docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/recipient_names_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This response object contains a list of recipients.
   class RecipientNamesResponse
     # Indicates whether email address is used by more than one user.
     attr_accessor :multiple_users

data/lib/docusign_esign/models/recipient_option.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes a recipient who is a member of a conditional group.
   class RecipientOption
     # 
     attr_accessor :email

data/lib/docusign_esign/models/recipient_phone_authentication.rb

@@ -17,21 +17,25 @@ module DocuSign_eSign
     # Boolean. When set to **true**, the recipient can supply a phone number their choice.
     attr_accessor :recip_may_provide_number
 
+    # Metadata that indicates whether the `recipMayProvideNumber` property can be edited.
     attr_accessor :recip_may_provide_number_metadata
 
     # Reserved.
     attr_accessor :record_voice_print
 
+    # Reserved for DocuSign.
     attr_accessor :record_voice_print_metadata
 
     # An Array containing a list of phone numbers the recipient may use for SMS text authentication. 
     attr_accessor :sender_provided_numbers
 
+    # Metadata that indicates whether the `senderProvidedNumbers` property can be edited.
     attr_accessor :sender_provided_numbers_metadata
 
     #  Reserved.
     attr_accessor :validate_recip_provided_number
 
+    # Reserved for DocuSign.
     attr_accessor :validate_recip_provided_number_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_phone_number.rb

@@ -12,15 +12,18 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes the recipient phone number.
   class RecipientPhoneNumber
     # 
     attr_accessor :country_code
 
+    # Metadata that indicates if the `countryCode` property is editable.
     attr_accessor :country_code_metadata
 
     # 
     attr_accessor :number
 
+    # Metadata that indicates if the `number` property is editable.
     attr_accessor :number_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_preview_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 the information necessary to create a recipient preview.
   class RecipientPreviewRequest
     # 
     attr_accessor :assertion_id
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :authentication_method
 
+    # 
     attr_accessor :client_ur_ls
 
     # 

data/lib/docusign_esign/models/recipient_proof_file.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/)
   class RecipientProofFile
     # 
     attr_accessor :has_identity_attempts

data/lib/docusign_esign/models/recipient_routing.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Describes the recipient routing rules.
   class RecipientRouting
+    # The recipient routing rules.
     attr_accessor :rules
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_signature_provider.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). 
   class RecipientSignatureProvider
     # 
     attr_accessor :seal_documents_with_tabs_only
@@ -22,8 +23,10 @@ module DocuSign_eSign
     # 
     attr_accessor :signature_provider_name
 
+    # Metadata that indicates whether the `signatureProviderName` property is editable. 
     attr_accessor :signature_provider_name_metadata
 
+    # Not applicable for this object.
     attr_accessor :signature_provider_options
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_signature_provider_options.rb

@@ -12,25 +12,30 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/)
   class RecipientSignatureProviderOptions
     # 
     attr_accessor :cpf_number
 
+    # Reserved for DocuSign.
     attr_accessor :cpf_number_metadata
 
     # 
     attr_accessor :one_time_password
 
+    # Metadata that indicates whether the `oneTimePassword` property is editable.
     attr_accessor :one_time_password_metadata
 
     # 
     attr_accessor :signer_role
 
+    # Metadata that indicates whether the `signerRole` property is editable.
     attr_accessor :signer_role_metadata
 
     # 
     attr_accessor :sms
 
+    # Metadata that indicates whether the `sms` property is editable.
     attr_accessor :sms_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_sms_authentication.rb

@@ -17,6 +17,7 @@ module DocuSign_eSign
     # An Array containing a list of phone numbers the recipient may use for SMS text authentication. 
     attr_accessor :sender_provided_numbers
 
+    # Metadata that indicates whether the `senderProvidedNumbers` property can be edited.
     attr_accessor :sender_provided_numbers_metadata
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_esign/models/recipient_token_client_ur_ls.rb

@@ -13,15 +13,65 @@ require 'date'
 
 module DocuSign_eSign
   class RecipientTokenClientURLs
+    # 
+    attr_accessor :on_access_code_failed
+
+    # 
+    attr_accessor :on_cancel
+
+    # 
+    attr_accessor :on_decline
+
+    # 
+    attr_accessor :on_exception
+
+    # 
+    attr_accessor :on_fax_pending
+
+    # 
+    attr_accessor :on_id_check_failed
+
+    # 
+    attr_accessor :on_session_timeout
+
+    # 
+    attr_accessor :on_signing_complete
+
+    # 
+    attr_accessor :on_ttl_expired
+
+    # 
+    attr_accessor :on_viewing_complete
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'on_access_code_failed' => :'onAccessCodeFailed',
+        :'on_cancel' => :'onCancel',
+        :'on_decline' => :'onDecline',
+        :'on_exception' => :'onException',
+        :'on_fax_pending' => :'onFaxPending',
+        :'on_id_check_failed' => :'onIdCheckFailed',
+        :'on_session_timeout' => :'onSessionTimeout',
+        :'on_signing_complete' => :'onSigningComplete',
+        :'on_ttl_expired' => :'onTTLExpired',
+        :'on_viewing_complete' => :'onViewingComplete'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'on_access_code_failed' => :'String',
+        :'on_cancel' => :'String',
+        :'on_decline' => :'String',
+        :'on_exception' => :'String',
+        :'on_fax_pending' => :'String',
+        :'on_id_check_failed' => :'String',
+        :'on_session_timeout' => :'String',
+        :'on_signing_complete' => :'String',
+        :'on_ttl_expired' => :'String',
+        :'on_viewing_complete' => :'String'
       }
     end
 
@@ -32,6 +82,46 @@ module DocuSign_eSign
 
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'onAccessCodeFailed')
+        self.on_access_code_failed = attributes[:'onAccessCodeFailed']
+      end
+
+      if attributes.has_key?(:'onCancel')
+        self.on_cancel = attributes[:'onCancel']
+      end
+
+      if attributes.has_key?(:'onDecline')
+        self.on_decline = attributes[:'onDecline']
+      end
+
+      if attributes.has_key?(:'onException')
+        self.on_exception = attributes[:'onException']
+      end
+
+      if attributes.has_key?(:'onFaxPending')
+        self.on_fax_pending = attributes[:'onFaxPending']
+      end
+
+      if attributes.has_key?(:'onIdCheckFailed')
+        self.on_id_check_failed = attributes[:'onIdCheckFailed']
+      end
+
+      if attributes.has_key?(:'onSessionTimeout')
+        self.on_session_timeout = attributes[:'onSessionTimeout']
+      end
+
+      if attributes.has_key?(:'onSigningComplete')
+        self.on_signing_complete = attributes[:'onSigningComplete']
+      end
+
+      if attributes.has_key?(:'onTTLExpired')
+        self.on_ttl_expired = attributes[:'onTTLExpired']
+      end
+
+      if attributes.has_key?(:'onViewingComplete')
+        self.on_viewing_complete = attributes[:'onViewingComplete']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -51,7 +141,17 @@ module DocuSign_eSign
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
-      self.class == o.class
+      self.class == o.class &&
+          on_access_code_failed == o.on_access_code_failed &&
+          on_cancel == o.on_cancel &&
+          on_decline == o.on_decline &&
+          on_exception == o.on_exception &&
+          on_fax_pending == o.on_fax_pending &&
+          on_id_check_failed == o.on_id_check_failed &&
+          on_session_timeout == o.on_session_timeout &&
+          on_signing_complete == o.on_signing_complete &&
+          on_ttl_expired == o.on_ttl_expired &&
+          on_viewing_complete == o.on_viewing_complete
     end
 
     # @see the `==` method
@@ -63,7 +163,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [].hash
+      [on_access_code_failed, on_cancel, on_decline, on_exception, on_fax_pending, on_id_check_failed, on_session_timeout, on_signing_complete, on_ttl_expired, on_viewing_complete].hash
     end
 
     # Builds the object from hash

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.
@@ -40,6 +41,9 @@ module DocuSign_eSign
     # 
     attr_accessor :notaries
 
+    # 
+    attr_accessor :participants
+
     # 
     attr_accessor :recipient_count
 
@@ -64,6 +68,7 @@ module DocuSign_eSign
         :'in_person_signers' => :'inPersonSigners',
         :'intermediaries' => :'intermediaries',
         :'notaries' => :'notaries',
+        :'participants' => :'participants',
         :'recipient_count' => :'recipientCount',
         :'seals' => :'seals',
         :'signers' => :'signers',
@@ -83,6 +88,7 @@ module DocuSign_eSign
         :'in_person_signers' => :'Array<InPersonSigner>',
         :'intermediaries' => :'Array<Intermediary>',
         :'notaries' => :'Array<NotaryRecipient>',
+        :'participants' => :'Array<Participant>',
         :'recipient_count' => :'String',
         :'seals' => :'Array<SealSign>',
         :'signers' => :'Array<Signer>',
@@ -148,6 +154,12 @@ module DocuSign_eSign
         end
       end
 
+      if attributes.has_key?(:'participants')
+        if (value = attributes[:'participants']).is_a?(Array)
+          self.participants = value
+        end
+      end
+
       if attributes.has_key?(:'recipientCount')
         self.recipient_count = attributes[:'recipientCount']
       end
@@ -198,6 +210,7 @@ module DocuSign_eSign
           in_person_signers == o.in_person_signers &&
           intermediaries == o.intermediaries &&
           notaries == o.notaries &&
+          participants == o.participants &&
           recipient_count == o.recipient_count &&
           seals == o.seals &&
           signers == o.signers &&
@@ -213,7 +226,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [agents, carbon_copies, certified_deliveries, current_routing_order, editors, error_details, in_person_signers, intermediaries, notaries, recipient_count, seals, signers, witnesses].hash
+      [agents, carbon_copies, certified_deliveries, current_routing_order, editors, error_details, in_person_signers, intermediaries, notaries, participants, recipient_count, seals, signers, witnesses].hash
     end
 
     # Builds the object from hash

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/reserved_domain_existence.rb

@@ -0,0 +1,194 @@
+=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 ReservedDomainExistence
+    # 
+    attr_accessor :email_domain
+
+    # 
+    attr_accessor :is_reserved
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email_domain' => :'emailDomain',
+        :'is_reserved' => :'isReserved'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email_domain' => :'String',
+        :'is_reserved' => :'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?(:'emailDomain')
+        self.email_domain = attributes[:'emailDomain']
+      end
+
+      if attributes.has_key?(:'isReserved')
+        self.is_reserved = attributes[:'isReserved']
+      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 &&
+          email_domain == o.email_domain &&
+          is_reserved == o.is_reserved
+    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
+      [email_domain, is_reserved].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/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