### Start Task on Agent with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Starts a specified task on a given agent for a specific account. Requires fetching the task first.

```java
EFTask task = efClient.getTask(69).getData();

StartTaskResult result = efClient.startTaskResult(task, 420, 1337);
```

--------------------------------

### Start Task On An Agent

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Starts a specific task on a given agent for a specified account.

```APIDOC
## Start Task On An Agent

### Description
Starts a specified task on a given agent for a particular account.

### Method
```java
StartTaskResult startTaskResult(EFTask task, long agentId, long accountId)
```

### Parameters
#### Request Body
- **task** (EFTask) - Required - The task object to start.
- **agentId** (long) - Required - The ID of the agent to run the task on.
- **accountId** (long) - Required - The ID of the account to use for the task.

### Request Example
```java
// Fetch task with id 69
EFTask task = efClient.getTask(69).getData();

// Start the task on agent with id 420 and account with id 1337
StartTaskResult result = efClient.startTaskResult(task, 420, 1337);
```

### Response
#### Success Response (200)
- **data** (StartTaskResult) - Result of starting the task.

### Response Example
```json
{
  "data": {
    "success": true,
    "message": "Task started successfully."
  }
}
```
```

--------------------------------

### Get Account That Needs Tutorial Island Completion

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves an account that has not yet completed the tutorial island (tutorialStatus field is not set to 1000). Supports filtering.

```APIDOC
## Get Account That Needs Tutorial Island Completion

### Description
Returns an account that does not yet have the tutorialStatus field set to 1000. You must update this value on the account record for the call to work correctly. This is varp 281 in-game. Supports filtering.

### Method
```java
getNextTutorialAccount(Map<String, String> filters)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
- **filters** (Map<String, String>) - Optional. A map containing filter criteria. Supported keys: `account_category_id`, `country_code`.

#### Request Body
None

### Request Example
```java
Map<String, String> filters = new HashMap<>() {{
    put("account_category_id", "1,2,3");
    put("country_code", "US,GB");
}};
GetResult<EFAccount> result = efClient.getNextTutorialAccount(filters);
```

### Response
#### Success Response (200)
- **data** (EFAccount) - The EFAccount object that needs tutorial completion.

#### Response Example
```json
{
  "data": {
    "id": 456,
    "username": "tutorial_user@example.com",
    "password": "hashed_password",
    "account_category_id": 1,
    "country_code": "US",
    "otp_key": null,
    "tutorial_status": null,
    "last_checked_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Get Account Needing Tutorial Island Completion

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves an account that has not completed tutorial island (tutorialStatus field not set to 1000). Supports filtering by category and country code. The tutorialStatus must be updated on the account record for the call to work correctly.

```java
// Get next account that needs tutorial island completion.
Map<String, String> filters = new HashMap<>()
{{
    put("account_category_id", "1,2,3");
    put("country_code", "US,GB");
}};
GetResult<EFAccount> result = efClient.getNextTutorialAccount(filters);

// Print your retrieved account.
System.out.println(result.getData());
```

--------------------------------

### Get Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a single account using its unique identifier. Prints the retrieved account data.

```java
// Get a single account by id.
GetResult<EFAccount> result = efClient.getAccount(123);

// Print your retrieved account.
System.out.println(result.getData());
```

--------------------------------

### Get Proxy By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a single proxy using its unique identifier. Prints the retrieved proxy data.

```java
// Get a single proxy by id.
GetResult<EFProxy> result = efClient.getProxy(69);

// Print your retrieved proxy.
System.out.println(result.getData());
```

--------------------------------

### Get Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a single account by its unique identifier.

```APIDOC
## Get Account By ID

### Description
Get a single account by id.

### Method
```java
getAccount(long id)
```

### Parameters
#### Path Parameters
- **id** (long) - Required - The unique identifier of the account.

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
GetResult<EFAccount> result = efClient.getAccount(123);
```

### Response
#### Success Response (200)
- **data** (EFAccount) - The EFAccount object corresponding to the provided ID.

#### Response Example
```json
{
  "data": {
    "id": 123,
    "username": "testuser@example.com",
    "password": "hashed_password",
    "account_category_id": 1,
    "country_code": "US",
    "otp_key": null,
    "tutorial_status": 1000,
    "last_checked_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Get Proxy By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a single proxy by its unique identifier.

```APIDOC
## Get Proxy By ID

### Description
Get a single proxy by id.

### Method
```java
getProxy(long id)
```

### Parameters
#### Path Parameters
- **id** (long) - Required - The unique identifier of the proxy.

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
GetResult<EFProxy> result = efClient.getProxy(69);
```

### Response
#### Success Response (200)
- **data** (EFProxy) - The EFProxy object corresponding to the provided ID.

#### Response Example
```json
{
  "data": {
    "id": 69,
    "ip_address": "10.0.0.1",
    "port": 8080,
    "country_code": "GB",
    "proxy_category_id": 2,
    "last_used_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### Get Accounts That Need Checking

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves accounts that have not had their lastCheckedAt timestamp updated within the last 24 hours. Supports pagination and filtering.

```APIDOC
## Get Accounts That Need Checking

### Description
Returns accounts that have not had their lastCheckedAt timestamp updated within the last 24 hours. You should update this timestamp after checking the account status. If you do not update this value, the account will only be retrieved from the API once per hour. Supports pagination and filtering.

### Method
```java
getNextCheckAccounts(int pageSize, Map<String, String> filters)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
- **pageSize** (int) - Required - The maximum number of accounts to retrieve per page.
- **filters** (Map<String, String>) - Optional. A map containing filter criteria. Supported keys: `account_category_id`, `country_code`.

#### Request Body
None

### Request Example
```java
Map<String, String> filters = new HashMap<>() {{
    put("account_category_id", "1,2,3");
    put("country_code", "US,GB");
}};
PageResult<EFAccount> pageResult = efClient.getNextCheckAccounts(3, filters);
```

### Response
#### Success Response (200)
- **data** (List<EFAccount>) - A list of EFAccount objects that need checking.
- **total** (int) - The total number of accounts available that need checking.

#### Response Example
```json
{
  "data": [
    {
      "id": 789,
      "username": "check_user@example.com",
      "password": "hashed_password",
      "account_category_id": 1,
      "country_code": "US",
      "otp_key": null,
      "tutorial_status": 1000,
      "last_checked_at": "2023-10-26T10:00:00Z"
    }
  ],
  "total": 7
}
```
```

--------------------------------

### Get Accounts Needing Checking

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves accounts that have not been checked in the last 24 hours. Supports filtering. The lastCheckedAt timestamp should be updated after checking the account status to prevent frequent hourly checks.

```java
// All get page methods also support filter options.
Map<String, String> filters = new HashMap<>()
{{
	put("account_category_id", "1,2,3");
	put("country_code", "US,GB");
}};
PageResult<EFAccount> pageResult = efClient.getNextCheckAccounts(3, filters);

// Print out all of your retrieved accounts.
pageResult.getData().forEach(System.out::println);
```

--------------------------------

### Initialize EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Shows how to declare an API key, create an OkHttpClient instance, and initialize the EFClient.

```java
String apiKey = "apiKey";
OkHttpClient okHttpClient = new OkHttpClient();
EFClient efClient = new EFClient(okHttpClient, apiKey);
```

--------------------------------

### Create Proxy with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Use this to create a new proxy entity. Username and password are required.

```java
EFProxy proxy = new EFProxy();
proxy.setType("socks5");
proxy.setIpAddress("127.0.0.1");
proxy.setPort(6969);
proxy.setUsername("test69");
proxy.setPassword("password420");

CreateResult<EFProxy> result = efClient.createProxy(proxy);

System.out.println(result.getData().getId());
```

--------------------------------

### Create Account

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Creates a new account entity. Requires username and password. Prints the ID of the newly created account.

```java
// Create a new account entity and set some attributes.
// Username & Password are the only required attributes for creation.
EFAccount account = new EFAccount();
account.setUsername("test69@gmail.com");
account.setPassword("password420");

// Create the account record.
CreateResult<EFAccount> result = efClient.createAccount(account);

// Print the created account id.
System.out.println(result.getData().getId());
```

--------------------------------

### Create Account

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Creates a new account entity. Username and password are required.

```APIDOC
## Create Account

### Description
Create a new account entity and set some attributes. Username & Password are the only required attributes for creation.

### Method
```java
createAccount(EFAccount account)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **account** (EFAccount) - Required - The account object to create. Must include `username` and `password`.

### Request Example
```java
EFAccount account = new EFAccount();
account.setUsername("test69@gmail.com");
account.setPassword("password420");
CreateResult<EFAccount> result = efClient.createAccount(account);
```

### Response
#### Success Response (200)
- **data** (EFAccount) - The created EFAccount object, including its assigned ID.

#### Response Example
```json
{
  "data": {
    "id": 69,
    "username": "test69@gmail.com",
    "password": "hashed_password",
    "account_category_id": null,
    "country_code": null,
    "otp_key": null,
    "tutorial_status": null,
    "last_checked_at": null
  }
}
```
```

--------------------------------

### List Agents with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of agents. Specify the page number and the number of items per page.

```java
PageResult<EFAgent> pageResult = efClient.getAgentPage(1, 100);

pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Tasks with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of tasks. Specify the page number and the number of items per page.

```java
PageResult<EFTask> pageResult = efClient.getTaskPage(1, 100);

pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Bots with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of bots. Specify the page number and the number of items per page.

```java
PageResult<EFBot> pageResult = efClient.getBotPage(1, 100);

pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Tasks

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of tasks.

```APIDOC
## List Tasks

### Description
Retrieves a paginated list of tasks, with a default limit of 100 items per page.

### Method
```java
PageResult<EFTask> getTaskPage(int pageNumber, int pageSize)
```

### Parameters
#### Query Parameters
- **pageNumber** (int) - Required - The page number to retrieve.
- **pageSize** (int) - Required - The number of items per page (up to 100).

### Request Example
```java
PageResult<EFTask> pageResult = efClient.getTaskPage(1, 100);

// Print out all of your retrieved tasks.
pageResult.getData().forEach(System.out::println);
```

### Response
#### Success Response (200)
- **data** (List<EFTask>) - A list of EFTask objects.

### Response Example
```json
{
  "data": [
    {
      "id": 69,
      "name": "Task-1",
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### Create Proxy

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Creates a new proxy entity. Username and Password are the only required attributes for creation.

```APIDOC
## Create Proxy

### Description
Creates a new proxy entity with specified attributes. Username and Password are required.

### Method
```java
CreateResult<EFProxy> createProxy(EFProxy proxy)
```

### Parameters
#### Request Body
- **proxy** (EFProxy) - Required - An EFProxy object with at least username and password set.

### Request Example
```java
EFProxy proxy = new EFProxy();
proxy.setType("socks5");
proxy.setIpAddress("127.0.0.1");
proxy.setPort(6969);
proxy.setUsername("test69");
proxy.setPassword("password420");

CreateResult<EFProxy> result = efClient.createProxy(proxy);
```

### Response
#### Success Response (200)
- **data** (EFProxy) - The created proxy object, including its ID.

### Response Example
```json
{
  "data": {
    "id": 123,
    "type": "socks5",
    "ipAddress": "127.0.0.1",
    "port": 6969,
    "username": "test69",
    "password": "password420"
  }
}
```
```

--------------------------------

### List Proxy Categories with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of proxy categories. Specify the page number and the number of items per page.

```java
PageResult<EFProxyCategory> pageResult = efClient.getProxyCategoryPage(1, 100);

pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Proxies

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of proxies. Supports specifying page number and items per page.

```APIDOC
## List Proxies

### Description
Get up to 100 of your proxies on eternal farm.

### Method
```java
getProxyPage(int pageNumber, int pageSize)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
PageResult<EFProxy> pageResult = efClient.getProxyPage(1, 100);
```

### Response
#### Success Response (200)
- **data** (List<EFProxy>) - A list of EFProxy objects.
- **total** (int) - The total number of proxies available.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "ip_address": "192.168.1.1",
      "port": 8080,
      "country_code": "US",
      "proxy_category_id": 1,
      "last_used_at": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 50
}
```
```

--------------------------------

### List Prime Link Requests with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of prime link requests. Specify the page number and the number of items per page.

```java
PageResult<EFPrimeLinkRequest> pageResult = efClient.getPrimeLinkRequestPage(1, 100);

pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Account Categories

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of account categories. Specifies page number and amount per page.

```java
// Get up to 100 of your account categories on eternal farm.
PageResult<EFAccountCategory> pageResult = efClient.getAccountCategoryPage(1, 100);

// Print out all of your retrieved account categories.
pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Account Categories

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of all available account categories.

```APIDOC
## List Account Categories

### Description
Get up to 100 of your account categories on eternal farm.

### Method
```java
getAccountCategoryPage(int pageNumber, int pageSize)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
PageResult<EFAccountCategory> pageResult = efClient.getAccountCategoryPage(1, 100);
```

### Response
#### Success Response (200)
- **data** (List<EFAccountCategory>) - A list of EFAccountCategory objects.
- **total** (int) - The total number of account categories available.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "name": "Standard"
    },
    {
      "id": 2,
      "name": "Premium"
    }
  ],
  "total": 2
}
```
```

--------------------------------

### List Bots

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of bots.

```APIDOC
## List Bots

### Description
Retrieves a paginated list of bots, with a default limit of 100 items per page.

### Method
```java
PageResult<EFBot> getBotPage(int pageNumber, int pageSize)
```

### Parameters
#### Query Parameters
- **pageNumber** (int) - Required - The page number to retrieve.
- **pageSize** (int) - Required - The number of items per page (up to 100).

### Request Example
```java
PageResult<EFBot> pageResult = efClient.getBotPage(1, 100);

// Print out all of your retrieved bots.
pageResult.getData().forEach(System.out::println);
```

### Response
#### Success Response (200)
- **data** (List<EFBot>) - A list of EFBot objects.

### Response Example
```json
{
  "data": [
    {
      "id": 789,
      "name": "Bot-Alpha",
      "status": "active"
    }
  ]
}
```
```

--------------------------------

### List Proxies

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of proxies, specifying page number and amount per page. Supports filtering.

```java
// Get up to 100 of your proxies on eternal farm.
PageResult<EFProxy> pageResult = efClient.getProxyPage(1, 100);

// Print out all of your retrieved proxies.
pageResult.getData().forEach(System.out::println);
```

```java
// All get page methods also support filter options.
Map<String, String> filters = new HashMap<>()
{{
	put("proxy_category_id", "1,2,3");
	put("country_code", "US,GB");
}};
PageResult<EFProxy> pageResult = efClient.getProxyPage(1, 100, filters);

// Print out all of your retrieved proxies.
pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Accounts (With Filters)

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of accounts with support for filtering by account category and country code.

```APIDOC
## List Accounts (With Filters)

### Description
All get page methods also support filter options.

### Method
```java
getAccountPage(int pageNumber, int pageSize, Map<String, String> filters)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
- **filters** (Map<String, String>) - Optional. A map containing filter criteria. Supported keys: `account_category_id`, `country_code`.

#### Request Body
None

### Request Example
```java
Map<String, String> filters = new HashMap<>() {{
    put("account_category_id", "1,2,3");
    put("country_code", "US,GB");
}};
PageResult<EFAccount> pageResult = efClient.getAccountPage(1, 100, filters);
```

### Response
#### Success Response (200)
- **data** (List<EFAccount>) - A list of EFAccount objects matching the filters.
- **total** (int) - The total number of accounts available matching the filters.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "username": "user1@example.com",
      "password": "password123",
      "account_category_id": 1,
      "country_code": "US",
      "otp_key": null,
      "tutorial_status": 1000,
      "last_checked_at": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 5
}
```
```

--------------------------------

### List Proxies (With Filters)

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of proxies with support for filtering by proxy category and country code.

```APIDOC
## List Proxies (With Filters)

### Description
All get page methods also support filter options.

### Method
```java
getProxyPage(int pageNumber, int pageSize, Map<String, String> filters)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
- **filters** (Map<String, String>) - Optional. A map containing filter criteria. Supported keys: `proxy_category_id`, `country_code`.

#### Request Body
None

### Request Example
```java
Map<String, String> filters = new HashMap<>() {{
    put("proxy_category_id", "1,2,3");
    put("country_code", "US,GB");
}};
PageResult<EFProxy> pageResult = efClient.getProxyPage(1, 100, filters);
```

### Response
#### Success Response (200)
- **data** (List<EFProxy>) - A list of EFProxy objects matching the filters.
- **total** (int) - The total number of proxies available matching the filters.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "ip_address": "192.168.1.1",
      "port": 8080,
      "country_code": "US",
      "proxy_category_id": 1,
      "last_used_at": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 25
}
```
```

--------------------------------

### Update Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Updates an existing account. It's recommended to fetch the account first, modify its properties, and then update.

```APIDOC
## Update Account By ID

### Description
Updates an existing account record. It is recommended to fetch the existing record first, modify the desired attributes, and then call this method.

### Method
```java
updateAccount(EFAccount account)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **account** (EFAccount) - Required - The account object with updated information. Must include the `id` of the account to update.

### Request Example
```java
// Fetch the existing account
EFAccount account = efClient.getAccount(123).getData();

// Modify attributes
account.setAccountCategoryId(69);
account.setOtpKey("ABC69420");

// Update the account record
UpdateResult<EFAccount> result = efClient.updateAccount(account);
```

### Response
#### Success Response (200)
- **data** (EFAccount) - The updated EFAccount object.

#### Response Example
```json
{
  "data": {
    "id": 123,
    "username": "testuser@example.com",
    "password": "hashed_password",
    "account_category_id": 69,
    "country_code": "US",
    "otp_key": "ABC69420",
    "tutorial_status": 1000,
    "last_checked_at": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### List Proxy Categories

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of proxy categories.

```APIDOC
## List Proxy Categories

### Description
Retrieves a paginated list of proxy categories, with a default limit of 100 items per page.

### Method
```java
PageResult<EFProxyCategory> getProxyCategoryPage(int pageNumber, int pageSize)
```

### Parameters
#### Query Parameters
- **pageNumber** (int) - Required - The page number to retrieve.
- **pageSize** (int) - Required - The number of items per page (up to 100).

### Request Example
```java
PageResult<EFProxyCategory> pageResult = efClient.getProxyCategoryPage(1, 100);

// Print out all of your retrieved proxy categories.
pageResult.getData().forEach(System.out::println);
```

### Response
#### Success Response (200)
- **data** (List<EFProxyCategory>) - A list of EFProxyCategory objects.

### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "name": "SOCKS5 Proxies"
    },
    {
      "id": 2,
      "name": "HTTP Proxies"
    }
  ]
}
```
```

--------------------------------

### List Accounts

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of accounts, specifying page number and amount per page. Supports filtering.

```java
// Get up to 100 of your accounts on eternal farm.
PageResult<EFAccount> pageResult = efClient.getAccountPage(1, 100);

// Print out all of your retrieved accounts.
pageResult.getData().forEach(System.out::println);
```

```java
// All get page methods also support filter options.
Map<String, String> filters = new HashMap<>()
{{
	put("account_category_id", "1,2,3");
	put("country_code", "US,GB");
}};
PageResult<EFAccount> pageResult = efClient.getAccountPage(1, 100, filters);

// Print out all of your retrieved accounts.
pageResult.getData().forEach(System.out::println);
```

--------------------------------

### List Agents

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of agents.

```APIDOC
## List Agents

### Description
Retrieves a paginated list of agents, with a default limit of 100 items per page.

### Method
```java
PageResult<EFAgent> getAgentPage(int pageNumber, int pageSize)
```

### Parameters
#### Query Parameters
- **pageNumber** (int) - Required - The page number to retrieve.
- **pageSize** (int) - Required - The number of items per page (up to 100).

### Request Example
```java
PageResult<EFAgent> pageResult = efClient.getAgentPage(1, 100);

// Print out all of your retrieved agents.
pageResult.getData().forEach(System.out::println);
```

### Response
#### Success Response (200)
- **data** (List<EFAgent>) - A list of EFAgent objects.

### Response Example
```json
{
  "data": [
    {
      "id": 420,
      "name": "Agent-001",
      "ipAddress": "192.168.1.100"
    }
  ]
}
```
```

--------------------------------

### EFClient Maven Dependencies

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Required Maven dependencies for using the EFClient library, including OkHttp, Gson, and Lombok.

```xml
<dependencies>
    <dependency>
        <groupId>com.squareup.okhttp3</groupId>
        <artifactId>okhttp</artifactId>
        <version>4.9.3</version>
    </dependency>
    <dependency>
        <groupId>com.google.code.gson</groupId>
        <artifactId>gson</artifactId>
        <version>2.8.9</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.22</version>
    </dependency>
</dependencies>
```

--------------------------------

### Update Proxy by ID with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Fetches an existing proxy by its ID, allows modification of attributes, and then updates the record.

```java
EFProxy proxy = efClient.getProxy(69).getData();

proxy.setProxyCategoryId(69);

UpdateResult<EFProxy> result = efClient.updateProxy(proxy);
```

--------------------------------

### List Accounts

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of accounts. Supports specifying page number and items per page.

```APIDOC
## List Accounts

### Description
Get up to 100 of your accounts on eternal farm.

### Method
```java
getAccountPage(int pageNumber, int pageSize)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
PageResult<EFAccount> pageResult = efClient.getAccountPage(1, 100);
```

### Response
#### Success Response (200)
- **data** (List<EFAccount>) - A list of EFAccount objects.
- **total** (int) - The total number of accounts available.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "username": "user1@example.com",
      "password": "password123",
      "account_category_id": 1,
      "country_code": "US",
      "otp_key": null,
      "tutorial_status": 1000,
      "last_checked_at": "2023-10-27T10:00:00Z"
    }
  ],
  "total": 10
}
```
```

--------------------------------

### List Prime Link Requests

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Retrieves a paginated list of prime link requests.

```APIDOC
## List Prime Link Requests

### Description
Retrieves a paginated list of prime link requests, with a default limit of 100 items per page.

### Method
```java
PageResult<EFPrimeLinkRequest> getPrimeLinkRequestPage(int pageNumber, int pageSize)
```

### Parameters
#### Query Parameters
- **pageNumber** (int) - Required - The page number to retrieve.
- **pageSize** (int) - Required - The number of items per page (up to 100).

### Request Example
```java
PageResult<EFPrimeLinkRequest> pageResult = efClient.getPrimeLinkRequestPage(1, 100);

// Print out all of your retrieved prime link requests.
pageResult.getData().forEach(System.out::println);
```

### Response
#### Success Response (200)
- **data** (List<EFPrimeLinkRequest>) - A list of EFPrimeLinkRequest objects.

### Response Example
```json
{
  "data": [
    {
      "id": 101,
      "accountId": 1337,
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### Update Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Updates an existing account by first fetching the record, modifying attributes, and then sending the update. Requires the account ID.

```java
// Get a single account by id.
EFAccount account = efClient.getAccount(123).getData();

// Change some attributes on the account.
account.setAccountCategoryId(69);
account.setOtpKey("ABC69420");

// Update the account record.
UpdateResult<EFAccount> result = efClient.updateAccount(account);
```

--------------------------------

### Stop Task on Agent with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Stops a specified task on a given agent for a specific account. Requires fetching the task first.

```java
EFTask task = efClient.getTask(69).getData();

StartTaskResult result = efClient.stopTaskResult(task, 420, 1337);
```

--------------------------------

### Delete Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Deletes an account by its ID. You can either provide an account object with the ID set or retrieve the account first and then delete it.

```APIDOC
## Delete Account By ID

### Description
Deletes an account record by its ID. You can either provide an account object with the ID set, or retrieve the account first and then delete it.

### Method
```java
deleteAccount(EFAccount account)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **account** (EFAccount) - Required - The account object containing the `id` of the account to delete.

### Request Example
```java
// Option 1: Create an account entity with the ID set
EFAccount accountToDelete = new EFAccount();
accountToDelete.setId(69);
DeleteResult<EFAccount> result = efClient.deleteAccount(accountToDelete);

// Option 2: Retrieve the account first then delete
// EFAccount accountToDelete = efClient.getAccount(69).getData();
// DeleteResult<EFAccount> result = efClient.deleteAccount(accountToDelete);
```

### Response
#### Success Response (200)
- **data** (boolean) - Indicates if the deletion was successful (true) or not (false).

#### Response Example
```json
{
  "data": true
}
```
```

--------------------------------

### Update Proxy By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Updates an existing proxy entity identified by its ID. It's recommended to fetch the existing record first.

```APIDOC
## Update Proxy By ID

### Description
Updates an existing proxy entity. It is recommended to fetch the existing record first before making modifications.

### Method
```java
UpdateResult<EFProxy> updateProxy(EFProxy proxy)
```

### Parameters
#### Request Body
- **proxy** (EFProxy) - Required - The EFProxy object with the ID of the proxy to update and the modified attributes.

### Request Example
```java
// Get a single proxy by id.
EFProxy proxy = efClient.getProxy(69).getData();

// Change some attributes on the proxy.
proxy.setProxyCategoryId(69);

// Update the proxy record.
UpdateResult<EFProxy> result = efClient.updateProxy(proxy);
```

### Response
#### Success Response (200)
- **data** (EFProxy) - The updated proxy object.

### Response Example
```json
{
  "data": {
    "id": 69,
    "proxyCategoryId": 69
    // ... other proxy attributes
  }
}
```
```

--------------------------------

### Delete Proxy by ID with EFClient

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Deletes a proxy record by its ID. You can optionally retrieve the proxy first before deleting.

```java
EFProxy proxy = new EFProxy();
proxy.setId(69);

DeleteResult<EFProxy> result = efClient.deleteProxy(proxy);
```

--------------------------------

### Delete Account By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Deletes an account record. An account entity with the ID set is required for deletion. The account can optionally be retrieved first.

```java
// Create an account entity and set the id.
// You can optionally retrieve the account first then delete.
EFAccount account = new EFAccount();
account.setId(69);

// Delete the account record.
DeleteResult<EFAccount> result = efClient.deleteAccount(account);
```

--------------------------------

### Stop Task On An Agent

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Stops a specific task on a given agent for a specified account.

```APIDOC
## Stop Task On An Agent

### Description
Stops a specified task on a given agent for a particular account.

### Method
```java
StartTaskResult stopTaskResult(EFTask task, long agentId, long accountId)
```

### Parameters
#### Request Body
- **task** (EFTask) - Required - The task object to stop.
- **agentId** (long) - Required - The ID of the agent where the task is running.
- **accountId** (long) - Required - The ID of the account associated with the task.

### Request Example
```java
// Fetch task with id 69
EFTask task = efClient.getTask(69).getData();

// Stop the task on agent with id 420 and account with id 1337
StartTaskResult result = efClient.stopTaskResult(task, 420, 1337);
```

### Response
#### Success Response (200)
- **data** (StartTaskResult) - Result of stopping the task.

### Response Example
```json
{
  "data": {
    "success": true,
    "message": "Task stopped successfully."
  }
}
```
```

--------------------------------

### Delete Proxy By ID

Source: https://github.com/lostvirt/efclient/blob/master/README.md

Deletes a proxy entity identified by its ID.

```APIDOC
## Delete Proxy By ID

### Description
Deletes a proxy entity based on its ID. You can optionally retrieve the proxy first before deleting.

### Method
```java
DeleteResult<EFProxy> deleteProxy(EFProxy proxy)
```

### Parameters
#### Request Body
- **proxy** (EFProxy) - Required - An EFProxy object with the ID of the proxy to be deleted.

### Request Example
```java
EFProxy proxy = new EFProxy();
proxy.setId(69);

// Delete the proxy record.
DeleteResult<EFProxy> result = efClient.deleteProxy(proxy);
```

### Response
#### Success Response (200)
- **data** (boolean) - Indicates if the deletion was successful.

### Response Example
```json
{
  "data": true
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.