module:model/EnvelopeDelayRuleApiModel

module:model/EnvelopeDelayRuleApiModel

new module:model/EnvelopeDelayRuleApiModel()

Source:

Constructs a new EnvelopeDelayRuleApiModel.
An envelope delay rule is a rule which determines how the envelope should be delayed either for sending or routing. It can expressed as either a delay in some number of days, hours, minutes and seconds or an exact resumeDate in the future.

Members

(inner) delay :String

Source:

A string timespan duration represented as d.hh:mm:ss where the d component is days, hh is hours measured on a 24-hour clock, mm is minutes and ss is seconds, indicating the expected delay for this envelope rule. The maximum delay is 30 days.

Type:
  • String

(inner) resumeDate :String

Source:

A string formatted as an ISO 8601 DATETIME with TimeZone specified, indicating the expected resumeDate for this envelope rule. The specified datetime must occur in the future relative to the current UTC time hen the request is made. The maximum resumeDate must not exceed 30 days in the future.

Type:
  • String

Methods

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

Source:

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

Optional instance to populate.

Returns:

The populated EnvelopeDelayRuleApiModel instance.

Type
module:model/EnvelopeDelayRuleApiModel