class DocuSign_eSign::EnvelopeTemplate
Attributes
access_control_list_base64[RW]
allow_comments[RW]
allow_markup[RW]
allow_reassign[RW]
When set to true, the recipient can redirect an envelope to a more appropriate recipient.
allow_view_history[RW]
any_signer[RW]
asynchronous[RW]
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.
attachments_uri[RW]
auto_match[RW]
auto_match_specified_by_user[RW]
brand_id[RW]
brand_lock[RW]
certificate_uri[RW]
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
completed_date_time[RW]
Specifies the date and time this item was completed.
copy_recipient_data[RW]
created[RW]
created_date_time[RW]
Indicates the date and time the item was created.
custom_fields[RW]
custom_fields_uri[RW]
Contains a URI for an endpoint that you can use to retrieve the custom fields.
declined_date_time[RW]
The date and time the recipient declined the document.
deleted_date_time[RW]
Specifies the data and time the item was deleted.
delivered_date_time[RW]
Reserved: For DocuSign use only.
description[RW]
disable_responsive_document[RW]
document_base64[RW]
documents[RW]
Complex element contains the details on the documents in the envelope.
documents_combined_uri[RW]
documents_uri[RW]
Contains a URI for an endpoint that you can use to retrieve the documents.
email_blurb[RW]
email_settings[RW]
email_subject[RW]
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.
enable_wet_sign[RW]
When set to true, the signer is allowed to print the document and sign it on paper.
enforce_signer_visibility[RW]
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.
envelope_attachments[RW]
envelope_custom_metadata[RW]
envelope_documents[RW]
envelope_id[RW]
The envelope ID of the envelope status that failed to post.
envelope_id_stamping[RW]
When set to true, Envelope ID Stamping is enabled.
envelope_location[RW]
envelope_metadata[RW]
envelope_uri[RW]
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
expire_after[RW]
expire_date_time[RW]
expire_enabled[RW]
external_envelope_id[RW]
favorited_by_me[RW]
folder_id[RW]
folder_ids[RW]
folder_name[RW]
folders[RW]
has_comments[RW]
has_form_data_changed[RW]
has_wav_file[RW]
holder[RW]
initial_sent_date_time[RW]
is21_cfr_part11[RW]
When set to true, indicates that this module is enabled on the account.
is_dynamic_envelope[RW]
is_signature_provider_envelope[RW]
last_modified[RW]
last_modified_by[RW]
last_modified_date_time[RW]
The date and time the item was last modified.
last_used[RW]
location[RW]
lock_information[RW]
message_lock[RW]
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[RW]
new_password[RW]
notification[RW]
notification_uri[RW]
Contains a URI for an endpoint that you can use to retrieve the notifications.
owner[RW]
page_count[RW]
password[RW]
password_protected[RW]
power_form[RW]
power_forms[RW]
purge_completed_date[RW]
purge_request_date[RW]
purge_state[RW]
recipients[RW]
recipients_lock[RW]
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
recipients_uri[RW]
Contains a URI for an endpoint that you can use to retrieve the recipients.
sender[RW]
sent_date_time[RW]
The date and time the envelope was sent.
signer_can_sign_on_mobile[RW]
signing_location[RW]
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
status[RW]
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.
status_changed_date_time[RW]
The data and time the status changed.
status_date_time[RW]
template_id[RW]
The unique identifier of the template. If this is not provided, DocuSign will generate a value.
templates_uri[RW]
Contains a URI for an endpoint which you can use to retrieve the templates.
transaction_id[RW]
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[RW]
use_disclosure[RW]
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.
voided_date_time[RW]
The date and time the envelope or template was voided.
voided_reason[RW]
The reason the envelope or template was voided.
workflow[RW]
Public Class Methods
attribute_map()
click to toggle source
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docusign_esign/models/envelope_template.rb, line 305 def self.attribute_map { :'access_control_list_base64' => :'accessControlListBase64', :'allow_comments' => :'allowComments', :'allow_markup' => :'allowMarkup', :'allow_reassign' => :'allowReassign', :'allow_view_history' => :'allowViewHistory', :'any_signer' => :'anySigner', :'asynchronous' => :'asynchronous', :'attachments_uri' => :'attachmentsUri', :'authoritative_copy' => :'authoritativeCopy', :'authoritative_copy_default' => :'authoritativeCopyDefault', :'auto_match' => :'autoMatch', :'auto_match_specified_by_user' => :'autoMatchSpecifiedByUser', :'auto_navigation' => :'autoNavigation', :'brand_id' => :'brandId', :'brand_lock' => :'brandLock', :'certificate_uri' => :'certificateUri', :'completed_date_time' => :'completedDateTime', :'copy_recipient_data' => :'copyRecipientData', :'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', :'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', :'expire_after' => :'expireAfter', :'expire_date_time' => :'expireDateTime', :'expire_enabled' => :'expireEnabled', :'external_envelope_id' => :'externalEnvelopeId', :'favorited_by_me' => :'favoritedByMe', :'folder_id' => :'folderId', :'folder_ids' => :'folderIds', :'folder_name' => :'folderName', :'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' => :'lastModified', :'last_modified_by' => :'lastModifiedBy', :'last_modified_date_time' => :'lastModifiedDateTime', :'last_used' => :'lastUsed', :'location' => :'location', :'lock_information' => :'lockInformation', :'message_lock' => :'messageLock', :'name' => :'name', :'new_password' => :'newPassword', :'notification' => :'notification', :'notification_uri' => :'notificationUri', :'owner' => :'owner', :'page_count' => :'pageCount', :'password' => :'password', :'password_protected' => :'passwordProtected', :'power_form' => :'powerForm', :'power_forms' => :'powerForms', :'purge_completed_date' => :'purgeCompletedDate', :'purge_request_date' => :'purgeRequestDate', :'purge_state' => :'purgeState', :'recipients' => :'recipients', :'recipients_lock' => :'recipientsLock', :'recipients_uri' => :'recipientsUri', :'sender' => :'sender', :'sent_date_time' => :'sentDateTime', :'shared' => :'shared', :'signer_can_sign_on_mobile' => :'signerCanSignOnMobile', :'signing_location' => :'signingLocation', :'status' => :'status', :'status_changed_date_time' => :'statusChangedDateTime', :'status_date_time' => :'statusDateTime', :'template_id' => :'templateId', :'templates_uri' => :'templatesUri', :'transaction_id' => :'transactionId', :'uri' => :'uri', :'use_disclosure' => :'useDisclosure', :'voided_date_time' => :'voidedDateTime', :'voided_reason' => :'voidedReason', :'workflow' => :'workflow' } end
new(attributes = {})
click to toggle source
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docusign_esign/models/envelope_template.rb, line 518 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'accessControlListBase64') self.access_control_list_base64 = attributes[:'accessControlListBase64'] end if attributes.has_key?(:'allowComments') self.allow_comments = attributes[:'allowComments'] end if attributes.has_key?(:'allowMarkup') self.allow_markup = attributes[:'allowMarkup'] end if attributes.has_key?(:'allowReassign') self.allow_reassign = attributes[:'allowReassign'] end if attributes.has_key?(:'allowViewHistory') self.allow_view_history = attributes[:'allowViewHistory'] end if attributes.has_key?(:'anySigner') self.any_signer = attributes[:'anySigner'] end if attributes.has_key?(:'asynchronous') self.asynchronous = attributes[:'asynchronous'] end if attributes.has_key?(:'attachmentsUri') self.attachments_uri = attributes[:'attachmentsUri'] end if attributes.has_key?(:'authoritativeCopy') self.authoritative_copy = attributes[:'authoritativeCopy'] end if attributes.has_key?(:'authoritativeCopyDefault') self.authoritative_copy_default = attributes[:'authoritativeCopyDefault'] end if attributes.has_key?(:'autoMatch') self.auto_match = attributes[:'autoMatch'] end if attributes.has_key?(:'autoMatchSpecifiedByUser') self.auto_match_specified_by_user = attributes[:'autoMatchSpecifiedByUser'] end if attributes.has_key?(:'autoNavigation') self.auto_navigation = attributes[:'autoNavigation'] end if attributes.has_key?(:'brandId') self.brand_id = attributes[:'brandId'] end if attributes.has_key?(:'brandLock') self.brand_lock = attributes[:'brandLock'] end if attributes.has_key?(:'certificateUri') self.certificate_uri = attributes[:'certificateUri'] end if attributes.has_key?(:'completedDateTime') self.completed_date_time = attributes[:'completedDateTime'] end if attributes.has_key?(:'copyRecipientData') self.copy_recipient_data = attributes[:'copyRecipientData'] end if attributes.has_key?(:'created') self.created = attributes[:'created'] end if attributes.has_key?(:'createdDateTime') self.created_date_time = attributes[:'createdDateTime'] end if attributes.has_key?(:'customFields') self.custom_fields = attributes[:'customFields'] end if attributes.has_key?(:'customFieldsUri') self.custom_fields_uri = attributes[:'customFieldsUri'] end if attributes.has_key?(:'declinedDateTime') self.declined_date_time = attributes[:'declinedDateTime'] end if attributes.has_key?(:'deletedDateTime') self.deleted_date_time = attributes[:'deletedDateTime'] end if attributes.has_key?(:'deliveredDateTime') self.delivered_date_time = attributes[:'deliveredDateTime'] end if attributes.has_key?(:'description') self.description = attributes[:'description'] end if attributes.has_key?(:'disableResponsiveDocument') self.disable_responsive_document = attributes[:'disableResponsiveDocument'] end if attributes.has_key?(:'documentBase64') self.document_base64 = attributes[:'documentBase64'] end if attributes.has_key?(:'documents') if (value = attributes[:'documents']).is_a?(Array) self.documents = value end end if attributes.has_key?(:'documentsCombinedUri') self.documents_combined_uri = attributes[:'documentsCombinedUri'] end if attributes.has_key?(:'documentsUri') self.documents_uri = attributes[:'documentsUri'] end if attributes.has_key?(:'emailBlurb') self.email_blurb = attributes[:'emailBlurb'] end if attributes.has_key?(:'emailSettings') self.email_settings = attributes[:'emailSettings'] end if attributes.has_key?(:'emailSubject') self.email_subject = attributes[:'emailSubject'] end if attributes.has_key?(:'enableWetSign') self.enable_wet_sign = attributes[:'enableWetSign'] end if attributes.has_key?(:'enforceSignerVisibility') self.enforce_signer_visibility = attributes[:'enforceSignerVisibility'] end if attributes.has_key?(:'envelopeAttachments') if (value = attributes[:'envelopeAttachments']).is_a?(Array) self.envelope_attachments = value end end if attributes.has_key?(:'envelopeCustomMetadata') self.envelope_custom_metadata = attributes[:'envelopeCustomMetadata'] end if attributes.has_key?(:'envelopeDocuments') if (value = attributes[:'envelopeDocuments']).is_a?(Array) self.envelope_documents = value end end if attributes.has_key?(:'envelopeId') self.envelope_id = attributes[:'envelopeId'] end if attributes.has_key?(:'envelopeIdStamping') self.envelope_id_stamping = attributes[:'envelopeIdStamping'] end if attributes.has_key?(:'envelopeLocation') self.envelope_location = attributes[:'envelopeLocation'] end if attributes.has_key?(:'envelopeMetadata') self.envelope_metadata = attributes[:'envelopeMetadata'] end if attributes.has_key?(:'envelopeUri') self.envelope_uri = attributes[:'envelopeUri'] end if attributes.has_key?(:'expireAfter') self.expire_after = attributes[:'expireAfter'] end if attributes.has_key?(:'expireDateTime') self.expire_date_time = attributes[:'expireDateTime'] end if attributes.has_key?(:'expireEnabled') self.expire_enabled = attributes[:'expireEnabled'] end if attributes.has_key?(:'externalEnvelopeId') self.external_envelope_id = attributes[:'externalEnvelopeId'] end if attributes.has_key?(:'favoritedByMe') self.favorited_by_me = attributes[:'favoritedByMe'] end if attributes.has_key?(:'folderId') self.folder_id = attributes[:'folderId'] end if attributes.has_key?(:'folderIds') if (value = attributes[:'folderIds']).is_a?(Array) self.folder_ids = value end end if attributes.has_key?(:'folderName') self.folder_name = attributes[:'folderName'] end if attributes.has_key?(:'folders') if (value = attributes[:'folders']).is_a?(Array) self.folders = value end end if attributes.has_key?(:'hasComments') self.has_comments = attributes[:'hasComments'] end if attributes.has_key?(:'hasFormDataChanged') self.has_form_data_changed = attributes[:'hasFormDataChanged'] end if attributes.has_key?(:'hasWavFile') self.has_wav_file = attributes[:'hasWavFile'] end if attributes.has_key?(:'holder') self.holder = attributes[:'holder'] end if attributes.has_key?(:'initialSentDateTime') self.initial_sent_date_time = attributes[:'initialSentDateTime'] end if attributes.has_key?(:'is21CFRPart11') self.is21_cfr_part11 = attributes[:'is21CFRPart11'] end if attributes.has_key?(:'isDynamicEnvelope') self.is_dynamic_envelope = attributes[:'isDynamicEnvelope'] end if attributes.has_key?(:'isSignatureProviderEnvelope') self.is_signature_provider_envelope = attributes[:'isSignatureProviderEnvelope'] end if attributes.has_key?(:'lastModified') self.last_modified = attributes[:'lastModified'] end if attributes.has_key?(:'lastModifiedBy') self.last_modified_by = attributes[:'lastModifiedBy'] end if attributes.has_key?(:'lastModifiedDateTime') self.last_modified_date_time = attributes[:'lastModifiedDateTime'] end if attributes.has_key?(:'lastUsed') self.last_used = attributes[:'lastUsed'] end if attributes.has_key?(:'location') self.location = attributes[:'location'] end if attributes.has_key?(:'lockInformation') self.lock_information = attributes[:'lockInformation'] end if attributes.has_key?(:'messageLock') self.message_lock = attributes[:'messageLock'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'newPassword') self.new_password = attributes[:'newPassword'] end if attributes.has_key?(:'notification') self.notification = attributes[:'notification'] end if attributes.has_key?(:'notificationUri') self.notification_uri = attributes[:'notificationUri'] end if attributes.has_key?(:'owner') self.owner = attributes[:'owner'] end if attributes.has_key?(:'pageCount') self.page_count = attributes[:'pageCount'] end if attributes.has_key?(:'password') self.password = attributes[:'password'] end if attributes.has_key?(:'passwordProtected') self.password_protected = attributes[:'passwordProtected'] end if attributes.has_key?(:'powerForm') self.power_form = attributes[:'powerForm'] end if attributes.has_key?(:'powerForms') if (value = attributes[:'powerForms']).is_a?(Array) self.power_forms = value end end if attributes.has_key?(:'purgeCompletedDate') self.purge_completed_date = attributes[:'purgeCompletedDate'] end if attributes.has_key?(:'purgeRequestDate') self.purge_request_date = attributes[:'purgeRequestDate'] end if attributes.has_key?(:'purgeState') self.purge_state = attributes[:'purgeState'] end if attributes.has_key?(:'recipients') self.recipients = attributes[:'recipients'] end if attributes.has_key?(:'recipientsLock') self.recipients_lock = attributes[:'recipientsLock'] end if attributes.has_key?(:'recipientsUri') self.recipients_uri = attributes[:'recipientsUri'] end if attributes.has_key?(:'sender') self.sender = attributes[:'sender'] end if attributes.has_key?(:'sentDateTime') self.sent_date_time = attributes[:'sentDateTime'] end if attributes.has_key?(:'shared') self.shared = attributes[:'shared'] end if attributes.has_key?(:'signerCanSignOnMobile') self.signer_can_sign_on_mobile = attributes[:'signerCanSignOnMobile'] end if attributes.has_key?(:'signingLocation') self.signing_location = attributes[:'signingLocation'] end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'statusChangedDateTime') self.status_changed_date_time = attributes[:'statusChangedDateTime'] end if attributes.has_key?(:'statusDateTime') self.status_date_time = attributes[:'statusDateTime'] end if attributes.has_key?(:'templateId') self.template_id = attributes[:'templateId'] end if attributes.has_key?(:'templatesUri') self.templates_uri = attributes[:'templatesUri'] end if attributes.has_key?(:'transactionId') self.transaction_id = attributes[:'transactionId'] end if attributes.has_key?(:'uri') self.uri = attributes[:'uri'] end if attributes.has_key?(:'useDisclosure') self.use_disclosure = attributes[:'useDisclosure'] end if attributes.has_key?(:'voidedDateTime') self.voided_date_time = attributes[:'voidedDateTime'] end if attributes.has_key?(:'voidedReason') self.voided_reason = attributes[:'voidedReason'] end if attributes.has_key?(:'workflow') self.workflow = attributes[:'workflow'] end end
swagger_types()
click to toggle source
Attribute type mapping.
# File lib/docusign_esign/models/envelope_template.rb, line 411 def self.swagger_types { :'access_control_list_base64' => :'String', :'allow_comments' => :'String', :'allow_markup' => :'String', :'allow_reassign' => :'String', :'allow_view_history' => :'String', :'any_signer' => :'String', :'asynchronous' => :'String', :'attachments_uri' => :'String', :'authoritative_copy' => :'String', :'authoritative_copy_default' => :'String', :'auto_match' => :'String', :'auto_match_specified_by_user' => :'String', :'auto_navigation' => :'String', :'brand_id' => :'String', :'brand_lock' => :'String', :'certificate_uri' => :'String', :'completed_date_time' => :'String', :'copy_recipient_data' => :'String', :'created' => :'String', :'created_date_time' => :'String', :'custom_fields' => :'CustomFields', :'custom_fields_uri' => :'String', :'declined_date_time' => :'String', :'deleted_date_time' => :'String', :'delivered_date_time' => :'String', :'description' => :'String', :'disable_responsive_document' => :'String', :'document_base64' => :'String', :'documents' => :'Array<Document>', :'documents_combined_uri' => :'String', :'documents_uri' => :'String', :'email_blurb' => :'String', :'email_settings' => :'EmailSettings', :'email_subject' => :'String', :'enable_wet_sign' => :'String', :'enforce_signer_visibility' => :'String', :'envelope_attachments' => :'Array<Attachment>', :'envelope_custom_metadata' => :'EnvelopeCustomMetadata', :'envelope_documents' => :'Array<EnvelopeDocument>', :'envelope_id' => :'String', :'envelope_id_stamping' => :'String', :'envelope_location' => :'String', :'envelope_metadata' => :'EnvelopeMetadata', :'envelope_uri' => :'String', :'expire_after' => :'String', :'expire_date_time' => :'String', :'expire_enabled' => :'String', :'external_envelope_id' => :'String', :'favorited_by_me' => :'String', :'folder_id' => :'String', :'folder_ids' => :'Array<String>', :'folder_name' => :'String', :'folders' => :'Array<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' => :'String', :'last_modified_by' => :'UserInfo', :'last_modified_date_time' => :'String', :'last_used' => :'String', :'location' => :'String', :'lock_information' => :'LockInformation', :'message_lock' => :'String', :'name' => :'String', :'new_password' => :'String', :'notification' => :'Notification', :'notification_uri' => :'String', :'owner' => :'UserInfo', :'page_count' => :'String', :'password' => :'String', :'password_protected' => :'String', :'power_form' => :'PowerForm', :'power_forms' => :'Array<PowerForm>', :'purge_completed_date' => :'String', :'purge_request_date' => :'String', :'purge_state' => :'String', :'recipients' => :'Recipients', :'recipients_lock' => :'String', :'recipients_uri' => :'String', :'sender' => :'UserInfo', :'sent_date_time' => :'String', :'shared' => :'String', :'signer_can_sign_on_mobile' => :'String', :'signing_location' => :'String', :'status' => :'String', :'status_changed_date_time' => :'String', :'status_date_time' => :'String', :'template_id' => :'String', :'templates_uri' => :'String', :'transaction_id' => :'String', :'uri' => :'String', :'use_disclosure' => :'String', :'voided_date_time' => :'String', :'voided_reason' => :'String', :'workflow' => :'Workflow' } end
Public Instance Methods
==(o)
click to toggle source
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/docusign_esign/models/envelope_template.rb, line 952 def ==(o) return true if self.equal?(o) self.class == o.class && access_control_list_base64 == o.access_control_list_base64 && allow_comments == o.allow_comments && allow_markup == o.allow_markup && allow_reassign == o.allow_reassign && allow_view_history == o.allow_view_history && any_signer == o.any_signer && asynchronous == o.asynchronous && attachments_uri == o.attachments_uri && authoritative_copy == o.authoritative_copy && authoritative_copy_default == o.authoritative_copy_default && auto_match == o.auto_match && auto_match_specified_by_user == o.auto_match_specified_by_user && auto_navigation == o.auto_navigation && brand_id == o.brand_id && brand_lock == o.brand_lock && certificate_uri == o.certificate_uri && completed_date_time == o.completed_date_time && copy_recipient_data == o.copy_recipient_data && created == o.created && created_date_time == o.created_date_time && custom_fields == o.custom_fields && custom_fields_uri == o.custom_fields_uri && declined_date_time == o.declined_date_time && deleted_date_time == o.deleted_date_time && delivered_date_time == o.delivered_date_time && description == o.description && disable_responsive_document == o.disable_responsive_document && document_base64 == o.document_base64 && documents == o.documents && documents_combined_uri == o.documents_combined_uri && documents_uri == o.documents_uri && email_blurb == o.email_blurb && email_settings == o.email_settings && email_subject == o.email_subject && enable_wet_sign == o.enable_wet_sign && enforce_signer_visibility == o.enforce_signer_visibility && envelope_attachments == o.envelope_attachments && envelope_custom_metadata == o.envelope_custom_metadata && envelope_documents == o.envelope_documents && envelope_id == o.envelope_id && envelope_id_stamping == o.envelope_id_stamping && envelope_location == o.envelope_location && envelope_metadata == o.envelope_metadata && envelope_uri == o.envelope_uri && expire_after == o.expire_after && expire_date_time == o.expire_date_time && expire_enabled == o.expire_enabled && external_envelope_id == o.external_envelope_id && favorited_by_me == o.favorited_by_me && folder_id == o.folder_id && folder_ids == o.folder_ids && folder_name == o.folder_name && folders == o.folders && has_comments == o.has_comments && has_form_data_changed == o.has_form_data_changed && has_wav_file == o.has_wav_file && holder == o.holder && initial_sent_date_time == o.initial_sent_date_time && is21_cfr_part11 == o.is21_cfr_part11 && is_dynamic_envelope == o.is_dynamic_envelope && is_signature_provider_envelope == o.is_signature_provider_envelope && last_modified == o.last_modified && last_modified_by == o.last_modified_by && last_modified_date_time == o.last_modified_date_time && last_used == o.last_used && location == o.location && lock_information == o.lock_information && message_lock == o.message_lock && name == o.name && new_password == o.new_password && notification == o.notification && notification_uri == o.notification_uri && owner == o.owner && page_count == o.page_count && password == o.password && password_protected == o.password_protected && power_form == o.power_form && power_forms == o.power_forms && purge_completed_date == o.purge_completed_date && purge_request_date == o.purge_request_date && purge_state == o.purge_state && recipients == o.recipients && recipients_lock == o.recipients_lock && recipients_uri == o.recipients_uri && sender == o.sender && sent_date_time == o.sent_date_time && shared == o.shared && signer_can_sign_on_mobile == o.signer_can_sign_on_mobile && signing_location == o.signing_location && status == o.status && status_changed_date_time == o.status_changed_date_time && status_date_time == o.status_date_time && template_id == o.template_id && templates_uri == o.templates_uri && transaction_id == o.transaction_id && uri == o.uri && use_disclosure == o.use_disclosure && voided_date_time == o.voided_date_time && voided_reason == o.voided_reason && workflow == o.workflow end
_deserialize(type, value)
click to toggle source
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docusign_esign/models/envelope_template.rb, line 1093 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = DocuSign_eSign.const_get(type).new temp_model.build_from_hash(value) end end
_to_hash(value)
click to toggle source
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/docusign_esign/models/envelope_template.rb, line 1159 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
build_from_hash(attributes)
click to toggle source
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docusign_esign/models/envelope_template.rb, line 1072 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
eql?(o)
click to toggle source
@see the ‘==` method @param [Object] Object to be compared
# File lib/docusign_esign/models/envelope_template.rb, line 1059 def eql?(o) self == o end
hash()
click to toggle source
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docusign_esign/models/envelope_template.rb, line 1065 def hash [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_match, auto_match_specified_by_user, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, disable_responsive_document, document_base64, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_custom_metadata, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, favorited_by_me, folder_id, folder_ids, folder_name, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified, last_modified_by, last_modified_date_time, last_used, location, lock_information, message_lock, name, new_password, notification, notification_uri, owner, page_count, password, password_protected, power_form, power_forms, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason, workflow].hash end
list_invalid_properties()
click to toggle source
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docusign_esign/models/envelope_template.rb, line 939 def list_invalid_properties invalid_properties = Array.new invalid_properties end
to_body()
click to toggle source
to_hash()
click to toggle source
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docusign_esign/models/envelope_template.rb, line 1145 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
to_s()
click to toggle source
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docusign_esign/models/envelope_template.rb, line 1133 def to_s to_hash.to_s end
valid?()
click to toggle source
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docusign_esign/models/envelope_template.rb, line 946 def valid? true end