Package com.docusign.esign.api

Class CloudStorageApi

  • public class CloudStorageApi
extends Object
    CloudStorageApi class.

    • Constructor Detail

      • CloudStorageApi

        public CloudStorageApi()
        CloudStorageApi.

      • CloudStorageApi

        public CloudStorageApi​(ApiClient apiClient)
        CloudStorageApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • callList

        public ExternalFolder callList​(String accountId,
                               String userId,
                               String serviceId,
                               String folderId)
                        throws ApiException
        Gets a list of all the items from the specified cloud storage provider.. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        folderId - The ID of the folder being accessed. (required)
        Returns:
        ExternalFolder
        Throws:
        ApiException

      • callList

        public ExternalFolder callList​(String accountId,
                               String userId,
                               String serviceId,
                               String folderId,
                               CloudStorageApi.CallListOptions options)
                        throws ApiException
        Gets a list of all the items from the specified cloud storage provider.. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        folderId - The ID of the folder being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        ExternalFolder
        Throws:
        ApiException - if fails to make API call

      • callListWithHttpInfo

        public ApiResponse<ExternalFolder> callListWithHttpInfo​(String accountId,
                                                        String userId,
                                                        String serviceId,
                                                        String folderId,
                                                        CloudStorageApi.CallListOptions options)
                                                 throws ApiException
        Gets a list of all the items from the specified cloud storage provider. Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        folderId - The ID of the folder being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        ExternalFolder
        Throws:
        ApiException - if fails to make API call

      • createProvider

        public CloudStorageProviders createProvider​(String accountId,
                                            String userId,
                                            CloudStorageProviders cloudStorageProviders)
                                     throws ApiException
        Configures the redirect URL information for one or more cloud storage providers for the specified user.. Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        cloudStorageProviders - (optional)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • createProviderWithHttpInfo

        public ApiResponse<CloudStorageProviders> createProviderWithHttpInfo​(String accountId,
                                                                     String userId,
                                                                     CloudStorageProviders cloudStorageProviders)
                                                              throws ApiException
        Configures the redirect URL information for one or more cloud storage providers for the specified user. Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        cloudStorageProviders - (optional)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • deleteProvider

        public CloudStorageProviders deleteProvider​(String accountId,
                                            String userId,
                                            String serviceId)
                                     throws ApiException
        Deletes the user authentication information for the specified cloud storage provider.. Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • deleteProviderWithHttpInfo

        public ApiResponse<CloudStorageProviders> deleteProviderWithHttpInfo​(String accountId,
                                                                     String userId,
                                                                     String serviceId)
                                                              throws ApiException
        Deletes the user authentication information for the specified cloud storage provider. Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • deleteProviders

        public CloudStorageProviders deleteProviders​(String accountId,
                                             String userId,
                                             CloudStorageProviders cloudStorageProviders)
                                      throws ApiException
        Deletes the user authentication information for one or more cloud storage providers.. Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        cloudStorageProviders - (optional)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • deleteProvidersWithHttpInfo

        public ApiResponse<CloudStorageProviders> deleteProvidersWithHttpInfo​(String accountId,
                                                                      String userId,
                                                                      CloudStorageProviders cloudStorageProviders)
                                                               throws ApiException
        Deletes the user authentication information for one or more cloud storage providers. Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        cloudStorageProviders - (optional)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • getProvider

        public CloudStorageProviders getProvider​(String accountId,
                                         String userId,
                                         String serviceId)
                                  throws ApiException
        Gets the specified Cloud Storage Provider configuration for the User.. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException

      • getProvider

        public CloudStorageProviders getProvider​(String accountId,
                                         String userId,
                                         String serviceId,
                                         CloudStorageApi.GetProviderOptions options)
                                  throws ApiException
        Gets the specified Cloud Storage Provider configuration for the User.. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        options - for modifying the method behavior.
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • getProviderWithHttpInfo

        public ApiResponse<CloudStorageProviders> getProviderWithHttpInfo​(String accountId,
                                                                  String userId,
                                                                  String serviceId,
                                                                  CloudStorageApi.GetProviderOptions options)
                                                           throws ApiException
        Gets the specified Cloud Storage Provider configuration for the User. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        options - for modifying the method behavior.
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • listFolders

        public ExternalFolder listFolders​(String accountId,
                                  String userId,
                                  String serviceId)
                           throws ApiException
        Retrieves a list of all the items in a specified folder from the specified cloud storage provider.. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        Returns:
        ExternalFolder
        Throws:
        ApiException

      • listFolders

        public ExternalFolder listFolders​(String accountId,
                                  String userId,
                                  String serviceId,
                                  CloudStorageApi.ListFoldersOptions options)
                           throws ApiException
        Retrieves a list of all the items in a specified folder from the specified cloud storage provider.. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        options - for modifying the method behavior.
        Returns:
        ExternalFolder
        Throws:
        ApiException - if fails to make API call

      • listFoldersWithHttpInfo

        public ApiResponse<ExternalFolder> listFoldersWithHttpInfo​(String accountId,
                                                           String userId,
                                                           String serviceId,
                                                           CloudStorageApi.ListFoldersOptions options)
                                                    throws ApiException
        Retrieves a list of all the items in a specified folder from the specified cloud storage provider. Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        serviceId - The ID of the service to access. Valid values are the service name (\"Box\") or the numerical serviceId (\"4136\"). (required)
        options - for modifying the method behavior.
        Returns:
        ExternalFolder
        Throws:
        ApiException - if fails to make API call

      • listProviders

        public CloudStorageProviders listProviders​(String accountId,
                                           String userId)
                                    throws ApiException
        Get the Cloud Storage Provider configuration for the specified user.. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        Returns:
        CloudStorageProviders
        Throws:
        ApiException

      • listProviders

        public CloudStorageProviders listProviders​(String accountId,
                                           String userId,
                                           CloudStorageApi.ListProvidersOptions options)
                                    throws ApiException
        Get the Cloud Storage Provider configuration for the specified user.. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call

      • listProvidersWithHttpInfo

        public ApiResponse<CloudStorageProviders> listProvidersWithHttpInfo​(String accountId,
                                                                    String userId,
                                                                    CloudStorageApi.ListProvidersOptions options)
                                                             throws ApiException
        Get the Cloud Storage Provider configuration for the specified user. Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. The {serviceId} parameter can be either the service name or serviceId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        userId - The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. (required)
        options - for modifying the method behavior.
        Returns:
        CloudStorageProviders
        Throws:
        ApiException - if fails to make API call