Package 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	Description
SubscriptionsApi()
SubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	blockSubscription(String subscriptionId, String blockState, String ifMatch)	Block a Subscription This operation can be used to block a subscription.
okhttp3.Call	blockSubscriptionAsync(String subscriptionId, String blockState, String ifMatch, ApiCallback<Void> _callback)	Block a Subscription (asynchronously) This operation can be used to block a subscription.
okhttp3.Call	blockSubscriptionCall(String subscriptionId, String blockState, String ifMatch, ApiCallback _callback)	Build call for blockSubscription
ApiResponse<Void>	blockSubscriptionWithHttpInfo(String subscriptionId, String blockState, String ifMatch)	Block a Subscription This operation can be used to block a subscription.
ApiClient	getApiClient()
SubscriptionListDTO	getSubscriptions(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.
okhttp3.Call	getSubscriptionsAsync(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.
okhttp3.Call	getSubscriptionsCall(String apiId, Integer limit, Integer offset, String ifNoneMatch, String query, ApiCallback _callback)	Build call for getSubscriptions
ApiResponse<SubscriptionListDTO>	getSubscriptionsWithHttpInfo(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	setApiClient(ApiClient apiClient)
void	unBlockSubscription(String subscriptionId, String ifMatch)	Unblock a Subscription This operation can be used to unblock a subscription specifying the subscription Id.
okhttp3.Call	unBlockSubscriptionAsync(String subscriptionId, String ifMatch, ApiCallback<Void> _callback)	Unblock a Subscription (asynchronously) This operation can be used to unblock a subscription specifying the subscription Id.
okhttp3.Call	unBlockSubscriptionCall(String subscriptionId, String ifMatch, ApiCallback _callback)	Build call for unBlockSubscription
ApiResponse<Void>	unBlockSubscriptionWithHttpInfo(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)

blockSubscriptionCall

public okhttp3.Call blockSubscriptionCall(String subscriptionId,
                                          String blockState,
                                          String ifMatch,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for blockSubscription

Parameters:

subscriptionId - Subscription Id (required)

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

blockSubscription

public void blockSubscription(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

blockSubscriptionWithHttpInfo

public ApiResponse<Void> blockSubscriptionWithHttpInfo(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

blockSubscriptionAsync

public okhttp3.Call blockSubscriptionAsync(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

getSubscriptionsCall

public okhttp3.Call getSubscriptionsCall(String apiId,
                                         Integer limit,
                                         Integer offset,
                                         String ifNoneMatch,
                                         String query,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getSubscriptions

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**. (optional)

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 - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscriptions

public SubscriptionListDTO getSubscriptions(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/v4/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v4/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**. (optional)

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

getSubscriptionsWithHttpInfo

public ApiResponse<SubscriptionListDTO> getSubscriptionsWithHttpInfo(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/v4/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v4/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**. (optional)

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

getSubscriptionsAsync

public okhttp3.Call getSubscriptionsAsync(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/v4/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v4/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**. (optional)

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

unBlockSubscriptionCall

public okhttp3.Call unBlockSubscriptionCall(String subscriptionId,
                                            String ifMatch,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for unBlockSubscription

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

unBlockSubscription

public void unBlockSubscription(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

unBlockSubscriptionWithHttpInfo

public ApiResponse<Void> unBlockSubscriptionWithHttpInfo(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

unBlockSubscriptionAsync

public okhttp3.Call unBlockSubscriptionAsync(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