new module:api/FoldersApi(apiClient)
- Source:
Constructs a new FoldersApi.
Parameters:
Name | Type | Description |
---|---|---|
apiClient |
module:ApiClient | Optional API client implementation to use, |
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
|
||||||||||||||||||||||||
callback |
module:api/FoldersApi~listCallback | The callback function, accepting three arguments: error, data, response |
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
|
|||||||||||||||||||||||||||
callback |
module:api/FoldersApi~listItemsCallback | The callback function, accepting three arguments: error, data, response |
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
|
||||||
callback |
module:api/FoldersApi~moveEnvelopesCallback | The callback function, accepting three arguments: error, data, response |
search(accountId, searchFolderId, optsOrCallback, callback)
- 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
|
|||||||||||||||||||||||||||
callback |
module:api/FoldersApi~searchCallback | The callback function, accepting three arguments: error, data, response |
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. |