public class SubscriptionsApi extends Object
| Constructor and Description |
|---|
SubscriptionsApi() |
SubscriptionsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ApiClient |
getApiClient() |
void |
setApiClient(ApiClient apiClient) |
SubscriptionListDTO |
subscriptionsGet(String apiId,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch)
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,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch,
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,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsGet
|
ApiResponse<SubscriptionListDTO> |
subscriptionsGetWithHttpInfo(String apiId,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch)
Get all subscriptions
This operation can be used to retrieve a list of subscriptions of the user associated with the provided access token.
|
List<SubscriptionDTO> |
subscriptionsMultiplePost(List<SubscriptionDTO> body,
String xWSO2Tenant)
Add new subscriptions
This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
|
com.squareup.okhttp.Call |
subscriptionsMultiplePostAsync(List<SubscriptionDTO> body,
String xWSO2Tenant,
ApiCallback<List<SubscriptionDTO>> callback)
Add new subscriptions (asynchronously)
This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
|
com.squareup.okhttp.Call |
subscriptionsMultiplePostCall(List<SubscriptionDTO> body,
String xWSO2Tenant,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsMultiplePost
|
ApiResponse<List<SubscriptionDTO>> |
subscriptionsMultiplePostWithHttpInfo(List<SubscriptionDTO> body,
String xWSO2Tenant)
Add new subscriptions
This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
|
SubscriptionDTO |
subscriptionsPost(SubscriptionDTO body,
String xWSO2Tenant)
Add a new subscription
This operation can be used to add a new subscription providing the id of the API and the application.
|
com.squareup.okhttp.Call |
subscriptionsPostAsync(SubscriptionDTO body,
String xWSO2Tenant,
ApiCallback<SubscriptionDTO> callback)
Add a new subscription (asynchronously)
This operation can be used to add a new subscription providing the id of the API and the application.
|
com.squareup.okhttp.Call |
subscriptionsPostCall(SubscriptionDTO body,
String xWSO2Tenant,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsPost
|
ApiResponse<SubscriptionDTO> |
subscriptionsPostWithHttpInfo(SubscriptionDTO body,
String xWSO2Tenant)
Add a new subscription
This operation can be used to add a new subscription providing the id of the API and the application.
|
void |
subscriptionsSubscriptionIdDelete(String subscriptionId,
String ifMatch)
Remove a subscription
This operation can be used to remove a subscription.
|
com.squareup.okhttp.Call |
subscriptionsSubscriptionIdDeleteAsync(String subscriptionId,
String ifMatch,
ApiCallback<Void> callback)
Remove a subscription (asynchronously)
This operation can be used to remove a subscription.
|
com.squareup.okhttp.Call |
subscriptionsSubscriptionIdDeleteCall(String subscriptionId,
String ifMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsSubscriptionIdDelete
|
ApiResponse<Void> |
subscriptionsSubscriptionIdDeleteWithHttpInfo(String subscriptionId,
String ifMatch)
Remove a subscription
This operation can be used to remove a subscription.
|
SubscriptionDTO |
subscriptionsSubscriptionIdGet(String subscriptionId,
String ifNoneMatch)
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 ifNoneMatch,
ApiCallback<SubscriptionDTO> callback)
Get details of a subscription (asynchronously)
This operation can be used to get details of a single subscription.
|
com.squareup.okhttp.Call |
subscriptionsSubscriptionIdGetCall(String subscriptionId,
String ifNoneMatch,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsSubscriptionIdGet
|
ApiResponse<SubscriptionDTO> |
subscriptionsSubscriptionIdGetWithHttpInfo(String subscriptionId,
String ifNoneMatch)
Get details of a subscription
This operation can be used to get details of a single subscription.
|
SubscriptionDTO |
subscriptionsSubscriptionIdPut(SubscriptionDTO body,
String subscriptionId,
String xWSO2Tenant)
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.
|
com.squareup.okhttp.Call |
subscriptionsSubscriptionIdPutAsync(SubscriptionDTO body,
String subscriptionId,
String xWSO2Tenant,
ApiCallback<SubscriptionDTO> callback)
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.
|
com.squareup.okhttp.Call |
subscriptionsSubscriptionIdPutCall(SubscriptionDTO body,
String subscriptionId,
String xWSO2Tenant,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for subscriptionsSubscriptionIdPut
|
ApiResponse<SubscriptionDTO> |
subscriptionsSubscriptionIdPutWithHttpInfo(SubscriptionDTO body,
String subscriptionId,
String xWSO2Tenant)
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.
|
public SubscriptionsApi()
public SubscriptionsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public com.squareup.okhttp.Call subscriptionsGetCall(String apiId, String applicationId, String groupId, String xWSO2Tenant, Integer offset, Integer limit, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
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 retirieved 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)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic SubscriptionListDTO subscriptionsGet(String apiId, String applicationId, String groupId, String xWSO2Tenant, Integer offset, Integer limit, String ifNoneMatch) throws ApiException
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 retirieved 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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionListDTO> subscriptionsGetWithHttpInfo(String apiId, String applicationId, String groupId, String xWSO2Tenant, Integer offset, Integer limit, String ifNoneMatch) throws ApiException
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 retirieved 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)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsGetAsync(String apiId, String applicationId, String groupId, String xWSO2Tenant, Integer offset, Integer limit, String ifNoneMatch, ApiCallback<SubscriptionListDTO> callback) throws ApiException
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 retirieved 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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call subscriptionsMultiplePostCall(List<SubscriptionDTO> body, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
body - 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 retirieved from. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic List<SubscriptionDTO> subscriptionsMultiplePost(List<SubscriptionDTO> body, String xWSO2Tenant) throws ApiException
body - 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 retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<SubscriptionDTO>> subscriptionsMultiplePostWithHttpInfo(List<SubscriptionDTO> body, String xWSO2Tenant) throws ApiException
body - 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 retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsMultiplePostAsync(List<SubscriptionDTO> body, String xWSO2Tenant, ApiCallback<List<SubscriptionDTO>> callback) throws ApiException
body - 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 retirieved from. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call subscriptionsPostCall(SubscriptionDTO body, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
body - 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 retirieved from. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic SubscriptionDTO subscriptionsPost(SubscriptionDTO body, String xWSO2Tenant) throws ApiException
body - 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 retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionDTO> subscriptionsPostWithHttpInfo(SubscriptionDTO body, String xWSO2Tenant) throws ApiException
body - 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 retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsPostAsync(SubscriptionDTO body, String xWSO2Tenant, ApiCallback<SubscriptionDTO> callback) throws ApiException
body - 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 retirieved from. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call subscriptionsSubscriptionIdDeleteCall(String subscriptionId, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
subscriptionId - Subscription Id (required)ifMatch - Validator for conditional requests; based on ETag. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void subscriptionsSubscriptionIdDelete(String subscriptionId, String ifMatch) throws ApiException
subscriptionId - Subscription Id (required)ifMatch - Validator for conditional requests; based on ETag. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> subscriptionsSubscriptionIdDeleteWithHttpInfo(String subscriptionId, String ifMatch) throws ApiException
subscriptionId - Subscription Id (required)ifMatch - Validator for conditional requests; based on ETag. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsSubscriptionIdDeleteAsync(String subscriptionId, String ifMatch, ApiCallback<Void> callback) throws ApiException
subscriptionId - Subscription Id (required)ifMatch - Validator for conditional requests; based on ETag. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call subscriptionsSubscriptionIdGetCall(String subscriptionId, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
subscriptionId - Subscription Id (required)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic SubscriptionDTO subscriptionsSubscriptionIdGet(String subscriptionId, String ifNoneMatch) throws ApiException
subscriptionId - Subscription Id (required)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionDTO> subscriptionsSubscriptionIdGetWithHttpInfo(String subscriptionId, String ifNoneMatch) throws ApiException
subscriptionId - Subscription Id (required)ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsSubscriptionIdGetAsync(String subscriptionId, String ifNoneMatch, ApiCallback<SubscriptionDTO> callback) throws ApiException
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 finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call subscriptionsSubscriptionIdPutCall(SubscriptionDTO body, String subscriptionId, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
body - Subscription object that should to be added (required)subscriptionId - Subscription Id (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic SubscriptionDTO subscriptionsSubscriptionIdPut(SubscriptionDTO body, String subscriptionId, String xWSO2Tenant) throws ApiException
body - Subscription object that should to be added (required)subscriptionId - Subscription Id (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionDTO> subscriptionsSubscriptionIdPutWithHttpInfo(SubscriptionDTO body, String subscriptionId, String xWSO2Tenant) throws ApiException
body - Subscription object that should to be added (required)subscriptionId - Subscription Id (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call subscriptionsSubscriptionIdPutAsync(SubscriptionDTO body, String subscriptionId, String xWSO2Tenant, ApiCallback<SubscriptionDTO> callback) throws ApiException
body - Subscription object that should to be added (required)subscriptionId - Subscription Id (required)xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2020 WSO2 Inc. All rights reserved.