module:model/EnvelopeSummary

module:model/EnvelopeSummary

new module:model/EnvelopeSummary()

Source:

Constructs a new EnvelopeSummary.
This object describes an envelope.

Members

(inner) bulkEnvelopeStatus :module:model/BulkEnvelopeStatus

Source:

An object that describes the status of the bulk send envelopes.

Type:

(inner) envelopeId :String

Source:

The envelope ID of the envelope status that failed to post.

Type:
  • String

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) recipientSigningUri :String

Source:
Type:
  • String

(inner) recipientSigningUriError :String

Source:
Type:
  • String

(inner) status :String

Source:

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Type:
  • String

(inner) statusDateTime :String

Source:

The DateTime that the envelope changed status (i.e. was created or sent.)

Type:
  • String

(inner) uri :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/EnvelopeSummary}

Source:

Constructs a EnvelopeSummary 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/EnvelopeSummary

Optional instance to populate.

Returns:

The populated EnvelopeSummary instance.

Type
module:model/EnvelopeSummary