Class IpApi

java.lang.Object

sendpost_java_sdk.IpApi

public class IpApi
extends Object

Constructor Summary

Constructors

Constructor	Description
IpApi()
IpApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
IP	allocateNewIp(IPAllocationRequest ipAllocationRequest)	Allocate a New IP Allocates a new IP resource to the account.
okhttp3.Call	allocateNewIpAsync(IPAllocationRequest ipAllocationRequest, ApiCallback<IP> _callback)	Allocate a New IP (asynchronously) Allocates a new IP resource to the account.
okhttp3.Call	allocateNewIpCall(IPAllocationRequest ipAllocationRequest, ApiCallback _callback)	Build call for allocateNewIp
ApiResponse<IP>	allocateNewIpWithHttpInfo(IPAllocationRequest ipAllocationRequest)	Allocate a New IP Allocates a new IP resource to the account.
IPDeletionResponse	deleteIp(Integer ipId)	Delete a Specific IP Deletes a specific IP resource based on the provided IP ID.
okhttp3.Call	deleteIpAsync(Integer ipId, ApiCallback<IPDeletionResponse> _callback)	Delete a Specific IP (asynchronously) Deletes a specific IP resource based on the provided IP ID.
okhttp3.Call	deleteIpCall(Integer ipId, ApiCallback _callback)	Build call for deleteIp
ApiResponse<IPDeletionResponse>	deleteIpWithHttpInfo(Integer ipId)	Delete a Specific IP Deletes a specific IP resource based on the provided IP ID.
List<IP>	getAllIps(Integer limit, Integer offset, String search)	Get All IPs Retrieves a list of all IPs associated with the main account.
okhttp3.Call	getAllIpsAsync(Integer limit, Integer offset, String search, ApiCallback<List<IP>> _callback)	Get All IPs (asynchronously) Retrieves a list of all IPs associated with the main account.
okhttp3.Call	getAllIpsCall(Integer limit, Integer offset, String search, ApiCallback _callback)	Build call for getAllIps
ApiResponse<List<IP>>	getAllIpsWithHttpInfo(Integer limit, Integer offset, String search)	Get All IPs Retrieves a list of all IPs associated with the main account.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
IP	getSpecificIp(Integer ipId)	Get a Specific IP Retrieves detailed information about a specific IP based on the provided ID.
okhttp3.Call	getSpecificIpAsync(Integer ipId, ApiCallback<IP> _callback)	Get a Specific IP (asynchronously) Retrieves detailed information about a specific IP based on the provided ID.
okhttp3.Call	getSpecificIpCall(Integer ipId, ApiCallback _callback)	Build call for getSpecificIp
ApiResponse<IP>	getSpecificIpWithHttpInfo(Integer ipId)	Get a Specific IP Retrieves detailed information about a specific IP based on the provided ID.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
IP	updateIp(Integer ipId, IPUpdateRequest ipUpdateRequest)	Update an Existing IP Updates an existing IP resource based on the provided IP ID.
okhttp3.Call	updateIpAsync(Integer ipId, IPUpdateRequest ipUpdateRequest, ApiCallback<IP> _callback)	Update an Existing IP (asynchronously) Updates an existing IP resource based on the provided IP ID.
okhttp3.Call	updateIpCall(Integer ipId, IPUpdateRequest ipUpdateRequest, ApiCallback _callback)	Build call for updateIp
ApiResponse<IP>	updateIpWithHttpInfo(Integer ipId, IPUpdateRequest ipUpdateRequest)	Update an Existing IP Updates an existing IP resource based on the provided IP ID.

Methods inherited from class java.lang.Object

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

Constructor Details

IpApi

public IpApi()

IpApi

public IpApi(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)

allocateNewIpCall

public okhttp3.Call allocateNewIpCall(@Nonnull
 IPAllocationRequest ipAllocationRequest,
 ApiCallback _callback)
                               throws ApiException

Build call for allocateNewIp

Parameters:

ipAllocationRequest - (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 the allocated IP	-

allocateNewIp

public IP allocateNewIp(@Nonnull
 IPAllocationRequest ipAllocationRequest)
                 throws ApiException

Allocate a New IP Allocates a new IP resource to the account.

Parameters:

ipAllocationRequest - (required)

Returns:

IP

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 the allocated IP	-

allocateNewIpWithHttpInfo

public ApiResponse<IP> allocateNewIpWithHttpInfo(@Nonnull
 IPAllocationRequest ipAllocationRequest)
                                          throws ApiException

Allocate a New IP Allocates a new IP resource to the account.

Parameters:

ipAllocationRequest - (required)

Returns:

ApiResponse<IP>

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 the allocated IP	-

allocateNewIpAsync

public okhttp3.Call allocateNewIpAsync(@Nonnull
 IPAllocationRequest ipAllocationRequest,
 ApiCallback<IP> _callback)
                                throws ApiException

Allocate a New IP (asynchronously) Allocates a new IP resource to the account.

Parameters:

ipAllocationRequest - (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 the allocated IP	-

deleteIpCall

public okhttp3.Call deleteIpCall(@Nonnull
 Integer ipId,
 ApiCallback _callback)
                          throws ApiException

Build call for deleteIp

Parameters:

ipId - The ID of the IP resource 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	Confirmation message after successful IP deletion	-

deleteIp

public IPDeletionResponse deleteIp(@Nonnull
 Integer ipId)
                            throws ApiException

Delete a Specific IP Deletes a specific IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource to delete (required)

Returns:

IPDeletionResponse

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	Confirmation message after successful IP deletion	-

deleteIpWithHttpInfo

public ApiResponse<IPDeletionResponse> deleteIpWithHttpInfo(@Nonnull
 Integer ipId)
                                                     throws ApiException

Delete a Specific IP Deletes a specific IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource to delete (required)

Returns:

ApiResponse<IPDeletionResponse>

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	Confirmation message after successful IP deletion	-

deleteIpAsync

public okhttp3.Call deleteIpAsync(@Nonnull
 Integer ipId,
 ApiCallback<IPDeletionResponse> _callback)
                           throws ApiException

Delete a Specific IP (asynchronously) Deletes a specific IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource 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	Confirmation message after successful IP deletion	-

getAllIpsCall

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

Build call for getAllIps

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against IP's public IP address (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 IPs associated with the account	-

getAllIps

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

Get All IPs Retrieves a list of all IPs associated with the main account.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against IP's public IP address (optional)

Returns:

List<IP>

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 IPs associated with the account	-

getAllIpsWithHttpInfo

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

Get All IPs Retrieves a list of all IPs associated with the main account.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against IP's public IP address (optional)

Returns:

ApiResponse<List<IP>>

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 IPs associated with the account	-

getAllIpsAsync

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

Get All IPs (asynchronously) Retrieves a list of all IPs associated with the main account.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against IP's public IP address (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 IPs associated with the account	-

getSpecificIpCall

public okhttp3.Call getSpecificIpCall(@Nonnull
 Integer ipId,
 ApiCallback _callback)
                               throws ApiException

Build call for getSpecificIp

Parameters:

ipId - The ID of the IP resource 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	Information about the specified IP	-

getSpecificIp

public IP getSpecificIp(@Nonnull
 Integer ipId)
                 throws ApiException

Get a Specific IP Retrieves detailed information about a specific IP based on the provided ID.

Parameters:

ipId - The ID of the IP resource to retrieve (required)

Returns:

IP

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	Information about the specified IP	-

getSpecificIpWithHttpInfo

public ApiResponse<IP> getSpecificIpWithHttpInfo(@Nonnull
 Integer ipId)
                                          throws ApiException

Get a Specific IP Retrieves detailed information about a specific IP based on the provided ID.

Parameters:

ipId - The ID of the IP resource to retrieve (required)

Returns:

ApiResponse<IP>

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	Information about the specified IP	-

getSpecificIpAsync

public okhttp3.Call getSpecificIpAsync(@Nonnull
 Integer ipId,
 ApiCallback<IP> _callback)
                                throws ApiException

Get a Specific IP (asynchronously) Retrieves detailed information about a specific IP based on the provided ID.

Parameters:

ipId - The ID of the IP resource 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	Information about the specified IP	-

updateIpCall

public okhttp3.Call updateIpCall(@Nonnull
 Integer ipId,
 @Nonnull
 IPUpdateRequest ipUpdateRequest,
 ApiCallback _callback)
                          throws ApiException

Build call for updateIp

Parameters:

ipId - The ID of the IP resource to update (required)

ipUpdateRequest - (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 IP information	-

updateIp

public IP updateIp(@Nonnull
 Integer ipId,
 @Nonnull
 IPUpdateRequest ipUpdateRequest)
            throws ApiException

Update an Existing IP Updates an existing IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource to update (required)

ipUpdateRequest - (required)

Returns:

IP

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 IP information	-

updateIpWithHttpInfo

public ApiResponse<IP> updateIpWithHttpInfo(@Nonnull
 Integer ipId,
 @Nonnull
 IPUpdateRequest ipUpdateRequest)
                                     throws ApiException

Update an Existing IP Updates an existing IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource to update (required)

ipUpdateRequest - (required)

Returns:

ApiResponse<IP>

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 IP information	-

updateIpAsync

public okhttp3.Call updateIpAsync(@Nonnull
 Integer ipId,
 @Nonnull
 IPUpdateRequest ipUpdateRequest,
 ApiCallback<IP> _callback)
                           throws ApiException

Update an Existing IP (asynchronously) Updates an existing IP resource based on the provided IP ID.

Parameters:

ipId - The ID of the IP resource to update (required)

ipUpdateRequest - (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 IP information	-