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

Class RatingsApi

  • public class RatingsApi
extends Object

    • Constructor Detail

      • RatingsApi

        public RatingsApi()

      • RatingsApi

        public RatingsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • apisApiIdRatingsGetCall

        public okhttp3.Call apisApiIdRatingsGetCall​(String apiId,
                                            Integer limit,
                                            Integer offset,
                                            String xWSO2Tenant,
                                            ApiCallback _callback)
                                     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 retrieved from. (optional)
        _callback - Callback for upload/download progress
        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 retrieved 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 retrieved 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 okhttp3.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 retrieved 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 okhttp3.Call apisApiIdUserRatingDeleteCall​(String apiId,
                                                  String xWSO2Tenant,
                                                  String ifMatch,
                                                  ApiCallback _callback)
                                           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 retrieved from. (optional)
        ifMatch - Validator for conditional requests; based on ETag. (optional)
        _callback - Callback for upload/download progress
        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 retrieved 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 retrieved 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 okhttp3.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 retrieved 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 okhttp3.Call apisApiIdUserRatingGetCall​(String apiId,
                                               String xWSO2Tenant,
                                               String ifNoneMatch,
                                               ApiCallback _callback)
                                        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 retrieved from. (optional)
        ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)
        _callback - Callback for upload/download progress
        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 retrieved 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 retrieved 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 okhttp3.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 retrieved 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 okhttp3.Call apisApiIdUserRatingPutCall​(String apiId,
                                               RatingDTO ratingDTO,
                                               String xWSO2Tenant,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for apisApiIdUserRatingPut
        Parameters:
        apiId - **API ID** consisting of the **UUID** of the API. (required)
        ratingDTO - 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 retrieved from. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apisApiIdUserRatingPut

        public RatingDTO apisApiIdUserRatingPut​(String apiId,
                                        RatingDTO ratingDTO,
                                        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)
        ratingDTO - 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 retrieved 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 ratingDTO,
                                                                 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)
        ratingDTO - 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 retrieved 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 okhttp3.Call apisApiIdUserRatingPutAsync​(String apiId,
                                                RatingDTO ratingDTO,
                                                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)
        ratingDTO - 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 retrieved 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