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

Inheritance diagram for DocuSign.eSign.Api.IFoldersApi:

Public Member Functions
FoldersResponse	List (string accountId, FoldersApi.ListOptions options=null)
	Gets a list of the folders for the account. More...

ApiResponse< FoldersResponse >	ListWithHttpInfo (string accountId, FoldersApi.ListOptions options=null)
	Gets a list of the folders for the account. More...

FolderItemsResponse	ListItems (string accountId, string folderId, FoldersApi.ListItemsOptions options=null)
	Gets a list of the envelopes in the specified folder. More...

ApiResponse< FolderItemsResponse >	ListItemsWithHttpInfo (string accountId, string folderId, FoldersApi.ListItemsOptions options=null)
	Gets a list of the envelopes in the specified folder. More...

FoldersResponse	MoveEnvelopes (string accountId, string folderId, FoldersRequest foldersRequest=null)
	Moves an envelope from its current folder to the specified folder. More...

ApiResponse< FoldersResponse >	MoveEnvelopesWithHttpInfo (string accountId, string folderId, FoldersRequest foldersRequest=null)
	Moves an envelope from its current folder to the specified folder. More...

FolderItemResponse	Search (string accountId, string searchFolderId, FoldersApi.SearchOptions options=null)
	Gets a list of envelopes in folders matching the specified criteria. More...

ApiResponse< FolderItemResponse >	SearchWithHttpInfo (string accountId, string searchFolderId, FoldersApi.SearchOptions options=null)
	Gets a list of envelopes in folders matching the specified criteria. More...

System.Threading.Tasks.Task< FoldersResponse >	ListAsync (string accountId, FoldersApi.ListOptions options=null)
	Gets a list of the folders for the account. More...

System.Threading.Tasks.Task< ApiResponse< FoldersResponse > >	ListAsyncWithHttpInfo (string accountId, FoldersApi.ListOptions options=null)
	Gets a list of the folders for the account. More...

System.Threading.Tasks.Task< FolderItemsResponse >	ListItemsAsync (string accountId, string folderId, FoldersApi.ListItemsOptions options=null)
	Gets a list of the envelopes in the specified folder. More...

System.Threading.Tasks.Task< ApiResponse< FolderItemsResponse > >	ListItemsAsyncWithHttpInfo (string accountId, string folderId, FoldersApi.ListItemsOptions options=null)
	Gets a list of the envelopes in the specified folder. More...

System.Threading.Tasks.Task< FoldersResponse >	MoveEnvelopesAsync (string accountId, string folderId, FoldersRequest foldersRequest=null)
	Moves an envelope from its current folder to the specified folder. More...

System.Threading.Tasks.Task< ApiResponse< FoldersResponse > >	MoveEnvelopesAsyncWithHttpInfo (string accountId, string folderId, FoldersRequest foldersRequest=null)
	Moves an envelope from its current folder to the specified folder. More...

System.Threading.Tasks.Task< FolderItemResponse >	SearchAsync (string accountId, string searchFolderId, FoldersApi.SearchOptions options=null)
	Gets a list of envelopes in folders matching the specified criteria. More...

System.Threading.Tasks.Task< ApiResponse< FolderItemResponse > >	SearchAsyncWithHttpInfo (string accountId, string searchFolderId, FoldersApi.SearchOptions options=null)
	Gets a list of envelopes in folders matching the specified criteria. 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

◆ List()

FoldersResponse DocuSign.eSign.Api.IFoldersApi.List	(	string	accountId,
		FoldersApi.ListOptions	options = `null`
	)

Gets a list of the folders for the account.

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns

◆ ListAsync()

System.Threading.Tasks.Task<FoldersResponse> DocuSign.eSign.Api.IFoldersApi.ListAsync	(	string	accountId,
		FoldersApi.ListOptions	options = `null`
	)

Gets a list of the folders for the account.

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of FoldersResponse

◆ ListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<FoldersResponse> > DocuSign.eSign.Api.IFoldersApi.ListAsyncWithHttpInfo	(	string	accountId,
		FoldersApi.ListOptions	options = `null`
	)

Gets a list of the folders for the account.

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (FoldersResponse)

◆ ListItems()

FolderItemsResponse DocuSign.eSign.Api.IFoldersApi.ListItems	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

Gets a list of the envelopes in the specified folder.

Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Exceptions

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

Parameters

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

Returns

◆ ListItemsAsync()

System.Threading.Tasks.Task<FolderItemsResponse> DocuSign.eSign.Api.IFoldersApi.ListItemsAsync	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

Gets a list of the envelopes in the specified folder.

Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Exceptions

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

Parameters

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

Returns: Task of FolderItemsResponse

◆ ListItemsAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<FolderItemsResponse> > DocuSign.eSign.Api.IFoldersApi.ListItemsAsyncWithHttpInfo	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

Gets a list of the envelopes in the specified folder.

Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (FolderItemsResponse)

◆ ListItemsWithHttpInfo()

ApiResponse<FolderItemsResponse> DocuSign.eSign.Api.IFoldersApi.ListItemsWithHttpInfo	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

Gets a list of the envelopes in the specified folder.

Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters.

Exceptions

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

Parameters

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

Returns: ApiResponse of

◆ ListWithHttpInfo()

ApiResponse<FoldersResponse> DocuSign.eSign.Api.IFoldersApi.ListWithHttpInfo	(	string	accountId,
		FoldersApi.ListOptions	options = `null`
	)

Gets a list of the folders for the account.

Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

◆ MoveEnvelopes()

FoldersResponse DocuSign.eSign.Api.IFoldersApi.MoveEnvelopes	(	string	accountId,
		string	folderId,
		FoldersRequest	foldersRequest = `null`
	)

Moves an envelope from its current folder to the specified folder.

Moves envelopes to the specified folder.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
folderId	The ID of the folder being accessed.
foldersRequest	(optional)

Returns

Implemented in DocuSign.eSign.Api.FoldersApi.

◆ MoveEnvelopesAsync()

System.Threading.Tasks.Task<FoldersResponse> DocuSign.eSign.Api.IFoldersApi.MoveEnvelopesAsync	(	string	accountId,
		string	folderId,
		FoldersRequest	foldersRequest = `null`
	)

Moves an envelope from its current folder to the specified folder.

Moves envelopes to the specified folder.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
folderId	The ID of the folder being accessed.
foldersRequest	(optional)

Returns: Task of FoldersResponse

Implemented in DocuSign.eSign.Api.FoldersApi.

◆ MoveEnvelopesAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<FoldersResponse> > DocuSign.eSign.Api.IFoldersApi.MoveEnvelopesAsyncWithHttpInfo	(	string	accountId,
		string	folderId,
		FoldersRequest	foldersRequest = `null`
	)

Moves an envelope from its current folder to the specified folder.

Moves envelopes to the specified folder.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
folderId	The ID of the folder being accessed.
foldersRequest	(optional)

Returns: Task of ApiResponse (FoldersResponse)

Implemented in DocuSign.eSign.Api.FoldersApi.

◆ MoveEnvelopesWithHttpInfo()

ApiResponse<FoldersResponse> DocuSign.eSign.Api.IFoldersApi.MoveEnvelopesWithHttpInfo	(	string	accountId,
		string	folderId,
		FoldersRequest	foldersRequest = `null`
	)

Moves an envelope from its current folder to the specified folder.

Moves envelopes to the specified folder.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
folderId	The ID of the folder being accessed.
foldersRequest	(optional)

Returns: ApiResponse of

Implemented in DocuSign.eSign.Api.FoldersApi.

◆ Search()

FolderItemResponse DocuSign.eSign.Api.IFoldersApi.Search	(	string	accountId,
		string	searchFolderId,
		FoldersApi.SearchOptions	options = `null`
	)

Gets a list of envelopes in folders matching the specified criteria.

Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
searchFolderId	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
options	Options for modifying the behavior of the function.

Returns

◆ SearchAsync()

System.Threading.Tasks.Task<FolderItemResponse> DocuSign.eSign.Api.IFoldersApi.SearchAsync	(	string	accountId,
		string	searchFolderId,
		FoldersApi.SearchOptions	options = `null`
	)

Gets a list of envelopes in folders matching the specified criteria.

Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
searchFolderId	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
options	Options for modifying the behavior of the function.

Returns: Task of FolderItemResponse

◆ SearchAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<FolderItemResponse> > DocuSign.eSign.Api.IFoldersApi.SearchAsyncWithHttpInfo	(	string	accountId,
		string	searchFolderId,
		FoldersApi.SearchOptions	options = `null`
	)

Gets a list of envelopes in folders matching the specified criteria.

Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
searchFolderId	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (FolderItemResponse)

◆ SearchWithHttpInfo()

ApiResponse<FolderItemResponse> DocuSign.eSign.Api.IFoldersApi.SearchWithHttpInfo	(	string	accountId,
		string	searchFolderId,
		FoldersApi.SearchOptions	options = `null`
	)

Gets a list of envelopes in folders matching the specified criteria.

Retrieves a list of envelopes that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
searchFolderId	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListItems()

◆ ListItemsAsync()

◆ ListItemsAsyncWithHttpInfo()

◆ ListItemsWithHttpInfo()

◆ ListWithHttpInfo()

◆ MoveEnvelopes()

◆ MoveEnvelopesAsync()

◆ MoveEnvelopesAsyncWithHttpInfo()

◆ MoveEnvelopesWithHttpInfo()

◆ Search()

◆ SearchAsync()

◆ SearchAsyncWithHttpInfo()

◆ SearchWithHttpInfo()