Package io.voucherify.client.api

Class CategoriesApi

java.lang.Object

io.voucherify.client.api.CategoriesApi

public class CategoriesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CategoriesApi()
CategoriesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CategoriesCreateResponseBody	createCategory(CategoriesCreateRequestBody categoriesCreateRequestBody)	Create Category Create category with a specific name and hierarchy.
okhttp3.Call	createCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody, ApiCallback<CategoriesCreateResponseBody> _callback)	Create Category (asynchronously) Create category with a specific name and hierarchy.
okhttp3.Call	createCategoryCall(CategoriesCreateRequestBody categoriesCreateRequestBody, ApiCallback _callback)	Build call for createCategory
ApiResponse<CategoriesCreateResponseBody>	createCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody)	Create Category Create category with a specific name and hierarchy.
void	deleteCategory(String categoryId)	Delete Category Delete a category by the category ID.
okhttp3.Call	deleteCategoryAsync(String categoryId, ApiCallback<Void> _callback)	Delete Category (asynchronously) Delete a category by the category ID.
okhttp3.Call	deleteCategoryCall(String categoryId, ApiCallback _callback)	Build call for deleteCategory
ApiResponse<Void>	deleteCategoryWithHttpInfo(String categoryId)	Delete Category Delete a category by the category ID.
ApiClient	getApiClient()
CategoriesGetResponseBody	getCategory(String categoryId)	Get Category Retrieve a category by the category ID.
okhttp3.Call	getCategoryAsync(String categoryId, ApiCallback<CategoriesGetResponseBody> _callback)	Get Category (asynchronously) Retrieve a category by the category ID.
okhttp3.Call	getCategoryCall(String categoryId, ApiCallback _callback)	Build call for getCategory
ApiResponse<CategoriesGetResponseBody>	getCategoryWithHttpInfo(String categoryId)	Get Category Retrieve a category by the category ID.
String	getCustomBaseUrl()
int	getHostIndex()
CategoriesListResponseBody	listCategories()	List Categories List all categories.
okhttp3.Call	listCategoriesAsync(ApiCallback<CategoriesListResponseBody> _callback)	List Categories (asynchronously) List all categories.
okhttp3.Call	listCategoriesCall(ApiCallback _callback)	Build call for listCategories
ApiResponse<CategoriesListResponseBody>	listCategoriesWithHttpInfo()	List Categories List all categories.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
CategoriesUpdateResponseBody	updateCategory(String categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody)	Update Category Update category using the category ID.
okhttp3.Call	updateCategoryAsync(String categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, ApiCallback<CategoriesUpdateResponseBody> _callback)	Update Category (asynchronously) Update category using the category ID.
okhttp3.Call	updateCategoryCall(String categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody, ApiCallback _callback)	Build call for updateCategory
ApiResponse<CategoriesUpdateResponseBody>	updateCategoryWithHttpInfo(String categoryId, CategoriesUpdateRequestBody categoriesUpdateRequestBody)	Update Category Update category using the category ID.

Methods inherited from class java.lang.Object

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

Constructor Details

CategoriesApi

public CategoriesApi()

CategoriesApi

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

createCategoryCall

public okhttp3.Call createCategoryCall(CategoriesCreateRequestBody categoriesCreateRequestBody,
 ApiCallback _callback)
                                throws ApiException

Build call for createCategory

Parameters:

categoriesCreateRequestBody - Specify the details of the category that you would like to create. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createCategory

public CategoriesCreateResponseBody createCategory(CategoriesCreateRequestBody categoriesCreateRequestBody)
                                            throws ApiException

Create Category Create category with a specific name and hierarchy.

Parameters:

categoriesCreateRequestBody - Specify the details of the category that you would like to create. (optional)

Returns:

CategoriesCreateResponseBody

Throws:

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

createCategoryWithHttpInfo

public ApiResponse<CategoriesCreateResponseBody> createCategoryWithHttpInfo(CategoriesCreateRequestBody categoriesCreateRequestBody)
                                                                     throws ApiException

Create Category Create category with a specific name and hierarchy.

Parameters:

categoriesCreateRequestBody - Specify the details of the category that you would like to create. (optional)

Returns:

ApiResponse<CategoriesCreateResponseBody>

Throws:

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

createCategoryAsync

public okhttp3.Call createCategoryAsync(CategoriesCreateRequestBody categoriesCreateRequestBody,
 ApiCallback<CategoriesCreateResponseBody> _callback)
                                 throws ApiException

Create Category (asynchronously) Create category with a specific name and hierarchy.

Parameters:

categoriesCreateRequestBody - Specify the details of the category that you would like to create. (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

deleteCategoryCall

public okhttp3.Call deleteCategoryCall(String categoryId,
 ApiCallback _callback)
                                throws ApiException

Build call for deleteCategory

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteCategory

public void deleteCategory(String categoryId)
                    throws ApiException

Delete Category Delete a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

Throws:

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

deleteCategoryWithHttpInfo

public ApiResponse<Void> deleteCategoryWithHttpInfo(String categoryId)
                                             throws ApiException

Delete Category Delete a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteCategoryAsync

public okhttp3.Call deleteCategoryAsync(String categoryId,
 ApiCallback<Void> _callback)
                                 throws ApiException

Delete Category (asynchronously) Delete a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (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

getCategoryCall

public okhttp3.Call getCategoryCall(String categoryId,
 ApiCallback _callback)
                             throws ApiException

Build call for getCategory

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getCategory

public CategoriesGetResponseBody getCategory(String categoryId)
                                      throws ApiException

Get Category Retrieve a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

Returns:

CategoriesGetResponseBody

Throws:

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

getCategoryWithHttpInfo

public ApiResponse<CategoriesGetResponseBody> getCategoryWithHttpInfo(String categoryId)
                                                               throws ApiException

Get Category Retrieve a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

Returns:

ApiResponse<CategoriesGetResponseBody>

Throws:

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

getCategoryAsync

public okhttp3.Call getCategoryAsync(String categoryId,
 ApiCallback<CategoriesGetResponseBody> _callback)
                              throws ApiException

Get Category (asynchronously) Retrieve a category by the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (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

listCategoriesCall

public okhttp3.Call listCategoriesCall(ApiCallback _callback)
                                throws ApiException

Build call for listCategories

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

listCategories

public CategoriesListResponseBody listCategories()
                                          throws ApiException

List Categories List all categories.

Returns:

CategoriesListResponseBody

Throws:

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

listCategoriesWithHttpInfo

public ApiResponse<CategoriesListResponseBody> listCategoriesWithHttpInfo()
                                                                   throws ApiException

List Categories List all categories.

Returns:

ApiResponse<CategoriesListResponseBody>

Throws:

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

listCategoriesAsync

public okhttp3.Call listCategoriesAsync(ApiCallback<CategoriesListResponseBody> _callback)
                                 throws ApiException

List Categories (asynchronously) List all categories.

Parameters:

_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

updateCategoryCall

public okhttp3.Call updateCategoryCall(String categoryId,
 CategoriesUpdateRequestBody categoriesUpdateRequestBody,
 ApiCallback _callback)
                                throws ApiException

Build call for updateCategory

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

categoriesUpdateRequestBody - Specify the details of the category that you would like to update. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateCategory

public CategoriesUpdateResponseBody updateCategory(String categoryId,
 CategoriesUpdateRequestBody categoriesUpdateRequestBody)
                                            throws ApiException

Update Category Update category using the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

categoriesUpdateRequestBody - Specify the details of the category that you would like to update. (optional)

Returns:

CategoriesUpdateResponseBody

Throws:

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

updateCategoryWithHttpInfo

public ApiResponse<CategoriesUpdateResponseBody> updateCategoryWithHttpInfo(String categoryId,
 CategoriesUpdateRequestBody categoriesUpdateRequestBody)
                                                                     throws ApiException

Update Category Update category using the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

categoriesUpdateRequestBody - Specify the details of the category that you would like to update. (optional)

Returns:

ApiResponse<CategoriesUpdateResponseBody>

Throws:

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

updateCategoryAsync

public okhttp3.Call updateCategoryAsync(String categoryId,
 CategoriesUpdateRequestBody categoriesUpdateRequestBody,
 ApiCallback<CategoriesUpdateResponseBody> _callback)
                                 throws ApiException

Update Category (asynchronously) Update category using the category ID.

Parameters:

categoryId - Unique category ID assigned by Voucherify. (required)

categoriesUpdateRequestBody - Specify the details of the category that you would like to update. (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