sibApi

Class SendersApi

java.lang.Object

sibApi.SendersApi

public class SendersApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SendersApi()
SendersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateSenderModel	createSender(CreateSender sender) Create a new sender
com.squareup.okhttp.Call	createSenderAsync(CreateSender sender, ApiCallback<CreateSenderModel> callback) Create a new sender (asynchronously)
com.squareup.okhttp.Call	createSenderCall(CreateSender sender, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createSender
ApiResponse<CreateSenderModel>	createSenderWithHttpInfo(CreateSender sender) Create a new sender
void	deleteSender(Long senderId) Delete a sender
com.squareup.okhttp.Call	deleteSenderAsync(Long senderId, ApiCallback<Void> callback) Delete a sender (asynchronously)
com.squareup.okhttp.Call	deleteSenderCall(Long senderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteSender
ApiResponse<Void>	deleteSenderWithHttpInfo(Long senderId) Delete a sender
ApiClient	getApiClient()
GetIps	getIps() Get all the dedicated IPs for your account
com.squareup.okhttp.Call	getIpsAsync(ApiCallback<GetIps> callback) Get all the dedicated IPs for your account (asynchronously)
com.squareup.okhttp.Call	getIpsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getIps
GetIpsFromSender	getIpsFromSender(Long senderId) Get all the dedicated IPs for a sender
com.squareup.okhttp.Call	getIpsFromSenderAsync(Long senderId, ApiCallback<GetIpsFromSender> callback) Get all the dedicated IPs for a sender (asynchronously)
com.squareup.okhttp.Call	getIpsFromSenderCall(Long senderId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getIpsFromSender
ApiResponse<GetIpsFromSender>	getIpsFromSenderWithHttpInfo(Long senderId) Get all the dedicated IPs for a sender
ApiResponse<GetIps>	getIpsWithHttpInfo() Get all the dedicated IPs for your account
GetSendersList	getSenders(String ip, String domain) Get the list of all your senders
com.squareup.okhttp.Call	getSendersAsync(String ip, String domain, ApiCallback<GetSendersList> callback) Get the list of all your senders (asynchronously)
com.squareup.okhttp.Call	getSendersCall(String ip, String domain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSenders
ApiResponse<GetSendersList>	getSendersWithHttpInfo(String ip, String domain) Get the list of all your senders
void	setApiClient(ApiClient apiClient)
void	updateSender(Long senderId, UpdateSender sender) Update a sender
com.squareup.okhttp.Call	updateSenderAsync(Long senderId, UpdateSender sender, ApiCallback<Void> callback) Update a sender (asynchronously)
com.squareup.okhttp.Call	updateSenderCall(Long senderId, UpdateSender sender, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateSender
ApiResponse<Void>	updateSenderWithHttpInfo(Long senderId, UpdateSender sender) Update a sender

Methods inherited from class java.lang.Object

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

Constructor Detail

SendersApi

public SendersApi()

SendersApi

public SendersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSenderCall

public com.squareup.okhttp.Call createSenderCall(CreateSender sender,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for createSender

Parameters:

sender - sender's name (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createSender

public CreateSenderModel createSender(CreateSender sender)
                               throws ApiException

Create a new sender

Parameters:

sender - sender's name (optional)

Returns:

CreateSenderModel

Throws:

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

createSenderWithHttpInfo

public ApiResponse<CreateSenderModel> createSenderWithHttpInfo(CreateSender sender)
                                                        throws ApiException

Create a new sender

Parameters:

sender - sender's name (optional)

Returns:

ApiResponse<CreateSenderModel>

Throws:

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

createSenderAsync

public com.squareup.okhttp.Call createSenderAsync(CreateSender sender,
                                                  ApiCallback<CreateSenderModel> callback)
                                           throws ApiException

Create a new sender (asynchronously)

Parameters:

sender - sender's 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

deleteSenderCall

public com.squareup.okhttp.Call deleteSenderCall(Long senderId,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for deleteSender

Parameters:

senderId - Id of the sender (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteSender

public void deleteSender(Long senderId)
                  throws ApiException

Delete a sender

Parameters:

senderId - Id of the sender (required)

Throws:

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

deleteSenderWithHttpInfo

public ApiResponse<Void> deleteSenderWithHttpInfo(Long senderId)
                                           throws ApiException

Delete a sender

Parameters:

senderId - Id of the sender (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSenderAsync

public com.squareup.okhttp.Call deleteSenderAsync(Long senderId,
                                                  ApiCallback<Void> callback)
                                           throws ApiException

Delete a sender (asynchronously)

Parameters:

senderId - Id of the sender (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

getIpsCall

public com.squareup.okhttp.Call getIpsCall(ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for getIps

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getIps

public GetIps getIps()
              throws ApiException

Get all the dedicated IPs for your account

Returns:

GetIps

Throws:

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

getIpsWithHttpInfo

public ApiResponse<GetIps> getIpsWithHttpInfo()
                                       throws ApiException

Get all the dedicated IPs for your account

Returns:

ApiResponse<GetIps>

Throws:

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

getIpsAsync

public com.squareup.okhttp.Call getIpsAsync(ApiCallback<GetIps> callback)
                                     throws ApiException

Get all the dedicated IPs for your account (asynchronously)

Parameters:

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

getIpsFromSenderCall

public com.squareup.okhttp.Call getIpsFromSenderCall(Long senderId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getIpsFromSender

Parameters:

senderId - Id of the sender (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getIpsFromSender

public GetIpsFromSender getIpsFromSender(Long senderId)
                                  throws ApiException

Get all the dedicated IPs for a sender

Parameters:

senderId - Id of the sender (required)

Returns:

GetIpsFromSender

Throws:

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

getIpsFromSenderWithHttpInfo

public ApiResponse<GetIpsFromSender> getIpsFromSenderWithHttpInfo(Long senderId)
                                                           throws ApiException

Get all the dedicated IPs for a sender

Parameters:

senderId - Id of the sender (required)

Returns:

ApiResponse<GetIpsFromSender>

Throws:

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

getIpsFromSenderAsync

public com.squareup.okhttp.Call getIpsFromSenderAsync(Long senderId,
                                                      ApiCallback<GetIpsFromSender> callback)
                                               throws ApiException

Get all the dedicated IPs for a sender (asynchronously)

Parameters:

senderId - Id of the sender (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

getSendersCall

public com.squareup.okhttp.Call getSendersCall(String ip,
                                               String domain,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for getSenders

Parameters:

ip - Filter your senders for a specific ip (available for dedicated IP usage only) (optional)

domain - Filter your senders for a specific domain (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSenders

public GetSendersList getSenders(String ip,
                                 String domain)
                          throws ApiException

Get the list of all your senders

Parameters:

ip - Filter your senders for a specific ip (available for dedicated IP usage only) (optional)

domain - Filter your senders for a specific domain (optional)

Returns:

GetSendersList

Throws:

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

getSendersWithHttpInfo

public ApiResponse<GetSendersList> getSendersWithHttpInfo(String ip,
                                                          String domain)
                                                   throws ApiException

Get the list of all your senders

Parameters:

ip - Filter your senders for a specific ip (available for dedicated IP usage only) (optional)

domain - Filter your senders for a specific domain (optional)

Returns:

ApiResponse<GetSendersList>

Throws:

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

getSendersAsync

public com.squareup.okhttp.Call getSendersAsync(String ip,
                                                String domain,
                                                ApiCallback<GetSendersList> callback)
                                         throws ApiException

Get the list of all your senders (asynchronously)

Parameters:

ip - Filter your senders for a specific ip (available for dedicated IP usage only) (optional)

domain - Filter your senders for a specific domain (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

updateSenderCall

public com.squareup.okhttp.Call updateSenderCall(Long senderId,
                                                 UpdateSender sender,
                                                 ProgressResponseBody.ProgressListener progressListener,
                                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                          throws ApiException

Build call for updateSender

Parameters:

senderId - Id of the sender (required)

sender - sender's name (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateSender

public void updateSender(Long senderId,
                         UpdateSender sender)
                  throws ApiException

Update a sender

Parameters:

senderId - Id of the sender (required)

sender - sender's name (optional)

Throws:

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

updateSenderWithHttpInfo

public ApiResponse<Void> updateSenderWithHttpInfo(Long senderId,
                                                  UpdateSender sender)
                                           throws ApiException

Update a sender

Parameters:

senderId - Id of the sender (required)

sender - sender's name (optional)

Returns:

ApiResponse<Void>

Throws:

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

updateSenderAsync

public com.squareup.okhttp.Call updateSenderAsync(Long senderId,
                                                  UpdateSender sender,
                                                  ApiCallback<Void> callback)
                                           throws ApiException

Update a sender (asynchronously)

Parameters:

senderId - Id of the sender (required)

sender - sender's 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