docusign_esign 3.17.0 → 3.19.0

data/lib/docusign_esign/models/email_address.rb

@@ -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 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
 
     # 
@@ -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/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,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
     attr_accessor :envelope_custom_metadata
 
     # 
@@ -121,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.
@@ -171,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
 
     # 
@@ -192,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.
@@ -200,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.
@@ -235,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.

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_definition.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Envelope object definition.
   class EnvelopeDefinition
     # 
     attr_accessor :access_control_list_base64
@@ -76,6 +77,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.   **Note:** Any custom fields you set with this API method will _replace_ custom fields you have defined with [Envelope Custom Fields in Admin](https://support.docusign.com/en/guides/ndse-admin-guide-document-labels), whether the **Show field to envelope creators** or **Make fields required for envelopes** options are checked or not. 
     attr_accessor :custom_fields
 
     # Contains a URI for an endpoint that you can use to retrieve the custom fields.
@@ -108,6 +110,7 @@ module DocuSign_eSign
     # Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters
     attr_accessor :email_blurb
 
+    # This optional complex element enables the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope, as well as the BCC email addresses to which an envelope is sent. When the `emailSettings` information is used for an envelope, it only applies to that envelope.  **Important Note:** The `emailSettings` information is not returned in the GET method for envelope status. Use GET /email_settings to return information about the emailSettings.
     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.
@@ -122,6 +125,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
     attr_accessor :envelope_custom_metadata
 
     # 
@@ -136,11 +140,13 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_location
 
+    # Metadata about the features that are enabled for the envelope.
     attr_accessor :envelope_metadata
 
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
     attr_accessor :envelope_uri
 
+    # This optional object is used to register a webhook that will receive status changes for this envelope.
     attr_accessor :event_notification
 
     # 
@@ -191,11 +197,13 @@ 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
 
+    # An optional complex element that specifies the notification options for the envelope.
     attr_accessor :notification
 
     # Contains a URI for an endpoint that you can use to retrieve the notifications.
@@ -204,6 +212,7 @@ module DocuSign_eSign
     # 
     attr_accessor :password
 
+    # Information about any PowerForms that are included in the envelope.
     attr_accessor :power_form
 
     # 
@@ -215,6 +224,7 @@ module DocuSign_eSign
     # Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue. 
     attr_accessor :purge_state
 
+    # Specifies the envelope recipients.
     attr_accessor :recipients
 
     # When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
@@ -223,8 +233,10 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the recipients.
     attr_accessor :recipients_uri
 
+    # 
     attr_accessor :recipient_view_request
 
+    # Information about the sender of the envelope.
     attr_accessor :sender
 
     # The date and time the envelope was sent.
@@ -266,6 +278,7 @@ module DocuSign_eSign
     # The reason the envelope or template was voided.
     attr_accessor :voided_reason
 
+    # Describes the workflow for this envelope.
     attr_accessor :workflow
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_document.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains details about the envelope document.
   class EnvelopeDocument
     # 
     attr_accessor :added_recipient_ids
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
     attr_accessor :authoritative_copy
 
+    # Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents.
     attr_accessor :authoritative_copy_metadata
 
     # 
@@ -33,6 +35,7 @@ module DocuSign_eSign
     # 
     attr_accessor :display
 
+    # Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents.
     attr_accessor :display_metadata
 
     # 
@@ -47,16 +50,19 @@ module DocuSign_eSign
     # 
     attr_accessor :document_id_guid
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
     attr_accessor :include_in_download
 
+    # Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents.
     attr_accessor :include_in_download_metadata
 
     # 
     attr_accessor :name
 
+    # Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents.
     attr_accessor :name_metadata
 
     # 
@@ -68,6 +74,7 @@ module DocuSign_eSign
     # 
     attr_accessor :signer_must_acknowledge
 
+    # Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents.
     attr_accessor :signer_must_acknowledge_metadata
 
     # 

data/lib/docusign_esign/models/envelope_event.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # For which envelope events should your webhook be called?
   class EnvelopeEvent
     # he envelope status, this can be Sent, Delivered, Completed, Declined, or Voided.
     attr_accessor :envelope_event_status_code

data/lib/docusign_esign/models/envelope_form_data.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes the form data of the envelope.
   class EnvelopeFormData
     # 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.
     attr_accessor :email_subject
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :form_data
 
+    # An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). 
     attr_accessor :prefill_form_data
 
     #