org.wso2.carbon.apimgt.rest.integration.tests.api

Class APIIndividualApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.api.APIIndividualApi

public class APIIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
APIIndividualApi()
APIIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	apisApiIdDelete(String apiId, String ifMatch, String ifUnmodifiedSince) Delete an API This operation can be used to delete an existing API proving the Id of the API.
com.squareup.okhttp.Call	apisApiIdDeleteAsync(String apiId, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Delete an API (asynchronously) This operation can be used to delete an existing API proving the Id of the API.
ApiResponse<Void>	apisApiIdDeleteWithHttpInfo(String apiId, String ifMatch, String ifUnmodifiedSince) Delete an API This operation can be used to delete an existing API proving the Id of the API.
void	apisApiIdGatewayConfigGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get gateway definition This operation can be used to retrieve the gateway configuration of an API.
com.squareup.okhttp.Call	apisApiIdGatewayConfigGetAsync(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Void> callback) Get gateway definition (asynchronously) This operation can be used to retrieve the gateway configuration of an API.
ApiResponse<Void>	apisApiIdGatewayConfigGetWithHttpInfo(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get gateway definition This operation can be used to retrieve the gateway configuration of an API.
void	apisApiIdGatewayConfigPut(String apiId, String gatewayConfig, String contentType, String ifMatch, String ifUnmodifiedSince) Update gateway configuration This operation can be used to update the gateway configuration of an existing API.
com.squareup.okhttp.Call	apisApiIdGatewayConfigPutAsync(String apiId, String gatewayConfig, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Update gateway configuration (asynchronously) This operation can be used to update the gateway configuration of an existing API.
ApiResponse<Void>	apisApiIdGatewayConfigPutWithHttpInfo(String apiId, String gatewayConfig, String contentType, String ifMatch, String ifUnmodifiedSince) Update gateway configuration This operation can be used to update the gateway configuration of an existing API.
API	apisApiIdGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get details of an API Using this operation, you can retrieve complete details of a single API.
com.squareup.okhttp.Call	apisApiIdGetAsync(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<API> callback) Get details of an API (asynchronously) Using this operation, you can retrieve complete details of a single API.
ApiResponse<API>	apisApiIdGetWithHttpInfo(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get details of an API Using this operation, you can retrieve complete details of a single API.
API	apisApiIdPut(String apiId, API body, String contentType, String ifMatch, String ifUnmodifiedSince) Update an API This operation can be used to update an existing API.
com.squareup.okhttp.Call	apisApiIdPutAsync(String apiId, API body, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<API> callback) Update an API (asynchronously) This operation can be used to update an existing API.
ApiResponse<API>	apisApiIdPutWithHttpInfo(String apiId, API body, String contentType, String ifMatch, String ifUnmodifiedSince) Update an API This operation can be used to update an existing API.
void	apisApiIdSwaggerGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get swagger definition This operation can be used to retrieve the swagger definition of an API.
com.squareup.okhttp.Call	apisApiIdSwaggerGetAsync(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Void> callback) Get swagger definition (asynchronously) This operation can be used to retrieve the swagger definition of an API.
ApiResponse<Void>	apisApiIdSwaggerGetWithHttpInfo(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get swagger definition This operation can be used to retrieve the swagger definition of an API.
void	apisApiIdSwaggerPut(String apiId, String apiDefinition, String contentType, String ifMatch, String ifUnmodifiedSince) Update swagger definition This operation can be used to update the swagger definition of an existing API.
com.squareup.okhttp.Call	apisApiIdSwaggerPutAsync(String apiId, String apiDefinition, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Update swagger definition (asynchronously) This operation can be used to update the swagger definition of an existing API.
ApiResponse<Void>	apisApiIdSwaggerPutWithHttpInfo(String apiId, String apiDefinition, String contentType, String ifMatch, String ifUnmodifiedSince) Update swagger definition This operation can be used to update the swagger definition of an existing API.
void	apisApiIdThumbnailGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get thumbnail image This operation can be used to download a thumbnail image of an API.
com.squareup.okhttp.Call	apisApiIdThumbnailGetAsync(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Void> callback) Get thumbnail image (asynchronously) This operation can be used to download a thumbnail image of an API.
ApiResponse<Void>	apisApiIdThumbnailGetWithHttpInfo(String apiId, String accept, String ifNoneMatch, String ifModifiedSince) Get thumbnail image This operation can be used to download a thumbnail image of an API.
FileInfo	apisApiIdThumbnailPost(String apiId, File file, String contentType, String ifMatch, String ifUnmodifiedSince) Upload a thumbnail image This operation can be used to upload a thumbnail image of an API.
com.squareup.okhttp.Call	apisApiIdThumbnailPostAsync(String apiId, File file, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<FileInfo> callback) Upload a thumbnail image (asynchronously) This operation can be used to upload a thumbnail image of an API.
ApiResponse<FileInfo>	apisApiIdThumbnailPostWithHttpInfo(String apiId, File file, String contentType, String ifMatch, String ifUnmodifiedSince) Upload a thumbnail image This operation can be used to upload a thumbnail image of an API.
void	apisChangeLifecyclePost(String action, String apiId, String lifecycleChecklist, String ifMatch, String ifUnmodifiedSince) Change API Status This operation is used to change the lifecycle of an API.
com.squareup.okhttp.Call	apisChangeLifecyclePostAsync(String action, String apiId, String lifecycleChecklist, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Change API Status (asynchronously) This operation is used to change the lifecycle of an API.
ApiResponse<Void>	apisChangeLifecyclePostWithHttpInfo(String action, String apiId, String lifecycleChecklist, String ifMatch, String ifUnmodifiedSince) Change API Status This operation is used to change the lifecycle of an API.
void	apisCopyApiPost(String newVersion, String apiId) Create a new API version This operation can be used to create a new version of an existing API.
com.squareup.okhttp.Call	apisCopyApiPostAsync(String newVersion, String apiId, ApiCallback<Void> callback) Create a new API version (asynchronously) This operation can be used to create a new version of an existing API.
ApiResponse<Void>	apisCopyApiPostWithHttpInfo(String newVersion, String apiId) Create a new API version This operation can be used to create a new version of an existing API.
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

APIIndividualApi

public APIIndividualApi()

APIIndividualApi

public APIIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdDelete

public void apisApiIdDelete(String apiId,
                            String ifMatch,
                            String ifUnmodifiedSince)
                     throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Throws:

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

apisApiIdDeleteWithHttpInfo

public ApiResponse<Void> apisApiIdDeleteWithHttpInfo(String apiId,
                                                     String ifMatch,
                                                     String ifUnmodifiedSince)
                                              throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdDeleteAsync

public com.squareup.okhttp.Call apisApiIdDeleteAsync(String apiId,
                                                     String ifMatch,
                                                     String ifUnmodifiedSince,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisApiIdGatewayConfigGet

public void apisApiIdGatewayConfigGet(String apiId,
                                      String accept,
                                      String ifNoneMatch,
                                      String ifModifiedSince)
                               throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdGatewayConfigGetWithHttpInfo

public ApiResponse<Void> apisApiIdGatewayConfigGetWithHttpInfo(String apiId,
                                                               String accept,
                                                               String ifNoneMatch,
                                                               String ifModifiedSince)
                                                        throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdGatewayConfigGetAsync

public com.squareup.okhttp.Call apisApiIdGatewayConfigGetAsync(String apiId,
                                                               String accept,
                                                               String ifNoneMatch,
                                                               String ifModifiedSince,
                                                               ApiCallback<Void> callback)
                                                        throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdGatewayConfigPut

public void apisApiIdGatewayConfigPut(String apiId,
                                      String gatewayConfig,
                                      String contentType,
                                      String ifMatch,
                                      String ifUnmodifiedSince)
                               throws ApiException

Update gateway configuration This operation can be used to update the gateway configuration of an existing API. gateway configuration to be updated is passed as a form data parameter `gatewayConfig`.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

gatewayConfig - gateway configuration of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Throws:

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

apisApiIdGatewayConfigPutWithHttpInfo

public ApiResponse<Void> apisApiIdGatewayConfigPutWithHttpInfo(String apiId,
                                                               String gatewayConfig,
                                                               String contentType,
                                                               String ifMatch,
                                                               String ifUnmodifiedSince)
                                                        throws ApiException

Update gateway configuration This operation can be used to update the gateway configuration of an existing API. gateway configuration to be updated is passed as a form data parameter `gatewayConfig`.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

gatewayConfig - gateway configuration of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdGatewayConfigPutAsync

public com.squareup.okhttp.Call apisApiIdGatewayConfigPutAsync(String apiId,
                                                               String gatewayConfig,
                                                               String contentType,
                                                               String ifMatch,
                                                               String ifUnmodifiedSince,
                                                               ApiCallback<Void> callback)
                                                        throws ApiException

Update gateway configuration (asynchronously) This operation can be used to update the gateway configuration of an existing API. gateway configuration to be updated is passed as a form data parameter `gatewayConfig`.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

gatewayConfig - gateway configuration of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisApiIdGet

public API apisApiIdGet(String apiId,
                        String accept,
                        String ifNoneMatch,
                        String ifModifiedSince)
                 throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

API

Throws:

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

apisApiIdGetWithHttpInfo

public ApiResponse<API> apisApiIdGetWithHttpInfo(String apiId,
                                                 String accept,
                                                 String ifNoneMatch,
                                                 String ifModifiedSince)
                                          throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<API>

Throws:

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

apisApiIdGetAsync

public com.squareup.okhttp.Call apisApiIdGetAsync(String apiId,
                                                  String accept,
                                                  String ifNoneMatch,
                                                  String ifModifiedSince,
                                                  ApiCallback<API> callback)
                                           throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdPut

public API apisApiIdPut(String apiId,
                        API body,
                        String contentType,
                        String ifMatch,
                        String ifUnmodifiedSince)
                 throws ApiException

Update an API This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

API

Throws:

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

apisApiIdPutWithHttpInfo

public ApiResponse<API> apisApiIdPutWithHttpInfo(String apiId,
                                                 API body,
                                                 String contentType,
                                                 String ifMatch,
                                                 String ifUnmodifiedSince)
                                          throws ApiException

Update an API This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<API>

Throws:

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

apisApiIdPutAsync

public com.squareup.okhttp.Call apisApiIdPutAsync(String apiId,
                                                  API body,
                                                  String contentType,
                                                  String ifMatch,
                                                  String ifUnmodifiedSince,
                                                  ApiCallback<API> callback)
                                           throws ApiException

Update an API (asynchronously) This operation can be used to update an existing API. But the properties `name`, `version`, `context`, `provider`, `state` will not be changed by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisApiIdSwaggerGet

public void apisApiIdSwaggerGet(String apiId,
                                String accept,
                                String ifNoneMatch,
                                String ifModifiedSince)
                         throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdSwaggerGetWithHttpInfo

public ApiResponse<Void> apisApiIdSwaggerGetWithHttpInfo(String apiId,
                                                         String accept,
                                                         String ifNoneMatch,
                                                         String ifModifiedSince)
                                                  throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdSwaggerGetAsync

public com.squareup.okhttp.Call apisApiIdSwaggerGetAsync(String apiId,
                                                         String accept,
                                                         String ifNoneMatch,
                                                         String ifModifiedSince,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdSwaggerPut

public void apisApiIdSwaggerPut(String apiId,
                                String apiDefinition,
                                String contentType,
                                String ifMatch,
                                String ifUnmodifiedSince)
                         throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

apiDefinition - Swagger definition of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Throws:

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

apisApiIdSwaggerPutWithHttpInfo

public ApiResponse<Void> apisApiIdSwaggerPutWithHttpInfo(String apiId,
                                                         String apiDefinition,
                                                         String contentType,
                                                         String ifMatch,
                                                         String ifUnmodifiedSince)
                                                  throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

apiDefinition - Swagger definition of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdSwaggerPutAsync

public com.squareup.okhttp.Call apisApiIdSwaggerPutAsync(String apiId,
                                                         String apiDefinition,
                                                         String contentType,
                                                         String ifMatch,
                                                         String ifUnmodifiedSince,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

apiDefinition - Swagger definition of the API (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisApiIdThumbnailGet

public void apisApiIdThumbnailGet(String apiId,
                                  String accept,
                                  String ifNoneMatch,
                                  String ifModifiedSince)
                           throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdThumbnailGetWithHttpInfo

public ApiResponse<Void> apisApiIdThumbnailGetWithHttpInfo(String apiId,
                                                           String accept,
                                                           String ifNoneMatch,
                                                           String ifModifiedSince)
                                                    throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdThumbnailGetAsync

public com.squareup.okhttp.Call apisApiIdThumbnailGetAsync(String apiId,
                                                           String accept,
                                                           String ifNoneMatch,
                                                           String ifModifiedSince,
                                                           ApiCallback<Void> callback)
                                                    throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (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 resourec. (optional)

ifModifiedSince - Validator for conditional requests; based on Last Modified header 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

apisApiIdThumbnailPost

public FileInfo apisApiIdThumbnailPost(String apiId,
                                       File file,
                                       String contentType,
                                       String ifMatch,
                                       String ifUnmodifiedSince)
                                throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

file - Image to upload (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

FileInfo

Throws:

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

apisApiIdThumbnailPostWithHttpInfo

public ApiResponse<FileInfo> apisApiIdThumbnailPostWithHttpInfo(String apiId,
                                                                File file,
                                                                String contentType,
                                                                String ifMatch,
                                                                String ifUnmodifiedSince)
                                                         throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

file - Image to upload (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<FileInfo>

Throws:

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

apisApiIdThumbnailPostAsync

public com.squareup.okhttp.Call apisApiIdThumbnailPostAsync(String apiId,
                                                            File file,
                                                            String contentType,
                                                            String ifMatch,
                                                            String ifUnmodifiedSince,
                                                            ApiCallback<FileInfo> callback)
                                                     throws ApiException

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

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

file - Image to upload (required)

contentType - Media type of the entity in the body. Default is application/json. (required)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisChangeLifecyclePost

public void apisChangeLifecyclePost(String action,
                                    String apiId,
                                    String lifecycleChecklist,
                                    String ifMatch,
                                    String ifUnmodifiedSince)
                             throws ApiException

Change API Status This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. (optional)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Throws:

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

apisChangeLifecyclePostWithHttpInfo

public ApiResponse<Void> apisChangeLifecyclePostWithHttpInfo(String action,
                                                             String apiId,
                                                             String lifecycleChecklist,
                                                             String ifMatch,
                                                             String ifUnmodifiedSince)
                                                      throws ApiException

Change API Status This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. (optional)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisChangeLifecyclePostAsync

public com.squareup.okhttp.Call apisChangeLifecyclePostAsync(String action,
                                                             String apiId,
                                                             String lifecycleChecklist,
                                                             String ifMatch,
                                                             String ifUnmodifiedSince,
                                                             ApiCallback<Void> callback)
                                                      throws ApiException

Change API Status (asynchronously) This operation is used to change the lifecycle of an API. Eg: Publish an API which is in `CREATED` state. In order to change the lifecycle, we need to provide the lifecycle `action` as a query parameter. For example, to Publish an API, `action` should be `Publish`. Some actions supports providing additional paramters which should be provided as `lifecycleChecklist` parameter. Please see parameters table for more information.

Parameters:

action - The action to demote or promote the state of the API. Supported actions are [ **Publish, Deploy as a Prototype, Demote to Created, Demote to Prototyped, Block, Deprecate, Re-Publish, Retire **] (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

lifecycleChecklist - You can specify additional checklist items by using an **\"attribute:\"** modifier. Eg: \"Deprecate Old Versions:true\" will deprecate older versions of a particular API when it is promoted to Published state from Created state. Multiple checklist items can be given in \"attribute1:true, attribute2:false\" format. Supported checklist items are as follows. 1. **Deprecate Old Versions**: Setting this to true will deprecate older versions of a particular API when it is promoted to Published state from Created state. 2. **Require Re-Subscription**: If you set this to true, users need to re subscribe to the API although they may have subscribed to an older version. (optional)

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

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

apisCopyApiPost

public void apisCopyApiPost(String newVersion,
                            String apiId)
                     throws ApiException

Create a new API version This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.

Parameters:

newVersion - Version of the new API. (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

Throws:

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

apisCopyApiPostWithHttpInfo

public ApiResponse<Void> apisCopyApiPostWithHttpInfo(String newVersion,
                                                     String apiId)
                                              throws ApiException

Create a new API version This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.

Parameters:

newVersion - Version of the new API. (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (required)

Returns:

ApiResponse<Void>

Throws:

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

apisCopyApiPostAsync

public com.squareup.okhttp.Call apisCopyApiPostAsync(String newVersion,
                                                     String apiId,
                                                     ApiCallback<Void> callback)
                                              throws ApiException

Create a new API version (asynchronously) This operation can be used to create a new version of an existing API. The new version is specified as `newVersion` query parameter. New API will be in `CREATED` state.

Parameters:

newVersion - Version of the new API. (required)

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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