org.wso2.carbon.apimgt.rest.integration.tests.api

Class SubscriptionIndividualApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.api.SubscriptionIndividualApi

public class SubscriptionIndividualApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionIndividualApi()
SubscriptionIndividualApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	subscriptionsBlockSubscriptionPost(String subscriptionId, String blockState, String ifMatch, String ifUnmodifiedSince) Block a subscription This operation can be used to block a subscription.
com.squareup.okhttp.Call	subscriptionsBlockSubscriptionPostAsync(String subscriptionId, String blockState, String ifMatch, String ifUnmodifiedSince, ApiCallback<Void> callback) Block a subscription (asynchronously) This operation can be used to block a subscription.
ApiResponse<Void>	subscriptionsBlockSubscriptionPostWithHttpInfo(String subscriptionId, String blockState, String ifMatch, String ifUnmodifiedSince) Block a subscription This operation can be used to block a subscription.
Subscription	subscriptionsSubscriptionIdGet(String subscriptionId, String accept, String ifNoneMatch, String ifModifiedSince) Get details of a subscription This operation can be used to get details of a single subscription.
com.squareup.okhttp.Call	subscriptionsSubscriptionIdGetAsync(String subscriptionId, String accept, String ifNoneMatch, String ifModifiedSince, ApiCallback<Subscription> callback) Get details of a subscription (asynchronously) This operation can be used to get details of a single subscription.
ApiResponse<Subscription>	subscriptionsSubscriptionIdGetWithHttpInfo(String subscriptionId, String accept, String ifNoneMatch, String ifModifiedSince) Get details of a subscription This operation can be used to get details of a single subscription.
void	subscriptionsUnblockSubscriptionPost(String subscriptionId, String ifMatch, String ifUnmodifiedSince) 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, String ifUnmodifiedSince, ApiCallback<Void> callback) Unblock a Subscription (asynchronously) This operation can be used to unblock a subscription specifying the subscription Id.
ApiResponse<Void>	subscriptionsUnblockSubscriptionPostWithHttpInfo(String subscriptionId, String ifMatch, String ifUnmodifiedSince) 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

SubscriptionIndividualApi

public SubscriptionIndividualApi()

SubscriptionIndividualApi

public SubscriptionIndividualApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

subscriptionsBlockSubscriptionPost

public void subscriptionsBlockSubscriptionPost(String subscriptionId,
                                               String blockState,
                                               String ifMatch,
                                               String ifUnmodifiedSince)
                                        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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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,
                                                                        String ifUnmodifiedSince)
                                                                 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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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,
                                                                        String ifUnmodifiedSince,
                                                                        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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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

subscriptionsSubscriptionIdGet

public Subscription subscriptionsSubscriptionIdGet(String subscriptionId,
                                                   String accept,
                                                   String ifNoneMatch,
                                                   String ifModifiedSince)
                                            throws ApiException

Get details of a subscription This operation can be used to get details of a single subscription.

Parameters:

subscriptionId - Subscription Id (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

Subscription

Throws:

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

subscriptionsSubscriptionIdGetWithHttpInfo

public ApiResponse<Subscription> subscriptionsSubscriptionIdGetWithHttpInfo(String subscriptionId,
                                                                            String accept,
                                                                            String ifNoneMatch,
                                                                            String ifModifiedSince)
                                                                     throws ApiException

Get details of a subscription This operation can be used to get details of a single subscription.

Parameters:

subscriptionId - Subscription Id (required)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (optional)

Returns:

ApiResponse<Subscription>

Throws:

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

subscriptionsSubscriptionIdGetAsync

public com.squareup.okhttp.Call subscriptionsSubscriptionIdGetAsync(String subscriptionId,
                                                                    String accept,
                                                                    String ifNoneMatch,
                                                                    String ifModifiedSince,
                                                                    ApiCallback<Subscription> 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)

accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)

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

ifModifiedSince - Validator for conditional requests; based on Last Modified header of the formerly retrieved variant of the resource. (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

subscriptionsUnblockSubscriptionPost

public void subscriptionsUnblockSubscriptionPost(String subscriptionId,
                                                 String ifMatch,
                                                 String ifUnmodifiedSince)
                                          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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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,
                                                                          String ifUnmodifiedSince)
                                                                   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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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,
                                                                          String ifUnmodifiedSince,
                                                                          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)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (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