Constructor
new SignRequestsManager(client)
Parameters:
Name | Type | Description |
---|---|---|
client |
BoxClient | The Box API Client that is responsible for making calls to the API |
Classes
Methods
cancelById(options, callbackopt) → {Promise.<schemas.SignRequest>}
Cancel sign request
Cancels a sign request.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
cancelById(options, callbackopt) → {Promise.<schemas.SignRequest>}
Cancel sign request
Cancels a sign request.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
create(body, optionsopt, callbackopt) → {Promise.<schemas.SignRequest>}
Create sign request
Creates a sign request. This involves preparing a document for signing and
sending the sign request to signers.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
body |
schemas.SignRequestCreateRequest | ||
options |
object |
<optional> |
Options for the request |
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
create(body, optionsopt, callbackopt) → {Promise.<schemas.SignRequest>}
Create sign request
Creates a sign request. This involves preparing a document for signing and
sending the sign request to signers.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
body |
schemas.SignRequestCreateRequest | ||
options |
object |
<optional> |
Options for the request |
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
getAll(optionsopt, callbackopt) → {Promise.<schemas.SignRequests>}
List sign requests
Gets sign requests created by a user. If the `sign_files` and/or
`parent_folder` are deleted, the sign request will not return in the list.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
Options for the request
Properties
|
||||||||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequests>
getAll(optionsopt, callbackopt) → {Promise.<schemas.SignRequests>}
List sign requests
Gets sign requests created by a user. If the `sign_files` and/or
`parent_folder` are deleted, the sign request will not return in the list.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
Options for the request
Properties
|
||||||||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequests>
getById(options, callbackopt) → {Promise.<schemas.SignRequest>}
Get sign request by ID
Gets a sign request by ID.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
getById(options, callbackopt) → {Promise.<schemas.SignRequest>}
Get sign request by ID
Gets a sign request by ID.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<schemas.SignRequest>
resendById(options, callbackopt) → {Promise.<void>}
Resend sign request
Resends a sign request email to all outstanding signers.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<void>
resendById(options, callbackopt) → {Promise.<void>}
Resend sign request
Resends a sign request email to all outstanding signers.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
options |
object | Options for the request
Properties
|
|||||||
callback |
function |
<optional> |
Passed the result if successful, error otherwise |
Returns:
A promise resolving to the result or rejecting with an error
- Type
- Promise.<void>