Documentation

EnvelopeTemplateResult
in package
implements ArrayAccess

EnvelopeTemplateResult Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes, Traits and Enums

ArrayAccess

Table of Contents

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)
$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()  : mixed
getAllowMarkup()  : string
Gets allow_markup
getAllowReassign()  : string
Gets allow_reassign
getAllowViewHistory()  : string
Gets allow_view_history
getAsynchronous()  : string
Gets asynchronous
getAttachmentsUri()  : string
Gets attachments_uri
getAuthoritativeCopy()  : string
Gets authoritative_copy
getAuthoritativeCopyDefault()  : string
Gets authoritative_copy_default
getAutoNavigation()  : string
Gets auto_navigation
getBrandId()  : string
Gets brand_id
getBrandLock()  : string
Gets brand_lock
getCertificateUri()  : string
Gets certificate_uri
getCompletedDateTime()  : string
Gets completed_date_time
getCreated()  : string
Gets created
getCreatedDateTime()  : string
Gets created_date_time
getCustomFields()  : CustomFields
Gets custom_fields
getCustomFieldsUri()  : string
Gets custom_fields_uri
getDeclinedDateTime()  : string
Gets declined_date_time
getDeletedDateTime()  : string
Gets deleted_date_time
getDeliveredDateTime()  : string
Gets delivered_date_time
getDescription()  : string
Gets description
getDisableResponsiveDocument()  : string
Gets disable_responsive_document
getDocuments()  : array<string|int, Document>
Gets documents
getDocumentsCombinedUri()  : string
Gets documents_combined_uri
getDocumentsUri()  : string
Gets documents_uri
getEmailBlurb()  : string
Gets email_blurb
getEmailSettings()  : EmailSettings
Gets email_settings
getEmailSubject()  : string
Gets email_subject
getEnableWetSign()  : string
Gets enable_wet_sign
getEnforceSignerVisibility()  : string
Gets enforce_signer_visibility
getEnvelopeId()  : string
Gets envelope_id
getEnvelopeIdStamping()  : string
Gets envelope_id_stamping
getEnvelopeUri()  : string
Gets envelope_uri
getFolderId()  : string
Gets folder_id
getFolderName()  : string
Gets folder_name
getFolderUri()  : string
Gets folder_uri
getInitialSentDateTime()  : string
Gets initial_sent_date_time
getIs21CfrPart11()  : string
Gets is21_cfr_part11
getIsSignatureProviderEnvelope()  : string
Gets is_signature_provider_envelope
getLastModified()  : string
Gets last_modified
getLastModifiedDateTime()  : string
Gets last_modified_date_time
getLockInformation()  : LockInformation
Gets lock_information
getMessageLock()  : string
Gets message_lock
getName()  : string
Gets name
getNotification()  : Notification
Gets notification
getNotificationUri()  : string
Gets notification_uri
getOwner()  : UserInfo
Gets owner
getPageCount()  : int
Gets page_count
getParentFolderUri()  : string
Gets parent_folder_uri
getPassword()  : string
Gets password
getPurgeState()  : string
Gets purge_state
getRecipients()  : Recipients
Gets recipients
getRecipientsLock()  : string
Gets recipients_lock
getRecipientsUri()  : string
Gets recipients_uri
getSentDateTime()  : string
Gets sent_date_time
getShared()  : string
Gets shared
getSignerCanSignOnMobile()  : string
Gets signer_can_sign_on_mobile
getSigningLocation()  : string
Gets signing_location
getStatus()  : string
Gets status
getStatusChangedDateTime()  : string
Gets status_changed_date_time
getTemplateId()  : string
Gets template_id
getTemplatesUri()  : string
Gets templates_uri
getters()  : mixed
getTransactionId()  : string
Gets transaction_id
getUri()  : string
Gets uri
getUseDisclosure()  : string
Gets use_disclosure
getVoidedDateTime()  : string
Gets voided_date_time
getVoidedReason()  : string
Gets voided_reason
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.
setAllowMarkup()  : $this
Sets allow_markup
setAllowReassign()  : $this
Sets allow_reassign
setAllowViewHistory()  : $this
Sets allow_view_history
setAsynchronous()  : $this
Sets asynchronous
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
setCertificateUri()  : $this
Sets certificate_uri
setCompletedDateTime()  : $this
Sets completed_date_time
setCreated()  : $this
Sets created
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
setDescription()  : $this
Sets description
setDisableResponsiveDocument()  : $this
Sets disable_responsive_document
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
setEnvelopeId()  : $this
Sets envelope_id
setEnvelopeIdStamping()  : $this
Sets envelope_id_stamping
setEnvelopeUri()  : $this
Sets envelope_uri
setFolderId()  : $this
Sets folder_id
setFolderName()  : $this
Sets folder_name
setFolderUri()  : $this
Sets folder_uri
setInitialSentDateTime()  : $this
Sets initial_sent_date_time
setIs21CfrPart11()  : $this
Sets is21_cfr_part11
setIsSignatureProviderEnvelope()  : $this
Sets is_signature_provider_envelope
setLastModified()  : $this
Sets last_modified
setLastModifiedDateTime()  : $this
Sets last_modified_date_time
setLockInformation()  : $this
Sets lock_information
setMessageLock()  : $this
Sets message_lock
setName()  : $this
Sets name
setNotification()  : $this
Sets notification
setNotificationUri()  : $this
Sets notification_uri
setOwner()  : $this
Sets owner
setPageCount()  : $this
Sets page_count
setParentFolderUri()  : $this
Sets parent_folder_uri
setPassword()  : $this
Sets password
setPurgeState()  : $this
Sets purge_state
setRecipients()  : $this
Sets recipients
setRecipientsLock()  : $this
Sets recipients_lock
setRecipientsUri()  : $this
Sets recipients_uri
setSentDateTime()  : $this
Sets sent_date_time
setShared()  : $this
Sets shared
setSignerCanSignOnMobile()  : $this
Sets signer_can_sign_on_mobile
setSigningLocation()  : $this
Sets signing_location
setStatus()  : $this
Sets status
setStatusChangedDateTime()  : $this
Sets status_changed_date_time
setTemplateId()  : $this
Sets template_id
setTemplatesUri()  : $this
Sets templates_uri
setters()  : mixed
setTransactionId()  : $this
Sets transaction_id
setUri()  : $this
Sets uri
setUseDisclosure()  : $this
Sets use_disclosure
setVoidedDateTime()  : $this
Sets voided_date_time
setVoidedReason()  : $this
Sets voided_reason
swaggerTypes()  : mixed
valid()  : bool
validate all the properties in the model return true if all passed

Constants

Properties

$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 = ['allow_markup' => 'allowMarkup', 'allow_reassign' => 'allowReassign', 'allow_view_history' => 'allowViewHistory', 'asynchronous' => 'asynchronous', 'attachments_uri' => 'attachmentsUri', 'authoritative_copy' => 'authoritativeCopy', 'authoritative_copy_default' => 'authoritativeCopyDefault', 'auto_navigation' => 'autoNavigation', 'brand_id' => 'brandId', 'brand_lock' => 'brandLock', 'certificate_uri' => 'certificateUri', 'completed_date_time' => 'completedDateTime', 'created' => 'created', 'created_date_time' => 'createdDateTime', 'custom_fields' => 'customFields', 'custom_fields_uri' => 'customFieldsUri', 'declined_date_time' => 'declinedDateTime', 'deleted_date_time' => 'deletedDateTime', 'delivered_date_time' => 'deliveredDateTime', 'description' => 'description', 'disable_responsive_document' => 'disableResponsiveDocument', '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_id' => 'envelopeId', 'envelope_id_stamping' => 'envelopeIdStamping', 'envelope_uri' => 'envelopeUri', 'folder_id' => 'folderId', 'folder_name' => 'folderName', 'folder_uri' => 'folderUri', 'initial_sent_date_time' => 'initialSentDateTime', 'is21_cfr_part11' => 'is21CFRPart11', 'is_signature_provider_envelope' => 'isSignatureProviderEnvelope', 'last_modified' => 'lastModified', 'last_modified_date_time' => 'lastModifiedDateTime', 'lock_information' => 'lockInformation', 'message_lock' => 'messageLock', 'name' => 'name', 'notification' => 'notification', 'notification_uri' => 'notificationUri', 'owner' => 'owner', 'page_count' => 'pageCount', 'parent_folder_uri' => 'parentFolderUri', 'password' => 'password', 'purge_state' => 'purgeState', 'recipients' => 'recipients', 'recipients_lock' => 'recipientsLock', 'recipients_uri' => 'recipientsUri', 'sent_date_time' => 'sentDateTime', 'shared' => 'shared', 'signer_can_sign_on_mobile' => 'signerCanSignOnMobile', 'signing_location' => 'signingLocation', 'status' => 'status', 'status_changed_date_time' => 'statusChangedDateTime', 'template_id' => 'templateId', 'templates_uri' => 'templatesUri', 'transaction_id' => 'transactionId', 'uri' => 'uri', 'use_disclosure' => 'useDisclosure', 'voided_date_time' => 'voidedDateTime', 'voided_reason' => 'voidedReason']

$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 = ['allow_markup' => 'getAllowMarkup', 'allow_reassign' => 'getAllowReassign', 'allow_view_history' => 'getAllowViewHistory', 'asynchronous' => 'getAsynchronous', 'attachments_uri' => 'getAttachmentsUri', 'authoritative_copy' => 'getAuthoritativeCopy', 'authoritative_copy_default' => 'getAuthoritativeCopyDefault', 'auto_navigation' => 'getAutoNavigation', 'brand_id' => 'getBrandId', 'brand_lock' => 'getBrandLock', 'certificate_uri' => 'getCertificateUri', 'completed_date_time' => 'getCompletedDateTime', 'created' => 'getCreated', 'created_date_time' => 'getCreatedDateTime', 'custom_fields' => 'getCustomFields', 'custom_fields_uri' => 'getCustomFieldsUri', 'declined_date_time' => 'getDeclinedDateTime', 'deleted_date_time' => 'getDeletedDateTime', 'delivered_date_time' => 'getDeliveredDateTime', 'description' => 'getDescription', 'disable_responsive_document' => 'getDisableResponsiveDocument', '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_id' => 'getEnvelopeId', 'envelope_id_stamping' => 'getEnvelopeIdStamping', 'envelope_uri' => 'getEnvelopeUri', 'folder_id' => 'getFolderId', 'folder_name' => 'getFolderName', 'folder_uri' => 'getFolderUri', 'initial_sent_date_time' => 'getInitialSentDateTime', 'is21_cfr_part11' => 'getIs21CfrPart11', 'is_signature_provider_envelope' => 'getIsSignatureProviderEnvelope', 'last_modified' => 'getLastModified', 'last_modified_date_time' => 'getLastModifiedDateTime', 'lock_information' => 'getLockInformation', 'message_lock' => 'getMessageLock', 'name' => 'getName', 'notification' => 'getNotification', 'notification_uri' => 'getNotificationUri', 'owner' => 'getOwner', 'page_count' => 'getPageCount', 'parent_folder_uri' => 'getParentFolderUri', 'password' => 'getPassword', 'purge_state' => 'getPurgeState', 'recipients' => 'getRecipients', 'recipients_lock' => 'getRecipientsLock', 'recipients_uri' => 'getRecipientsUri', 'sent_date_time' => 'getSentDateTime', 'shared' => 'getShared', 'signer_can_sign_on_mobile' => 'getSignerCanSignOnMobile', 'signing_location' => 'getSigningLocation', 'status' => 'getStatus', 'status_changed_date_time' => 'getStatusChangedDateTime', 'template_id' => 'getTemplateId', 'templates_uri' => 'getTemplatesUri', 'transaction_id' => 'getTransactionId', 'uri' => 'getUri', 'use_disclosure' => 'getUseDisclosure', 'voided_date_time' => 'getVoidedDateTime', 'voided_reason' => 'getVoidedReason']

$setters

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

protected static array<string|int, string> $setters = ['allow_markup' => 'setAllowMarkup', 'allow_reassign' => 'setAllowReassign', 'allow_view_history' => 'setAllowViewHistory', 'asynchronous' => 'setAsynchronous', 'attachments_uri' => 'setAttachmentsUri', 'authoritative_copy' => 'setAuthoritativeCopy', 'authoritative_copy_default' => 'setAuthoritativeCopyDefault', 'auto_navigation' => 'setAutoNavigation', 'brand_id' => 'setBrandId', 'brand_lock' => 'setBrandLock', 'certificate_uri' => 'setCertificateUri', 'completed_date_time' => 'setCompletedDateTime', 'created' => 'setCreated', 'created_date_time' => 'setCreatedDateTime', 'custom_fields' => 'setCustomFields', 'custom_fields_uri' => 'setCustomFieldsUri', 'declined_date_time' => 'setDeclinedDateTime', 'deleted_date_time' => 'setDeletedDateTime', 'delivered_date_time' => 'setDeliveredDateTime', 'description' => 'setDescription', 'disable_responsive_document' => 'setDisableResponsiveDocument', '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_id' => 'setEnvelopeId', 'envelope_id_stamping' => 'setEnvelopeIdStamping', 'envelope_uri' => 'setEnvelopeUri', 'folder_id' => 'setFolderId', 'folder_name' => 'setFolderName', 'folder_uri' => 'setFolderUri', 'initial_sent_date_time' => 'setInitialSentDateTime', 'is21_cfr_part11' => 'setIs21CfrPart11', 'is_signature_provider_envelope' => 'setIsSignatureProviderEnvelope', 'last_modified' => 'setLastModified', 'last_modified_date_time' => 'setLastModifiedDateTime', 'lock_information' => 'setLockInformation', 'message_lock' => 'setMessageLock', 'name' => 'setName', 'notification' => 'setNotification', 'notification_uri' => 'setNotificationUri', 'owner' => 'setOwner', 'page_count' => 'setPageCount', 'parent_folder_uri' => 'setParentFolderUri', 'password' => 'setPassword', 'purge_state' => 'setPurgeState', 'recipients' => 'setRecipients', 'recipients_lock' => 'setRecipientsLock', 'recipients_uri' => 'setRecipientsUri', 'sent_date_time' => 'setSentDateTime', 'shared' => 'setShared', 'signer_can_sign_on_mobile' => 'setSignerCanSignOnMobile', 'signing_location' => 'setSigningLocation', 'status' => 'setStatus', 'status_changed_date_time' => 'setStatusChangedDateTime', 'template_id' => 'setTemplateId', 'templates_uri' => 'setTemplatesUri', 'transaction_id' => 'setTransactionId', 'uri' => 'setUri', 'use_disclosure' => 'setUseDisclosure', 'voided_date_time' => 'setVoidedDateTime', 'voided_reason' => 'setVoidedReason']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'envelopeTemplateResult'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['allow_markup' => 'string', 'allow_reassign' => 'string', 'allow_view_history' => 'string', 'asynchronous' => 'string', 'attachments_uri' => 'string', 'authoritative_copy' => 'string', 'authoritative_copy_default' => 'string', 'auto_navigation' => 'string', 'brand_id' => 'string', 'brand_lock' => 'string', 'certificate_uri' => 'string', 'completed_date_time' => 'string', 'created' => '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', 'description' => 'string', 'disable_responsive_document' => '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_id' => 'string', 'envelope_id_stamping' => 'string', 'envelope_uri' => 'string', 'folder_id' => 'string', 'folder_name' => 'string', 'folder_uri' => 'string', 'initial_sent_date_time' => 'string', 'is21_cfr_part11' => 'string', 'is_signature_provider_envelope' => 'string', 'last_modified' => 'string', 'last_modified_date_time' => 'string', 'lock_information' => '\\DocuSign\\eSign\\Model\\LockInformation', 'message_lock' => 'string', 'name' => 'string', 'notification' => '\\DocuSign\\eSign\\Model\\Notification', 'notification_uri' => 'string', 'owner' => '\\DocuSign\\eSign\\Model\\UserInfo', 'page_count' => 'int', 'parent_folder_uri' => 'string', 'password' => 'string', 'purge_state' => 'string', 'recipients' => '\\DocuSign\\eSign\\Model\\Recipients', 'recipients_lock' => 'string', 'recipients_uri' => 'string', 'sent_date_time' => 'string', 'shared' => 'string', 'signer_can_sign_on_mobile' => 'string', 'signing_location' => 'string', 'status' => 'string', 'status_changed_date_time' => 'string', 'template_id' => 'string', 'templates_uri' => 'string', 'transaction_id' => 'string', 'uri' => 'string', 'use_disclosure' => 'string', 'voided_date_time' => 'string', 'voided_reason' => 'string']

Methods

__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

getAllowReassign()

Gets allow_reassign

public getAllowReassign() : string
Return values
string

getAllowViewHistory()

Gets allow_view_history

public getAllowViewHistory() : string
Return values
string

getAttachmentsUri()

Gets attachments_uri

public getAttachmentsUri() : string
Return values
string

getAuthoritativeCopy()

Gets authoritative_copy

public getAuthoritativeCopy() : string
Return values
string

getAuthoritativeCopyDefault()

Gets authoritative_copy_default

public getAuthoritativeCopyDefault() : string
Return values
string

getAutoNavigation()

Gets auto_navigation

public getAutoNavigation() : string
Return values
string

getCertificateUri()

Gets certificate_uri

public getCertificateUri() : string
Return values
string

getCompletedDateTime()

Gets completed_date_time

public getCompletedDateTime() : string
Return values
string

getCreatedDateTime()

Gets created_date_time

public getCreatedDateTime() : string
Return values
string

getCustomFieldsUri()

Gets custom_fields_uri

public getCustomFieldsUri() : string
Return values
string

getDeclinedDateTime()

Gets declined_date_time

public getDeclinedDateTime() : string
Return values
string

getDeletedDateTime()

Gets deleted_date_time

public getDeletedDateTime() : string
Return values
string

getDeliveredDateTime()

Gets delivered_date_time

public getDeliveredDateTime() : string
Return values
string

getDisableResponsiveDocument()

Gets disable_responsive_document

public getDisableResponsiveDocument() : string
Return values
string

getDocumentsCombinedUri()

Gets documents_combined_uri

public getDocumentsCombinedUri() : string
Return values
string

getDocumentsUri()

Gets documents_uri

public getDocumentsUri() : string
Return values
string

getEmailSubject()

Gets email_subject

public getEmailSubject() : string
Return values
string

getEnableWetSign()

Gets enable_wet_sign

public getEnableWetSign() : string
Return values
string

getEnforceSignerVisibility()

Gets enforce_signer_visibility

public getEnforceSignerVisibility() : string
Return values
string

getEnvelopeIdStamping()

Gets envelope_id_stamping

public getEnvelopeIdStamping() : string
Return values
string

getInitialSentDateTime()

Gets initial_sent_date_time

public getInitialSentDateTime() : string
Return values
string

getIs21CfrPart11()

Gets is21_cfr_part11

public getIs21CfrPart11() : string
Return values
string

getIsSignatureProviderEnvelope()

Gets is_signature_provider_envelope

public getIsSignatureProviderEnvelope() : string
Return values
string

getLastModified()

Gets last_modified

public getLastModified() : string
Return values
string

getLastModifiedDateTime()

Gets last_modified_date_time

public getLastModifiedDateTime() : string
Return values
string

getNotificationUri()

Gets notification_uri

public getNotificationUri() : string
Return values
string

getParentFolderUri()

Gets parent_folder_uri

public getParentFolderUri() : string
Return values
string

getRecipientsLock()

Gets recipients_lock

public getRecipientsLock() : string
Return values
string

getRecipientsUri()

Gets recipients_uri

public getRecipientsUri() : string
Return values
string

getSentDateTime()

Gets sent_date_time

public getSentDateTime() : string
Return values
string

getSignerCanSignOnMobile()

Gets signer_can_sign_on_mobile

public getSignerCanSignOnMobile() : string
Return values
string

getSigningLocation()

Gets signing_location

public getSigningLocation() : string
Return values
string

getStatusChangedDateTime()

Gets status_changed_date_time

public getStatusChangedDateTime() : string
Return values
string

getTemplatesUri()

Gets templates_uri

public getTemplatesUri() : string
Return values
string

getTransactionId()

Gets transaction_id

public getTransactionId() : string
Return values
string

getUseDisclosure()

Gets use_disclosure

public getUseDisclosure() : string
Return values
string

getVoidedDateTime()

Gets voided_date_time

public getVoidedDateTime() : string
Return values
string

getVoidedReason()

Gets voided_reason

public getVoidedReason() : string
Return values
string

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

setAllowMarkup()

Sets allow_markup

public setAllowMarkup(string $allow_markup) : $this
Parameters
$allow_markup : string

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 $allow_reassign) : $this
Parameters
$allow_reassign : string

When set to true, the recipient can redirect an envelope to a more appropriate recipient.

Return values
$this

setAllowViewHistory()

Sets allow_view_history

public setAllowViewHistory(string $allow_view_history) : $this
Parameters
$allow_view_history : string
Return values
$this

setAsynchronous()

Sets asynchronous

public setAsynchronous(string $asynchronous) : $this
Parameters
$asynchronous : string

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

setAttachmentsUri()

Sets attachments_uri

public setAttachmentsUri(string $attachments_uri) : $this
Parameters
$attachments_uri : string
Return values
$this

setAuthoritativeCopy()

Sets authoritative_copy

public setAuthoritativeCopy(string $authoritative_copy) : $this
Parameters
$authoritative_copy : string

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 $authoritative_copy_default) : $this
Parameters
$authoritative_copy_default : string
Return values
$this

setAutoNavigation()

Sets auto_navigation

public setAutoNavigation(string $auto_navigation) : $this
Parameters
$auto_navigation : string
Return values
$this

setBrandId()

Sets brand_id

public setBrandId(string $brand_id) : $this
Parameters
$brand_id : string
Return values
$this

setBrandLock()

Sets brand_lock

public setBrandLock(string $brand_lock) : $this
Parameters
$brand_lock : string
Return values
$this

setCertificateUri()

Sets certificate_uri

public setCertificateUri(string $certificate_uri) : $this
Parameters
$certificate_uri : string

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 $completed_date_time) : $this
Parameters
$completed_date_time : string

Specifies the date and time this item was completed.

Return values
$this

setCreated()

Sets created

public setCreated(string $created) : $this
Parameters
$created : string
Return values
$this

setCreatedDateTime()

Sets created_date_time

public setCreatedDateTime(string $created_date_time) : $this
Parameters
$created_date_time : string

Indicates the date and time the item was created.

Return values
$this

setCustomFieldsUri()

Sets custom_fields_uri

public setCustomFieldsUri(string $custom_fields_uri) : $this
Parameters
$custom_fields_uri : string

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 $declined_date_time) : $this
Parameters
$declined_date_time : string

The date and time the recipient declined the document.

Return values
$this

setDeletedDateTime()

Sets deleted_date_time

public setDeletedDateTime(string $deleted_date_time) : $this
Parameters
$deleted_date_time : string

Specifies the data and time the item was deleted.

Return values
$this

setDeliveredDateTime()

Sets delivered_date_time

public setDeliveredDateTime(string $delivered_date_time) : $this
Parameters
$delivered_date_time : string

Reserved: For DocuSign use only.

Return values
$this

setDescription()

Sets description

public setDescription(string $description) : $this
Parameters
$description : string
Return values
$this

setDisableResponsiveDocument()

Sets disable_responsive_document

public setDisableResponsiveDocument(string $disable_responsive_document) : $this
Parameters
$disable_responsive_document : string
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 $documents_combined_uri) : $this
Parameters
$documents_combined_uri : string
Return values
$this

setDocumentsUri()

Sets documents_uri

public setDocumentsUri(string $documents_uri) : $this
Parameters
$documents_uri : string

Contains a URI for an endpoint that you can use to retrieve the documents.

Return values
$this

setEmailBlurb()

Sets email_blurb

public setEmailBlurb(string $email_blurb) : $this
Parameters
$email_blurb : string
Return values
$this

setEmailSubject()

Sets email_subject

public setEmailSubject(string $email_subject) : $this
Parameters
$email_subject : string

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 $enable_wet_sign) : $this
Parameters
$enable_wet_sign : string

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 $enforce_signer_visibility) : $this
Parameters
$enforce_signer_visibility : string

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

setEnvelopeId()

Sets envelope_id

public setEnvelopeId(string $envelope_id) : $this
Parameters
$envelope_id : string

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

Return values
$this

setEnvelopeIdStamping()

Sets envelope_id_stamping

public setEnvelopeIdStamping(string $envelope_id_stamping) : $this
Parameters
$envelope_id_stamping : string

When set to true, Envelope ID Stamping is enabled.

Return values
$this

setEnvelopeUri()

Sets envelope_uri

public setEnvelopeUri(string $envelope_uri) : $this
Parameters
$envelope_uri : string

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Return values
$this

setFolderId()

Sets folder_id

public setFolderId(string $folder_id) : $this
Parameters
$folder_id : string
Return values
$this

setFolderName()

Sets folder_name

public setFolderName(string $folder_name) : $this
Parameters
$folder_name : string
Return values
$this

setFolderUri()

Sets folder_uri

public setFolderUri(string $folder_uri) : $this
Parameters
$folder_uri : string
Return values
$this

setInitialSentDateTime()

Sets initial_sent_date_time

public setInitialSentDateTime(string $initial_sent_date_time) : $this
Parameters
$initial_sent_date_time : string
Return values
$this

setIs21CfrPart11()

Sets is21_cfr_part11

public setIs21CfrPart11(string $is21_cfr_part11) : $this
Parameters
$is21_cfr_part11 : string

When set to true, indicates that this module is enabled on the account.

Return values
$this

setIsSignatureProviderEnvelope()

Sets is_signature_provider_envelope

public setIsSignatureProviderEnvelope(string $is_signature_provider_envelope) : $this
Parameters
$is_signature_provider_envelope : string
Return values
$this

setLastModified()

Sets last_modified

public setLastModified(string $last_modified) : $this
Parameters
$last_modified : string
Return values
$this

setLastModifiedDateTime()

Sets last_modified_date_time

public setLastModifiedDateTime(string $last_modified_date_time) : $this
Parameters
$last_modified_date_time : string

The date and time the item was last modified.

Return values
$this

setMessageLock()

Sets message_lock

public setMessageLock(string $message_lock) : $this
Parameters
$message_lock : string

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

setName()

Sets name

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setNotificationUri()

Sets notification_uri

public setNotificationUri(string $notification_uri) : $this
Parameters
$notification_uri : string

Contains a URI for an endpoint that you can use to retrieve the notifications.

Return values
$this

setPageCount()

Sets page_count

public setPageCount(int $page_count) : $this
Parameters
$page_count : int
Return values
$this

setParentFolderUri()

Sets parent_folder_uri

public setParentFolderUri(string $parent_folder_uri) : $this
Parameters
$parent_folder_uri : string
Return values
$this

setPassword()

Sets password

public setPassword(string $password) : $this
Parameters
$password : string
Return values
$this

setPurgeState()

Sets purge_state

public setPurgeState(string $purge_state) : $this
Parameters
$purge_state : string
Return values
$this

setRecipientsLock()

Sets recipients_lock

public setRecipientsLock(string $recipients_lock) : $this
Parameters
$recipients_lock : string

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 $recipients_uri) : $this
Parameters
$recipients_uri : string

Contains a URI for an endpoint that you can use to retrieve the recipients.

Return values
$this

setSentDateTime()

Sets sent_date_time

public setSentDateTime(string $sent_date_time) : $this
Parameters
$sent_date_time : string

The date and time the envelope was sent.

Return values
$this

setShared()

Sets shared

public setShared(string $shared) : $this
Parameters
$shared : string

When set to true, this custom tab is shared.

Return values
$this

setSignerCanSignOnMobile()

Sets signer_can_sign_on_mobile

public setSignerCanSignOnMobile(string $signer_can_sign_on_mobile) : $this
Parameters
$signer_can_sign_on_mobile : string
Return values
$this

setSigningLocation()

Sets signing_location

public setSigningLocation(string $signing_location) : $this
Parameters
$signing_location : string

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 $status) : $this
Parameters
$status : string

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 $status_changed_date_time) : $this
Parameters
$status_changed_date_time : string

The data and time the status changed.

Return values
$this

setTemplateId()

Sets template_id

public setTemplateId(string $template_id) : $this
Parameters
$template_id : string

The unique identifier of the template. If this is not provided, DocuSign will generate a value.

Return values
$this

setTemplatesUri()

Sets templates_uri

public setTemplatesUri(string $templates_uri) : $this
Parameters
$templates_uri : string

Contains a URI for an endpoint which you can use to retrieve the templates.

Return values
$this

setTransactionId()

Sets transaction_id

public setTransactionId(string $transaction_id) : $this
Parameters
$transaction_id : string

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

setUri()

Sets uri

public setUri(string $uri) : $this
Parameters
$uri : string
Return values
$this

setUseDisclosure()

Sets use_disclosure

public setUseDisclosure(string $use_disclosure) : $this
Parameters
$use_disclosure : string

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

setVoidedDateTime()

Sets voided_date_time

public setVoidedDateTime(string $voided_date_time) : $this
Parameters
$voided_date_time : string

The date and time the envelope or template was voided.

Return values
$this

setVoidedReason()

Sets voided_reason

public setVoidedReason(string $voided_reason) : $this
Parameters
$voided_reason : string

The reason the envelope or template was voided.

Return values
$this

valid()

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

public valid() : bool
Return values
bool

True if all properteis are valid

Search results