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

Class ApiRevisionsApi

java.lang.Object
org.wso2.am.integration.clients.publisher.api.v1.ApiRevisionsApi
public class ApiRevisionsApi extends Object

  • Constructor Details

    • ApiRevisionsApi

      public ApiRevisionsApi()

    • ApiRevisionsApi

      public ApiRevisionsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createAPIRevisionCall

      public okhttp3.Call createAPIRevisionCall(String apiId, APIRevisionDTO apIRevisionDTO, ApiCallback _callback) throws ApiException
      Build call for createAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      apIRevisionDTO - API object that needs to be added (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • createAPIRevision

      public APIRevisionDTO createAPIRevision(String apiId, APIRevisionDTO apIRevisionDTO) throws ApiException
      Create API Revision Create a new API revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      apIRevisionDTO - API object that needs to be added (optional)
      Returns:
      APIRevisionDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createAPIRevisionWithHttpInfo

      public ApiResponse<APIRevisionDTO> createAPIRevisionWithHttpInfo(String apiId, APIRevisionDTO apIRevisionDTO) throws ApiException
      Create API Revision Create a new API revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      apIRevisionDTO - API object that needs to be added (optional)
      Returns:
      ApiResponse<APIRevisionDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • createAPIRevisionAsync

      public okhttp3.Call createAPIRevisionAsync(String apiId, APIRevisionDTO apIRevisionDTO, ApiCallback<APIRevisionDTO> _callback) throws ApiException
      Create API Revision (asynchronously) Create a new API revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      apIRevisionDTO - API object that needs to be added (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

    • deleteAPIRevisionCall

      public okhttp3.Call deleteAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for deleteAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteAPIRevision

      public APIRevisionListDTO deleteAPIRevision(String apiId, String revisionId) throws ApiException
      Delete Revision Delete a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      Returns:
      APIRevisionListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteAPIRevisionWithHttpInfo

      public ApiResponse<APIRevisionListDTO> deleteAPIRevisionWithHttpInfo(String apiId, String revisionId) throws ApiException
      Delete Revision Delete a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      Returns:
      ApiResponse<APIRevisionListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteAPIRevisionAsync

      public okhttp3.Call deleteAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIRevisionListDTO> _callback) throws ApiException
      Delete Revision (asynchronously) Delete a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (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

    • deleteAPIRevisionDeploymentPendingTaskCall

      public okhttp3.Call deleteAPIRevisionDeploymentPendingTaskCall(String apiId, String revisionId, String envName, ApiCallback _callback) throws ApiException
      Build call for deleteAPIRevisionDeploymentPendingTask
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      envName - Environment name of an Revision (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deleteAPIRevisionDeploymentPendingTask

      public void deleteAPIRevisionDeploymentPendingTask(String apiId, String revisionId, String envName) throws ApiException
      Delete Pending Revision Deployment Workflow Tasks This operation can be used to remove pending revision deployment requests that are in pending state
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      envName - Environment name of an Revision (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteAPIRevisionDeploymentPendingTaskWithHttpInfo

      public ApiResponse<Void> deleteAPIRevisionDeploymentPendingTaskWithHttpInfo(String apiId, String revisionId, String envName) throws ApiException
      Delete Pending Revision Deployment Workflow Tasks This operation can be used to remove pending revision deployment requests that are in pending state
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      envName - Environment name of an Revision (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deleteAPIRevisionDeploymentPendingTaskAsync

      public okhttp3.Call deleteAPIRevisionDeploymentPendingTaskAsync(String apiId, String revisionId, String envName, ApiCallback<Void> _callback) throws ApiException
      Delete Pending Revision Deployment Workflow Tasks (asynchronously) This operation can be used to remove pending revision deployment requests that are in pending state
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      envName - Environment name of an Revision (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

    • deployAPIRevisionCall

      public okhttp3.Call deployAPIRevisionCall(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for deployAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • deployAPIRevision

      public List<APIRevisionDeploymentDTO> deployAPIRevision(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      Deploy Revision Deploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      Returns:
      List<APIRevisionDeploymentDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deployAPIRevisionWithHttpInfo

      public ApiResponse<List<APIRevisionDeploymentDTO>> deployAPIRevisionWithHttpInfo(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      Deploy Revision Deploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      Returns:
      ApiResponse<List<APIRevisionDeploymentDTO>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • deployAPIRevisionAsync

      public okhttp3.Call deployAPIRevisionAsync(String apiId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<List<APIRevisionDeploymentDTO>> _callback) throws ApiException
      Deploy Revision (asynchronously) Deploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (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

    • getAPIRevisionCall

      public okhttp3.Call getAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for getAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAPIRevision

      public APIRevisionDTO getAPIRevision(String apiId, String revisionId) throws ApiException
      Retrieve Revision Retrieve a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      Returns:
      APIRevisionDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionWithHttpInfo

      public ApiResponse<APIRevisionDTO> getAPIRevisionWithHttpInfo(String apiId, String revisionId) throws ApiException
      Retrieve Revision Retrieve a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (required)
      Returns:
      ApiResponse<APIRevisionDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionAsync

      public okhttp3.Call getAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIRevisionDTO> _callback) throws ApiException
      Retrieve Revision (asynchronously) Retrieve a revision of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (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

    • getAPIRevisionDeploymentsCall

      public okhttp3.Call getAPIRevisionDeploymentsCall(String apiId, ApiCallback _callback) throws ApiException
      Build call for getAPIRevisionDeployments
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAPIRevisionDeployments

      public APIRevisionDeploymentListDTO getAPIRevisionDeployments(String apiId) throws ApiException
      List Deployments List available deployed revision deployment details of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      Returns:
      APIRevisionDeploymentListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionDeploymentsWithHttpInfo

      public ApiResponse<APIRevisionDeploymentListDTO> getAPIRevisionDeploymentsWithHttpInfo(String apiId) throws ApiException
      List Deployments List available deployed revision deployment details of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      Returns:
      ApiResponse<APIRevisionDeploymentListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionDeploymentsAsync

      public okhttp3.Call getAPIRevisionDeploymentsAsync(String apiId, ApiCallback<APIRevisionDeploymentListDTO> _callback) throws ApiException
      List Deployments (asynchronously) List available deployed revision deployment details of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (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

    • getAPIRevisionsCall

      public okhttp3.Call getAPIRevisionsCall(String apiId, String query, ApiCallback _callback) throws ApiException
      Build call for getAPIRevisions
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      query - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAPIRevisions

      public APIRevisionListDTO getAPIRevisions(String apiId, String query) throws ApiException
      List Revisions List available revisions of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      query - (optional)
      Returns:
      APIRevisionListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionsWithHttpInfo

      public ApiResponse<APIRevisionListDTO> getAPIRevisionsWithHttpInfo(String apiId, String query) throws ApiException
      List Revisions List available revisions of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      query - (optional)
      Returns:
      ApiResponse<APIRevisionListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIRevisionsAsync

      public okhttp3.Call getAPIRevisionsAsync(String apiId, String query, ApiCallback<APIRevisionListDTO> _callback) throws ApiException
      List Revisions (asynchronously) List available revisions of an API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      query - (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

    • restoreAPIRevisionCall

      public okhttp3.Call restoreAPIRevisionCall(String apiId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for restoreAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • restoreAPIRevision

      public APIDTO restoreAPIRevision(String apiId, String revisionId) throws ApiException
      Restore API Revision Restore a revision to the current API of the API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      Returns:
      APIDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • restoreAPIRevisionWithHttpInfo

      public ApiResponse<APIDTO> restoreAPIRevisionWithHttpInfo(String apiId, String revisionId) throws ApiException
      Restore API Revision Restore a revision to the current API of the API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      Returns:
      ApiResponse<APIDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • restoreAPIRevisionAsync

      public okhttp3.Call restoreAPIRevisionAsync(String apiId, String revisionId, ApiCallback<APIDTO> _callback) throws ApiException
      Restore API Revision (asynchronously) Restore a revision to the current API of the API
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (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

    • undeployAPIRevisionCall

      public okhttp3.Call undeployAPIRevisionCall(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for undeployAPIRevision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      revisionNumber - Revision Number of an API (optional)
      allEnvironments - (optional, default to false)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • undeployAPIRevision

      public void undeployAPIRevision(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      UnDeploy Revision UnDeploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      revisionNumber - Revision Number of an API (optional)
      allEnvironments - (optional, default to false)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • undeployAPIRevisionWithHttpInfo

      public ApiResponse<Void> undeployAPIRevisionWithHttpInfo(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      UnDeploy Revision UnDeploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      revisionNumber - Revision Number of an API (optional)
      allEnvironments - (optional, default to false)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • undeployAPIRevisionAsync

      public okhttp3.Call undeployAPIRevisionAsync(String apiId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<Void> _callback) throws ApiException
      UnDeploy Revision (asynchronously) UnDeploy a revision
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      revisionId - Revision ID of an API (optional)
      revisionNumber - Revision Number of an API (optional)
      allEnvironments - (optional, default to false)
      apIRevisionDeploymentDTO - Deployment object that needs to be added (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

    • updateAPIDeploymentCall

      public okhttp3.Call updateAPIDeploymentCall(String apiId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for updateAPIDeployment
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      deploymentId - Base64 URL encoded value of the name of an environment (required)
      apIRevisionDeploymentDTO - Deployment object that needs to be updated (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • updateAPIDeployment

      public APIRevisionDeploymentDTO updateAPIDeployment(String apiId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO) throws ApiException
      Update Deployment Update deployment devportal visibility
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      deploymentId - Base64 URL encoded value of the name of an environment (required)
      apIRevisionDeploymentDTO - Deployment object that needs to be updated (optional)
      Returns:
      APIRevisionDeploymentDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateAPIDeploymentWithHttpInfo

      public ApiResponse<APIRevisionDeploymentDTO> updateAPIDeploymentWithHttpInfo(String apiId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO) throws ApiException
      Update Deployment Update deployment devportal visibility
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      deploymentId - Base64 URL encoded value of the name of an environment (required)
      apIRevisionDeploymentDTO - Deployment object that needs to be updated (optional)
      Returns:
      ApiResponse<APIRevisionDeploymentDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • updateAPIDeploymentAsync

      public okhttp3.Call updateAPIDeploymentAsync(String apiId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO, ApiCallback<APIRevisionDeploymentDTO> _callback) throws ApiException
      Update Deployment (asynchronously) Update deployment devportal visibility
      Parameters:
      apiId - **API ID** consisting of the **UUID** of the API. (required)
      deploymentId - Base64 URL encoded value of the name of an environment (required)
      apIRevisionDeploymentDTO - Deployment object that needs to be updated (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