docusign_esign 3.12.0 → 3.19.0

data/lib/docusign_esign/models/connect_user_info.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 ConnectUserInfo
+    # 
+    attr_accessor :email
+
+    # 
+    attr_accessor :is_included
+
+    # 
+    attr_accessor :user_id
+
+    # 
+    attr_accessor :user_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'is_included' => :'isIncluded',
+        :'user_id' => :'userId',
+        :'user_name' => :'userName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'is_included' => :'String',
+        :'user_id' => :'String',
+        :'user_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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'isIncluded')
+        self.is_included = attributes[:'isIncluded']
+      end
+
+      if attributes.has_key?(:'userId')
+        self.user_id = attributes[:'userId']
+      end
+
+      if attributes.has_key?(:'userName')
+        self.user_name = attributes[:'userName']
+      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 == o.email &&
+          is_included == o.is_included &&
+          user_id == o.user_id &&
+          user_name == o.user_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
+      [email, is_included, user_id, user_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/consent_details.rb

@@ -0,0 +1,204 @@
+=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 ConsentDetails
+    # 
+    attr_accessor :consent_key
+
+    # Reserved: For DocuSign use only.
+    attr_accessor :delivery_method
+
+    # 
+    attr_accessor :signer_consent_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'consent_key' => :'consentKey',
+        :'delivery_method' => :'deliveryMethod',
+        :'signer_consent_status' => :'signerConsentStatus'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'consent_key' => :'String',
+        :'delivery_method' => :'String',
+        :'signer_consent_status' => :'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?(:'consentKey')
+        self.consent_key = attributes[:'consentKey']
+      end
+
+      if attributes.has_key?(:'deliveryMethod')
+        self.delivery_method = attributes[:'deliveryMethod']
+      end
+
+      if attributes.has_key?(:'signerConsentStatus')
+        self.signer_consent_status = attributes[:'signerConsentStatus']
+      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 &&
+          consent_key == o.consent_key &&
+          delivery_method == o.delivery_method &&
+          signer_consent_status == o.signer_consent_status
+    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
+      [consent_key, delivery_method, signer_consent_status].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/console_view_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request object for the [EnvelopeViews: createConsole](/docs/esign-rest-api/reference/envelopes/envelopeviews/createconsole/) method.
   class ConsoleViewRequest
     # The envelope ID of the envelope status that failed to post.
     attr_accessor :envelope_id

data/lib/docusign_esign/models/consumer_disclosure.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about consumer disclosures.
   class ConsumerDisclosure
     # A GUID identifying the account associated with the consumer disclosure
     attr_accessor :account_esign_id
@@ -19,6 +20,7 @@ module DocuSign_eSign
     # Indicates whether the customer can withdraw their acceptance of the consumer disclosure.
     attr_accessor :allow_cd_withdraw
 
+    # Metadata that indicates whether the `allowCDWithdraw` property is editable. 
     attr_accessor :allow_cd_withdraw_metadata
 
     # 
@@ -69,6 +71,7 @@ module DocuSign_eSign
     # 
     attr_accessor :use_consumer_disclosure_within_account
 
+    # Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. 
     attr_accessor :use_consumer_disclosure_within_account_metadata
 
     # Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.  Maximum length: 100 characters. 

data/lib/docusign_esign/models/contact.rb

@@ -31,6 +31,7 @@ module DocuSign_eSign
     # 
     attr_accessor :emails
 
+    # This object describes errors that occur. It is only valid for responses and ignored in requests.
     attr_accessor :error_details
 
     # 
@@ -42,6 +43,9 @@ module DocuSign_eSign
     # 
     attr_accessor :organization
 
+    # 
+    attr_accessor :room_contact_type
+
     # When set to **true**, this custom tab is shared.
     attr_accessor :shared
 
@@ -64,6 +68,7 @@ module DocuSign_eSign
         :'is_owner' => :'isOwner',
         :'name' => :'name',
         :'organization' => :'organization',
+        :'room_contact_type' => :'roomContactType',
         :'shared' => :'shared',
         :'signing_group' => :'signingGroup',
         :'signing_group_name' => :'signingGroupName'
@@ -83,6 +88,7 @@ module DocuSign_eSign
         :'is_owner' => :'BOOLEAN',
         :'name' => :'String',
         :'organization' => :'String',
+        :'room_contact_type' => :'String',
         :'shared' => :'String',
         :'signing_group' => :'String',
         :'signing_group_name' => :'String'
@@ -141,6 +147,10 @@ module DocuSign_eSign
         self.organization = attributes[:'organization']
       end
 
+      if attributes.has_key?(:'roomContactType')
+        self.room_contact_type = attributes[:'roomContactType']
+      end
+
       if attributes.has_key?(:'shared')
         self.shared = attributes[:'shared']
       end
@@ -182,6 +192,7 @@ module DocuSign_eSign
           is_owner == o.is_owner &&
           name == o.name &&
           organization == o.organization &&
+          room_contact_type == o.room_contact_type &&
           shared == o.shared &&
           signing_group == o.signing_group &&
           signing_group_name == o.signing_group_name
@@ -196,7 +207,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cloud_provider, cloud_provider_container_id, contact_id, contact_phone_numbers, contact_uri, emails, error_details, is_owner, name, organization, shared, signing_group, signing_group_name].hash
+      [cloud_provider, cloud_provider_container_id, contact_id, contact_phone_numbers, contact_uri, emails, error_details, is_owner, name, organization, room_contact_type, shared, signing_group, signing_group_name].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/contact_get_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 information about the contacts associated with an account.
   class ContactGetResponse
     # 
     attr_accessor :contacts

data/lib/docusign_esign/models/contact_mod_request.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request object containing the new information for the contacts.
   class ContactModRequest
     # 
     attr_accessor :contact_list

data/lib/docusign_esign/models/contact_phone_number.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # Details about the phone numbers associated with a specific contact.
   class ContactPhoneNumber
     # 
     attr_accessor :phone_number

data/lib/docusign_esign/models/contact_update_response.rb

@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This response objects shows the updated details for the contacts.
   class ContactUpdateResponse
     # 
     attr_accessor :contacts

data/lib/docusign_esign/models/correct_view_request.rb

@@ -12,7 +12,11 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # The request body for the [EnvelopeViews: createCorrect](/docs/esign-rest-api/reference/envelopes/envelopeviews/createcorrect/) method.
   class CorrectViewRequest
+    # 
+    attr_accessor :begin_on_tagger
+
     # The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are:   * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action)  ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers. 
     attr_accessor :return_url
 
@@ -25,6 +29,7 @@ module DocuSign_eSign
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'begin_on_tagger' => :'beginOnTagger',
         :'return_url' => :'returnUrl',
         :'suppress_navigation' => :'suppressNavigation',
         :'view_url' => :'viewUrl'
@@ -34,6 +39,7 @@ module DocuSign_eSign
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'begin_on_tagger' => :'String',
         :'return_url' => :'String',
         :'suppress_navigation' => :'String',
         :'view_url' => :'String'
@@ -48,6 +54,10 @@ 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?(:'beginOnTagger')
+        self.begin_on_tagger = attributes[:'beginOnTagger']
+      end
+
       if attributes.has_key?(:'returnUrl')
         self.return_url = attributes[:'returnUrl']
       end
@@ -79,6 +89,7 @@ module DocuSign_eSign
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          begin_on_tagger == o.begin_on_tagger &&
           return_url == o.return_url &&
           suppress_navigation == o.suppress_navigation &&
           view_url == o.view_url
@@ -93,7 +104,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [return_url, suppress_navigation, view_url].hash
+      [begin_on_tagger, return_url, suppress_navigation, view_url].hash
     end
 
     # Builds the object from hash

data/lib/docusign_esign/models/credit_card_information.rb

@@ -12,7 +12,9 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+  # This object contains information about a credit card that is associated with an account.
   class CreditCardInformation
+    # A complex element containing the credit card billing address information.
     attr_accessor :address
 
     #