RubyGems - docusign_esign - Versions diffs - 3.18.0 → 3.19.0 - Mend

docusign_esign 3.18.0 → 3.19.0

Files changed (304) hide show

data/lib/docusign_esign/models/formula_tab.rb CHANGED Viewed

@@ -12,60 +12,72 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 module DocuSign_eSign
+  # The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result.  The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas.  If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments.  [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]:     https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
   class FormulaTab
     #
     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
     #
@@ -76,33 +88,40 @@ module DocuSign_eSign
     # When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.  When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.  This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
     attr_accessor :conceal_value_on_document
+    # Metadata that indicates whether the `concealValueOnDocument` property is editable.
     attr_accessor :conceal_value_on_document_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
     # When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.
     attr_accessor :disable_auto_size
+    # Metadata that indicates whether the `disableAutoSize` property is editable.
     attr_accessor :disable_auto_size_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.
@@ -111,67 +130,82 @@ 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
     # The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets.  Maximum Length: 2000 characters.  *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be:   [Line1]+[Line2]+[Tax]
     attr_accessor :formula
+    # Metadata indicating if the sender can edit the `formula` property.
     attr_accessor :formula_metadata
     # Height of the tab in pixels.
     attr_accessor :height
+    # Metadata that indicates whether the `height` property is editable.
     attr_accessor :height_metadata
     #
     attr_accessor :hidden
+    # Metadata that indicates whether the `hidden` property is editable.
     attr_accessor :hidden_metadata
     # When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number.
     attr_accessor :is_payment_amount
+    # Reserved for DocuSign.
     attr_accessor :is_payment_amount_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
     # 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
     # An optional value that describes the maximum length of the property when the property is a string.
     attr_accessor :max_length
+    # Metadata that indicates whether the `maxLength` property is editable.
     attr_accessor :max_length_metadata
+    # Contains the information necessary to map the tab to a field in SalesForce.
     attr_accessor :merge_field
     #
@@ -180,18 +214,22 @@ module DocuSign_eSign
     #
     attr_accessor :name
+    # Metadata that indicates whether the `name` property is editable. This property is read-only.
     attr_accessor :name_metadata
     # The initial value of the tab when it was sent to the recipient.
     attr_accessor :original_value
+    # Metadata that indicates whether the `originalValue` property is editable.
     attr_accessor :original_value_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
+    # This property indicates  that this formula tab  is a payment item.   See [Requesting Payments Along with Signatures][paymentguide]  in the DocuSign Support Center  to learn more about payments.   [paymentguide]:     https://support.docusign.com/en/guides/requesting-payments-along-with-signatures
     attr_accessor :payment_details
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -200,45 +238,55 @@ 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** and shared is true, information must be entered in this field to complete the envelope.
     attr_accessor :require_all
+    # Metadata that indicates whether the `requireAll` property is editable.
     attr_accessor :require_all_metadata
     # When set to **true**, the signer is required to fill out this tab
     attr_accessor :required
+    # Metadata that indicates whether the `required` property is editable.
     attr_accessor :required_metadata
     # Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.
     attr_accessor :require_initial_on_shared_change
+    # Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
     attr_accessor :require_initial_on_shared_change_metadata
     #
     attr_accessor :round_decimal_places
+    # Metadata that indicates whether the `roundDecimalPlaces` property is editable.
     attr_accessor :round_decimal_places_metadata
     # When set to **true**, the sender must populate the tab before an envelope can be sent using the template.   This value tab can only be changed by modifying (PUT) the template.   Tabs with a `senderRequired` value of true cannot be deleted from an envelope.
     attr_accessor :sender_required
+    # Metadata that indicates whether the `senderRequired` property is editable.
     attr_accessor :sender_required_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
     #
     attr_accessor :share_to_recipients
+    # Reserved for DocuSign.
     attr_accessor :share_to_recipients_metadata
+    # Reserved for DocuSign.
     attr_accessor :smart_contract_information
     #
@@ -247,81 +295,97 @@ 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
     # The message displayed if the custom tab fails input validation (either custom of embedded).
     attr_accessor :validation_message
+    # Metadata that indicates whether the `validationMessage` property is editable.
     attr_accessor :validation_message_metadata
     # A regular expression used to validate input for the tab.
     attr_accessor :validation_pattern
+    # Metadata that indicates whether the `validationPattern` property is editable.
     attr_accessor :validation_pattern_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.

data/lib/docusign_esign/models/full_name.rb CHANGED Viewed

@@ -12,60 +12,72 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 module DocuSign_eSign
+  # A tab that displays the recipient's full name.
   class FullName
     #
     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
     #
@@ -76,23 +88,28 @@ module DocuSign_eSign
     # 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.
@@ -101,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
     #
@@ -145,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.
@@ -158,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
     #
@@ -170,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.

data/lib/docusign_esign/models/group.rb CHANGED Viewed

@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 module DocuSign_eSign
+  # This object contains information about a group.
   class Group
     #
     attr_accessor :ds_group_id
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
     # The DocuSign group ID for the group.

data/lib/docusign_esign/models/id_check_configuration.rb CHANGED Viewed

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 module DocuSign_eSign
+  # A complex object specifying ID check configuration.
   class IdCheckConfiguration
     #
     attr_accessor :auth_steps

data/lib/docusign_esign/models/id_check_information_input.rb CHANGED Viewed

@@ -14,12 +14,16 @@ require 'date'
 module DocuSign_eSign
   # A complex element that contains input information related to a recipient ID check. It can include the following information.  addressInformationInput: Used to set recipient address information and consists of:  * addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.  dobInformationInput: Used to set recipient date of birth information and consists of:  * dateOfBirth: Specifies the recipient's date, month and year of birth. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.  ssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:  * ssn4: Specifies the last four digits of the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. * receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.  ssn9InformationInput: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:  * ssn9: Specifies the recipient's SSN. * displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.
   class IdCheckInformationInput
+    # An object that specifies recipient address information and how it is displayed.
     attr_accessor :address_information_input
+    # An object that specifies recipient date of birth information and how it is displayed.
     attr_accessor :dob_information_input
+    # An object that specifies the last four digits of the recipient's Social Security Number (SSN).
     attr_accessor :ssn4_information_input
+    # An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.
     attr_accessor :ssn9_information_input
     # Attribute mapping from ruby-style variable name to JSON key.