Package io.voucherify.client.api

Class ProductCollectionsApi

java.lang.Object

io.voucherify.client.api.ProductCollectionsApi

public class ProductCollectionsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ProductCollectionsApi()
ProductCollectionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ProductCollectionsCreateResponseBody	createProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody)	Create Product Collection This method creates a new product collection.
okhttp3.Call	createProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, ApiCallback<ProductCollectionsCreateResponseBody> _callback)	Create Product Collection (asynchronously) This method creates a new product collection.
okhttp3.Call	createProductCollectionCall(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody, ApiCallback _callback)	Build call for createProductCollection
ApiResponse<ProductCollectionsCreateResponseBody>	createProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody)	Create Product Collection This method creates a new product collection.
void	deleteProductCollection(String productCollectionId)	Delete Product Collection This method deletes a product collection.
okhttp3.Call	deleteProductCollectionAsync(String productCollectionId, ApiCallback<Void> _callback)	Delete Product Collection (asynchronously) This method deletes a product collection.
okhttp3.Call	deleteProductCollectionCall(String productCollectionId, ApiCallback _callback)	Build call for deleteProductCollection
ApiResponse<Void>	deleteProductCollectionWithHttpInfo(String productCollectionId)	Delete Product Collection This method deletes a product collection.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
ProductCollectionsGetResponseBody	getProductCollection(String productCollectionId)	Get Product Collection Retrieves the product collection.
okhttp3.Call	getProductCollectionAsync(String productCollectionId, ApiCallback<ProductCollectionsGetResponseBody> _callback)	Get Product Collection (asynchronously) Retrieves the product collection.
okhttp3.Call	getProductCollectionCall(String productCollectionId, ApiCallback _callback)	Build call for getProductCollection
ApiResponse<ProductCollectionsGetResponseBody>	getProductCollectionWithHttpInfo(String productCollectionId)	Get Product Collection Retrieves the product collection.
ProductCollectionsListResponseBody	listProductCollections(Integer limit, Integer page, ParameterOrder order)	List Product Collections This method returns a list of product collections.
okhttp3.Call	listProductCollectionsAsync(Integer limit, Integer page, ParameterOrder order, ApiCallback<ProductCollectionsListResponseBody> _callback)	List Product Collections (asynchronously) This method returns a list of product collections.
okhttp3.Call	listProductCollectionsCall(Integer limit, Integer page, ParameterOrder order, ApiCallback _callback)	Build call for listProductCollections
ApiResponse<ProductCollectionsListResponseBody>	listProductCollectionsWithHttpInfo(Integer limit, Integer page, ParameterOrder order)	List Product Collections This method returns a list of product collections.
ProductCollectionsProductsListResponseBody	listProductsInCollection(String productCollectionId, Integer limit, Integer page, ParameterOrder order, OffsetDateTime startingAfter)	List Products in Collection Retrieves list of products from a product collection; works for both dynamic and static product collections.
okhttp3.Call	listProductsInCollectionAsync(String productCollectionId, Integer limit, Integer page, ParameterOrder order, OffsetDateTime startingAfter, ApiCallback<ProductCollectionsProductsListResponseBody> _callback)	List Products in Collection (asynchronously) Retrieves list of products from a product collection; works for both dynamic and static product collections.
okhttp3.Call	listProductsInCollectionCall(String productCollectionId, Integer limit, Integer page, ParameterOrder order, OffsetDateTime startingAfter, ApiCallback _callback)	Build call for listProductsInCollection
ApiResponse<ProductCollectionsProductsListResponseBody>	listProductsInCollectionWithHttpInfo(String productCollectionId, Integer limit, Integer page, ParameterOrder order, OffsetDateTime startingAfter)	List Products in Collection Retrieves list of products from a product collection; works for both dynamic and static product collections.
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

ProductCollectionsApi

public ProductCollectionsApi()

ProductCollectionsApi

public ProductCollectionsApi(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)

createProductCollectionCall

public okhttp3.Call createProductCollectionCall(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody,
 ApiCallback _callback)
                                         throws ApiException

Build call for createProductCollection

Parameters:

productCollectionsCreateRequestBody - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createProductCollection

public ProductCollectionsCreateResponseBody createProductCollection(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody)
                                                             throws ApiException

Create Product Collection This method creates a new product collection.

Parameters:

productCollectionsCreateRequestBody - (optional)

Returns:

ProductCollectionsCreateResponseBody

Throws:

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

createProductCollectionWithHttpInfo

public ApiResponse<ProductCollectionsCreateResponseBody> createProductCollectionWithHttpInfo(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody)
                                                                                      throws ApiException

Create Product Collection This method creates a new product collection.

Parameters:

productCollectionsCreateRequestBody - (optional)

Returns:

ApiResponse<ProductCollectionsCreateResponseBody>

Throws:

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

createProductCollectionAsync

public okhttp3.Call createProductCollectionAsync(ProductCollectionsCreateRequestBody productCollectionsCreateRequestBody,
 ApiCallback<ProductCollectionsCreateResponseBody> _callback)
                                          throws ApiException

Create Product Collection (asynchronously) This method creates a new product collection.

Parameters:

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

deleteProductCollectionCall

public okhttp3.Call deleteProductCollectionCall(String productCollectionId,
 ApiCallback _callback)
                                         throws ApiException

Build call for deleteProductCollection

Parameters:

productCollectionId - A unique product collection ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteProductCollection

public void deleteProductCollection(String productCollectionId)
                             throws ApiException

Delete Product Collection This method deletes a product collection.

Parameters:

productCollectionId - A unique product collection ID. (required)

Throws:

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

deleteProductCollectionWithHttpInfo

public ApiResponse<Void> deleteProductCollectionWithHttpInfo(String productCollectionId)
                                                      throws ApiException

Delete Product Collection This method deletes a product collection.

Parameters:

productCollectionId - A unique product collection ID. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteProductCollectionAsync

public okhttp3.Call deleteProductCollectionAsync(String productCollectionId,
 ApiCallback<Void> _callback)
                                          throws ApiException

Delete Product Collection (asynchronously) This method deletes a product collection.

Parameters:

productCollectionId - A unique product collection 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

getProductCollectionCall

public okhttp3.Call getProductCollectionCall(String productCollectionId,
 ApiCallback _callback)
                                      throws ApiException

Build call for getProductCollection

Parameters:

productCollectionId - A unique product collection ID. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getProductCollection

public ProductCollectionsGetResponseBody getProductCollection(String productCollectionId)
                                                       throws ApiException

Get Product Collection Retrieves the product collection.

Parameters:

productCollectionId - A unique product collection ID. (required)

Returns:

ProductCollectionsGetResponseBody

Throws:

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

getProductCollectionWithHttpInfo

public ApiResponse<ProductCollectionsGetResponseBody> getProductCollectionWithHttpInfo(String productCollectionId)
                                                                                throws ApiException

Get Product Collection Retrieves the product collection.

Parameters:

productCollectionId - A unique product collection ID. (required)

Returns:

ApiResponse<ProductCollectionsGetResponseBody>

Throws:

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

getProductCollectionAsync

public okhttp3.Call getProductCollectionAsync(String productCollectionId,
 ApiCallback<ProductCollectionsGetResponseBody> _callback)
                                       throws ApiException

Get Product Collection (asynchronously) Retrieves the product collection.

Parameters:

productCollectionId - A unique product collection 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

listProductCollectionsCall

public okhttp3.Call listProductCollectionsCall(Integer limit,
 Integer page,
 ParameterOrder order,
 ApiCallback _callback)
                                        throws ApiException

Build call for listProductCollections

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listProductCollections

public ProductCollectionsListResponseBody listProductCollections(Integer limit,
 Integer page,
 ParameterOrder order)
                                                          throws ApiException

List Product Collections This method returns a list of product collections.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

ProductCollectionsListResponseBody

Throws:

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

listProductCollectionsWithHttpInfo

public ApiResponse<ProductCollectionsListResponseBody> listProductCollectionsWithHttpInfo(Integer limit,
 Integer page,
 ParameterOrder order)
                                                                                   throws ApiException

List Product Collections This method returns a list of product collections.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

Returns:

ApiResponse<ProductCollectionsListResponseBody>

Throws:

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

listProductCollectionsAsync

public okhttp3.Call listProductCollectionsAsync(Integer limit,
 Integer page,
 ParameterOrder order,
 ApiCallback<ProductCollectionsListResponseBody> _callback)
                                         throws ApiException

List Product Collections (asynchronously) This method returns a list of product collections.

Parameters:

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (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

listProductsInCollectionCall

public okhttp3.Call listProductsInCollectionCall(String productCollectionId,
 Integer limit,
 Integer page,
 ParameterOrder order,
 OffsetDateTime startingAfter,
 ApiCallback _callback)
                                          throws ApiException

Build call for listProductsInCollection

Parameters:

productCollectionId - Unique product collection ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - Timestamp representing the date and time to use in starting_after cursor to get more data. Represented in ISO 8601 format. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listProductsInCollection

public ProductCollectionsProductsListResponseBody listProductsInCollection(String productCollectionId,
 Integer limit,
 Integer page,
 ParameterOrder order,
 OffsetDateTime startingAfter)
                                                                    throws ApiException

List Products in Collection Retrieves list of products from a product collection; works for both dynamic and static product collections.

Parameters:

productCollectionId - Unique product collection ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - Timestamp representing the date and time to use in starting_after cursor to get more data. Represented in ISO 8601 format. (optional)

Returns:

ProductCollectionsProductsListResponseBody

Throws:

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

listProductsInCollectionWithHttpInfo

public ApiResponse<ProductCollectionsProductsListResponseBody> listProductsInCollectionWithHttpInfo(String productCollectionId,
 Integer limit,
 Integer page,
 ParameterOrder order,
 OffsetDateTime startingAfter)
                                                                                             throws ApiException

List Products in Collection Retrieves list of products from a product collection; works for both dynamic and static product collections.

Parameters:

productCollectionId - Unique product collection ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - Timestamp representing the date and time to use in starting_after cursor to get more data. Represented in ISO 8601 format. (optional)

Returns:

ApiResponse<ProductCollectionsProductsListResponseBody>

Throws:

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

listProductsInCollectionAsync

public okhttp3.Call listProductsInCollectionAsync(String productCollectionId,
 Integer limit,
 Integer page,
 ParameterOrder order,
 OffsetDateTime startingAfter,
 ApiCallback<ProductCollectionsProductsListResponseBody> _callback)
                                           throws ApiException

List Products in Collection (asynchronously) Retrieves list of products from a product collection; works for both dynamic and static product collections.

Parameters:

productCollectionId - Unique product collection ID. (required)

limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)

page - Which page of results to return. The lowest value is 1. (optional)

order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)

startingAfter - Timestamp representing the date and time to use in starting_after cursor to get more data. Represented in ISO 8601 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