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

Inheritance diagram for DocuSign.eSign.Api.FoldersApi:

Classes
class	ListItemsOptions
	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. More...

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

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

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

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

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

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

async System.Threading.Tasks.Task< FoldersResponse >	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. More...

async System.Threading.Tasks.Task< ApiResponse< FoldersResponse > >	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. More...

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

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

async System.Threading.Tasks.Task< FolderItemsResponse >	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. More...

async 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. Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters. More...

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

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

async System.Threading.Tasks.Task< FoldersResponse >	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. More...

async 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. Moves envelopes 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. 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. More...

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

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

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

Public Member Functions inherited from DocuSign.eSign.Api.IFoldersApi
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...

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

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

◆ FoldersApi()

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

inline

Initializes a new instance of the FoldersApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ List()

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

inline

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: FoldersResponse

◆ ListAsync()

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

inline

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

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

inline

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.FoldersApi.ListItems	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

inline

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: FolderItemsResponse

◆ ListItemsAsync()

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

inline

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

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

inline

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.FoldersApi.ListItemsWithHttpInfo	(	string	accountId,
		string	folderId,
		FoldersApi.ListItemsOptions	options = `null`
	)

inline

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 FolderItemsResponse

◆ ListWithHttpInfo()

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

inline

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 FoldersResponse

◆ MoveEnvelopes()

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

inline

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: FoldersResponse

Implements DocuSign.eSign.Api.IFoldersApi.

◆ MoveEnvelopesAsync()

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

inline

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

Implements DocuSign.eSign.Api.IFoldersApi.

◆ MoveEnvelopesAsyncWithHttpInfo()

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

inline

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)

Implements DocuSign.eSign.Api.IFoldersApi.

◆ MoveEnvelopesWithHttpInfo()

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

inline

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 FoldersResponse

Implements DocuSign.eSign.Api.IFoldersApi.

◆ Search()

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

inline

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: FolderItemResponse

◆ SearchAsync()

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

inline

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

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

inline

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.FoldersApi.SearchWithHttpInfo	(	string	accountId,
		string	searchFolderId,
		FoldersApi.SearchOptions	options = `null`
	)

inline

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 FolderItemResponse

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.FoldersApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.FoldersApi.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/FoldersApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ FoldersApi()

Member Function Documentation

◆ GetBasePath()

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListItems()

◆ ListItemsAsync()

◆ ListItemsAsyncWithHttpInfo()

◆ ListItemsWithHttpInfo()

◆ ListWithHttpInfo()

◆ MoveEnvelopes()

◆ MoveEnvelopesAsync()

◆ MoveEnvelopesAsyncWithHttpInfo()

◆ MoveEnvelopesWithHttpInfo()

◆ Search()

◆ SearchAsync()

◆ SearchAsyncWithHttpInfo()

◆ SearchWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory