org.wso2.carbon.apimgt.samples.utils.store.rest.client.api

Class APIIndividualApi

java.lang.Object

org.wso2.carbon.apimgt.samples.utils.store.rest.client.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
API	apisApiIdGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, String xWSO2Tenant) 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, String xWSO2Tenant, 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, String xWSO2Tenant) Get details of an API Using this operation, you can retrieve complete details of a single API.
void	apisApiIdSwaggerGet(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, String xWSO2Tenant) Get swagger definition You can use this operation to retrieve the swagger definition of an API.
com.squareup.okhttp.Call	apisApiIdSwaggerGetAsync(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, String xWSO2Tenant, ApiCallback<Void> callback) Get swagger definition (asynchronously) You can use this operation to retrieve the swagger definition of an API.
ApiResponse<Void>	apisApiIdSwaggerGetWithHttpInfo(String apiId, String accept, String ifNoneMatch, String ifModifiedSince, String xWSO2Tenant) Get swagger definition You can use this operation to retrieve the swagger definition of an API.
void	apisApiIdThumbnailGet(String apiId, String xWSO2Tenant, 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 xWSO2Tenant, 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 xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) Get thumbnail image This operation can be used to download a thumbnail image of an API.
void	apisGenerateSdkPost(String apiId, String language, String xWSO2Tenant) Generate SDK for an API This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language.
com.squareup.okhttp.Call	apisGenerateSdkPostAsync(String apiId, String language, String xWSO2Tenant, ApiCallback<Void> callback) Generate SDK for an API (asynchronously) This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language.
ApiResponse<Void>	apisGenerateSdkPostWithHttpInfo(String apiId, String language, String xWSO2Tenant) Generate SDK for an API This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language.
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)

apisApiIdGet

public API apisApiIdGet(String apiId,
                        String accept,
                        String ifNoneMatch,
                        String ifModifiedSince,
                        String xWSO2Tenant)
                 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. `X-WSO2-Tenant` header can be used to retrive an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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,
                                                 String xWSO2Tenant)
                                          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. `X-WSO2-Tenant` header can be used to retrive an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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,
                                                  String xWSO2Tenant,
                                                  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. `X-WSO2-Tenant` header can be used to retrive an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But if it is provided, it will be validated and checked for permissions of the user, hence you may be able to see APIs which are restricted for special permissions/roles. \\n

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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,
                                String xWSO2Tenant)
                         throws ApiException

Get swagger definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrive the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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,
                                                         String xWSO2Tenant)
                                                  throws ApiException

Get swagger definition You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrive the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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,
                                                         String xWSO2Tenant,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Get swagger definition (asynchronously) You can use this operation to retrieve the swagger definition of an API. `X-WSO2-Tenant` header can be used to retrive the swagger definition an API of a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's swagger definition, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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 resource. (optional)

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

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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 xWSO2Tenant,
                                  String accept,
                                  String ifNoneMatch,
                                  String ifModifiedSince)
                           throws ApiException

Get thumbnail image This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (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 xWSO2Tenant,
                                                           String accept,
                                                           String ifNoneMatch,
                                                           String ifModifiedSince)
                                                    throws ApiException

Get thumbnail image This operation can be used to download a thumbnail image of an API. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (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 xWSO2Tenant,
                                                           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. `X-WSO2-Tenant` header can be used to retrive a thumbnail of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to see a restricted API's thumbnail, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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)

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource (Will be supported in future). (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

apisGenerateSdkPost

public void apisGenerateSdkPost(String apiId,
                                String language,
                                String xWSO2Tenant)
                         throws ApiException

Generate SDK for an API This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language. `X-WSO2-Tenant` header can be used to retrive the generated SDK of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to generate a restricted API's SDK, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

language - Programming language to generate SDK. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

Throws:

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

apisGenerateSdkPostWithHttpInfo

public ApiResponse<Void> apisGenerateSdkPostWithHttpInfo(String apiId,
                                                         String language,
                                                         String xWSO2Tenant)
                                                  throws ApiException

Generate SDK for an API This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language. `X-WSO2-Tenant` header can be used to retrive the generated SDK of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to generate a restricted API's SDK, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

language - Programming language to generate SDK. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisGenerateSdkPostAsync

public com.squareup.okhttp.Call apisGenerateSdkPostAsync(String apiId,
                                                         String language,
                                                         String xWSO2Tenant,
                                                         ApiCallback<Void> callback)
                                                  throws ApiException

Generate SDK for an API (asynchronously) This operation can be used to generate SDK for an API by providing the id of the API along with the preferred language. `X-WSO2-Tenant` header can be used to retrive the generated SDK of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used. **NOTE:** * This operation does not require an Authorization header by default. But in order to generate a restricted API's SDK, you need to provide Authorization header.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. Using the **UUID** in the API call is recommended. 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)

language - Programming language to generate SDK. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (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