docusign_esign 3.18.0 → 3.19.0

data/lib/docusign_esign/models/billing_plan_information.rb

@@ -12,13 +12,18 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains details about a billing plan.
   class BillingPlanInformation
+    # 
     attr_accessor :app_store_receipt
 
+    # The billing address for the account.
     attr_accessor :billing_address
 
+    # A complex type that has information about the credit card used to pay for this account.
     attr_accessor :credit_card_information
 
+    # Information about the bank that processes direct debits for the payment plan.
     attr_accessor :direct_debit_processor_information
 
     # 
@@ -39,13 +44,19 @@ module DocuSign_eSign
     # 
     attr_accessor :payment_method
 
+    # 
+    attr_accessor :payment_processor
+
+    # Information about the entity that processes payments for the billing plan.
     attr_accessor :payment_processor_information
 
+    # An object used to identify the features and attributes of the account being created.
     attr_accessor :plan_information
 
     # 
     attr_accessor :process_payment
 
+    # A complex type that contains properties for entering referral and discount information.
     attr_accessor :referral_information
 
     # 
@@ -82,6 +93,7 @@ module DocuSign_eSign
         :'included_seats' => :'includedSeats',
         :'incremental_seats' => :'incrementalSeats',
         :'payment_method' => :'paymentMethod',
+        :'payment_processor' => :'paymentProcessor',
         :'payment_processor_information' => :'paymentProcessorInformation',
         :'plan_information' => :'planInformation',
         :'process_payment' => :'processPayment',
@@ -109,6 +121,7 @@ module DocuSign_eSign
         :'included_seats' => :'String',
         :'incremental_seats' => :'String',
         :'payment_method' => :'String',
+        :'payment_processor' => :'String',
         :'payment_processor_information' => :'PaymentProcessorInformation',
         :'plan_information' => :'PlanInformation',
         :'process_payment' => :'String',
@@ -171,6 +184,10 @@ module DocuSign_eSign
         self.payment_method = attributes[:'paymentMethod']
       end
 
+      if attributes.has_key?(:'paymentProcessor')
+        self.payment_processor = attributes[:'paymentProcessor']
+      end
+
       if attributes.has_key?(:'paymentProcessorInformation')
         self.payment_processor_information = attributes[:'paymentProcessorInformation']
       end
@@ -244,6 +261,7 @@ module DocuSign_eSign
           included_seats == o.included_seats &&
           incremental_seats == o.incremental_seats &&
           payment_method == o.payment_method &&
+          payment_processor == o.payment_processor &&
           payment_processor_information == o.payment_processor_information &&
           plan_information == o.plan_information &&
           process_payment == o.process_payment &&
@@ -266,7 +284,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, tax_exempt_id].hash
+      [app_store_receipt, billing_address, credit_card_information, direct_debit_processor_information, downgrade_reason, enable_pre_auth, enable_support, included_seats, incremental_seats, payment_method, payment_processor, payment_processor_information, plan_information, process_payment, referral_information, renewal_status, sale_discount_amount, sale_discount_fixed_amount, sale_discount_percent, sale_discount_periods, sale_discount_seat_price_override, tax_exempt_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/billing_plan_preview.rb

@@ -17,6 +17,7 @@ module DocuSign_eSign
     # Specifies the ISO currency code for the account.
     attr_accessor :currency_code
 
+    # 
     attr_accessor :invoice
 
     # 

data/lib/docusign_esign/models/billing_plan_response.rb

@@ -14,6 +14,7 @@ require 'date'
 module DocuSign_eSign
   # Defines a billing plan response object.
   class BillingPlanResponse
+    # An object that contains details about the billing plan.
     attr_accessor :billing_plan
 
     # 

data/lib/docusign_esign/models/billing_plan_update_response.rb

@@ -17,6 +17,7 @@ module DocuSign_eSign
     # 
     attr_accessor :account_payment_method
 
+    # 
     attr_accessor :billing_plan_preview
 
     # Specifies the ISO currency code for the account.

data/lib/docusign_esign/models/brand.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.
   class Brand
     # The name of the company associated with this brand.
     attr_accessor :brand_company
@@ -34,6 +35,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email_content
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
@@ -51,8 +53,10 @@ module DocuSign_eSign
     # 
     attr_accessor :links
 
+    # The URIs for retrieving the logos that are associated with the brand.
     attr_accessor :logos
 
+    # An object containing the URLs for the four DocuSign master resource files that the brand uses for sending, signing, email messages, and captive (embedded) signing. You can modify the default email messages and formats in these file to customize the user experience.  **Note:** This object is returned only when the `resourceContentType` is `sending`, `signing`, `email`, or `signing_captive`.
     attr_accessor :resources
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/brand_email_content.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Deprecated.
   class BrandEmailContent
     # 
     attr_accessor :content

data/lib/docusign_esign/models/brand_link.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about a link that a brand uses.
   class BrandLink
     # 
     attr_accessor :link_text

data/lib/docusign_esign/models/brand_logos.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The URIs for retrieving the logos that are associated with the brand.  These are read-only properties that provide a URI to logos in use. To update a logo use [AccountBrands: updateLogo](/docs/esign-rest-api/reference/accounts/accountbrands/updatelogo/). 
   class BrandLogos
     # 
     attr_accessor :email

data/lib/docusign_esign/models/brand_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This request object contains information about a specific brand.
   class BrandRequest
     # The ID of the brand used in API calls
     attr_accessor :brand_id

data/lib/docusign_esign/models/brand_resource_urls.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Brands use resource files to style the following experiences:   - Email - Sending - Signing - Captive (embedded) signing   You can modify these resource files to customize these experiences.
   class BrandResourceUrls
     # 
     attr_accessor :email

data/lib/docusign_esign/models/brand_resources.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.
   class BrandResources
+    # The user ID of the user who created the brand resource.
     attr_accessor :created_by_user_info
 
     # 
@@ -21,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :data_not_saved_not_in_master
 
+    # Information about the user who last modified the brand resource.
     attr_accessor :modified_by_user_info
 
     # 

data/lib/docusign_esign/models/brands_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about one or more brands.
   class BrandsRequest
     # The list of brands.
     attr_accessor :brands

data/lib/docusign_esign/models/bulk_envelope.rb

@@ -28,6 +28,7 @@ module DocuSign_eSign
     # Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
     attr_accessor :envelope_uri
 
+    # 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/bulk_recipients_update_response.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class BulkRecipientsUpdateResponse
+    # 
     attr_accessor :signer
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/bulk_send_batch_action_request.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # 
     attr_accessor :action
 
+    # 
     attr_accessor :notification
 
     # 

data/lib/docusign_esign/models/bulk_send_batch_status.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Result of `getBulkSendBatchStatus`
   class BulkSendBatchStatus
     # 
     attr_accessor :action
@@ -34,6 +35,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_id_or_template_id
 
+    # 
     attr_accessor :envelopes_info
 
     # 

data/lib/docusign_esign/models/bulk_send_batch_summaries.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A list of bulk send batch summaries. 
   class BulkSendBatchSummaries
     # 
     attr_accessor :batch_size_limit

data/lib/docusign_esign/models/bulk_send_batch_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Summary status of a single batch.
   class BulkSendBatchSummary
     # 
     attr_accessor :batch_id

data/lib/docusign_esign/models/bulk_send_error_status.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A single bulk send error report.
   class BulkSendErrorStatus
     # 
     attr_accessor :created

data/lib/docusign_esign/models/bulk_send_request.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 the envelope or template that you want to send in bulk.
   class BulkSendRequest
     # 
     attr_accessor :batch_name

data/lib/docusign_esign/models/bulk_send_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The object contains the response to a bulk send request.
   class BulkSendResponse
     # 
     attr_accessor :batch_id

data/lib/docusign_esign/models/bulk_send_test_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the results of a bulk send test.
   class BulkSendTestResponse
     # 
     attr_accessor :can_be_sent

data/lib/docusign_esign/models/bulk_sending_copy.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.
   class BulkSendingCopy
     # An optional array of strings that allows 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

data/lib/docusign_esign/models/bulk_sending_copy_custom_field.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 a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.
   class BulkSendingCopyCustomField
     # 
     attr_accessor :name

data/lib/docusign_esign/models/bulk_sending_copy_recipient.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 a bulk send recipient.
   class BulkSendingCopyRecipient
     # 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
@@ -28,6 +29,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email
 
+    # An optional complex type that sets a specific email subject and body for this recipient's notification email.   **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. 
     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]]` 
@@ -45,6 +47,7 @@ module DocuSign_eSign
     # 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
 
+    # An object that contains input information related to a recipient ID check.
     attr_accessor :id_check_information_input
 
     # 
@@ -56,6 +59,7 @@ 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
 
+    # When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:  * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings.  A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.  
     attr_accessor :phone_authentication
 
     # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
@@ -73,6 +77,7 @@ module DocuSign_eSign
     # When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
     attr_accessor :signing_group_id
 
+    # When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.   
     attr_accessor :sms_authentication
 
     #  Lists the social ID type that can be used for recipient authentication.

data/lib/docusign_esign/models/bulk_sending_copy_tab.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.  For example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.
   class BulkSendingCopyTab
     # The original value of the tab.
     attr_accessor :initial_value

data/lib/docusign_esign/models/bulk_sending_list.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains the details for the bulk send list.
   class BulkSendingList
     # 
     attr_accessor :bulk_copies

data/lib/docusign_esign/models/bulk_sending_list_summaries.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.
   class BulkSendingListSummaries
     # 
     attr_accessor :bulk_list_summaries

data/lib/docusign_esign/models/bulk_sending_list_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains basic information about a bulk send list.
   class BulkSendingListSummary
     # 
     attr_accessor :bulk_send_list_id

data/lib/docusign_esign/models/captive_recipient.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 a captive (embedded) recipient.
   class CaptiveRecipient
     # Specifies whether the recipient is embedded or remote.   If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true**, an error is generated on sending.ng.   Maximum length: 100 characters. 
     attr_accessor :client_user_id
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # Specifies the email address associated with the captive recipient.
     attr_accessor :email
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Specifies the user name associated with the captive recipient.

data/lib/docusign_esign/models/captive_recipient_information.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about captive (embedded) recipients.
   class CaptiveRecipientInformation
     # A complex type containing information about one or more captive recipients.
     attr_accessor :captive_recipients

data/lib/docusign_esign/models/carbon_copy.rb

@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. 
   class CarbonCopy
     # 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
 
+    # Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
     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.
@@ -60,6 +62,7 @@ module DocuSign_eSign
     # Reserved: For DocuSign use only.
     attr_accessor :delivery_method
 
+    # Reserved for DocuSign.
     attr_accessor :delivery_method_metadata
 
     # 
@@ -74,8 +77,10 @@ module DocuSign_eSign
     # Email id of the recipient. Notification of the document to sign is sent to this email id.   Maximum length: 100 characters. 
     attr_accessor :email
 
+    # Metadata that indicates whether the `email` property is editable. This property is read-only.
     attr_accessor :email_metadata
 
+    # An optional complex type that sets a specific email subject and body for this recipient's notification email.   **Note:** You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients will inherit the this value from the top-level `emailSubject` and `emailBlurb`. 
     attr_accessor :email_notification
 
     # 
@@ -84,6 +89,7 @@ module DocuSign_eSign
     # 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
 
     # Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.  When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
@@ -92,25 +98,31 @@ module DocuSign_eSign
     # Reserved:
     attr_accessor :fax_number
 
+    # Reserved for DocuSign.
     attr_accessor :fax_number_metadata
 
     # The user's first name.  Maximum Length: 50 characters.
     attr_accessor :first_name
 
+    # Metadata that indicates whether the `firstName` property is editable. This property is read-only.
     attr_accessor :first_name_metadata
 
     # 
     attr_accessor :full_name
 
+    # Reserved for DocuSign.
     attr_accessor :full_name_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
 
+    # Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
     attr_accessor :id_check_configuration_name_metadata
 
+    # An object that contains input information related to a recipient ID check.
     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. 
@@ -119,6 +131,7 @@ module DocuSign_eSign
     # 
     attr_accessor :last_name
 
+    # Metadata that indicates whether the `lastName` property is editable. This property is read-only.
     attr_accessor :last_name_metadata
 
     # 
@@ -133,22 +146,28 @@ module DocuSign_eSign
     # legal name of the recipient.  Maximum Length: 100 characters.
     attr_accessor :name
 
+    # Metadata that indicates whether the `name` property is editable. This property is read-only.
     attr_accessor :name_metadata
 
     # 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
 
+    # Metadata that indicates whether the `note` property is editable. This property is read-only.
     attr_accessor :note_metadata
 
+    # When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements:  * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings.  A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign.  
     attr_accessor :phone_authentication
 
+    # Describes the recipient phone number.
     attr_accessor :phone_number
 
+    # The proof file of the recipient.
     attr_accessor :proof_file
 
     # Reserved:
     attr_accessor :recipient_attachments
 
+    # Information about the recipient's authentication status. This property is read-only.
     attr_accessor :recipient_authentication_status
 
     # 
@@ -163,11 +182,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
 
+    # Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
     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.
@@ -176,6 +197,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.
@@ -187,6 +209,7 @@ module DocuSign_eSign
     # When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
     attr_accessor :signing_group_id
 
+    # Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
     attr_accessor :signing_group_id_metadata
 
     # The display name for the signing group.   Maximum Length: 100 characters. 
@@ -195,6 +218,7 @@ module DocuSign_eSign
     # A complex type that contains information about users in the signing group.
     attr_accessor :signing_group_users
 
+    # When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication.   
     attr_accessor :sms_authentication
 
     #  Lists the social ID type that can be used for recipient authentication.
@@ -209,6 +233,7 @@ module DocuSign_eSign
     # 
     attr_accessor :suppress_emails
 
+    # A list of `commentTabs` that contains the Carbon Copy recipient's comments.
     attr_accessor :tabs
 
     # When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.