module:model/ScheduledSendingApiModel

module:model/ScheduledSendingApiModel

new module:model/ScheduledSendingApiModel()

Source:

Constructs a new ScheduledSendingApiModel.

Members

(inner) resumeDate :String

Source:

An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent or null if the envelope has not yet been sent.

Type:
  • String

(inner) rules :Array.<module:model/EnvelopeDelayRuleApiModel>

Source:

A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.

Type:

(inner) status :String

Source:

"pending" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. "started" if the scheduled sending delay is in progress. "completed" if the scheduled sending delay has elapsed and the envelope has been sent.

Type:
  • String

Methods

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

Source:

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

Optional instance to populate.

Returns:

The populated ScheduledSendingApiModel instance.

Type
module:model/ScheduledSendingApiModel