Class IpPoolsApi

java.lang.Object

sendpost_java_sdk.IpPoolsApi

public class IpPoolsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IpPoolsApi()
IpPoolsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IPPool	createIPPool(IPPoolCreateRequest ipPoolCreateRequest)	Create a New IPPool Creates a new IPPool with the specified name, IPs, and third-party sending providers.
okhttp3.Call	createIPPoolAsync(IPPoolCreateRequest ipPoolCreateRequest, ApiCallback<IPPool> _callback)	Create a New IPPool (asynchronously) Creates a new IPPool with the specified name, IPs, and third-party sending providers.
okhttp3.Call	createIPPoolCall(IPPoolCreateRequest ipPoolCreateRequest, ApiCallback _callback)	Build call for createIPPool
ApiResponse<IPPool>	createIPPoolWithHttpInfo(IPPoolCreateRequest ipPoolCreateRequest)	Create a New IPPool Creates a new IPPool with the specified name, IPs, and third-party sending providers.
IPPoolDeleteResponse	deleteIPPool(Integer ippoolId)	Delete a Specific IPPool Delete a specific IPPool based on its ID.
okhttp3.Call	deleteIPPoolAsync(Integer ippoolId, ApiCallback<IPPoolDeleteResponse> _callback)	Delete a Specific IPPool (asynchronously) Delete a specific IPPool based on its ID.
okhttp3.Call	deleteIPPoolCall(Integer ippoolId, ApiCallback _callback)	Build call for deleteIPPool
ApiResponse<IPPoolDeleteResponse>	deleteIPPoolWithHttpInfo(Integer ippoolId)	Delete a Specific IPPool Delete a specific IPPool based on its ID.
List<IPPool>	getAllIPPools(Integer limit, Integer offset, String search)	Get All IPPools Retrieves a list of all IPPools and information about all IPs contained in that pool.
okhttp3.Call	getAllIPPoolsAsync(Integer limit, Integer offset, String search, ApiCallback<List<IPPool>> _callback)	Get All IPPools (asynchronously) Retrieves a list of all IPPools and information about all IPs contained in that pool.
okhttp3.Call	getAllIPPoolsCall(Integer limit, Integer offset, String search, ApiCallback _callback)	Build call for getAllIPPools
ApiResponse<List<IPPool>>	getAllIPPoolsWithHttpInfo(Integer limit, Integer offset, String search)	Get All IPPools Retrieves a list of all IPPools and information about all IPs contained in that pool.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
IPPool	getIPPoolById(Integer ippoolId)	Get a Specific IPPool Retrieves details of a specific IPPool based on its ID.
okhttp3.Call	getIPPoolByIdAsync(Integer ippoolId, ApiCallback<IPPool> _callback)	Get a Specific IPPool (asynchronously) Retrieves details of a specific IPPool based on its ID.
okhttp3.Call	getIPPoolByIdCall(Integer ippoolId, ApiCallback _callback)	Build call for getIPPoolById
ApiResponse<IPPool>	getIPPoolByIdWithHttpInfo(Integer ippoolId)	Get a Specific IPPool Retrieves details of a specific IPPool based on its ID.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IPPool	updateIPPool(Integer ippoolId, IPPoolUpdateRequest ipPoolUpdateRequest)	Update an Existing IPPool Update the details of an existing IPPool by its ID.
okhttp3.Call	updateIPPoolAsync(Integer ippoolId, IPPoolUpdateRequest ipPoolUpdateRequest, ApiCallback<IPPool> _callback)	Update an Existing IPPool (asynchronously) Update the details of an existing IPPool by its ID.
okhttp3.Call	updateIPPoolCall(Integer ippoolId, IPPoolUpdateRequest ipPoolUpdateRequest, ApiCallback _callback)	Build call for updateIPPool
ApiResponse<IPPool>	updateIPPoolWithHttpInfo(Integer ippoolId, IPPoolUpdateRequest ipPoolUpdateRequest)	Update an Existing IPPool Update the details of an existing IPPool by its ID.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IpPoolsApi

public IpPoolsApi()

IpPoolsApi

public IpPoolsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createIPPoolCall

public okhttp3.Call createIPPoolCall(@Nonnull
 IPPoolCreateRequest ipPoolCreateRequest,
 ApiCallback _callback)
                              throws ApiException

Build call for createIPPool

Parameters:

ipPoolCreateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Created IPPool details	-
403	Forbidden, IPPool with the same name already exists	-

createIPPool

public IPPool createIPPool(@Nonnull
 IPPoolCreateRequest ipPoolCreateRequest)
                    throws ApiException

Create a New IPPool Creates a new IPPool with the specified name, IPs, and third-party sending providers.

Parameters:

ipPoolCreateRequest - (required)

Returns:

IPPool

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Created IPPool details	-
403	Forbidden, IPPool with the same name already exists	-

createIPPoolWithHttpInfo

public ApiResponse<IPPool> createIPPoolWithHttpInfo(@Nonnull
 IPPoolCreateRequest ipPoolCreateRequest)
                                             throws ApiException

Create a New IPPool Creates a new IPPool with the specified name, IPs, and third-party sending providers.

Parameters:

ipPoolCreateRequest - (required)

Returns:

ApiResponse<IPPool>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Created IPPool details	-
403	Forbidden, IPPool with the same name already exists	-

createIPPoolAsync

public okhttp3.Call createIPPoolAsync(@Nonnull
 IPPoolCreateRequest ipPoolCreateRequest,
 ApiCallback<IPPool> _callback)
                               throws ApiException

Create a New IPPool (asynchronously) Creates a new IPPool with the specified name, IPs, and third-party sending providers.

Parameters:

ipPoolCreateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Created IPPool details	-
403	Forbidden, IPPool with the same name already exists	-

deleteIPPoolCall

public okhttp3.Call deleteIPPoolCall(@Nonnull
 Integer ippoolId,
 ApiCallback _callback)
                              throws ApiException

Build call for deleteIPPool

Parameters:

ippoolId - The ID of the IPPool to delete (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Successful deletion of the IPPool	-
404	IPPool not found	-
401	Unauthorized	-

deleteIPPool

public IPPoolDeleteResponse deleteIPPool(@Nonnull
 Integer ippoolId)
                                  throws ApiException

Delete a Specific IPPool Delete a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool to delete (required)

Returns:

IPPoolDeleteResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Successful deletion of the IPPool	-
404	IPPool not found	-
401	Unauthorized	-

deleteIPPoolWithHttpInfo

public ApiResponse<IPPoolDeleteResponse> deleteIPPoolWithHttpInfo(@Nonnull
 Integer ippoolId)
                                                           throws ApiException

Delete a Specific IPPool Delete a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool to delete (required)

Returns:

ApiResponse<IPPoolDeleteResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Successful deletion of the IPPool	-
404	IPPool not found	-
401	Unauthorized	-

deleteIPPoolAsync

public okhttp3.Call deleteIPPoolAsync(@Nonnull
 Integer ippoolId,
 ApiCallback<IPPoolDeleteResponse> _callback)
                               throws ApiException

Delete a Specific IPPool (asynchronously) Delete a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool to delete (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Successful deletion of the IPPool	-
404	IPPool not found	-
401	Unauthorized	-

getAllIPPoolsCall

public okhttp3.Call getAllIPPoolsCall(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String search,
 ApiCallback _callback)
                               throws ApiException

Build call for getAllIPPools

Parameters:

limit - Number of records to return per request (optional)

offset - Number of initial records to skip (optional)

search - Case insensitive search against IPPool name (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	A list of IPPools	-
401	Unauthorized	-

getAllIPPools

public List<IPPool> getAllIPPools(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String search)
                           throws ApiException

Get All IPPools Retrieves a list of all IPPools and information about all IPs contained in that pool.

Parameters:

limit - Number of records to return per request (optional)

offset - Number of initial records to skip (optional)

search - Case insensitive search against IPPool name (optional)

Returns:

List<IPPool>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	A list of IPPools	-
401	Unauthorized	-

getAllIPPoolsWithHttpInfo

public ApiResponse<List<IPPool>> getAllIPPoolsWithHttpInfo(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String search)
                                                    throws ApiException

Get All IPPools Retrieves a list of all IPPools and information about all IPs contained in that pool.

Parameters:

limit - Number of records to return per request (optional)

offset - Number of initial records to skip (optional)

search - Case insensitive search against IPPool name (optional)

Returns:

ApiResponse<List<IPPool>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	A list of IPPools	-
401	Unauthorized	-

getAllIPPoolsAsync

public okhttp3.Call getAllIPPoolsAsync(@Nullable
 Integer limit,
 @Nullable
 Integer offset,
 @Nullable
 String search,
 ApiCallback<List<IPPool>> _callback)
                                throws ApiException

Get All IPPools (asynchronously) Retrieves a list of all IPPools and information about all IPs contained in that pool.

Parameters:

limit - Number of records to return per request (optional)

offset - Number of initial records to skip (optional)

search - Case insensitive search against IPPool name (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	A list of IPPools	-
401	Unauthorized	-

getIPPoolByIdCall

public okhttp3.Call getIPPoolByIdCall(@Nonnull
 Integer ippoolId,
 ApiCallback _callback)
                               throws ApiException

Build call for getIPPoolById

Parameters:

ippoolId - The ID of the IPPool whose information you want to retrieve (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Details of a specific IPPool	-
401	Unauthorized	-

getIPPoolById

public IPPool getIPPoolById(@Nonnull
 Integer ippoolId)
                     throws ApiException

Get a Specific IPPool Retrieves details of a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool whose information you want to retrieve (required)

Returns:

IPPool

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Details of a specific IPPool	-
401	Unauthorized	-

getIPPoolByIdWithHttpInfo

public ApiResponse<IPPool> getIPPoolByIdWithHttpInfo(@Nonnull
 Integer ippoolId)
                                              throws ApiException

Get a Specific IPPool Retrieves details of a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool whose information you want to retrieve (required)

Returns:

ApiResponse<IPPool>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Details of a specific IPPool	-
401	Unauthorized	-

getIPPoolByIdAsync

public okhttp3.Call getIPPoolByIdAsync(@Nonnull
 Integer ippoolId,
 ApiCallback<IPPool> _callback)
                                throws ApiException

Get a Specific IPPool (asynchronously) Retrieves details of a specific IPPool based on its ID.

Parameters:

ippoolId - The ID of the IPPool whose information you want to retrieve (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	Details of a specific IPPool	-
401	Unauthorized	-

updateIPPoolCall

public okhttp3.Call updateIPPoolCall(@Nonnull
 Integer ippoolId,
 @Nonnull
 IPPoolUpdateRequest ipPoolUpdateRequest,
 ApiCallback _callback)
                              throws ApiException

Build call for updateIPPool

Parameters:

ippoolId - The ID of the IPPool to update (required)

ipPoolUpdateRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	The updated IPPool details	-
400	Bad request - invalid or missing data	-
404	IPPool not found	-
401	Unauthorized	-

updateIPPool

public IPPool updateIPPool(@Nonnull
 Integer ippoolId,
 @Nonnull
 IPPoolUpdateRequest ipPoolUpdateRequest)
                    throws ApiException

Update an Existing IPPool Update the details of an existing IPPool by its ID.

Parameters:

ippoolId - The ID of the IPPool to update (required)

ipPoolUpdateRequest - (required)

Returns:

IPPool

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	The updated IPPool details	-
400	Bad request - invalid or missing data	-
404	IPPool not found	-
401	Unauthorized	-

updateIPPoolWithHttpInfo

public ApiResponse<IPPool> updateIPPoolWithHttpInfo(@Nonnull
 Integer ippoolId,
 @Nonnull
 IPPoolUpdateRequest ipPoolUpdateRequest)
                                             throws ApiException

Update an Existing IPPool Update the details of an existing IPPool by its ID.

Parameters:

ippoolId - The ID of the IPPool to update (required)

ipPoolUpdateRequest - (required)

Returns:

ApiResponse<IPPool>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	The updated IPPool details	-
400	Bad request - invalid or missing data	-
404	IPPool not found	-
401	Unauthorized	-

updateIPPoolAsync

public okhttp3.Call updateIPPoolAsync(@Nonnull
 Integer ippoolId,
 @Nonnull
 IPPoolUpdateRequest ipPoolUpdateRequest,
 ApiCallback<IPPool> _callback)
                               throws ApiException

Update an Existing IPPool (asynchronously) Update the details of an existing IPPool by its ID.

Parameters:

ippoolId - The ID of the IPPool to update (required)

ipPoolUpdateRequest - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Response Details

Status Code	Description	Response Headers
200	The updated IPPool details	-
400	Bad request - invalid or missing data	-
404	IPPool not found	-
401	Unauthorized	-