Package com.docusign.esign.api

Class WorkspacesApi

  • public class WorkspacesApi
extends Object
    WorkspacesApi class.

    • Constructor Detail

      • WorkspacesApi

        public WorkspacesApi()
        WorkspacesApi.

      • WorkspacesApi

        public WorkspacesApi​(ApiClient apiClient)
        WorkspacesApi.

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        getApiClient Method.
        Returns:
        ApiClient

      • setApiClient

        public void setApiClient​(ApiClient apiClient)
        setApiClient Method.

      • createWorkspace

        public Workspace createWorkspace​(String accountId,
                                 Workspace workspace)
                          throws ApiException
        Create a Workspace. Creates a new workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspace - (optional)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • createWorkspaceWithHttpInfo

        public ApiResponse<Workspace> createWorkspaceWithHttpInfo​(String accountId,
                                                          Workspace workspace)
                                                   throws ApiException
        Create a Workspace Creates a new workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspace - (optional)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • createWorkspaceFile

        public WorkspaceItem createWorkspaceFile​(String accountId,
                                         String workspaceId,
                                         String folderId)
                                  throws ApiException
        Creates a workspace file.. This method adds a file to a workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        Returns:
        WorkspaceItem
        Throws:
        ApiException - if fails to make API call

      • createWorkspaceFileWithHttpInfo

        public ApiResponse<WorkspaceItem> createWorkspaceFileWithHttpInfo​(String accountId,
                                                                  String workspaceId,
                                                                  String folderId)
                                                           throws ApiException
        Creates a workspace file. This method adds a file to a workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        Returns:
        WorkspaceItem
        Throws:
        ApiException - if fails to make API call

      • deleteWorkspace

        public Workspace deleteWorkspace​(String accountId,
                                 String workspaceId)
                          throws ApiException
        Delete Workspace. Deletes an existing workspace (logically).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • deleteWorkspaceWithHttpInfo

        public ApiResponse<Workspace> deleteWorkspaceWithHttpInfo​(String accountId,
                                                          String workspaceId)
                                                   throws ApiException
        Delete Workspace Deletes an existing workspace (logically).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • deleteWorkspaceFolderItems

        public void deleteWorkspaceFolderItems​(String accountId,
                                       String workspaceId,
                                       String folderId,
                                       WorkspaceItemList workspaceItemList)
                                throws ApiException
        Deletes workspace one or more specific files/folders from the given folder or root.. This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        workspaceItemList - (optional)
        Throws:
        ApiException - if fails to make API call

      • deleteWorkspaceFolderItemsWithHttpInfo

        public ApiResponse<Object> deleteWorkspaceFolderItemsWithHttpInfo​(String accountId,
                                                                  String workspaceId,
                                                                  String folderId,
                                                                  WorkspaceItemList workspaceItemList)
                                                           throws ApiException
        Deletes workspace one or more specific files/folders from the given folder or root. This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the `status` of the workspace must be `active`.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        workspaceItemList - (optional)
        Throws:
        ApiException - if fails to make API call

      • getWorkspace

        public Workspace getWorkspace​(String accountId,
                              String workspaceId)
                       throws ApiException
        Get Workspace. Retrives properties about a workspace given a unique workspaceId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • getWorkspaceWithHttpInfo

        public ApiResponse<Workspace> getWorkspaceWithHttpInfo​(String accountId,
                                                       String workspaceId)
                                                throws ApiException
        Get Workspace Retrives properties about a workspace given a unique workspaceId.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • getWorkspaceFile

        public void getWorkspaceFile​(String accountId,
                             String workspaceId,
                             String folderId,
                             String fileId)
                      throws ApiException
        Get Workspace File. Retrieves a workspace file (the binary).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        Throws:
        ApiException

      • getWorkspaceFile

        public void getWorkspaceFile​(String accountId,
                             String workspaceId,
                             String folderId,
                             String fileId,
                             WorkspacesApi.GetWorkspaceFileOptions options)
                      throws ApiException
        Get Workspace File. Retrieves a workspace file (the binary).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • getWorkspaceFileWithHttpInfo

        public ApiResponse<Object> getWorkspaceFileWithHttpInfo​(String accountId,
                                                        String workspaceId,
                                                        String folderId,
                                                        String fileId,
                                                        WorkspacesApi.GetWorkspaceFileOptions options)
                                                 throws ApiException
        Get Workspace File Retrieves a workspace file (the binary).
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        options - for modifying the method behavior.
        Throws:
        ApiException - if fails to make API call

      • listWorkspaceFilePages

        public PageImages listWorkspaceFilePages​(String accountId,
                                         String workspaceId,
                                         String folderId,
                                         String fileId)
                                  throws ApiException
        List File Pages. Retrieves a workspace file as rasterized pages.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        Returns:
        PageImages
        Throws:
        ApiException

      • listWorkspaceFilePages

        public PageImages listWorkspaceFilePages​(String accountId,
                                         String workspaceId,
                                         String folderId,
                                         String fileId,
                                         WorkspacesApi.ListWorkspaceFilePagesOptions options)
                                  throws ApiException
        List File Pages. Retrieves a workspace file as rasterized pages.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        options - for modifying the method behavior.
        Returns:
        PageImages
        Throws:
        ApiException - if fails to make API call

      • listWorkspaceFilePagesWithHttpInfo

        public ApiResponse<PageImages> listWorkspaceFilePagesWithHttpInfo​(String accountId,
                                                                  String workspaceId,
                                                                  String folderId,
                                                                  String fileId,
                                                                  WorkspacesApi.ListWorkspaceFilePagesOptions options)
                                                           throws ApiException
        List File Pages Retrieves a workspace file as rasterized pages.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        options - for modifying the method behavior.
        Returns:
        PageImages
        Throws:
        ApiException - if fails to make API call

      • listWorkspaceFolderItems

        public WorkspaceFolderContents listWorkspaceFolderItems​(String accountId,
                                                        String workspaceId,
                                                        String folderId)
                                                 throws ApiException
        List Workspace Folder Contents. Retrieves workspace folder contents, which can include sub folders and files.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        Returns:
        WorkspaceFolderContents
        Throws:
        ApiException

      • listWorkspaceFolderItems

        public WorkspaceFolderContents listWorkspaceFolderItems​(String accountId,
                                                        String workspaceId,
                                                        String folderId,
                                                        WorkspacesApi.ListWorkspaceFolderItemsOptions options)
                                                 throws ApiException
        List Workspace Folder Contents. Retrieves workspace folder contents, which can include sub folders and files.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        WorkspaceFolderContents
        Throws:
        ApiException - if fails to make API call

      • listWorkspaceFolderItemsWithHttpInfo

        public ApiResponse<WorkspaceFolderContents> listWorkspaceFolderItemsWithHttpInfo​(String accountId,
                                                                                 String workspaceId,
                                                                                 String folderId,
                                                                                 WorkspacesApi.ListWorkspaceFolderItemsOptions options)
                                                                          throws ApiException
        List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        options - for modifying the method behavior.
        Returns:
        WorkspaceFolderContents
        Throws:
        ApiException - if fails to make API call

      • listWorkspaces

        public WorkspaceList listWorkspaces​(String accountId)
                             throws ApiException
        List Workspaces. Gets information about the Workspaces that have been created.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        WorkspaceList
        Throws:
        ApiException - if fails to make API call

      • listWorkspacesWithHttpInfo

        public ApiResponse<WorkspaceList> listWorkspacesWithHttpInfo​(String accountId)
                                                      throws ApiException
        List Workspaces Gets information about the Workspaces that have been created.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        Returns:
        WorkspaceList
        Throws:
        ApiException - if fails to make API call

      • updateWorkspace

        public Workspace updateWorkspace​(String accountId,
                                 String workspaceId,
                                 Workspace workspace)
                          throws ApiException
        Update Workspace. Updates information about a specific workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        workspace - (optional)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • updateWorkspaceWithHttpInfo

        public ApiResponse<Workspace> updateWorkspaceWithHttpInfo​(String accountId,
                                                          String workspaceId,
                                                          Workspace workspace)
                                                   throws ApiException
        Update Workspace Updates information about a specific workspace.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        workspace - (optional)
        Returns:
        Workspace
        Throws:
        ApiException - if fails to make API call

      • updateWorkspaceFile

        public WorkspaceItem updateWorkspaceFile​(String accountId,
                                         String workspaceId,
                                         String folderId,
                                         String fileId)
                                  throws ApiException
        Update Workspace File Metadata. Updates workspace item metadata for one or more specific files/folders.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        Returns:
        WorkspaceItem
        Throws:
        ApiException - if fails to make API call

      • updateWorkspaceFileWithHttpInfo

        public ApiResponse<WorkspaceItem> updateWorkspaceFileWithHttpInfo​(String accountId,
                                                                  String workspaceId,
                                                                  String folderId,
                                                                  String fileId)
                                                           throws ApiException
        Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.
        Parameters:
        accountId - The external account number (int) or account ID Guid. (required)
        workspaceId - Specifies the workspace ID GUID. (required)
        folderId - The ID of the folder being accessed. (required)
        fileId - Specifies the room file ID GUID. (required)
        Returns:
        WorkspaceItem
        Throws:
        ApiException - if fails to make API call