Package org.wso2.am.integration.clients.internal.api

Class SubscriptionValidationApi

  • public class SubscriptionValidationApi
extends Object

    • Constructor Detail

      • SubscriptionValidationApi

        public SubscriptionValidationApi()

      • SubscriptionValidationApi

        public SubscriptionValidationApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • apiPoliciesGetCall

        public com.squareup.okhttp.Call apiPoliciesGetCall​(String xWSO2Tenant,
                                                   String policyName,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException
        Build call for apiPoliciesGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Api policy name (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apiPoliciesGet

        public ApiPolicyListDTO apiPoliciesGet​(String xWSO2Tenant,
                                       String policyName)
                                throws ApiException
        Get all API throttling policies This will provide access to api level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Api policy name (optional)
        Returns:
        ApiPolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apiPoliciesGetWithHttpInfo

        public ApiResponse<ApiPolicyListDTO> apiPoliciesGetWithHttpInfo​(String xWSO2Tenant,
                                                                String policyName)
                                                         throws ApiException
        Get all API throttling policies This will provide access to api level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Api policy name (optional)
        Returns:
        ApiResponse<ApiPolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apiPoliciesGetAsync

        public com.squareup.okhttp.Call apiPoliciesGetAsync​(String xWSO2Tenant,
                                                    String policyName,
                                                    ApiCallback<ApiPolicyListDTO> callback)
                                             throws ApiException
        Get all API throttling policies (asynchronously) This will provide access to api level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Api policy name (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

      • apisGetCall

        public com.squareup.okhttp.Call apisGetCall​(String xWSO2Tenant,
                                            String apiId,
                                            String context,
                                            String version,
                                            String gatewayLabel,
                                            String accept,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException
        Build call for apisGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID (optional)
        context - **Search condition**. context of the api (optional)
        version - **Search condition**. versio of the api (optional)
        gatewayLabel - **Search condition**. label associated with the APIs (optional)
        accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • apisGet

        public APIListDTO apisGet​(String xWSO2Tenant,
                          String apiId,
                          String context,
                          String version,
                          String gatewayLabel,
                          String accept)
                   throws ApiException
        Get all apis This will provide access to apis in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID (optional)
        context - **Search condition**. context of the api (optional)
        version - **Search condition**. versio of the api (optional)
        gatewayLabel - **Search condition**. label associated with the APIs (optional)
        accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)
        Returns:
        APIListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisGetWithHttpInfo

        public ApiResponse<APIListDTO> apisGetWithHttpInfo​(String xWSO2Tenant,
                                                   String apiId,
                                                   String context,
                                                   String version,
                                                   String gatewayLabel,
                                                   String accept)
                                            throws ApiException
        Get all apis This will provide access to apis in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID (optional)
        context - **Search condition**. context of the api (optional)
        version - **Search condition**. versio of the api (optional)
        gatewayLabel - **Search condition**. label associated with the APIs (optional)
        accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)
        Returns:
        ApiResponse<APIListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • apisGetAsync

        public com.squareup.okhttp.Call apisGetAsync​(String xWSO2Tenant,
                                             String apiId,
                                             String context,
                                             String version,
                                             String gatewayLabel,
                                             String accept,
                                             ApiCallback<APIListDTO> callback)
                                      throws ApiException
        Get all apis (asynchronously) This will provide access to apis in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID (optional)
        context - **Search condition**. context of the api (optional)
        version - **Search condition**. versio of the api (optional)
        gatewayLabel - **Search condition**. label associated with the APIs (optional)
        accept - Media types acceptable for the response. Default is application/json. (optional, default to application/json)
        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

      • applicationKeyMappingsGetCall

        public com.squareup.okhttp.Call applicationKeyMappingsGetCall​(String xWSO2Tenant,
                                                              String consumerKey,
                                                              String keymanager,
                                                              ProgressResponseBody.ProgressListener progressListener,
                                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                       throws ApiException
        Build call for applicationKeyMappingsGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        consumerKey - **Search condition**. Consumer Key of the application (optional)
        keymanager - **Search condition**. KeyManager associated to consumer_key of the application (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • applicationKeyMappingsGet

        public ApplicationKeyMappingListDTO applicationKeyMappingsGet​(String xWSO2Tenant,
                                                              String consumerKey,
                                                              String keymanager)
                                                       throws ApiException
        Get all application key mappings This will provide access to application vs key mappings in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        consumerKey - **Search condition**. Consumer Key of the application (optional)
        keymanager - **Search condition**. KeyManager associated to consumer_key of the application (optional)
        Returns:
        ApplicationKeyMappingListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationKeyMappingsGetWithHttpInfo

        public ApiResponse<ApplicationKeyMappingListDTO> applicationKeyMappingsGetWithHttpInfo​(String xWSO2Tenant,
                                                                                       String consumerKey,
                                                                                       String keymanager)
                                                                                throws ApiException
        Get all application key mappings This will provide access to application vs key mappings in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        consumerKey - **Search condition**. Consumer Key of the application (optional)
        keymanager - **Search condition**. KeyManager associated to consumer_key of the application (optional)
        Returns:
        ApiResponse<ApplicationKeyMappingListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationKeyMappingsGetAsync

        public com.squareup.okhttp.Call applicationKeyMappingsGetAsync​(String xWSO2Tenant,
                                                               String consumerKey,
                                                               String keymanager,
                                                               ApiCallback<ApplicationKeyMappingListDTO> callback)
                                                        throws ApiException
        Get all application key mappings (asynchronously) This will provide access to application vs key mappings in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        consumerKey - **Search condition**. Consumer Key of the application (optional)
        keymanager - **Search condition**. KeyManager associated to consumer_key of the application (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

      • applicationPoliciesGetCall

        public com.squareup.okhttp.Call applicationPoliciesGetCall​(String xWSO2Tenant,
                                                           String policyName,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException
        Build call for applicationPoliciesGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Application policy name (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • applicationPoliciesGet

        public ApplicationPolicyListDTO applicationPoliciesGet​(String xWSO2Tenant,
                                                       String policyName)
                                                throws ApiException
        Get all application throttling policies This will provide access to application level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Application policy name (optional)
        Returns:
        ApplicationPolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationPoliciesGetWithHttpInfo

        public ApiResponse<ApplicationPolicyListDTO> applicationPoliciesGetWithHttpInfo​(String xWSO2Tenant,
                                                                                String policyName)
                                                                         throws ApiException
        Get all application throttling policies This will provide access to application level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Application policy name (optional)
        Returns:
        ApiResponse<ApplicationPolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationPoliciesGetAsync

        public com.squareup.okhttp.Call applicationPoliciesGetAsync​(String xWSO2Tenant,
                                                            String policyName,
                                                            ApiCallback<ApplicationPolicyListDTO> callback)
                                                     throws ApiException
        Get all application throttling policies (asynchronously) This will provide access to application level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Application policy name (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

      • applicationsGetCall

        public com.squareup.okhttp.Call applicationsGetCall​(String xWSO2Tenant,
                                                    Integer appId,
                                                    ProgressResponseBody.ProgressListener progressListener,
                                                    ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                             throws ApiException
        Build call for applicationsGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        appId - **Search condition**. Application ID of the application (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • applicationsGet

        public ApplicationListDTO applicationsGet​(String xWSO2Tenant,
                                          Integer appId)
                                   throws ApiException
        Get all applications This will provide access to applications in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        appId - **Search condition**. Application ID of the application (optional)
        Returns:
        ApplicationListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationsGetWithHttpInfo

        public ApiResponse<ApplicationListDTO> applicationsGetWithHttpInfo​(String xWSO2Tenant,
                                                                   Integer appId)
                                                            throws ApiException
        Get all applications This will provide access to applications in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        appId - **Search condition**. Application ID of the application (optional)
        Returns:
        ApiResponse<ApplicationListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • applicationsGetAsync

        public com.squareup.okhttp.Call applicationsGetAsync​(String xWSO2Tenant,
                                                     Integer appId,
                                                     ApiCallback<ApplicationListDTO> callback)
                                              throws ApiException
        Get all applications (asynchronously) This will provide access to applications in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        appId - **Search condition**. Application ID of the application (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

      • globalPoliciesGetCall

        public com.squareup.okhttp.Call globalPoliciesGetCall​(String xWSO2Tenant,
                                                      String policyName,
                                                      ProgressResponseBody.ProgressListener progressListener,
                                                      ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                               throws ApiException
        Build call for globalPoliciesGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Global policy name (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • globalPoliciesGet

        public GlobalPolicyListDTO globalPoliciesGet​(String xWSO2Tenant,
                                             String policyName)
                                      throws ApiException
        Get all Global throttling policies This will provide access to global throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Global policy name (optional)
        Returns:
        GlobalPolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • globalPoliciesGetWithHttpInfo

        public ApiResponse<GlobalPolicyListDTO> globalPoliciesGetWithHttpInfo​(String xWSO2Tenant,
                                                                      String policyName)
                                                               throws ApiException
        Get all Global throttling policies This will provide access to global throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Global policy name (optional)
        Returns:
        ApiResponse<GlobalPolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • globalPoliciesGetAsync

        public com.squareup.okhttp.Call globalPoliciesGetAsync​(String xWSO2Tenant,
                                                       String policyName,
                                                       ApiCallback<GlobalPolicyListDTO> callback)
                                                throws ApiException
        Get all Global throttling policies (asynchronously) This will provide access to global throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Global policy name (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

      • scopesGetCall

        public com.squareup.okhttp.Call scopesGetCall​(String xWSO2Tenant,
                                              String scopeKey,
                                              ProgressResponseBody.ProgressListener progressListener,
                                              ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                       throws ApiException
        Build call for scopesGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        scopeKey - **Search condition**. Scope Key (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • scopesGet

        public ScopesListDTO scopesGet​(String xWSO2Tenant,
                               String scopeKey)
                        throws ApiException
        Get all scopes. This will provide access to the Scopes created in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        scopeKey - **Search condition**. Scope Key (optional)
        Returns:
        ScopesListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • scopesGetWithHttpInfo

        public ApiResponse<ScopesListDTO> scopesGetWithHttpInfo​(String xWSO2Tenant,
                                                        String scopeKey)
                                                 throws ApiException
        Get all scopes. This will provide access to the Scopes created in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        scopeKey - **Search condition**. Scope Key (optional)
        Returns:
        ApiResponse<ScopesListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • scopesGetAsync

        public com.squareup.okhttp.Call scopesGetAsync​(String xWSO2Tenant,
                                               String scopeKey,
                                               ApiCallback<ScopesListDTO> callback)
                                        throws ApiException
        Get all scopes. (asynchronously) This will provide access to the Scopes created in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        scopeKey - **Search condition**. Scope Key (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

      • subscriptionPoliciesGetCall

        public com.squareup.okhttp.Call subscriptionPoliciesGetCall​(String xWSO2Tenant,
                                                            String policyName,
                                                            ProgressResponseBody.ProgressListener progressListener,
                                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                     throws ApiException
        Build call for subscriptionPoliciesGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Subscription policy name (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionPoliciesGet

        public SubscriptionPolicyListDTO subscriptionPoliciesGet​(String xWSO2Tenant,
                                                         String policyName)
                                                  throws ApiException
        Get all subscription throttling policies This will provide access to subscription level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Subscription policy name (optional)
        Returns:
        SubscriptionPolicyListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionPoliciesGetWithHttpInfo

        public ApiResponse<SubscriptionPolicyListDTO> subscriptionPoliciesGetWithHttpInfo​(String xWSO2Tenant,
                                                                                  String policyName)
                                                                           throws ApiException
        Get all subscription throttling policies This will provide access to subscription level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Subscription policy name (optional)
        Returns:
        ApiResponse<SubscriptionPolicyListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionPoliciesGetAsync

        public com.squareup.okhttp.Call subscriptionPoliciesGetAsync​(String xWSO2Tenant,
                                                             String policyName,
                                                             ApiCallback<SubscriptionPolicyListDTO> callback)
                                                      throws ApiException
        Get all subscription throttling policies (asynchronously) This will provide access to subscription level throttling policies in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        policyName - **Search condition**. Subscription policy name (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

      • subscriptionsGetCall

        public com.squareup.okhttp.Call subscriptionsGetCall​(String xWSO2Tenant,
                                                     Integer apiId,
                                                     Integer appId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException
        Build call for subscriptionsGet
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID of the subscription (optional)
        appId - **Search condition**. Application ID of the subscription (optional)
        progressListener - Progress listener
        progressRequestListener - Progress request listener
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • subscriptionsGet

        public SubscriptionListDTO subscriptionsGet​(String xWSO2Tenant,
                                            Integer apiId,
                                            Integer appId)
                                     throws ApiException
        Get all subscriptions This will provide access to subscriptions in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID of the subscription (optional)
        appId - **Search condition**. Application ID of the subscription (optional)
        Returns:
        SubscriptionListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • subscriptionsGetWithHttpInfo

        public ApiResponse<SubscriptionListDTO> subscriptionsGetWithHttpInfo​(String xWSO2Tenant,
                                                                     Integer apiId,
                                                                     Integer appId)
                                                              throws ApiException
        Get all subscriptions This will provide access to subscriptions in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID of the subscription (optional)
        appId - **Search condition**. Application ID of the subscription (optional)
        Returns:
        ApiResponse<SubscriptionListDTO>
        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 xWSO2Tenant,
                                                      Integer apiId,
                                                      Integer appId,
                                                      ApiCallback<SubscriptionListDTO> callback)
                                               throws ApiException
        Get all subscriptions (asynchronously) This will provide access to subscriptions in database.
        Parameters:
        xWSO2Tenant - This is used to specify the tenant domain, where the resource need to be retrieved from. (required)
        apiId - **Search condition**. Api ID of the subscription (optional)
        appId - **Search condition**. Application ID of the subscription (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