docusign_esign 3.18.0 → 3.19.0

data/lib/docusign_esign/models/envelope_id.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 envelope ID. Recipients cannot enter or change the information in this tab. 
   class EnvelopeId
     # 
     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,66 +202,79 @@ 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
 
     # 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_ids_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Lists of envelope and transaction IDs to use in the results.  If you use this request body with Envelopes: listStatus, you must set one or both of the following query parameters to the special value `request_body`:  - `envelope_ids=request_body` - `transaction_ids=request_body` 
   class EnvelopeIdsRequest
     # 
     attr_accessor :envelope_ids

data/lib/docusign_esign/models/envelope_notification_request.rb

@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A complex element that specifies the notification settings for the envelope.
   class EnvelopeNotificationRequest
+    # A complex element that specifies the expiration settings for the envelope.
     attr_accessor :expirations
 
+    # A complex element that specifies reminder settings for the envelope.
     attr_accessor :reminders
 
     # 

data/lib/docusign_esign/models/envelope_purge_configuration.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). 
   class EnvelopePurgeConfiguration
     # 
     attr_accessor :purge_envelopes

data/lib/docusign_esign/models/envelope_summary.rb

@@ -12,12 +12,15 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  #  This object describes an envelope.
   class EnvelopeSummary
+    # An object that describes the status of the bulk send envelopes.
     attr_accessor :bulk_envelope_status
 
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # 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_template.rb

@@ -73,6 +73,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.
@@ -108,6 +109,7 @@ module DocuSign_eSign
     # 
     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.
@@ -122,6 +124,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_attachments
 
+    # 
     attr_accessor :envelope_custom_metadata
 
     # 
@@ -136,6 +139,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.
@@ -195,6 +199,7 @@ module DocuSign_eSign
     # 
     attr_accessor :last_modified
 
+    # 
     attr_accessor :last_modified_by
 
     # The date and time the item was last modified.
@@ -206,6 +211,7 @@ 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.
@@ -217,11 +223,13 @@ module DocuSign_eSign
     # 
     attr_accessor :new_password
 
+    # 
     attr_accessor :notification
 
     # Contains a URI for an endpoint that you can use to retrieve the notifications.
     attr_accessor :notification_uri
 
+    # 
     attr_accessor :owner
 
     # 
@@ -233,6 +241,7 @@ module DocuSign_eSign
     # 
     attr_accessor :password_protected
 
+    # Information about any PowerForms that are included in the envelope.
     attr_accessor :power_form
 
     # 
@@ -247,6 +256,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.
@@ -255,6 +265,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.
@@ -299,6 +310,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_template_results.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about templates.
   class EnvelopeTemplateResults
     # The last position in the result set. 
     attr_accessor :end_position

data/lib/docusign_esign/models/envelope_transaction_status.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 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.

data/lib/docusign_esign/models/envelope_transfer_rule.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 an envelope transfer rule.
   class EnvelopeTransferRule
     # 
     attr_accessor :carbon_copy_original_owner
@@ -25,17 +26,22 @@ module DocuSign_eSign
     # 
     attr_accessor :event_type
 
+    # Information about the group that triggers the transfer.
     attr_accessor :from_group
 
+    # Information about the user who triggers the transfer.
     attr_accessor :from_user
 
     # 
     attr_accessor :modified_date
 
+    # Information about the user who last modified the envelope transfer rule.
     attr_accessor :modified_user
 
+    # Information about the destination folder to which the envelope is transferred.
     attr_accessor :to_folder
 
+    # Information about the user to which the envelope is transferred.
     attr_accessor :to_user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_transfer_rule_request.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 transfer rule that you want to create.
   class EnvelopeTransferRuleRequest
     # 
     attr_accessor :carbon_copy_original_owner
@@ -34,10 +35,13 @@ module DocuSign_eSign
     # 
     attr_accessor :modified_date
 
+    # Information about the user who last modified the envelope transfer rule.
     attr_accessor :modified_user
 
+    # Information about the destination folder to which the envelope is transferred.
     attr_accessor :to_folder
 
+    # Information about the user to which the envelope is transferred.
     attr_accessor :to_user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/envelope_update_summary.rb

@@ -13,16 +13,19 @@ require 'date'
 
 module DocuSign_eSign
   class EnvelopeUpdateSummary
+    # An object that describes the status of the bulk send envelopes.
     attr_accessor :bulk_envelope_status
 
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
     attr_accessor :list_custom_field_update_results
 
+    # Provides lock information about an envelope that a user has locked.
     attr_accessor :lock_information
 
     # 
@@ -31,6 +34,7 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_update_results
 
+    # 
     attr_accessor :tab_update_results
 
     # 

data/lib/docusign_esign/models/envelopes_information.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Result set for the Envelopes: listStatusChanges method
   class EnvelopesInformation
     # 
     attr_accessor :continuation_token

data/lib/docusign_esign/models/event_notification.rb

@@ -20,6 +20,7 @@ module DocuSign_eSign
     # A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.   To receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both.
     attr_accessor :envelope_events
 
+    # Allows you to specify the format of the information the Connect webhooks returns. For more information, see [Connect webhooks with JSON notifications](https://www.docusign.com/blog/developers/connect-webhooks-json-notifications)
     attr_accessor :event_data
 
     # 

data/lib/docusign_esign/models/event_result.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about the result of an event.
   class EventResult
     # 
     attr_accessor :event_timestamp

data/lib/docusign_esign/models/external_document_sources.rb

@@ -12,30 +12,36 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A complex object specifying the external document sources.
   class ExternalDocumentSources
     # 
     attr_accessor :boxnet_enabled
 
+    # Metadata indicating whether the `boxnetEnabled` property is editable.
     attr_accessor :boxnet_metadata
 
     # 
     attr_accessor :dropbox_enabled
 
+    # Metadata indicating whether the `dropboxEnabled` property is editable.
     attr_accessor :dropbox_metadata
 
     # 
     attr_accessor :google_drive_enabled
 
+    # Metadata indicating whether the `googleDriveEnabled` property is editable.
     attr_accessor :google_drive_metadata
 
     # 
     attr_accessor :one_drive_enabled
 
+    # Metadata indicating whether the `oneDriveEnabled` property is editable.
     attr_accessor :one_drive_metadata
 
     # 
     attr_accessor :salesforce_enabled
 
+    # Metadata indicating whether the `salesforceEnabled` property is editable.
     attr_accessor :salesforce_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/external_file.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains information about a file or folder in cloud storage.
   class ExternalFile
     # 
     attr_accessor :date

data/lib/docusign_esign/models/external_folder.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # The last position in the result set. 
     attr_accessor :end_position
 
+    # 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/favorite_templates_content_item.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class FavoriteTemplatesContentItem
+    # 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/favorite_templates_info.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class FavoriteTemplatesInfo
+    # 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/feature_set.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.
   class FeatureSet
     # A complex type that contains alternate currency values that are configured for this plan feature set.
     attr_accessor :currency_feature_set_prices

data/lib/docusign_esign/models/filter.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Use this object to create a filtered view of the items in a folder.
   class Filter
     # Access token information.
     attr_accessor :action_required