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

Class SubscriptionCollectionApi

java.lang.Object

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

public class SubscriptionCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SubscriptionCollectionApi()
SubscriptionCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
SubscriptionList	subscriptionsGet(String apiId, Integer limit, Integer offset, String accept, 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, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<SubscriptionList> 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.
ApiResponse<SubscriptionList>	subscriptionsGetWithHttpInfo(String apiId, Integer limit, Integer offset, String accept, 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubscriptionCollectionApi

public SubscriptionCollectionApi()

SubscriptionCollectionApi

public SubscriptionCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

subscriptionsGet

public SubscriptionList subscriptionsGet(String apiId,
                                         Integer limit,
                                         Integer offset,
                                         String accept,
                                         String ifNoneMatch)
                                  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/v1.0/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1.0/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**. (required)

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)

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)

Returns:

SubscriptionList

Throws:

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

subscriptionsGetWithHttpInfo

public ApiResponse<SubscriptionList> subscriptionsGetWithHttpInfo(String apiId,
                                                                  Integer limit,
                                                                  Integer offset,
                                                                  String accept,
                                                                  String ifNoneMatch)
                                                           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/v1.0/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1.0/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**. (required)

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)

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)

Returns:

ApiResponse<SubscriptionList>

Throws:

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

subscriptionsGetAsync

public com.squareup.okhttp.Call subscriptionsGetAsync(String apiId,
                                                      Integer limit,
                                                      Integer offset,
                                                      String accept,
                                                      String ifNoneMatch,
                                                      ApiCallback<SubscriptionList> 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/v1.0/subscriptions` 2. Retrieving subscriptions for a specific API. `GET https://127.0.0.1:9443/api/am/publisher/v1.0/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**. (required)

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)

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)

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