com.docusign.esign.api

Class WorkspacesApi

java.lang.Object

com.docusign.esign.api.WorkspacesApi

public class WorkspacesApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WorkspacesApi.GetWorkspaceFileOptions
class	WorkspacesApi.ListWorkspaceFilePagesOptions
class	WorkspacesApi.ListWorkspaceFolderItemsOptions

Constructor Summary

Constructors

Constructor and Description
WorkspacesApi()
WorkspacesApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
Workspace	createWorkspace(String accountId, Workspace workspace) Create a Workspace Creates a new workspace.
WorkspaceItem	createWorkspaceFile(String accountId, String workspaceId, String folderId) Creates a workspace file.
Workspace	deleteWorkspace(String accountId, String workspaceId) Delete Workspace Deletes an existing workspace (logically).
void	deleteWorkspaceFolderItems(String accountId, String workspaceId, String folderId, WorkspaceItemList workspaceItemList) Deletes workspace one or more specific files/folders from the given folder or root.
ApiClient	getApiClient()
Workspace	getWorkspace(String accountId, String workspaceId) Get Workspace Retrives properties about a workspace given a unique workspaceId.
void	getWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId) Get Workspace File Retrieves a workspace file (the binary).
void	getWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId, WorkspacesApi.GetWorkspaceFileOptions options) Get Workspace File Retrieves a workspace file (the binary).
PageImages	listWorkspaceFilePages(String accountId, String workspaceId, String folderId, String fileId) List File Pages Retrieves a workspace file as rasterized pages.
PageImages	listWorkspaceFilePages(String accountId, String workspaceId, String folderId, String fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options) List File Pages Retrieves a workspace file as rasterized pages.
WorkspaceFolderContents	listWorkspaceFolderItems(String accountId, String workspaceId, String folderId) List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.
WorkspaceFolderContents	listWorkspaceFolderItems(String accountId, String workspaceId, String folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options) List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.
WorkspaceList	listWorkspaces(String accountId) List Workspaces Gets information about the Workspaces that have been created.
void	setApiClient(ApiClient apiClient)
Workspace	updateWorkspace(String accountId, String workspaceId, Workspace workspace) Update Workspace Updates information about a specific workspace.
WorkspaceItem	updateWorkspaceFile(String accountId, String workspaceId, String folderId, String fileId) Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkspacesApi

public WorkspacesApi()

WorkspacesApi

public WorkspacesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

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

createWorkspaceFile

public WorkspaceItem createWorkspaceFile(String accountId,
                                String workspaceId,
                                String folderId)
                                  throws ApiException

Creates a workspace file.

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

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.

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

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

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

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

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

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

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