docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/poly_line_overlay.rb

@@ -12,106 +12,134 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.
   class PolyLineOverlay
     # 
     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
 
+    # 
+    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
 
     # 
     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
 
+    # Contains details about the style used for the strike through graphic.
     attr_accessor :graphics_context
 
     # 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 signer cannot change the data of the custom tab.
     attr_accessor :locked
 
+    # Metadata that indicates whether the `locked` property is editable.
     attr_accessor :locked_metadata
 
+    # Contains the information necessary to map the tab to a field in SalesForce.
     attr_accessor :merge_field
 
     # 
@@ -120,11 +148,13 @@ module DocuSign_eSign
     # 
     attr_accessor :overlay_type
 
+    # Metadata that indicates whether the `overlayType` property is editable. 
     attr_accessor :overlay_type_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
 
     # 
@@ -136,15 +166,19 @@ 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
 
     # When set to **true**, this custom tab is shared.
     attr_accessor :shared
 
+    # Metadata that indicates whether the `shared` property is editable.
     attr_accessor :shared_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :smart_contract_information
 
     # 
@@ -153,16 +187,19 @@ 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.
@@ -171,41 +208,49 @@ module DocuSign_eSign
     # 
     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
 
     # 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.
@@ -231,6 +276,8 @@ module DocuSign_eSign
         :'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
         :'anchor_y_offset' => :'anchorYOffset',
         :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
+        :'caption' => :'caption',
+        :'caption_metadata' => :'captionMetadata',
         :'conditional_parent_label' => :'conditionalParentLabel',
         :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
         :'conditional_parent_value' => :'conditionalParentValue',
@@ -315,6 +362,8 @@ module DocuSign_eSign
         :'anchor_x_offset_metadata' => :'PropertyMetadata',
         :'anchor_y_offset' => :'String',
         :'anchor_y_offset_metadata' => :'PropertyMetadata',
+        :'caption' => :'String',
+        :'caption_metadata' => :'PropertyMetadata',
         :'conditional_parent_label' => :'String',
         :'conditional_parent_label_metadata' => :'PropertyMetadata',
         :'conditional_parent_value' => :'String',
@@ -464,6 +513,14 @@ module DocuSign_eSign
         self.anchor_y_offset_metadata = attributes[:'anchorYOffsetMetadata']
       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
@@ -739,6 +796,8 @@ module DocuSign_eSign
           anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
           anchor_y_offset == o.anchor_y_offset &&
           anchor_y_offset_metadata == o.anchor_y_offset_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 &&
@@ -808,7 +867,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, 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, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, graphics_context, height, height_metadata, locked, locked_metadata, merge_field, merge_field_xml, overlay_type, overlay_type_metadata, page_number, page_number_metadata, poly_lines, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_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, 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, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, graphics_context, height, height_metadata, locked, locked_metadata, merge_field, merge_field_xml, overlay_type, overlay_type_metadata, page_number, page_number_metadata, poly_lines, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, shared, shared_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_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/power_form.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains details about a PowerForm.
   class PowerForm
     # 
     attr_accessor :created_by
@@ -28,6 +29,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelopes
 
+    # 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/power_form_recipient.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # **Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.
   class PowerFormRecipient
     # If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.   Maximum Length: 50 characters and it must conform to the account's access code format setting.  If blank, but the signer `accessCode` property is set in the envelope, then that value is used.  If blank and the signer `accessCode` property is not set, then the access code is not required.
     attr_accessor :access_code

data/lib/docusign_esign/models/power_form_senders_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object includes information about the users who have sent PowerForms.
   class PowerFormSendersResponse
     # The last position in the result set. 
     attr_accessor :end_position

data/lib/docusign_esign/models/power_forms_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A list of PowerForms.
   class PowerFormsResponse
     # The last position in the result set. 
     attr_accessor :end_position

data/lib/docusign_esign/models/prefill_tabs.rb

@@ -12,10 +12,20 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields.  Only the following tab types can be prefill tabs:  - text - check boxes - radio buttons    [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application.   [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs.  [app]:      https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]:  https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields
   class PrefillTabs
     # Specifies a tag on the document in a location where the recipient can select an option.
     attr_accessor :checkbox_tabs
 
+    # Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained.   If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.
+    attr_accessor :date_tabs
+
+    # Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :email_tabs
+
+    # Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. 
+    attr_accessor :number_tabs
+
     # Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.
     attr_accessor :radio_group_tabs
 
@@ -25,21 +35,32 @@ module DocuSign_eSign
     # 
     attr_accessor :sender_name_tabs
 
+    # Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :ssn_tabs
+
     # 
     attr_accessor :tab_groups
 
     # Specifies a that that is an adaptable field that allows the recipient to enter different text information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
     attr_accessor :text_tabs
 
+    # Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.
+    attr_accessor :zip_tabs
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'checkbox_tabs' => :'checkboxTabs',
+        :'date_tabs' => :'dateTabs',
+        :'email_tabs' => :'emailTabs',
+        :'number_tabs' => :'numberTabs',
         :'radio_group_tabs' => :'radioGroupTabs',
         :'sender_company_tabs' => :'senderCompanyTabs',
         :'sender_name_tabs' => :'senderNameTabs',
+        :'ssn_tabs' => :'ssnTabs',
         :'tab_groups' => :'tabGroups',
-        :'text_tabs' => :'textTabs'
+        :'text_tabs' => :'textTabs',
+        :'zip_tabs' => :'zipTabs'
       }
     end
 
@@ -47,11 +68,16 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'checkbox_tabs' => :'Array<Checkbox>',
+        :'date_tabs' => :'Array<DocuSign_eSign::Date>',
+        :'email_tabs' => :'Array<Email>',
+        :'number_tabs' => :'Array<Number>',
         :'radio_group_tabs' => :'Array<RadioGroup>',
         :'sender_company_tabs' => :'Array<SenderCompany>',
         :'sender_name_tabs' => :'Array<SenderName>',
+        :'ssn_tabs' => :'Array<Ssn>',
         :'tab_groups' => :'Array<TabGroup>',
-        :'text_tabs' => :'Array<Text>'
+        :'text_tabs' => :'Array<Text>',
+        :'zip_tabs' => :'Array<Zip>'
       }
     end
 
@@ -69,6 +95,24 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'dateTabs')
+        if (value = attributes[:'dateTabs']).is_a?(Array)
+          self.date_tabs = value
+        end
+      end
+
+      if attributes.has_key?(:'emailTabs')
+        if (value = attributes[:'emailTabs']).is_a?(Array)
+          self.email_tabs = value
+        end
+      end
+
+      if attributes.has_key?(:'numberTabs')
+        if (value = attributes[:'numberTabs']).is_a?(Array)
+          self.number_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'radioGroupTabs')
         if (value = attributes[:'radioGroupTabs']).is_a?(Array)
           self.radio_group_tabs = value
@@ -87,6 +131,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'ssnTabs')
+        if (value = attributes[:'ssnTabs']).is_a?(Array)
+          self.ssn_tabs = value
+        end
+      end
+
       if attributes.has_key?(:'tabGroups')
         if (value = attributes[:'tabGroups']).is_a?(Array)
           self.tab_groups = value
@@ -98,6 +148,12 @@ module DocuSign_eSign
           self.text_tabs = value
         end
       end
+
+      if attributes.has_key?(:'zipTabs')
+        if (value = attributes[:'zipTabs']).is_a?(Array)
+          self.zip_tabs = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -119,11 +175,16 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           checkbox_tabs == o.checkbox_tabs &&
+          date_tabs == o.date_tabs &&
+          email_tabs == o.email_tabs &&
+          number_tabs == o.number_tabs &&
           radio_group_tabs == o.radio_group_tabs &&
           sender_company_tabs == o.sender_company_tabs &&
           sender_name_tabs == o.sender_name_tabs &&
+          ssn_tabs == o.ssn_tabs &&
           tab_groups == o.tab_groups &&
-          text_tabs == o.text_tabs
+          text_tabs == o.text_tabs &&
+          zip_tabs == o.zip_tabs
     end
 
     # @see the `==` method
@@ -135,7 +196,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [checkbox_tabs, radio_group_tabs, sender_company_tabs, sender_name_tabs, tab_groups, text_tabs].hash
+      [checkbox_tabs, date_tabs, email_tabs, number_tabs, radio_group_tabs, sender_company_tabs, sender_name_tabs, ssn_tabs, tab_groups, text_tabs, zip_tabs].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/property_metadata.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Metadata about a property.
   class PropertyMetadata
     # 
     attr_accessor :options