module:api/FoldersApi

module:api/FoldersApi

new module:api/FoldersApi(apiClient)

Source:

Constructs a new FoldersApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

list(accountId, optsOrCallback, callback)

Source:

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.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String
include String
includeItems String
startPosition String
subFolderDepth String
template String

Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
userFilter String
callback module:api/FoldersApi~listCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FoldersResponse

listItems(accountId, folderId, optsOrCallback, callback)

Source:

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.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
folderId String

The ID of the folder being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
fromDate String

Only return items on or after this date. If no value is provided, the default search is the previous 30 days.
includeItems String
ownerEmail String

The email of the folder owner.
ownerName String

The name of the folder owner.
searchText String

The search text used to search the items of the envelope. The search looks at recipient names and emails, envelope custom fields, sender name, and subject.
startPosition String

The position of the folder items to return. This is used for repeated calls, when the number of envelopes returned is too much for one return (calls return 100 envelopes at a time). The default value is 0.
status String

The current status of the envelope. If no value is provided, the default search is all/any status.
toDate String

Only return items up to this date. If no value is provided, the default search is to the current date.
callback module:api/FoldersApi~listItemsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FolderItemsResponse

moveEnvelopes(accountId, folderId, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
folderId String

The ID of the folder being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
foldersRequest module:model/FoldersRequest
callback module:api/FoldersApi~moveEnvelopesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FoldersResponse
Source:

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.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
searchFolderId String

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

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
all String

Specifies that all envelopes that match the criteria are returned.
count String

Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100.
fromDate String

Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
includeRecipients String

When set to true, the recipient information is returned in the response.
order String

Specifies the order in which the list is returned. Valid values are: asc for ascending order, and desc for descending order.
orderBy String

Specifies the property used to sort the list. Valid values are: action_required, created, completed, sent, signer_list, status, or subject.
startPosition String

Specifies the the starting location in the result set of the items that are returned.
toDate String

Specifies the end of the date range to return.
callback module:api/FoldersApi~searchCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FolderItemResponse

Type Definitions

listCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the list operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FoldersResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listItemsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listItems operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FolderItemsResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

moveEnvelopesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the moveEnvelopes operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FoldersResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

searchCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the search operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FolderItemResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.