Class SenderIdentitiesApi

java.lang.Object

com.boldsign.api.SenderIdentitiesApi

public class SenderIdentitiesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SenderIdentitiesApi()
SenderIdentitiesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SenderIdentityCreated	createSenderIdentities(CreateSenderIdentityRequest createSenderIdentityRequest)	Creates sender identity.
okhttp3.Call	createSenderIdentitiesAsync(CreateSenderIdentityRequest createSenderIdentityRequest, ApiCallback<SenderIdentityCreated> _callback)	Creates sender identity.
okhttp3.Call	createSenderIdentitiesCall(CreateSenderIdentityRequest createSenderIdentityRequest, ApiCallback _callback)	Build call for createSenderIdentities
ApiResponse<SenderIdentityCreated>	createSenderIdentitiesWithHttpInfo(CreateSenderIdentityRequest createSenderIdentityRequest)	Creates sender identity.
void	deleteSenderIdentities(String email)	Deletes sender identity.
okhttp3.Call	deleteSenderIdentitiesAsync(String email, ApiCallback<Void> _callback)	Deletes sender identity.
okhttp3.Call	deleteSenderIdentitiesCall(String email, ApiCallback _callback)	Build call for deleteSenderIdentities
ApiResponse<Void>	deleteSenderIdentitiesWithHttpInfo(String email)	Deletes sender identity.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SenderIdentityList	listSenderIdentities(Integer page, Integer pageSize, String search, List<String> brandIds)	Lists sender identity.
okhttp3.Call	listSenderIdentitiesAsync(Integer page, Integer pageSize, String search, List<String> brandIds, ApiCallback<SenderIdentityList> _callback)	Lists sender identity.
okhttp3.Call	listSenderIdentitiesCall(Integer page, Integer pageSize, String search, List<String> brandIds, ApiCallback _callback)	Build call for listSenderIdentities
ApiResponse<SenderIdentityList>	listSenderIdentitiesWithHttpInfo(Integer page, Integer pageSize, String search, List<String> brandIds)	Lists sender identity.
void	reRequestSenderIdentities(String email)	Rerequests denied sender identity.
okhttp3.Call	reRequestSenderIdentitiesAsync(String email, ApiCallback<Void> _callback)	Rerequests denied sender identity.
okhttp3.Call	reRequestSenderIdentitiesCall(String email, ApiCallback _callback)	Build call for reRequestSenderIdentities
ApiResponse<Void>	reRequestSenderIdentitiesWithHttpInfo(String email)	Rerequests denied sender identity.
void	resendInvitationSenderIdentities(String email)	Resends sender identity invitation.
okhttp3.Call	resendInvitationSenderIdentitiesAsync(String email, ApiCallback<Void> _callback)	Resends sender identity invitation.
okhttp3.Call	resendInvitationSenderIdentitiesCall(String email, ApiCallback _callback)	Build call for resendInvitationSenderIdentities
ApiResponse<Void>	resendInvitationSenderIdentitiesWithHttpInfo(String email)	Resends sender identity invitation.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
void	updateSenderIdentities(String email, EditSenderIdentityRequest editSenderIdentityRequest)	Updates sender identity.
okhttp3.Call	updateSenderIdentitiesAsync(String email, EditSenderIdentityRequest editSenderIdentityRequest, ApiCallback<Void> _callback)	Updates sender identity.
okhttp3.Call	updateSenderIdentitiesCall(String email, EditSenderIdentityRequest editSenderIdentityRequest, ApiCallback _callback)	Build call for updateSenderIdentities
ApiResponse<Void>	updateSenderIdentitiesWithHttpInfo(String email, EditSenderIdentityRequest editSenderIdentityRequest)	Updates sender identity.

Methods inherited from class java.lang.Object

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

Constructor Details

SenderIdentitiesApi

public SenderIdentitiesApi()

SenderIdentitiesApi

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

createSenderIdentitiesCall

public okhttp3.Call createSenderIdentitiesCall(CreateSenderIdentityRequest createSenderIdentityRequest,
 ApiCallback _callback)
                                        throws ApiException

Build call for createSenderIdentities

Parameters:

createSenderIdentityRequest - The create sender identity request. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

createSenderIdentities

public SenderIdentityCreated createSenderIdentities(CreateSenderIdentityRequest createSenderIdentityRequest)
                                             throws ApiException

Creates sender identity.

Parameters:

createSenderIdentityRequest - The create sender identity request. (required)

Returns:

SenderIdentityCreated

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

createSenderIdentitiesWithHttpInfo

public ApiResponse<SenderIdentityCreated> createSenderIdentitiesWithHttpInfo(CreateSenderIdentityRequest createSenderIdentityRequest)
                                                                      throws ApiException

Creates sender identity.

Parameters:

createSenderIdentityRequest - The create sender identity request. (required)

Returns:

ApiResponse<SenderIdentityCreated>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

createSenderIdentitiesAsync

public okhttp3.Call createSenderIdentitiesAsync(CreateSenderIdentityRequest createSenderIdentityRequest,
 ApiCallback<SenderIdentityCreated> _callback)
                                         throws ApiException

Creates sender identity. (asynchronously)

Parameters:

createSenderIdentityRequest - The create sender identity request. (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:

Status Code	Description	Response Headers
201	Created	-
401	Unauthorized	-
403	Forbidden	-
400	Bad Request	-

deleteSenderIdentitiesCall

public okhttp3.Call deleteSenderIdentitiesCall(String email,
 ApiCallback _callback)
                                        throws ApiException

Build call for deleteSenderIdentities

Parameters:

email - The email address. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteSenderIdentities

public void deleteSenderIdentities(String email)
                            throws ApiException

Deletes sender identity.

Parameters:

email - The email address. (required)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteSenderIdentitiesWithHttpInfo

public ApiResponse<Void> deleteSenderIdentitiesWithHttpInfo(String email)
                                                     throws ApiException

Deletes sender identity.

Parameters:

email - The email address. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

deleteSenderIdentitiesAsync

public okhttp3.Call deleteSenderIdentitiesAsync(String email,
 ApiCallback<Void> _callback)
                                         throws ApiException

Deletes sender identity. (asynchronously)

Parameters:

email - The email address. (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:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

listSenderIdentitiesCall

public okhttp3.Call listSenderIdentitiesCall(Integer page,
 Integer pageSize,
 String search,
 List<String> brandIds,
 ApiCallback _callback)
                                      throws ApiException

Build call for listSenderIdentities

Parameters:

page - Page index specified in get sender identity request. (required)

pageSize - Page size specified in get sender identity list request. (optional, default to 10)

search - Users can be listed by the search key present in the sender identity like sender identity name and email address (optional)

brandIds - A list of brand IDs to filter associated with the sender identity. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

listSenderIdentities

public SenderIdentityList listSenderIdentities(Integer page,
 Integer pageSize,
 String search,
 List<String> brandIds)
                                        throws ApiException

Lists sender identity.

Parameters:

page - Page index specified in get sender identity request. (required)

pageSize - Page size specified in get sender identity list request. (optional, default to 10)

search - Users can be listed by the search key present in the sender identity like sender identity name and email address (optional)

brandIds - A list of brand IDs to filter associated with the sender identity. (optional)

Returns:

SenderIdentityList

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

listSenderIdentitiesWithHttpInfo

public ApiResponse<SenderIdentityList> listSenderIdentitiesWithHttpInfo(Integer page,
 Integer pageSize,
 String search,
 List<String> brandIds)
                                                                 throws ApiException

Lists sender identity.

Parameters:

page - Page index specified in get sender identity request. (required)

pageSize - Page size specified in get sender identity list request. (optional, default to 10)

search - Users can be listed by the search key present in the sender identity like sender identity name and email address (optional)

brandIds - A list of brand IDs to filter associated with the sender identity. (optional)

Returns:

ApiResponse<SenderIdentityList>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

listSenderIdentitiesAsync

public okhttp3.Call listSenderIdentitiesAsync(Integer page,
 Integer pageSize,
 String search,
 List<String> brandIds,
 ApiCallback<SenderIdentityList> _callback)
                                       throws ApiException

Lists sender identity. (asynchronously)

Parameters:

page - Page index specified in get sender identity request. (required)

pageSize - Page size specified in get sender identity list request. (optional, default to 10)

search - Users can be listed by the search key present in the sender identity like sender identity name and email address (optional)

brandIds - A list of brand IDs to filter associated with the sender identity. (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:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

reRequestSenderIdentitiesCall

public okhttp3.Call reRequestSenderIdentitiesCall(String email,
 ApiCallback _callback)
                                           throws ApiException

Build call for reRequestSenderIdentities

Parameters:

email - The email address. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

reRequestSenderIdentities

public void reRequestSenderIdentities(String email)
                               throws ApiException

Rerequests denied sender identity.

Parameters:

email - The email address. (required)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

reRequestSenderIdentitiesWithHttpInfo

public ApiResponse<Void> reRequestSenderIdentitiesWithHttpInfo(String email)
                                                        throws ApiException

Rerequests denied sender identity.

Parameters:

email - The email address. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

reRequestSenderIdentitiesAsync

public okhttp3.Call reRequestSenderIdentitiesAsync(String email,
 ApiCallback<Void> _callback)
                                            throws ApiException

Rerequests denied sender identity. (asynchronously)

Parameters:

email - The email address. (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:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

resendInvitationSenderIdentitiesCall

public okhttp3.Call resendInvitationSenderIdentitiesCall(String email,
 ApiCallback _callback)
                                                  throws ApiException

Build call for resendInvitationSenderIdentities

Parameters:

email - The email address. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

resendInvitationSenderIdentities

public void resendInvitationSenderIdentities(String email)
                                      throws ApiException

Resends sender identity invitation.

Parameters:

email - The email address. (required)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

resendInvitationSenderIdentitiesWithHttpInfo

public ApiResponse<Void> resendInvitationSenderIdentitiesWithHttpInfo(String email)
                                                               throws ApiException

Resends sender identity invitation.

Parameters:

email - The email address. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

resendInvitationSenderIdentitiesAsync

public okhttp3.Call resendInvitationSenderIdentitiesAsync(String email,
 ApiCallback<Void> _callback)
                                                   throws ApiException

Resends sender identity invitation. (asynchronously)

Parameters:

email - The email address. (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:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

updateSenderIdentitiesCall

public okhttp3.Call updateSenderIdentitiesCall(String email,
 EditSenderIdentityRequest editSenderIdentityRequest,
 ApiCallback _callback)
                                        throws ApiException

Build call for updateSenderIdentities

Parameters:

email - The email address. (required)

editSenderIdentityRequest - The create sender identity request. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

updateSenderIdentities

public void updateSenderIdentities(String email,
 EditSenderIdentityRequest editSenderIdentityRequest)
                            throws ApiException

Updates sender identity.

Parameters:

email - The email address. (required)

editSenderIdentityRequest - The create sender identity request. (required)

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

updateSenderIdentitiesWithHttpInfo

public ApiResponse<Void> updateSenderIdentitiesWithHttpInfo(String email,
 EditSenderIdentityRequest editSenderIdentityRequest)
                                                     throws ApiException

Updates sender identity.

Parameters:

email - The email address. (required)

editSenderIdentityRequest - The create sender identity request. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-

updateSenderIdentitiesAsync

public okhttp3.Call updateSenderIdentitiesAsync(String email,
 EditSenderIdentityRequest editSenderIdentityRequest,
 ApiCallback<Void> _callback)
                                         throws ApiException

Updates sender identity. (asynchronously)

Parameters:

email - The email address. (required)

editSenderIdentityRequest - The create sender identity request. (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:

Status Code	Description	Response Headers
204	No Content	-
401	Unauthorized	-
403	Forbidden	-