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.
|
okhttp3.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.
|
okhttp3.Call |
subscriptionsGetCall(String apiId,
String applicationId,
String groupId,
String xWSO2Tenant,
Integer offset,
Integer limit,
String ifNoneMatch,
ApiCallback _callback)
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> subscriptionDTO,
String xWSO2Tenant)
Add New Subscriptions
This operation can be used to add a new subscriptions providing the ids of the APIs and the applications.
|
okhttp3.Call |
subscriptionsMultiplePostAsync(List<SubscriptionDTO> subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsMultiplePostCall(List<SubscriptionDTO> subscriptionDTO,
String xWSO2Tenant,
ApiCallback _callback)
Build call for subscriptionsMultiplePost
|
ApiResponse<List<SubscriptionDTO>> |
subscriptionsMultiplePostWithHttpInfo(List<SubscriptionDTO> subscriptionDTO,
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 subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsPostAsync(SubscriptionDTO subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsPostCall(SubscriptionDTO subscriptionDTO,
String xWSO2Tenant,
ApiCallback _callback)
Build call for subscriptionsPost
|
ApiResponse<SubscriptionDTO> |
subscriptionsPostWithHttpInfo(SubscriptionDTO subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsSubscriptionIdDeleteAsync(String subscriptionId,
String ifMatch,
ApiCallback<Void> _callback)
Remove a Subscription (asynchronously)
This operation can be used to remove a subscription.
|
okhttp3.Call |
subscriptionsSubscriptionIdDeleteCall(String subscriptionId,
String ifMatch,
ApiCallback _callback)
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.
|
okhttp3.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.
|
okhttp3.Call |
subscriptionsSubscriptionIdGetCall(String subscriptionId,
String ifNoneMatch,
ApiCallback _callback)
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(String subscriptionId,
SubscriptionDTO subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsSubscriptionIdPutAsync(String subscriptionId,
SubscriptionDTO subscriptionDTO,
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.
|
okhttp3.Call |
subscriptionsSubscriptionIdPutCall(String subscriptionId,
SubscriptionDTO subscriptionDTO,
String xWSO2Tenant,
ApiCallback _callback)
Build call for subscriptionsSubscriptionIdPut
|
ApiResponse<SubscriptionDTO> |
subscriptionsSubscriptionIdPutWithHttpInfo(String subscriptionId,
SubscriptionDTO subscriptionDTO,
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 okhttp3.Call subscriptionsGetCall(String apiId, String applicationId, String groupId, String xWSO2Tenant, Integer offset, Integer limit, String ifNoneMatch, ApiCallback _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 retrieved 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 - Callback for upload/download progressApiException - 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 retrieved 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 retrieved 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 okhttp3.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 retrieved 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 okhttp3.Call subscriptionsMultiplePostCall(List<SubscriptionDTO> subscriptionDTO, String xWSO2Tenant, ApiCallback _callback) throws ApiException
subscriptionDTO - 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 retrieved from. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic List<SubscriptionDTO> subscriptionsMultiplePost(List<SubscriptionDTO> subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionDTO - 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 retrieved 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> subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionDTO - 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 retrieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call subscriptionsMultiplePostAsync(List<SubscriptionDTO> subscriptionDTO, String xWSO2Tenant, ApiCallback<List<SubscriptionDTO>> _callback) throws ApiException
subscriptionDTO - 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 retrieved 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 okhttp3.Call subscriptionsPostCall(SubscriptionDTO subscriptionDTO, String xWSO2Tenant, ApiCallback _callback) throws ApiException
subscriptionDTO - 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 retrieved from. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic SubscriptionDTO subscriptionsPost(SubscriptionDTO subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionDTO - 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 retrieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionDTO> subscriptionsPostWithHttpInfo(SubscriptionDTO subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionDTO - 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 retrieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call subscriptionsPostAsync(SubscriptionDTO subscriptionDTO, String xWSO2Tenant, ApiCallback<SubscriptionDTO> _callback) throws ApiException
subscriptionDTO - 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 retrieved 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 okhttp3.Call subscriptionsSubscriptionIdDeleteCall(String subscriptionId, String ifMatch, ApiCallback _callback) throws ApiException
subscriptionId - Subscription Id (required)ifMatch - Validator for conditional requests; based on ETag. (optional)_callback - Callback for upload/download progressApiException - 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 okhttp3.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 okhttp3.Call subscriptionsSubscriptionIdGetCall(String subscriptionId, String ifNoneMatch, ApiCallback _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 - Callback for upload/download progressApiException - 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 okhttp3.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 okhttp3.Call subscriptionsSubscriptionIdPutCall(String subscriptionId, SubscriptionDTO subscriptionDTO, String xWSO2Tenant, ApiCallback _callback) throws ApiException
subscriptionId - Subscription Id (required)subscriptionDTO - 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 retrieved from. (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body objectpublic SubscriptionDTO subscriptionsSubscriptionIdPut(String subscriptionId, SubscriptionDTO subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionId - Subscription Id (required)subscriptionDTO - 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 retrieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<SubscriptionDTO> subscriptionsSubscriptionIdPutWithHttpInfo(String subscriptionId, SubscriptionDTO subscriptionDTO, String xWSO2Tenant) throws ApiException
subscriptionId - Subscription Id (required)subscriptionDTO - 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 retrieved from. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call subscriptionsSubscriptionIdPutAsync(String subscriptionId, SubscriptionDTO subscriptionDTO, String xWSO2Tenant, ApiCallback<SubscriptionDTO> _callback) throws ApiException
subscriptionId - Subscription Id (required)subscriptionDTO - 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 retrieved 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 © 2021 WSO2 Inc. All rights reserved.