Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.WorkspacesApi:

Classes
class	GetWorkspaceFileOptions
	Get Workspace File Retrieves a workspace file (the binary). More...

class	ListWorkspaceFilePagesOptions
	List File Pages Retrieves a workspace file as rasterized pages. More...

class	ListWorkspaceFolderItemsOptions
	List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. More...

Public Member Functions
	WorkspacesApi (DocuSignClient aplClient)
	Initializes a new instance of the WorkspacesApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

Workspace	CreateWorkspace (string accountId, Workspace workspace=null)
	Create a Workspace Creates a new workspace. More...

ApiResponse< Workspace >	CreateWorkspaceWithHttpInfo (string accountId, Workspace workspace=null)
	Create a Workspace Creates a new workspace. More...

async System.Threading.Tasks.Task< Workspace >	CreateWorkspaceAsync (string accountId, Workspace workspace=null)
	Create a Workspace Creates a new workspace. More...

async System.Threading.Tasks.Task< ApiResponse< Workspace > >	CreateWorkspaceAsyncWithHttpInfo (string accountId, Workspace workspace=null)
	Create a Workspace Creates a new workspace. More...

WorkspaceItem	CreateWorkspaceFile (string accountId, string workspaceId, string folderId)
	Creates a workspace file. This method adds a file to a workspace. More...

ApiResponse< WorkspaceItem >	CreateWorkspaceFileWithHttpInfo (string accountId, string workspaceId, string folderId)
	Creates a workspace file. This method adds a file to a workspace. More...

async System.Threading.Tasks.Task< WorkspaceItem >	CreateWorkspaceFileAsync (string accountId, string workspaceId, string folderId)
	Creates a workspace file. This method adds a file to a workspace. More...

async System.Threading.Tasks.Task< ApiResponse< WorkspaceItem > >	CreateWorkspaceFileAsyncWithHttpInfo (string accountId, string workspaceId, string folderId)
	Creates a workspace file. This method adds a file to a workspace. More...

Workspace	DeleteWorkspace (string accountId, string workspaceId)
	Delete Workspace Deletes an existing workspace (logically). More...

ApiResponse< Workspace >	DeleteWorkspaceWithHttpInfo (string accountId, string workspaceId)
	Delete Workspace Deletes an existing workspace (logically). More...

async System.Threading.Tasks.Task< Workspace >	DeleteWorkspaceAsync (string accountId, string workspaceId)
	Delete Workspace Deletes an existing workspace (logically). More...

async System.Threading.Tasks.Task< ApiResponse< Workspace > >	DeleteWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId)
	Delete Workspace Deletes an existing workspace (logically). More...

void	DeleteWorkspaceFolderItems (string accountId, string workspaceId, string folderId, WorkspaceItemList workspaceItemList=null)
	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`. More...

ApiResponse< Object >	DeleteWorkspaceFolderItemsWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspaceItemList workspaceItemList=null)
	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`. More...

async System.Threading.Tasks.Task	DeleteWorkspaceFolderItemsAsync (string accountId, string workspaceId, string folderId, WorkspaceItemList workspaceItemList=null)
	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`. More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	DeleteWorkspaceFolderItemsAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspaceItemList workspaceItemList=null)
	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`. More...

Workspace	GetWorkspace (string accountId, string workspaceId)
	Get Workspace Retrives properties about a workspace given a unique workspaceId. More...

ApiResponse< Workspace >	GetWorkspaceWithHttpInfo (string accountId, string workspaceId)
	Get Workspace Retrives properties about a workspace given a unique workspaceId. More...

async System.Threading.Tasks.Task< Workspace >	GetWorkspaceAsync (string accountId, string workspaceId)
	Get Workspace Retrives properties about a workspace given a unique workspaceId. More...

async System.Threading.Tasks.Task< ApiResponse< Workspace > >	GetWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId)
	Get Workspace Retrives properties about a workspace given a unique workspaceId. More...

void	GetWorkspaceFile (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File Retrieves a workspace file (the binary). More...

ApiResponse< Object >	GetWorkspaceFileWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File Retrieves a workspace file (the binary). More...

async System.Threading.Tasks.Task	GetWorkspaceFileAsync (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File Retrieves a workspace file (the binary). More...

async System.Threading.Tasks.Task< ApiResponse< Object > >	GetWorkspaceFileAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File Retrieves a workspace file (the binary). More...

PageImages	ListWorkspaceFilePages (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages Retrieves a workspace file as rasterized pages. More...

ApiResponse< PageImages >	ListWorkspaceFilePagesWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages Retrieves a workspace file as rasterized pages. More...

async System.Threading.Tasks.Task< PageImages >	ListWorkspaceFilePagesAsync (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages Retrieves a workspace file as rasterized pages. More...

async System.Threading.Tasks.Task< ApiResponse< PageImages > >	ListWorkspaceFilePagesAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages Retrieves a workspace file as rasterized pages. More...

WorkspaceFolderContents	ListWorkspaceFolderItems (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. More...

ApiResponse< WorkspaceFolderContents >	ListWorkspaceFolderItemsWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. More...

async System.Threading.Tasks.Task< WorkspaceFolderContents >	ListWorkspaceFolderItemsAsync (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. More...

async System.Threading.Tasks.Task< ApiResponse< WorkspaceFolderContents > >	ListWorkspaceFolderItemsAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files. More...

WorkspaceList	ListWorkspaces (string accountId)
	List Workspaces Gets information about the Workspaces that have been created. More...

ApiResponse< WorkspaceList >	ListWorkspacesWithHttpInfo (string accountId)
	List Workspaces Gets information about the Workspaces that have been created. More...

async System.Threading.Tasks.Task< WorkspaceList >	ListWorkspacesAsync (string accountId)
	List Workspaces Gets information about the Workspaces that have been created. More...

async System.Threading.Tasks.Task< ApiResponse< WorkspaceList > >	ListWorkspacesAsyncWithHttpInfo (string accountId)
	List Workspaces Gets information about the Workspaces that have been created. More...

Workspace	UpdateWorkspace (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace Updates information about a specific workspace. More...

ApiResponse< Workspace >	UpdateWorkspaceWithHttpInfo (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace Updates information about a specific workspace. More...

async System.Threading.Tasks.Task< Workspace >	UpdateWorkspaceAsync (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace Updates information about a specific workspace. More...

async System.Threading.Tasks.Task< ApiResponse< Workspace > >	UpdateWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace Updates information about a specific workspace. More...

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. More...

ApiResponse< WorkspaceItem >	UpdateWorkspaceFileWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders. More...

async System.Threading.Tasks.Task< WorkspaceItem >	UpdateWorkspaceFileAsync (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders. More...

async System.Threading.Tasks.Task< ApiResponse< WorkspaceItem > >	UpdateWorkspaceFileAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders. More...

Public Member Functions inherited from DocuSign.eSign.Api.IWorkspacesApi
void	GetWorkspaceFile (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File More...

ApiResponse< Object >	GetWorkspaceFileWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File More...

PageImages	ListWorkspaceFilePages (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages More...

ApiResponse< PageImages >	ListWorkspaceFilePagesWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages More...

WorkspaceFolderContents	ListWorkspaceFolderItems (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents More...

ApiResponse< WorkspaceFolderContents >	ListWorkspaceFolderItemsWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents More...

System.Threading.Tasks.Task	GetWorkspaceFileAsync (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File More...

System.Threading.Tasks.Task< ApiResponse< Object > >	GetWorkspaceFileAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.GetWorkspaceFileOptions options=null)
	Get Workspace File More...

System.Threading.Tasks.Task< PageImages >	ListWorkspaceFilePagesAsync (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages More...

System.Threading.Tasks.Task< ApiResponse< PageImages > >	ListWorkspaceFilePagesAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId, WorkspacesApi.ListWorkspaceFilePagesOptions options=null)
	List File Pages More...

System.Threading.Tasks.Task< WorkspaceFolderContents >	ListWorkspaceFolderItemsAsync (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents More...

System.Threading.Tasks.Task< ApiResponse< WorkspaceFolderContents > >	ListWorkspaceFolderItemsAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, WorkspacesApi.ListWorkspaceFolderItemsOptions options=null)
	List Workspace Folder Contents More...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Constructor & Destructor Documentation

◆ WorkspacesApi()

DocuSign.eSign.Api.WorkspacesApi.WorkspacesApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the WorkspacesApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateWorkspace()

Workspace DocuSign.eSign.Api.WorkspacesApi.CreateWorkspace	(	string	accountId,
		Workspace	workspace = `null`
	)

inline

Create a Workspace Creates a new workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspace	(optional)

Returns: Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceAsync()

async System.Threading.Tasks.Task<Workspace> DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceAsync	(	string	accountId,
		Workspace	workspace = `null`
	)

inline

Create a Workspace Creates a new workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspace	(optional)

Returns: Task of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Workspace> > DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceAsyncWithHttpInfo	(	string	accountId,
		Workspace	workspace = `null`
	)

inline

Create a Workspace Creates a new workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspace	(optional)

Returns: Task of ApiResponse (Workspace)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceFile()

WorkspaceItem DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceFile	(	string	accountId,
		string	workspaceId,
		string	folderId
	)

inline

Creates a workspace file. This method adds a file to a workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.

Returns: WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceFileAsync()

async System.Threading.Tasks.Task<WorkspaceItem> DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceFileAsync	(	string	accountId,
		string	workspaceId,
		string	folderId
	)

inline

Creates a workspace file. This method adds a file to a workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.

Returns: Task of WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceFileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<WorkspaceItem> > DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceFileAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId
	)

inline

Creates a workspace file. This method adds a file to a workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.

Returns: Task of ApiResponse (WorkspaceItem)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceFileWithHttpInfo()

ApiResponse<WorkspaceItem> DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceFileWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId
	)

inline

Creates a workspace file. This method adds a file to a workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.

Returns: ApiResponse of WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ CreateWorkspaceWithHttpInfo()

ApiResponse<Workspace> DocuSign.eSign.Api.WorkspacesApi.CreateWorkspaceWithHttpInfo	(	string	accountId,
		Workspace	workspace = `null`
	)

inline

Create a Workspace Creates a new workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspace	(optional)

Returns: ApiResponse of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspace()

Workspace DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspace	(	string	accountId,
		string	workspaceId
	)

inline

Delete Workspace Deletes an existing workspace (logically).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceAsync()

async System.Threading.Tasks.Task<Workspace> DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceAsync	(	string	accountId,
		string	workspaceId
	)

inline

Delete Workspace Deletes an existing workspace (logically).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Task of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Workspace> > DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId
	)

inline

Delete Workspace Deletes an existing workspace (logically).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Task of ApiResponse (Workspace)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceFolderItems()

void DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceFolderItems	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspaceItemList	workspaceItemList = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
workspaceItemList	(optional)

Returns

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceFolderItemsAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceFolderItemsAsync	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspaceItemList	workspaceItemList = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
workspaceItemList	(optional)

Returns: Task of void

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceFolderItemsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceFolderItemsAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspaceItemList	workspaceItemList = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
workspaceItemList	(optional)

Returns: Task of ApiResponse

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceFolderItemsWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceFolderItemsWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspaceItemList	workspaceItemList = `null`
	)

inline

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`.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
workspaceItemList	(optional)

Returns: ApiResponse of Object(void)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ DeleteWorkspaceWithHttpInfo()

ApiResponse<Workspace> DocuSign.eSign.Api.WorkspacesApi.DeleteWorkspaceWithHttpInfo	(	string	accountId,
		string	workspaceId
	)

inline

Delete Workspace Deletes an existing workspace (logically).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: ApiResponse of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ GetBasePath()

String DocuSign.eSign.Api.WorkspacesApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetWorkspace()

Workspace DocuSign.eSign.Api.WorkspacesApi.GetWorkspace	(	string	accountId,
		string	workspaceId
	)

inline

Get Workspace Retrives properties about a workspace given a unique workspaceId.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ GetWorkspaceAsync()

async System.Threading.Tasks.Task<Workspace> DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceAsync	(	string	accountId,
		string	workspaceId
	)

inline

Get Workspace Retrives properties about a workspace given a unique workspaceId.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Task of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ GetWorkspaceAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Workspace> > DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId
	)

inline

Get Workspace Retrives properties about a workspace given a unique workspaceId.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: Task of ApiResponse (Workspace)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ GetWorkspaceFile()

void DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceFile	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.GetWorkspaceFileOptions	options = `null`
	)

inline

Get Workspace File Retrieves a workspace file (the binary).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns

◆ GetWorkspaceFileAsync()

async System.Threading.Tasks.Task DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceFileAsync	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.GetWorkspaceFileOptions	options = `null`
	)

inline

Get Workspace File Retrieves a workspace file (the binary).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: Task of void

◆ GetWorkspaceFileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceFileAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.GetWorkspaceFileOptions	options = `null`
	)

inline

Get Workspace File Retrieves a workspace file (the binary).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse

◆ GetWorkspaceFileWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceFileWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.GetWorkspaceFileOptions	options = `null`
	)

inline

Get Workspace File Retrieves a workspace file (the binary).

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of Object(void)

◆ GetWorkspaceWithHttpInfo()

ApiResponse<Workspace> DocuSign.eSign.Api.WorkspacesApi.GetWorkspaceWithHttpInfo	(	string	accountId,
		string	workspaceId
	)

inline

Get Workspace Retrives properties about a workspace given a unique workspaceId.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.

Returns: ApiResponse of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ ListWorkspaceFilePages()

PageImages DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFilePages	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.ListWorkspaceFilePagesOptions	options = `null`
	)

inline

List File Pages Retrieves a workspace file as rasterized pages.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: PageImages

◆ ListWorkspaceFilePagesAsync()

async System.Threading.Tasks.Task<PageImages> DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFilePagesAsync	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.ListWorkspaceFilePagesOptions	options = `null`
	)

inline

List File Pages Retrieves a workspace file as rasterized pages.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: Task of PageImages

◆ ListWorkspaceFilePagesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<PageImages> > DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFilePagesAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.ListWorkspaceFilePagesOptions	options = `null`
	)

inline

List File Pages Retrieves a workspace file as rasterized pages.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (PageImages)

◆ ListWorkspaceFilePagesWithHttpInfo()

ApiResponse<PageImages> DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFilePagesWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.ListWorkspaceFilePagesOptions	options = `null`
	)

inline

List File Pages Retrieves a workspace file as rasterized pages.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of PageImages

◆ ListWorkspaceFolderItems()

WorkspaceFolderContents DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFolderItems	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspacesApi.ListWorkspaceFolderItemsOptions	options = `null`
	)

inline

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: WorkspaceFolderContents

◆ ListWorkspaceFolderItemsAsync()

async System.Threading.Tasks.Task<WorkspaceFolderContents> DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFolderItemsAsync	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspacesApi.ListWorkspaceFolderItemsOptions	options = `null`
	)

inline

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of WorkspaceFolderContents

◆ ListWorkspaceFolderItemsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<WorkspaceFolderContents> > DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFolderItemsAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspacesApi.ListWorkspaceFolderItemsOptions	options = `null`
	)

inline

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (WorkspaceFolderContents)

◆ ListWorkspaceFolderItemsWithHttpInfo()

ApiResponse<WorkspaceFolderContents> DocuSign.eSign.Api.WorkspacesApi.ListWorkspaceFolderItemsWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		WorkspacesApi.ListWorkspaceFolderItemsOptions	options = `null`
	)

inline

List Workspace Folder Contents Retrieves workspace folder contents, which can include sub folders and files.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of WorkspaceFolderContents

◆ ListWorkspaces()

WorkspaceList DocuSign.eSign.Api.WorkspacesApi.ListWorkspaces ( string accountId )

inline

List Workspaces Gets information about the Workspaces that have been created.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId The external account number (int) or account ID Guid.

Returns: WorkspaceList

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ ListWorkspacesAsync()

async System.Threading.Tasks.Task<WorkspaceList> DocuSign.eSign.Api.WorkspacesApi.ListWorkspacesAsync ( string accountId )

inline

List Workspaces Gets information about the Workspaces that have been created.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId The external account number (int) or account ID Guid.

Returns: Task of WorkspaceList

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ ListWorkspacesAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<WorkspaceList> > DocuSign.eSign.Api.WorkspacesApi.ListWorkspacesAsyncWithHttpInfo ( string accountId )

inline

List Workspaces Gets information about the Workspaces that have been created.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId The external account number (int) or account ID Guid.

Returns: Task of ApiResponse (WorkspaceList)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ ListWorkspacesWithHttpInfo()

ApiResponse<WorkspaceList> DocuSign.eSign.Api.WorkspacesApi.ListWorkspacesWithHttpInfo ( string accountId )

inline

List Workspaces Gets information about the Workspaces that have been created.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId The external account number (int) or account ID Guid.

Returns: ApiResponse of WorkspaceList

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspace()

Workspace DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspace	(	string	accountId,
		string	workspaceId,
		Workspace	workspace = `null`
	)

inline

Update Workspace Updates information about a specific workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
workspace	(optional)

Returns: Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceAsync()

async System.Threading.Tasks.Task<Workspace> DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceAsync	(	string	accountId,
		string	workspaceId,
		Workspace	workspace = `null`
	)

inline

Update Workspace Updates information about a specific workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
workspace	(optional)

Returns: Task of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<Workspace> > DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		Workspace	workspace = `null`
	)

inline

Update Workspace Updates information about a specific workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
workspace	(optional)

Returns: Task of ApiResponse (Workspace)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceFile()

WorkspaceItem DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceFile	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId
	)

inline

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.

Returns: WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceFileAsync()

async System.Threading.Tasks.Task<WorkspaceItem> DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceFileAsync	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId
	)

inline

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.

Returns: Task of WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceFileAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<WorkspaceItem> > DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceFileAsyncWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId
	)

inline

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.

Returns: Task of ApiResponse (WorkspaceItem)

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceFileWithHttpInfo()

ApiResponse<WorkspaceItem> DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceFileWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId
	)

inline

Update Workspace File Metadata Updates workspace item metadata for one or more specific files/folders.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
folderId	The ID of the folder being accessed.
fileId	Specifies the room file ID GUID.

Returns: ApiResponse of WorkspaceItem

Implements DocuSign.eSign.Api.IWorkspacesApi.

◆ UpdateWorkspaceWithHttpInfo()

ApiResponse<Workspace> DocuSign.eSign.Api.WorkspacesApi.UpdateWorkspaceWithHttpInfo	(	string	accountId,
		string	workspaceId,
		Workspace	workspace = `null`
	)

inline

Update Workspace Updates information about a specific workspace.

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
workspaceId	Specifies the workspace ID GUID.
workspace	(optional)

Returns: ApiResponse of Workspace

Implements DocuSign.eSign.Api.IWorkspacesApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.WorkspacesApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.WorkspacesApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class was generated from the following file:

sdk/src/DocuSign.eSign/Api/WorkspacesApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ WorkspacesApi()

Member Function Documentation

◆ CreateWorkspace()

◆ CreateWorkspaceAsync()

◆ CreateWorkspaceAsyncWithHttpInfo()

◆ CreateWorkspaceFile()

◆ CreateWorkspaceFileAsync()

◆ CreateWorkspaceFileAsyncWithHttpInfo()

◆ CreateWorkspaceFileWithHttpInfo()

◆ CreateWorkspaceWithHttpInfo()

◆ DeleteWorkspace()

◆ DeleteWorkspaceAsync()

◆ DeleteWorkspaceAsyncWithHttpInfo()

◆ DeleteWorkspaceFolderItems()

◆ DeleteWorkspaceFolderItemsAsync()

◆ DeleteWorkspaceFolderItemsAsyncWithHttpInfo()

◆ DeleteWorkspaceFolderItemsWithHttpInfo()

◆ DeleteWorkspaceWithHttpInfo()

◆ GetBasePath()

◆ GetWorkspace()

◆ GetWorkspaceAsync()

◆ GetWorkspaceAsyncWithHttpInfo()

◆ GetWorkspaceFile()

◆ GetWorkspaceFileAsync()

◆ GetWorkspaceFileAsyncWithHttpInfo()

◆ GetWorkspaceFileWithHttpInfo()

◆ GetWorkspaceWithHttpInfo()

◆ ListWorkspaceFilePages()

◆ ListWorkspaceFilePagesAsync()

◆ ListWorkspaceFilePagesAsyncWithHttpInfo()

◆ ListWorkspaceFilePagesWithHttpInfo()

◆ ListWorkspaceFolderItems()

◆ ListWorkspaceFolderItemsAsync()

◆ ListWorkspaceFolderItemsAsyncWithHttpInfo()

◆ ListWorkspaceFolderItemsWithHttpInfo()

◆ ListWorkspaces()

◆ ListWorkspacesAsync()

◆ ListWorkspacesAsyncWithHttpInfo()

◆ ListWorkspacesWithHttpInfo()

◆ UpdateWorkspace()

◆ UpdateWorkspaceAsync()

◆ UpdateWorkspaceAsyncWithHttpInfo()

◆ UpdateWorkspaceFile()

◆ UpdateWorkspaceFileAsync()

◆ UpdateWorkspaceFileAsyncWithHttpInfo()

◆ UpdateWorkspaceFileWithHttpInfo()

◆ UpdateWorkspaceWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory