Class DomainApi

java.lang.Object

sendpost_java_sdk.DomainApi

public class DomainApi
extends Object

Constructor Summary

Constructors

Constructor	Description
DomainApi()
DomainApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<Domain>	getAllDomains(Integer limit, Integer offset, String search)	Get All Domains Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.
okhttp3.Call	getAllDomainsAsync(Integer limit, Integer offset, String search, ApiCallback<List<Domain>> _callback)	Get All Domains (asynchronously) Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.
okhttp3.Call	getAllDomainsCall(Integer limit, Integer offset, String search, ApiCallback _callback)	Build call for getAllDomains
ApiResponse<List<Domain>>	getAllDomainsWithHttpInfo(Integer limit, Integer offset, String search)	Get All Domains Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
DeleteResponse	subaccountDomainDomainIdDelete(String domainId)	Delete a specific domain Delete a specific domain using its `id`.
okhttp3.Call	subaccountDomainDomainIdDeleteAsync(String domainId, ApiCallback<DeleteResponse> _callback)	Delete a specific domain (asynchronously) Delete a specific domain using its `id`.
okhttp3.Call	subaccountDomainDomainIdDeleteCall(String domainId, ApiCallback _callback)	Build call for subaccountDomainDomainIdDelete
ApiResponse<DeleteResponse>	subaccountDomainDomainIdDeleteWithHttpInfo(String domainId)	Delete a specific domain Delete a specific domain using its `id`.
Domain	subaccountDomainDomainIdGet(String domainId)	Get a specific domain Retrieve details of a specific domain using its `id`.
okhttp3.Call	subaccountDomainDomainIdGetAsync(String domainId, ApiCallback<Domain> _callback)	Get a specific domain (asynchronously) Retrieve details of a specific domain using its `id`.
okhttp3.Call	subaccountDomainDomainIdGetCall(String domainId, ApiCallback _callback)	Build call for subaccountDomainDomainIdGet
ApiResponse<Domain>	subaccountDomainDomainIdGetWithHttpInfo(String domainId)	Get a specific domain Retrieve details of a specific domain using its `id`.
Domain	subaccountDomainPost(CreateDomainRequest createDomainRequest)	Create a new domain Add a new domain using its `name`.
okhttp3.Call	subaccountDomainPostAsync(CreateDomainRequest createDomainRequest, ApiCallback<Domain> _callback)	Create a new domain (asynchronously) Add a new domain using its `name`.
okhttp3.Call	subaccountDomainPostCall(CreateDomainRequest createDomainRequest, ApiCallback _callback)	Build call for subaccountDomainPost
ApiResponse<Domain>	subaccountDomainPostWithHttpInfo(CreateDomainRequest createDomainRequest)	Create a new domain Add a new domain using its `name`.

Methods inherited from class java.lang.Object

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

Constructor Details

DomainApi

public DomainApi()

DomainApi

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

getAllDomainsCall

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

Build call for getAllDomains

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against domain names (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	List of domains retrieved successfully	-

getAllDomains

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

Get All Domains Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against domain names (optional)

Returns:

List<Domain>

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	List of domains retrieved successfully	-

getAllDomainsWithHttpInfo

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

Get All Domains Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against domain names (optional)

Returns:

ApiResponse<List<Domain>>

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	List of domains retrieved successfully	-

getAllDomainsAsync

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

Get All Domains (asynchronously) Retrieve a list of all domains associated with the sub-account, including their DNS records and authentication status.

Parameters:

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

offset - Number of initial records to skip (optional)

search - Case insensitive search against domain names (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	List of domains retrieved successfully	-

subaccountDomainDomainIdDeleteCall

public okhttp3.Call subaccountDomainDomainIdDeleteCall(@Nonnull
 String domainId,
 ApiCallback _callback)
                                                throws ApiException

Build call for subaccountDomainDomainIdDelete

Parameters:

domainId - The unique ID of the domain 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 response	-

subaccountDomainDomainIdDelete

public DeleteResponse subaccountDomainDomainIdDelete(@Nonnull
 String domainId)
                                              throws ApiException

Delete a specific domain Delete a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain to delete. (required)

Returns:

DeleteResponse

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 response	-

subaccountDomainDomainIdDeleteWithHttpInfo

public ApiResponse<DeleteResponse> subaccountDomainDomainIdDeleteWithHttpInfo(@Nonnull
 String domainId)
                                                                       throws ApiException

Delete a specific domain Delete a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain to delete. (required)

Returns:

ApiResponse<DeleteResponse>

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 response	-

subaccountDomainDomainIdDeleteAsync

public okhttp3.Call subaccountDomainDomainIdDeleteAsync(@Nonnull
 String domainId,
 ApiCallback<DeleteResponse> _callback)
                                                 throws ApiException

Delete a specific domain (asynchronously) Delete a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain 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 response	-

subaccountDomainDomainIdGetCall

public okhttp3.Call subaccountDomainDomainIdGetCall(@Nonnull
 String domainId,
 ApiCallback _callback)
                                             throws ApiException

Build call for subaccountDomainDomainIdGet

Parameters:

domainId - The unique ID of the domain 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	Successful response	-

subaccountDomainDomainIdGet

public Domain subaccountDomainDomainIdGet(@Nonnull
 String domainId)
                                   throws ApiException

Get a specific domain Retrieve details of a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain to retrieve. (required)

Returns:

Domain

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 response	-

subaccountDomainDomainIdGetWithHttpInfo

public ApiResponse<Domain> subaccountDomainDomainIdGetWithHttpInfo(@Nonnull
 String domainId)
                                                            throws ApiException

Get a specific domain Retrieve details of a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain to retrieve. (required)

Returns:

ApiResponse<Domain>

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 response	-

subaccountDomainDomainIdGetAsync

public okhttp3.Call subaccountDomainDomainIdGetAsync(@Nonnull
 String domainId,
 ApiCallback<Domain> _callback)
                                              throws ApiException

Get a specific domain (asynchronously) Retrieve details of a specific domain using its `id`.

Parameters:

domainId - The unique ID of the domain 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	Successful response	-

subaccountDomainPostCall

public okhttp3.Call subaccountDomainPostCall(@Nonnull
 CreateDomainRequest createDomainRequest,
 ApiCallback _callback)
                                      throws ApiException

Build call for subaccountDomainPost

Parameters:

createDomainRequest - (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
201	Successful response	-

subaccountDomainPost

public Domain subaccountDomainPost(@Nonnull
 CreateDomainRequest createDomainRequest)
                            throws ApiException

Create a new domain Add a new domain using its `name`.

Parameters:

createDomainRequest - (required)

Returns:

Domain

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
201	Successful response	-

subaccountDomainPostWithHttpInfo

public ApiResponse<Domain> subaccountDomainPostWithHttpInfo(@Nonnull
 CreateDomainRequest createDomainRequest)
                                                     throws ApiException

Create a new domain Add a new domain using its `name`.

Parameters:

createDomainRequest - (required)

Returns:

ApiResponse<Domain>

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
201	Successful response	-

subaccountDomainPostAsync

public okhttp3.Call subaccountDomainPostAsync(@Nonnull
 CreateDomainRequest createDomainRequest,
 ApiCallback<Domain> _callback)
                                       throws ApiException

Create a new domain (asynchronously) Add a new domain using its `name`.

Parameters:

createDomainRequest - (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
201	Successful response	-