Documentation

EnvelopeDefinition
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess

EnvelopeDefinition Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess

DISCRIMINATOR = null
$attributeMap : array<string|int, string>: Array of attributes where the key is the local name, and the value is the original name
$container : array<string|int, mixed>: Associative array for storing property values
$getters : array<string|int, string>: Array of attributes to getter functions (for serialization of requests)
$setters : array<string|int, string>: Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats : array<string|int, string>: Array of property to format mappings. Used for (de)serialization
$swaggerModelName : string: The original name of the model.
$swaggerTypes : array<string|int, string>: Array of property to type mappings. Used for (de)serialization
__construct() : mixed: Constructor
__toString() : string: Gets the string presentation of the object
attributeMap() : array<string|int, mixed>: Array of attributes where the key is the local name, and the value is the original name
getAccessControlListBase64() : string|null: Gets access_control_list_base64
getAccessibility() : string|null: Gets accessibility
getAllowComments() : string|null: Gets allow_comments
getAllowMarkup() : string|null: Gets allow_markup
getAllowReassign() : string|null: Gets allow_reassign
getAllowRecipientRecursion() : string|null: Gets allow_recipient_recursion
getAllowViewHistory() : string|null: Gets allow_view_history
getAnySigner() : string|null: Gets any_signer
getAsynchronous() : string|null: Gets asynchronous
getAttachments() : array<string|int, Attachment>: Gets attachments
getAttachmentsUri() : string|null: Gets attachments_uri
getAuthoritativeCopy() : string|null: Gets authoritative_copy
getAuthoritativeCopyDefault() : string|null: Gets authoritative_copy_default
getAutoNavigation() : string|null: Gets auto_navigation
getBrandId() : string|null: Gets brand_id
getBrandLock() : string|null: Gets brand_lock
getBurnDefaultTabData() : string|null: Gets burn_default_tab_data
getCertificateUri() : string|null: Gets certificate_uri
getCompletedDateTime() : string|null: Gets completed_date_time
getCompositeTemplates() : array<string|int, CompositeTemplate>: Gets composite_templates
getCopyRecipientData() : string|null: Gets copy_recipient_data
getCreatedDateTime() : string|null: Gets created_date_time
getCustomFields() : CustomFields: Gets custom_fields
getCustomFieldsUri() : string|null: Gets custom_fields_uri
getDeclinedDateTime() : string|null: Gets declined_date_time
getDeletedDateTime() : string|null: Gets deleted_date_time
getDeliveredDateTime() : string|null: Gets delivered_date_time
getDisableResponsiveDocument() : string|null: Gets disable_responsive_document
getDocumentBase64() : string|null: Gets document_base64
getDocuments() : array<string|int, Document>: Gets documents
getDocumentsCombinedUri() : string|null: Gets documents_combined_uri
getDocumentsUri() : string|null: Gets documents_uri
getEmailBlurb() : string|null: Gets email_blurb
getEmailSettings() : EmailSettings: Gets email_settings
getEmailSubject() : string|null: Gets email_subject
getEnableWetSign() : string|null: Gets enable_wet_sign
getEnforceSignerVisibility() : string|null: Gets enforce_signer_visibility
getEnvelopeAttachments() : array<string|int, Attachment>: Gets envelope_attachments
getEnvelopeCustomMetadata() : EnvelopeCustomMetadata: Gets envelope_custom_metadata
getEnvelopeDocuments() : array<string|int, EnvelopeDocument>: Gets envelope_documents
getEnvelopeId() : string|null: Gets envelope_id
getEnvelopeIdStamping() : string|null: Gets envelope_id_stamping
getEnvelopeLocation() : string|null: Gets envelope_location
getEnvelopeMetadata() : EnvelopeMetadata: Gets envelope_metadata
getEnvelopeUri() : string|null: Gets envelope_uri
getEventNotification() : EventNotification: Gets event_notification
getEventNotifications() : array<string|int, EventNotification>: Gets event_notifications
getExpireAfter() : string|null: Gets expire_after
getExpireDateTime() : string|null: Gets expire_date_time
getExpireEnabled() : string|null: Gets expire_enabled
getExternalEnvelopeId() : string|null: Gets external_envelope_id
getFolders() : array<string|int, Folder>: Gets folders
getHasComments() : string|null: Gets has_comments
getHasFormDataChanged() : string|null: Gets has_form_data_changed
getHasWavFile() : string|null: Gets has_wav_file
getHolder() : string|null: Gets holder
getInitialSentDateTime() : string|null: Gets initial_sent_date_time
getIs21CfrPart11() : string|null: Gets is21_cfr_part11
getIsDynamicEnvelope() : string|null: Gets is_dynamic_envelope
getIsSignatureProviderEnvelope() : string|null: Gets is_signature_provider_envelope
getLastModifiedDateTime() : string|null: Gets last_modified_date_time
getLocation() : string|null: Gets location
getLockInformation() : LockInformation: Gets lock_information
getMessageLock() : string|null: Gets message_lock
getModelName() : string: The original name of the model.
getNotification() : Notification: Gets notification
getNotificationUri() : string|null: Gets notification_uri
getPassword() : string|null: Gets password
getPowerForm() : PowerForm: Gets power_form
getPurgeCompletedDate() : string|null: Gets purge_completed_date
getPurgeRequestDate() : string|null: Gets purge_request_date
getPurgeState() : string|null: Gets purge_state
getRecipients() : Recipients: Gets recipients
getRecipientsLock() : string|null: Gets recipients_lock
getRecipientsUri() : string|null: Gets recipients_uri
getRecipientViewRequest() : RecipientViewRequest: Gets recipient_view_request
getSender() : UserInfo: Gets sender
getSentDateTime() : string|null: Gets sent_date_time
getSignerCanSignOnMobile() : string|null: Gets signer_can_sign_on_mobile
getSigningLocation() : string|null: Gets signing_location
getStatus() : string|null: Gets status
getStatusChangedDateTime() : string|null: Gets status_changed_date_time
getStatusDateTime() : string|null: Gets status_date_time
getTemplateId() : string|null: Gets template_id
getTemplateRoles() : array<string|int, TemplateRole>: Gets template_roles
getTemplatesUri() : string|null: Gets templates_uri
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getTransactionId() : string|null: Gets transaction_id
getUseDisclosure() : string|null: Gets use_disclosure
getUSigState() : string|null: Gets u_sig_state
getVoidedDateTime() : string|null: Gets voided_date_time
getVoidedReason() : string|null: Gets voided_reason
getWorkflow() : Workflow: Gets workflow
listInvalidProperties() : array<string|int, mixed>: Show all the invalid properties with reasons.
offsetExists() : bool: Returns true if offset exists. False otherwise.
offsetGet() : mixed: Gets offset.
offsetSet() : void: Sets value based on offset.
offsetUnset() : void: Unsets offset.
setAccessControlListBase64() : $this: Sets access_control_list_base64
setAccessibility() : $this: Sets accessibility
setAllowComments() : $this: Sets allow_comments
setAllowMarkup() : $this: Sets allow_markup
setAllowReassign() : $this: Sets allow_reassign
setAllowRecipientRecursion() : $this: Sets allow_recipient_recursion
setAllowViewHistory() : $this: Sets allow_view_history
setAnySigner() : $this: Sets any_signer
setAsynchronous() : $this: Sets asynchronous
setAttachments() : $this: Sets attachments
setAttachmentsUri() : $this: Sets attachments_uri
setAuthoritativeCopy() : $this: Sets authoritative_copy
setAuthoritativeCopyDefault() : $this: Sets authoritative_copy_default
setAutoNavigation() : $this: Sets auto_navigation
setBrandId() : $this: Sets brand_id
setBrandLock() : $this: Sets brand_lock
setBurnDefaultTabData() : $this: Sets burn_default_tab_data
setCertificateUri() : $this: Sets certificate_uri
setCompletedDateTime() : $this: Sets completed_date_time
setCompositeTemplates() : $this: Sets composite_templates
setCopyRecipientData() : $this: Sets copy_recipient_data
setCreatedDateTime() : $this: Sets created_date_time
setCustomFields() : $this: Sets custom_fields
setCustomFieldsUri() : $this: Sets custom_fields_uri
setDeclinedDateTime() : $this: Sets declined_date_time
setDeletedDateTime() : $this: Sets deleted_date_time
setDeliveredDateTime() : $this: Sets delivered_date_time
setDisableResponsiveDocument() : $this: Sets disable_responsive_document
setDocumentBase64() : $this: Sets document_base64
setDocuments() : $this: Sets documents
setDocumentsCombinedUri() : $this: Sets documents_combined_uri
setDocumentsUri() : $this: Sets documents_uri
setEmailBlurb() : $this: Sets email_blurb
setEmailSettings() : $this: Sets email_settings
setEmailSubject() : $this: Sets email_subject
setEnableWetSign() : $this: Sets enable_wet_sign
setEnforceSignerVisibility() : $this: Sets enforce_signer_visibility
setEnvelopeAttachments() : $this: Sets envelope_attachments
setEnvelopeCustomMetadata() : $this: Sets envelope_custom_metadata
setEnvelopeDocuments() : $this: Sets envelope_documents
setEnvelopeId() : $this: Sets envelope_id
setEnvelopeIdStamping() : $this: Sets envelope_id_stamping
setEnvelopeLocation() : $this: Sets envelope_location
setEnvelopeMetadata() : $this: Sets envelope_metadata
setEnvelopeUri() : $this: Sets envelope_uri
setEventNotification() : $this: Sets event_notification
setEventNotifications() : $this: Sets event_notifications
setExpireAfter() : $this: Sets expire_after
setExpireDateTime() : $this: Sets expire_date_time
setExpireEnabled() : $this: Sets expire_enabled
setExternalEnvelopeId() : $this: Sets external_envelope_id
setFolders() : $this: Sets folders
setHasComments() : $this: Sets has_comments
setHasFormDataChanged() : $this: Sets has_form_data_changed
setHasWavFile() : $this: Sets has_wav_file
setHolder() : $this: Sets holder
setInitialSentDateTime() : $this: Sets initial_sent_date_time
setIs21CfrPart11() : $this: Sets is21_cfr_part11
setIsDynamicEnvelope() : $this: Sets is_dynamic_envelope
setIsSignatureProviderEnvelope() : $this: Sets is_signature_provider_envelope
setLastModifiedDateTime() : $this: Sets last_modified_date_time
setLocation() : $this: Sets location
setLockInformation() : $this: Sets lock_information
setMessageLock() : $this: Sets message_lock
setNotification() : $this: Sets notification
setNotificationUri() : $this: Sets notification_uri
setPassword() : $this: Sets password
setPowerForm() : $this: Sets power_form
setPurgeCompletedDate() : $this: Sets purge_completed_date
setPurgeRequestDate() : $this: Sets purge_request_date
setPurgeState() : $this: Sets purge_state
setRecipients() : $this: Sets recipients
setRecipientsLock() : $this: Sets recipients_lock
setRecipientsUri() : $this: Sets recipients_uri
setRecipientViewRequest() : $this: Sets recipient_view_request
setSender() : $this: Sets sender
setSentDateTime() : $this: Sets sent_date_time
setSignerCanSignOnMobile() : $this: Sets signer_can_sign_on_mobile
setSigningLocation() : $this: Sets signing_location
setStatus() : $this: Sets status
setStatusChangedDateTime() : $this: Sets status_changed_date_time
setStatusDateTime() : $this: Sets status_date_time
setTemplateId() : $this: Sets template_id
setTemplateRoles() : $this: Sets template_roles
setTemplatesUri() : $this: Sets templates_uri
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setTransactionId() : $this: Sets transaction_id
setUseDisclosure() : $this: Sets use_disclosure
setUSigState() : $this: Sets u_sig_state
setVoidedDateTime() : $this: Sets voided_date_time
setVoidedReason() : $this: Sets voided_reason
setWorkflow() : $this: Sets workflow
swaggerFormats() : array<string|int, mixed>: Array of property to format mappings. Used for (de)serialization
swaggerTypes() : array<string|int, mixed>: Array of property to type mappings. Used for (de)serialization
valid() : bool: Validate all the properties in the model return true if all passed

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$attributeMap

Array of attributes where the key is the local name, and the value is the original name


    protected
    static    array<string|int, string>
    $attributeMap
     = ['access_control_list_base64' => 'accessControlListBase64', 'accessibility' => 'accessibility', 'allow_comments' => 'allowComments', 'allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', 'allow_recipient_recursion' => 'allowRecipientRecursion', 'allow_view_history' => 'allowViewHistory', 'any_signer' => 'anySigner', 'asynchronous' => 'asynchronous', 'attachments' => 'attachments', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', 'burn_default_tab_data' => 'burnDefaultTabData', 'certificate_uri' => 'certificateUri', 'completed_date_time' => 'completedDateTime', 'composite_templates' => 'compositeTemplates', 'copy_recipient_data' => 'copyRecipientData', 'created_date_time' => 'createdDateTime', 'custom_fields' => 'customFields', 'custom_fields_uri' => 'customFieldsUri', 'declined_date_time' => 'declinedDateTime', 'deleted_date_time' => 'deletedDateTime', 'delivered_date_time' => 'deliveredDateTime', 'disable_responsive_document' => 'disableResponsiveDocument', 'document_base64' => 'documentBase64', 'documents' => 'documents', 'documents_combined_uri' => 'documentsCombinedUri', 'documents_uri' => 'documentsUri', 'email_blurb' => 'emailBlurb', 'email_settings' => 'emailSettings', 'email_subject' => 'emailSubject', 'enable_wet_sign' => 'enableWetSign', 'enforce_signer_visibility' => 'enforceSignerVisibility', 'envelope_attachments' => 'envelopeAttachments', 'envelope_custom_metadata' => 'envelopeCustomMetadata', 'envelope_documents' => 'envelopeDocuments', 'envelope_id' => 'envelopeId', 'envelope_id_stamping' => 'envelopeIdStamping', 'envelope_location' => 'envelopeLocation', 'envelope_metadata' => 'envelopeMetadata', 'envelope_uri' => 'envelopeUri', 'event_notification' => 'eventNotification', 'event_notifications' => 'eventNotifications', 'expire_after' => 'expireAfter', 'expire_date_time' => 'expireDateTime', 'expire_enabled' => 'expireEnabled', 'external_envelope_id' => 'externalEnvelopeId', 'folders' => 'folders', 'has_comments' => 'hasComments', 'has_form_data_changed' => 'hasFormDataChanged', 'has_wav_file' => 'hasWavFile', 'holder' => 'holder', 'initial_sent_date_time' => 'initialSentDateTime', 'is21_cfr_part11' => 'is21CFRPart11', 'is_dynamic_envelope' => 'isDynamicEnvelope', 'is_signature_provider_envelope' => 'isSignatureProviderEnvelope', 'last_modified_date_time' => 'lastModifiedDateTime', 'location' => 'location', 'lock_information' => 'lockInformation', 'message_lock' => 'messageLock', 'notification' => 'notification', 'notification_uri' => 'notificationUri', 'password' => 'password', 'power_form' => 'powerForm', 'purge_completed_date' => 'purgeCompletedDate', 'purge_request_date' => 'purgeRequestDate', 'purge_state' => 'purgeState', 'recipients' => 'recipients', 'recipients_lock' => 'recipientsLock', 'recipients_uri' => 'recipientsUri', 'recipient_view_request' => 'recipientViewRequest', 'sender' => 'sender', 'sent_date_time' => 'sentDateTime', 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', 'status_date_time' => 'statusDateTime', 'template_id' => 'templateId', 'template_roles' => 'templateRoles', 'templates_uri' => 'templatesUri', 'transaction_id' => 'transactionId', 'use_disclosure' => 'useDisclosure', 'u_sig_state' => 'uSigState', 'voided_date_time' => 'voidedDateTime', 'voided_reason' => 'voidedReason', 'workflow' => 'workflow']

$container

Associative array for storing property values


    protected
        array<string|int, mixed>
    $container
     = []

$getters

Array of attributes to getter functions (for serialization of requests)


    protected
    static    array<string|int, string>
    $getters
     = ['access_control_list_base64' => 'getAccessControlListBase64', 'accessibility' => 'getAccessibility', 'allow_comments' => 'getAllowComments', 'allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', 'allow_recipient_recursion' => 'getAllowRecipientRecursion', 'allow_view_history' => 'getAllowViewHistory', 'any_signer' => 'getAnySigner', 'asynchronous' => 'getAsynchronous', 'attachments' => 'getAttachments', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', 'burn_default_tab_data' => 'getBurnDefaultTabData', 'certificate_uri' => 'getCertificateUri', 'completed_date_time' => 'getCompletedDateTime', 'composite_templates' => 'getCompositeTemplates', 'copy_recipient_data' => 'getCopyRecipientData', 'created_date_time' => 'getCreatedDateTime', 'custom_fields' => 'getCustomFields', 'custom_fields_uri' => 'getCustomFieldsUri', 'declined_date_time' => 'getDeclinedDateTime', 'deleted_date_time' => 'getDeletedDateTime', 'delivered_date_time' => 'getDeliveredDateTime', 'disable_responsive_document' => 'getDisableResponsiveDocument', 'document_base64' => 'getDocumentBase64', 'documents' => 'getDocuments', 'documents_combined_uri' => 'getDocumentsCombinedUri', 'documents_uri' => 'getDocumentsUri', 'email_blurb' => 'getEmailBlurb', 'email_settings' => 'getEmailSettings', 'email_subject' => 'getEmailSubject', 'enable_wet_sign' => 'getEnableWetSign', 'enforce_signer_visibility' => 'getEnforceSignerVisibility', 'envelope_attachments' => 'getEnvelopeAttachments', 'envelope_custom_metadata' => 'getEnvelopeCustomMetadata', 'envelope_documents' => 'getEnvelopeDocuments', 'envelope_id' => 'getEnvelopeId', 'envelope_id_stamping' => 'getEnvelopeIdStamping', 'envelope_location' => 'getEnvelopeLocation', 'envelope_metadata' => 'getEnvelopeMetadata', 'envelope_uri' => 'getEnvelopeUri', 'event_notification' => 'getEventNotification', 'event_notifications' => 'getEventNotifications', 'expire_after' => 'getExpireAfter', 'expire_date_time' => 'getExpireDateTime', 'expire_enabled' => 'getExpireEnabled', 'external_envelope_id' => 'getExternalEnvelopeId', 'folders' => 'getFolders', 'has_comments' => 'getHasComments', 'has_form_data_changed' => 'getHasFormDataChanged', 'has_wav_file' => 'getHasWavFile', 'holder' => 'getHolder', 'initial_sent_date_time' => 'getInitialSentDateTime', 'is21_cfr_part11' => 'getIs21CfrPart11', 'is_dynamic_envelope' => 'getIsDynamicEnvelope', 'is_signature_provider_envelope' => 'getIsSignatureProviderEnvelope', 'last_modified_date_time' => 'getLastModifiedDateTime', 'location' => 'getLocation', 'lock_information' => 'getLockInformation', 'message_lock' => 'getMessageLock', 'notification' => 'getNotification', 'notification_uri' => 'getNotificationUri', 'password' => 'getPassword', 'power_form' => 'getPowerForm', 'purge_completed_date' => 'getPurgeCompletedDate', 'purge_request_date' => 'getPurgeRequestDate', 'purge_state' => 'getPurgeState', 'recipients' => 'getRecipients', 'recipients_lock' => 'getRecipientsLock', 'recipients_uri' => 'getRecipientsUri', 'recipient_view_request' => 'getRecipientViewRequest', 'sender' => 'getSender', 'sent_date_time' => 'getSentDateTime', 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', 'status_date_time' => 'getStatusDateTime', 'template_id' => 'getTemplateId', 'template_roles' => 'getTemplateRoles', 'templates_uri' => 'getTemplatesUri', 'transaction_id' => 'getTransactionId', 'use_disclosure' => 'getUseDisclosure', 'u_sig_state' => 'getUSigState', 'voided_date_time' => 'getVoidedDateTime', 'voided_reason' => 'getVoidedReason', 'workflow' => 'getWorkflow']

$setters

Array of attributes to setter functions (for deserialization of responses)


    protected
    static    array<string|int, string>
    $setters
     = ['access_control_list_base64' => 'setAccessControlListBase64', 'accessibility' => 'setAccessibility', 'allow_comments' => 'setAllowComments', 'allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', 'allow_recipient_recursion' => 'setAllowRecipientRecursion', 'allow_view_history' => 'setAllowViewHistory', 'any_signer' => 'setAnySigner', 'asynchronous' => 'setAsynchronous', 'attachments' => 'setAttachments', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', 'burn_default_tab_data' => 'setBurnDefaultTabData', 'certificate_uri' => 'setCertificateUri', 'completed_date_time' => 'setCompletedDateTime', 'composite_templates' => 'setCompositeTemplates', 'copy_recipient_data' => 'setCopyRecipientData', 'created_date_time' => 'setCreatedDateTime', 'custom_fields' => 'setCustomFields', 'custom_fields_uri' => 'setCustomFieldsUri', 'declined_date_time' => 'setDeclinedDateTime', 'deleted_date_time' => 'setDeletedDateTime', 'delivered_date_time' => 'setDeliveredDateTime', 'disable_responsive_document' => 'setDisableResponsiveDocument', 'document_base64' => 'setDocumentBase64', 'documents' => 'setDocuments', 'documents_combined_uri' => 'setDocumentsCombinedUri', 'documents_uri' => 'setDocumentsUri', 'email_blurb' => 'setEmailBlurb', 'email_settings' => 'setEmailSettings', 'email_subject' => 'setEmailSubject', 'enable_wet_sign' => 'setEnableWetSign', 'enforce_signer_visibility' => 'setEnforceSignerVisibility', 'envelope_attachments' => 'setEnvelopeAttachments', 'envelope_custom_metadata' => 'setEnvelopeCustomMetadata', 'envelope_documents' => 'setEnvelopeDocuments', 'envelope_id' => 'setEnvelopeId', 'envelope_id_stamping' => 'setEnvelopeIdStamping', 'envelope_location' => 'setEnvelopeLocation', 'envelope_metadata' => 'setEnvelopeMetadata', 'envelope_uri' => 'setEnvelopeUri', 'event_notification' => 'setEventNotification', 'event_notifications' => 'setEventNotifications', 'expire_after' => 'setExpireAfter', 'expire_date_time' => 'setExpireDateTime', 'expire_enabled' => 'setExpireEnabled', 'external_envelope_id' => 'setExternalEnvelopeId', 'folders' => 'setFolders', 'has_comments' => 'setHasComments', 'has_form_data_changed' => 'setHasFormDataChanged', 'has_wav_file' => 'setHasWavFile', 'holder' => 'setHolder', 'initial_sent_date_time' => 'setInitialSentDateTime', 'is21_cfr_part11' => 'setIs21CfrPart11', 'is_dynamic_envelope' => 'setIsDynamicEnvelope', 'is_signature_provider_envelope' => 'setIsSignatureProviderEnvelope', 'last_modified_date_time' => 'setLastModifiedDateTime', 'location' => 'setLocation', 'lock_information' => 'setLockInformation', 'message_lock' => 'setMessageLock', 'notification' => 'setNotification', 'notification_uri' => 'setNotificationUri', 'password' => 'setPassword', 'power_form' => 'setPowerForm', 'purge_completed_date' => 'setPurgeCompletedDate', 'purge_request_date' => 'setPurgeRequestDate', 'purge_state' => 'setPurgeState', 'recipients' => 'setRecipients', 'recipients_lock' => 'setRecipientsLock', 'recipients_uri' => 'setRecipientsUri', 'recipient_view_request' => 'setRecipientViewRequest', 'sender' => 'setSender', 'sent_date_time' => 'setSentDateTime', 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', 'status_date_time' => 'setStatusDateTime', 'template_id' => 'setTemplateId', 'template_roles' => 'setTemplateRoles', 'templates_uri' => 'setTemplatesUri', 'transaction_id' => 'setTransactionId', 'use_disclosure' => 'setUseDisclosure', 'u_sig_state' => 'setUSigState', 'voided_date_time' => 'setVoidedDateTime', 'voided_reason' => 'setVoidedReason', 'workflow' => 'setWorkflow']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerFormats
     = ['access_control_list_base64' => null, 'accessibility' => null, 'allow_comments' => null, 'allow_markup' => null, 'allow_reassign' => null, 'allow_recipient_recursion' => null, 'allow_view_history' => null, 'any_signer' => null, 'asynchronous' => null, 'attachments' => null, 'attachments_uri' => null, 'authoritative_copy' => null, 'authoritative_copy_default' => null, 'auto_navigation' => null, 'brand_id' => null, 'brand_lock' => null, 'burn_default_tab_data' => null, 'certificate_uri' => null, 'completed_date_time' => null, 'composite_templates' => null, 'copy_recipient_data' => null, 'created_date_time' => null, 'custom_fields' => null, 'custom_fields_uri' => null, 'declined_date_time' => null, 'deleted_date_time' => null, 'delivered_date_time' => null, 'disable_responsive_document' => null, 'document_base64' => null, 'documents' => null, 'documents_combined_uri' => null, 'documents_uri' => null, 'email_blurb' => null, 'email_settings' => null, 'email_subject' => null, 'enable_wet_sign' => null, 'enforce_signer_visibility' => null, 'envelope_attachments' => null, 'envelope_custom_metadata' => null, 'envelope_documents' => null, 'envelope_id' => null, 'envelope_id_stamping' => null, 'envelope_location' => null, 'envelope_metadata' => null, 'envelope_uri' => null, 'event_notification' => null, 'event_notifications' => null, 'expire_after' => null, 'expire_date_time' => null, 'expire_enabled' => null, 'external_envelope_id' => null, 'folders' => null, 'has_comments' => null, 'has_form_data_changed' => null, 'has_wav_file' => null, 'holder' => null, 'initial_sent_date_time' => null, 'is21_cfr_part11' => null, 'is_dynamic_envelope' => null, 'is_signature_provider_envelope' => null, 'last_modified_date_time' => null, 'location' => null, 'lock_information' => null, 'message_lock' => null, 'notification' => null, 'notification_uri' => null, 'password' => null, 'power_form' => null, 'purge_completed_date' => null, 'purge_request_date' => null, 'purge_state' => null, 'recipients' => null, 'recipients_lock' => null, 'recipients_uri' => null, 'recipient_view_request' => null, 'sender' => null, 'sent_date_time' => null, 'signer_can_sign_on_mobile' => null, 'signing_location' => null, 'status' => null, 'status_changed_date_time' => null, 'status_date_time' => null, 'template_id' => null, 'template_roles' => null, 'templates_uri' => null, 'transaction_id' => null, 'use_disclosure' => null, 'u_sig_state' => null, 'voided_date_time' => null, 'voided_reason' => null, 'workflow' => null]

$swaggerModelName

The original name of the model.


    protected
    static    string
    $swaggerModelName
     = 'envelopeDefinition'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization


    protected
    static    array<string|int, string>
    $swaggerTypes
     = ['access_control_list_base64' => '?string', 'accessibility' => '?string', 'allow_comments' => '?string', 'allow_markup' => '?string', 'allow_reassign' => '?string', 'allow_recipient_recursion' => '?string', 'allow_view_history' => '?string', 'any_signer' => '?string', 'asynchronous' => '?string', 'attachments' => '\\DocuSign\\eSign\\Model\\Attachment[]', 'attachments_uri' => '?string', 'authoritative_copy' => '?string', 'authoritative_copy_default' => '?string', 'auto_navigation' => '?string', 'brand_id' => '?string', 'brand_lock' => '?string', 'burn_default_tab_data' => '?string', 'certificate_uri' => '?string', 'completed_date_time' => '?string', 'composite_templates' => '\\DocuSign\\eSign\\Model\\CompositeTemplate[]', 'copy_recipient_data' => '?string', 'created_date_time' => '?string', 'custom_fields' => '\\DocuSign\\eSign\\Model\\CustomFields', 'custom_fields_uri' => '?string', 'declined_date_time' => '?string', 'deleted_date_time' => '?string', 'delivered_date_time' => '?string', 'disable_responsive_document' => '?string', 'document_base64' => '?string', 'documents' => '\\DocuSign\\eSign\\Model\\Document[]', 'documents_combined_uri' => '?string', 'documents_uri' => '?string', 'email_blurb' => '?string', 'email_settings' => '\\DocuSign\\eSign\\Model\\EmailSettings', 'email_subject' => '?string', 'enable_wet_sign' => '?string', 'enforce_signer_visibility' => '?string', 'envelope_attachments' => '\\DocuSign\\eSign\\Model\\Attachment[]', 'envelope_custom_metadata' => '\\DocuSign\\eSign\\Model\\EnvelopeCustomMetadata', 'envelope_documents' => '\\DocuSign\\eSign\\Model\\EnvelopeDocument[]', 'envelope_id' => '?string', 'envelope_id_stamping' => '?string', 'envelope_location' => '?string', 'envelope_metadata' => '\\DocuSign\\eSign\\Model\\EnvelopeMetadata', 'envelope_uri' => '?string', 'event_notification' => '\\DocuSign\\eSign\\Model\\EventNotification', 'event_notifications' => '\\DocuSign\\eSign\\Model\\EventNotification[]', 'expire_after' => '?string', 'expire_date_time' => '?string', 'expire_enabled' => '?string', 'external_envelope_id' => '?string', 'folders' => '\\DocuSign\\eSign\\Model\\Folder[]', 'has_comments' => '?string', 'has_form_data_changed' => '?string', 'has_wav_file' => '?string', 'holder' => '?string', 'initial_sent_date_time' => '?string', 'is21_cfr_part11' => '?string', 'is_dynamic_envelope' => '?string', 'is_signature_provider_envelope' => '?string', 'last_modified_date_time' => '?string', 'location' => '?string', 'lock_information' => '\\DocuSign\\eSign\\Model\\LockInformation', 'message_lock' => '?string', 'notification' => '\\DocuSign\\eSign\\Model\\Notification', 'notification_uri' => '?string', 'password' => '?string', 'power_form' => '\\DocuSign\\eSign\\Model\\PowerForm', 'purge_completed_date' => '?string', 'purge_request_date' => '?string', 'purge_state' => '?string', 'recipients' => '\\DocuSign\\eSign\\Model\\Recipients', 'recipients_lock' => '?string', 'recipients_uri' => '?string', 'recipient_view_request' => '\\DocuSign\\eSign\\Model\\RecipientViewRequest', 'sender' => '\\DocuSign\\eSign\\Model\\UserInfo', 'sent_date_time' => '?string', 'signer_can_sign_on_mobile' => '?string', 'signing_location' => '?string', 'status' => '?string', 'status_changed_date_time' => '?string', 'status_date_time' => '?string', 'template_id' => '?string', 'template_roles' => '\\DocuSign\\eSign\\Model\\TemplateRole[]', 'templates_uri' => '?string', 'transaction_id' => '?string', 'use_disclosure' => '?string', 'u_sig_state' => '?string', 'voided_date_time' => '?string', 'voided_reason' => '?string', 'workflow' => '\\DocuSign\\eSign\\Model\\Workflow']

__construct()

Constructor


    public
                __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__toString()

Gets the string presentation of the object


    public
                __toString() : string

Return values

string —

attributeMap()

Array of attributes where the key is the local name, and the value is the original name


    public
            static    attributeMap() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getAccessControlListBase64()

Gets access_control_list_base64


    public
                getAccessControlListBase64() : string|null

Return values

string|null —

getAccessibility()

Gets accessibility


    public
                getAccessibility() : string|null

Return values

string|null —

getAllowComments()

Gets allow_comments


    public
                getAllowComments() : string|null

Return values

string|null —

getAllowMarkup()

Gets allow_markup


    public
                getAllowMarkup() : string|null

Return values

string|null —

getAllowReassign()

Gets allow_reassign


    public
                getAllowReassign() : string|null

Return values

string|null —

getAllowRecipientRecursion()

Gets allow_recipient_recursion


    public
                getAllowRecipientRecursion() : string|null

Return values

string|null —

getAllowViewHistory()

Gets allow_view_history


    public
                getAllowViewHistory() : string|null

Return values

string|null —

getAnySigner()

Gets any_signer


    public
                getAnySigner() : string|null

Return values

string|null —

getAsynchronous()

Gets asynchronous


    public
                getAsynchronous() : string|null

Return values

string|null —

getAttachments()

Gets attachments


    public
                getAttachments() : array<string|int, Attachment>

Return values

array<string|int, Attachment> —

getAttachmentsUri()

Gets attachments_uri


    public
                getAttachmentsUri() : string|null

Return values

string|null —

getAuthoritativeCopy()

Gets authoritative_copy


    public
                getAuthoritativeCopy() : string|null

Return values

string|null —

getAuthoritativeCopyDefault()

Gets authoritative_copy_default


    public
                getAuthoritativeCopyDefault() : string|null

Return values

string|null —

getAutoNavigation()

Gets auto_navigation


    public
                getAutoNavigation() : string|null

Return values

string|null —

getBrandId()

Gets brand_id


    public
                getBrandId() : string|null

Return values

string|null —

getBrandLock()

Gets brand_lock


    public
                getBrandLock() : string|null

Return values

string|null —

getBurnDefaultTabData()

Gets burn_default_tab_data


    public
                getBurnDefaultTabData() : string|null

Return values

string|null —

getCertificateUri()

Gets certificate_uri


    public
                getCertificateUri() : string|null

Return values

string|null —

getCompletedDateTime()

Gets completed_date_time


    public
                getCompletedDateTime() : string|null

Return values

string|null —

getCompositeTemplates()

Gets composite_templates


    public
                getCompositeTemplates() : array<string|int, CompositeTemplate>

Return values

array<string|int, CompositeTemplate> —

getCopyRecipientData()

Gets copy_recipient_data


    public
                getCopyRecipientData() : string|null

Return values

string|null —

getCreatedDateTime()

Gets created_date_time


    public
                getCreatedDateTime() : string|null

Return values

string|null —

getCustomFields()

Gets custom_fields


    public
                getCustomFields() : CustomFields

Return values

CustomFields —

getCustomFieldsUri()

Gets custom_fields_uri


    public
                getCustomFieldsUri() : string|null

Return values

string|null —

getDeclinedDateTime()

Gets declined_date_time


    public
                getDeclinedDateTime() : string|null

Return values

string|null —

getDeletedDateTime()

Gets deleted_date_time


    public
                getDeletedDateTime() : string|null

Return values

string|null —

getDeliveredDateTime()

Gets delivered_date_time


    public
                getDeliveredDateTime() : string|null

Return values

string|null —

getDisableResponsiveDocument()

Gets disable_responsive_document


    public
                getDisableResponsiveDocument() : string|null

Return values

string|null —

getDocumentBase64()

Gets document_base64


    public
                getDocumentBase64() : string|null

Return values

string|null —

getDocuments()

Gets documents


    public
                getDocuments() : array<string|int, Document>

Return values

array<string|int, Document> —

getDocumentsCombinedUri()

Gets documents_combined_uri


    public
                getDocumentsCombinedUri() : string|null

Return values

string|null —

getDocumentsUri()

Gets documents_uri


    public
                getDocumentsUri() : string|null

Return values

string|null —

getEmailBlurb()

Gets email_blurb


    public
                getEmailBlurb() : string|null

Return values

string|null —

getEmailSettings()

Gets email_settings


    public
                getEmailSettings() : EmailSettings

Return values

EmailSettings —

getEmailSubject()

Gets email_subject


    public
                getEmailSubject() : string|null

Return values

string|null —

getEnableWetSign()

Gets enable_wet_sign


    public
                getEnableWetSign() : string|null

Return values

string|null —

getEnforceSignerVisibility()

Gets enforce_signer_visibility


    public
                getEnforceSignerVisibility() : string|null

Return values

string|null —

getEnvelopeAttachments()

Gets envelope_attachments


    public
                getEnvelopeAttachments() : array<string|int, Attachment>

Return values

array<string|int, Attachment> —

getEnvelopeCustomMetadata()

Gets envelope_custom_metadata


    public
                getEnvelopeCustomMetadata() : EnvelopeCustomMetadata

Return values

EnvelopeCustomMetadata —

getEnvelopeDocuments()

Gets envelope_documents


    public
                getEnvelopeDocuments() : array<string|int, EnvelopeDocument>

Return values

array<string|int, EnvelopeDocument> —

getEnvelopeId()

Gets envelope_id


    public
                getEnvelopeId() : string|null

Return values

string|null —

getEnvelopeIdStamping()

Gets envelope_id_stamping


    public
                getEnvelopeIdStamping() : string|null

Return values

string|null —

getEnvelopeLocation()

Gets envelope_location


    public
                getEnvelopeLocation() : string|null

Return values

string|null —

getEnvelopeMetadata()

Gets envelope_metadata


    public
                getEnvelopeMetadata() : EnvelopeMetadata

Return values

EnvelopeMetadata —

getEnvelopeUri()

Gets envelope_uri


    public
                getEnvelopeUri() : string|null

Return values

string|null —

getEventNotification()

Gets event_notification


    public
                getEventNotification() : EventNotification

Return values

EventNotification —

getEventNotifications()

Gets event_notifications


    public
                getEventNotifications() : array<string|int, EventNotification>

Return values

array<string|int, EventNotification> —

getExpireAfter()

Gets expire_after


    public
                getExpireAfter() : string|null

Return values

string|null —

getExpireDateTime()

Gets expire_date_time


    public
                getExpireDateTime() : string|null

Return values

string|null —

getExpireEnabled()

Gets expire_enabled


    public
                getExpireEnabled() : string|null

Return values

string|null —

getExternalEnvelopeId()

Gets external_envelope_id


    public
                getExternalEnvelopeId() : string|null

Return values

string|null —

getFolders()

Gets folders


    public
                getFolders() : array<string|int, Folder>

Return values

array<string|int, Folder> —

getHasComments()

Gets has_comments


    public
                getHasComments() : string|null

Return values

string|null —

getHasFormDataChanged()

Gets has_form_data_changed


    public
                getHasFormDataChanged() : string|null

Return values

string|null —

getHasWavFile()

Gets has_wav_file


    public
                getHasWavFile() : string|null

Return values

string|null —

getHolder()

Gets holder


    public
                getHolder() : string|null

Return values

string|null —

getInitialSentDateTime()

Gets initial_sent_date_time


    public
                getInitialSentDateTime() : string|null

Return values

string|null —

getIs21CfrPart11()

Gets is21_cfr_part11


    public
                getIs21CfrPart11() : string|null

Return values

string|null —

getIsDynamicEnvelope()

Gets is_dynamic_envelope


    public
                getIsDynamicEnvelope() : string|null

Return values

string|null —

getIsSignatureProviderEnvelope()

Gets is_signature_provider_envelope


    public
                getIsSignatureProviderEnvelope() : string|null

Return values

string|null —

getLastModifiedDateTime()

Gets last_modified_date_time


    public
                getLastModifiedDateTime() : string|null

Return values

string|null —

getLocation()

Gets location


    public
                getLocation() : string|null

Return values

string|null —

getLockInformation()

Gets lock_information


    public
                getLockInformation() : LockInformation

Return values

LockInformation —

getMessageLock()

Gets message_lock


    public
                getMessageLock() : string|null

Return values

string|null —

getModelName()

The original name of the model.


    public
                getModelName() : string

Return values

string —

getNotification()

Gets notification


    public
                getNotification() : Notification

Return values

Notification —

getNotificationUri()

Gets notification_uri


    public
                getNotificationUri() : string|null

Return values

string|null —

getPassword()

Gets password


    public
                getPassword() : string|null

Return values

string|null —

getPowerForm()

Gets power_form


    public
                getPowerForm() : PowerForm

Return values

PowerForm —

getPurgeCompletedDate()

Gets purge_completed_date


    public
                getPurgeCompletedDate() : string|null

Return values

string|null —

getPurgeRequestDate()

Gets purge_request_date


    public
                getPurgeRequestDate() : string|null

Return values

string|null —

getPurgeState()

Gets purge_state


    public
                getPurgeState() : string|null

Return values

string|null —

getRecipients()

Gets recipients


    public
                getRecipients() : Recipients

Return values

Recipients —

getRecipientsLock()

Gets recipients_lock


    public
                getRecipientsLock() : string|null

Return values

string|null —

getRecipientsUri()

Gets recipients_uri


    public
                getRecipientsUri() : string|null

Return values

string|null —

getRecipientViewRequest()

Gets recipient_view_request


    public
                getRecipientViewRequest() : RecipientViewRequest

Return values

RecipientViewRequest —

getSender()

Gets sender


    public
                getSender() : UserInfo

Return values

UserInfo —

getSentDateTime()

Gets sent_date_time


    public
                getSentDateTime() : string|null

Return values

string|null —

getSignerCanSignOnMobile()

Gets signer_can_sign_on_mobile


    public
                getSignerCanSignOnMobile() : string|null

Return values

string|null —

getSigningLocation()

Gets signing_location


    public
                getSigningLocation() : string|null

Return values

string|null —

getStatus()

Gets status


    public
                getStatus() : string|null

Return values

string|null —

getStatusChangedDateTime()

Gets status_changed_date_time


    public
                getStatusChangedDateTime() : string|null

Return values

string|null —

getStatusDateTime()

Gets status_date_time


    public
                getStatusDateTime() : string|null

Return values

string|null —

getTemplateId()

Gets template_id


    public
                getTemplateId() : string|null

Return values

string|null —

getTemplateRoles()

Gets template_roles


    public
                getTemplateRoles() : array<string|int, TemplateRole>

Return values

array<string|int, TemplateRole> —

getTemplatesUri()

Gets templates_uri


    public
                getTemplatesUri() : string|null

Return values

string|null —

getters()

Array of attributes to getter functions (for serialization of requests)


    public
            static    getters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getTransactionId()

Gets transaction_id


    public
                getTransactionId() : string|null

Return values

string|null —

getUseDisclosure()

Gets use_disclosure


    public
                getUseDisclosure() : string|null

Return values

string|null —

getUSigState()

Gets u_sig_state


    public
                getUSigState() : string|null

Return values

string|null —

getVoidedDateTime()

Gets voided_date_time


    public
                getVoidedDateTime() : string|null

Return values

string|null —

getVoidedReason()

Gets voided_reason


    public
                getVoidedReason() : string|null

Return values

string|null —

getWorkflow()

Gets workflow


    public
                getWorkflow() : Workflow

Return values

Workflow —

listInvalidProperties()

Show all the invalid properties with reasons.


    public
                listInvalidProperties() : array<string|int, mixed>

Return values

array<string|int, mixed> —

invalid properties with reasons

offsetExists()

Returns true if offset exists. False otherwise.


    public
                offsetExists(int $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                offsetGet(int $offset) : mixed

Parameters

$offset : int: Offset

Return values

mixed —

offsetSet()

Sets value based on offset.


    public
                offsetSet(int $offset, mixed $value) : void

Parameters

$offset : int: Offset
$value : mixed: Value to be set

Return values

void —

offsetUnset()

Unsets offset.


    public
                offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

setAccessControlListBase64()

Sets access_control_list_base64


    public
                setAccessControlListBase64(string|null $access_control_list_base64) : $this

Parameters

$access_control_list_base64 : string|null

Return values

$this —

setAccessibility()

Sets accessibility


    public
                setAccessibility(string|null $accessibility) : $this

Parameters

$accessibility : string|null: Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.

Return values

$this —

setAllowComments()

Sets allow_comments


    public
                setAllowComments(string|null $allow_comments) : $this

Parameters

$allow_comments : string|null

Return values

$this —

setAllowMarkup()

Sets allow_markup


    public
                setAllowMarkup(string|null $allow_markup) : $this

Parameters

$allow_markup : string|null: When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this

Return values

$this —

setAllowReassign()

Sets allow_reassign


    public
                setAllowReassign(string|null $allow_reassign) : $this

Parameters

$allow_reassign : string|null: When set to true, the recipient can redirect an envelope to a more appropriate recipient.

Return values

$this —

setAllowRecipientRecursion()

Sets allow_recipient_recursion


    public
                setAllowRecipientRecursion(string|null $allow_recipient_recursion) : $this

Parameters

$allow_recipient_recursion : string|null: When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.

Return values

$this —

setAllowViewHistory()

Sets allow_view_history


    public
                setAllowViewHistory(string|null $allow_view_history) : $this

Parameters

$allow_view_history : string|null

Return values

$this —

setAnySigner()

Sets any_signer


    public
                setAnySigner(string|null $any_signer) : $this

Parameters

$any_signer : string|null

Return values

$this —

setAsynchronous()

Sets asynchronous


    public
                setAsynchronous(string|null $asynchronous) : $this

Parameters

$asynchronous : string|null: When set to true, the envelope is queued for processing and the value of the status property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.

Return values

$this —

setAttachments()

Sets attachments


    public
                setAttachments(array<string|int, Attachment> $attachments) : $this

Parameters

$attachments : array<string|int, Attachment>

Return values

$this —

setAttachmentsUri()

Sets attachments_uri


    public
                setAttachmentsUri(string|null $attachments_uri) : $this

Parameters

$attachments_uri : string|null

Return values

$this —

setAuthoritativeCopy()

Sets authoritative_copy


    public
                setAuthoritativeCopy(string|null $authoritative_copy) : $this

Parameters

$authoritative_copy : string|null: Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

Return values

$this —

setAuthoritativeCopyDefault()

Sets authoritative_copy_default


    public
                setAuthoritativeCopyDefault(string|null $authoritative_copy_default) : $this

Parameters

$authoritative_copy_default : string|null

Return values

$this —

setAutoNavigation()

Sets auto_navigation


    public
                setAutoNavigation(string|null $auto_navigation) : $this

Parameters

$auto_navigation : string|null

Return values

$this —

setBrandId()

Sets brand_id


    public
                setBrandId(string|null $brand_id) : $this

Parameters

$brand_id : string|null: This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.

Return values

$this —

setBrandLock()

Sets brand_lock


    public
                setBrandLock(string|null $brand_lock) : $this

Parameters

$brand_lock : string|null

Return values

$this —

setBurnDefaultTabData()

Sets burn_default_tab_data


    public
                setBurnDefaultTabData(string|null $burn_default_tab_data) : $this

Parameters

$burn_default_tab_data : string|null

Return values

$this —

setCertificateUri()

Sets certificate_uri


    public
                setCertificateUri(string|null $certificate_uri) : $this

Parameters

$certificate_uri : string|null: Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.

Return values

$this —

setCompletedDateTime()

Sets completed_date_time


    public
                setCompletedDateTime(string|null $completed_date_time) : $this

Parameters

$completed_date_time : string|null: Specifies the date and time this item was completed.

Return values

$this —

setCompositeTemplates()

Sets composite_templates


    public
                setCompositeTemplates(array<string|int, CompositeTemplate> $composite_templates) : $this

Parameters

$composite_templates : array<string|int, CompositeTemplate>: A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.

Return values

$this —

setCopyRecipientData()

Sets copy_recipient_data


    public
                setCopyRecipientData(string|null $copy_recipient_data) : $this

Parameters

$copy_recipient_data : string|null

Return values

$this —

setCreatedDateTime()

Sets created_date_time


    public
                setCreatedDateTime(string|null $created_date_time) : $this

Parameters

$created_date_time : string|null: Indicates the date and time the item was created.

Return values

$this —

setCustomFields()

Sets custom_fields


    public
                setCustomFields(CustomFields $custom_fields) : $this

Parameters

$custom_fields : CustomFields: An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Return values

$this —

setCustomFieldsUri()

Sets custom_fields_uri


    public
                setCustomFieldsUri(string|null $custom_fields_uri) : $this

Parameters

$custom_fields_uri : string|null: Contains a URI for an endpoint that you can use to retrieve the custom fields.

Return values

$this —

setDeclinedDateTime()

Sets declined_date_time


    public
                setDeclinedDateTime(string|null $declined_date_time) : $this

Parameters

$declined_date_time : string|null: The date and time the recipient declined the document.

Return values

$this —

setDeletedDateTime()

Sets deleted_date_time


    public
                setDeletedDateTime(string|null $deleted_date_time) : $this

Parameters

$deleted_date_time : string|null: Specifies the data and time the item was deleted.

Return values

$this —

setDeliveredDateTime()

Sets delivered_date_time


    public
                setDeliveredDateTime(string|null $delivered_date_time) : $this

Parameters

$delivered_date_time : string|null: Reserved: For DocuSign use only.

Return values

$this —

setDisableResponsiveDocument()

Sets disable_responsive_document


    public
                setDisableResponsiveDocument(string|null $disable_responsive_document) : $this

Parameters

$disable_responsive_document : string|null

Return values

$this —

setDocumentBase64()

Sets document_base64


    public
                setDocumentBase64(string|null $document_base64) : $this

Parameters

$document_base64 : string|null

Return values

$this —

setDocuments()

Sets documents


    public
                setDocuments(array<string|int, Document> $documents) : $this

Parameters

$documents : array<string|int, Document>: Complex element contains the details on the documents in the envelope.

Return values

$this —

setDocumentsCombinedUri()

Sets documents_combined_uri


    public
                setDocumentsCombinedUri(string|null $documents_combined_uri) : $this

Parameters

$documents_combined_uri : string|null

Return values

$this —

setDocumentsUri()

Sets documents_uri


    public
                setDocumentsUri(string|null $documents_uri) : $this

Parameters

$documents_uri : string|null: Contains a URI for an endpoint that you can use to retrieve the documents.

Return values

$this —

setEmailBlurb()

Sets email_blurb


    public
                setEmailBlurb(string|null $email_blurb) : $this

Parameters

$email_blurb : string|null: Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters

Return values

$this —

setEmailSettings()

Sets email_settings


    public
                setEmailSettings(EmailSettings $email_settings) : $this

Parameters

$email_settings : EmailSettings: This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the emailSettings information is used for an envelope, it only applies to that envelope. Important Note: The emailSettings information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings.

Return values

$this —

setEmailSubject()

Sets email_subject


    public
                setEmailSubject(string|null $email_subject) : $this

Parameters

$email_subject : string|null: Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.

Return values

$this —

setEnableWetSign()

Sets enable_wet_sign


    public
                setEnableWetSign(string|null $enable_wet_sign) : $this

Parameters

$enable_wet_sign : string|null: When set to true, the signer is allowed to print the document and sign it on paper.

Return values

$this —

setEnforceSignerVisibility()

Sets enforce_signer_visibility


    public
                setEnforceSignerVisibility(string|null $enforce_signer_visibility) : $this

Parameters

$enforce_signer_visibility : string|null: When set to true, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. Your account must have Document Visibility enabled to use this.

Return values

$this —

setEnvelopeAttachments()

Sets envelope_attachments


    public
                setEnvelopeAttachments(array<string|int, Attachment> $envelope_attachments) : $this

Parameters

$envelope_attachments : array<string|int, Attachment>

Return values

$this —

setEnvelopeCustomMetadata()

Sets envelope_custom_metadata


    public
                setEnvelopeCustomMetadata(EnvelopeCustomMetadata $envelope_custom_metadata) : $this

Parameters

$envelope_custom_metadata : EnvelopeCustomMetadata

Return values

$this —

setEnvelopeDocuments()

Sets envelope_documents


    public
                setEnvelopeDocuments(array<string|int, EnvelopeDocument> $envelope_documents) : $this

Parameters

$envelope_documents : array<string|int, EnvelopeDocument>

Return values

$this —

setEnvelopeId()

Sets envelope_id


    public
                setEnvelopeId(string|null $envelope_id) : $this

Parameters

$envelope_id : string|null: The envelope ID of the envelope status that failed to post.

Return values

$this —

setEnvelopeIdStamping()

Sets envelope_id_stamping


    public
                setEnvelopeIdStamping(string|null $envelope_id_stamping) : $this

Parameters

$envelope_id_stamping : string|null: When set to true, Envelope ID Stamping is enabled.

Return values

$this —

setEnvelopeLocation()

Sets envelope_location


    public
                setEnvelopeLocation(string|null $envelope_location) : $this

Parameters

$envelope_location : string|null

Return values

$this —

setEnvelopeMetadata()

Sets envelope_metadata


    public
                setEnvelopeMetadata(EnvelopeMetadata $envelope_metadata) : $this

Parameters

$envelope_metadata : EnvelopeMetadata: Metadata about the features that are enabled for the envelope.

Return values

$this —

setEnvelopeUri()

Sets envelope_uri


    public
                setEnvelopeUri(string|null $envelope_uri) : $this

Parameters

$envelope_uri : string|null: Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Return values

$this —

setEventNotification()

Sets event_notification


    public
                setEventNotification(EventNotification $event_notification) : $this

Parameters

$event_notification : EventNotification: This optional object is used to register a webhook that will receive status changes for this envelope.

Return values

$this —

setEventNotifications()

Sets event_notifications


    public
                setEventNotifications(array<string|int, EventNotification> $event_notifications) : $this

Parameters

$event_notifications : array<string|int, EventNotification>

Return values

$this —

setExpireAfter()

Sets expire_after


    public
                setExpireAfter(string|null $expire_after) : $this

Parameters

$expire_after : string|null

Return values

$this —

setExpireDateTime()

Sets expire_date_time


    public
                setExpireDateTime(string|null $expire_date_time) : $this

Parameters

$expire_date_time : string|null

Return values

$this —

setExpireEnabled()

Sets expire_enabled


    public
                setExpireEnabled(string|null $expire_enabled) : $this

Parameters

$expire_enabled : string|null

Return values

$this —

setExternalEnvelopeId()

Sets external_envelope_id


    public
                setExternalEnvelopeId(string|null $external_envelope_id) : $this

Parameters

$external_envelope_id : string|null

Return values

$this —

setFolders()

Sets folders


    public
                setFolders(array<string|int, Folder> $folders) : $this

Parameters

$folders : array<string|int, Folder>

Return values

$this —

setHasComments()

Sets has_comments


    public
                setHasComments(string|null $has_comments) : $this

Parameters

$has_comments : string|null

Return values

$this —

setHasFormDataChanged()

Sets has_form_data_changed


    public
                setHasFormDataChanged(string|null $has_form_data_changed) : $this

Parameters

$has_form_data_changed : string|null

Return values

$this —

setHasWavFile()

Sets has_wav_file


    public
                setHasWavFile(string|null $has_wav_file) : $this

Parameters

$has_wav_file : string|null

Return values

$this —

setHolder()

Sets holder


    public
                setHolder(string|null $holder) : $this

Parameters

$holder : string|null

Return values

$this —

setInitialSentDateTime()

Sets initial_sent_date_time


    public
                setInitialSentDateTime(string|null $initial_sent_date_time) : $this

Parameters

$initial_sent_date_time : string|null

Return values

$this —

setIs21CfrPart11()

Sets is21_cfr_part11


    public
                setIs21CfrPart11(string|null $is21_cfr_part11) : $this

Parameters

$is21_cfr_part11 : string|null: When set to true, indicates that this module is enabled on the account.

Return values

$this —

setIsDynamicEnvelope()

Sets is_dynamic_envelope


    public
                setIsDynamicEnvelope(string|null $is_dynamic_envelope) : $this

Parameters

$is_dynamic_envelope : string|null

Return values

$this —

setIsSignatureProviderEnvelope()

Sets is_signature_provider_envelope


    public
                setIsSignatureProviderEnvelope(string|null $is_signature_provider_envelope) : $this

Parameters

$is_signature_provider_envelope : string|null

Return values

$this —

setLastModifiedDateTime()

Sets last_modified_date_time


    public
                setLastModifiedDateTime(string|null $last_modified_date_time) : $this

Parameters

$last_modified_date_time : string|null: The date and time the item was last modified.

Return values

$this —

setLocation()

Sets location


    public
                setLocation(string|null $location) : $this

Parameters

$location : string|null

Return values

$this —

setLockInformation()

Sets lock_information


    public
                setLockInformation(LockInformation $lock_information) : $this

Parameters

$lock_information : LockInformation: Provides lock information about an envelope that a user has locked.

Return values

$this —

setMessageLock()

Sets message_lock


    public
                setMessageLock(string|null $message_lock) : $this

Parameters

$message_lock : string|null: When set to true, prevents senders from changing the contents of emailBlurb and emailSubject properties for the envelope. Additionally, this prevents users from making changes to the contents of emailBlurb and emailSubject properties when correcting envelopes. However, if the messageLock node is set to true**** and the emailSubject property is empty, senders and correctors are able to add a subject to the envelope.

Return values

$this —

setNotification()

Sets notification


    public
                setNotification(Notification $notification) : $this

Parameters

$notification : Notification: An optional complex element that specifies the notification options for the envelope.

Return values

$this —

setNotificationUri()

Sets notification_uri


    public
                setNotificationUri(string|null $notification_uri) : $this

Parameters

$notification_uri : string|null: Contains a URI for an endpoint that you can use to retrieve the notifications.

Return values

$this —

setPassword()

Sets password


    public
                setPassword(string|null $password) : $this

Parameters

$password : string|null

Return values

$this —

setPowerForm()

Sets power_form


    public
                setPowerForm(PowerForm $power_form) : $this

Parameters

$power_form : PowerForm: Information about any PowerForms that are included in the envelope.

Return values

$this —

setPurgeCompletedDate()

Sets purge_completed_date


    public
                setPurgeCompletedDate(string|null $purge_completed_date) : $this

Parameters

$purge_completed_date : string|null

Return values

$this —

setPurgeRequestDate()

Sets purge_request_date


    public
                setPurgeRequestDate(string|null $purge_request_date) : $this

Parameters

$purge_request_date : string|null

Return values

$this —

setPurgeState()

Sets purge_state


    public
                setPurgeState(string|null $purge_state) : $this

Parameters

$purge_state : string|null: Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.

Return values

$this —

setRecipients()

Sets recipients


    public
                setRecipients(Recipients $recipients) : $this

Parameters

$recipients : Recipients: An array of powerform recipients.

Return values

$this —

setRecipientsLock()

Sets recipients_lock


    public
                setRecipientsLock(string|null $recipients_lock) : $this

Parameters

$recipients_lock : string|null: When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.

Return values

$this —

setRecipientsUri()

Sets recipients_uri


    public
                setRecipientsUri(string|null $recipients_uri) : $this

Parameters

$recipients_uri : string|null: Contains a URI for an endpoint that you can use to retrieve the recipients.

Return values

$this —

setRecipientViewRequest()

Sets recipient_view_request


    public
                setRecipientViewRequest(RecipientViewRequest $recipient_view_request) : $this

Parameters

$recipient_view_request : RecipientViewRequest

Return values

$this —

setSender()

Sets sender


    public
                setSender(UserInfo $sender) : $this

Parameters

$sender : UserInfo: Information about the sender of the envelope.

Return values

$this —

setSentDateTime()

Sets sent_date_time


    public
                setSentDateTime(string|null $sent_date_time) : $this

Parameters

$sent_date_time : string|null: The date and time the envelope was sent.

Return values

$this —

setSignerCanSignOnMobile()

Sets signer_can_sign_on_mobile


    public
                setSignerCanSignOnMobile(string|null $signer_can_sign_on_mobile) : $this

Parameters

$signer_can_sign_on_mobile : string|null

Return values

$this —

setSigningLocation()

Sets signing_location


    public
                setSigningLocation(string|null $signing_location) : $this

Parameters

$signing_location : string|null: Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.

Return values

$this —

setStatus()

Sets status


    public
                setStatus(string|null $status) : $this

Parameters

$status : string|null: 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.

Return values

$this —

setStatusChangedDateTime()

Sets status_changed_date_time


    public
                setStatusChangedDateTime(string|null $status_changed_date_time) : $this

Parameters

$status_changed_date_time : string|null: The data and time the status changed.

Return values

$this —

setStatusDateTime()

Sets status_date_time


    public
                setStatusDateTime(string|null $status_date_time) : $this

Parameters

$status_date_time : string|null

Return values

$this —

setTemplateId()

Sets template_id


    public
                setTemplateId(string|null $template_id) : $this

Parameters

$template_id : string|null: The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Return values

$this —

setTemplateRoles()

Sets template_roles


    public
                setTemplateRoles(array<string|int, TemplateRole> $template_roles) : $this

Parameters

$template_roles : array<string|int, TemplateRole>: Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient's email address. * name - The recipient's name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template.

Return values

$this —

setTemplatesUri()

Sets templates_uri


    public
                setTemplatesUri(string|null $templates_uri) : $this

Parameters

$templates_uri : string|null: Contains a URI for an endpoint which you can use to retrieve the templates.

Return values

$this —

setters()

Array of attributes to setter functions (for deserialization of responses)


    public
            static    setters() : array<string|int, mixed>

Return values

array<string|int, mixed> —

setTransactionId()

Sets transaction_id


    public
                setTransactionId(string|null $transaction_id) : $this

Parameters

$transaction_id : string|null: Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The transactionId property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

Return values

$this —

setUseDisclosure()

Sets use_disclosure


    public
                setUseDisclosure(string|null $use_disclosure) : $this

Parameters

$use_disclosure : string|null: When set to true, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to false, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the useDisclosure property is not set, then the account's normal disclosure setting is used and the value of the useDisclosure property is not returned in responses when getting envelope information.

Return values

$this —

setUSigState()

Sets u_sig_state


    public
                setUSigState(string|null $u_sig_state) : $this

Parameters

$u_sig_state : string|null

Return values

$this —

setVoidedDateTime()

Sets voided_date_time


    public
                setVoidedDateTime(string|null $voided_date_time) : $this

Parameters

$voided_date_time : string|null: The date and time the envelope or template was voided.

Return values

$this —

setVoidedReason()

Sets voided_reason


    public
                setVoidedReason(string|null $voided_reason) : $this

Parameters

$voided_reason : string|null: The reason the envelope or template was voided.

Return values

$this —

setWorkflow()

Sets workflow


    public
                setWorkflow(Workflow $workflow) : $this

Parameters

$workflow : Workflow: Describes the workflow for this envelope.

Return values

$this —

swaggerFormats()

Array of property to format mappings. Used for (de)serialization


    public
            static    swaggerFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

swaggerTypes()

Array of property to type mappings. Used for (de)serialization


    public
            static    swaggerTypes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

valid()

Validate all the properties in the model return true if all passed


    public
                valid() : bool

Return values

bool —

True if all properties are valid

EnvelopeDefinition in package DocuSign eSign implements ModelInterface, ArrayAccess

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$setters

$swaggerFormats

$swaggerModelName

$swaggerTypes

Methods

__construct()

Parameters

Return values

__toString()

Return values

attributeMap()

Return values

getAccessControlListBase64()

Return values

getAccessibility()

Return values

getAllowComments()

Return values

getAllowMarkup()

Return values

getAllowReassign()

Return values

getAllowRecipientRecursion()

Return values

getAllowViewHistory()

Return values

getAnySigner()

Return values

getAsynchronous()

Return values

getAttachments()

Return values

getAttachmentsUri()

Return values

getAuthoritativeCopy()

Return values

getAuthoritativeCopyDefault()

Return values

getAutoNavigation()

Return values

getBrandId()

Return values

getBrandLock()

Return values

getBurnDefaultTabData()

Return values

getCertificateUri()

Return values

getCompletedDateTime()

Return values

getCompositeTemplates()

Return values

getCopyRecipientData()

Return values

getCreatedDateTime()

Return values

getCustomFields()

Return values

getCustomFieldsUri()

Return values

getDeclinedDateTime()

Return values

getDeletedDateTime()

Return values

getDeliveredDateTime()

Return values

getDisableResponsiveDocument()

Return values

getDocumentBase64()

Return values

EnvelopeDefinition
in package

DocuSign

eSign

implements ModelInterface, ArrayAccess