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

Class SubscriptionsApi

  • public class SubscriptionsApi
extends Object

    • Constructor Detail

      • SubscriptionsApi

        public SubscriptionsApi()

      • SubscriptionsApi

        public SubscriptionsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getAdditionalInfoOfAPISubscriptionsCall

        public okhttp3.Call getAdditionalInfoOfAPISubscriptionsCall​(String apiId,
                                                            String groupId,
                                                            String xWSO2Tenant,
                                                            Integer offset,
                                                            Integer limit,
                                                            String ifNoneMatch,
                                                            ApiCallback _callback)
                                                     throws ApiException
        Build call for getAdditionalInfoOfAPISubscriptions
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        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

      • getAdditionalInfoOfAPISubscriptions

        public AdditionalSubscriptionInfoListDTO getAdditionalInfoOfAPISubscriptions​(String apiId,
                                                                             String groupId,
                                                                             String xWSO2Tenant,
                                                                             Integer offset,
                                                                             Integer limit,
                                                                             String ifNoneMatch)
                                                                      throws ApiException
        Get Additional Information of subscriptions attached to an API. This operation can be used to retrieve all additional Information of subscriptions attached to an API by providing the API id.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        AdditionalSubscriptionInfoListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAdditionalInfoOfAPISubscriptionsWithHttpInfo

        public ApiResponse<AdditionalSubscriptionInfoListDTO> getAdditionalInfoOfAPISubscriptionsWithHttpInfo​(String apiId,
                                                                                                      String groupId,
                                                                                                      String xWSO2Tenant,
                                                                                                      Integer offset,
                                                                                                      Integer limit,
                                                                                                      String ifNoneMatch)
                                                                                               throws ApiException
        Get Additional Information of subscriptions attached to an API. This operation can be used to retrieve all additional Information of subscriptions attached to an API by providing the API id.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<AdditionalSubscriptionInfoListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getAdditionalInfoOfAPISubscriptionsAsync

        public okhttp3.Call getAdditionalInfoOfAPISubscriptionsAsync​(String apiId,
                                                             String groupId,
                                                             String xWSO2Tenant,
                                                             Integer offset,
                                                             Integer limit,
                                                             String ifNoneMatch,
                                                             ApiCallback<AdditionalSubscriptionInfoListDTO> _callback)
                                                      throws ApiException
        Get Additional Information of subscriptions attached to an API. (asynchronously) This operation can be used to retrieve all additional Information of subscriptions attached to an API by providing the API id.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        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

      • subscriptionsGetCall

        public okhttp3.Call subscriptionsGetCall​(String apiId,
                                         String applicationId,
                                         String groupId,
                                         String xWSO2Tenant,
                                         Integer offset,
                                         Integer limit,
                                         String ifNoneMatch,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for subscriptionsGet
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (optional)
        applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        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

      • subscriptionsGet

        public SubscriptionListDTO subscriptionsGet​(String apiId,
                                            String applicationId,
                                            String groupId,
                                            String xWSO2Tenant,
                                            Integer offset,
                                            Integer limit,
                                            String ifNoneMatch)
                                     throws ApiException
        Get All Subscriptions This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving applications which are subscibed to a specific API. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (optional)
        applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        SubscriptionListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsGetWithHttpInfo

        public ApiResponse<SubscriptionListDTO> subscriptionsGetWithHttpInfo​(String apiId,
                                                                     String applicationId,
                                                                     String groupId,
                                                                     String xWSO2Tenant,
                                                                     Integer offset,
                                                                     Integer limit,
                                                                     String ifNoneMatch)
                                                              throws ApiException
        Get All Subscriptions This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving applications which are subscibed to a specific API. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (optional)
        applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<SubscriptionListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsGetAsync

        public okhttp3.Call subscriptionsGetAsync​(String apiId,
                                          String applicationId,
                                          String groupId,
                                          String xWSO2Tenant,
                                          Integer offset,
                                          Integer limit,
                                          String ifNoneMatch,
                                          ApiCallback<SubscriptionListDTO> _callback)
                                   throws ApiException
        Get All Subscriptions (asynchronously) This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token. This operation is capable of 1. Retrieving applications which are subscibed to a specific API. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed` 2. Retrieving APIs which are subscribed by a specific application. `GET https://localhost:9443/api/am/devportal/v2/subscriptions?applicationId=c43a325c-260b-4302-81cb-768eafaa3aed` **IMPORTANT:** * It is mandatory to provide either **apiId** or **applicationId**.
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (optional)
        applicationId - **Application Identifier** consisting of the UUID of the Application. (optional)
        groupId - Application Group Id (optional)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        offset - Starting point within the complete list of items qualified. (optional, default to 0)
        limit - Maximum size of resource array to return. (optional, default to 25)
        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

      • subscriptionsMultiplePostCall

        public okhttp3.Call subscriptionsMultiplePostCall​(List<SubscriptionDTO> subscriptionDTO,
                                                  String xWSO2Tenant,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for subscriptionsMultiplePost
        Parameters:
        subscriptionDTO - Subscription objects that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionsMultiplePost

        public List<SubscriptionDTO> subscriptionsMultiplePost​(List<SubscriptionDTO> subscriptionDTO,
                                                       String xWSO2Tenant)
                                                throws ApiException
        Add New Subscriptions This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
        Parameters:
        subscriptionDTO - Subscription objects that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        List<SubscriptionDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsMultiplePostWithHttpInfo

        public ApiResponse<List<SubscriptionDTO>> subscriptionsMultiplePostWithHttpInfo​(List<SubscriptionDTO> subscriptionDTO,
                                                                                String xWSO2Tenant)
                                                                         throws ApiException
        Add New Subscriptions This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
        Parameters:
        subscriptionDTO - Subscription objects that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        ApiResponse<List<SubscriptionDTO>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsMultiplePostAsync

        public okhttp3.Call subscriptionsMultiplePostAsync​(List<SubscriptionDTO> subscriptionDTO,
                                                   String xWSO2Tenant,
                                                   ApiCallback<List<SubscriptionDTO>> _callback)
                                            throws ApiException
        Add New Subscriptions (asynchronously) This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
        Parameters:
        subscriptionDTO - Subscription objects that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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

      • subscriptionsPostCall

        public okhttp3.Call subscriptionsPostCall​(SubscriptionDTO subscriptionDTO,
                                          String xWSO2Tenant,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for subscriptionsPost
        Parameters:
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionsPost

        public SubscriptionDTO subscriptionsPost​(SubscriptionDTO subscriptionDTO,
                                         String xWSO2Tenant)
                                  throws ApiException
        Add a New Subscription This operation can be used to add a new subscription providing the id of the API and the application.
        Parameters:
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        SubscriptionDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsPostWithHttpInfo

        public ApiResponse<SubscriptionDTO> subscriptionsPostWithHttpInfo​(SubscriptionDTO subscriptionDTO,
                                                                  String xWSO2Tenant)
                                                           throws ApiException
        Add a New Subscription This operation can be used to add a new subscription providing the id of the API and the application.
        Parameters:
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        ApiResponse<SubscriptionDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsPostAsync

        public okhttp3.Call subscriptionsPostAsync​(SubscriptionDTO subscriptionDTO,
                                           String xWSO2Tenant,
                                           ApiCallback<SubscriptionDTO> _callback)
                                    throws ApiException
        Add a New Subscription (asynchronously) This operation can be used to add a new subscription providing the id of the API and the application.
        Parameters:
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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

      • subscriptionsSubscriptionIdDeleteCall

        public okhttp3.Call subscriptionsSubscriptionIdDeleteCall​(String subscriptionId,
                                                          String ifMatch,
                                                          ApiCallback _callback)
                                                   throws ApiException
        Build call for subscriptionsSubscriptionIdDelete
        Parameters:
        subscriptionId - Subscription Id (required)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionsSubscriptionIdDelete

        public void subscriptionsSubscriptionIdDelete​(String subscriptionId,
                                              String ifMatch)
                                       throws ApiException
        Remove a Subscription This operation can be used to remove a subscription.
        Parameters:
        subscriptionId - Subscription Id (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

      • subscriptionsSubscriptionIdDeleteWithHttpInfo

        public ApiResponse<Void> subscriptionsSubscriptionIdDeleteWithHttpInfo​(String subscriptionId,
                                                                       String ifMatch)
                                                                throws ApiException
        Remove a Subscription This operation can be used to remove a subscription.
        Parameters:
        subscriptionId - Subscription Id (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

      • subscriptionsSubscriptionIdDeleteAsync

        public okhttp3.Call subscriptionsSubscriptionIdDeleteAsync​(String subscriptionId,
                                                           String ifMatch,
                                                           ApiCallback<Void> _callback)
                                                    throws ApiException
        Remove a Subscription (asynchronously) This operation can be used to remove a subscription.
        Parameters:
        subscriptionId - Subscription Id (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

      • subscriptionsSubscriptionIdGetCall

        public okhttp3.Call subscriptionsSubscriptionIdGetCall​(String subscriptionId,
                                                       String ifNoneMatch,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for subscriptionsSubscriptionIdGet
        Parameters:
        subscriptionId - Subscription Id (required)
        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

      • subscriptionsSubscriptionIdGet

        public SubscriptionDTO subscriptionsSubscriptionIdGet​(String subscriptionId,
                                                      String ifNoneMatch)
                                               throws ApiException
        Get Details of a Subscription This operation can be used to get details of a single subscription.
        Parameters:
        subscriptionId - Subscription Id (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        SubscriptionDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsSubscriptionIdGetWithHttpInfo

        public ApiResponse<SubscriptionDTO> subscriptionsSubscriptionIdGetWithHttpInfo​(String subscriptionId,
                                                                               String ifNoneMatch)
                                                                        throws ApiException
        Get Details of a Subscription This operation can be used to get details of a single subscription.
        Parameters:
        subscriptionId - Subscription Id (required)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        Returns:
        ApiResponse<SubscriptionDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsSubscriptionIdGetAsync

        public okhttp3.Call subscriptionsSubscriptionIdGetAsync​(String subscriptionId,
                                                        String ifNoneMatch,
                                                        ApiCallback<SubscriptionDTO> _callback)
                                                 throws ApiException
        Get Details of a Subscription (asynchronously) This operation can be used to get details of a single subscription.
        Parameters:
        subscriptionId - Subscription Id (required)
        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

      • subscriptionsSubscriptionIdPutCall

        public okhttp3.Call subscriptionsSubscriptionIdPutCall​(String subscriptionId,
                                                       SubscriptionDTO subscriptionDTO,
                                                       String xWSO2Tenant,
                                                       ApiCallback _callback)
                                                throws ApiException
        Build call for subscriptionsSubscriptionIdPut
        Parameters:
        subscriptionId - Subscription Id (required)
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionsSubscriptionIdPut

        public SubscriptionDTO subscriptionsSubscriptionIdPut​(String subscriptionId,
                                                      SubscriptionDTO subscriptionDTO,
                                                      String xWSO2Tenant)
                                               throws ApiException
        Update Existing Subscription This operation can be used to update a subscription providing the subscription id, api id, application Id, status and updated throttling policy tier.
        Parameters:
        subscriptionId - Subscription Id (required)
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        SubscriptionDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsSubscriptionIdPutWithHttpInfo

        public ApiResponse<SubscriptionDTO> subscriptionsSubscriptionIdPutWithHttpInfo​(String subscriptionId,
                                                                               SubscriptionDTO subscriptionDTO,
                                                                               String xWSO2Tenant)
                                                                        throws ApiException
        Update Existing Subscription This operation can be used to update a subscription providing the subscription id, api id, application Id, status and updated throttling policy tier.
        Parameters:
        subscriptionId - Subscription Id (required)
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (optional)
        Returns:
        ApiResponse<SubscriptionDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsSubscriptionIdPutAsync

        public okhttp3.Call subscriptionsSubscriptionIdPutAsync​(String subscriptionId,
                                                        SubscriptionDTO subscriptionDTO,
                                                        String xWSO2Tenant,
                                                        ApiCallback<SubscriptionDTO> _callback)
                                                 throws ApiException
        Update Existing Subscription (asynchronously) This operation can be used to update a subscription providing the subscription id, api id, application Id, status and updated throttling policy tier.
        Parameters:
        subscriptionId - Subscription Id (required)
        subscriptionDTO - Subscription object that should to be added (required)
        xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retrieved from. (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