new module:model/BulkEnvelopeStatus()
- Source:
Constructs a new BulkEnvelopeStatus.
Members
(inner) batchId :String
- Source:
Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.
Type:
- String
(inner) batchSize :String
- Source:
The number of items returned in this response.
Type:
- String
(inner) bulkEnvelopes :Array.<module:model/BulkEnvelope>
- Source:
Reserved: TBD
Type:
- Array.<module:model/BulkEnvelope>
(inner) bulkEnvelopesBatchUri :String
- Source:
Reserved: TBD
Type:
- String
(inner) endPosition :String
- Source:
The last position in the result set.
Type:
- String
(inner) failed :String
- Source:
The number of entries with a status of failed.
Type:
- String
(inner) nextUri :String
- Source:
The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
Type:
- String
(inner) previousUri :String
- Source:
The postal code for the billing address.
Type:
- String
(inner) queued :String
- Source:
The number of entries with a status of queued.
Type:
- String
(inner) resultSetSize :String
- Source:
The number of results returned in this response.
Type:
- String
(inner) sent :String
- Source:
The number of entries with a status of sent.
Type:
- String
(inner) startPosition :String
- Source:
Starting position of the current result set.
Type:
- String
(inner) submittedDate :String
- Source:
Type:
- String
(inner) totalSetSize :String
- Source:
The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/BulkEnvelopeStatus}
- Source:
Constructs a BulkEnvelopeStatus 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/BulkEnvelopeStatus | Optional instance to populate. |
Returns:
The populated BulkEnvelopeStatus instance.