com.configcat.publicapi.java.client.api

Class ProductsApi

java.lang.Object

com.configcat.publicapi.java.client.api.ProductsApi

public class ProductsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProductsApi()
ProductsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ProductModel	createProduct(java.util.UUID organizationId, CreateProductRequest createProductRequest) Create Product This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.
okhttp3.Call	createProductAsync(java.util.UUID organizationId, CreateProductRequest createProductRequest, ApiCallback<ProductModel> _callback) Create Product (asynchronously) This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.
okhttp3.Call	createProductCall(java.util.UUID organizationId, CreateProductRequest createProductRequest, ApiCallback _callback) Build call for createProduct
ApiResponse<ProductModel>	createProductWithHttpInfo(java.util.UUID organizationId, CreateProductRequest createProductRequest) Create Product This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.
void	deleteProduct(java.util.UUID productId) Delete Product This endpoint removes a Product identified by the `productId` parameter.
okhttp3.Call	deleteProductAsync(java.util.UUID productId, ApiCallback<java.lang.Void> _callback) Delete Product (asynchronously) This endpoint removes a Product identified by the `productId` parameter.
okhttp3.Call	deleteProductCall(java.util.UUID productId, ApiCallback _callback) Build call for deleteProduct
ApiResponse<java.lang.Void>	deleteProductWithHttpInfo(java.util.UUID productId) Delete Product This endpoint removes a Product identified by the `productId` parameter.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
ProductModel	getProduct(java.util.UUID productId) Get Product This endpoint returns the metadata of a Product identified by the `productId`.
okhttp3.Call	getProductAsync(java.util.UUID productId, ApiCallback<ProductModel> _callback) Get Product (asynchronously) This endpoint returns the metadata of a Product identified by the `productId`.
okhttp3.Call	getProductCall(java.util.UUID productId, ApiCallback _callback) Build call for getProduct
PreferencesModel	getProductPreferences(java.util.UUID productId) Get Product Preferences This endpoint returns the preferences of a Product identified by the `productId`.
okhttp3.Call	getProductPreferencesAsync(java.util.UUID productId, ApiCallback<PreferencesModel> _callback) Get Product Preferences (asynchronously) This endpoint returns the preferences of a Product identified by the `productId`.
okhttp3.Call	getProductPreferencesCall(java.util.UUID productId, ApiCallback _callback) Build call for getProductPreferences
ApiResponse<PreferencesModel>	getProductPreferencesWithHttpInfo(java.util.UUID productId) Get Product Preferences This endpoint returns the preferences of a Product identified by the `productId`.
java.util.List<ProductModel>	getProducts() List Products This endpoint returns the list of the Products that belongs to the user.
okhttp3.Call	getProductsAsync(ApiCallback<java.util.List<ProductModel>> _callback) List Products (asynchronously) This endpoint returns the list of the Products that belongs to the user.
okhttp3.Call	getProductsCall(ApiCallback _callback) Build call for getProducts
ApiResponse<java.util.List<ProductModel>>	getProductsWithHttpInfo() List Products This endpoint returns the list of the Products that belongs to the user.
ApiResponse<ProductModel>	getProductWithHttpInfo(java.util.UUID productId) Get Product This endpoint returns the metadata of a Product identified by the `productId`.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
ProductModel	updateProduct(java.util.UUID productId, UpdateProductRequest updateProductRequest) Update Product This endpoint updates a Product identified by the `productId` parameter.
okhttp3.Call	updateProductAsync(java.util.UUID productId, UpdateProductRequest updateProductRequest, ApiCallback<ProductModel> _callback) Update Product (asynchronously) This endpoint updates a Product identified by the `productId` parameter.
okhttp3.Call	updateProductCall(java.util.UUID productId, UpdateProductRequest updateProductRequest, ApiCallback _callback) Build call for updateProduct
PreferencesModel	updateProductPreferences(java.util.UUID productId, UpdatePreferencesRequest updatePreferencesRequest) Update Product Preferences This endpoint updates the preferences of a Product identified by the `productId` parameter.
okhttp3.Call	updateProductPreferencesAsync(java.util.UUID productId, UpdatePreferencesRequest updatePreferencesRequest, ApiCallback<PreferencesModel> _callback) Update Product Preferences (asynchronously) This endpoint updates the preferences of a Product identified by the `productId` parameter.
okhttp3.Call	updateProductPreferencesCall(java.util.UUID productId, UpdatePreferencesRequest updatePreferencesRequest, ApiCallback _callback) Build call for updateProductPreferences
ApiResponse<PreferencesModel>	updateProductPreferencesWithHttpInfo(java.util.UUID productId, UpdatePreferencesRequest updatePreferencesRequest) Update Product Preferences This endpoint updates the preferences of a Product identified by the `productId` parameter.
ApiResponse<ProductModel>	updateProductWithHttpInfo(java.util.UUID productId, UpdateProductRequest updateProductRequest) Update Product This endpoint updates a Product identified by the `productId` parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductsApi

public ProductsApi()

ProductsApi

public ProductsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createProductCall

public okhttp3.Call createProductCall(java.util.UUID organizationId,
                                      CreateProductRequest createProductRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createProduct

Parameters:

organizationId - The identifier of the Organization. (required)

createProductRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createProduct

public ProductModel createProduct(java.util.UUID organizationId,
                                  CreateProductRequest createProductRequest)
                           throws ApiException

Create Product This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.

Parameters:

organizationId - The identifier of the Organization. (required)

createProductRequest - (required)

Returns:

ProductModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createProductWithHttpInfo

public ApiResponse<ProductModel> createProductWithHttpInfo(java.util.UUID organizationId,
                                                           CreateProductRequest createProductRequest)
                                                    throws ApiException

Create Product This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.

Parameters:

organizationId - The identifier of the Organization. (required)

createProductRequest - (required)

Returns:

ApiResponse<ProductModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

createProductAsync

public okhttp3.Call createProductAsync(java.util.UUID organizationId,
                                       CreateProductRequest createProductRequest,
                                       ApiCallback<ProductModel> _callback)
                                throws ApiException

Create Product (asynchronously) This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.

Parameters:

organizationId - The identifier of the Organization. (required)

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

Http Response Details

Status Code	Description	Response Headers
201	When the creation was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductCall

public okhttp3.Call deleteProductCall(java.util.UUID productId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteProduct

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProduct

public void deleteProduct(java.util.UUID productId)
                   throws ApiException

Delete Product This endpoint removes a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductWithHttpInfo

public ApiResponse<java.lang.Void> deleteProductWithHttpInfo(java.util.UUID productId)
                                                      throws ApiException

Delete Product This endpoint removes a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

deleteProductAsync

public okhttp3.Call deleteProductAsync(java.util.UUID productId,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException

Delete Product (asynchronously) This endpoint removes a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (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

Http Response Details

Status Code	Description	Response Headers
204	When the delete was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductCall

public okhttp3.Call getProductCall(java.util.UUID productId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getProduct

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProduct

public ProductModel getProduct(java.util.UUID productId)
                        throws ApiException

Get Product This endpoint returns the metadata of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ProductModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductWithHttpInfo

public ApiResponse<ProductModel> getProductWithHttpInfo(java.util.UUID productId)
                                                 throws ApiException

Get Product This endpoint returns the metadata of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<ProductModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductAsync

public okhttp3.Call getProductAsync(java.util.UUID productId,
                                    ApiCallback<ProductModel> _callback)
                             throws ApiException

Get Product (asynchronously) This endpoint returns the metadata of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductPreferencesCall

public okhttp3.Call getProductPreferencesCall(java.util.UUID productId,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getProductPreferences

Parameters:

productId - The identifier of the Product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product preferences data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductPreferences

public PreferencesModel getProductPreferences(java.util.UUID productId)
                                       throws ApiException

Get Product Preferences This endpoint returns the preferences of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (required)

Returns:

PreferencesModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product preferences data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductPreferencesWithHttpInfo

public ApiResponse<PreferencesModel> getProductPreferencesWithHttpInfo(java.util.UUID productId)
                                                                throws ApiException

Get Product Preferences This endpoint returns the preferences of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (required)

Returns:

ApiResponse<PreferencesModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product preferences data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductPreferencesAsync

public okhttp3.Call getProductPreferencesAsync(java.util.UUID productId,
                                               ApiCallback<PreferencesModel> _callback)
                                        throws ApiException

Get Product Preferences (asynchronously) This endpoint returns the preferences of a Product identified by the `productId`.

Parameters:

productId - The identifier of the Product. (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

Http Response Details

Status Code	Description	Response Headers
200	When everything is ok, the product preferences data is returned.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductsCall

public okhttp3.Call getProductsCall(ApiCallback _callback)
                             throws ApiException

Build call for getProducts

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProducts

public java.util.List<ProductModel> getProducts()
                                         throws ApiException

List Products This endpoint returns the list of the Products that belongs to the user.

Returns:

List<ProductModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductsWithHttpInfo

public ApiResponse<java.util.List<ProductModel>> getProductsWithHttpInfo()
                                                                  throws ApiException

List Products This endpoint returns the list of the Products that belongs to the user.

Returns:

ApiResponse<List<ProductModel>>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getProductsAsync

public okhttp3.Call getProductsAsync(ApiCallback<java.util.List<ProductModel>> _callback)
                              throws ApiException

List Products (asynchronously) This endpoint returns the list of the Products that belongs to the user.

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

Http Response Details

Status Code	Description	Response Headers
200		-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductCall

public okhttp3.Call updateProductCall(java.util.UUID productId,
                                      UpdateProductRequest updateProductRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateProduct

Parameters:

productId - The identifier of the Product. (required)

updateProductRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProduct

public ProductModel updateProduct(java.util.UUID productId,
                                  UpdateProductRequest updateProductRequest)
                           throws ApiException

Update Product This endpoint updates a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

updateProductRequest - (required)

Returns:

ProductModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductWithHttpInfo

public ApiResponse<ProductModel> updateProductWithHttpInfo(java.util.UUID productId,
                                                           UpdateProductRequest updateProductRequest)
                                                    throws ApiException

Update Product This endpoint updates a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

updateProductRequest - (required)

Returns:

ApiResponse<ProductModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductAsync

public okhttp3.Call updateProductAsync(java.util.UUID productId,
                                       UpdateProductRequest updateProductRequest,
                                       ApiCallback<ProductModel> _callback)
                                throws ApiException

Update Product (asynchronously) This endpoint updates a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

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

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductPreferencesCall

public okhttp3.Call updateProductPreferencesCall(java.util.UUID productId,
                                                 UpdatePreferencesRequest updatePreferencesRequest,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for updateProductPreferences

Parameters:

productId - The identifier of the Product. (required)

updatePreferencesRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductPreferences

public PreferencesModel updateProductPreferences(java.util.UUID productId,
                                                 UpdatePreferencesRequest updatePreferencesRequest)
                                          throws ApiException

Update Product Preferences This endpoint updates the preferences of a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

updatePreferencesRequest - (required)

Returns:

PreferencesModel

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductPreferencesWithHttpInfo

public ApiResponse<PreferencesModel> updateProductPreferencesWithHttpInfo(java.util.UUID productId,
                                                                          UpdatePreferencesRequest updatePreferencesRequest)
                                                                   throws ApiException

Update Product Preferences This endpoint updates the preferences of a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

updatePreferencesRequest - (required)

Returns:

ApiResponse<PreferencesModel>

Throws:

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

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateProductPreferencesAsync

public okhttp3.Call updateProductPreferencesAsync(java.util.UUID productId,
                                                  UpdatePreferencesRequest updatePreferencesRequest,
                                                  ApiCallback<PreferencesModel> _callback)
                                           throws ApiException

Update Product Preferences (asynchronously) This endpoint updates the preferences of a Product identified by the `productId` parameter.

Parameters:

productId - The identifier of the Product. (required)

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

Http Response Details

Status Code	Description	Response Headers
200	When the update was successful.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-