docspring 1.4.0 → 2.0.0

data/lib/docspring/models/create_submission_data_request_data.rb

@@ -3,40 +3,41 @@
 
 #DocSpring is a service that helps you fill out and sign PDF templates.
 
-OpenAPI spec version: v1
+The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.0
+Generator version: 7.11.0
 
 =end
 
 require 'date'
+require 'time'
 
 module DocSpring
   class CreateSubmissionDataRequestData
-    attr_accessor :auth_type
+    attr_accessor :auth_phone_number_hash
 
-    attr_accessor :metadata
+    attr_accessor :auth_provider
 
     attr_accessor :auth_second_factor_type
 
-    attr_accessor :auth_phone_number_hash
+    attr_accessor :auth_session_id_hash
 
     attr_accessor :auth_session_started_at
 
-    attr_accessor :auth_user_id_hash
+    attr_accessor :auth_type
 
-    attr_accessor :auth_session_id_hash
+    attr_accessor :auth_user_id_hash
 
     attr_accessor :auth_username_hash
 
-    attr_accessor :name
+    attr_accessor :email
 
     attr_accessor :fields
 
-    attr_accessor :auth_provider
+    attr_accessor :metadata
 
-    attr_accessor :email
+    attr_accessor :name
 
     attr_accessor :order
 
@@ -65,100 +66,131 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'auth_type' => :'auth_type',
-        :'metadata' => :'metadata',
-        :'auth_second_factor_type' => :'auth_second_factor_type',
         :'auth_phone_number_hash' => :'auth_phone_number_hash',
+        :'auth_provider' => :'auth_provider',
+        :'auth_second_factor_type' => :'auth_second_factor_type',
+        :'auth_session_id_hash' => :'auth_session_id_hash',
         :'auth_session_started_at' => :'auth_session_started_at',
+        :'auth_type' => :'auth_type',
         :'auth_user_id_hash' => :'auth_user_id_hash',
-        :'auth_session_id_hash' => :'auth_session_id_hash',
         :'auth_username_hash' => :'auth_username_hash',
-        :'name' => :'name',
-        :'fields' => :'fields',
-        :'auth_provider' => :'auth_provider',
         :'email' => :'email',
+        :'fields' => :'fields',
+        :'metadata' => :'metadata',
+        :'name' => :'name',
         :'order' => :'order'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'auth_type' => :'String',
-        :'metadata' => :'Object',
-        :'auth_second_factor_type' => :'String',
         :'auth_phone_number_hash' => :'String',
+        :'auth_provider' => :'String',
+        :'auth_second_factor_type' => :'String',
+        :'auth_session_id_hash' => :'String',
         :'auth_session_started_at' => :'String',
+        :'auth_type' => :'String',
         :'auth_user_id_hash' => :'String',
-        :'auth_session_id_hash' => :'String',
         :'auth_username_hash' => :'String',
-        :'name' => :'String',
-        :'fields' => :'Array<String>',
-        :'auth_provider' => :'String',
         :'email' => :'String',
+        :'fields' => :'Array<String>',
+        :'metadata' => :'Object',
+        :'name' => :'String',
         :'order' => :'Integer'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'auth_phone_number_hash',
+        :'auth_provider',
+        :'auth_session_id_hash',
+        :'auth_session_started_at',
+        :'auth_user_id_hash',
+        :'auth_username_hash',
+        :'email',
+        :'fields',
+        :'name',
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::CreateSubmissionDataRequestData` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DocSpring::CreateSubmissionDataRequestData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'auth_type')
-        self.auth_type = attributes[:'auth_type']
+      if attributes.key?(:'auth_phone_number_hash')
+        self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
       end
 
-      if attributes.has_key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.key?(:'auth_provider')
+        self.auth_provider = attributes[:'auth_provider']
       end
 
-      if attributes.has_key?(:'auth_second_factor_type')
+      if attributes.key?(:'auth_second_factor_type')
         self.auth_second_factor_type = attributes[:'auth_second_factor_type']
       end
 
-      if attributes.has_key?(:'auth_phone_number_hash')
-        self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
+      if attributes.key?(:'auth_session_id_hash')
+        self.auth_session_id_hash = attributes[:'auth_session_id_hash']
       end
 
-      if attributes.has_key?(:'auth_session_started_at')
+      if attributes.key?(:'auth_session_started_at')
         self.auth_session_started_at = attributes[:'auth_session_started_at']
       end
 
-      if attributes.has_key?(:'auth_user_id_hash')
-        self.auth_user_id_hash = attributes[:'auth_user_id_hash']
+      if attributes.key?(:'auth_type')
+        self.auth_type = attributes[:'auth_type']
+      else
+        self.auth_type = nil
       end
 
-      if attributes.has_key?(:'auth_session_id_hash')
-        self.auth_session_id_hash = attributes[:'auth_session_id_hash']
+      if attributes.key?(:'auth_user_id_hash')
+        self.auth_user_id_hash = attributes[:'auth_user_id_hash']
       end
 
-      if attributes.has_key?(:'auth_username_hash')
+      if attributes.key?(:'auth_username_hash')
         self.auth_username_hash = attributes[:'auth_username_hash']
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
       end
 
-      if attributes.has_key?(:'fields')
+      if attributes.key?(:'fields')
         if (value = attributes[:'fields']).is_a?(Array)
           self.fields = value
         end
       end
 
-      if attributes.has_key?(:'auth_provider')
-        self.auth_provider = attributes[:'auth_provider']
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'email')
-        self.email = attributes[:'email']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'order')
+      if attributes.key?(:'order')
         self.order = attributes[:'order']
       end
     end
@@ -166,57 +198,64 @@ module DocSpring
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @auth_type.nil?
+        invalid_properties.push('invalid value for "auth_type", auth_type cannot be nil.')
+      end
+
       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?
-      auth_type_validator = EnumAttributeValidator.new('String', ['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml'])
-      return false unless auth_type_validator.valid?(@auth_type)
-      auth_second_factor_type_validator = EnumAttributeValidator.new('String', ['none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint'])
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      auth_second_factor_type_validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
       return false unless auth_second_factor_type_validator.valid?(@auth_second_factor_type)
+      return false if @auth_type.nil?
+      auth_type_validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
+      return false unless auth_type_validator.valid?(@auth_type)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] auth_type Object to be assigned
-    def auth_type=(auth_type)
-      validator = EnumAttributeValidator.new('String', ['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml'])
-      unless validator.valid?(auth_type)
-        fail ArgumentError, 'invalid value for "auth_type", must be one of #{validator.allowable_values}.'
-      end
-      @auth_type = auth_type
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] auth_second_factor_type Object to be assigned
     def auth_second_factor_type=(auth_second_factor_type)
-      validator = EnumAttributeValidator.new('String', ['none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint'])
+      validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
       unless validator.valid?(auth_second_factor_type)
-        fail ArgumentError, 'invalid value for "auth_second_factor_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"auth_second_factor_type\", must be one of #{validator.allowable_values}."
       end
       @auth_second_factor_type = auth_second_factor_type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] auth_type Object to be assigned
+    def auth_type=(auth_type)
+      validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
+      unless validator.valid?(auth_type)
+        fail ArgumentError, "invalid value for \"auth_type\", must be one of #{validator.allowable_values}."
+      end
+      @auth_type = auth_type
+    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 &&
-          auth_type == o.auth_type &&
-          metadata == o.metadata &&
-          auth_second_factor_type == o.auth_second_factor_type &&
           auth_phone_number_hash == o.auth_phone_number_hash &&
+          auth_provider == o.auth_provider &&
+          auth_second_factor_type == o.auth_second_factor_type &&
+          auth_session_id_hash == o.auth_session_id_hash &&
           auth_session_started_at == o.auth_session_started_at &&
+          auth_type == o.auth_type &&
           auth_user_id_hash == o.auth_user_id_hash &&
-          auth_session_id_hash == o.auth_session_id_hash &&
           auth_username_hash == o.auth_username_hash &&
-          name == o.name &&
-          fields == o.fields &&
-          auth_provider == o.auth_provider &&
           email == o.email &&
+          fields == o.fields &&
+          metadata == o.metadata &&
+          name == o.name &&
           order == o.order
     end
 
@@ -227,39 +266,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [auth_type, metadata, auth_second_factor_type, auth_phone_number_hash, auth_session_started_at, auth_user_id_hash, auth_session_id_hash, auth_username_hash, name, fields, auth_provider, email, order].hash
+      [auth_phone_number_hash, auth_provider, auth_second_factor_type, auth_session_id_hash, auth_session_started_at, auth_type, auth_user_id_hash, auth_username_hash, email, fields, metadata, name, order].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)
+    def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     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)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -268,7 +310,7 @@ module DocSpring
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -289,8 +331,9 @@ module DocSpring
           end
         end
       else # model
-        temp_model = DocSpring.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = DocSpring.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -312,7 +355,11 @@ module DocSpring
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -335,5 +382,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end