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

Class ApiProductRevisionsApi

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

  • Constructor Details

    • ApiProductRevisionsApi

      public ApiProductRevisionsApi()

    • ApiProductRevisionsApi

      public ApiProductRevisionsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createAPIProductRevisionCall

      public okhttp3.Call createAPIProductRevisionCall(String apiProductId, APIRevisionDTO apIRevisionDTO, ApiCallback _callback) throws ApiException
      Build call for createAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      apIRevisionDTO - API Product 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

    • createAPIProductRevision

      public APIRevisionDTO createAPIProductRevision(String apiProductId, APIRevisionDTO apIRevisionDTO) throws ApiException
      Create a new API Product revision Create a new API Product revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      apIRevisionDTO - API Product 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

    • createAPIProductRevisionWithHttpInfo

      public ApiResponse<APIRevisionDTO> createAPIProductRevisionWithHttpInfo(String apiProductId, APIRevisionDTO apIRevisionDTO) throws ApiException
      Create a new API Product revision Create a new API Product revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      apIRevisionDTO - API Product 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

    • createAPIProductRevisionAsync

      public okhttp3.Call createAPIProductRevisionAsync(String apiProductId, APIRevisionDTO apIRevisionDTO, ApiCallback<APIRevisionDTO> _callback) throws ApiException
      Create a new API Product revision (asynchronously) Create a new API Product revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      apIRevisionDTO - API Product 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

    • deleteAPIProductRevisionCall

      public okhttp3.Call deleteAPIProductRevisionCall(String apiProductId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for deleteAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • deleteAPIProductRevision

      public APIRevisionListDTO deleteAPIProductRevision(String apiProductId, String revisionId) throws ApiException
      Delete Revision Delete a revision of 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)
      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

    • deleteAPIProductRevisionWithHttpInfo

      public ApiResponse<APIRevisionListDTO> deleteAPIProductRevisionWithHttpInfo(String apiProductId, String revisionId) throws ApiException
      Delete Revision Delete a revision of 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)
      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

    • deleteAPIProductRevisionAsync

      public okhttp3.Call deleteAPIProductRevisionAsync(String apiProductId, String revisionId, ApiCallback<APIRevisionListDTO> _callback) throws ApiException
      Delete Revision (asynchronously) Delete a revision of 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)
      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

    • deployAPIProductRevisionCall

      public okhttp3.Call deployAPIProductRevisionCall(String apiProductId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for deployAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • deployAPIProductRevision

      public void deployAPIProductRevision(String apiProductId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      Deploy Revision Deploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      revisionId - Revision ID of an API (optional)
      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

    • deployAPIProductRevisionWithHttpInfo

      public ApiResponse<Void> deployAPIProductRevisionWithHttpInfo(String apiProductId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      Deploy Revision Deploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      revisionId - Revision ID of an API (optional)
      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

    • deployAPIProductRevisionAsync

      public okhttp3.Call deployAPIProductRevisionAsync(String apiProductId, String revisionId, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<Void> _callback) throws ApiException
      Deploy Revision (asynchronously) Deploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • getAPIProductRevisionCall

      public okhttp3.Call getAPIProductRevisionCall(String apiProductId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for getAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • getAPIProductRevision

      public APIRevisionDTO getAPIProductRevision(String apiProductId, String revisionId) throws ApiException
      Retrieve Revision Retrieve a revision of 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)
      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

    • getAPIProductRevisionWithHttpInfo

      public ApiResponse<APIRevisionDTO> getAPIProductRevisionWithHttpInfo(String apiProductId, String revisionId) throws ApiException
      Retrieve Revision Retrieve a revision of 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)
      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

    • getAPIProductRevisionAsync

      public okhttp3.Call getAPIProductRevisionAsync(String apiProductId, String revisionId, ApiCallback<APIRevisionDTO> _callback) throws ApiException
      Retrieve Revision (asynchronously) Retrieve a revision of 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)
      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

    • getAPIProductRevisionDeploymentsCall

      public okhttp3.Call getAPIProductRevisionDeploymentsCall(String apiProductId, ApiCallback _callback) throws ApiException
      Build call for getAPIProductRevisionDeployments
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAPIProductRevisionDeployments

      public APIRevisionDeploymentListDTO getAPIProductRevisionDeployments(String apiProductId) throws ApiException
      List Deployments List available deployed revision deployment details of 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)
      Returns:
      APIRevisionDeploymentListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIProductRevisionDeploymentsWithHttpInfo

      public ApiResponse<APIRevisionDeploymentListDTO> getAPIProductRevisionDeploymentsWithHttpInfo(String apiProductId) throws ApiException
      List Deployments List available deployed revision deployment details of 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)
      Returns:
      ApiResponse<APIRevisionDeploymentListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIProductRevisionDeploymentsAsync

      public okhttp3.Call getAPIProductRevisionDeploymentsAsync(String apiProductId, ApiCallback<APIRevisionDeploymentListDTO> _callback) throws ApiException
      List Deployments (asynchronously) List available deployed revision deployment details of 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)
      _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

    • getAPIProductRevisionsCall

      public okhttp3.Call getAPIProductRevisionsCall(String apiProductId, String query, ApiCallback _callback) throws ApiException
      Build call for getAPIProductRevisions
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (required)
      query - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getAPIProductRevisions

      public APIRevisionListDTO getAPIProductRevisions(String apiProductId, String query) throws ApiException
      List Revisions List available revisions of 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)
      query - (optional)
      Returns:
      APIRevisionListDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIProductRevisionsWithHttpInfo

      public ApiResponse<APIRevisionListDTO> getAPIProductRevisionsWithHttpInfo(String apiProductId, String query) throws ApiException
      List Revisions List available revisions of 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)
      query - (optional)
      Returns:
      ApiResponse<APIRevisionListDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getAPIProductRevisionsAsync

      public okhttp3.Call getAPIProductRevisionsAsync(String apiProductId, String query, ApiCallback<APIRevisionListDTO> _callback) throws ApiException
      List Revisions (asynchronously) List available revisions of 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)
      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

    • restoreAPIProductRevisionCall

      public okhttp3.Call restoreAPIProductRevisionCall(String apiProductId, String revisionId, ApiCallback _callback) throws ApiException
      Build call for restoreAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • restoreAPIProductRevision

      public APIProductDTO restoreAPIProductRevision(String apiProductId, String revisionId) throws ApiException
      Restore Revision Restore a revision to the Current API 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)
      revisionId - Revision ID of an API (optional)
      Returns:
      APIProductDTO
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • restoreAPIProductRevisionWithHttpInfo

      public ApiResponse<APIProductDTO> restoreAPIProductRevisionWithHttpInfo(String apiProductId, String revisionId) throws ApiException
      Restore Revision Restore a revision to the Current API 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)
      revisionId - Revision ID of an API (optional)
      Returns:
      ApiResponse<APIProductDTO>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • restoreAPIProductRevisionAsync

      public okhttp3.Call restoreAPIProductRevisionAsync(String apiProductId, String revisionId, ApiCallback<APIProductDTO> _callback) throws ApiException
      Restore Revision (asynchronously) Restore a revision to the Current API 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)
      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

    • undeployAPIProductRevisionCall

      public okhttp3.Call undeployAPIProductRevisionCall(String apiProductId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for undeployAPIProductRevision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • undeployAPIProductRevision

      public void undeployAPIProductRevision(String apiProductId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      UnDeploy Revision UnDeploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • undeployAPIProductRevisionWithHttpInfo

      public ApiResponse<Void> undeployAPIProductRevisionWithHttpInfo(String apiProductId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO) throws ApiException
      UnDeploy Revision UnDeploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • undeployAPIProductRevisionAsync

      public okhttp3.Call undeployAPIProductRevisionAsync(String apiProductId, String revisionId, String revisionNumber, Boolean allEnvironments, List<APIRevisionDeploymentDTO> apIRevisionDeploymentDTO, ApiCallback<Void> _callback) throws ApiException
      UnDeploy Revision (asynchronously) UnDeploy an API Product Revision
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • updateAPIProductDeploymentCall

      public okhttp3.Call updateAPIProductDeploymentCall(String apiProductId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO, ApiCallback _callback) throws ApiException
      Build call for updateAPIProductDeployment
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • updateAPIProductDeployment

      public APIRevisionDeploymentDTO updateAPIProductDeployment(String apiProductId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO) throws ApiException
      Update Deployment Update deployment devportal visibility
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • updateAPIProductDeploymentWithHttpInfo

      public ApiResponse<APIRevisionDeploymentDTO> updateAPIProductDeploymentWithHttpInfo(String apiProductId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO) throws ApiException
      Update Deployment Update deployment devportal visibility
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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

    • updateAPIProductDeploymentAsync

      public okhttp3.Call updateAPIProductDeploymentAsync(String apiProductId, String deploymentId, APIRevisionDeploymentDTO apIRevisionDeploymentDTO, ApiCallback<APIRevisionDeploymentDTO> _callback) throws ApiException
      Update Deployment (asynchronously) Update deployment devportal visibility
      Parameters:
      apiProductId - **API Product ID** consisting of the **UUID** of the API Product. Using the **UUID** in the API call is recommended. (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