Package io.voucherify.client.api

Class SegmentsApi

java.lang.Object

io.voucherify.client.api.SegmentsApi

public class SegmentsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SegmentsApi()
SegmentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SegmentsCreateResponseBody	createSegment(SegmentsCreateRequestBody segmentsCreateRequestBody)	Create Segment Create a customer segment.
okhttp3.Call	createSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody, ApiCallback<SegmentsCreateResponseBody> _callback)	Create Segment (asynchronously) Create a customer segment.
okhttp3.Call	createSegmentCall(SegmentsCreateRequestBody segmentsCreateRequestBody, ApiCallback _callback)	Build call for createSegment
ApiResponse<SegmentsCreateResponseBody>	createSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody)	Create Segment Create a customer segment.
void	deleteSegment(String segmentId)	Delete Segment This method deletes a customer segment.
okhttp3.Call	deleteSegmentAsync(String segmentId, ApiCallback<Void> _callback)	Delete Segment (asynchronously) This method deletes a customer segment.
okhttp3.Call	deleteSegmentCall(String segmentId, ApiCallback _callback)	Build call for deleteSegment
ApiResponse<Void>	deleteSegmentWithHttpInfo(String segmentId)	Delete Segment This method deletes a customer segment.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SegmentsGetResponseBody	getSegment(String segmentId)	Get Segment Retrieves the segment with given segment ID.
okhttp3.Call	getSegmentAsync(String segmentId, ApiCallback<SegmentsGetResponseBody> _callback)	Get Segment (asynchronously) Retrieves the segment with given segment ID.
okhttp3.Call	getSegmentCall(String segmentId, ApiCallback _callback)	Build call for getSegment
ApiResponse<SegmentsGetResponseBody>	getSegmentWithHttpInfo(String segmentId)	Get Segment Retrieves the segment with given segment ID.
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 Details

SegmentsApi

public SegmentsApi()

SegmentsApi

public SegmentsApi(ApiClient apiClient)

Method Details

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)

createSegmentCall

public okhttp3.Call createSegmentCall(SegmentsCreateRequestBody segmentsCreateRequestBody,
 ApiCallback _callback)
                               throws ApiException

Build call for createSegment

Parameters:

segmentsCreateRequestBody - Specify the boundary conditions for the customer segment. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createSegment

public SegmentsCreateResponseBody createSegment(SegmentsCreateRequestBody segmentsCreateRequestBody)
                                         throws ApiException

Create Segment Create a customer segment. 🚧 Limit on Static Segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.

Parameters:

segmentsCreateRequestBody - Specify the boundary conditions for the customer segment. (optional)

Returns:

SegmentsCreateResponseBody

Throws:

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

createSegmentWithHttpInfo

public ApiResponse<SegmentsCreateResponseBody> createSegmentWithHttpInfo(SegmentsCreateRequestBody segmentsCreateRequestBody)
                                                                  throws ApiException

Create Segment Create a customer segment. 🚧 Limit on Static Segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.

Parameters:

segmentsCreateRequestBody - Specify the boundary conditions for the customer segment. (optional)

Returns:

ApiResponse<SegmentsCreateResponseBody>

Throws:

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

createSegmentAsync

public okhttp3.Call createSegmentAsync(SegmentsCreateRequestBody segmentsCreateRequestBody,
 ApiCallback<SegmentsCreateResponseBody> _callback)
                                throws ApiException

Create Segment (asynchronously) Create a customer segment. 🚧 Limit on Static Segments There is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited auto-update segment instead and use some customer metadata to build this segment.

Parameters:

segmentsCreateRequestBody - Specify the boundary conditions for the customer segment. (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

deleteSegmentCall

public okhttp3.Call deleteSegmentCall(String segmentId,
 ApiCallback _callback)
                               throws ApiException

Build call for deleteSegment

Parameters:

segmentId - A unique customer segment ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteSegment

public void deleteSegment(String segmentId)
                   throws ApiException

Delete Segment This method deletes a customer segment.

Parameters:

segmentId - A unique customer segment ID. (required)

Throws:

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

deleteSegmentWithHttpInfo

public ApiResponse<Void> deleteSegmentWithHttpInfo(String segmentId)
                                            throws ApiException

Delete Segment This method deletes a customer segment.

Parameters:

segmentId - A unique customer segment ID. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteSegmentAsync

public okhttp3.Call deleteSegmentAsync(String segmentId,
 ApiCallback<Void> _callback)
                                throws ApiException

Delete Segment (asynchronously) This method deletes a customer segment.

Parameters:

segmentId - A unique customer segment ID. (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

getSegmentCall

public okhttp3.Call getSegmentCall(String segmentId,
 ApiCallback _callback)
                            throws ApiException

Build call for getSegment

Parameters:

segmentId - A unique customer segment ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSegment

public SegmentsGetResponseBody getSegment(String segmentId)
                                   throws ApiException

Get Segment Retrieves the segment with given segment ID.

Parameters:

segmentId - A unique customer segment ID. (required)

Returns:

SegmentsGetResponseBody

Throws:

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

getSegmentWithHttpInfo

public ApiResponse<SegmentsGetResponseBody> getSegmentWithHttpInfo(String segmentId)
                                                            throws ApiException

Get Segment Retrieves the segment with given segment ID.

Parameters:

segmentId - A unique customer segment ID. (required)

Returns:

ApiResponse<SegmentsGetResponseBody>

Throws:

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

getSegmentAsync

public okhttp3.Call getSegmentAsync(String segmentId,
 ApiCallback<SegmentsGetResponseBody> _callback)
                             throws ApiException

Get Segment (asynchronously) Retrieves the segment with given segment ID.

Parameters:

segmentId - A unique customer segment ID. (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