TransactionalEmailsApi (sib-api-v3-sdk 5.3.0 API)

java.lang.Object
- sibApi.TransactionalEmailsApi

public class TransactionalEmailsApi
extends Object

Constructor Summary

Constructors
Constructor and Description

TransactionalEmailsApi()

TransactionalEmailsApi(ApiClient apiClient)

Constructors
Constructor and Description
`TransactionalEmailsApi()`
`TransactionalEmailsApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`blockNewDomain(BlockDomain blockDomain)` Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same
`com.squareup.okhttp.Call`	`blockNewDomainAsync(BlockDomain blockDomain, ApiCallback<Void> callback)` Add a new domain to the list of blocked domains (asynchronously) Blocks a new domain in order to avoid messages being sent to the same
`com.squareup.okhttp.Call`	`blockNewDomainCall(BlockDomain blockDomain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for blockNewDomain
`ApiResponse<Void>`	`blockNewDomainWithHttpInfo(BlockDomain blockDomain)` Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same
`CreateModel`	`createSmtpTemplate(CreateSmtpTemplate smtpTemplate)` Create an email template
`com.squareup.okhttp.Call`	`createSmtpTemplateAsync(CreateSmtpTemplate smtpTemplate, ApiCallback<CreateModel> callback)` Create an email template (asynchronously)
`com.squareup.okhttp.Call`	`createSmtpTemplateCall(CreateSmtpTemplate smtpTemplate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for createSmtpTemplate
`ApiResponse<CreateModel>`	`createSmtpTemplateWithHttpInfo(CreateSmtpTemplate smtpTemplate)` Create an email template
`void`	`deleteBlockedDomain(String domain)` Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains
`com.squareup.okhttp.Call`	`deleteBlockedDomainAsync(String domain, ApiCallback<Void> callback)` Unblock an existing domain from the list of blocked domains (asynchronously) Unblocks an existing domain from the list of blocked domains
`com.squareup.okhttp.Call`	`deleteBlockedDomainCall(String domain, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteBlockedDomain
`ApiResponse<Void>`	`deleteBlockedDomainWithHttpInfo(String domain)` Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains
`void`	`deleteHardbounces(DeleteHardbounces deleteHardbounces)` Delete hardbounces Delete hardbounces.
`com.squareup.okhttp.Call`	`deleteHardbouncesAsync(DeleteHardbounces deleteHardbounces, ApiCallback<Void> callback)` Delete hardbounces (asynchronously) Delete hardbounces.
`com.squareup.okhttp.Call`	`deleteHardbouncesCall(DeleteHardbounces deleteHardbounces, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteHardbounces
`ApiResponse<Void>`	`deleteHardbouncesWithHttpInfo(DeleteHardbounces deleteHardbounces)` Delete hardbounces Delete hardbounces.
`void`	`deleteSmtpTemplate(Long templateId)` Delete an inactive email template
`com.squareup.okhttp.Call`	`deleteSmtpTemplateAsync(Long templateId, ApiCallback<Void> callback)` Delete an inactive email template (asynchronously)
`com.squareup.okhttp.Call`	`deleteSmtpTemplateCall(Long templateId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for deleteSmtpTemplate
`ApiResponse<Void>`	`deleteSmtpTemplateWithHttpInfo(Long templateId)` Delete an inactive email template
`GetAggregatedReport`	`getAggregatedSmtpReport(String startDate, String endDate, Long days, String tag)` Get your transactional email activity aggregated over a period of time
`com.squareup.okhttp.Call`	`getAggregatedSmtpReportAsync(String startDate, String endDate, Long days, String tag, ApiCallback<GetAggregatedReport> callback)` Get your transactional email activity aggregated over a period of time (asynchronously)
`com.squareup.okhttp.Call`	`getAggregatedSmtpReportCall(String startDate, String endDate, Long days, String tag, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getAggregatedSmtpReport
`ApiResponse<GetAggregatedReport>`	`getAggregatedSmtpReportWithHttpInfo(String startDate, String endDate, Long days, String tag)` Get your transactional email activity aggregated over a period of time
`ApiClient`	`getApiClient()`
`GetBlockedDomains`	`getBlockedDomains()` Get the list of blocked domains Get the list of blocked domains
`com.squareup.okhttp.Call`	`getBlockedDomainsAsync(ApiCallback<GetBlockedDomains> callback)` Get the list of blocked domains (asynchronously) Get the list of blocked domains
`com.squareup.okhttp.Call`	`getBlockedDomainsCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getBlockedDomains
`ApiResponse<GetBlockedDomains>`	`getBlockedDomainsWithHttpInfo()` Get the list of blocked domains Get the list of blocked domains
`GetEmailEventReport`	`getEmailEventReport(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort)` Get all your transactional email activity (unaggregated events)
`com.squareup.okhttp.Call`	`getEmailEventReportAsync(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort, ApiCallback<GetEmailEventReport> callback)` Get all your transactional email activity (unaggregated events) (asynchronously)
`com.squareup.okhttp.Call`	`getEmailEventReportCall(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getEmailEventReport
`ApiResponse<GetEmailEventReport>`	`getEmailEventReportWithHttpInfo(Long limit, Long offset, String startDate, String endDate, Long days, String email, String event, String tags, String messageId, Long templateId, String sort)` Get all your transactional email activity (unaggregated events)
`GetReports`	`getSmtpReport(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort)` Get your transactional email activity aggregated per day
`com.squareup.okhttp.Call`	`getSmtpReportAsync(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort, ApiCallback<GetReports> callback)` Get your transactional email activity aggregated per day (asynchronously)
`com.squareup.okhttp.Call`	`getSmtpReportCall(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getSmtpReport
`ApiResponse<GetReports>`	`getSmtpReportWithHttpInfo(Long limit, Long offset, String startDate, String endDate, Long days, String tag, String sort)` Get your transactional email activity aggregated per day
`GetSmtpTemplateOverview`	`getSmtpTemplate(Long templateId)` Returns the template information
`com.squareup.okhttp.Call`	`getSmtpTemplateAsync(Long templateId, ApiCallback<GetSmtpTemplateOverview> callback)` Returns the template information (asynchronously)
`com.squareup.okhttp.Call`	`getSmtpTemplateCall(Long templateId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getSmtpTemplate
`GetSmtpTemplates`	`getSmtpTemplates(Boolean templateStatus, Long limit, Long offset, String sort)` Get the list of email templates
`com.squareup.okhttp.Call`	`getSmtpTemplatesAsync(Boolean templateStatus, Long limit, Long offset, String sort, ApiCallback<GetSmtpTemplates> callback)` Get the list of email templates (asynchronously)
`com.squareup.okhttp.Call`	`getSmtpTemplatesCall(Boolean templateStatus, Long limit, Long offset, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getSmtpTemplates
`ApiResponse<GetSmtpTemplates>`	`getSmtpTemplatesWithHttpInfo(Boolean templateStatus, Long limit, Long offset, String sort)` Get the list of email templates
`ApiResponse<GetSmtpTemplateOverview>`	`getSmtpTemplateWithHttpInfo(Long templateId)` Returns the template information
`GetTransacBlockedContacts`	`getTransacBlockedContacts(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort)` Get the list of blocked or unsubscribed transactional contacts
`com.squareup.okhttp.Call`	`getTransacBlockedContactsAsync(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort, ApiCallback<GetTransacBlockedContacts> callback)` Get the list of blocked or unsubscribed transactional contacts (asynchronously)
`com.squareup.okhttp.Call`	`getTransacBlockedContactsCall(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getTransacBlockedContacts
`ApiResponse<GetTransacBlockedContacts>`	`getTransacBlockedContactsWithHttpInfo(String startDate, String endDate, Long limit, Long offset, List<String> senders, String sort)` Get the list of blocked or unsubscribed transactional contacts
`GetTransacEmailContent`	`getTransacEmailContent(String uuid)` Get the personalized content of a sent transactional email
`com.squareup.okhttp.Call`	`getTransacEmailContentAsync(String uuid, ApiCallback<GetTransacEmailContent> callback)` Get the personalized content of a sent transactional email (asynchronously)
`com.squareup.okhttp.Call`	`getTransacEmailContentCall(String uuid, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getTransacEmailContent
`ApiResponse<GetTransacEmailContent>`	`getTransacEmailContentWithHttpInfo(String uuid)` Get the personalized content of a sent transactional email
`GetTransacEmailsList`	`getTransacEmailsList(String email, Long templateId, String messageId, String startDate, String endDate, String sort)` Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default.
`com.squareup.okhttp.Call`	`getTransacEmailsListAsync(String email, Long templateId, String messageId, String startDate, String endDate, String sort, ApiCallback<GetTransacEmailsList> callback)` Get the list of transactional emails on the basis of allowed filters (asynchronously) This endpoint will show the list of emails for past 30 days by default.
`com.squareup.okhttp.Call`	`getTransacEmailsListCall(String email, Long templateId, String messageId, String startDate, String endDate, String sort, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for getTransacEmailsList
`ApiResponse<GetTransacEmailsList>`	`getTransacEmailsListWithHttpInfo(String email, Long templateId, String messageId, String startDate, String endDate, String sort)` Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default.
`SendTemplateEmail`	`sendTemplate(Long templateId, SendEmail sendEmail)` Deprecated.
`com.squareup.okhttp.Call`	`sendTemplateAsync(Long templateId, SendEmail sendEmail, ApiCallback<SendTemplateEmail> callback)` Deprecated.
`com.squareup.okhttp.Call`	`sendTemplateCall(Long templateId, SendEmail sendEmail, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Deprecated.
`ApiResponse<SendTemplateEmail>`	`sendTemplateWithHttpInfo(Long templateId, SendEmail sendEmail)` Deprecated.
`void`	`sendTestTemplate(Long templateId, SendTestEmail sendTestEmail)` Send a template to your test list
`com.squareup.okhttp.Call`	`sendTestTemplateAsync(Long templateId, SendTestEmail sendTestEmail, ApiCallback<Void> callback)` Send a template to your test list (asynchronously)
`com.squareup.okhttp.Call`	`sendTestTemplateCall(Long templateId, SendTestEmail sendTestEmail, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for sendTestTemplate
`ApiResponse<Void>`	`sendTestTemplateWithHttpInfo(Long templateId, SendTestEmail sendTestEmail)` Send a template to your test list
`CreateSmtpEmail`	`sendTransacEmail(SendSmtpEmail sendSmtpEmail)` Send a transactional email
`com.squareup.okhttp.Call`	`sendTransacEmailAsync(SendSmtpEmail sendSmtpEmail, ApiCallback<CreateSmtpEmail> callback)` Send a transactional email (asynchronously)
`com.squareup.okhttp.Call`	`sendTransacEmailCall(SendSmtpEmail sendSmtpEmail, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for sendTransacEmail
`ApiResponse<CreateSmtpEmail>`	`sendTransacEmailWithHttpInfo(SendSmtpEmail sendSmtpEmail)` Send a transactional email
`void`	`setApiClient(ApiClient apiClient)`
`void`	`smtpBlockedContactsEmailDelete(String email)` Unblock or resubscribe a transactional contact
`com.squareup.okhttp.Call`	`smtpBlockedContactsEmailDeleteAsync(String email, ApiCallback<Void> callback)` Unblock or resubscribe a transactional contact (asynchronously)
`com.squareup.okhttp.Call`	`smtpBlockedContactsEmailDeleteCall(String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for smtpBlockedContactsEmailDelete
`ApiResponse<Void>`	`smtpBlockedContactsEmailDeleteWithHttpInfo(String email)` Unblock or resubscribe a transactional contact
`void`	`smtpLogMessageIdDelete(String messageId)` Delete an SMTP transactional log
`com.squareup.okhttp.Call`	`smtpLogMessageIdDeleteAsync(String messageId, ApiCallback<Void> callback)` Delete an SMTP transactional log (asynchronously)
`com.squareup.okhttp.Call`	`smtpLogMessageIdDeleteCall(String messageId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for smtpLogMessageIdDelete
`ApiResponse<Void>`	`smtpLogMessageIdDeleteWithHttpInfo(String messageId)` Delete an SMTP transactional log
`void`	`updateSmtpTemplate(Long templateId, UpdateSmtpTemplate smtpTemplate)` Update an email template
`com.squareup.okhttp.Call`	`updateSmtpTemplateAsync(Long templateId, UpdateSmtpTemplate smtpTemplate, ApiCallback<Void> callback)` Update an email template (asynchronously)
`com.squareup.okhttp.Call`	`updateSmtpTemplateCall(Long templateId, UpdateSmtpTemplate smtpTemplate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for updateSmtpTemplate
`ApiResponse<Void>`	`updateSmtpTemplateWithHttpInfo(Long templateId, UpdateSmtpTemplate smtpTemplate)` Update an email template

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TransactionalEmailsApi
```
public TransactionalEmailsApi()
```

TransactionalEmailsApi

public TransactionalEmailsApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

blockNewDomainCall

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

Build call for blockNewDomain

Parameters:: blockDomain - (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

blockNewDomain
```
public void blockNewDomain(BlockDomain blockDomain)
                    throws ApiException
```
Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same

Parameters:

blockDomain - (required)

Throws:

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

blockNewDomainWithHttpInfo
```
public ApiResponse<Void> blockNewDomainWithHttpInfo(BlockDomain blockDomain)
                                             throws ApiException
```
Add a new domain to the list of blocked domains Blocks a new domain in order to avoid messages being sent to the same

Parameters:

blockDomain - (required)

Returns:

ApiResponse<Void>

Throws:

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

blockNewDomainAsync
```
public com.squareup.okhttp.Call blockNewDomainAsync(BlockDomain blockDomain,
                                                    ApiCallback<Void> callback)
                                             throws ApiException
```
Add a new domain to the list of blocked domains (asynchronously) Blocks a new domain in order to avoid messages being sent to the same

Parameters:

blockDomain - (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

createSmtpTemplateCall

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

Build call for createSmtpTemplate

Parameters:: smtpTemplate - values to update in transactional email template (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

createSmtpTemplate
```
public CreateModel createSmtpTemplate(CreateSmtpTemplate smtpTemplate)
                               throws ApiException
```
Create an email template

Parameters:

smtpTemplate - values to update in transactional email template (required)

Returns:

CreateModel

Throws:

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

createSmtpTemplateWithHttpInfo
```
public ApiResponse<CreateModel> createSmtpTemplateWithHttpInfo(CreateSmtpTemplate smtpTemplate)
                                                        throws ApiException
```
Create an email template

Parameters:

smtpTemplate - values to update in transactional email template (required)

Returns:

ApiResponse<CreateModel>

Throws:

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

createSmtpTemplateAsync
```
public com.squareup.okhttp.Call createSmtpTemplateAsync(CreateSmtpTemplate smtpTemplate,
                                                        ApiCallback<CreateModel> callback)
                                                 throws ApiException
```
Create an email template (asynchronously)

Parameters:

smtpTemplate - values to update in transactional email template (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

deleteBlockedDomainCall

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

Build call for deleteBlockedDomain

Parameters:: domain - The name of the domain to be deleted (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteBlockedDomain
```
public void deleteBlockedDomain(String domain)
                         throws ApiException
```
Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains

Parameters:

domain - The name of the domain to be deleted (required)

Throws:

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

deleteBlockedDomainWithHttpInfo
```
public ApiResponse<Void> deleteBlockedDomainWithHttpInfo(String domain)
                                                  throws ApiException
```
Unblock an existing domain from the list of blocked domains Unblocks an existing domain from the list of blocked domains

Parameters:

domain - The name of the domain to be deleted (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteBlockedDomainAsync
```
public com.squareup.okhttp.Call deleteBlockedDomainAsync(String domain,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException
```
Unblock an existing domain from the list of blocked domains (asynchronously) Unblocks an existing domain from the list of blocked domains

Parameters:

domain - The name of the domain to be deleted (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

deleteHardbouncesCall

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

Build call for deleteHardbounces

Parameters:: deleteHardbounces - values to delete hardbounces (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteHardbounces
```
public void deleteHardbounces(DeleteHardbounces deleteHardbounces)
                       throws ApiException
```
Delete hardbounces Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

Parameters:

deleteHardbounces - values to delete hardbounces (optional)

Throws:

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

deleteHardbouncesWithHttpInfo
```
public ApiResponse<Void> deleteHardbouncesWithHttpInfo(DeleteHardbounces deleteHardbounces)
                                                throws ApiException
```
Delete hardbounces Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

Parameters:

deleteHardbounces - values to delete hardbounces (optional)

Returns:

ApiResponse<Void>

Throws:

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

deleteHardbouncesAsync
```
public com.squareup.okhttp.Call deleteHardbouncesAsync(DeleteHardbounces deleteHardbounces,
                                                       ApiCallback<Void> callback)
                                                throws ApiException
```
Delete hardbounces (asynchronously) Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)

Parameters:

deleteHardbounces - values to delete hardbounces (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

deleteSmtpTemplateCall

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

Build call for deleteSmtpTemplate

Parameters:: templateId - id of the template (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

deleteSmtpTemplate
```
public void deleteSmtpTemplate(Long templateId)
                        throws ApiException
```
Delete an inactive email template

Parameters:

templateId - id of the template (required)

Throws:

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

deleteSmtpTemplateWithHttpInfo
```
public ApiResponse<Void> deleteSmtpTemplateWithHttpInfo(Long templateId)
                                                 throws ApiException
```
Delete an inactive email template

Parameters:

templateId - id of the template (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSmtpTemplateAsync
```
public com.squareup.okhttp.Call deleteSmtpTemplateAsync(Long templateId,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException
```
Delete an inactive email template (asynchronously)

Parameters:

templateId - id of the template (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

getAggregatedSmtpReportCall

public com.squareup.okhttp.Call getAggregatedSmtpReportCall(String startDate,
                                                            String endDate,
                                                            Long days,
                                                            String tag,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for getAggregatedSmtpReport

Parameters:: startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getAggregatedSmtpReport
```
public GetAggregatedReport getAggregatedSmtpReport(String startDate,
                                                   String endDate,
                                                   Long days,
                                                   String tag)
                                            throws ApiException
```
Get your transactional email activity aggregated over a period of time

Parameters:

startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional)

endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Tag of the emails (optional)

Returns:

GetAggregatedReport

Throws:

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

getAggregatedSmtpReportWithHttpInfo

public ApiResponse<GetAggregatedReport> getAggregatedSmtpReportWithHttpInfo(String startDate,
                                                                            String endDate,
                                                                            Long days,
                                                                            String tag)
                                                                     throws ApiException

Get your transactional email activity aggregated over a period of time

Parameters:: startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (optional)
Returns:: ApiResponse<GetAggregatedReport>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAggregatedSmtpReportAsync

public com.squareup.okhttp.Call getAggregatedSmtpReportAsync(String startDate,
                                                             String endDate,
                                                             Long days,
                                                             String tag,
                                                             ApiCallback<GetAggregatedReport> callback)
                                                      throws ApiException

Get your transactional email activity aggregated over a period of time (asynchronously)

Parameters:: startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (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

getBlockedDomainsCall

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

Build call for getBlockedDomains

Parameters:: progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getBlockedDomains
```
public GetBlockedDomains getBlockedDomains()
                                    throws ApiException
```
Get the list of blocked domains Get the list of blocked domains

Returns:

GetBlockedDomains

Throws:

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

getBlockedDomainsWithHttpInfo
```
public ApiResponse<GetBlockedDomains> getBlockedDomainsWithHttpInfo()
                                                             throws ApiException
```
Get the list of blocked domains Get the list of blocked domains

Returns:

ApiResponse<GetBlockedDomains>

Throws:

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

getBlockedDomainsAsync
```
public com.squareup.okhttp.Call getBlockedDomainsAsync(ApiCallback<GetBlockedDomains> callback)
                                                throws ApiException
```
Get the list of blocked domains (asynchronously) Get the list of blocked domains

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

getEmailEventReportCall

public com.squareup.okhttp.Call getEmailEventReportCall(Long limit,
                                                        Long offset,
                                                        String startDate,
                                                        String endDate,
                                                        Long days,
                                                        String email,
                                                        String event,
                                                        String tags,
                                                        String messageId,
                                                        Long templateId,
                                                        String sort,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for getEmailEventReport

Parameters:: limit - Number limitation for the result returned (optional, default to 50); offset - Beginning point in the list to retrieve from. (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); email - Filter the report for a specific email addresses (optional); event - Filter the report for a specific event type (optional); tags - Filter the report for tags (serialized and urlencoded array) (optional); messageId - Filter on a specific message id (optional); templateId - Filter on a specific template id (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getEmailEventReport

public GetEmailEventReport getEmailEventReport(Long limit,
                                               Long offset,
                                               String startDate,
                                               String endDate,
                                               Long days,
                                               String email,
                                               String event,
                                               String tags,
                                               String messageId,
                                               Long templateId,
                                               String sort)
                                        throws ApiException

Get all your transactional email activity (unaggregated events)

Parameters:: limit - Number limitation for the result returned (optional, default to 50); offset - Beginning point in the list to retrieve from. (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); email - Filter the report for a specific email addresses (optional); event - Filter the report for a specific event type (optional); tags - Filter the report for tags (serialized and urlencoded array) (optional); messageId - Filter on a specific message id (optional); templateId - Filter on a specific template id (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
Returns:: GetEmailEventReport
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEmailEventReportWithHttpInfo

public ApiResponse<GetEmailEventReport> getEmailEventReportWithHttpInfo(Long limit,
                                                                        Long offset,
                                                                        String startDate,
                                                                        String endDate,
                                                                        Long days,
                                                                        String email,
                                                                        String event,
                                                                        String tags,
                                                                        String messageId,
                                                                        Long templateId,
                                                                        String sort)
                                                                 throws ApiException

Get all your transactional email activity (unaggregated events)

Parameters:: limit - Number limitation for the result returned (optional, default to 50); offset - Beginning point in the list to retrieve from. (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); email - Filter the report for a specific email addresses (optional); event - Filter the report for a specific event type (optional); tags - Filter the report for tags (serialized and urlencoded array) (optional); messageId - Filter on a specific message id (optional); templateId - Filter on a specific template id (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
Returns:: ApiResponse<GetEmailEventReport>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getEmailEventReportAsync

public com.squareup.okhttp.Call getEmailEventReportAsync(Long limit,
                                                         Long offset,
                                                         String startDate,
                                                         String endDate,
                                                         Long days,
                                                         String email,
                                                         String event,
                                                         String tags,
                                                         String messageId,
                                                         Long templateId,
                                                         String sort,
                                                         ApiCallback<GetEmailEventReport> callback)
                                                  throws ApiException

Get all your transactional email activity (unaggregated events) (asynchronously)

Parameters:: limit - Number limitation for the result returned (optional, default to 50); offset - Beginning point in the list to retrieve from. (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); email - Filter the report for a specific email addresses (optional); event - Filter the report for a specific event type (optional); tags - Filter the report for tags (serialized and urlencoded array) (optional); messageId - Filter on a specific message id (optional); templateId - Filter on a specific template id (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); 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

getSmtpReportCall

public com.squareup.okhttp.Call getSmtpReportCall(Long limit,
                                                  Long offset,
                                                  String startDate,
                                                  String endDate,
                                                  Long days,
                                                  String tag,
                                                  String sort,
                                                  ProgressResponseBody.ProgressListener progressListener,
                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                           throws ApiException

Build call for getSmtpReport

Parameters:: limit - Number of documents returned per page (optional, default to 10); offset - Index of the first document on the page (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getSmtpReport
```
public GetReports getSmtpReport(Long limit,
                                Long offset,
                                String startDate,
                                String endDate,
                                Long days,
                                String tag,
                                String sort)
                         throws ApiException
```
Get your transactional email activity aggregated per day

Parameters:

limit - Number of documents returned per page (optional, default to 10)

offset - Index of the first document on the page (optional, default to 0)

startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional)

endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional)

days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)

tag - Tag of the emails (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetReports

Throws:

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

getSmtpReportWithHttpInfo

public ApiResponse<GetReports> getSmtpReportWithHttpInfo(Long limit,
                                                         Long offset,
                                                         String startDate,
                                                         String endDate,
                                                         Long days,
                                                         String tag,
                                                         String sort)
                                                  throws ApiException

Get your transactional email activity aggregated per day

Parameters:: limit - Number of documents returned per page (optional, default to 10); offset - Index of the first document on the page (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
Returns:: ApiResponse<GetReports>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSmtpReportAsync

public com.squareup.okhttp.Call getSmtpReportAsync(Long limit,
                                                   Long offset,
                                                   String startDate,
                                                   String endDate,
                                                   Long days,
                                                   String tag,
                                                   String sort,
                                                   ApiCallback<GetReports> callback)
                                            throws ApiException

Get your transactional email activity aggregated per day (asynchronously)

Parameters:: limit - Number of documents returned per page (optional, default to 10); offset - Index of the first document on the page (optional, default to 0); startDate - Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) (optional); endDate - Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) (optional); days - Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional); tag - Tag of the emails (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); 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

getSmtpTemplateCall

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

Build call for getSmtpTemplate

Parameters:: templateId - id of the template (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getSmtpTemplate
```
public GetSmtpTemplateOverview getSmtpTemplate(Long templateId)
                                        throws ApiException
```
Returns the template information

Parameters:

templateId - id of the template (required)

Returns:

GetSmtpTemplateOverview

Throws:

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

getSmtpTemplateWithHttpInfo
```
public ApiResponse<GetSmtpTemplateOverview> getSmtpTemplateWithHttpInfo(Long templateId)
                                                                 throws ApiException
```
Returns the template information

Parameters:

templateId - id of the template (required)

Returns:

ApiResponse<GetSmtpTemplateOverview>

Throws:

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

getSmtpTemplateAsync
```
public com.squareup.okhttp.Call getSmtpTemplateAsync(Long templateId,
                                                     ApiCallback<GetSmtpTemplateOverview> callback)
                                              throws ApiException
```
Returns the template information (asynchronously)

Parameters:

templateId - id of the template (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

getSmtpTemplatesCall

public com.squareup.okhttp.Call getSmtpTemplatesCall(Boolean templateStatus,
                                                     Long limit,
                                                     Long offset,
                                                     String sort,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getSmtpTemplates

Parameters:: templateStatus - Filter on the status of the template. Active = true, inactive = false (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document in the page (optional, default to 0); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getSmtpTemplates
```
public GetSmtpTemplates getSmtpTemplates(Boolean templateStatus,
                                         Long limit,
                                         Long offset,
                                         String sort)
                                  throws ApiException
```
Get the list of email templates

Parameters:

templateStatus - Filter on the status of the template. Active = true, inactive = false (optional)

limit - Number of documents returned per page (optional, default to 50)

offset - Index of the first document in the page (optional, default to 0)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetSmtpTemplates

Throws:

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

getSmtpTemplatesWithHttpInfo

public ApiResponse<GetSmtpTemplates> getSmtpTemplatesWithHttpInfo(Boolean templateStatus,
                                                                  Long limit,
                                                                  Long offset,
                                                                  String sort)
                                                           throws ApiException

Get the list of email templates

Parameters:: templateStatus - Filter on the status of the template. Active = true, inactive = false (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document in the page (optional, default to 0); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
Returns:: ApiResponse<GetSmtpTemplates>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getSmtpTemplatesAsync

public com.squareup.okhttp.Call getSmtpTemplatesAsync(Boolean templateStatus,
                                                      Long limit,
                                                      Long offset,
                                                      String sort,
                                                      ApiCallback<GetSmtpTemplates> callback)
                                               throws ApiException

Get the list of email templates (asynchronously)

Parameters:: templateStatus - Filter on the status of the template. Active = true, inactive = false (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document in the page (optional, default to 0); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); 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

getTransacBlockedContactsCall

public com.squareup.okhttp.Call getTransacBlockedContactsCall(String startDate,
                                                              String endDate,
                                                              Long limit,
                                                              Long offset,
                                                              List<String> senders,
                                                              String sort,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for getTransacBlockedContacts

Parameters:: startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional); endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document on the page (optional, default to 0); senders - Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getTransacBlockedContacts
```
public GetTransacBlockedContacts getTransacBlockedContacts(String startDate,
                                                           String endDate,
                                                           Long limit,
                                                           Long offset,
                                                           List<String> senders,
                                                           String sort)
                                                    throws ApiException
```
Get the list of blocked or unsubscribed transactional contacts

Parameters:

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional)

limit - Number of documents returned per page (optional, default to 50)

offset - Index of the first document on the page (optional, default to 0)

senders - Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetTransacBlockedContacts

Throws:

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

getTransacBlockedContactsWithHttpInfo

public ApiResponse<GetTransacBlockedContacts> getTransacBlockedContactsWithHttpInfo(String startDate,
                                                                                    String endDate,
                                                                                    Long limit,
                                                                                    Long offset,
                                                                                    List<String> senders,
                                                                                    String sort)
                                                                             throws ApiException

Get the list of blocked or unsubscribed transactional contacts

Parameters:: startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional); endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document on the page (optional, default to 0); senders - Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
Returns:: ApiResponse<GetTransacBlockedContacts>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getTransacBlockedContactsAsync

public com.squareup.okhttp.Call getTransacBlockedContactsAsync(String startDate,
                                                               String endDate,
                                                               Long limit,
                                                               Long offset,
                                                               List<String> senders,
                                                               String sort,
                                                               ApiCallback<GetTransacBlockedContacts> callback)
                                                        throws ApiException

Get the list of blocked or unsubscribed transactional contacts (asynchronously)

Parameters:: startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts (optional); endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts (optional); limit - Number of documents returned per page (optional, default to 50); offset - Index of the first document on the page (optional, default to 0); senders - Comma separated list of emails of the senders from which contacts are blocked or unsubscribed (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); 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

getTransacEmailContentCall

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

Build call for getTransacEmailContent

Parameters:: uuid - Unique id of the transactional email that has been sent to a particular contact (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getTransacEmailContent
```
public GetTransacEmailContent getTransacEmailContent(String uuid)
                                              throws ApiException
```
Get the personalized content of a sent transactional email

Parameters:

uuid - Unique id of the transactional email that has been sent to a particular contact (required)

Returns:

GetTransacEmailContent

Throws:

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

getTransacEmailContentWithHttpInfo
```
public ApiResponse<GetTransacEmailContent> getTransacEmailContentWithHttpInfo(String uuid)
                                                                       throws ApiException
```
Get the personalized content of a sent transactional email

Parameters:

uuid - Unique id of the transactional email that has been sent to a particular contact (required)

Returns:

ApiResponse<GetTransacEmailContent>

Throws:

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

getTransacEmailContentAsync
```
public com.squareup.okhttp.Call getTransacEmailContentAsync(String uuid,
                                                            ApiCallback<GetTransacEmailContent> callback)
                                                     throws ApiException
```
Get the personalized content of a sent transactional email (asynchronously)

Parameters:

uuid - Unique id of the transactional email that has been sent to a particular contact (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

getTransacEmailsListCall

public com.squareup.okhttp.Call getTransacEmailsListCall(String email,
                                                         Long templateId,
                                                         String messageId,
                                                         String startDate,
                                                         String endDate,
                                                         String sort,
                                                         ProgressResponseBody.ProgressListener progressListener,
                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                  throws ApiException

Build call for getTransacEmailsList

Parameters:: email - Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional); templateId - Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional); messageId - Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional); startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional); endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional); sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

getTransacEmailsList
```
public GetTransacEmailsList getTransacEmailsList(String email,
                                                 Long templateId,
                                                 String messageId,
                                                 String startDate,
                                                 String endDate,
                                                 String sort)
                                          throws ApiException
```
Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

Parameters:

email - Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional)

templateId - Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional)

messageId - Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

GetTransacEmailsList

Throws:

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

getTransacEmailsListWithHttpInfo
```
public ApiResponse<GetTransacEmailsList> getTransacEmailsListWithHttpInfo(String email,
                                                                          Long templateId,
                                                                          String messageId,
                                                                          String startDate,
                                                                          String endDate,
                                                                          String sort)
                                                                   throws ApiException
```
Get the list of transactional emails on the basis of allowed filters This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

Parameters:

email - Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional)

templateId - Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional)

messageId - Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

Returns:

ApiResponse<GetTransacEmailsList>

Throws:

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

getTransacEmailsListAsync
```
public com.squareup.okhttp.Call getTransacEmailsListAsync(String email,
                                                          Long templateId,
                                                          String messageId,
                                                          String startDate,
                                                          String endDate,
                                                          String sort,
                                                          ApiCallback<GetTransacEmailsList> callback)
                                                   throws ApiException
```
Get the list of transactional emails on the basis of allowed filters (asynchronously) This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.

Parameters:

email - Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent. (optional)

templateId - Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email. (optional)

messageId - Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent. (optional)

startDate - Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

endDate - Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. (optional)

sort - Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)

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

sendTemplateCall

@Deprecated
public com.squareup.okhttp.Call sendTemplateCall(Long templateId,
                                                             SendEmail sendEmail,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Deprecated.

Build call for sendTemplate

Parameters:: templateId - Id of the template (required); sendEmail - (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

sendTemplate
```
@Deprecated
public SendTemplateEmail sendTemplate(Long templateId,
                                                  SendEmail sendEmail)
                                           throws ApiException
```
Deprecated.

Send a template This endpoint is deprecated. Prefer v3/smtp/email instead.

Parameters:

templateId - Id of the template (required)

sendEmail - (required)

Returns:

SendTemplateEmail

Throws:

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

sendTemplateWithHttpInfo

@Deprecated
public ApiResponse<SendTemplateEmail> sendTemplateWithHttpInfo(Long templateId,
                                                                           SendEmail sendEmail)
                                                                    throws ApiException

Deprecated.

Send a template This endpoint is deprecated. Prefer v3/smtp/email instead.

Parameters:: templateId - Id of the template (required); sendEmail - (required)
Returns:: ApiResponse<SendTemplateEmail>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

sendTemplateAsync

@Deprecated
public com.squareup.okhttp.Call sendTemplateAsync(Long templateId,
                                                              SendEmail sendEmail,
                                                              ApiCallback<SendTemplateEmail> callback)
                                                       throws ApiException

Deprecated.

Send a template (asynchronously) This endpoint is deprecated. Prefer v3/smtp/email instead.

Parameters:: templateId - Id of the template (required); sendEmail - (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

sendTestTemplateCall

public com.squareup.okhttp.Call sendTestTemplateCall(Long templateId,
                                                     SendTestEmail sendTestEmail,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for sendTestTemplate

Parameters:: templateId - Id of the template (required); sendTestEmail - (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

sendTestTemplate
```
public void sendTestTemplate(Long templateId,
                             SendTestEmail sendTestEmail)
                      throws ApiException
```
Send a template to your test list

Parameters:

templateId - Id of the template (required)

sendTestEmail - (required)

Throws:

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

sendTestTemplateWithHttpInfo

public ApiResponse<Void> sendTestTemplateWithHttpInfo(Long templateId,
                                                      SendTestEmail sendTestEmail)
                                               throws ApiException

Send a template to your test list

Parameters:: templateId - Id of the template (required); sendTestEmail - (required)
Returns:: ApiResponse<Void>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

sendTestTemplateAsync

public com.squareup.okhttp.Call sendTestTemplateAsync(Long templateId,
                                                      SendTestEmail sendTestEmail,
                                                      ApiCallback<Void> callback)
                                               throws ApiException

Send a template to your test list (asynchronously)

Parameters:: templateId - Id of the template (required); sendTestEmail - (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

sendTransacEmailCall

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

Build call for sendTransacEmail

Parameters:: sendSmtpEmail - Values to send a transactional email (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

sendTransacEmail
```
public CreateSmtpEmail sendTransacEmail(SendSmtpEmail sendSmtpEmail)
                                 throws ApiException
```
Send a transactional email

Parameters:

sendSmtpEmail - Values to send a transactional email (required)

Returns:

CreateSmtpEmail

Throws:

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

sendTransacEmailWithHttpInfo
```
public ApiResponse<CreateSmtpEmail> sendTransacEmailWithHttpInfo(SendSmtpEmail sendSmtpEmail)
                                                          throws ApiException
```
Send a transactional email

Parameters:

sendSmtpEmail - Values to send a transactional email (required)

Returns:

ApiResponse<CreateSmtpEmail>

Throws:

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

sendTransacEmailAsync
```
public com.squareup.okhttp.Call sendTransacEmailAsync(SendSmtpEmail sendSmtpEmail,
                                                      ApiCallback<CreateSmtpEmail> callback)
                                               throws ApiException
```
Send a transactional email (asynchronously)

Parameters:

sendSmtpEmail - Values to send a transactional email (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

smtpBlockedContactsEmailDeleteCall

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

Build call for smtpBlockedContactsEmailDelete

Parameters:: email - contact email (urlencoded) to unblock. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

smtpBlockedContactsEmailDelete
```
public void smtpBlockedContactsEmailDelete(String email)
                                    throws ApiException
```
Unblock or resubscribe a transactional contact

Parameters:

email - contact email (urlencoded) to unblock. (required)

Throws:

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

smtpBlockedContactsEmailDeleteWithHttpInfo
```
public ApiResponse<Void> smtpBlockedContactsEmailDeleteWithHttpInfo(String email)
                                                             throws ApiException
```
Unblock or resubscribe a transactional contact

Parameters:

email - contact email (urlencoded) to unblock. (required)

Returns:

ApiResponse<Void>

Throws:

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

smtpBlockedContactsEmailDeleteAsync
```
public com.squareup.okhttp.Call smtpBlockedContactsEmailDeleteAsync(String email,
                                                                    ApiCallback<Void> callback)
                                                             throws ApiException
```
Unblock or resubscribe a transactional contact (asynchronously)

Parameters:

email - contact email (urlencoded) to unblock. (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

smtpLogMessageIdDeleteCall

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

Build call for smtpLogMessageIdDelete

Parameters:: messageId - MessageId of the transactional log to delete (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

smtpLogMessageIdDelete
```
public void smtpLogMessageIdDelete(String messageId)
                            throws ApiException
```
Delete an SMTP transactional log

Parameters:

messageId - MessageId of the transactional log to delete (required)

Throws:

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

smtpLogMessageIdDeleteWithHttpInfo
```
public ApiResponse<Void> smtpLogMessageIdDeleteWithHttpInfo(String messageId)
                                                     throws ApiException
```
Delete an SMTP transactional log

Parameters:

messageId - MessageId of the transactional log to delete (required)

Returns:

ApiResponse<Void>

Throws:

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

smtpLogMessageIdDeleteAsync
```
public com.squareup.okhttp.Call smtpLogMessageIdDeleteAsync(String messageId,
                                                            ApiCallback<Void> callback)
                                                     throws ApiException
```
Delete an SMTP transactional log (asynchronously)

Parameters:

messageId - MessageId of the transactional log 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

updateSmtpTemplateCall

public com.squareup.okhttp.Call updateSmtpTemplateCall(Long templateId,
                                                       UpdateSmtpTemplate smtpTemplate,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for updateSmtpTemplate

Parameters:: templateId - id of the template (required); smtpTemplate - values to update in transactional email template (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

updateSmtpTemplate
```
public void updateSmtpTemplate(Long templateId,
                               UpdateSmtpTemplate smtpTemplate)
                        throws ApiException
```
Update an email template

Parameters:

templateId - id of the template (required)

smtpTemplate - values to update in transactional email template (required)

Throws:

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

updateSmtpTemplateWithHttpInfo
```
public ApiResponse<Void> updateSmtpTemplateWithHttpInfo(Long templateId,
                                                        UpdateSmtpTemplate smtpTemplate)
                                                 throws ApiException
```
Update an email template

Parameters:

templateId - id of the template (required)

smtpTemplate - values to update in transactional email template (required)

Returns:

ApiResponse<Void>

Throws:

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

updateSmtpTemplateAsync

public com.squareup.okhttp.Call updateSmtpTemplateAsync(Long templateId,
                                                        UpdateSmtpTemplate smtpTemplate,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Update an email template (asynchronously)

Parameters:: templateId - id of the template (required); smtpTemplate - values to update in transactional email template (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

Class TransactionalEmailsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransactionalEmailsApi

TransactionalEmailsApi

Method Detail

getApiClient

setApiClient

blockNewDomainCall

blockNewDomain

blockNewDomainWithHttpInfo

blockNewDomainAsync

createSmtpTemplateCall

createSmtpTemplate

createSmtpTemplateWithHttpInfo

createSmtpTemplateAsync

deleteBlockedDomainCall

deleteBlockedDomain

deleteBlockedDomainWithHttpInfo

deleteBlockedDomainAsync

deleteHardbouncesCall

deleteHardbounces

deleteHardbouncesWithHttpInfo

deleteHardbouncesAsync

deleteSmtpTemplateCall

deleteSmtpTemplate

deleteSmtpTemplateWithHttpInfo

deleteSmtpTemplateAsync

getAggregatedSmtpReportCall

getAggregatedSmtpReport

getAggregatedSmtpReportWithHttpInfo

getAggregatedSmtpReportAsync

getBlockedDomainsCall

getBlockedDomains

getBlockedDomainsWithHttpInfo

getBlockedDomainsAsync

getEmailEventReportCall

getEmailEventReport

getEmailEventReportWithHttpInfo

getEmailEventReportAsync

getSmtpReportCall

getSmtpReport

getSmtpReportWithHttpInfo

getSmtpReportAsync

getSmtpTemplateCall

getSmtpTemplate

getSmtpTemplateWithHttpInfo

getSmtpTemplateAsync

getSmtpTemplatesCall

getSmtpTemplates

getSmtpTemplatesWithHttpInfo

getSmtpTemplatesAsync

getTransacBlockedContactsCall

getTransacBlockedContacts

getTransacBlockedContactsWithHttpInfo

getTransacBlockedContactsAsync

getTransacEmailContentCall

getTransacEmailContent

getTransacEmailContentWithHttpInfo

getTransacEmailContentAsync

getTransacEmailsListCall

getTransacEmailsList

getTransacEmailsListWithHttpInfo

getTransacEmailsListAsync

sendTemplateCall

sendTemplate

sendTemplateWithHttpInfo

sendTemplateAsync

sendTestTemplateCall

sendTestTemplate

sendTestTemplateWithHttpInfo

sendTestTemplateAsync

sendTransacEmailCall

sendTransacEmail

sendTransacEmailWithHttpInfo

sendTransacEmailAsync

smtpBlockedContactsEmailDeleteCall

smtpBlockedContactsEmailDelete