docusign_esign 2.11.0 → 3.0.0.rc1

data/lib/docusign_esign/models/recipient_names_response.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -12,6 +12,7 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_eSign
+
   class RecipientNamesResponse
     # Indicates whether email address is used by more than one user.
     attr_accessor :multiple_users
@@ -22,6 +23,7 @@ module DocuSign_eSign
     # 
     attr_accessor :reserved_recipient_email
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +48,7 @@ module DocuSign_eSign
       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 }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'multipleUsers')
         self.multiple_users = attributes[:'multipleUsers']
@@ -61,19 +63,20 @@ module DocuSign_eSign
       if attributes.has_key?(:'reservedRecipientEmail')
         self.reserved_recipient_email = attributes[:'reservedRecipientEmail']
       end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return 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
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -105,10 +108,10 @@ module DocuSign_eSign
       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
+          # check to ensure the input is an array given that the 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) })
+            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]]))
@@ -190,7 +193,7 @@ module DocuSign_eSign
     # @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) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -203,4 +206,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipient_phone_authentication.rb

@@ -3,7 +3,7 @@
 
 #The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
 
-OpenAPI spec version: v2
+OpenAPI spec version: v2.1
 Contact: devcenter@docusign.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -17,22 +17,35 @@ module DocuSign_eSign
     # Boolean. When set to **true**, the recipient can supply a phone number their choice.
     attr_accessor :recip_may_provide_number
 
+    attr_accessor :recip_may_provide_number_metadata
+
     # Reserved.
     attr_accessor :record_voice_print
 
+    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
 
+    attr_accessor :sender_provided_numbers_metadata
+
     #  Reserved.
     attr_accessor :validate_recip_provided_number
 
+    attr_accessor :validate_recip_provided_number_metadata
+
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'recip_may_provide_number' => :'recipMayProvideNumber',
+        :'recip_may_provide_number_metadata' => :'recipMayProvideNumberMetadata',
         :'record_voice_print' => :'recordVoicePrint',
+        :'record_voice_print_metadata' => :'recordVoicePrintMetadata',
         :'sender_provided_numbers' => :'senderProvidedNumbers',
-        :'validate_recip_provided_number' => :'validateRecipProvidedNumber'
+        :'sender_provided_numbers_metadata' => :'senderProvidedNumbersMetadata',
+        :'validate_recip_provided_number' => :'validateRecipProvidedNumber',
+        :'validate_recip_provided_number_metadata' => :'validateRecipProvidedNumberMetadata'
       }
     end
 
@@ -40,9 +53,13 @@ module DocuSign_eSign
     def self.swagger_types
       {
         :'recip_may_provide_number' => :'String',
+        :'recip_may_provide_number_metadata' => :'PropertyMetadata',
         :'record_voice_print' => :'String',
+        :'record_voice_print_metadata' => :'PropertyMetadata',
         :'sender_provided_numbers' => :'Array<String>',
-        :'validate_recip_provided_number' => :'String'
+        :'sender_provided_numbers_metadata' => :'PropertyMetadata',
+        :'validate_recip_provided_number' => :'String',
+        :'validate_recip_provided_number_metadata' => :'PropertyMetadata'
       }
     end
 
@@ -52,38 +69,55 @@ module DocuSign_eSign
       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 }
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
       if attributes.has_key?(:'recipMayProvideNumber')
         self.recip_may_provide_number = attributes[:'recipMayProvideNumber']
       end
 
+      if attributes.has_key?(:'recipMayProvideNumberMetadata')
+        self.recip_may_provide_number_metadata = attributes[:'recipMayProvideNumberMetadata']
+      end
+
       if attributes.has_key?(:'recordVoicePrint')
         self.record_voice_print = attributes[:'recordVoicePrint']
       end
 
+      if attributes.has_key?(:'recordVoicePrintMetadata')
+        self.record_voice_print_metadata = attributes[:'recordVoicePrintMetadata']
+      end
+
       if attributes.has_key?(:'senderProvidedNumbers')
         if (value = attributes[:'senderProvidedNumbers']).is_a?(Array)
           self.sender_provided_numbers = value
         end
       end
 
+      if attributes.has_key?(:'senderProvidedNumbersMetadata')
+        self.sender_provided_numbers_metadata = attributes[:'senderProvidedNumbersMetadata']
+      end
+
       if attributes.has_key?(:'validateRecipProvidedNumber')
         self.validate_recip_provided_number = attributes[:'validateRecipProvidedNumber']
       end
+
+      if attributes.has_key?(:'validateRecipProvidedNumberMetadata')
+        self.validate_recip_provided_number_metadata = attributes[:'validateRecipProvidedNumberMetadata']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
+    # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      invalid_properties
+      return 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
+      return true
     end
 
     # Checks equality by comparing each attribute.
@@ -92,9 +126,13 @@ module DocuSign_eSign
       return true if self.equal?(o)
       self.class == o.class &&
           recip_may_provide_number == o.recip_may_provide_number &&
+          recip_may_provide_number_metadata == o.recip_may_provide_number_metadata &&
           record_voice_print == o.record_voice_print &&
+          record_voice_print_metadata == o.record_voice_print_metadata &&
           sender_provided_numbers == o.sender_provided_numbers &&
-          validate_recip_provided_number == o.validate_recip_provided_number
+          sender_provided_numbers_metadata == o.sender_provided_numbers_metadata &&
+          validate_recip_provided_number == o.validate_recip_provided_number &&
+          validate_recip_provided_number_metadata == o.validate_recip_provided_number_metadata
     end
 
     # @see the `==` method
@@ -106,7 +144,7 @@ module DocuSign_eSign
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [recip_may_provide_number, record_voice_print, sender_provided_numbers, validate_recip_provided_number].hash
+      [recip_may_provide_number, recip_may_provide_number_metadata, record_voice_print, record_voice_print_metadata, sender_provided_numbers, sender_provided_numbers_metadata, validate_recip_provided_number, validate_recip_provided_number_metadata].hash
     end
 
     # Builds the object from hash
@@ -116,10 +154,10 @@ module DocuSign_eSign
       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
+          # check to ensure the input is an array given that the 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) })
+            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]]))
@@ -201,7 +239,7 @@ module DocuSign_eSign
     # @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) }
+        value.compact.map{ |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -214,4 +252,5 @@ module DocuSign_eSign
     end
 
   end
+
 end

data/lib/docusign_esign/models/recipient_preview_request.rb

@@ -0,0 +1,278 @@
+=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 RecipientPreviewRequest
+    # 
+    attr_accessor :assertion_id
+
+    # 
+    attr_accessor :authentication_instant
+
+    # 
+    attr_accessor :authentication_method
+
+    # 
+    attr_accessor :ping_frequency
+
+    # 
+    attr_accessor :ping_url
+
+    # Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
+    attr_accessor :recipient_id
+
+    # 
+    attr_accessor :return_url
+
+    # 
+    attr_accessor :security_domain
+
+    # 
+    attr_accessor :x_frame_options
+
+    # 
+    attr_accessor :x_frame_options_allow_from_url
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'assertion_id' => :'assertionId',
+        :'authentication_instant' => :'authenticationInstant',
+        :'authentication_method' => :'authenticationMethod',
+        :'ping_frequency' => :'pingFrequency',
+        :'ping_url' => :'pingUrl',
+        :'recipient_id' => :'recipientId',
+        :'return_url' => :'returnUrl',
+        :'security_domain' => :'securityDomain',
+        :'x_frame_options' => :'xFrameOptions',
+        :'x_frame_options_allow_from_url' => :'xFrameOptionsAllowFromUrl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'assertion_id' => :'String',
+        :'authentication_instant' => :'String',
+        :'authentication_method' => :'String',
+        :'ping_frequency' => :'String',
+        :'ping_url' => :'String',
+        :'recipient_id' => :'String',
+        :'return_url' => :'String',
+        :'security_domain' => :'String',
+        :'x_frame_options' => :'String',
+        :'x_frame_options_allow_from_url' => :'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?(:'assertionId')
+        self.assertion_id = attributes[:'assertionId']
+      end
+
+      if attributes.has_key?(:'authenticationInstant')
+        self.authentication_instant = attributes[:'authenticationInstant']
+      end
+
+      if attributes.has_key?(:'authenticationMethod')
+        self.authentication_method = attributes[:'authenticationMethod']
+      end
+
+      if attributes.has_key?(:'pingFrequency')
+        self.ping_frequency = attributes[:'pingFrequency']
+      end
+
+      if attributes.has_key?(:'pingUrl')
+        self.ping_url = attributes[:'pingUrl']
+      end
+
+      if attributes.has_key?(:'recipientId')
+        self.recipient_id = attributes[:'recipientId']
+      end
+
+      if attributes.has_key?(:'returnUrl')
+        self.return_url = attributes[:'returnUrl']
+      end
+
+      if attributes.has_key?(:'securityDomain')
+        self.security_domain = attributes[:'securityDomain']
+      end
+
+      if attributes.has_key?(:'xFrameOptions')
+        self.x_frame_options = attributes[:'xFrameOptions']
+      end
+
+      if attributes.has_key?(:'xFrameOptionsAllowFromUrl')
+        self.x_frame_options_allow_from_url = attributes[:'xFrameOptionsAllowFromUrl']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          assertion_id == o.assertion_id &&
+          authentication_instant == o.authentication_instant &&
+          authentication_method == o.authentication_method &&
+          ping_frequency == o.ping_frequency &&
+          ping_url == o.ping_url &&
+          recipient_id == o.recipient_id &&
+          return_url == o.return_url &&
+          security_domain == o.security_domain &&
+          x_frame_options == o.x_frame_options &&
+          x_frame_options_allow_from_url == o.x_frame_options_allow_from_url
+    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
+      [assertion_id, authentication_instant, authentication_method, ping_frequency, ping_url, recipient_id, return_url, security_domain, x_frame_options, x_frame_options_allow_from_url].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 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