org.wso2.am.integration.clients.publisher.api.v1

Class ApiProductsApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.ApiProductsApi

public class ApiProductsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiProductsApi()
ApiProductsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	apiProductsApiProductIdDelete(String apiProductId, String ifMatch) Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDeleteAsync(String apiProductId, String ifMatch, ApiCallback<Void> callback) Delete an API Product (asynchronously) This operation can be used to delete an existing API Product proving the Id of the API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDeleteCall(String apiProductId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDelete
ApiResponse<Void>	apiProductsApiProductIdDeleteWithHttpInfo(String apiProductId, String ifMatch) Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.
APIProductDTO	apiProductsApiProductIdGet(String apiProductId, String accept, String ifNoneMatch) Get details of an API Product Using this operation, you can retrieve complete details of a single API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdGetAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<APIProductDTO> callback) Get details of an API Product (asynchronously) Using this operation, you can retrieve complete details of a single API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdGetCall(String apiProductId, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdGet
ApiResponse<APIProductDTO>	apiProductsApiProductIdGetWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get details of an API Product Using this operation, you can retrieve complete details of a single API Product.
APIProductDTO	apiProductsApiProductIdPut(String apiProductId, APIProductDTO body, String ifMatch) Update an API product This operation can be used to update an existing API product.
com.squareup.okhttp.Call	apiProductsApiProductIdPutAsync(String apiProductId, APIProductDTO body, String ifMatch, ApiCallback<APIProductDTO> callback) Update an API product (asynchronously) This operation can be used to update an existing API product.
com.squareup.okhttp.Call	apiProductsApiProductIdPutCall(String apiProductId, APIProductDTO body, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdPut
ApiResponse<APIProductDTO>	apiProductsApiProductIdPutWithHttpInfo(String apiProductId, APIProductDTO body, String ifMatch) Update an API product This operation can be used to update an existing API product.
void	apiProductsApiProductIdSwaggerGet(String apiProductId, String accept, String ifNoneMatch) Get swagger definition This operation can be used to retrieve the swagger definition of an API.
com.squareup.okhttp.Call	apiProductsApiProductIdSwaggerGetAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<Void> callback) Get swagger definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.
com.squareup.okhttp.Call	apiProductsApiProductIdSwaggerGetCall(String apiProductId, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdSwaggerGet
ApiResponse<Void>	apiProductsApiProductIdSwaggerGetWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get swagger definition This operation can be used to retrieve the swagger definition of an API.
void	apiProductsApiProductIdSwaggerPut(String apiProductId, String apiDefinition, String ifMatch) upload swagger definition This operation can be used to create/update the swagger definition of an existing API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdSwaggerPutAsync(String apiProductId, String apiDefinition, String ifMatch, ApiCallback<Void> callback) upload swagger definition (asynchronously) This operation can be used to create/update the swagger definition of an existing API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdSwaggerPutCall(String apiProductId, String apiDefinition, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdSwaggerPut
ApiResponse<Void>	apiProductsApiProductIdSwaggerPutWithHttpInfo(String apiProductId, String apiDefinition, String ifMatch) upload swagger definition This operation can be used to create/update the swagger definition of an existing API Product.
void	apiProductsApiProductIdThumbnailGet(String apiProductId, String accept, String ifNoneMatch) Get thumbnail image This operation can be used to download a thumbnail image of an API product.
com.squareup.okhttp.Call	apiProductsApiProductIdThumbnailGetAsync(String apiProductId, String accept, String ifNoneMatch, ApiCallback<Void> callback) Get thumbnail image (asynchronously) This operation can be used to download a thumbnail image of an API product.
com.squareup.okhttp.Call	apiProductsApiProductIdThumbnailGetCall(String apiProductId, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdThumbnailGet
ApiResponse<Void>	apiProductsApiProductIdThumbnailGetWithHttpInfo(String apiProductId, String accept, String ifNoneMatch) Get thumbnail image This operation can be used to download a thumbnail image of an API product.
FileInfoDTO	apiProductsApiProductIdThumbnailPut(String apiProductId, File file, String ifMatch) Upload a thumbnail image This operation can be used to upload a thumbnail image of an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdThumbnailPutAsync(String apiProductId, File file, String ifMatch, ApiCallback<FileInfoDTO> callback) Upload a thumbnail image (asynchronously) This operation can be used to upload a thumbnail image of an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdThumbnailPutCall(String apiProductId, File file, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdThumbnailPut
ApiResponse<FileInfoDTO>	apiProductsApiProductIdThumbnailPutWithHttpInfo(String apiProductId, File file, String ifMatch) Upload a thumbnail image This operation can be used to upload a thumbnail image of an API Product.
APIProductListDTO	apiProductsGet(Integer limit, Integer offset, String query, String accept, String ifNoneMatch) Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition.
com.squareup.okhttp.Call	apiProductsGetAsync(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ApiCallback<APIProductListDTO> callback) Retrieve/Search API Products (asynchronously) This operation provides you a list of available API Products qualifying under a given search condition.
com.squareup.okhttp.Call	apiProductsGetCall(Integer limit, Integer offset, String query, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsGet
ApiResponse<APIProductListDTO>	apiProductsGetWithHttpInfo(Integer limit, Integer offset, String query, String accept, String ifNoneMatch) Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition.
APIProductDTO	apiProductsPost(APIProductDTO body) Create a new API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.
com.squareup.okhttp.Call	apiProductsPostAsync(APIProductDTO body, ApiCallback<APIProductDTO> callback) Create a new API Product (asynchronously) This operation can be used to create a new API Product specifying the details of the API Product in the payload.
com.squareup.okhttp.Call	apiProductsPostCall(APIProductDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsPost
ApiResponse<APIProductDTO>	apiProductsPostWithHttpInfo(APIProductDTO body) Create a new API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiProductsApi

public ApiProductsApi()

ApiProductsApi

public ApiProductsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apiProductsApiProductIdDeleteCall

public com.squareup.okhttp.Call apiProductsApiProductIdDeleteCall(String apiProductId,
                                                                  String ifMatch,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for apiProductsApiProductIdDelete

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDelete

public void apiProductsApiProductIdDelete(String apiProductId,
                                          String ifMatch)
                                   throws ApiException

Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Throws:

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

apiProductsApiProductIdDeleteWithHttpInfo

public ApiResponse<Void> apiProductsApiProductIdDeleteWithHttpInfo(String apiProductId,
                                                                   String ifMatch)
                                                            throws ApiException

Delete an API Product This operation can be used to delete an existing API Product proving the Id of the API Product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdDeleteAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDeleteAsync(String apiProductId,
                                                                   String ifMatch,
                                                                   ApiCallback<Void> callback)
                                                            throws ApiException

Delete an API Product (asynchronously) This operation can be used to delete an existing API Product proving the Id of the API Product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

ifMatch - Validator for conditional requests; based on ETag. (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

apiProductsApiProductIdGetCall

public com.squareup.okhttp.Call apiProductsApiProductIdGetCall(String apiProductId,
                                                               String accept,
                                                               String ifNoneMatch,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for apiProductsApiProductIdGet

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdGet

public APIProductDTO apiProductsApiProductIdGet(String apiProductId,
                                                String accept,
                                                String ifNoneMatch)
                                         throws ApiException

Get details of an API Product Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

APIProductDTO

Throws:

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

apiProductsApiProductIdGetWithHttpInfo

public ApiResponse<APIProductDTO> apiProductsApiProductIdGetWithHttpInfo(String apiProductId,
                                                                         String accept,
                                                                         String ifNoneMatch)
                                                                  throws ApiException

Get details of an API Product Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<APIProductDTO>

Throws:

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

apiProductsApiProductIdGetAsync

public com.squareup.okhttp.Call apiProductsApiProductIdGetAsync(String apiProductId,
                                                                String accept,
                                                                String ifNoneMatch,
                                                                ApiCallback<APIProductDTO> callback)
                                                         throws ApiException

Get details of an API Product (asynchronously) Using this operation, you can retrieve complete details of a single API Product. You need to provide the Id of the API to retrive it.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apiProductsApiProductIdPutCall

public com.squareup.okhttp.Call apiProductsApiProductIdPutCall(String apiProductId,
                                                               APIProductDTO body,
                                                               String ifMatch,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for apiProductsApiProductIdPut

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

body - API object that needs to be added (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdPut

public APIProductDTO apiProductsApiProductIdPut(String apiProductId,
                                                APIProductDTO body,
                                                String ifMatch)
                                         throws ApiException

Update an API product This operation can be used to update an existing API product. But the properties `name`, `provider`

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

body - API object that needs to be added (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

APIProductDTO

Throws:

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

apiProductsApiProductIdPutWithHttpInfo

public ApiResponse<APIProductDTO> apiProductsApiProductIdPutWithHttpInfo(String apiProductId,
                                                                         APIProductDTO body,
                                                                         String ifMatch)
                                                                  throws ApiException

Update an API product This operation can be used to update an existing API product. But the properties `name`, `provider`

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

body - API object that needs to be added (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<APIProductDTO>

Throws:

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

apiProductsApiProductIdPutAsync

public com.squareup.okhttp.Call apiProductsApiProductIdPutAsync(String apiProductId,
                                                                APIProductDTO body,
                                                                String ifMatch,
                                                                ApiCallback<APIProductDTO> callback)
                                                         throws ApiException

Update an API product (asynchronously) This operation can be used to update an existing API product. But the properties `name`, `provider`

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

body - API object that needs to be added (required)

ifMatch - Validator for conditional requests; based on ETag. (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

apiProductsApiProductIdSwaggerGetCall

public com.squareup.okhttp.Call apiProductsApiProductIdSwaggerGetCall(String apiProductId,
                                                                      String accept,
                                                                      String ifNoneMatch,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for apiProductsApiProductIdSwaggerGet

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdSwaggerGet

public void apiProductsApiProductIdSwaggerGet(String apiProductId,
                                              String accept,
                                              String ifNoneMatch)
                                       throws ApiException

Get swagger definition This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Throws:

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

apiProductsApiProductIdSwaggerGetWithHttpInfo

public ApiResponse<Void> apiProductsApiProductIdSwaggerGetWithHttpInfo(String apiProductId,
                                                                       String accept,
                                                                       String ifNoneMatch)
                                                                throws ApiException

Get swagger definition This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdSwaggerGetAsync

public com.squareup.okhttp.Call apiProductsApiProductIdSwaggerGetAsync(String apiProductId,
                                                                       String accept,
                                                                       String ifNoneMatch,
                                                                       ApiCallback<Void> callback)
                                                                throws ApiException

Get swagger definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apiProductsApiProductIdSwaggerPutCall

public com.squareup.okhttp.Call apiProductsApiProductIdSwaggerPutCall(String apiProductId,
                                                                      String apiDefinition,
                                                                      String ifMatch,
                                                                      ProgressResponseBody.ProgressListener progressListener,
                                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                               throws ApiException

Build call for apiProductsApiProductIdSwaggerPut

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

apiDefinition - Swagger definition of the API product (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdSwaggerPut

public void apiProductsApiProductIdSwaggerPut(String apiProductId,
                                              String apiDefinition,
                                              String ifMatch)
                                       throws ApiException

upload swagger definition This operation can be used to create/update the swagger definition of an existing API Product. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

apiDefinition - Swagger definition of the API product (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Throws:

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

apiProductsApiProductIdSwaggerPutWithHttpInfo

public ApiResponse<Void> apiProductsApiProductIdSwaggerPutWithHttpInfo(String apiProductId,
                                                                       String apiDefinition,
                                                                       String ifMatch)
                                                                throws ApiException

upload swagger definition This operation can be used to create/update the swagger definition of an existing API Product. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

apiDefinition - Swagger definition of the API product (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdSwaggerPutAsync

public com.squareup.okhttp.Call apiProductsApiProductIdSwaggerPutAsync(String apiProductId,
                                                                       String apiDefinition,
                                                                       String ifMatch,
                                                                       ApiCallback<Void> callback)
                                                                throws ApiException

upload swagger definition (asynchronously) This operation can be used to create/update the swagger definition of an existing API Product. Swagger definition to be updated is passed as a form data parameter `apiDefinition`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

apiDefinition - Swagger definition of the API product (required)

ifMatch - Validator for conditional requests; based on ETag. (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

apiProductsApiProductIdThumbnailGetCall

public com.squareup.okhttp.Call apiProductsApiProductIdThumbnailGetCall(String apiProductId,
                                                                        String accept,
                                                                        String ifNoneMatch,
                                                                        ProgressResponseBody.ProgressListener progressListener,
                                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                 throws ApiException

Build call for apiProductsApiProductIdThumbnailGet

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdThumbnailGet

public void apiProductsApiProductIdThumbnailGet(String apiProductId,
                                                String accept,
                                                String ifNoneMatch)
                                         throws ApiException

Get thumbnail image This operation can be used to download a thumbnail image of an API product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Throws:

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

apiProductsApiProductIdThumbnailGetWithHttpInfo

public ApiResponse<Void> apiProductsApiProductIdThumbnailGetWithHttpInfo(String apiProductId,
                                                                         String accept,
                                                                         String ifNoneMatch)
                                                                  throws ApiException

Get thumbnail image This operation can be used to download a thumbnail image of an API product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdThumbnailGetAsync

public com.squareup.okhttp.Call apiProductsApiProductIdThumbnailGetAsync(String apiProductId,
                                                                         String accept,
                                                                         String ifNoneMatch,
                                                                         ApiCallback<Void> callback)
                                                                  throws ApiException

Get thumbnail image (asynchronously) This operation can be used to download a thumbnail image of an API product.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apiProductsApiProductIdThumbnailPutCall

public com.squareup.okhttp.Call apiProductsApiProductIdThumbnailPutCall(String apiProductId,
                                                                        File file,
                                                                        String ifMatch,
                                                                        ProgressResponseBody.ProgressListener progressListener,
                                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                 throws ApiException

Build call for apiProductsApiProductIdThumbnailPut

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

file - Image to upload (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdThumbnailPut

public FileInfoDTO apiProductsApiProductIdThumbnailPut(String apiProductId,
                                                       File file,
                                                       String ifMatch)
                                                throws ApiException

Upload a thumbnail image This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

file - Image to upload (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

FileInfoDTO

Throws:

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

apiProductsApiProductIdThumbnailPutWithHttpInfo

public ApiResponse<FileInfoDTO> apiProductsApiProductIdThumbnailPutWithHttpInfo(String apiProductId,
                                                                                File file,
                                                                                String ifMatch)
                                                                         throws ApiException

Upload a thumbnail image This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

file - Image to upload (required)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<FileInfoDTO>

Throws:

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

apiProductsApiProductIdThumbnailPutAsync

public com.squareup.okhttp.Call apiProductsApiProductIdThumbnailPutAsync(String apiProductId,
                                                                         File file,
                                                                         String ifMatch,
                                                                         ApiCallback<FileInfoDTO> callback)
                                                                  throws ApiException

Upload a thumbnail image (asynchronously) This operation can be used to upload a thumbnail image of an API Product. The thumbnail to be uploaded should be given as a form data parameter `file`.

Parameters:

apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)

file - Image to upload (required)

ifMatch - Validator for conditional requests; based on ETag. (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

apiProductsGetCall

public com.squareup.okhttp.Call apiProductsGetCall(Integer limit,
                                                   Integer offset,
                                                   String query,
                                                   String accept,
                                                   String ifNoneMatch,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for apiProductsGet

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsGet

public APIProductListDTO apiProductsGet(Integer limit,
                                        Integer offset,
                                        String query,
                                        String accept,
                                        String ifNoneMatch)
                                 throws ApiException

Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

APIProductListDTO

Throws:

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

apiProductsGetWithHttpInfo

public ApiResponse<APIProductListDTO> apiProductsGetWithHttpInfo(Integer limit,
                                                                 Integer offset,
                                                                 String query,
                                                                 String accept,
                                                                 String ifNoneMatch)
                                                          throws ApiException

Retrieve/Search API Products This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<APIProductListDTO>

Throws:

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

apiProductsGetAsync

public com.squareup.okhttp.Call apiProductsGetAsync(Integer limit,
                                                    Integer offset,
                                                    String query,
                                                    String accept,
                                                    String ifNoneMatch,
                                                    ApiCallback<APIProductListDTO> callback)
                                             throws ApiException

Retrieve/Search API Products (asynchronously) This operation provides you a list of available API Products qualifying under a given search condition. Each retrieved API Product is represented with a minimal amount of attributes. If you want to get complete details of an API Product, you need to use **Get details of an API Product** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - (optional)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

apiProductsPostCall

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

Build call for apiProductsPost

Parameters:

body - API object that needs to be added (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsPost

public APIProductDTO apiProductsPost(APIProductDTO body)
                              throws ApiException

Create a new API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.

Parameters:

body - API object that needs to be added (required)

Returns:

APIProductDTO

Throws:

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

apiProductsPostWithHttpInfo

public ApiResponse<APIProductDTO> apiProductsPostWithHttpInfo(APIProductDTO body)
                                                       throws ApiException

Create a new API Product This operation can be used to create a new API Product specifying the details of the API Product in the payload.

Parameters:

body - API object that needs to be added (required)

Returns:

ApiResponse<APIProductDTO>

Throws:

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

apiProductsPostAsync

public com.squareup.okhttp.Call apiProductsPostAsync(APIProductDTO body,
                                                     ApiCallback<APIProductDTO> callback)
                                              throws ApiException

Create a new API Product (asynchronously) This operation can be used to create a new API Product specifying the details of the API Product in the payload.

Parameters:

body - API object that needs to be added (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