io.swagger.client.api

Class ChannelsApi

java.lang.Object

io.swagger.client.api.ChannelsApi

public class ChannelsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ChannelsApi()
ChannelsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
List<Channel>	channelsGet(Integer limit, Integer offset) List all of your channels
com.squareup.okhttp.Call	channelsGetAsync(Integer limit, Integer offset, ApiCallback<List<Channel>> callback) List all of your channels (asynchronously)
com.squareup.okhttp.Call	channelsGetCall(Integer limit, Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsGet
ApiResponse<List<Channel>>	channelsGetWithHttpInfo(Integer limit, Integer offset) List all of your channels
void	channelsNameCancelPost(String name) Cancel the emails being sent with this channel
com.squareup.okhttp.Call	channelsNameCancelPostAsync(String name, ApiCallback<Void> callback) Cancel the emails being sent with this channel (asynchronously)
com.squareup.okhttp.Call	channelsNameCancelPostCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsNameCancelPost
ApiResponse<Void>	channelsNameCancelPostWithHttpInfo(String name) Cancel the emails being sent with this channel
void	channelsNameDelete(String name) Delete the channel.
com.squareup.okhttp.Call	channelsNameDeleteAsync(String name, ApiCallback<Void> callback) Delete the channel.
com.squareup.okhttp.Call	channelsNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsNameDelete
ApiResponse<Void>	channelsNameDeleteWithHttpInfo(String name) Delete the channel.
Channel	channelsNameGet(String name) Retrieve an existing channel.
com.squareup.okhttp.Call	channelsNameGetAsync(String name, ApiCallback<Channel> callback) Retrieve an existing channel.
com.squareup.okhttp.Call	channelsNameGetCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsNameGet
ApiResponse<Channel>	channelsNameGetWithHttpInfo(String name) Retrieve an existing channel.
Channel	channelsNamePut(String name, String body) Rename an existing channel.
com.squareup.okhttp.Call	channelsNamePutAsync(String name, String body, ApiCallback<Channel> callback) Rename an existing channel.
com.squareup.okhttp.Call	channelsNamePutCall(String name, String body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsNamePut
ApiResponse<Channel>	channelsNamePutWithHttpInfo(String name, String body) Rename an existing channel.
Channel	channelsPost(String body) Manually add a channel to your account to group email
com.squareup.okhttp.Call	channelsPostAsync(String body, ApiCallback<Channel> callback) Manually add a channel to your account to group email (asynchronously)
com.squareup.okhttp.Call	channelsPostCall(String body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsPost
ApiResponse<Channel>	channelsPostWithHttpInfo(String body) Manually add a channel to your account to group email
ExportLink	channelsTasksExportGet(List<String> channelNames, String fileFormat, String compressionFormat, String fileName) Export selected channels to chosen file format.
com.squareup.okhttp.Call	channelsTasksExportGetAsync(List<String> channelNames, String fileFormat, String compressionFormat, String fileName, ApiCallback<ExportLink> callback) Export selected channels to chosen file format.
com.squareup.okhttp.Call	channelsTasksExportGetCall(List<String> channelNames, String fileFormat, String compressionFormat, String fileName, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for channelsTasksExportGet
ApiResponse<ExportLink>	channelsTasksExportGetWithHttpInfo(List<String> channelNames, String fileFormat, String compressionFormat, String fileName) Export selected channels to chosen file format.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelsApi

public ChannelsApi()

ChannelsApi

public ChannelsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

channelsGetCall

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

Build call for channelsGet

Parameters:

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

channelsGet

public List<Channel> channelsGet(Integer limit,
                                 Integer offset)
                          throws ApiException

List all of your channels

Parameters:

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

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

Returns:

List<Channel>

Throws:

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

channelsGetWithHttpInfo

public ApiResponse<List<Channel>> channelsGetWithHttpInfo(Integer limit,
                                                          Integer offset)
                                                   throws ApiException

List all of your channels

Parameters:

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

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

Returns:

ApiResponse<List<Channel>>

Throws:

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

channelsGetAsync

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

List all of your channels (asynchronously)

Parameters:

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

channelsNameCancelPostCall

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

Build call for channelsNameCancelPost

Parameters:

name - The name of the channel to cancel. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

channelsNameCancelPost

public void channelsNameCancelPost(String name)
                            throws ApiException

Cancel the emails being sent with this channel

Parameters:

name - The name of the channel to cancel. (required)

Throws:

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

channelsNameCancelPostWithHttpInfo

public ApiResponse<Void> channelsNameCancelPostWithHttpInfo(String name)
                                                     throws ApiException

Cancel the emails being sent with this channel

Parameters:

name - The name of the channel to cancel. (required)

Returns:

ApiResponse<Void>

Throws:

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

channelsNameCancelPostAsync

public com.squareup.okhttp.Call channelsNameCancelPostAsync(String name,
                                                            ApiCallback<Void> callback)
                                                     throws ApiException

Cancel the emails being sent with this channel (asynchronously)

Parameters:

name - The name of the channel to cancel. (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

channelsNameDeleteCall

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

Build call for channelsNameDelete

Parameters:

name - The name of the channel to delete. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

channelsNameDelete

public void channelsNameDelete(String name)
                        throws ApiException

Delete the channel.

Parameters:

name - The name of the channel to delete. (required)

Throws:

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

channelsNameDeleteWithHttpInfo

public ApiResponse<Void> channelsNameDeleteWithHttpInfo(String name)
                                                 throws ApiException

Delete the channel.

Parameters:

name - The name of the channel to delete. (required)

Returns:

ApiResponse<Void>

Throws:

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

channelsNameDeleteAsync

public com.squareup.okhttp.Call channelsNameDeleteAsync(String name,
                                                        ApiCallback<Void> callback)
                                                 throws ApiException

Delete the channel. (asynchronously)

Parameters:

name - The name of the channel 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

channelsNameGetCall

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

Build call for channelsNameGet

Parameters:

name - The name of the channel to get. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

channelsNameGet

public Channel channelsNameGet(String name)
                        throws ApiException

Retrieve an existing channel.

Parameters:

name - The name of the channel to get. (required)

Returns:

Channel

Throws:

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

channelsNameGetWithHttpInfo

public ApiResponse<Channel> channelsNameGetWithHttpInfo(String name)
                                                 throws ApiException

Retrieve an existing channel.

Parameters:

name - The name of the channel to get. (required)

Returns:

ApiResponse<Channel>

Throws:

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

channelsNameGetAsync

public com.squareup.okhttp.Call channelsNameGetAsync(String name,
                                                     ApiCallback<Channel> callback)
                                              throws ApiException

Retrieve an existing channel. (asynchronously)

Parameters:

name - The name of the channel to get. (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

channelsNamePutCall

public com.squareup.okhttp.Call channelsNamePutCall(String name,
                                                    String body,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for channelsNamePut

Parameters:

name - The name of the channel to update. (required)

body - The new name for the channel. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

channelsNamePut

public Channel channelsNamePut(String name,
                               String body)
                        throws ApiException

Rename an existing channel.

Parameters:

name - The name of the channel to update. (required)

body - The new name for the channel. (required)

Returns:

Channel

Throws:

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

channelsNamePutWithHttpInfo

public ApiResponse<Channel> channelsNamePutWithHttpInfo(String name,
                                                        String body)
                                                 throws ApiException

Rename an existing channel.

Parameters:

name - The name of the channel to update. (required)

body - The new name for the channel. (required)

Returns:

ApiResponse<Channel>

Throws:

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

channelsNamePutAsync

public com.squareup.okhttp.Call channelsNamePutAsync(String name,
                                                     String body,
                                                     ApiCallback<Channel> callback)
                                              throws ApiException

Rename an existing channel. (asynchronously)

Parameters:

name - The name of the channel to update. (required)

body - The new name for the channel. (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

channelsPostCall

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

Build call for channelsPost

Parameters:

body - Descriptive name of the channel (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

channelsPost

public Channel channelsPost(String body)
                     throws ApiException

Manually add a channel to your account to group email

Parameters:

body - Descriptive name of the channel (required)

Returns:

Channel

Throws:

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

channelsPostWithHttpInfo

public ApiResponse<Channel> channelsPostWithHttpInfo(String body)
                                              throws ApiException

Manually add a channel to your account to group email

Parameters:

body - Descriptive name of the channel (required)

Returns:

ApiResponse<Channel>

Throws:

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

channelsPostAsync

public com.squareup.okhttp.Call channelsPostAsync(String body,
                                                  ApiCallback<Channel> callback)
                                           throws ApiException

Manually add a channel to your account to group email (asynchronously)

Parameters:

body - Descriptive name of the channel (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

channelsTasksExportGetCall

public com.squareup.okhttp.Call channelsTasksExportGetCall(List<String> channelNames,
                                                           String fileFormat,
                                                           String compressionFormat,
                                                           String fileName,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for channelsTasksExportGet

Parameters:

channelNames - List of channel names used for processing (required)

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

channelsTasksExportGet

public ExportLink channelsTasksExportGet(List<String> channelNames,
                                         String fileFormat,
                                         String compressionFormat,
                                         String fileName)
                                  throws ApiException

Export selected channels to chosen file format.

Parameters:

channelNames - List of channel names used for processing (required)

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

channelsTasksExportGetWithHttpInfo

public ApiResponse<ExportLink> channelsTasksExportGetWithHttpInfo(List<String> channelNames,
                                                                  String fileFormat,
                                                                  String compressionFormat,
                                                                  String fileName)
                                                           throws ApiException

Export selected channels to chosen file format.

Parameters:

channelNames - List of channel names used for processing (required)

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

channelsTasksExportGetAsync

public com.squareup.okhttp.Call channelsTasksExportGetAsync(List<String> channelNames,
                                                            String fileFormat,
                                                            String compressionFormat,
                                                            String fileName,
                                                            ApiCallback<ExportLink> callback)
                                                     throws ApiException

Export selected channels to chosen file format. (asynchronously)

Parameters:

channelNames - List of channel names used for processing (required)

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