docusign_esign 3.17.0 → 3.19.0

data/lib/docusign_esign/models/locale_policy.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # 
     attr_accessor :address_format
 
+    # 
     attr_accessor :address_format_metadata
 
     # 
@@ -24,26 +25,31 @@ module DocuSign_eSign
     # 
     attr_accessor :calendar_type
 
+    # 
     attr_accessor :calendar_type_metadata
 
     # 
     attr_accessor :culture_name
 
+    # 
     attr_accessor :culture_name_metadata
 
     # 
     attr_accessor :currency_code
 
+    # Metadata that indicates whether the `currencyCode` property is editable.
     attr_accessor :currency_code_metadata
 
     # 
     attr_accessor :currency_negative_format
 
+    # 
     attr_accessor :currency_negative_format_metadata
 
     # 
     attr_accessor :currency_positive_format
 
+    # 
     attr_accessor :currency_positive_format_metadata
 
     # 
@@ -61,6 +67,7 @@ module DocuSign_eSign
     # 
     attr_accessor :date_format
 
+    # 
     attr_accessor :date_format_metadata
 
     # 
@@ -102,31 +109,37 @@ module DocuSign_eSign
     # 
     attr_accessor :initial_format
 
+    # 
     attr_accessor :initial_format_metadata
 
     # 
     attr_accessor :name_format
 
+    # 
     attr_accessor :name_format_metadata
 
     # 
     attr_accessor :sign_date_format
 
+    # Metadata that indicates whether the `signDateFormat` property is editable. 
     attr_accessor :sign_date_format_metadata
 
     # 
     attr_accessor :sign_time_format
 
+    # Metadata that indicates whether the `signTimeFormat` property is editable. 
     attr_accessor :sign_time_format_metadata
 
     # 
     attr_accessor :time_format
 
+    # 
     attr_accessor :time_format_metadata
 
     # 
     attr_accessor :time_zone
 
+    # 
     attr_accessor :time_zone_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/lock_information.rb

@@ -13,6 +13,7 @@ require 'date'
 
 module DocuSign_eSign
   class LockInformation
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # Sets the time, in seconds, until the lock expires when there is no activity on the envelope.  If no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.  The lock duration can be extended. 
@@ -21,6 +22,7 @@ module DocuSign_eSign
     # Specifies the friendly name of  the application that is locking the envelope.
     attr_accessor :locked_by_app
 
+    # A complex type containing information about the user that has the envelope or template locked.
     attr_accessor :locked_by_user
 
     # The datetime until the envelope lock expires.

data/lib/docusign_esign/models/lock_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 the lock that you want to create or update.
   class LockRequest
     # The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds.
     attr_accessor :lock_duration_in_seconds

data/lib/docusign_esign/models/member_group_shared_item.rb

@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about items shared among groups.
   class MemberGroupSharedItem
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
+    # The group sharing the item.
     attr_accessor :group
 
     # When set to **true**, this custom tab is shared.

data/lib/docusign_esign/models/member_shared_items.rb

@@ -12,10 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Information about shared items.
   class MemberSharedItems
     # 
     attr_accessor :envelopes
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
@@ -24,6 +26,7 @@ module DocuSign_eSign
     # 
     attr_accessor :templates
 
+    # Information about the user requesting sharing information.
     attr_accessor :user
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/merge_field.rb

@@ -17,11 +17,13 @@ module DocuSign_eSign
     # When set to **true**, the sender can modify the value of the custom tab during the sending process.
     attr_accessor :allow_sender_to_edit
 
+    # Metadata that indicates if the sender can edit the `allowSenderToEdit` property.
     attr_accessor :allow_sender_to_edit_metadata
 
     # If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
     attr_accessor :configuration_type
 
+    # Metadata that indicates if the sender can edit the `configurationType` property.
     attr_accessor :configuration_type_metadata
 
     # Sets the object associated with the custom tab. Currently this is the Salesforce Object.
@@ -30,18 +32,22 @@ module DocuSign_eSign
     # 
     attr_accessor :path_extended
 
+    # Reserved for DocuSign.
     attr_accessor :path_extended_metadata
 
+    # Metadata that indicates whether the `path` property is editable. 
     attr_accessor :path_metadata
 
     # Specifies the row number in a Salesforce table that the merge field value corresponds to.
     attr_accessor :row
 
+    # Metadata that indicates whether the `row` property is editable. 
     attr_accessor :row_metadata
 
     # When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.
     attr_accessor :write_back
 
+    # Metadata that indicates if the sender can edit the `writeBack` property.
     attr_accessor :write_back_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/mobile_notifier_configuration.rb

@@ -16,6 +16,7 @@ module DocuSign_eSign
     # 
     attr_accessor :device_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/money.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes information about the `total` of a payment. 
   class Money
     # 
     attr_accessor :amount_in_base_unit

data/lib/docusign_esign/models/name_value.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A name-value pair that describes an item and provides a value for the item.
   class NameValue
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # The name or key of a name/value pair.

data/lib/docusign_esign/models/new_account_definition.rb

@@ -16,12 +16,16 @@ module DocuSign_eSign
     # The account name for the new account.
     attr_accessor :account_name
 
+    # The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden.  
     attr_accessor :account_settings
 
+    # A complex type that contains the following information for the new account: `Street1`, `Street2`, `City`, `State`, `Zip`, `Phone`, and `Fax`.
     attr_accessor :address_information
 
+    # 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
 
     # The code that identifies the billing plan groups and plans for the new account.
@@ -36,20 +40,28 @@ module DocuSign_eSign
     # 
     attr_accessor :envelope_partition_id
 
+    # A complex type with the initial user information for the new account. Note that some user information is set internally based on the plan and cannot be overridden.
     attr_accessor :initial_user
 
     # 
     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
 
+    # Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo.
     attr_accessor :social_account_information
 
     # 
@@ -69,6 +81,7 @@ module DocuSign_eSign
         :'envelope_partition_id' => :'envelopePartitionId',
         :'initial_user' => :'initialUser',
         :'payment_method' => :'paymentMethod',
+        :'payment_processor' => :'paymentProcessor',
         :'payment_processor_information' => :'paymentProcessorInformation',
         :'plan_information' => :'planInformation',
         :'process_payment' => :'processPayment',
@@ -92,6 +105,7 @@ module DocuSign_eSign
         :'envelope_partition_id' => :'String',
         :'initial_user' => :'UserInformation',
         :'payment_method' => :'String',
+        :'payment_processor' => :'String',
         :'payment_processor_information' => :'PaymentProcessorInformation',
         :'plan_information' => :'PlanInformation',
         :'process_payment' => :'String',
@@ -153,6 +167,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
@@ -207,6 +225,7 @@ module DocuSign_eSign
           envelope_partition_id == o.envelope_partition_id &&
           initial_user == o.initial_user &&
           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 &&
@@ -224,7 +243,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [account_name, account_settings, address_information, credit_card_information, direct_debit_processor_information, distributor_code, distributor_password, enable_pre_auth, envelope_partition_id, initial_user, payment_method, payment_processor_information, plan_information, process_payment, referral_information, social_account_information, tax_exempt_id].hash
+      [account_name, account_settings, address_information, credit_card_information, direct_debit_processor_information, distributor_code, distributor_password, enable_pre_auth, envelope_partition_id, initial_user, payment_method, payment_processor, payment_processor_information, plan_information, process_payment, referral_information, social_account_information, tax_exempt_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/new_account_summary.rb

@@ -28,6 +28,7 @@ module DocuSign_eSign
     # The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.
     attr_accessor :base_url
 
+    # 
     attr_accessor :billing_plan_preview
 
     # Specifies the user ID of the new user.

data/lib/docusign_esign/models/new_user.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Object representing a new user.
   class NewUser
     # Contains a token that can be used for authentication in API calls instead of using the user name and password.
     attr_accessor :api_password
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email
 
+    # 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/new_users_summary.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Object representing a summary of data for new users.
   class NewUsersSummary
     # 
     attr_accessor :new_users

data/lib/docusign_esign/models/notarize.rb

@@ -12,55 +12,66 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.
   class Notarize
     # 
     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
 
     # 
@@ -71,50 +82,61 @@ 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
 
     # 
     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 signer cannot change the data of the custom tab.
     attr_accessor :locked
 
+    # Metadata that indicates whether the `locked` property is editable.
     attr_accessor :locked_metadata
 
+    # Contains the information necessary to map the tab to a field in SalesForce.
     attr_accessor :merge_field
 
     # 
@@ -123,6 +145,7 @@ module DocuSign_eSign
     # 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.
@@ -131,15 +154,19 @@ module DocuSign_eSign
     # 
     attr_accessor :recipient_id_guid
 
+    # Metadata that indicates whether the `recipientIdGuid` property is editable.
     attr_accessor :recipient_id_guid_metadata
 
+    # Metadata that indicates whether the `recipientId` property is editable.
     attr_accessor :recipient_id_metadata
 
     # When set to **true**, the signer is required to fill out this tab
     attr_accessor :required
 
+    # Metadata that indicates whether the `required` property is editable.
     attr_accessor :required_metadata
 
+    # Reserved for DocuSign.
     attr_accessor :smart_contract_information
 
     # 
@@ -148,56 +175,67 @@ 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
 
     # 
     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
 
     # 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/notary.rb

@@ -22,6 +22,7 @@ module DocuSign_eSign
     # 
     attr_accessor :searchable
 
+    # Information about the user registering to be a notary.
     attr_accessor :user_info
 
     # Attribute mapping from ruby-style variable name to JSON key.