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

Class DocumentIndividualApi

java.lang.Object

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

public class DocumentIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentIndividualApi()
DocumentIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	apisApiIdDocumentsDocumentIdContentGet(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) Get the content of an API document This operation can be used to retrive the content of an API's document.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdContentGetAsync(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Void> callback) Get the content of an API document (asynchronously) This operation can be used to retrive the content of an API's document.
ApiResponse<Void>	apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) Get the content of an API document This operation can be used to retrive the content of an API's document.
Document	apisApiIdDocumentsDocumentIdGet(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdGetAsync(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Document> callback) Get a document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API.
ApiResponse<Document>	apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId, String documentId, String xWSO2Tenant, String accept, String ifNoneMatch, String ifModifiedSince) Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an 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

DocumentIndividualApi

public DocumentIndividualApi()

DocumentIndividualApi

public DocumentIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdDocumentsDocumentIdContentGet

public void apisApiIdDocumentsDocumentIdContentGet(String apiId,
                                                   String documentId,
                                                   String xWSO2Tenant,
                                                   String accept,
                                                   String ifNoneMatch,
                                                   String ifModifiedSince)
                                            throws ApiException

Get the content of an API document This operation can be used to retrive the content of an API's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other` `X-WSO2-Tenant` header can be used to retrive the content of a document 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 document content, 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)

documentId - Document Identifier (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

apisApiIdDocumentsDocumentIdContentGetWithHttpInfo

public ApiResponse<Void> apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId,
                                                                            String documentId,
                                                                            String xWSO2Tenant,
                                                                            String accept,
                                                                            String ifNoneMatch,
                                                                            String ifModifiedSince)
                                                                     throws ApiException

Get the content of an API document This operation can be used to retrive the content of an API's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other` `X-WSO2-Tenant` header can be used to retrive the content of a document 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 document content, 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)

documentId - Document Identifier (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

apisApiIdDocumentsDocumentIdContentGetAsync

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

Get the content of an API document (asynchronously) This operation can be used to retrive the content of an API's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other` `X-WSO2-Tenant` header can be used to retrive the content of a document 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 document content, 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)

documentId - Document Identifier (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

apisApiIdDocumentsDocumentIdGet

public Document apisApiIdDocumentsDocumentIdGet(String apiId,
                                                String documentId,
                                                String xWSO2Tenant,
                                                String accept,
                                                String ifNoneMatch,
                                                String ifModifiedSince)
                                         throws ApiException

Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document 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 document, 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)

documentId - Document Identifier (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:

Document

Throws:

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

apisApiIdDocumentsDocumentIdGetWithHttpInfo

public ApiResponse<Document> apisApiIdDocumentsDocumentIdGetWithHttpInfo(String apiId,
                                                                         String documentId,
                                                                         String xWSO2Tenant,
                                                                         String accept,
                                                                         String ifNoneMatch,
                                                                         String ifModifiedSince)
                                                                  throws ApiException

Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document 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 document, 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)

documentId - Document Identifier (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<Document>

Throws:

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

apisApiIdDocumentsDocumentIdGetAsync

public com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdGetAsync(String apiId,
                                                                     String documentId,
                                                                     String xWSO2Tenant,
                                                                     String accept,
                                                                     String ifNoneMatch,
                                                                     String ifModifiedSince,
                                                                     ApiCallback<Document> callback)
                                                              throws ApiException

Get a document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API. `X-WSO2-Tenant` header can be used to retrive a document 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 document, 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)

documentId - Document Identifier (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