Docusign CSharp Docs
|
Public Member Functions | |
EnvelopeTemplate (string AccessControlListBase64=default(string), string AllowComments=default(string), string AllowMarkup=default(string), string AllowReassign=default(string), string AllowViewHistory=default(string), string AnySigner=default(string), string Asynchronous=default(string), string AttachmentsUri=default(string), string AuthoritativeCopy=default(string), string AuthoritativeCopyDefault=default(string), string AutoMatch=default(string), string AutoMatchSpecifiedByUser=default(string), string AutoNavigation=default(string), string BrandId=default(string), string BrandLock=default(string), string BurnDefaultTabData=default(string), string CertificateUri=default(string), string CompletedDateTime=default(string), string CopyRecipientData=default(string), string Created=default(string), string CreatedDateTime=default(string), CustomFields CustomFields=default(CustomFields), string CustomFieldsUri=default(string), string DeclinedDateTime=default(string), string DeletedDateTime=default(string), string DeliveredDateTime=default(string), string Description=default(string), string DisableResponsiveDocument=default(string), string DocumentBase64=default(string), List< Document > Documents=default(List< Document >), string DocumentsCombinedUri=default(string), string DocumentsUri=default(string), string EmailBlurb=default(string), EmailSettings EmailSettings=default(EmailSettings), string EmailSubject=default(string), string EnableWetSign=default(string), string EnforceSignerVisibility=default(string), List< Attachment > EnvelopeAttachments=default(List< Attachment >), EnvelopeCustomMetadata EnvelopeCustomMetadata=default(EnvelopeCustomMetadata), List< EnvelopeDocument > EnvelopeDocuments=default(List< EnvelopeDocument >), string EnvelopeId=default(string), string EnvelopeIdStamping=default(string), string EnvelopeLocation=default(string), EnvelopeMetadata EnvelopeMetadata=default(EnvelopeMetadata), string EnvelopeUri=default(string), string ExpireAfter=default(string), string ExpireDateTime=default(string), string ExpireEnabled=default(string), string ExternalEnvelopeId=default(string), string FavoritedByMe=default(string), string FolderId=default(string), List< string > FolderIds=default(List< string >), string FolderName=default(string), List< Folder > Folders=default(List< Folder >), string HasComments=default(string), string HasFormDataChanged=default(string), string HasWavFile=default(string), string Holder=default(string), string InitialSentDateTime=default(string), string Is21CFRPart11=default(string), string IsAceGenTemplate=default(string), string IsDocGenTemplate=default(string), string IsDynamicEnvelope=default(string), string IsSignatureProviderEnvelope=default(string), string LastModified=default(string), UserInfo LastModifiedBy=default(UserInfo), string LastModifiedDateTime=default(string), string LastUsed=default(string), string Location=default(string), LockInformation LockInformation=default(LockInformation), string MessageLock=default(string), string Name=default(string), string NewPassword=default(string), Notification Notification=default(Notification), string NotificationUri=default(string), UserInfo Owner=default(UserInfo), string PageCount=default(string), string Password=default(string), string PasswordProtected=default(string), PowerForm PowerForm=default(PowerForm), List< PowerForm > PowerForms=default(List< PowerForm >), string PurgeCompletedDate=default(string), string PurgeRequestDate=default(string), string PurgeState=default(string), Recipients Recipients=default(Recipients), string RecipientsLock=default(string), string RecipientsUri=default(string), UserInfo Sender=default(UserInfo), string SentDateTime=default(string), string Shared=default(string), string SignerCanSignOnMobile=default(string), string SigningLocation=default(string), string Status=default(string), string StatusChangedDateTime=default(string), string StatusDateTime=default(string), string TemplateId=default(string), string TemplatesUri=default(string), string TransactionId=default(string), string Uri=default(string), string UseDisclosure=default(string), string USigState=default(string), string VoidedDateTime=default(string), string VoidedReason=default(string), Workflow Workflow=default(Workflow)) | |
Initializes a new instance of the EnvelopeTemplate class. More... | |
override string | ToString () |
Returns the string presentation of the object More... | |
string | ToJson () |
Returns the JSON string presentation of the object More... | |
override bool | Equals (object obj) |
Returns true if objects are equal More... | |
bool | Equals (EnvelopeTemplate other) |
Returns true if EnvelopeTemplate instances are equal More... | |
override int | GetHashCode () |
Gets the hash code More... | |
IEnumerable< ValidationResult > | Validate (ValidationContext validationContext) |
Properties | |
string | AccessControlListBase64 [get, set] |
Gets or Sets AccessControlListBase64 More... | |
string | AllowComments [get, set] |
Gets or Sets AllowComments More... | |
string | AllowMarkup [get, set] |
When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this More... | |
string | AllowReassign [get, set] |
When set to true, the recipient can redirect an envelope to a more appropriate recipient. More... | |
string | AllowViewHistory [get, set] |
Gets or Sets AllowViewHistory More... | |
string | AnySigner [get, set] |
Gets or Sets AnySigner More... | |
string | Asynchronous [get, set] |
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. More... | |
string | AttachmentsUri [get, set] |
Gets or Sets AttachmentsUri More... | |
string | AuthoritativeCopy [get, set] |
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. More... | |
string | AuthoritativeCopyDefault [get, set] |
Gets or Sets AuthoritativeCopyDefault More... | |
string | AutoMatch [get, set] |
Gets or Sets AutoMatch More... | |
string | AutoMatchSpecifiedByUser [get, set] |
Gets or Sets AutoMatchSpecifiedByUser More... | |
string | AutoNavigation [get, set] |
Gets or Sets AutoNavigation More... | |
string | BrandId [get, set] |
Gets or Sets BrandId More... | |
string | BrandLock [get, set] |
Gets or Sets BrandLock More... | |
string | BurnDefaultTabData [get, set] |
Gets or Sets BurnDefaultTabData More... | |
string | CertificateUri [get, set] |
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. More... | |
string | CompletedDateTime [get, set] |
Specifies the date and time this item was completed. More... | |
string | CopyRecipientData [get, set] |
Gets or Sets CopyRecipientData More... | |
string | Created [get, set] |
Gets or Sets Created More... | |
string | CreatedDateTime [get, set] |
Indicates the date and time the item was created. More... | |
CustomFields | CustomFields [get, set] |
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. More... | |
string | CustomFieldsUri [get, set] |
Contains a URI for an endpoint that you can use to retrieve the custom fields. More... | |
string | DeclinedDateTime [get, set] |
The date and time the recipient declined the document. More... | |
string | DeletedDateTime [get, set] |
Specifies the data and time the item was deleted. More... | |
string | DeliveredDateTime [get, set] |
Reserved: For DocuSign use only. More... | |
string | Description [get, set] |
Gets or Sets Description More... | |
string | DisableResponsiveDocument [get, set] |
Gets or Sets DisableResponsiveDocument More... | |
string | DocumentBase64 [get, set] |
Gets or Sets DocumentBase64 More... | |
List< Document > | Documents [get, set] |
Complex element contains the details on the documents in the envelope. More... | |
string | DocumentsCombinedUri [get, set] |
Gets or Sets DocumentsCombinedUri More... | |
string | DocumentsUri [get, set] |
Contains a URI for an endpoint that you can use to retrieve the documents. More... | |
string | EmailBlurb [get, set] |
Gets or Sets EmailBlurb More... | |
EmailSettings | EmailSettings [get, set] |
A complex type that contains email settings. More... | |
string | EmailSubject [get, set] |
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. More... | |
string | EnableWetSign [get, set] |
When set to true, the signer is allowed to print the document and sign it on paper. More... | |
string | EnforceSignerVisibility [get, set] |
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. More... | |
List< Attachment > | EnvelopeAttachments [get, set] |
Gets or Sets EnvelopeAttachments More... | |
EnvelopeCustomMetadata | EnvelopeCustomMetadata [get, set] |
Gets or Sets EnvelopeCustomMetadata More... | |
List< EnvelopeDocument > | EnvelopeDocuments [get, set] |
Gets or Sets EnvelopeDocuments More... | |
string | EnvelopeId [get, set] |
The envelope ID of the envelope status that failed to post. More... | |
string | EnvelopeIdStamping [get, set] |
When set to true, Envelope ID Stamping is enabled. More... | |
string | EnvelopeLocation [get, set] |
Gets or Sets EnvelopeLocation More... | |
EnvelopeMetadata | EnvelopeMetadata [get, set] |
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. More... | |
string | EnvelopeUri [get, set] |
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. More... | |
string | ExpireAfter [get, set] |
Gets or Sets ExpireAfter More... | |
string | ExpireDateTime [get, set] |
Gets or Sets ExpireDateTime More... | |
string | ExpireEnabled [get, set] |
Gets or Sets ExpireEnabled More... | |
string | ExternalEnvelopeId [get, set] |
Gets or Sets ExternalEnvelopeId More... | |
string | FavoritedByMe [get, set] |
Gets or Sets FavoritedByMe More... | |
string | FolderId [get, set] |
Gets or Sets FolderId More... | |
List< string > | FolderIds [get, set] |
Gets or Sets FolderIds More... | |
string | FolderName [get, set] |
Gets or Sets FolderName More... | |
List< Folder > | Folders [get, set] |
Gets or Sets Folders More... | |
string | HasComments [get, set] |
Gets or Sets HasComments More... | |
string | HasFormDataChanged [get, set] |
Gets or Sets HasFormDataChanged More... | |
string | HasWavFile [get, set] |
Gets or Sets HasWavFile More... | |
string | Holder [get, set] |
Gets or Sets Holder More... | |
string | InitialSentDateTime [get, set] |
Gets or Sets InitialSentDateTime More... | |
string | Is21CFRPart11 [get, set] |
When set to true, indicates that this module is enabled on the account. More... | |
string | IsAceGenTemplate [get, set] |
Gets or Sets IsAceGenTemplate More... | |
string | IsDocGenTemplate [get, set] |
Gets or Sets IsDocGenTemplate More... | |
string | IsDynamicEnvelope [get, set] |
Gets or Sets IsDynamicEnvelope More... | |
string | IsSignatureProviderEnvelope [get, set] |
Gets or Sets IsSignatureProviderEnvelope More... | |
string | LastModified [get, set] |
Gets or Sets LastModified More... | |
UserInfo | LastModifiedBy [get, set] |
Gets or Sets LastModifiedBy More... | |
string | LastModifiedDateTime [get, set] |
The date and time the item was last modified. More... | |
string | LastUsed [get, set] |
Gets or Sets LastUsed More... | |
string | Location [get, set] |
Gets or Sets Location More... | |
LockInformation | LockInformation [get, set] |
Provides lock information about an envelope that a user has locked. More... | |
string | MessageLock [get, set] |
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. More... | |
string | Name [get, set] |
Gets or Sets Name More... | |
string | NewPassword [get, set] |
Gets or Sets NewPassword More... | |
Notification | Notification [get, set] |
Gets or Sets Notification More... | |
string | NotificationUri [get, set] |
Contains a URI for an endpoint that you can use to retrieve the notifications. More... | |
UserInfo | Owner [get, set] |
Gets or Sets Owner More... | |
string | PageCount [get, set] |
Gets or Sets PageCount More... | |
string | Password [get, set] |
Gets or Sets Password More... | |
string | PasswordProtected [get, set] |
Gets or Sets PasswordProtected More... | |
PowerForm | PowerForm [get, set] |
Information about any PowerForms that are included in the envelope. More... | |
List< PowerForm > | PowerForms [get, set] |
Gets or Sets PowerForms More... | |
string | PurgeCompletedDate [get, set] |
Gets or Sets PurgeCompletedDate More... | |
string | PurgeRequestDate [get, set] |
Gets or Sets PurgeRequestDate More... | |
string | PurgeState [get, set] |
Gets or Sets PurgeState More... | |
Recipients | Recipients [get, set] |
An array of powerform recipients. More... | |
string | RecipientsLock [get, set] |
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. More... | |
string | RecipientsUri [get, set] |
Contains a URI for an endpoint that you can use to retrieve the recipients. More... | |
UserInfo | Sender [get, set] |
Information about the sender of the envelope. More... | |
string | SentDateTime [get, set] |
The date and time the envelope was sent. More... | |
string | Shared [get, set] |
When set to true, this custom tab is shared. More... | |
string | SignerCanSignOnMobile [get, set] |
Gets or Sets SignerCanSignOnMobile More... | |
string | SigningLocation [get, set] |
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. More... | |
string | Status [get, set] |
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. More... | |
string | StatusChangedDateTime [get, set] |
The data and time the status changed. More... | |
string | StatusDateTime [get, set] |
Gets or Sets StatusDateTime More... | |
string | TemplateId [get, set] |
The unique identifier of the template. If this is not provided, DocuSign will generate a value. More... | |
string | TemplatesUri [get, set] |
Contains a URI for an endpoint which you can use to retrieve the templates. More... | |
string | TransactionId [get, set] |
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. More... | |
string | Uri [get, set] |
Gets or Sets Uri More... | |
string | UseDisclosure [get, set] |
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. More... | |
string | USigState [get, set] |
Gets or Sets USigState More... | |
string | VoidedDateTime [get, set] |
The date and time the envelope or template was voided. More... | |
string | VoidedReason [get, set] |
The reason the envelope or template was voided. More... | |
Workflow | Workflow [get, set] |
Gets or Sets Workflow More... | |
|
inline |
Initializes a new instance of the EnvelopeTemplate class.
AccessControlListBase64 | AccessControlListBase64. |
AllowComments | AllowComments. |
AllowMarkup | When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this. |
AllowReassign | When set to true, the recipient can redirect an envelope to a more appropriate recipient.. |
AllowViewHistory | AllowViewHistory. |
AnySigner | AnySigner. |
Asynchronous | 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.. |
AttachmentsUri | AttachmentsUri. |
AuthoritativeCopy | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.. |
AuthoritativeCopyDefault | AuthoritativeCopyDefault. |
AutoMatch | AutoMatch. |
AutoMatchSpecifiedByUser | AutoMatchSpecifiedByUser. |
AutoNavigation | AutoNavigation. |
BrandId | BrandId. |
BrandLock | BrandLock. |
BurnDefaultTabData | BurnDefaultTabData. |
CertificateUri | Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.. |
CompletedDateTime | Specifies the date and time this item was completed.. |
CopyRecipientData | CopyRecipientData. |
Created | Created. |
CreatedDateTime | Indicates the date and time the item was created.. |
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.. |
CustomFieldsUri | Contains a URI for an endpoint that you can use to retrieve the custom fields.. |
DeclinedDateTime | The date and time the recipient declined the document.. |
DeletedDateTime | Specifies the data and time the item was deleted.. |
DeliveredDateTime | Reserved: For DocuSign use only.. |
Description | Description. |
DisableResponsiveDocument | DisableResponsiveDocument. |
DocumentBase64 | DocumentBase64. |
Documents | Complex element contains the details on the documents in the envelope.. |
DocumentsCombinedUri | DocumentsCombinedUri. |
DocumentsUri | Contains a URI for an endpoint that you can use to retrieve the documents.. |
EmailBlurb | EmailBlurb. |
EmailSettings | A complex type that contains email settings.. |
EmailSubject | 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.. |
EnableWetSign | When set to true, the signer is allowed to print the document and sign it on paper.. |
EnforceSignerVisibility | 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.. |
EnvelopeAttachments | EnvelopeAttachments. |
EnvelopeCustomMetadata | EnvelopeCustomMetadata. |
EnvelopeDocuments | EnvelopeDocuments. |
EnvelopeId | The envelope ID of the envelope status that failed to post.. |
EnvelopeIdStamping | When set to true, Envelope ID Stamping is enabled.. |
EnvelopeLocation | EnvelopeLocation. |
EnvelopeMetadata | Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.. |
EnvelopeUri | Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.. |
ExpireAfter | ExpireAfter. |
ExpireDateTime | ExpireDateTime. |
ExpireEnabled | ExpireEnabled. |
ExternalEnvelopeId | ExternalEnvelopeId. |
FavoritedByMe | FavoritedByMe. |
FolderId | FolderId. |
FolderIds | FolderIds. |
FolderName | FolderName. |
Folders | Folders. |
HasComments | HasComments. |
HasFormDataChanged | HasFormDataChanged. |
HasWavFile | HasWavFile. |
Holder | Holder. |
InitialSentDateTime | InitialSentDateTime. |
Is21CFRPart11 | When set to true, indicates that this module is enabled on the account.. |
IsAceGenTemplate | IsAceGenTemplate. |
IsDocGenTemplate | IsDocGenTemplate. |
IsDynamicEnvelope | IsDynamicEnvelope. |
IsSignatureProviderEnvelope | IsSignatureProviderEnvelope. |
LastModified | LastModified. |
LastModifiedBy | LastModifiedBy. |
LastModifiedDateTime | The date and time the item was last modified.. |
LastUsed | LastUsed. |
Location | Location. |
LockInformation | Provides lock information about an envelope that a user has locked.. |
MessageLock | 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.. |
Name | Name. |
NewPassword | NewPassword. |
Notification | Notification. |
NotificationUri | Contains a URI for an endpoint that you can use to retrieve the notifications.. |
Owner | Owner. |
PageCount | PageCount. |
Password | Password. |
PasswordProtected | PasswordProtected. |
PowerForm | Information about any PowerForms that are included in the envelope.. |
PowerForms | PowerForms. |
PurgeCompletedDate | PurgeCompletedDate. |
PurgeRequestDate | PurgeRequestDate. |
PurgeState | PurgeState. |
Recipients | An array of powerform recipients.. |
RecipientsLock | When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.. |
RecipientsUri | Contains a URI for an endpoint that you can use to retrieve the recipients.. |
Sender | Information about the sender of the envelope.. |
SentDateTime | The date and time the envelope was sent.. |
Shared | When set to true, this custom tab is shared.. |
SignerCanSignOnMobile | SignerCanSignOnMobile. |
SigningLocation | Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.. |
Status | 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.. |
StatusChangedDateTime | The data and time the status changed.. |
StatusDateTime | StatusDateTime. |
TemplateId | The unique identifier of the template. If this is not provided, DocuSign will generate a value. . |
TemplatesUri | Contains a URI for an endpoint which you can use to retrieve the templates.. |
TransactionId | 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.. |
Uri | Uri. |
UseDisclosure | 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.. |
USigState | USigState. |
VoidedDateTime | The date and time the envelope or template was voided.. |
VoidedReason | The reason the envelope or template was voided.. |
Workflow | Workflow. |
|
inline |
Returns true if objects are equal
obj | Object to be compared |
|
inline |
Returns true if EnvelopeTemplate instances are equal
other | Instance of EnvelopeTemplate to be compared |
|
inline |
Gets the hash code
|
inline |
Returns the JSON string presentation of the object
|
inline |
Returns the string presentation of the object
|
getset |
Gets or Sets AccessControlListBase64
|
getset |
Gets or Sets AllowComments
|
getset |
|
getset |
When set to true, the recipient can redirect an envelope to a more appropriate recipient.
When set to true, the recipient can redirect an envelope to a more appropriate recipient.
|
getset |
Gets or Sets AllowViewHistory
|
getset |
Gets or Sets AnySigner
|
getset |
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.
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.
|
getset |
Gets or Sets AttachmentsUri
|
getset |
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
|
getset |
Gets or Sets AuthoritativeCopyDefault
|
getset |
Gets or Sets AutoMatch
|
getset |
Gets or Sets AutoMatchSpecifiedByUser
|
getset |
Gets or Sets AutoNavigation
|
getset |
Gets or Sets BrandId
|
getset |
Gets or Sets BrandLock
|
getset |
Gets or Sets BurnDefaultTabData
|
getset |
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
|
getset |
Specifies the date and time this item was completed.
Specifies the date and time this item was completed.
|
getset |
Gets or Sets CopyRecipientData
|
getset |
Gets or Sets Created
|
getset |
Indicates the date and time the item was created.
Indicates the date and time the item was created.
|
getset |
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.
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.
|
getset |
Contains a URI for an endpoint that you can use to retrieve the custom fields.
Contains a URI for an endpoint that you can use to retrieve the custom fields.
|
getset |
The date and time the recipient declined the document.
The date and time the recipient declined the document.
|
getset |
Specifies the data and time the item was deleted.
Specifies the data and time the item was deleted.
|
getset |
|
getset |
Gets or Sets Description
|
getset |
Gets or Sets DisableResponsiveDocument
|
getset |
Gets or Sets DocumentBase64
Complex element contains the details on the documents in the envelope.
Complex element contains the details on the documents in the envelope.
|
getset |
Gets or Sets DocumentsCombinedUri
|
getset |
Contains a URI for an endpoint that you can use to retrieve the documents.
Contains a URI for an endpoint that you can use to retrieve the documents.
|
getset |
Gets or Sets EmailBlurb
|
getset |
A complex type that contains email settings.
A complex type that contains email settings.
|
getset |
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.
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.
|
getset |
When set to true, the signer is allowed to print the document and sign it on paper.
When set to true, the signer is allowed to print the document and sign it on paper.
|
getset |
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.
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.
|
getset |
Gets or Sets EnvelopeAttachments
|
getset |
Gets or Sets EnvelopeCustomMetadata
|
getset |
Gets or Sets EnvelopeDocuments
|
getset |
The envelope ID of the envelope status that failed to post.
The envelope ID of the envelope status that failed to post.
|
getset |
|
getset |
Gets or Sets EnvelopeLocation
|
getset |
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.
|
getset |
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
|
getset |
Gets or Sets ExpireAfter
|
getset |
Gets or Sets ExpireDateTime
|
getset |
Gets or Sets ExpireEnabled
|
getset |
Gets or Sets ExternalEnvelopeId
|
getset |
Gets or Sets FavoritedByMe
|
getset |
Gets or Sets FolderId
|
getset |
Gets or Sets FolderIds
|
getset |
Gets or Sets FolderName
|
getset |
Gets or Sets HasComments
|
getset |
Gets or Sets HasFormDataChanged
|
getset |
Gets or Sets HasWavFile
|
getset |
Gets or Sets Holder
|
getset |
Gets or Sets InitialSentDateTime
|
getset |
When set to true, indicates that this module is enabled on the account.
When set to true, indicates that this module is enabled on the account.
|
getset |
Gets or Sets IsAceGenTemplate
|
getset |
Gets or Sets IsDocGenTemplate
|
getset |
Gets or Sets IsDynamicEnvelope
|
getset |
Gets or Sets IsSignatureProviderEnvelope
|
getset |
Gets or Sets LastModified
|
getset |
Gets or Sets LastModifiedBy
|
getset |
The date and time the item was last modified.
The date and time the item was last modified.
|
getset |
Gets or Sets LastUsed
|
getset |
Gets or Sets Location
|
getset |
Provides lock information about an envelope that a user has locked.
Provides lock information about an envelope that a user has locked.
|
getset |
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.
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.
|
getset |
Gets or Sets Name
|
getset |
Gets or Sets NewPassword
|
getset |
Gets or Sets Notification
|
getset |
Contains a URI for an endpoint that you can use to retrieve the notifications.
Contains a URI for an endpoint that you can use to retrieve the notifications.
|
getset |
Gets or Sets Owner
|
getset |
Gets or Sets PageCount
|
getset |
Gets or Sets Password
|
getset |
Gets or Sets PasswordProtected
|
getset |
Information about any PowerForms that are included in the envelope.
Information about any PowerForms that are included in the envelope.
|
getset |
Gets or Sets PurgeCompletedDate
|
getset |
Gets or Sets PurgeRequestDate
|
getset |
Gets or Sets PurgeState
|
getset |
An array of powerform recipients.
An array of powerform recipients.
|
getset |
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
|
getset |
Contains a URI for an endpoint that you can use to retrieve the recipients.
Contains a URI for an endpoint that you can use to retrieve the recipients.
|
getset |
Information about the sender of the envelope.
Information about the sender of the envelope.
|
getset |
The date and time the envelope was sent.
The date and time the envelope was sent.
|
getset |
When set to true, this custom tab is shared.
When set to true, this custom tab is shared.
|
getset |
Gets or Sets SignerCanSignOnMobile
|
getset |
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
|
getset |
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.
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.
|
getset |
The data and time the status changed.
The data and time the status changed.
|
getset |
Gets or Sets StatusDateTime
|
getset |
|
getset |
Contains a URI for an endpoint which you can use to retrieve the templates.
Contains a URI for an endpoint which you can use to retrieve the templates.
|
getset |
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.
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.
|
getset |
Gets or Sets Uri
|
getset |
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.
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.
|
getset |
Gets or Sets USigState
|
getset |
The date and time the envelope or template was voided.
The date and time the envelope or template was voided.
|
getset |
The reason the envelope or template was voided.
The reason the envelope or template was voided.