ReportsApi (elasticemail-RESTful-API 3.0.1 API)

java.lang.Object
- io.swagger.client.api.ReportsApi

```
public class ReportsApi
extends Object
```

Constructor Summary

Constructors
Constructor and Description

ReportsApi()

ReportsApi(ApiClient apiClient)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiClient`	`getApiClient()`
`Log`	`reportsBouncedGet(List<String> messageCategories, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress)` Returns bounced logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsBouncedGetAsync(List<String> messageCategories, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress, ApiCallback<Log> callback)` Returns bounced logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsBouncedGetCall(List<String> messageCategories, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsBouncedGet
`ApiResponse<Log>`	`reportsBouncedGetWithHttpInfo(List<String> messageCategories, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress)` Returns bounced logs filtered by specified parameters.
`List<EmailCredits>`	`reportsEmailcreditsHistoryGet()` Lists email credits history
`com.squareup.okhttp.Call`	`reportsEmailcreditsHistoryGetAsync(ApiCallback<List<EmailCredits>> callback)` Lists email credits history (asynchronously)
`com.squareup.okhttp.Call`	`reportsEmailcreditsHistoryGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsEmailcreditsHistoryGet
`ApiResponse<List<EmailCredits>>`	`reportsEmailcreditsHistoryGetWithHttpInfo()` Lists email credits history
`EventLog`	`reportsEventlogGet(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset)` Returns log of delivery events filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsEventlogGetAsync(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, ApiCallback<EventLog> callback)` Returns log of delivery events filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsEventlogGetCall(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsEventlogGet
`ApiResponse<EventLog>`	`reportsEventlogGetWithHttpInfo(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset)` Returns log of delivery events filtered by specified parameters.
`ExportLink`	`reportsEventsExportGet(List<String> statuses, String from, String to, String channelName, String fileFormat, String compressionFormat, String fileName)` Export delivery events log information to the specified file format.
`com.squareup.okhttp.Call`	`reportsEventsExportGetAsync(List<String> statuses, String from, String to, String channelName, String fileFormat, String compressionFormat, String fileName, ApiCallback<ExportLink> callback)` Export delivery events log information to the specified file format.
`com.squareup.okhttp.Call`	`reportsEventsExportGetCall(List<String> statuses, String from, String to, String channelName, String fileFormat, String compressionFormat, String fileName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsEventsExportGet
`ApiResponse<ExportLink>`	`reportsEventsExportGetWithHttpInfo(List<String> statuses, String from, String to, String channelName, String fileFormat, String compressionFormat, String fileName)` Export delivery events log information to the specified file format.
`ExportLink`	`reportsExportGet(List<String> statuses, String fileFormat, String from, String to, String channelName, Boolean includeEmail, Boolean includeSms, List<String> messageCategory, String compressionFormat, String fileName, String email)` Export email log information to the specified file format.
`com.squareup.okhttp.Call`	`reportsExportGetAsync(List<String> statuses, String fileFormat, String from, String to, String channelName, Boolean includeEmail, Boolean includeSms, List<String> messageCategory, String compressionFormat, String fileName, String email, ApiCallback<ExportLink> callback)` Export email log information to the specified file format.
`com.squareup.okhttp.Call`	`reportsExportGetCall(List<String> statuses, String fileFormat, String from, String to, String channelName, Boolean includeEmail, Boolean includeSms, List<String> messageCategory, String compressionFormat, String fileName, String email, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsExportGet
`ApiResponse<ExportLink>`	`reportsExportGetWithHttpInfo(List<String> statuses, String fileFormat, String from, String to, String channelName, Boolean includeEmail, Boolean includeSms, List<String> messageCategory, String compressionFormat, String fileName, String email)` Export email log information to the specified file format.
`Log`	`reportsGet(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress)` Returns logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsGetAsync(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress, ApiCallback<Log> callback)` Returns logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsGetCall(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsGet
`ApiResponse<Log>`	`reportsGetWithHttpInfo(List<String> statuses, String from, String to, String channelName, Integer limit, Integer offset, Boolean includeEmail, Boolean includeSms, String email, String ipaddress)` Returns logs filtered by specified parameters.
`ExportLink`	`reportsLinktrackingsExportGet(String from, String to, String channelName, String fileFormat, Integer limit, Integer offset, String compressionFormat, String fileName)` Export detailed link tracking information to the specified file format.
`com.squareup.okhttp.Call`	`reportsLinktrackingsExportGetAsync(String from, String to, String channelName, String fileFormat, Integer limit, Integer offset, String compressionFormat, String fileName, ApiCallback<ExportLink> callback)` Export detailed link tracking information to the specified file format.
`com.squareup.okhttp.Call`	`reportsLinktrackingsExportGetCall(String from, String to, String channelName, String fileFormat, Integer limit, Integer offset, String compressionFormat, String fileName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsLinktrackingsExportGet
`ApiResponse<ExportLink>`	`reportsLinktrackingsExportGetWithHttpInfo(String from, String to, String channelName, String fileFormat, Integer limit, Integer offset, String compressionFormat, String fileName)` Export detailed link tracking information to the specified file format.
`Log`	`reportsNotificationsGet(List<String> statuses, String from, String to, Integer limit, Integer offset, String notificationType)` Returns notification logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsNotificationsGetAsync(List<String> statuses, String from, String to, Integer limit, Integer offset, String notificationType, ApiCallback<Log> callback)` Returns notification logs filtered by specified parameters.
`com.squareup.okhttp.Call`	`reportsNotificationsGetCall(List<String> statuses, String from, String to, Integer limit, Integer offset, String notificationType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsNotificationsGet
`ApiResponse<Log>`	`reportsNotificationsGetWithHttpInfo(List<String> statuses, String from, String to, Integer limit, Integer offset, String notificationType)` Returns notification logs filtered by specified parameters.
`List<Payment>`	`reportsPaymentsHistoryGet(Integer limit, Integer offset, String fromDate, String toDate)` Lists all payments
`com.squareup.okhttp.Call`	`reportsPaymentsHistoryGetAsync(Integer limit, Integer offset, String fromDate, String toDate, ApiCallback<List<Payment>> callback)` Lists all payments (asynchronously)
`com.squareup.okhttp.Call`	`reportsPaymentsHistoryGetCall(Integer limit, Integer offset, String fromDate, String toDate, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsPaymentsHistoryGet
`ApiResponse<List<Payment>>`	`reportsPaymentsHistoryGetWithHttpInfo(Integer limit, Integer offset, String fromDate, String toDate)` Lists all payments
`Referral`	`reportsReferralsGet()` Shows information about your referral details
`com.squareup.okhttp.Call`	`reportsReferralsGetAsync(ApiCallback<Referral> callback)` Shows information about your referral details (asynchronously)
`com.squareup.okhttp.Call`	`reportsReferralsGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsReferralsGet
`ApiResponse<Referral>`	`reportsReferralsGetWithHttpInfo()` Shows information about your referral details
`List<Payment>`	`reportsReferralsPayoutHistoryGet()` Lists all referral payout history
`com.squareup.okhttp.Call`	`reportsReferralsPayoutHistoryGetAsync(ApiCallback<List<Payment>> callback)` Lists all referral payout history (asynchronously)
`com.squareup.okhttp.Call`	`reportsReferralsPayoutHistoryGetCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsReferralsPayoutHistoryGet
`ApiResponse<List<Payment>>`	`reportsReferralsPayoutHistoryGetWithHttpInfo()` Lists all referral payout history
`List<ReputationHistory>`	`reportsReputationHistoryGet(Integer limit, Integer offset)` Shows latest changes in your sending reputation
`com.squareup.okhttp.Call`	`reportsReputationHistoryGetAsync(Integer limit, Integer offset, ApiCallback<List<ReputationHistory>> callback)` Shows latest changes in your sending reputation (asynchronously)
`com.squareup.okhttp.Call`	`reportsReputationHistoryGetCall(Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsReputationHistoryGet
`ApiResponse<List<ReputationHistory>>`	`reportsReputationHistoryGetWithHttpInfo(Integer limit, Integer offset)` Shows latest changes in your sending reputation
`List<SpamCheck>`	`reportsSpamchecksHistoryGet(Integer limit, Integer offset)` Returns detailed spam check.
`com.squareup.okhttp.Call`	`reportsSpamchecksHistoryGetAsync(Integer limit, Integer offset, ApiCallback<List<SpamCheck>> callback)` Returns detailed spam check.
`com.squareup.okhttp.Call`	`reportsSpamchecksHistoryGetCall(Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsSpamchecksHistoryGet
`ApiResponse<List<SpamCheck>>`	`reportsSpamchecksHistoryGetWithHttpInfo(Integer limit, Integer offset)` Returns detailed spam check.
`LogSummary`	`reportsSummaryGet(String from, String to, String channelName, String interval, String transactionID)` Loads summary information about activity in chosen date range.
`com.squareup.okhttp.Call`	`reportsSummaryGetAsync(String from, String to, String channelName, String interval, String transactionID, ApiCallback<LogSummary> callback)` Loads summary information about activity in chosen date range.
`com.squareup.okhttp.Call`	`reportsSummaryGetCall(String from, String to, String channelName, String interval, String transactionID, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)` Build call for reportsSummaryGet
`ApiResponse<LogSummary>`	`reportsSummaryGetWithHttpInfo(String from, String to, String channelName, String interval, String transactionID)` Loads summary information about activity in chosen date range.
`void`	`setApiClient(ApiClient apiClient)`

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

Constructor Detail

ReportsApi
```
public ReportsApi()
```

ReportsApi

public ReportsApi(ApiClient apiClient)

Method Detail

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

setApiClient

public void setApiClient(ApiClient apiClient)

reportsBouncedGetCall

public com.squareup.okhttp.Call reportsBouncedGetCall(List<String> messageCategories,
                                                      String from,
                                                      String to,
                                                      String channelName,
                                                      Integer limit,
                                                      Integer offset,
                                                      Boolean includeEmail,
                                                      Boolean includeSms,
                                                      String email,
                                                      String ipaddress,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for reportsBouncedGet

Parameters:: messageCategories - (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsBouncedGet
```
public Log reportsBouncedGet(List<String> messageCategories,
                             String from,
                             String to,
                             String channelName,
                             Integer limit,
                             Integer offset,
                             Boolean includeEmail,
                             Boolean includeSms,
                             String email,
                             String ipaddress)
                      throws ApiException
```
Returns bounced logs filtered by specified parameters.

Parameters:

messageCategories - (required)

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

channelName - Name of selected channel. (optional)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True)

includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True)

email - Proper email address. (optional)

ipaddress - Search for recipients that we sent through this IP address (optional)

Returns:

Log

Throws:

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

reportsBouncedGetWithHttpInfo

public ApiResponse<Log> reportsBouncedGetWithHttpInfo(List<String> messageCategories,
                                                      String from,
                                                      String to,
                                                      String channelName,
                                                      Integer limit,
                                                      Integer offset,
                                                      Boolean includeEmail,
                                                      Boolean includeSms,
                                                      String email,
                                                      String ipaddress)
                                               throws ApiException

Returns bounced logs filtered by specified parameters.

Parameters:: messageCategories - (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional)
Returns:: ApiResponse<Log>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsBouncedGetAsync

public com.squareup.okhttp.Call reportsBouncedGetAsync(List<String> messageCategories,
                                                       String from,
                                                       String to,
                                                       String channelName,
                                                       Integer limit,
                                                       Integer offset,
                                                       Boolean includeEmail,
                                                       Boolean includeSms,
                                                       String email,
                                                       String ipaddress,
                                                       ApiCallback<Log> callback)
                                                throws ApiException

Returns bounced logs filtered by specified parameters. (asynchronously)

Parameters:: messageCategories - (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

reportsEmailcreditsHistoryGetCall

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

Build call for reportsEmailcreditsHistoryGet

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

reportsEmailcreditsHistoryGet
```
public List<EmailCredits> reportsEmailcreditsHistoryGet()
                                                 throws ApiException
```
Lists email credits history

Returns:

List<EmailCredits>

Throws:

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

reportsEmailcreditsHistoryGetWithHttpInfo
```
public ApiResponse<List<EmailCredits>> reportsEmailcreditsHistoryGetWithHttpInfo()
                                                                          throws ApiException
```
Lists email credits history

Returns:

ApiResponse<List<EmailCredits>>

Throws:

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

reportsEmailcreditsHistoryGetAsync
```
public com.squareup.okhttp.Call reportsEmailcreditsHistoryGetAsync(ApiCallback<List<EmailCredits>> callback)
                                                            throws ApiException
```
Lists email credits history (asynchronously)

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

reportsEventlogGetCall

public com.squareup.okhttp.Call reportsEventlogGetCall(List<String> statuses,
                                                       String from,
                                                       String to,
                                                       String channelName,
                                                       Integer limit,
                                                       Integer offset,
                                                       ProgressResponseBody.ProgressListener progressListener,
                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                throws ApiException

Build call for reportsEventlogGet

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsEventlogGet
```
public EventLog reportsEventlogGet(List<String> statuses,
                                   String from,
                                   String to,
                                   String channelName,
                                   Integer limit,
                                   Integer offset)
                            throws ApiException
```
Returns log of delivery events filtered by specified parameters.

Parameters:

statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional)

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

channelName - Name of selected channel. (optional)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

EventLog

Throws:

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

reportsEventlogGetWithHttpInfo

public ApiResponse<EventLog> reportsEventlogGetWithHttpInfo(List<String> statuses,
                                                            String from,
                                                            String to,
                                                            String channelName,
                                                            Integer limit,
                                                            Integer offset)
                                                     throws ApiException

Returns log of delivery events filtered by specified parameters.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0)
Returns:: ApiResponse<EventLog>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsEventlogGetAsync

public com.squareup.okhttp.Call reportsEventlogGetAsync(List<String> statuses,
                                                        String from,
                                                        String to,
                                                        String channelName,
                                                        Integer limit,
                                                        Integer offset,
                                                        ApiCallback<EventLog> callback)
                                                 throws ApiException

Returns log of delivery events filtered by specified parameters. (asynchronously)

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); 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

reportsEventsExportGetCall

public com.squareup.okhttp.Call reportsEventsExportGetCall(List<String> statuses,
                                                           String from,
                                                           String to,
                                                           String channelName,
                                                           String fileFormat,
                                                           String compressionFormat,
                                                           String fileName,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for reportsEventsExportGet

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsEventsExportGet
```
public ExportLink reportsEventsExportGet(List<String> statuses,
                                         String from,
                                         String to,
                                         String channelName,
                                         String fileFormat,
                                         String compressionFormat,
                                         String fileName)
                                  throws ApiException
```
Export delivery events log information to the specified file format.

Parameters:

statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional)

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

channelName - Name of selected channel. (optional)

fileFormat - Format of the exported file (optional, default to Csv)

compressionFormat - FileResponse compression format. None or Zip. (optional, default to None)

fileName - Name of your file. (optional)

Returns:

ExportLink

Throws:

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

reportsEventsExportGetWithHttpInfo

public ApiResponse<ExportLink> reportsEventsExportGetWithHttpInfo(List<String> statuses,
                                                                  String from,
                                                                  String to,
                                                                  String channelName,
                                                                  String fileFormat,
                                                                  String compressionFormat,
                                                                  String fileName)
                                                           throws ApiException

Export delivery events log information to the specified file format.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional)
Returns:: ApiResponse<ExportLink>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsEventsExportGetAsync

public com.squareup.okhttp.Call reportsEventsExportGetAsync(List<String> statuses,
                                                            String from,
                                                            String to,
                                                            String channelName,
                                                            String fileFormat,
                                                            String compressionFormat,
                                                            String fileName,
                                                            ApiCallback<ExportLink> callback)
                                                     throws ApiException

Export delivery events log information to the specified file format. (asynchronously)

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (optional); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (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

reportsExportGetCall

public com.squareup.okhttp.Call reportsExportGetCall(List<String> statuses,
                                                     String fileFormat,
                                                     String from,
                                                     String to,
                                                     String channelName,
                                                     Boolean includeEmail,
                                                     Boolean includeSms,
                                                     List<String> messageCategory,
                                                     String compressionFormat,
                                                     String fileName,
                                                     String email,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for reportsExportGet

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); fileFormat - Format of the exported file (optional, default to Csv); from - Start date. (optional); to - End date. (optional); channelName - Name of selected channel. (optional); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); messageCategory - ID of message category (optional); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); email - Proper email address. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsExportGet

public ExportLink reportsExportGet(List<String> statuses,
                                   String fileFormat,
                                   String from,
                                   String to,
                                   String channelName,
                                   Boolean includeEmail,
                                   Boolean includeSms,
                                   List<String> messageCategory,
                                   String compressionFormat,
                                   String fileName,
                                   String email)
                            throws ApiException

Export email log information to the specified file format.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); fileFormat - Format of the exported file (optional, default to Csv); from - Start date. (optional); to - End date. (optional); channelName - Name of selected channel. (optional); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); messageCategory - ID of message category (optional); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); email - Proper email address. (optional)
Returns:: ExportLink
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsExportGetWithHttpInfo

public ApiResponse<ExportLink> reportsExportGetWithHttpInfo(List<String> statuses,
                                                            String fileFormat,
                                                            String from,
                                                            String to,
                                                            String channelName,
                                                            Boolean includeEmail,
                                                            Boolean includeSms,
                                                            List<String> messageCategory,
                                                            String compressionFormat,
                                                            String fileName,
                                                            String email)
                                                     throws ApiException

Export email log information to the specified file format.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); fileFormat - Format of the exported file (optional, default to Csv); from - Start date. (optional); to - End date. (optional); channelName - Name of selected channel. (optional); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); messageCategory - ID of message category (optional); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); email - Proper email address. (optional)
Returns:: ApiResponse<ExportLink>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsExportGetAsync

public com.squareup.okhttp.Call reportsExportGetAsync(List<String> statuses,
                                                      String fileFormat,
                                                      String from,
                                                      String to,
                                                      String channelName,
                                                      Boolean includeEmail,
                                                      Boolean includeSms,
                                                      List<String> messageCategory,
                                                      String compressionFormat,
                                                      String fileName,
                                                      String email,
                                                      ApiCallback<ExportLink> callback)
                                               throws ApiException

Export email log information to the specified file format. (asynchronously)

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); fileFormat - Format of the exported file (optional, default to Csv); from - Start date. (optional); to - End date. (optional); channelName - Name of selected channel. (optional); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); messageCategory - ID of message category (optional); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); email - Proper email address. (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

reportsGetCall

public com.squareup.okhttp.Call reportsGetCall(List<String> statuses,
                                               String from,
                                               String to,
                                               String channelName,
                                               Integer limit,
                                               Integer offset,
                                               Boolean includeEmail,
                                               Boolean includeSms,
                                               String email,
                                               String ipaddress,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for reportsGet

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsGet
```
public Log reportsGet(List<String> statuses,
                      String from,
                      String to,
                      String channelName,
                      Integer limit,
                      Integer offset,
                      Boolean includeEmail,
                      Boolean includeSms,
                      String email,
                      String ipaddress)
               throws ApiException
```
Returns logs filtered by specified parameters.

Parameters:

statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required)

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

channelName - Name of selected channel. (optional)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True)

includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True)

email - Proper email address. (optional)

ipaddress - Search for recipients that we sent through this IP address (optional)

Returns:

Log

Throws:

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

reportsGetWithHttpInfo

public ApiResponse<Log> reportsGetWithHttpInfo(List<String> statuses,
                                               String from,
                                               String to,
                                               String channelName,
                                               Integer limit,
                                               Integer offset,
                                               Boolean includeEmail,
                                               Boolean includeSms,
                                               String email,
                                               String ipaddress)
                                        throws ApiException

Returns logs filtered by specified parameters.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional)
Returns:: ApiResponse<Log>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsGetAsync

public com.squareup.okhttp.Call reportsGetAsync(List<String> statuses,
                                                String from,
                                                String to,
                                                String channelName,
                                                Integer limit,
                                                Integer offset,
                                                Boolean includeEmail,
                                                Boolean includeSms,
                                                String email,
                                                String ipaddress,
                                                ApiCallback<Log> callback)
                                         throws ApiException

Returns logs filtered by specified parameters. (asynchronously)

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); channelName - Name of selected channel. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); includeEmail - True: Search includes emails. Otherwise, false. (optional, default to True); includeSms - True: Search includes SMS. Otherwise, false. (optional, default to True); email - Proper email address. (optional); ipaddress - Search for recipients that we sent through this IP address (optional); callback - The callback to be executed when the API call finishes
Returns:: The request call
Throws:: ApiException - If fail to process the API call, e.g. serializing the request body object

reportsLinktrackingsExportGetCall

public com.squareup.okhttp.Call reportsLinktrackingsExportGetCall(String from,
                                                                  String to,
                                                                  String channelName,
                                                                  String fileFormat,
                                                                  Integer limit,
                                                                  Integer offset,
                                                                  String compressionFormat,
                                                                  String fileName,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for reportsLinktrackingsExportGet

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsLinktrackingsExportGet

public ExportLink reportsLinktrackingsExportGet(String from,
                                                String to,
                                                String channelName,
                                                String fileFormat,
                                                Integer limit,
                                                Integer offset,
                                                String compressionFormat,
                                                String fileName)
                                         throws ApiException

Export detailed link tracking information to the specified file format.

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional)
Returns:: ExportLink
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsLinktrackingsExportGetWithHttpInfo

public ApiResponse<ExportLink> reportsLinktrackingsExportGetWithHttpInfo(String from,
                                                                         String to,
                                                                         String channelName,
                                                                         String fileFormat,
                                                                         Integer limit,
                                                                         Integer offset,
                                                                         String compressionFormat,
                                                                         String fileName)
                                                                  throws ApiException

Export detailed link tracking information to the specified file format.

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (optional)
Returns:: ApiResponse<ExportLink>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsLinktrackingsExportGetAsync

public com.squareup.okhttp.Call reportsLinktrackingsExportGetAsync(String from,
                                                                   String to,
                                                                   String channelName,
                                                                   String fileFormat,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   String compressionFormat,
                                                                   String fileName,
                                                                   ApiCallback<ExportLink> callback)
                                                            throws ApiException

Export detailed link tracking information to the specified file format. (asynchronously)

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); fileFormat - Format of the exported file (optional, default to Csv); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); compressionFormat - FileResponse compression format. None or Zip. (optional, default to None); fileName - Name of your file. (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

reportsNotificationsGetCall

public com.squareup.okhttp.Call reportsNotificationsGetCall(List<String> statuses,
                                                            String from,
                                                            String to,
                                                            Integer limit,
                                                            Integer offset,
                                                            String notificationType,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException

Build call for reportsNotificationsGet

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); notificationType - (optional, default to All); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsNotificationsGet
```
public Log reportsNotificationsGet(List<String> statuses,
                                   String from,
                                   String to,
                                   Integer limit,
                                   Integer offset,
                                   String notificationType)
                            throws ApiException
```
Returns notification logs filtered by specified parameters.

Parameters:

statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required)

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional)

limit - Maximum of loaded items. (optional, default to 0)

offset - How many items should be loaded ahead. (optional, default to 0)

notificationType - (optional, default to All)

Returns:

Log

Throws:

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

reportsNotificationsGetWithHttpInfo

public ApiResponse<Log> reportsNotificationsGetWithHttpInfo(List<String> statuses,
                                                            String from,
                                                            String to,
                                                            Integer limit,
                                                            Integer offset,
                                                            String notificationType)
                                                     throws ApiException

Returns notification logs filtered by specified parameters.

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); notificationType - (optional, default to All)
Returns:: ApiResponse<Log>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsNotificationsGetAsync

public com.squareup.okhttp.Call reportsNotificationsGetAsync(List<String> statuses,
                                                             String from,
                                                             String to,
                                                             Integer limit,
                                                             Integer offset,
                                                             String notificationType,
                                                             ApiCallback<Log> callback)
                                                      throws ApiException

Returns notification logs filtered by specified parameters. (asynchronously)

Parameters:: statuses - List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report (required); from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (optional); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (optional); limit - Maximum of loaded items. (optional, default to 0); offset - How many items should be loaded ahead. (optional, default to 0); notificationType - (optional, default to All); 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

reportsPaymentsHistoryGetCall

public com.squareup.okhttp.Call reportsPaymentsHistoryGetCall(Integer limit,
                                                              Integer offset,
                                                              String fromDate,
                                                              String toDate,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for reportsPaymentsHistoryGet

Parameters:: limit - Maximum of loaded items. (required); offset - How many items should be loaded ahead. (required); fromDate - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); toDate - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsPaymentsHistoryGet

public List<Payment> reportsPaymentsHistoryGet(Integer limit,
                                               Integer offset,
                                               String fromDate,
                                               String toDate)
                                        throws ApiException

Lists all payments

Parameters:: limit - Maximum of loaded items. (required); offset - How many items should be loaded ahead. (required); fromDate - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); toDate - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required)
Returns:: List<Payment>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsPaymentsHistoryGetWithHttpInfo

public ApiResponse<List<Payment>> reportsPaymentsHistoryGetWithHttpInfo(Integer limit,
                                                                        Integer offset,
                                                                        String fromDate,
                                                                        String toDate)
                                                                 throws ApiException

Lists all payments

Parameters:: limit - Maximum of loaded items. (required); offset - How many items should be loaded ahead. (required); fromDate - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); toDate - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required)
Returns:: ApiResponse<List<Payment>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsPaymentsHistoryGetAsync

public com.squareup.okhttp.Call reportsPaymentsHistoryGetAsync(Integer limit,
                                                               Integer offset,
                                                               String fromDate,
                                                               String toDate,
                                                               ApiCallback<List<Payment>> callback)
                                                        throws ApiException

Lists all payments (asynchronously)

Parameters:: limit - Maximum of loaded items. (required); offset - How many items should be loaded ahead. (required); fromDate - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); toDate - Ending date for search in YYYY-MM-DDThh:mm:ss format. (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

reportsReferralsGetCall

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

Build call for reportsReferralsGet

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

reportsReferralsGet
```
public Referral reportsReferralsGet()
                             throws ApiException
```
Shows information about your referral details

Returns:

Referral

Throws:

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

reportsReferralsGetWithHttpInfo
```
public ApiResponse<Referral> reportsReferralsGetWithHttpInfo()
                                                      throws ApiException
```
Shows information about your referral details

Returns:

ApiResponse<Referral>

Throws:

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

reportsReferralsGetAsync
```
public com.squareup.okhttp.Call reportsReferralsGetAsync(ApiCallback<Referral> callback)
                                                  throws ApiException
```
Shows information about your referral details (asynchronously)

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

reportsReferralsPayoutHistoryGetCall

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

Build call for reportsReferralsPayoutHistoryGet

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

reportsReferralsPayoutHistoryGet
```
public List<Payment> reportsReferralsPayoutHistoryGet()
                                               throws ApiException
```
Lists all referral payout history

Returns:

List<Payment>

Throws:

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

reportsReferralsPayoutHistoryGetWithHttpInfo
```
public ApiResponse<List<Payment>> reportsReferralsPayoutHistoryGetWithHttpInfo()
                                                                        throws ApiException
```
Lists all referral payout history

Returns:

ApiResponse<List<Payment>>

Throws:

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

reportsReferralsPayoutHistoryGetAsync
```
public com.squareup.okhttp.Call reportsReferralsPayoutHistoryGetAsync(ApiCallback<List<Payment>> callback)
                                                               throws ApiException
```
Lists all referral payout history (asynchronously)

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

reportsReputationHistoryGetCall

public com.squareup.okhttp.Call reportsReputationHistoryGetCall(Integer limit,
                                                                Integer offset,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for reportsReputationHistoryGet

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsReputationHistoryGet
```
public List<ReputationHistory> reportsReputationHistoryGet(Integer limit,
                                                           Integer offset)
                                                    throws ApiException
```
Shows latest changes in your sending reputation

Parameters:

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<ReputationHistory>

Throws:

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

reportsReputationHistoryGetWithHttpInfo

public ApiResponse<List<ReputationHistory>> reportsReputationHistoryGetWithHttpInfo(Integer limit,
                                                                                    Integer offset)
                                                                             throws ApiException

Shows latest changes in your sending reputation

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0)
Returns:: ApiResponse<List<ReputationHistory>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsReputationHistoryGetAsync

public com.squareup.okhttp.Call reportsReputationHistoryGetAsync(Integer limit,
                                                                 Integer offset,
                                                                 ApiCallback<List<ReputationHistory>> callback)
                                                          throws ApiException

Shows latest changes in your sending reputation (asynchronously)

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0); 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

reportsSpamchecksHistoryGetCall

public com.squareup.okhttp.Call reportsSpamchecksHistoryGetCall(Integer limit,
                                                                Integer offset,
                                                                ProgressResponseBody.ProgressListener progressListener,
                                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                         throws ApiException

Build call for reportsSpamchecksHistoryGet

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsSpamchecksHistoryGet
```
public List<SpamCheck> reportsSpamchecksHistoryGet(Integer limit,
                                                   Integer offset)
                                            throws ApiException
```
Returns detailed spam check.

Parameters:

limit - Maximum of loaded items. (optional, default to 20)

offset - How many items should be loaded ahead. (optional, default to 0)

Returns:

List<SpamCheck>

Throws:

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

reportsSpamchecksHistoryGetWithHttpInfo

public ApiResponse<List<SpamCheck>> reportsSpamchecksHistoryGetWithHttpInfo(Integer limit,
                                                                            Integer offset)
                                                                     throws ApiException

Returns detailed spam check.

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0)
Returns:: ApiResponse<List<SpamCheck>>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsSpamchecksHistoryGetAsync

public com.squareup.okhttp.Call reportsSpamchecksHistoryGetAsync(Integer limit,
                                                                 Integer offset,
                                                                 ApiCallback<List<SpamCheck>> callback)
                                                          throws ApiException

Returns detailed spam check. (asynchronously)

Parameters:: limit - Maximum of loaded items. (optional, default to 20); offset - How many items should be loaded ahead. (optional, default to 0); 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

reportsSummaryGetCall

public com.squareup.okhttp.Call reportsSummaryGetCall(String from,
                                                      String to,
                                                      String channelName,
                                                      String interval,
                                                      String transactionID,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException

Build call for reportsSummaryGet

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); interval - 'Hourly' for detailed information, 'summary' for daily overview (optional, default to Summary); transactionID - ID number of transaction (optional); progressListener - Progress listener; progressRequestListener - Progress request listener
Returns:: Call to execute
Throws:: ApiException - If fail to serialize the request body object

reportsSummaryGet
```
public LogSummary reportsSummaryGet(String from,
                                    String to,
                                    String channelName,
                                    String interval,
                                    String transactionID)
                             throws ApiException
```
Loads summary information about activity in chosen date range.

Parameters:

from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required)

to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required)

channelName - Name of selected channel. (optional)

interval - 'Hourly' for detailed information, 'summary' for daily overview (optional, default to Summary)

transactionID - ID number of transaction (optional)

Returns:

LogSummary

Throws:

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

reportsSummaryGetWithHttpInfo

public ApiResponse<LogSummary> reportsSummaryGetWithHttpInfo(String from,
                                                             String to,
                                                             String channelName,
                                                             String interval,
                                                             String transactionID)
                                                      throws ApiException

Loads summary information about activity in chosen date range.

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); interval - 'Hourly' for detailed information, 'summary' for daily overview (optional, default to Summary); transactionID - ID number of transaction (optional)
Returns:: ApiResponse<LogSummary>
Throws:: ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

reportsSummaryGetAsync

public com.squareup.okhttp.Call reportsSummaryGetAsync(String from,
                                                       String to,
                                                       String channelName,
                                                       String interval,
                                                       String transactionID,
                                                       ApiCallback<LogSummary> callback)
                                                throws ApiException

Loads summary information about activity in chosen date range. (asynchronously)

Parameters:: from - Starting date for search in YYYY-MM-DDThh:mm:ss format. (required); to - Ending date for search in YYYY-MM-DDThh:mm:ss format. (required); channelName - Name of selected channel. (optional); interval - 'Hourly' for detailed information, 'summary' for daily overview (optional, default to Summary); transactionID - ID number of transaction (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

Class ReportsApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReportsApi

ReportsApi

Method Detail

getApiClient

setApiClient

reportsBouncedGetCall

reportsBouncedGet

reportsBouncedGetWithHttpInfo

reportsBouncedGetAsync

reportsEmailcreditsHistoryGetCall

reportsEmailcreditsHistoryGet

reportsEmailcreditsHistoryGetWithHttpInfo

reportsEmailcreditsHistoryGetAsync

reportsEventlogGetCall

reportsEventlogGet

reportsEventlogGetWithHttpInfo

reportsEventlogGetAsync

reportsEventsExportGetCall

reportsEventsExportGet

reportsEventsExportGetWithHttpInfo

reportsEventsExportGetAsync

reportsExportGetCall

reportsExportGet

reportsExportGetWithHttpInfo

reportsExportGetAsync

reportsGetCall

reportsGet

reportsGetWithHttpInfo

reportsGetAsync

reportsLinktrackingsExportGetCall

reportsLinktrackingsExportGet

reportsLinktrackingsExportGetWithHttpInfo

reportsLinktrackingsExportGetAsync

reportsNotificationsGetCall

reportsNotificationsGet

reportsNotificationsGetWithHttpInfo

reportsNotificationsGetAsync

reportsPaymentsHistoryGetCall

reportsPaymentsHistoryGet

reportsPaymentsHistoryGetWithHttpInfo

reportsPaymentsHistoryGetAsync

reportsReferralsGetCall

reportsReferralsGet

reportsReferralsGetWithHttpInfo

reportsReferralsGetAsync

reportsReferralsPayoutHistoryGetCall

reportsReferralsPayoutHistoryGet

reportsReferralsPayoutHistoryGetWithHttpInfo

reportsReferralsPayoutHistoryGetAsync

reportsReputationHistoryGetCall

reportsReputationHistoryGet

reportsReputationHistoryGetWithHttpInfo

reportsReputationHistoryGetAsync

reportsSpamchecksHistoryGetCall

reportsSpamchecksHistoryGet

reportsSpamchecksHistoryGetWithHttpInfo

reportsSpamchecksHistoryGetAsync

reportsSummaryGetCall

reportsSummaryGet

reportsSummaryGetWithHttpInfo

reportsSummaryGetAsync