org.wso2.am.integration.clients.store.api.v1

Class RatingsApi

java.lang.Object

org.wso2.am.integration.clients.store.api.v1.RatingsApi

public class RatingsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RatingsApi()
RatingsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
RatingListDTO	apisApiIdRatingsGet(String apiId, Integer limit, Integer offset, String xWSO2Tenant) Retrieve API ratings This operation can be used to retrieve the list of ratings of an API.
com.squareup.okhttp.Call	apisApiIdRatingsGetAsync(String apiId, Integer limit, Integer offset, String xWSO2Tenant, ApiCallback<RatingListDTO> callback) Retrieve API ratings (asynchronously) This operation can be used to retrieve the list of ratings of an API.
com.squareup.okhttp.Call	apisApiIdRatingsGetCall(String apiId, Integer limit, Integer offset, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdRatingsGet
ApiResponse<RatingListDTO>	apisApiIdRatingsGetWithHttpInfo(String apiId, Integer limit, Integer offset, String xWSO2Tenant) Retrieve API ratings This operation can be used to retrieve the list of ratings of an API.
void	apisApiIdUserRatingDelete(String apiId, String xWSO2Tenant, String ifMatch) Delete user API rating This operation can be used to delete logged in user API rating.
com.squareup.okhttp.Call	apisApiIdUserRatingDeleteAsync(String apiId, String xWSO2Tenant, String ifMatch, ApiCallback<Void> callback) Delete user API rating (asynchronously) This operation can be used to delete logged in user API rating.
com.squareup.okhttp.Call	apisApiIdUserRatingDeleteCall(String apiId, String xWSO2Tenant, String ifMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdUserRatingDelete
ApiResponse<Void>	apisApiIdUserRatingDeleteWithHttpInfo(String apiId, String xWSO2Tenant, String ifMatch) Delete user API rating This operation can be used to delete logged in user API rating.
RatingDTO	apisApiIdUserRatingGet(String apiId, String xWSO2Tenant, String ifNoneMatch) Retrieve API rating of user This operation can be used to get the user rating of an API.
com.squareup.okhttp.Call	apisApiIdUserRatingGetAsync(String apiId, String xWSO2Tenant, String ifNoneMatch, ApiCallback<RatingDTO> callback) Retrieve API rating of user (asynchronously) This operation can be used to get the user rating of an API.
com.squareup.okhttp.Call	apisApiIdUserRatingGetCall(String apiId, String xWSO2Tenant, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdUserRatingGet
ApiResponse<RatingDTO>	apisApiIdUserRatingGetWithHttpInfo(String apiId, String xWSO2Tenant, String ifNoneMatch) Retrieve API rating of user This operation can be used to get the user rating of an API.
RatingDTO	apisApiIdUserRatingPut(String apiId, RatingDTO body, String xWSO2Tenant) Add or update logged in user's rating for an API This operation can be used to add or update an API rating.
com.squareup.okhttp.Call	apisApiIdUserRatingPutAsync(String apiId, RatingDTO body, String xWSO2Tenant, ApiCallback<RatingDTO> callback) Add or update logged in user's rating for an API (asynchronously) This operation can be used to add or update an API rating.
com.squareup.okhttp.Call	apisApiIdUserRatingPutCall(String apiId, RatingDTO body, String xWSO2Tenant, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdUserRatingPut
ApiResponse<RatingDTO>	apisApiIdUserRatingPutWithHttpInfo(String apiId, RatingDTO body, String xWSO2Tenant) Add or update logged in user's rating for an API This operation can be used to add or update an API rating.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingsApi

public RatingsApi()

RatingsApi

public RatingsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdRatingsGetCall

public com.squareup.okhttp.Call apisApiIdRatingsGetCall(String apiId,
                                                        Integer limit,
                                                        Integer offset,
                                                        String xWSO2Tenant,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for apisApiIdRatingsGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdRatingsGet

public RatingListDTO apisApiIdRatingsGet(String apiId,
                                         Integer limit,
                                         Integer offset,
                                         String xWSO2Tenant)
                                  throws ApiException

Retrieve API ratings This operation can be used to retrieve the list of ratings of an API. `X-WSO2-Tenant` header can be used to retrieve ratings of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

Returns:

RatingListDTO

Throws:

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

apisApiIdRatingsGetWithHttpInfo

public ApiResponse<RatingListDTO> apisApiIdRatingsGetWithHttpInfo(String apiId,
                                                                  Integer limit,
                                                                  Integer offset,
                                                                  String xWSO2Tenant)
                                                           throws ApiException

Retrieve API ratings This operation can be used to retrieve the list of ratings of an API. `X-WSO2-Tenant` header can be used to retrieve ratings of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

Returns:

ApiResponse<RatingListDTO>

Throws:

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

apisApiIdRatingsGetAsync

public com.squareup.okhttp.Call apisApiIdRatingsGetAsync(String apiId,
                                                         Integer limit,
                                                         Integer offset,
                                                         String xWSO2Tenant,
                                                         ApiCallback<RatingListDTO> callback)
                                                  throws ApiException

Retrieve API ratings (asynchronously) This operation can be used to retrieve the list of ratings of an API. `X-WSO2-Tenant` header can be used to retrieve ratings of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (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)

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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apisApiIdUserRatingDeleteCall

public com.squareup.okhttp.Call apisApiIdUserRatingDeleteCall(String apiId,
                                                              String xWSO2Tenant,
                                                              String ifMatch,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException

Build call for apisApiIdUserRatingDelete

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdUserRatingDelete

public void apisApiIdUserRatingDelete(String apiId,
                                      String xWSO2Tenant,
                                      String ifMatch)
                               throws ApiException

Delete user API rating This operation can be used to delete logged in user API rating. `X-WSO2-Tenant` header can be used to delete the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Throws:

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

apisApiIdUserRatingDeleteWithHttpInfo

public ApiResponse<Void> apisApiIdUserRatingDeleteWithHttpInfo(String apiId,
                                                               String xWSO2Tenant,
                                                               String ifMatch)
                                                        throws ApiException

Delete user API rating This operation can be used to delete logged in user API rating. `X-WSO2-Tenant` header can be used to delete the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

ifMatch - Validator for conditional requests; based on ETag. (optional)

Returns:

ApiResponse<Void>

Throws:

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

apisApiIdUserRatingDeleteAsync

public com.squareup.okhttp.Call apisApiIdUserRatingDeleteAsync(String apiId,
                                                               String xWSO2Tenant,
                                                               String ifMatch,
                                                               ApiCallback<Void> callback)
                                                        throws ApiException

Delete user API rating (asynchronously) This operation can be used to delete logged in user API rating. `X-WSO2-Tenant` header can be used to delete the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

ifMatch - Validator for conditional requests; based on ETag. (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

apisApiIdUserRatingGetCall

public com.squareup.okhttp.Call apisApiIdUserRatingGetCall(String apiId,
                                                           String xWSO2Tenant,
                                                           String ifNoneMatch,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for apisApiIdUserRatingGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdUserRatingGet

public RatingDTO apisApiIdUserRatingGet(String apiId,
                                        String xWSO2Tenant,
                                        String ifNoneMatch)
                                 throws ApiException

Retrieve API rating of user This operation can be used to get the user rating of an API. `X-WSO2-Tenant` header can be used to retrieve the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

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

Returns:

RatingDTO

Throws:

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

apisApiIdUserRatingGetWithHttpInfo

public ApiResponse<RatingDTO> apisApiIdUserRatingGetWithHttpInfo(String apiId,
                                                                 String xWSO2Tenant,
                                                                 String ifNoneMatch)
                                                          throws ApiException

Retrieve API rating of user This operation can be used to get the user rating of an API. `X-WSO2-Tenant` header can be used to retrieve the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

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

Returns:

ApiResponse<RatingDTO>

Throws:

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

apisApiIdUserRatingGetAsync

public com.squareup.okhttp.Call apisApiIdUserRatingGetAsync(String apiId,
                                                            String xWSO2Tenant,
                                                            String ifNoneMatch,
                                                            ApiCallback<RatingDTO> callback)
                                                     throws ApiException

Retrieve API rating of user (asynchronously) This operation can be used to get the user rating of an API. `X-WSO2-Tenant` header can be used to retrieve the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

xWSO2Tenant - For cross-tenant invocations, this is used to specify the tenant domain, where the resource need to be retirieved from. (optional)

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

apisApiIdUserRatingPutCall

public com.squareup.okhttp.Call apisApiIdUserRatingPutCall(String apiId,
                                                           RatingDTO body,
                                                           String xWSO2Tenant,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for apisApiIdUserRatingPut

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

body - Rating 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 listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisApiIdUserRatingPut

public RatingDTO apisApiIdUserRatingPut(String apiId,
                                        RatingDTO body,
                                        String xWSO2Tenant)
                                 throws ApiException

Add or update logged in user's rating for an API This operation can be used to add or update an API rating. `X-WSO2-Tenant` header can be used to add or update the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

body - Rating 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)

Returns:

RatingDTO

Throws:

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

apisApiIdUserRatingPutWithHttpInfo

public ApiResponse<RatingDTO> apisApiIdUserRatingPutWithHttpInfo(String apiId,
                                                                 RatingDTO body,
                                                                 String xWSO2Tenant)
                                                          throws ApiException

Add or update logged in user's rating for an API This operation can be used to add or update an API rating. `X-WSO2-Tenant` header can be used to add or update the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

body - Rating 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)

Returns:

ApiResponse<RatingDTO>

Throws:

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

apisApiIdUserRatingPutAsync

public com.squareup.okhttp.Call apisApiIdUserRatingPutAsync(String apiId,
                                                            RatingDTO body,
                                                            String xWSO2Tenant,
                                                            ApiCallback<RatingDTO> callback)
                                                     throws ApiException

Add or update logged in user's rating for an API (asynchronously) This operation can be used to add or update an API rating. `X-WSO2-Tenant` header can be used to add or update the logged in user rating of an API that belongs to a different tenant domain. If not specified super tenant will be used. If Authorization header is present in the request, the user's tenant associated with the access token will be used.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. (required)

body - Rating 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 finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object