Api

Class SubscriptionsApi

java.lang.Object

Api.SubscriptionsApi

public class SubscriptionsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionsApi()
SubscriptionsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ActivateSubscriptionResponse	activateSubscription(String id) Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription
okhttp3.Call	activateSubscriptionAsync(String id, ApiCallback<ActivateSubscriptionResponse> callback) Activate a Subscription (asynchronously) Activate a `CANCELLED` Or `SUSPENDED` Subscription
okhttp3.Call	activateSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for activateSubscription
ApiResponse<ActivateSubscriptionResponse>	activateSubscriptionWithHttpInfo(String id) Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription
CancelSubscriptionResponse	cancelSubscription(String id) Cancel a Subscription Cancel a Subscription
okhttp3.Call	cancelSubscriptionAsync(String id, ApiCallback<CancelSubscriptionResponse> callback) Cancel a Subscription (asynchronously) Cancel a Subscription
okhttp3.Call	cancelSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for cancelSubscription
ApiResponse<CancelSubscriptionResponse>	cancelSubscriptionWithHttpInfo(String id) Cancel a Subscription Cancel a Subscription
CreateSubscriptionResponse	createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Create a Subscription Create a Recurring Billing Subscription
okhttp3.Call	createSubscriptionAsync(CreateSubscriptionRequest createSubscriptionRequest, ApiCallback<CreateSubscriptionResponse> callback) Create a Subscription (asynchronously) Create a Recurring Billing Subscription
okhttp3.Call	createSubscriptionCall(CreateSubscriptionRequest createSubscriptionRequest, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createSubscription
ApiResponse<CreateSubscriptionResponse>	createSubscriptionWithHttpInfo(CreateSubscriptionRequest createSubscriptionRequest) Create a Subscription Create a Recurring Billing Subscription
GetAllSubscriptionsResponse	getAllSubscriptions(Integer offset, Integer limit, String code, String status) Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
okhttp3.Call	getAllSubscriptionsAsync(Integer offset, Integer limit, String code, String status, ApiCallback<GetAllSubscriptionsResponse> callback) Get a List of Subscriptions (asynchronously) Retrieve Subscriptions by Subscription Code & Subscription Status.
okhttp3.Call	getAllSubscriptionsCall(Integer offset, Integer limit, String code, String status, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllSubscriptions
ApiResponse<GetAllSubscriptionsResponse>	getAllSubscriptionsWithHttpInfo(Integer offset, Integer limit, String code, String status) Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
ApiClient	getApiClient()
GetSubscriptionResponse	getSubscription(String id) Get a Subscription Get a Subscription by Subscription Id
okhttp3.Call	getSubscriptionAsync(String id, ApiCallback<GetSubscriptionResponse> callback) Get a Subscription (asynchronously) Get a Subscription by Subscription Id
okhttp3.Call	getSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSubscription
GetSubscriptionCodeResponse	getSubscriptionCode() Get a Subscription Code Get a Unique Subscription Code
okhttp3.Call	getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback) Get a Subscription Code (asynchronously) Get a Unique Subscription Code
okhttp3.Call	getSubscriptionCodeCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getSubscriptionCode
ApiResponse<GetSubscriptionCodeResponse>	getSubscriptionCodeWithHttpInfo() Get a Subscription Code Get a Unique Subscription Code
ApiResponse<GetSubscriptionResponse>	getSubscriptionWithHttpInfo(String id) Get a Subscription Get a Subscription by Subscription Id
void	setApiClient(ApiClient apiClient)
SuspendSubscriptionResponse	suspendSubscription(String id) Suspend a Subscription Suspend a Subscription
okhttp3.Call	suspendSubscriptionAsync(String id, ApiCallback<SuspendSubscriptionResponse> callback) Suspend a Subscription (asynchronously) Suspend a Subscription
okhttp3.Call	suspendSubscriptionCall(String id, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for suspendSubscription
ApiResponse<SuspendSubscriptionResponse>	suspendSubscriptionWithHttpInfo(String id) Suspend a Subscription Suspend a Subscription
UpdateSubscriptionResponse	updateSubscription(String id, UpdateSubscription updateSubscription) Update a Subscription Update a Subscription by Subscription Id
okhttp3.Call	updateSubscriptionAsync(String id, UpdateSubscription updateSubscription, ApiCallback<UpdateSubscriptionResponse> callback) Update a Subscription (asynchronously) Update a Subscription by Subscription Id
okhttp3.Call	updateSubscriptionCall(String id, UpdateSubscription updateSubscription, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateSubscription
ApiResponse<UpdateSubscriptionResponse>	updateSubscriptionWithHttpInfo(String id, UpdateSubscription updateSubscription) Update a Subscription Update a Subscription by 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)

activateSubscriptionCall

public okhttp3.Call activateSubscriptionCall(String id,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for activateSubscription

Parameters:

id - Subscription Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

activateSubscription

public ActivateSubscriptionResponse activateSubscription(String id)
                                                  throws ApiException

Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription

Parameters:

id - Subscription Id (required)

Returns:

ActivateSubscriptionResponse

Throws:

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

activateSubscriptionWithHttpInfo

public ApiResponse<ActivateSubscriptionResponse> activateSubscriptionWithHttpInfo(String id)
                                                                           throws ApiException

Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription

Parameters:

id - Subscription Id (required)

Returns:

ApiResponse<ActivateSubscriptionResponse>

Throws:

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

activateSubscriptionAsync

public okhttp3.Call activateSubscriptionAsync(String id,
                                              ApiCallback<ActivateSubscriptionResponse> callback)
                                       throws ApiException

Activate a Subscription (asynchronously) Activate a `CANCELLED` Or `SUSPENDED` Subscription

Parameters:

id - Subscription Id (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

cancelSubscriptionCall

public okhttp3.Call cancelSubscriptionCall(String id,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for cancelSubscription

Parameters:

id - Subscription Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

cancelSubscription

public CancelSubscriptionResponse cancelSubscription(String id)
                                              throws ApiException

Cancel a Subscription Cancel a Subscription

Parameters:

id - Subscription Id (required)

Returns:

CancelSubscriptionResponse

Throws:

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

cancelSubscriptionWithHttpInfo

public ApiResponse<CancelSubscriptionResponse> cancelSubscriptionWithHttpInfo(String id)
                                                                       throws ApiException

Cancel a Subscription Cancel a Subscription

Parameters:

id - Subscription Id (required)

Returns:

ApiResponse<CancelSubscriptionResponse>

Throws:

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

cancelSubscriptionAsync

public okhttp3.Call cancelSubscriptionAsync(String id,
                                            ApiCallback<CancelSubscriptionResponse> callback)
                                     throws ApiException

Cancel a Subscription (asynchronously) Cancel a Subscription

Parameters:

id - Subscription Id (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

createSubscriptionCall

public okhttp3.Call createSubscriptionCall(CreateSubscriptionRequest createSubscriptionRequest,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for createSubscription

Parameters:

createSubscriptionRequest - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createSubscription

public CreateSubscriptionResponse createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
                                              throws ApiException

Create a Subscription Create a Recurring Billing Subscription

Parameters:

createSubscriptionRequest - (required)

Returns:

CreateSubscriptionResponse

Throws:

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

createSubscriptionWithHttpInfo

public ApiResponse<CreateSubscriptionResponse> createSubscriptionWithHttpInfo(CreateSubscriptionRequest createSubscriptionRequest)
                                                                       throws ApiException

Create a Subscription Create a Recurring Billing Subscription

Parameters:

createSubscriptionRequest - (required)

Returns:

ApiResponse<CreateSubscriptionResponse>

Throws:

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

createSubscriptionAsync

public okhttp3.Call createSubscriptionAsync(CreateSubscriptionRequest createSubscriptionRequest,
                                            ApiCallback<CreateSubscriptionResponse> callback)
                                     throws ApiException

Create a Subscription (asynchronously) Create a Recurring Billing Subscription

Parameters:

createSubscriptionRequest - (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

getAllSubscriptionsCall

public okhttp3.Call getAllSubscriptionsCall(Integer offset,
                                            Integer limit,
                                            String code,
                                            String status,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getAllSubscriptions

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Subscription Code (optional)

status - Filter by Subscription Status (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllSubscriptions

public GetAllSubscriptionsResponse getAllSubscriptions(Integer offset,
                                                       Integer limit,
                                                       String code,
                                                       String status)
                                                throws ApiException

Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Subscription Code (optional)

status - Filter by Subscription Status (optional)

Returns:

GetAllSubscriptionsResponse

Throws:

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

getAllSubscriptionsWithHttpInfo

public ApiResponse<GetAllSubscriptionsResponse> getAllSubscriptionsWithHttpInfo(Integer offset,
                                                                                Integer limit,
                                                                                String code,
                                                                                String status)
                                                                         throws ApiException

Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Subscription Code (optional)

status - Filter by Subscription Status (optional)

Returns:

ApiResponse<GetAllSubscriptionsResponse>

Throws:

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

getAllSubscriptionsAsync

public okhttp3.Call getAllSubscriptionsAsync(Integer offset,
                                             Integer limit,
                                             String code,
                                             String status,
                                             ApiCallback<GetAllSubscriptionsResponse> callback)
                                      throws ApiException

Get a List of Subscriptions (asynchronously) Retrieve Subscriptions by Subscription Code & Subscription Status.

Parameters:

offset - Page offset number. (optional)

limit - Number of items to be returned. Default - `20`, Max - `100` (optional)

code - Filter by Subscription Code (optional)

status - Filter by Subscription Status (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

getSubscriptionCall

public okhttp3.Call getSubscriptionCall(String id,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws ApiException

Build call for getSubscription

Parameters:

id - Subscription Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscription

public GetSubscriptionResponse getSubscription(String id)
                                        throws ApiException

Get a Subscription Get a Subscription by Subscription Id

Parameters:

id - Subscription Id (required)

Returns:

GetSubscriptionResponse

Throws:

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

getSubscriptionWithHttpInfo

public ApiResponse<GetSubscriptionResponse> getSubscriptionWithHttpInfo(String id)
                                                                 throws ApiException

Get a Subscription Get a Subscription by Subscription Id

Parameters:

id - Subscription Id (required)

Returns:

ApiResponse<GetSubscriptionResponse>

Throws:

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

getSubscriptionAsync

public okhttp3.Call getSubscriptionAsync(String id,
                                         ApiCallback<GetSubscriptionResponse> callback)
                                  throws ApiException

Get a Subscription (asynchronously) Get a Subscription by Subscription Id

Parameters:

id - Subscription Id (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

getSubscriptionCodeCall

public okhttp3.Call getSubscriptionCodeCall(ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getSubscriptionCode

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSubscriptionCode

public GetSubscriptionCodeResponse getSubscriptionCode()
                                                throws ApiException

Get a Subscription Code Get a Unique Subscription Code

Returns:

GetSubscriptionCodeResponse

Throws:

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

getSubscriptionCodeWithHttpInfo

public ApiResponse<GetSubscriptionCodeResponse> getSubscriptionCodeWithHttpInfo()
                                                                         throws ApiException

Get a Subscription Code Get a Unique Subscription Code

Returns:

ApiResponse<GetSubscriptionCodeResponse>

Throws:

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

getSubscriptionCodeAsync

public okhttp3.Call getSubscriptionCodeAsync(ApiCallback<GetSubscriptionCodeResponse> callback)
                                      throws ApiException

Get a Subscription Code (asynchronously) Get a Unique Subscription Code

Parameters:

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

suspendSubscriptionCall

public okhttp3.Call suspendSubscriptionCall(String id,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for suspendSubscription

Parameters:

id - Subscription Id (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

suspendSubscription

public SuspendSubscriptionResponse suspendSubscription(String id)
                                                throws ApiException

Suspend a Subscription Suspend a Subscription

Parameters:

id - Subscription Id (required)

Returns:

SuspendSubscriptionResponse

Throws:

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

suspendSubscriptionWithHttpInfo

public ApiResponse<SuspendSubscriptionResponse> suspendSubscriptionWithHttpInfo(String id)
                                                                         throws ApiException

Suspend a Subscription Suspend a Subscription

Parameters:

id - Subscription Id (required)

Returns:

ApiResponse<SuspendSubscriptionResponse>

Throws:

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

suspendSubscriptionAsync

public okhttp3.Call suspendSubscriptionAsync(String id,
                                             ApiCallback<SuspendSubscriptionResponse> callback)
                                      throws ApiException

Suspend a Subscription (asynchronously) Suspend a Subscription

Parameters:

id - Subscription Id (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

updateSubscriptionCall

public okhttp3.Call updateSubscriptionCall(String id,
                                           UpdateSubscription updateSubscription,
                                           ProgressResponseBody.ProgressListener progressListener,
                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                    throws ApiException

Build call for updateSubscription

Parameters:

id - Subscription Id (required)

updateSubscription - Update Subscription (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateSubscription

public UpdateSubscriptionResponse updateSubscription(String id,
                                                     UpdateSubscription updateSubscription)
                                              throws ApiException

Update a Subscription Update a Subscription by Subscription Id

Parameters:

id - Subscription Id (required)

updateSubscription - Update Subscription (required)

Returns:

UpdateSubscriptionResponse

Throws:

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

updateSubscriptionWithHttpInfo

public ApiResponse<UpdateSubscriptionResponse> updateSubscriptionWithHttpInfo(String id,
                                                                              UpdateSubscription updateSubscription)
                                                                       throws ApiException

Update a Subscription Update a Subscription by Subscription Id

Parameters:

id - Subscription Id (required)

updateSubscription - Update Subscription (required)

Returns:

ApiResponse<UpdateSubscriptionResponse>

Throws:

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

updateSubscriptionAsync

public okhttp3.Call updateSubscriptionAsync(String id,
                                            UpdateSubscription updateSubscription,
                                            ApiCallback<UpdateSubscriptionResponse> callback)
                                     throws ApiException

Update a Subscription (asynchronously) Update a Subscription by Subscription Id

Parameters:

id - Subscription Id (required)

updateSubscription - Update Subscription (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