com.mailslurp.apis

Class ExportControllerApi

java.lang.Object

com.mailslurp.apis.ExportControllerApi

public class ExportControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ExportControllerApi()
ExportControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<byte[]>	exportEntities(String exportType, String apiKey, String outputFormat, String filter, String listSeparatorToken, Boolean excludePreviouslyExported, OffsetDateTime createdEarliestTime, OffsetDateTime createdOldestTime) Export inboxes link callable via browser
okhttp3.Call	exportEntitiesAsync(String exportType, String apiKey, String outputFormat, String filter, String listSeparatorToken, Boolean excludePreviouslyExported, OffsetDateTime createdEarliestTime, OffsetDateTime createdOldestTime, ApiCallback<List<byte[]>> _callback) Export inboxes link callable via browser (asynchronously)
okhttp3.Call	exportEntitiesCall(String exportType, String apiKey, String outputFormat, String filter, String listSeparatorToken, Boolean excludePreviouslyExported, OffsetDateTime createdEarliestTime, OffsetDateTime createdOldestTime, ApiCallback _callback) Build call for exportEntities
ApiResponse<List<byte[]>>	exportEntitiesWithHttpInfo(String exportType, String apiKey, String outputFormat, String filter, String listSeparatorToken, Boolean excludePreviouslyExported, OffsetDateTime createdEarliestTime, OffsetDateTime createdOldestTime) Export inboxes link callable via browser
ApiClient	getApiClient()
String	getCustomBaseUrl()
ExportLink	getExportLink(String exportType, ExportOptions exportOptions, String apiKey) Get export link
okhttp3.Call	getExportLinkAsync(String exportType, ExportOptions exportOptions, String apiKey, ApiCallback<ExportLink> _callback) Get export link (asynchronously)
okhttp3.Call	getExportLinkCall(String exportType, ExportOptions exportOptions, String apiKey, ApiCallback _callback) Build call for getExportLink
ApiResponse<ExportLink>	getExportLinkWithHttpInfo(String exportType, ExportOptions exportOptions, String apiKey) Get export link
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportControllerApi

public ExportControllerApi()

ExportControllerApi

public ExportControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

exportEntitiesCall

public okhttp3.Call exportEntitiesCall(String exportType,
                                       String apiKey,
                                       String outputFormat,
                                       String filter,
                                       String listSeparatorToken,
                                       Boolean excludePreviouslyExported,
                                       OffsetDateTime createdEarliestTime,
                                       OffsetDateTime createdOldestTime,
                                       ApiCallback _callback)
                                throws ApiException

Build call for exportEntities

Parameters:

exportType - (required)

apiKey - (required)

outputFormat - (required)

filter - (optional)

listSeparatorToken - (optional)

excludePreviouslyExported - (optional)

createdEarliestTime - (optional)

createdOldestTime - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

exportEntities

public List<byte[]> exportEntities(String exportType,
                                   String apiKey,
                                   String outputFormat,
                                   String filter,
                                   String listSeparatorToken,
                                   Boolean excludePreviouslyExported,
                                   OffsetDateTime createdEarliestTime,
                                   OffsetDateTime createdOldestTime)
                            throws ApiException

Export inboxes link callable via browser

Parameters:

exportType - (required)

apiKey - (required)

outputFormat - (required)

filter - (optional)

listSeparatorToken - (optional)

excludePreviouslyExported - (optional)

createdEarliestTime - (optional)

createdOldestTime - (optional)

Returns:

List<byte[]>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

exportEntitiesWithHttpInfo

public ApiResponse<List<byte[]>> exportEntitiesWithHttpInfo(String exportType,
                                                            String apiKey,
                                                            String outputFormat,
                                                            String filter,
                                                            String listSeparatorToken,
                                                            Boolean excludePreviouslyExported,
                                                            OffsetDateTime createdEarliestTime,
                                                            OffsetDateTime createdOldestTime)
                                                     throws ApiException

Export inboxes link callable via browser

Parameters:

exportType - (required)

apiKey - (required)

outputFormat - (required)

filter - (optional)

listSeparatorToken - (optional)

excludePreviouslyExported - (optional)

createdEarliestTime - (optional)

createdOldestTime - (optional)

Returns:

ApiResponse<List<byte[]>>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

exportEntitiesAsync

public okhttp3.Call exportEntitiesAsync(String exportType,
                                        String apiKey,
                                        String outputFormat,
                                        String filter,
                                        String listSeparatorToken,
                                        Boolean excludePreviouslyExported,
                                        OffsetDateTime createdEarliestTime,
                                        OffsetDateTime createdOldestTime,
                                        ApiCallback<List<byte[]>> _callback)
                                 throws ApiException

Export inboxes link callable via browser (asynchronously)

Parameters:

exportType - (required)

apiKey - (required)

outputFormat - (required)

filter - (optional)

listSeparatorToken - (optional)

excludePreviouslyExported - (optional)

createdEarliestTime - (optional)

createdOldestTime - (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getExportLinkCall

public okhttp3.Call getExportLinkCall(String exportType,
                                      ExportOptions exportOptions,
                                      String apiKey,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getExportLink

Parameters:

exportType - (required)

exportOptions - (required)

apiKey - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getExportLink

public ExportLink getExportLink(String exportType,
                                ExportOptions exportOptions,
                                String apiKey)
                         throws ApiException

Get export link

Parameters:

exportType - (required)

exportOptions - (required)

apiKey - (optional)

Returns:

ExportLink

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getExportLinkWithHttpInfo

public ApiResponse<ExportLink> getExportLinkWithHttpInfo(String exportType,
                                                         ExportOptions exportOptions,
                                                         String apiKey)
                                                  throws ApiException

Get export link

Parameters:

exportType - (required)

exportOptions - (required)

apiKey - (optional)

Returns:

ApiResponse<ExportLink>

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getExportLinkAsync

public okhttp3.Call getExportLinkAsync(String exportType,
                                       ExportOptions exportOptions,
                                       String apiKey,
                                       ApiCallback<ExportLink> _callback)
                                throws ApiException

Get export link (asynchronously)

Parameters:

exportType - (required)

exportOptions - (required)

apiKey - (optional)

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

Returns:

The request call

Throws:

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

Http Response Details:

Status Code	Description	Response Headers
200	OK	-