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

Inheritance diagram for DocuSign.eSign.Api.IWorkspacesApi:

Public Member Functions
Workspace	CreateWorkspace (string accountId, Workspace workspace=null)
	Create a Workspace More...

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

WorkspaceItem	CreateWorkspaceFile (string accountId, string workspaceId, string folderId)
	Creates a workspace file. More...

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

Workspace	DeleteWorkspace (string accountId, string workspaceId)
	Delete Workspace More...

ApiResponse< Workspace >	DeleteWorkspaceWithHttpInfo (string accountId, string workspaceId)
	Delete Workspace 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. 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. More...

Workspace	GetWorkspace (string accountId, string workspaceId)
	Get Workspace More...

ApiResponse< Workspace >	GetWorkspaceWithHttpInfo (string accountId, string workspaceId)
	Get Workspace More...

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

WorkspaceList	ListWorkspaces (string accountId)
	List Workspaces More...

ApiResponse< WorkspaceList >	ListWorkspacesWithHttpInfo (string accountId)
	List Workspaces More...

Workspace	UpdateWorkspace (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace More...

ApiResponse< Workspace >	UpdateWorkspaceWithHttpInfo (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace More...

WorkspaceItem	UpdateWorkspaceFile (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata More...

ApiResponse< WorkspaceItem >	UpdateWorkspaceFileWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata More...

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

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

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

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

System.Threading.Tasks.Task< Workspace >	DeleteWorkspaceAsync (string accountId, string workspaceId)
	Delete Workspace More...

System.Threading.Tasks.Task< ApiResponse< Workspace > >	DeleteWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId)
	Delete Workspace More...

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

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

System.Threading.Tasks.Task< Workspace >	GetWorkspaceAsync (string accountId, string workspaceId)
	Get Workspace More...

System.Threading.Tasks.Task< ApiResponse< Workspace > >	GetWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId)
	Get Workspace 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...

System.Threading.Tasks.Task< WorkspaceList >	ListWorkspacesAsync (string accountId)
	List Workspaces More...

System.Threading.Tasks.Task< ApiResponse< WorkspaceList > >	ListWorkspacesAsyncWithHttpInfo (string accountId)
	List Workspaces More...

System.Threading.Tasks.Task< Workspace >	UpdateWorkspaceAsync (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace More...

System.Threading.Tasks.Task< ApiResponse< Workspace > >	UpdateWorkspaceAsyncWithHttpInfo (string accountId, string workspaceId, Workspace workspace=null)
	Update Workspace More...

System.Threading.Tasks.Task< WorkspaceItem >	UpdateWorkspaceFileAsync (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata More...

System.Threading.Tasks.Task< ApiResponse< WorkspaceItem > >	UpdateWorkspaceFileAsyncWithHttpInfo (string accountId, string workspaceId, string folderId, string fileId)
	Update Workspace File Metadata More...

Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
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

Member Function Documentation

◆ CreateWorkspace()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceFile()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceFileAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceFileAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceFileWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ CreateWorkspaceWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspace()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceFolderItems()

void DocuSign.eSign.Api.IWorkspacesApi.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`.

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceFolderItemsAsync()

System.Threading.Tasks.Task DocuSign.eSign.Api.IWorkspacesApi.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`.

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceFolderItemsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<Object> > DocuSign.eSign.Api.IWorkspacesApi.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`.

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceFolderItemsWithHttpInfo()

ApiResponse<Object> DocuSign.eSign.Api.IWorkspacesApi.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`.

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ DeleteWorkspaceWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ GetWorkspace()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ GetWorkspaceAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ GetWorkspaceAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ GetWorkspaceFile()

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

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()

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

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()

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

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.IWorkspacesApi.GetWorkspaceFileWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.GetWorkspaceFileOptions	options = `null`
	)

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.IWorkspacesApi.GetWorkspaceWithHttpInfo	(	string	accountId,
		string	workspaceId
	)

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ ListWorkspaceFilePages()

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

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

◆ ListWorkspaceFilePagesAsync()

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

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()

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

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.IWorkspacesApi.ListWorkspaceFilePagesWithHttpInfo	(	string	accountId,
		string	workspaceId,
		string	folderId,
		string	fileId,
		WorkspacesApi.ListWorkspaceFilePagesOptions	options = `null`
	)

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

◆ ListWorkspaceFolderItems()

WorkspaceFolderContents DocuSign.eSign.Api.IWorkspacesApi.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.

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

◆ ListWorkspaceFolderItemsAsync()

System.Threading.Tasks.Task<WorkspaceFolderContents> DocuSign.eSign.Api.IWorkspacesApi.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.

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()

System.Threading.Tasks.Task<ApiResponse<WorkspaceFolderContents> > DocuSign.eSign.Api.IWorkspacesApi.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.

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

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

◆ ListWorkspaces()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ ListWorkspacesAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ ListWorkspacesAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ ListWorkspacesWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspace()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceFile()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceFileAsync()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceFileAsyncWithHttpInfo()

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

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)

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceFileWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

◆ UpdateWorkspaceWithHttpInfo()

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

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

Implemented in DocuSign.eSign.Api.WorkspacesApi.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateWorkspace()

◆ CreateWorkspaceAsync()

◆ CreateWorkspaceAsyncWithHttpInfo()

◆ CreateWorkspaceFile()

◆ CreateWorkspaceFileAsync()

◆ CreateWorkspaceFileAsyncWithHttpInfo()

◆ CreateWorkspaceFileWithHttpInfo()

◆ CreateWorkspaceWithHttpInfo()

◆ DeleteWorkspace()

◆ DeleteWorkspaceAsync()

◆ DeleteWorkspaceAsyncWithHttpInfo()

◆ DeleteWorkspaceFolderItems()

◆ DeleteWorkspaceFolderItemsAsync()

◆ DeleteWorkspaceFolderItemsAsyncWithHttpInfo()

◆ DeleteWorkspaceFolderItemsWithHttpInfo()

◆ DeleteWorkspaceWithHttpInfo()

◆ 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()