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

Class SubscriptionsApi

java.lang.Object

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

public class SubscriptionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionsApi()
SubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	subscriptionsBlockSubscriptionPost(String subscriptionId, String blockState, String ifMatch) Block a subscription This operation can be used to block a subscription.
com.squareup.okhttp.Call	subscriptionsBlockSubscriptionPostAsync(String subscriptionId, String blockState, String ifMatch, ApiCallback<Void> callback) Block a subscription (asynchronously) This operation can be used to block a subscription.
com.squareup.okhttp.Call	subscriptionsBlockSubscriptionPostCall(String subscriptionId, String blockState, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subscriptionsBlockSubscriptionPost
ApiResponse<Void>	subscriptionsBlockSubscriptionPostWithHttpInfo(String subscriptionId, String blockState, String ifMatch) Block a subscription This operation can be used to block a subscription.
SubscriptionListDTO	subscriptionsGet(String apiId, Integer limit, Integer offset, String ifNoneMatch, String query) Get all Subscriptions This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token.
com.squareup.okhttp.Call	subscriptionsGetAsync(String apiId, Integer limit, Integer offset, String ifNoneMatch, String query, ApiCallback<SubscriptionListDTO> callback) Get all Subscriptions (asynchronously) This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token.
com.squareup.okhttp.Call	subscriptionsGetCall(String apiId, Integer limit, Integer offset, String ifNoneMatch, String query, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subscriptionsGet
ApiResponse<SubscriptionListDTO>	subscriptionsGetWithHttpInfo(String apiId, Integer limit, Integer offset, String ifNoneMatch, String query) Get all Subscriptions This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token.
void	subscriptionsUnblockSubscriptionPost(String subscriptionId, String ifMatch) Unblock a Subscription This operation can be used to unblock a subscription specifying the subscription Id.
com.squareup.okhttp.Call	subscriptionsUnblockSubscriptionPostAsync(String subscriptionId, String ifMatch, ApiCallback<Void> callback) Unblock a Subscription (asynchronously) This operation can be used to unblock a subscription specifying the subscription Id.
com.squareup.okhttp.Call	subscriptionsUnblockSubscriptionPostCall(String subscriptionId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for subscriptionsUnblockSubscriptionPost
ApiResponse<Void>	subscriptionsUnblockSubscriptionPostWithHttpInfo(String subscriptionId, String ifMatch) Unblock a Subscription This operation can be used to unblock a subscription specifying the subscription Id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionsApi

public SubscriptionsApi()

SubscriptionsApi

public SubscriptionsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

subscriptionsBlockSubscriptionPostCall

public com.squareup.okhttp.Call subscriptionsBlockSubscriptionPostCall(String subscriptionId,
                                                                       String blockState,
                                                                       String ifMatch,
                                                                       ProgressResponseBody.ProgressListener progressListener,
                                                                       ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                throws ApiException

Build call for subscriptionsBlockSubscriptionPost

Parameters:

subscriptionId - Subscription Id (required)

blockState - Subscription block state. (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subscriptionsBlockSubscriptionPost

public void subscriptionsBlockSubscriptionPost(String subscriptionId,
                                               String blockState,
                                               String ifMatch)
                                        throws ApiException

Block a subscription This operation can be used to block a subscription. Along with the request, `blockState` must be specified as a query parameter. 1. `BLOCKED` : Subscription is completely blocked for both Production and Sandbox environments. 2. `PROD_ONLY_BLOCKED` : Subscription is blocked for Production environment only.

Parameters:

subscriptionId - Subscription Id (required)

blockState - Subscription block state. (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

subscriptionsBlockSubscriptionPostWithHttpInfo

public ApiResponse<Void> subscriptionsBlockSubscriptionPostWithHttpInfo(String subscriptionId,
                                                                        String blockState,
                                                                        String ifMatch)
                                                                 throws ApiException

Block a subscription This operation can be used to block a subscription. Along with the request, `blockState` must be specified as a query parameter. 1. `BLOCKED` : Subscription is completely blocked for both Production and Sandbox environments. 2. `PROD_ONLY_BLOCKED` : Subscription is blocked for Production environment only.

Parameters:

subscriptionId - Subscription Id (required)

blockState - Subscription block state. (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

subscriptionsBlockSubscriptionPostAsync

public com.squareup.okhttp.Call subscriptionsBlockSubscriptionPostAsync(String subscriptionId,
                                                                        String blockState,
                                                                        String ifMatch,
                                                                        ApiCallback<Void> callback)
                                                                 throws ApiException

Block a subscription (asynchronously) This operation can be used to block a subscription. Along with the request, `blockState` must be specified as a query parameter. 1. `BLOCKED` : Subscription is completely blocked for both Production and Sandbox environments. 2. `PROD_ONLY_BLOCKED` : Subscription is blocked for Production environment only.

Parameters:

subscriptionId - Subscription Id (required)

blockState - Subscription block state. (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

subscriptionsGetCall

public com.squareup.okhttp.Call subscriptionsGetCall(String apiId,
                                                     Integer limit,
                                                     Integer offset,
                                                     String ifNoneMatch,
                                                     String query,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for subscriptionsGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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)

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

query - Keywords to filter subscriptions (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subscriptionsGet

public SubscriptionListDTO subscriptionsGet(String apiId,
                                            Integer limit,
                                            Integer offset,
                                            String ifNoneMatch,
                                            String query)
                                     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 all subscriptions for the user's APIs. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed`

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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)

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

query - Keywords to filter subscriptions (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,
                                                                     Integer limit,
                                                                     Integer offset,
                                                                     String ifNoneMatch,
                                                                     String query)
                                                              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 all subscriptions for the user's APIs. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed`

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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)

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

query - Keywords to filter subscriptions (optional)

Returns:

ApiResponse<SubscriptionListDTO>

Throws:

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

subscriptionsGetAsync

public com.squareup.okhttp.Call subscriptionsGetAsync(String apiId,
                                                      Integer limit,
                                                      Integer offset,
                                                      String ifNoneMatch,
                                                      String query,
                                                      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 all subscriptions for the user's APIs. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1/subscriptions?apiId=c43a325c-260b-4302-81cb-768eafaa3aed`

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API I. Should be formatted as **provider-name-version**. (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)

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

query - Keywords to filter subscriptions (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

subscriptionsUnblockSubscriptionPostCall

public com.squareup.okhttp.Call subscriptionsUnblockSubscriptionPostCall(String subscriptionId,
                                                                         String ifMatch,
                                                                         ProgressResponseBody.ProgressListener progressListener,
                                                                         ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                                  throws ApiException

Build call for subscriptionsUnblockSubscriptionPost

Parameters:

subscriptionId - Subscription Id (required)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

subscriptionsUnblockSubscriptionPost

public void subscriptionsUnblockSubscriptionPost(String subscriptionId,
                                                 String ifMatch)
                                          throws ApiException

Unblock a Subscription This operation can be used to unblock a subscription specifying the subscription Id. The subscription will be fully unblocked after performing this operation.

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

subscriptionsUnblockSubscriptionPostWithHttpInfo

public ApiResponse<Void> subscriptionsUnblockSubscriptionPostWithHttpInfo(String subscriptionId,
                                                                          String ifMatch)
                                                                   throws ApiException

Unblock a Subscription This operation can be used to unblock a subscription specifying the subscription Id. The subscription will be fully unblocked after performing this operation.

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

subscriptionsUnblockSubscriptionPostAsync

public com.squareup.okhttp.Call subscriptionsUnblockSubscriptionPostAsync(String subscriptionId,
                                                                          String ifMatch,
                                                                          ApiCallback<Void> callback)
                                                                   throws ApiException

Unblock a Subscription (asynchronously) This operation can be used to unblock a subscription specifying the subscription Id. The subscription will be fully unblocked after performing this operation.

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