Struct docusign::Envelope

pub struct Envelope {

    pub documents: Vec<Document>,
    pub created_date_time: Option<DateTime<Utc>>,
    pub completed_date_time: Option<DateTime<Utc>>,
    pub declined_date_time: Option<DateTime<Utc>>,
    pub delivered_date_time: Option<DateTime<Utc>>,
    pub transaction_id: String,
    pub status: String,
    pub documents_uri: String,
    pub recipients_uri: String,
    pub attachments_uri: String,
    pub envelope_uri: String,
    pub email_subject: String,
    pub email_blurb: String,
    pub envelope_id: String,
    pub signing_location: String,
    pub custom_fields_uri: String,
    pub custom_fields: CustomFields,
    pub brand_lock: String,
    pub brand_id: String,
    pub use_disclosure: String,
    pub email_settings: EmailSettings,
    pub purge_state: String,
    pub lock_information: LockInformation,
    pub is21_cfr_part11: String,
    pub signer_can_sign_on_mobile: String,
    pub is_signature_provider_envelope: String,
    pub allow_view_history: String,
    pub allow_comments: String,
    pub allow_markup: String,
    pub allow_reassign: String,
    pub asynchronous: String,
    pub disable_responsive_document: String,
    pub copy_recipient_data: String,
    pub template_id: String,
    pub template_roles: Vec<TemplateRole>,
    pub recipients: Recipients,
}

Fields

documents: Vec<Document>

created_date_time: Option<DateTime<Utc>>

completed_date_time: Option<DateTime<Utc>>

declined_date_time: Option<DateTime<Utc>>

delivered_date_time: Option<DateTime<Utc>>

transaction_id: String

status: String

Indicates the envelope status. Valid values are:

• completed: The envelope has been completed and all tags have been signed.
• created: The envelope is created as a draft. It can be modified and sent later.
• declined: The envelope has been declined by the recipients.
• delivered: The envelope has been delivered to the recipients.
• sent: The envelope is sent to the recipients.
• signed: The envelope has been signed by the recipients.
• voided: The envelope is no longer valid and recipients cannot access or sign the envelope.

documents_uri: String

recipients_uri: String

attachments_uri: String

envelope_uri: String

email_subject: String

The subject line of the email message that is sent to all recipients.

For information about adding merge field information to the email subject, see Template Email Subject Merge Fields.

email_blurb: String

This is the same as the email body. If specified it is included in the email body for all envelope recipients.

envelope_id: String

signing_location: String

custom_fields_uri: String

custom_fields: CustomFields

brand_lock: String

brand_id: String

use_disclosure: String

email_settings: EmailSettings

purge_state: String

lock_information: LockInformation

is21_cfr_part11: String

signer_can_sign_on_mobile: String

is_signature_provider_envelope: String

allow_view_history: String

allow_comments: String

allow_markup: String

allow_reassign: String

asynchronous: String

disable_responsive_document: String

copy_recipient_data: String

template_id: String

The id of the template. If a value is not provided, DocuSign generates a value.

template_roles: Vec<TemplateRole>

recipients: Recipients

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Envelope

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Envelope

fn default() -> Envelope

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Envelope

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for Envelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.