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

Class ScopesApi

  • public class ScopesApi
extends Object

    • Constructor Detail

      • ScopesApi

        public ScopesApi()

      • ScopesApi

        public ScopesApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • addSharedScopeCall

        public okhttp3.Call addSharedScopeCall​(ScopeDTO scopeDTO,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for addSharedScope
        Parameters:
        scopeDTO - Scope object that needs to be added (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • addSharedScope

        public ScopeDTO addSharedScope​(ScopeDTO scopeDTO)
                        throws ApiException
        Add a New Shared Scope This operation can be used to add a new Shared Scope.
        Parameters:
        scopeDTO - Scope object that needs to be added (required)
        Returns:
        ScopeDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • addSharedScopeWithHttpInfo

        public ApiResponse<ScopeDTO> addSharedScopeWithHttpInfo​(ScopeDTO scopeDTO)
                                                 throws ApiException
        Add a New Shared Scope This operation can be used to add a new Shared Scope.
        Parameters:
        scopeDTO - Scope object that needs to be added (required)
        Returns:
        ApiResponse<ScopeDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • addSharedScopeAsync

        public okhttp3.Call addSharedScopeAsync​(ScopeDTO scopeDTO,
                                        ApiCallback<ScopeDTO> _callback)
                                 throws ApiException
        Add a New Shared Scope (asynchronously) This operation can be used to add a new Shared Scope.
        Parameters:
        scopeDTO - Scope object that needs to be added (required)
        _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

      • deleteSharedScopeCall

        public okhttp3.Call deleteSharedScopeCall​(String scopeId,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for deleteSharedScope
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • deleteSharedScope

        public void deleteSharedScope​(String scopeId)
                       throws ApiException
        Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteSharedScopeWithHttpInfo

        public ApiResponse<Void> deleteSharedScopeWithHttpInfo​(String scopeId)
                                                throws ApiException
        Delete a Shared Scope This operation can be used to delete a Shared Scope proving the Id of the scope.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteSharedScopeAsync

        public okhttp3.Call deleteSharedScopeAsync​(String scopeId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Delete a Shared Scope (asynchronously) This operation can be used to delete a Shared Scope proving the Id of the scope.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _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

      • getSharedScopeCall

        public okhttp3.Call getSharedScopeCall​(String scopeId,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getSharedScope
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getSharedScope

        public ScopeDTO getSharedScope​(String scopeId)
                        throws ApiException
        Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Returns:
        ScopeDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopeWithHttpInfo

        public ApiResponse<ScopeDTO> getSharedScopeWithHttpInfo​(String scopeId)
                                                 throws ApiException
        Get a Shared Scope by Scope Id This operation can be used to retrieve details of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Returns:
        ApiResponse<ScopeDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopeAsync

        public okhttp3.Call getSharedScopeAsync​(String scopeId,
                                        ApiCallback<ScopeDTO> _callback)
                                 throws ApiException
        Get a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve details of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _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

      • getSharedScopeUsagesCall

        public okhttp3.Call getSharedScopeUsagesCall​(String scopeId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for getSharedScopeUsages
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getSharedScopeUsages

        public SharedScopeUsageDTO getSharedScopeUsages​(String scopeId)
                                         throws ApiException
        Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Returns:
        SharedScopeUsageDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopeUsagesWithHttpInfo

        public ApiResponse<SharedScopeUsageDTO> getSharedScopeUsagesWithHttpInfo​(String scopeId)
                                                                  throws ApiException
        Get usages of a Shared Scope by Scope Id This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        Returns:
        ApiResponse<SharedScopeUsageDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopeUsagesAsync

        public okhttp3.Call getSharedScopeUsagesAsync​(String scopeId,
                                              ApiCallback<SharedScopeUsageDTO> _callback)
                                       throws ApiException
        Get usages of a Shared Scope by Scope Id (asynchronously) This operation can be used to retrieve usages of a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        _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

      • getSharedScopesCall

        public okhttp3.Call getSharedScopesCall​(Integer limit,
                                        Integer offset,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for getSharedScopes
        Parameters:
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getSharedScopes

        public ScopeListDTO getSharedScopes​(Integer limit,
                                    Integer offset)
                             throws ApiException
        Get All Available Shared Scopes This operation can be used to get all the available Shared Scopes.
        Parameters:
        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)
        Returns:
        ScopeListDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopesWithHttpInfo

        public ApiResponse<ScopeListDTO> getSharedScopesWithHttpInfo​(Integer limit,
                                                             Integer offset)
                                                      throws ApiException
        Get All Available Shared Scopes This operation can be used to get all the available Shared Scopes.
        Parameters:
        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)
        Returns:
        ApiResponse<ScopeListDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSharedScopesAsync

        public okhttp3.Call getSharedScopesAsync​(Integer limit,
                                         Integer offset,
                                         ApiCallback<ScopeListDTO> _callback)
                                  throws ApiException
        Get All Available Shared Scopes (asynchronously) This operation can be used to get all the available Shared Scopes.
        Parameters:
        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)
        _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

      • updateSharedScopeCall

        public okhttp3.Call updateSharedScopeCall​(String scopeId,
                                          ScopeDTO scopeDTO,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for updateSharedScope
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        scopeDTO - Scope object that needs to be updated (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • updateSharedScope

        public ScopeDTO updateSharedScope​(String scopeId,
                                  ScopeDTO scopeDTO)
                           throws ApiException
        Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        scopeDTO - Scope object that needs to be updated (required)
        Returns:
        ScopeDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSharedScopeWithHttpInfo

        public ApiResponse<ScopeDTO> updateSharedScopeWithHttpInfo​(String scopeId,
                                                           ScopeDTO scopeDTO)
                                                    throws ApiException
        Update a Shared Scope This operation can be used to update a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        scopeDTO - Scope object that needs to be updated (required)
        Returns:
        ApiResponse<ScopeDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateSharedScopeAsync

        public okhttp3.Call updateSharedScopeAsync​(String scopeId,
                                           ScopeDTO scopeDTO,
                                           ApiCallback<ScopeDTO> _callback)
                                    throws ApiException
        Update a Shared Scope (asynchronously) This operation can be used to update a Shared Scope by a given scope Id.
        Parameters:
        scopeId - Scope Id consisting the UUID of the shared scope (required)
        scopeDTO - Scope object that needs to be updated (required)
        _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

      • validateScopeCall

        public okhttp3.Call validateScopeCall​(String scopeId,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for validateScope
        Parameters:
        scopeId - Scope name (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateScope

        public void validateScope​(String scopeId)
                   throws ApiException
        Check Given Scope Name already Exists Using this operation, user can check a given scope name exists or not.
        Parameters:
        scopeId - Scope name (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateScopeWithHttpInfo

        public ApiResponse<Void> validateScopeWithHttpInfo​(String scopeId)
                                            throws ApiException
        Check Given Scope Name already Exists Using this operation, user can check a given scope name exists or not.
        Parameters:
        scopeId - Scope name (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateScopeAsync

        public okhttp3.Call validateScopeAsync​(String scopeId,
                                       ApiCallback<Void> _callback)
                                throws ApiException
        Check Given Scope Name already Exists (asynchronously) Using this operation, user can check a given scope name exists or not.
        Parameters:
        scopeId - Scope name (required)
        _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