docusign_esign 3.18.0 → 3.19.0

data/lib/docusign_esign/models/recipient_update_response.rb

@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The recipient details that are returned after you update the recipient.
   class RecipientUpdateResponse
     # 
     attr_accessor :combined
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -24,6 +26,7 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_id_guid
 
+    # All of the tabs associated with the recipient.
     attr_accessor :tabs
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_view_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request body for the [EnvelopeViews: createRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createrecipient/) and [EnvelopeViews: createSharedRecipient](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsharedrecipient/) methods.
   class RecipientViewRequest
     # A unique identifier of the authentication event executed by the client application.
     attr_accessor :assertion_id
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # A sender created value that indicates the convention used to authenticate the signer. This information is included in the Certificate of Completion.
     attr_accessor :authentication_method
 
+    # 
     attr_accessor :client_ur_ls
 
     # A sender created value that shows the recipient is embedded (captive).   Maximum length: 100 characters.

data/lib/docusign_esign/models/recipients.rb

@@ -29,6 +29,7 @@ module DocuSign_eSign
     # A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
     attr_accessor :editors
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

data/lib/docusign_esign/models/recipients_update_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This is the response that the API returns after you update recipients.
   class RecipientsUpdateSummary
     # 
     attr_accessor :recipient_update_results

data/lib/docusign_esign/models/return_url_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request body for the [EnvelopeViews: createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) method.
   class ReturnUrlRequest
     # Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:   * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).
     attr_accessor :return_url

data/lib/docusign_esign/models/seal_sign.rb

@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.  Example:   ```json \"recipients\": {       \"seals\": [         {           \"recipientId\": \"1\",           \"routingOrder\" : 1,           \"recipientSignatureProviders\": [             {               \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"             }        ]      }    ]  },     .     .     . ``` For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals). 
   class SealSign
     # 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
 
+    # Not applicable.
     attr_accessor :access_code_metadata
 
     # This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
@@ -48,6 +50,7 @@ module DocuSign_eSign
     # Reserved: For DocuSign use only.
     attr_accessor :delivery_method
 
+    # Reserved for DocuSign.
     attr_accessor :delivery_method_metadata
 
     # 
@@ -59,25 +62,31 @@ module DocuSign_eSign
     # 
     attr_accessor :document_visibility
 
+    # Not applicable.
     attr_accessor :email_notification
 
     # Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session.   If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.  It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.  If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.   *Example*:   `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` 
     attr_accessor :embedded_recipient_start_url
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Reserved:
     attr_accessor :fax_number
 
+    # Reserved for DocuSign.
     attr_accessor :fax_number_metadata
 
     # Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.  *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.
     attr_accessor :id_check_configuration_name
 
+    # Not applicable.
     attr_accessor :id_check_configuration_name_metadata
 
+    # Not applicable.
     attr_accessor :id_check_information_input
 
+    # Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
     attr_accessor :identity_verification
 
     # When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. 
@@ -95,13 +104,16 @@ module DocuSign_eSign
     # Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.  Maximum Length: 1000 characters.
     attr_accessor :note
 
+    # Not applicable.
     attr_accessor :note_metadata
 
+    # Not applicable.
     attr_accessor :phone_authentication
 
     # Reserved:
     attr_accessor :recipient_attachments
 
+    # Not applicable.
     attr_accessor :recipient_authentication_status
 
     # 
@@ -119,11 +131,13 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_type
 
+    # Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
     attr_accessor :recipient_type_metadata
 
     # When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. 
     attr_accessor :require_id_lookup
 
+    # Not applicable.
     attr_accessor :require_id_lookup_metadata
 
     # Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
@@ -132,6 +146,7 @@ module DocuSign_eSign
     # Specifies the routing order of the recipient in the envelope. 
     attr_accessor :routing_order
 
+    # Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
     attr_accessor :routing_order_metadata
 
     # The date and time the envelope was sent.
@@ -140,6 +155,7 @@ module DocuSign_eSign
     # Reserved: For DocuSign use only. 
     attr_accessor :signed_date_time
 
+    # Not applicable.
     attr_accessor :sms_authentication
 
     #  Lists the social ID type that can be used for recipient authentication.
@@ -154,6 +170,7 @@ module DocuSign_eSign
     # 
     attr_accessor :suppress_emails
 
+    # A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
     attr_accessor :tabs
 
     # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. 

data/lib/docusign_esign/models/seat_discount.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 seat discount.
   class SeatDiscount
     # Reserved: TBD
     attr_accessor :begin_seat_count

data/lib/docusign_esign/models/sender_company.rb

@@ -16,56 +16,67 @@ module DocuSign_eSign
     # 
     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 +87,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 +117,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 +171,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 +186,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 +201,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/sender_email_notifications.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains the settings for the email notifications that senders receive about the envelopes that they send.
   class SenderEmailNotifications
     # When set to **true**, the sender receives notification if the signer changes.
     attr_accessor :changed_signer