new module:model/BulkEnvelope()
- Source:
Constructs a new BulkEnvelope.
Members
(inner) bulkRecipientRow :String
- Source:
Reserved: TBD
Type:
- String
(inner) bulkStatus :String
- Source:
Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed
Type:
- String
(inner) email :String
- Source:
Type:
- String
(inner) envelopeId :String
- Source:
The envelope ID of the envelope status that failed to post.
Type:
- String
(inner) envelopeUri :String
- Source:
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Type:
- String
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) name :String
- Source:
Type:
- String
(inner) submittedDateTime :String
- Source:
Type:
- String
(inner) transactionId :String
- Source:
Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/BulkEnvelope}
- Source:
Constructs a BulkEnvelope from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/BulkEnvelope | Optional instance to populate. |
Returns:
The populated BulkEnvelope instance.