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

Class DocumentIndividualApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.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 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 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 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	apisApiIdDocumentsDocumentIdContentPost(String apiId, String documentId, String contentType, File file, String inlineContent, String ifMatch, String ifUnmodifiedSince) Upload the content of an API document Thid operation can be used to upload a file or add inline content to an API document.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdContentPostAsync(String apiId, String documentId, String contentType, File file, String inlineContent, String ifMatch, String ifUnmodifiedSince, ApiCallback<Document> callback) Upload the content of an API document (asynchronously) Thid operation can be used to upload a file or add inline content to an API document.
ApiResponse<Document>	apisApiIdDocumentsDocumentIdContentPostWithHttpInfo(String apiId, String documentId, String contentType, File file, String inlineContent, String ifMatch, String ifUnmodifiedSince) Upload the content of an API document Thid operation can be used to upload a file or add inline content to an API document.
void	apisApiIdDocumentsDocumentIdDelete(String apiId, String documentId, String ifMatch, String ifUnmodifiedSince) Delete a document of an API This operation can be used to delete a document associated with an API.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdDeleteAsync(String apiId, String documentId, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Delete a document of an API (asynchronously) This operation can be used to delete a document associated with an API.
ApiResponse<Void>	apisApiIdDocumentsDocumentIdDeleteWithHttpInfo(String apiId, String documentId, String ifMatch, String ifUnmodifiedSince) Delete a document of an API This operation can be used to delete a document associated with an API.
Document	apisApiIdDocumentsDocumentIdGet(String apiId, String documentId, 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 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 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.
Document	apisApiIdDocumentsDocumentIdPut(String apiId, String documentId, Document body, String contentType, String ifMatch, String ifUnmodifiedSince) Update a document of an API This operation can be used to update metadata of an API's document.
com.squareup.okhttp.Call	apisApiIdDocumentsDocumentIdPutAsync(String apiId, String documentId, Document body, String contentType, String ifMatch, String ifUnmodifiedSince, ApiCallback<Document> callback) Update a document of an API (asynchronously) This operation can be used to update metadata of an API's document.
ApiResponse<Document>	apisApiIdDocumentsDocumentIdPutWithHttpInfo(String apiId, String documentId, Document body, String contentType, String ifMatch, String ifUnmodifiedSince) Update a document of an API This operation can be used to update metadata of an API's document.
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 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`

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)

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

apisApiIdDocumentsDocumentIdContentGetWithHttpInfo

public ApiResponse<Void> apisApiIdDocumentsDocumentIdContentGetWithHttpInfo(String apiId,
                                                                            String documentId,
                                                                            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`

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)

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

apisApiIdDocumentsDocumentIdContentGetAsync

public com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdContentGetAsync(String apiId,
                                                                            String documentId,
                                                                            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`

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)

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

apisApiIdDocumentsDocumentIdContentPost

public Document apisApiIdDocumentsDocumentIdContentPost(String apiId,
                                                        String documentId,
                                                        String contentType,
                                                        File file,
                                                        String inlineContent,
                                                        String ifMatch,
                                                        String ifUnmodifiedSince)
                                                 throws ApiException

Upload the content of an API document Thid operation can be used to upload a file or add inline content to an API document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.

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)

documentId - Document Identifier (required)

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

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

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

Returns:

Document

Throws:

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

apisApiIdDocumentsDocumentIdContentPostWithHttpInfo

public ApiResponse<Document> apisApiIdDocumentsDocumentIdContentPostWithHttpInfo(String apiId,
                                                                                 String documentId,
                                                                                 String contentType,
                                                                                 File file,
                                                                                 String inlineContent,
                                                                                 String ifMatch,
                                                                                 String ifUnmodifiedSince)
                                                                          throws ApiException

Upload the content of an API document Thid operation can be used to upload a file or add inline content to an API document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.

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)

documentId - Document Identifier (required)

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

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

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

Returns:

ApiResponse<Document>

Throws:

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

apisApiIdDocumentsDocumentIdContentPostAsync

public com.squareup.okhttp.Call apisApiIdDocumentsDocumentIdContentPostAsync(String apiId,
                                                                             String documentId,
                                                                             String contentType,
                                                                             File file,
                                                                             String inlineContent,
                                                                             String ifMatch,
                                                                             String ifUnmodifiedSince,
                                                                             ApiCallback<Document> callback)
                                                                      throws ApiException

Upload the content of an API document (asynchronously) Thid operation can be used to upload a file or add inline content to an API document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.

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)

documentId - Document Identifier (required)

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

file - Document to upload (optional)

inlineContent - Inline content of the document (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

apisApiIdDocumentsDocumentIdDelete

public void apisApiIdDocumentsDocumentIdDelete(String apiId,
                                               String documentId,
                                               String ifMatch,
                                               String ifUnmodifiedSince)
                                        throws ApiException

Delete a document of an API This operation can be used to delete a document associated with 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)

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

apisApiIdDocumentsDocumentIdDeleteWithHttpInfo

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

Delete a document of an API This operation can be used to delete a document associated with 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)

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

apisApiIdDocumentsDocumentIdDeleteAsync

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

Delete a document of an API (asynchronously) This operation can be used to delete a document associated with 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)

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

apisApiIdDocumentsDocumentIdGet

public Document apisApiIdDocumentsDocumentIdGet(String apiId,
                                                String documentId,
                                                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.

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)

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

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 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.

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)

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

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)

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

apisApiIdDocumentsDocumentIdPut

public Document apisApiIdDocumentsDocumentIdPut(String apiId,
                                                String documentId,
                                                Document body,
                                                String contentType,
                                                String ifMatch,
                                                String ifUnmodifiedSince)
                                         throws ApiException

Update a document of an API This operation can be used to update metadata of an API's document.

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)

documentId - Document Identifier (required)

body - Document 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:

Document

Throws:

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

apisApiIdDocumentsDocumentIdPutWithHttpInfo

public ApiResponse<Document> apisApiIdDocumentsDocumentIdPutWithHttpInfo(String apiId,
                                                                         String documentId,
                                                                         Document body,
                                                                         String contentType,
                                                                         String ifMatch,
                                                                         String ifUnmodifiedSince)
                                                                  throws ApiException

Update a document of an API This operation can be used to update metadata of an API's document.

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)

documentId - Document Identifier (required)

body - Document 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<Document>

Throws:

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

apisApiIdDocumentsDocumentIdPutAsync

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

Update a document of an API (asynchronously) This operation can be used to update metadata of an API's document.

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)

documentId - Document Identifier (required)

body - Document 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