io.swagger.client.api

Class SegmentsApi

java.lang.Object

io.swagger.client.api.SegmentsApi

public class SegmentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SegmentsApi()
SegmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<Segment>	segmentsGet(Boolean includeHistory, String from, String to) Lists all your available Segments
com.squareup.okhttp.Call	segmentsGetAsync(Boolean includeHistory, String from, String to, ApiCallback<List<Segment>> callback) Lists all your available Segments (asynchronously)
com.squareup.okhttp.Call	segmentsGetCall(Boolean includeHistory, String from, String to, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentsGet
ApiResponse<List<Segment>>	segmentsGetWithHttpInfo(Boolean includeHistory, String from, String to) Lists all your available Segments
void	segmentsNameDelete(String name) Delete existing segment.
com.squareup.okhttp.Call	segmentsNameDeleteAsync(String name, ApiCallback<Void> callback) Delete existing segment.
com.squareup.okhttp.Call	segmentsNameDeleteCall(String name, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentsNameDelete
ApiResponse<Void>	segmentsNameDeleteWithHttpInfo(String name) Delete existing segment.
Segment	segmentsNameGet(String name, Boolean includeHistory, String from, String to) Lists your available Segment using the provided name
com.squareup.okhttp.Call	segmentsNameGetAsync(String name, Boolean includeHistory, String from, String to, ApiCallback<Segment> callback) Lists your available Segment using the provided name (asynchronously)
com.squareup.okhttp.Call	segmentsNameGetCall(String name, Boolean includeHistory, String from, String to, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentsNameGet
ApiResponse<Segment>	segmentsNameGetWithHttpInfo(String name, Boolean includeHistory, String from, String to) Lists your available Segment using the provided name
Segment	segmentsNamePut(String name, SegmentPayload body) Rename or change RULE for your segment
com.squareup.okhttp.Call	segmentsNamePutAsync(String name, SegmentPayload body, ApiCallback<Segment> callback) Rename or change RULE for your segment (asynchronously)
com.squareup.okhttp.Call	segmentsNamePutCall(String name, SegmentPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentsNamePut
ApiResponse<Segment>	segmentsNamePutWithHttpInfo(String name, SegmentPayload body) Rename or change RULE for your segment
Segment	segmentsPost(SegmentPayload body) Create new segment, based on specified RULE.
com.squareup.okhttp.Call	segmentsPostAsync(SegmentPayload body, ApiCallback<Segment> callback) Create new segment, based on specified RULE.
com.squareup.okhttp.Call	segmentsPostCall(SegmentPayload body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for segmentsPost
ApiResponse<Segment>	segmentsPostWithHttpInfo(SegmentPayload body) Create new segment, based on specified RULE.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentsApi

public SegmentsApi()

SegmentsApi

public SegmentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

segmentsGetCall

public com.squareup.okhttp.Call segmentsGetCall(Boolean includeHistory,
                                                String from,
                                                String to,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for segmentsGet

Parameters:

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentsGet

public List<Segment> segmentsGet(Boolean includeHistory,
                                 String from,
                                 String to)
                          throws ApiException

Lists all your available Segments

Parameters:

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

List<Segment>

Throws:

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

segmentsGetWithHttpInfo

public ApiResponse<List<Segment>> segmentsGetWithHttpInfo(Boolean includeHistory,
                                                          String from,
                                                          String to)
                                                   throws ApiException

Lists all your available Segments

Parameters:

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

ApiResponse<List<Segment>>

Throws:

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

segmentsGetAsync

public com.squareup.okhttp.Call segmentsGetAsync(Boolean includeHistory,
                                                 String from,
                                                 String to,
                                                 ApiCallback<List<Segment>> callback)
                                          throws ApiException

Lists all your available Segments (asynchronously)

Parameters:

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (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

segmentsNameDeleteCall

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

Build call for segmentsNameDelete

Parameters:

name - Name of your segment. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentsNameDelete

public void segmentsNameDelete(String name)
                        throws ApiException

Delete existing segment.

Parameters:

name - Name of your segment. (required)

Throws:

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

segmentsNameDeleteWithHttpInfo

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

Delete existing segment.

Parameters:

name - Name of your segment. (required)

Returns:

ApiResponse<Void>

Throws:

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

segmentsNameDeleteAsync

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

Delete existing segment. (asynchronously)

Parameters:

name - Name of your segment. (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

segmentsNameGetCall

public com.squareup.okhttp.Call segmentsNameGetCall(String name,
                                                    Boolean includeHistory,
                                                    String from,
                                                    String to,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException

Build call for segmentsNameGet

Parameters:

name - Name of the segment you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided (required)

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentsNameGet

public Segment segmentsNameGet(String name,
                               Boolean includeHistory,
                               String from,
                               String to)
                        throws ApiException

Lists your available Segment using the provided name

Parameters:

name - Name of the segment you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided (required)

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

Segment

Throws:

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

segmentsNameGetWithHttpInfo

public ApiResponse<Segment> segmentsNameGetWithHttpInfo(String name,
                                                        Boolean includeHistory,
                                                        String from,
                                                        String to)
                                                 throws ApiException

Lists your available Segment using the provided name

Parameters:

name - Name of the segment you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided (required)

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

Returns:

ApiResponse<Segment>

Throws:

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

segmentsNameGetAsync

public com.squareup.okhttp.Call segmentsNameGetAsync(String name,
                                                     Boolean includeHistory,
                                                     String from,
                                                     String to,
                                                     ApiCallback<Segment> callback)
                                              throws ApiException

Lists your available Segment using the provided name (asynchronously)

Parameters:

name - Name of the segment you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided (required)

includeHistory - True: Include history of last 30 days. Otherwise, false. (optional, default to False)

from - From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (optional)

to - To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. (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

segmentsNamePutCall

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

Build call for segmentsNamePut

Parameters:

name - Name of your segment. (required)

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentsNamePut

public Segment segmentsNamePut(String name,
                               SegmentPayload body)
                        throws ApiException

Rename or change RULE for your segment

Parameters:

name - Name of your segment. (required)

body - (required)

Returns:

Segment

Throws:

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

segmentsNamePutWithHttpInfo

public ApiResponse<Segment> segmentsNamePutWithHttpInfo(String name,
                                                        SegmentPayload body)
                                                 throws ApiException

Rename or change RULE for your segment

Parameters:

name - Name of your segment. (required)

body - (required)

Returns:

ApiResponse<Segment>

Throws:

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

segmentsNamePutAsync

public com.squareup.okhttp.Call segmentsNamePutAsync(String name,
                                                     SegmentPayload body,
                                                     ApiCallback<Segment> callback)
                                              throws ApiException

Rename or change RULE for your segment (asynchronously)

Parameters:

name - Name of your segment. (required)

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

segmentsPostCall

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

Build call for segmentsPost

Parameters:

body - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

segmentsPost

public Segment segmentsPost(SegmentPayload body)
                     throws ApiException

Create new segment, based on specified RULE.

Parameters:

body - (required)

Returns:

Segment

Throws:

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

segmentsPostWithHttpInfo

public ApiResponse<Segment> segmentsPostWithHttpInfo(SegmentPayload body)
                                              throws ApiException

Create new segment, based on specified RULE.

Parameters:

body - (required)

Returns:

ApiResponse<Segment>

Throws:

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

segmentsPostAsync

public com.squareup.okhttp.Call segmentsPostAsync(SegmentPayload body,
                                                  ApiCallback<Segment> callback)
                                           throws ApiException

Create new segment, based on specified RULE. (asynchronously)

Parameters:

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