docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/email_address.rb

@@ -12,82 +12,104 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A tab that displays the recipient's email as entered in the recipient information. 
   class EmailAddress
     # 
     attr_accessor :anchor_allow_white_space_in_characters
 
+    # Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
     attr_accessor :anchor_allow_white_space_in_characters_metadata
 
     # When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.
     attr_accessor :anchor_case_sensitive
 
+    # Metadata that indicates whether the `anchorCaseSensitive` property is editable.
     attr_accessor :anchor_case_sensitive_metadata
 
     # Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.
     attr_accessor :anchor_horizontal_alignment
 
+    # Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
     attr_accessor :anchor_horizontal_alignment_metadata
 
     # When set to **true**, this tab is ignored if anchorString is not found in the document.
     attr_accessor :anchor_ignore_if_not_present
 
+    # Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
     attr_accessor :anchor_ignore_if_not_present_metadata
 
     # When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.
     attr_accessor :anchor_match_whole_word
 
+    # Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
     attr_accessor :anchor_match_whole_word_metadata
 
     # Anchor text information for a radio button.
     attr_accessor :anchor_string
 
+    # Metadata that indicates whether the `anchorString` property is editable.
     attr_accessor :anchor_string_metadata
 
     # 
     attr_accessor :anchor_tab_processor_version
 
+    # Reserved for DocuSign.
     attr_accessor :anchor_tab_processor_version_metadata
 
     # Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
     attr_accessor :anchor_units
 
+    # Metadata that indicates whether the `anchorUnits` property is editable.
     attr_accessor :anchor_units_metadata
 
     # Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
     attr_accessor :anchor_x_offset
 
+    # Metadata that indicates whether the `anchorXOffset` property is editable.
     attr_accessor :anchor_x_offset_metadata
 
     # Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
     attr_accessor :anchor_y_offset
 
+    # Metadata that indicates whether the `anchorYOffset` property is editable.
     attr_accessor :anchor_y_offset_metadata
 
     # When set to **true**, the information in the tab is bold.
     attr_accessor :bold
 
+    # Metadata that indicates whether the `bold` property is editable.
     attr_accessor :bold_metadata
 
+    # 
+    attr_accessor :caption
+
+    attr_accessor :caption_metadata
+
     # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
     attr_accessor :conditional_parent_label
 
+    # Metadata that indicates whether the `conditionalParentLabel` property is editable.
     attr_accessor :conditional_parent_label_metadata
 
     # For conditional fields, this is the value of the parent tab that controls the tab's visibility.  If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. 
     attr_accessor :conditional_parent_value
 
+    # Metadata that indicates whether the `conditionalParentValue` property is editable.
     attr_accessor :conditional_parent_value_metadata
 
     # The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
     attr_accessor :custom_tab_id
 
+    # Metadata that indicates whether the `customTabId` property is editable.
     attr_accessor :custom_tab_id_metadata
 
     # Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
     attr_accessor :document_id
 
+    # Metadata that indicates whether the `documentId` property is editable.
     attr_accessor :document_id_metadata
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
@@ -96,42 +118,52 @@ module DocuSign_eSign
     # The font color used for the information in the tab.  Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
     attr_accessor :font_color
 
+    # Metadata that indicates whether the `fontColor` property is editable.
     attr_accessor :font_color_metadata
 
+    # Metadata that indicates whether the `font` property is editable.
     attr_accessor :font_metadata
 
     # The font size used for the information in the tab.  Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
     attr_accessor :font_size
 
+    # Metadata that indicates whether the `fontSize` property is editable.
     attr_accessor :font_size_metadata
 
     # 
     attr_accessor :form_order
 
+    # Metadata that indicates whether the `formOrder` property is editable.
     attr_accessor :form_order_metadata
 
     # 
     attr_accessor :form_page_label
 
+    # Metadata that indicates whether the `formPageLabel` property is editable.
     attr_accessor :form_page_label_metadata
 
     # 
     attr_accessor :form_page_number
 
+    # Metadata that indicates whether the `fromPageNumber` property is editable.
     attr_accessor :form_page_number_metadata
 
     # Height of the tab in pixels.
     attr_accessor :height
 
+    # Metadata that indicates whether the `height` property is editable.
     attr_accessor :height_metadata
 
     # When set to **true**, the information in the tab is italic.
     attr_accessor :italic
 
+    # Metadata that indicates whether the `italic` property is editable.
     attr_accessor :italic_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :locale_policy
 
+    # Contains the information necessary to map the tab to a field in SalesForce.
     attr_accessor :merge_field
 
     # 
@@ -140,11 +172,13 @@ module DocuSign_eSign
     # 
     attr_accessor :name
 
+    # Metadata that indicates whether the `name` property is editable. This property is read-only.
     attr_accessor :name_metadata
 
     # Specifies the page number on which the tab is located.
     attr_accessor :page_number
 
+    # Metadata that indicates whether the `pageNumber` property is editable.
     attr_accessor :page_number_metadata
 
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -153,10 +187,13 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_id_guid
 
+    # Metadata that indicates whether the `recipientIdGuid` property is editable.
     attr_accessor :recipient_id_guid_metadata
 
+    # Metadata that indicates whether the `recipientId` property is editable.
     attr_accessor :recipient_id_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :smart_contract_information
 
     # 
@@ -165,71 +202,85 @@ module DocuSign_eSign
     # 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.
     attr_accessor :status
 
+    # Metadata that indicates whether the `status` property is editable.
     attr_accessor :status_metadata
 
     # 
     attr_accessor :tab_group_labels
 
+    # Metadata that indicates whether the `tabGroupLabels` property is editable.
     attr_accessor :tab_group_labels_metadata
 
     # The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].     
     attr_accessor :tab_id
 
+    # Metadata that indicates whether the `tabId` property is editable.
     attr_accessor :tab_id_metadata
 
     # The label string associated with the tab.
     attr_accessor :tab_label
 
+    # Metadata that indicates whether the `tabLabel` property is editable.
     attr_accessor :tab_label_metadata
 
     # 
     attr_accessor :tab_order
 
+    # Metadata that indicates whether the `tabOrder` property is editable.
     attr_accessor :tab_order_metadata
 
     # 
     attr_accessor :tab_type
 
+    # Metadata that indicates whether the `tabType` property is editable.
     attr_accessor :tab_type_metadata
 
     # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 
     attr_accessor :template_locked
 
+    # Metadata that indicates whether the `templateLocked` property is editable.
     attr_accessor :template_locked_metadata
 
     # When set to **true**, the sender may not remove the recipient. Used only when working with template recipients.
     attr_accessor :template_required
 
+    # Metadata that indicates whether the `templateRequired` property is editable.
     attr_accessor :template_required_metadata
 
     # 
     attr_accessor :tooltip
 
+    # Metadata that indicates whether the `toolTip` property is editable.
     attr_accessor :tool_tip_metadata
 
     # When set to **true**, the information in the tab is underlined.
     attr_accessor :underline
 
+    # Metadata that indicates whether the `underline` property is editable.
     attr_accessor :underline_metadata
 
     # Specifies the value of the tab. 
     attr_accessor :value
 
+    # Metadata that indicates whether the `value` property is editable.
     attr_accessor :value_metadata
 
     # Width of the tab in pixels.
     attr_accessor :width
 
+    # Metadata that indicates whether the `width` property is editable.
     attr_accessor :width_metadata
 
     # This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
     attr_accessor :x_position
 
+    # Metadata that indicates whether the `xPosition` property is editable.
     attr_accessor :x_position_metadata
 
     # This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
     attr_accessor :y_position
 
+    # Metadata that indicates whether the `yPosition` property is editable.
     attr_accessor :y_position_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -257,6 +308,8 @@ module DocuSign_eSign
         :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
         :'bold' => :'bold',
         :'bold_metadata' => :'boldMetadata',
+        :'caption' => :'caption',
+        :'caption_metadata' => :'captionMetadata',
         :'conditional_parent_label' => :'conditionalParentLabel',
         :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
         :'conditional_parent_value' => :'conditionalParentValue',
@@ -351,6 +404,8 @@ module DocuSign_eSign
         :'anchor_y_offset_metadata' => :'PropertyMetadata',
         :'bold' => :'String',
         :'bold_metadata' => :'PropertyMetadata',
+        :'caption' => :'String',
+        :'caption_metadata' => :'PropertyMetadata',
         :'conditional_parent_label' => :'String',
         :'conditional_parent_label_metadata' => :'PropertyMetadata',
         :'conditional_parent_value' => :'String',
@@ -516,6 +571,14 @@ module DocuSign_eSign
         self.bold_metadata = attributes[:'boldMetadata']
       end
 
+      if attributes.has_key?(:'caption')
+        self.caption = attributes[:'caption']
+      end
+
+      if attributes.has_key?(:'captionMetadata')
+        self.caption_metadata = attributes[:'captionMetadata']
+      end
+
       if attributes.has_key?(:'conditionalParentLabel')
         self.conditional_parent_label = attributes[:'conditionalParentLabel']
       end
@@ -823,6 +886,8 @@ module DocuSign_eSign
           anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
           bold == o.bold &&
           bold_metadata == o.bold_metadata &&
+          caption == o.caption &&
+          caption_metadata == o.caption_metadata &&
           conditional_parent_label == o.conditional_parent_label &&
           conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
           conditional_parent_value == o.conditional_parent_value &&
@@ -900,7 +965,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
+      [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, merge_field, merge_field_xml, name, name_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope.rb

@@ -64,6 +64,7 @@ module DocuSign_eSign
     # Indicates the date and time the item was created.
     attr_accessor :created_date_time
 
+    # An optional array of strings that enables 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.
     attr_accessor :custom_fields
 
     # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -93,6 +94,7 @@ module DocuSign_eSign
     # This is the same as the email body. If specified it is included in email body for all envelope recipients.
     attr_accessor :email_blurb
 
+    # A complex type that contains email settings.
     attr_accessor :email_settings
 
     # 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.
@@ -107,6 +109,9 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
+    attr_accessor :envelope_custom_metadata
+
     # 
     attr_accessor :envelope_documents
 
@@ -119,6 +124,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_location
 
+    # 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.
     attr_accessor :envelope_metadata
 
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
@@ -169,16 +175,19 @@ module DocuSign_eSign
     # 
     attr_accessor :location
 
+    # Provides lock information about an envelope that a user has locked.
     attr_accessor :lock_information
 
     # 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.
     attr_accessor :message_lock
 
+    # 
     attr_accessor :notification
 
     # Contains a URI for an endpoint that you can use to retrieve the notifications.
     attr_accessor :notification_uri
 
+    # Information about any PowerForms that are included in the envelope.
     attr_accessor :power_form
 
     # 
@@ -190,6 +199,7 @@ module DocuSign_eSign
     # 
     attr_accessor :purge_state
 
+    # An array of recipient objects that provides details about the recipients of the envelope.
     attr_accessor :recipients
 
     # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -198,6 +208,7 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the recipients.
     attr_accessor :recipients_uri
 
+    # Information about the sender of the envelope.
     attr_accessor :sender
 
     # The date and time the envelope was sent.
@@ -233,6 +244,7 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    # 
     attr_accessor :workflow
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -270,6 +282,7 @@ module DocuSign_eSign
         :'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',
@@ -353,6 +366,7 @@ module DocuSign_eSign
         :'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',
@@ -539,6 +553,10 @@ module DocuSign_eSign
         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
@@ -774,6 +792,7 @@ module DocuSign_eSign
           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 &&
@@ -830,7 +849,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     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_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, envelope_metadata, envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, 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_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].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_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, document_base64, 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, 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_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/envelope_attachment.rb

@@ -22,6 +22,7 @@ module DocuSign_eSign
     # 
     attr_accessor :attachment_type
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/envelope_custom_metadata.rb

@@ -0,0 +1,186 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class EnvelopeCustomMetadata
+    # 
+    attr_accessor :envelope_custom_metadata_details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'envelope_custom_metadata_details' => :'envelopeCustomMetadataDetails'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'envelope_custom_metadata_details' => :'Array<NameValue>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'envelopeCustomMetadataDetails')
+        if (value = attributes[:'envelopeCustomMetadataDetails']).is_a?(Array)
+          self.envelope_custom_metadata_details = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          envelope_custom_metadata_details == o.envelope_custom_metadata_details
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [envelope_custom_metadata_details].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+end