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

Class ApiProductDocumentsApi

java.lang.Object

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

public class ApiProductDocumentsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApiProductDocumentsApi()
ApiProductDocumentsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	apiProductsApiProductIdDocumentsDocumentIdContentGet(String apiProductId, String documentId, String accept, String ifNoneMatch) Get the content of an API Product document This operation can be used to retrive the content of an API's document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdContentGetAsync(String apiProductId, String documentId, String accept, String ifNoneMatch, ApiCallback<Void> callback) Get the content of an API Product document (asynchronously) This operation can be used to retrive the content of an API's document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdContentGetCall(String apiProductId, String documentId, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsDocumentIdContentGet
ApiResponse<Void>	apiProductsApiProductIdDocumentsDocumentIdContentGetWithHttpInfo(String apiProductId, String documentId, String accept, String ifNoneMatch) Get the content of an API Product document This operation can be used to retrive the content of an API's document.
DocumentDTO	apiProductsApiProductIdDocumentsDocumentIdContentPost(String apiProductId, String documentId, File file, String inlineContent, String ifMatch) Upload the content of an API Product document Thid operation can be used to upload a file or add inline content to an API Product document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdContentPostAsync(String apiProductId, String documentId, File file, String inlineContent, String ifMatch, ApiCallback<DocumentDTO> callback) Upload the content of an API Product document (asynchronously) Thid operation can be used to upload a file or add inline content to an API Product document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdContentPostCall(String apiProductId, String documentId, File file, String inlineContent, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsDocumentIdContentPost
ApiResponse<DocumentDTO>	apiProductsApiProductIdDocumentsDocumentIdContentPostWithHttpInfo(String apiProductId, String documentId, File file, String inlineContent, String ifMatch) Upload the content of an API Product document Thid operation can be used to upload a file or add inline content to an API Product document.
void	apiProductsApiProductIdDocumentsDocumentIdDelete(String apiProductId, String documentId, String ifMatch) Delete a document of an API Product This operation can be used to delete a document associated with an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdDeleteAsync(String apiProductId, String documentId, String ifMatch, ApiCallback<Void> callback) Delete a document of an API Product (asynchronously) This operation can be used to delete a document associated with an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdDeleteCall(String apiProductId, String documentId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsDocumentIdDelete
ApiResponse<Void>	apiProductsApiProductIdDocumentsDocumentIdDeleteWithHttpInfo(String apiProductId, String documentId, String ifMatch) Delete a document of an API Product This operation can be used to delete a document associated with an API Product.
DocumentDTO	apiProductsApiProductIdDocumentsDocumentIdGet(String apiProductId, String documentId, String accept, String ifNoneMatch) 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	apiProductsApiProductIdDocumentsDocumentIdGetAsync(String apiProductId, String documentId, String accept, String ifNoneMatch, ApiCallback<DocumentDTO> callback) Get a document of an API (asynchronously) This operation can be used to retrieve a particular document's metadata associated with an API.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdGetCall(String apiProductId, String documentId, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsDocumentIdGet
ApiResponse<DocumentDTO>	apiProductsApiProductIdDocumentsDocumentIdGetWithHttpInfo(String apiProductId, String documentId, String accept, String ifNoneMatch) Get a document of an API This operation can be used to retrieve a particular document's metadata associated with an API.
DocumentDTO	apiProductsApiProductIdDocumentsDocumentIdPut(String apiProductId, String documentId, DocumentDTO body, String ifMatch) Update a document of an API Product This operation can be used to update metadata of an API's document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdPutAsync(String apiProductId, String documentId, DocumentDTO body, String ifMatch, ApiCallback<DocumentDTO> callback) Update a document of an API Product (asynchronously) This operation can be used to update metadata of an API's document.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsDocumentIdPutCall(String apiProductId, String documentId, DocumentDTO body, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsDocumentIdPut
ApiResponse<DocumentDTO>	apiProductsApiProductIdDocumentsDocumentIdPutWithHttpInfo(String apiProductId, String documentId, DocumentDTO body, String ifMatch) Update a document of an API Product This operation can be used to update metadata of an API's document.
DocumentListDTO	apiProductsApiProductIdDocumentsGet(String apiProductId, Integer limit, Integer offset, String accept, String ifNoneMatch) Get a list of documents of an API Product This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsGetAsync(String apiProductId, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<DocumentListDTO> callback) Get a list of documents of an API Product (asynchronously) This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsGetCall(String apiProductId, Integer limit, Integer offset, String accept, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsGet
ApiResponse<DocumentListDTO>	apiProductsApiProductIdDocumentsGetWithHttpInfo(String apiProductId, Integer limit, Integer offset, String accept, String ifNoneMatch) Get a list of documents of an API Product This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.
DocumentDTO	apiProductsApiProductIdDocumentsPost(String apiProductId, DocumentDTO body) Add a new document to an API Product This operation can be used to add a new documentation to an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsPostAsync(String apiProductId, DocumentDTO body, ApiCallback<DocumentDTO> callback) Add a new document to an API Product (asynchronously) This operation can be used to add a new documentation to an API Product.
com.squareup.okhttp.Call	apiProductsApiProductIdDocumentsPostCall(String apiProductId, DocumentDTO body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apiProductsApiProductIdDocumentsPost
ApiResponse<DocumentDTO>	apiProductsApiProductIdDocumentsPostWithHttpInfo(String apiProductId, DocumentDTO body) Add a new document to an API Product This operation can be used to add a new documentation to an API Product.
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

ApiProductDocumentsApi

public ApiProductDocumentsApi()

ApiProductDocumentsApi

public ApiProductDocumentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apiProductsApiProductIdDocumentsDocumentIdContentGetCall

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

Build call for apiProductsApiProductIdDocumentsDocumentIdContentGet

Parameters:

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsDocumentIdContentGet

public void apiProductsApiProductIdDocumentsDocumentIdContentGet(String apiProductId,
                                                                 String documentId,
                                                                 String accept,
                                                                 String ifNoneMatch)
                                                          throws ApiException

Get the content of an API Product 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 _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 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:

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

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdContentGetWithHttpInfo

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

Get the content of an API Product 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 _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 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:

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

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdContentGetAsync

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

Get the content of an API Product 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 _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v1/apis/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 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:

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

apiProductsApiProductIdDocumentsDocumentIdContentPostCall

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

Build call for apiProductsApiProductIdDocumentsDocumentIdContentPost

Parameters:

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

documentId - Document Identifier (required)

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsDocumentIdContentPost

public DocumentDTO apiProductsApiProductIdDocumentsDocumentIdContentPost(String apiProductId,
                                                                         String documentId,
                                                                         File file,
                                                                         String inlineContent,
                                                                         String ifMatch)
                                                                  throws ApiException

Upload the content of an API Product document Thid operation can be used to upload a file or add inline content to an API Product 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:

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

documentId - Document Identifier (required)

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

Returns:

DocumentDTO

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdContentPostWithHttpInfo

public ApiResponse<DocumentDTO> apiProductsApiProductIdDocumentsDocumentIdContentPostWithHttpInfo(String apiProductId,
                                                                                                  String documentId,
                                                                                                  File file,
                                                                                                  String inlineContent,
                                                                                                  String ifMatch)
                                                                                           throws ApiException

Upload the content of an API Product document Thid operation can be used to upload a file or add inline content to an API Product 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:

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

documentId - Document Identifier (required)

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

Returns:

ApiResponse<DocumentDTO>

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdContentPostAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDocumentsDocumentIdContentPostAsync(String apiProductId,
                                                                                           String documentId,
                                                                                           File file,
                                                                                           String inlineContent,
                                                                                           String ifMatch,
                                                                                           ApiCallback<DocumentDTO> callback)
                                                                                    throws ApiException

Upload the content of an API Product document (asynchronously) Thid operation can be used to upload a file or add inline content to an API Product 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:

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

documentId - Document Identifier (required)

file - Document to upload (optional)

inlineContent - Inline content of the document (optional)

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

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apiProductsApiProductIdDocumentsDocumentIdDeleteCall

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

Build call for apiProductsApiProductIdDocumentsDocumentIdDelete

Parameters:

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

documentId - Document Identifier (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsDocumentIdDelete

public void apiProductsApiProductIdDocumentsDocumentIdDelete(String apiProductId,
                                                             String documentId,
                                                             String ifMatch)
                                                      throws ApiException

Delete a document of an API Product This operation can be used to delete a document associated with an API Product.

Parameters:

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

documentId - Document Identifier (required)

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

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdDeleteWithHttpInfo

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

Delete a document of an API Product This operation can be used to delete a document associated with an API Product.

Parameters:

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

documentId - Document Identifier (required)

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

Returns:

ApiResponse<Void>

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdDeleteAsync

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

Delete a document of an API Product (asynchronously) This operation can be used to delete a document associated with an API Product.

Parameters:

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

documentId - Document Identifier (required)

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

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apiProductsApiProductIdDocumentsDocumentIdGetCall

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

Build call for apiProductsApiProductIdDocumentsDocumentIdGet

Parameters:

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsDocumentIdGet

public DocumentDTO apiProductsApiProductIdDocumentsDocumentIdGet(String apiProductId,
                                                                 String documentId,
                                                                 String accept,
                                                                 String ifNoneMatch)
                                                          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:

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

Returns:

DocumentDTO

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdGetWithHttpInfo

public ApiResponse<DocumentDTO> apiProductsApiProductIdDocumentsDocumentIdGetWithHttpInfo(String apiProductId,
                                                                                          String documentId,
                                                                                          String accept,
                                                                                          String ifNoneMatch)
                                                                                   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:

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

Returns:

ApiResponse<DocumentDTO>

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdGetAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDocumentsDocumentIdGetAsync(String apiProductId,
                                                                                   String documentId,
                                                                                   String accept,
                                                                                   String ifNoneMatch,
                                                                                   ApiCallback<DocumentDTO> 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:

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

apiProductsApiProductIdDocumentsDocumentIdPutCall

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

Build call for apiProductsApiProductIdDocumentsDocumentIdPut

Parameters:

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

documentId - Document Identifier (required)

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsDocumentIdPut

public DocumentDTO apiProductsApiProductIdDocumentsDocumentIdPut(String apiProductId,
                                                                 String documentId,
                                                                 DocumentDTO body,
                                                                 String ifMatch)
                                                          throws ApiException

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

Parameters:

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

documentId - Document Identifier (required)

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

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

Returns:

DocumentDTO

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdPutWithHttpInfo

public ApiResponse<DocumentDTO> apiProductsApiProductIdDocumentsDocumentIdPutWithHttpInfo(String apiProductId,
                                                                                          String documentId,
                                                                                          DocumentDTO body,
                                                                                          String ifMatch)
                                                                                   throws ApiException

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

Parameters:

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

documentId - Document Identifier (required)

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

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

Returns:

ApiResponse<DocumentDTO>

Throws:

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

apiProductsApiProductIdDocumentsDocumentIdPutAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDocumentsDocumentIdPutAsync(String apiProductId,
                                                                                   String documentId,
                                                                                   DocumentDTO body,
                                                                                   String ifMatch,
                                                                                   ApiCallback<DocumentDTO> callback)
                                                                            throws ApiException

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

Parameters:

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

documentId - Document Identifier (required)

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

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

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apiProductsApiProductIdDocumentsGetCall

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

Build call for apiProductsApiProductIdDocumentsGet

Parameters:

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

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

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

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsGet

public DocumentListDTO apiProductsApiProductIdDocumentsGet(String apiProductId,
                                                           Integer limit,
                                                           Integer offset,
                                                           String accept,
                                                           String ifNoneMatch)
                                                    throws ApiException

Get a list of documents of an API Product This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.

Parameters:

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

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

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

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

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

Returns:

DocumentListDTO

Throws:

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

apiProductsApiProductIdDocumentsGetWithHttpInfo

public ApiResponse<DocumentListDTO> apiProductsApiProductIdDocumentsGetWithHttpInfo(String apiProductId,
                                                                                    Integer limit,
                                                                                    Integer offset,
                                                                                    String accept,
                                                                                    String ifNoneMatch)
                                                                             throws ApiException

Get a list of documents of an API Product This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.

Parameters:

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

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

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

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

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

Returns:

ApiResponse<DocumentListDTO>

Throws:

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

apiProductsApiProductIdDocumentsGetAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDocumentsGetAsync(String apiProductId,
                                                                         Integer limit,
                                                                         Integer offset,
                                                                         String accept,
                                                                         String ifNoneMatch,
                                                                         ApiCallback<DocumentListDTO> callback)
                                                                  throws ApiException

Get a list of documents of an API Product (asynchronously) This operation can be used to retrive a list of documents belonging to an API Product by providing the id of the API Product.

Parameters:

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

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

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

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

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

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apiProductsApiProductIdDocumentsPostCall

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

Build call for apiProductsApiProductIdDocumentsPost

Parameters:

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apiProductsApiProductIdDocumentsPost

public DocumentDTO apiProductsApiProductIdDocumentsPost(String apiProductId,
                                                        DocumentDTO body)
                                                 throws ApiException

Add a new document to an API Product This operation can be used to add a new documentation to an API Product. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API Product document ** API once we obtain a document Id by this operation.

Parameters:

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

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

Returns:

DocumentDTO

Throws:

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

apiProductsApiProductIdDocumentsPostWithHttpInfo

public ApiResponse<DocumentDTO> apiProductsApiProductIdDocumentsPostWithHttpInfo(String apiProductId,
                                                                                 DocumentDTO body)
                                                                          throws ApiException

Add a new document to an API Product This operation can be used to add a new documentation to an API Product. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API Product document ** API once we obtain a document Id by this operation.

Parameters:

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

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

Returns:

ApiResponse<DocumentDTO>

Throws:

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

apiProductsApiProductIdDocumentsPostAsync

public com.squareup.okhttp.Call apiProductsApiProductIdDocumentsPostAsync(String apiProductId,
                                                                          DocumentDTO body,
                                                                          ApiCallback<DocumentDTO> callback)
                                                                   throws ApiException

Add a new document to an API Product (asynchronously) This operation can be used to add a new documentation to an API Product. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API Product document ** API once we obtain a document Id by this operation.

Parameters:

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

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

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object