Package org.wso2.am.integration.clients.store.api.v1

Class ApiDocumentsApi

  • public class ApiDocumentsApi
extends Object

    • Constructor Detail

      • ApiDocumentsApi

        public ApiDocumentsApi()

      • ApiDocumentsApi

        public ApiDocumentsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • apisApiIdDocumentsDocumentIdContentGetCall

        public okhttp3.Call apisApiIdDocumentsDocumentIdContentGetCall​(String apiId,
                                                               String documentId,
                                                               String xWSO2Tenant,
                                                               String ifNoneMatch,
                                                               ApiCallback _callback)
                                                        throws ApiException
        Build call for apisApiIdDocumentsDocumentIdContentGet
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apisApiIdDocumentsDocumentIdContentGet

        public void apisApiIdDocumentsDocumentIdContentGet​(String apiId,
                                                   String documentId,
                                                   String xWSO2Tenant,
                                                   String ifNoneMatch)
                                            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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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 ifNoneMatch)
                                                                     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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisApiIdDocumentsDocumentIdContentGetAsync

        public okhttp3.Call apisApiIdDocumentsDocumentIdContentGetAsync​(String apiId,
                                                                String documentId,
                                                                String xWSO2Tenant,
                                                                String ifNoneMatch,
                                                                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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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

      • apisApiIdDocumentsDocumentIdGetCall

        public okhttp3.Call apisApiIdDocumentsDocumentIdGetCall​(String apiId,
                                                        String documentId,
                                                        String xWSO2Tenant,
                                                        String ifNoneMatch,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for apisApiIdDocumentsDocumentIdGet
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apisApiIdDocumentsDocumentIdGet

        public DocumentDTO apisApiIdDocumentsDocumentIdGet​(String apiId,
                                                   String documentId,
                                                   String xWSO2Tenant,
                                                   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. `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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        DocumentDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisApiIdDocumentsDocumentIdGetWithHttpInfo

        public ApiResponse<DocumentDTO> apisApiIdDocumentsDocumentIdGetWithHttpInfo​(String apiId,
                                                                            String documentId,
                                                                            String xWSO2Tenant,
                                                                            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. `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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<DocumentDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisApiIdDocumentsDocumentIdGetAsync

        public okhttp3.Call apisApiIdDocumentsDocumentIdGetAsync​(String apiId,
                                                         String documentId,
                                                         String xWSO2Tenant,
                                                         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. `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. (required)
        documentId - Document Identifier (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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

      • apisApiIdDocumentsGetCall

        public okhttp3.Call apisApiIdDocumentsGetCall​(String apiId,
                                              Integer limit,
                                              Integer offset,
                                              String xWSO2Tenant,
                                              String ifNoneMatch,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for apisApiIdDocumentsGet
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (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)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apisApiIdDocumentsGet

        public DocumentListDTO apisApiIdDocumentsGet​(String apiId,
                                             Integer limit,
                                             Integer offset,
                                             String xWSO2Tenant,
                                             String ifNoneMatch)
                                      throws ApiException
        Get a List of Documents of an API This operation can be used to retrive a list of documents belonging to an API by providing the id of the API. `X-WSO2-Tenant` header can be used to retrive documents 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 documents, you need to provide Authorization header.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (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)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        DocumentListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisApiIdDocumentsGetWithHttpInfo

        public ApiResponse<DocumentListDTO> apisApiIdDocumentsGetWithHttpInfo​(String apiId,
                                                                      Integer limit,
                                                                      Integer offset,
                                                                      String xWSO2Tenant,
                                                                      String ifNoneMatch)
                                                               throws ApiException
        Get a List of Documents of an API This operation can be used to retrive a list of documents belonging to an API by providing the id of the API. `X-WSO2-Tenant` header can be used to retrive documents 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 documents, you need to provide Authorization header.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (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)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<DocumentListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisApiIdDocumentsGetAsync

        public okhttp3.Call apisApiIdDocumentsGetAsync​(String apiId,
                                               Integer limit,
                                               Integer offset,
                                               String xWSO2Tenant,
                                               String ifNoneMatch,
                                               ApiCallback<DocumentListDTO> _callback)
                                        throws ApiException
        Get a List of Documents of an API (asynchronously) This operation can be used to retrive a list of documents belonging to an API by providing the id of the API. `X-WSO2-Tenant` header can be used to retrive documents 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 documents, you need to provide Authorization header.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (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)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (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