docusign_esign 3.20.0 → 3.22.0

data/lib/docusign_esign/models/intermediary.rb

@@ -32,6 +32,9 @@ module DocuSign_eSign
     # 
     attr_accessor :auto_responded_reason
 
+    # 
+    attr_accessor :bulk_send_v2_recipient
+
     # 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
 
@@ -74,7 +77,7 @@ module DocuSign_eSign
     # 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`. 
+    # A complex type that contains information sets the language of the recipient's email information.   **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. 
     attr_accessor :email_notification
 
     # 
@@ -83,7 +86,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.
+    # Array or errors.
     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.
@@ -242,6 +245,7 @@ module DocuSign_eSign
         :'additional_notifications' => :'additionalNotifications',
         :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
         :'auto_responded_reason' => :'autoRespondedReason',
+        :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
         :'client_user_id' => :'clientUserId',
         :'completed_count' => :'completedCount',
         :'consent_details_list' => :'consentDetailsList',
@@ -321,6 +325,7 @@ module DocuSign_eSign
         :'additional_notifications' => :'Array<RecipientAdditionalNotification>',
         :'allow_system_override_for_locked_recipient' => :'String',
         :'auto_responded_reason' => :'String',
+        :'bulk_send_v2_recipient' => :'String',
         :'client_user_id' => :'String',
         :'completed_count' => :'String',
         :'consent_details_list' => :'Array<ConsentDetails>',
@@ -425,6 +430,10 @@ module DocuSign_eSign
         self.auto_responded_reason = attributes[:'autoRespondedReason']
       end
 
+      if attributes.has_key?(:'bulkSendV2Recipient')
+        self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
+      end
+
       if attributes.has_key?(:'clientUserId')
         self.client_user_id = attributes[:'clientUserId']
       end
@@ -734,6 +743,7 @@ module DocuSign_eSign
           additional_notifications == o.additional_notifications &&
           allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
           auto_responded_reason == o.auto_responded_reason &&
+          bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
           client_user_id == o.client_user_id &&
           completed_count == o.completed_count &&
           consent_details_list == o.consent_details_list &&
@@ -812,7 +822,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
+      [access_code, access_code_metadata, add_access_code_to_email, additional_notifications, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, consent_details_list, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email, email_metadata, email_notification, email_recipient_post_signing_url, embedded_recipient_start_url, error_details, excluded_documents, fax_number, fax_number_metadata, first_name, first_name_metadata, full_name, full_name_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, last_name, last_name_metadata, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, name_metadata, note, note_metadata, phone_authentication, phone_number, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, signing_group_id, signing_group_id_metadata, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, template_locked, template_required, total_tab_count, user_id].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/jurisdiction_summary.rb

@@ -0,0 +1,214 @@
+=begin
+#DocuSign REST API
+
+#The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
+
+OpenAPI spec version: v2.1
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_eSign
+  class JurisdictionSummary
+    # 
+    attr_accessor :authorized_for_i_pen
+
+    # 
+    attr_accessor :authorized_for_ron
+
+    # 
+    attr_accessor :jurisdiction_id
+
+    # 
+    attr_accessor :jurisdiction_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'authorized_for_i_pen' => :'authorizedForIPen',
+        :'authorized_for_ron' => :'authorizedForRon',
+        :'jurisdiction_id' => :'jurisdictionId',
+        :'jurisdiction_name' => :'jurisdictionName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'authorized_for_i_pen' => :'String',
+        :'authorized_for_ron' => :'String',
+        :'jurisdiction_id' => :'String',
+        :'jurisdiction_name' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'authorizedForIPen')
+        self.authorized_for_i_pen = attributes[:'authorizedForIPen']
+      end
+
+      if attributes.has_key?(:'authorizedForRon')
+        self.authorized_for_ron = attributes[:'authorizedForRon']
+      end
+
+      if attributes.has_key?(:'jurisdictionId')
+        self.jurisdiction_id = attributes[:'jurisdictionId']
+      end
+
+      if attributes.has_key?(:'jurisdictionName')
+        self.jurisdiction_name = attributes[:'jurisdictionName']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          authorized_for_i_pen == o.authorized_for_i_pen &&
+          authorized_for_ron == o.authorized_for_ron &&
+          jurisdiction_id == o.jurisdiction_id &&
+          jurisdiction_name == o.jurisdiction_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [authorized_for_i_pen, authorized_for_ron, jurisdiction_id, jurisdiction_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_eSign.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_esign/models/last_name.rb

@@ -83,6 +83,7 @@ module DocuSign_eSign
     # 
     attr_accessor :caption
 
+    # 
     attr_accessor :caption_metadata
 
     # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
     # 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.
+    # Array or errors.
     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.

data/lib/docusign_esign/models/list.rb

@@ -83,6 +83,7 @@ module DocuSign_eSign
     # 
     attr_accessor :caption
 
+    # 
     attr_accessor :caption_metadata
 
     # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -109,7 +110,7 @@ module DocuSign_eSign
     # 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.
+    # Array or errors.
     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.

data/lib/docusign_esign/models/list_custom_field.rb

@@ -17,7 +17,7 @@ module DocuSign_eSign
     # If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
     attr_accessor :configuration_type
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # An ID used to specify a custom field.

data/lib/docusign_esign/models/locale_policy_tab.rb

@@ -52,6 +52,9 @@ module DocuSign_eSign
     # 
     attr_accessor :time_zone
 
+    # 
+    attr_accessor :use_long_currency_format
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -67,7 +70,8 @@ module DocuSign_eSign
         :'initial_format' => :'initialFormat',
         :'name_format' => :'nameFormat',
         :'time_format' => :'timeFormat',
-        :'time_zone' => :'timeZone'
+        :'time_zone' => :'timeZone',
+        :'use_long_currency_format' => :'useLongCurrencyFormat'
       }
     end
 
@@ -86,7 +90,8 @@ module DocuSign_eSign
         :'initial_format' => :'String',
         :'name_format' => :'String',
         :'time_format' => :'String',
-        :'time_zone' => :'String'
+        :'time_zone' => :'String',
+        :'use_long_currency_format' => :'String'
       }
     end
 
@@ -149,6 +154,10 @@ module DocuSign_eSign
       if attributes.has_key?(:'timeZone')
         self.time_zone = attributes[:'timeZone']
       end
+
+      if attributes.has_key?(:'useLongCurrencyFormat')
+        self.use_long_currency_format = attributes[:'useLongCurrencyFormat']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -181,7 +190,8 @@ module DocuSign_eSign
           initial_format == o.initial_format &&
           name_format == o.name_format &&
           time_format == o.time_format &&
-          time_zone == o.time_zone
+          time_zone == o.time_zone &&
+          use_long_currency_format == o.use_long_currency_format
     end
 
     # @see the `==` method
@@ -193,7 +203,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [address_format, calendar_type, culture_name, currency_code, currency_negative_format, currency_positive_format, custom_date_format, custom_time_format, date_format, initial_format, name_format, time_format, time_zone].hash
+      [address_format, calendar_type, culture_name, currency_code, currency_negative_format, currency_positive_format, custom_date_format, custom_time_format, date_format, initial_format, name_format, time_format, time_zone, use_long_currency_format].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/lock_information.rb

@@ -13,7 +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.
+    # Array or errors.
     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. 

data/lib/docusign_esign/models/member_group_shared_item.rb

@@ -14,7 +14,7 @@ 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.
+    # Array or errors.
     attr_accessor :error_details
 
     # The group sharing the item.

data/lib/docusign_esign/models/member_shared_items.rb

@@ -17,7 +17,7 @@ module DocuSign_eSign
     # 
     attr_accessor :envelopes
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/mobile_notifier_configuration.rb

@@ -16,7 +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.
+    # Array or errors.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/name_value.rb

@@ -14,7 +14,7 @@ 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.
+    # Array or errors.
     attr_accessor :error_details
 
     # The name or key of a name/value pair.

data/lib/docusign_esign/models/new_account_definition.rb

@@ -16,7 +16,7 @@ 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.  
+    # The list of account settings. These 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`.
@@ -61,7 +61,7 @@ module DocuSign_eSign
     # 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.
+    # Contains properties that map a DocuSign user to a social account (Facebook, Yahoo, etc.)
     attr_accessor :social_account_information
 
     # 

data/lib/docusign_esign/models/new_user.rb

@@ -23,7 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :email
 
-    # This object describes errors that occur. It is only valid for responses and ignored in requests.
+    # Array or errors.
     attr_accessor :error_details
 
     # 

data/lib/docusign_esign/models/notarize.rb

@@ -77,6 +77,7 @@ module DocuSign_eSign
     # 
     attr_accessor :caption
 
+    # 
     attr_accessor :caption_metadata
 
     # For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
@@ -103,7 +104,7 @@ module DocuSign_eSign
     # 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.
+    # Array or errors.
     attr_accessor :error_details
 
     #