Class: SignRequestsManager

SignRequestsManager(client)

Simple manager for interacting with all Sign Requests endpoints and actions.

Constructor

new SignRequestsManager(client)

Parameters:
Name Type Description
client BoxClient The Box API Client that is responsible for making calls to the API
Source:

Classes

SignRequestsManager

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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Source:
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
Source:
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
Name Type Attributes Description
marker string <optional>
 Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit number <optional>
 The maximum number of items to return per page.
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Attributes Description
marker string <optional>
 Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
limit number <optional>
 The maximum number of items to return per page.
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
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
Name Type Description
sign_request_id string The ID of the sign request
callback function <optional>
 Passed the result if successful, error otherwise
Source:
Returns:
A promise resolving to the result or rejecting with an error
Type
Promise.<void>