docspring 1.4.1 → 2.0.0

data/lib/docspring/models/submission_batch.rb

@@ -3,34 +3,35 @@
 
 #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 SubmissionBatch
-    attr_accessor :pending_count
-
-    attr_accessor :completion_percentage
-
-    attr_accessor :metadata
+    attr_accessor :id
 
     attr_accessor :total_count
 
-    attr_accessor :submissions
+    attr_accessor :pending_count
 
-    attr_accessor :processed_at
+    attr_accessor :error_count
 
-    attr_accessor :id
+    attr_accessor :completion_percentage
 
     attr_accessor :state
 
-    attr_accessor :error_count
+    attr_accessor :processed_at
+
+    attr_accessor :metadata
+
+    attr_accessor :submissions
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -57,101 +58,173 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'total_count' => :'total_count',
         :'pending_count' => :'pending_count',
+        :'error_count' => :'error_count',
         :'completion_percentage' => :'completion_percentage',
-        :'metadata' => :'metadata',
-        :'total_count' => :'total_count',
-        :'submissions' => :'submissions',
-        :'processed_at' => :'processed_at',
-        :'id' => :'id',
         :'state' => :'state',
-        :'error_count' => :'error_count'
+        :'processed_at' => :'processed_at',
+        :'metadata' => :'metadata',
+        :'submissions' => :'submissions'
       }
     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
       {
+        :'id' => :'String',
+        :'total_count' => :'Integer',
         :'pending_count' => :'Integer',
+        :'error_count' => :'Integer',
         :'completion_percentage' => :'Integer',
-        :'metadata' => :'Object',
-        :'total_count' => :'Integer',
-        :'submissions' => :'Array<Submission>',
-        :'processed_at' => :'String',
-        :'id' => :'String',
         :'state' => :'String',
-        :'error_count' => :'Integer'
+        :'processed_at' => :'String',
+        :'metadata' => :'Object',
+        :'submissions' => :'Array<Submission>'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'processed_at',
+      ])
+    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::SubmissionBatch` 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::SubmissionBatch`. 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?(:'pending_count')
-        self.pending_count = attributes[:'pending_count']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.has_key?(:'completion_percentage')
-        self.completion_percentage = attributes[:'completion_percentage']
+      if attributes.key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      else
+        self.total_count = nil
       end
 
-      if attributes.has_key?(:'metadata')
-        self.metadata = attributes[:'metadata']
+      if attributes.key?(:'pending_count')
+        self.pending_count = attributes[:'pending_count']
+      else
+        self.pending_count = nil
       end
 
-      if attributes.has_key?(:'total_count')
-        self.total_count = attributes[:'total_count']
+      if attributes.key?(:'error_count')
+        self.error_count = attributes[:'error_count']
+      else
+        self.error_count = nil
       end
 
-      if attributes.has_key?(:'submissions')
-        if (value = attributes[:'submissions']).is_a?(Array)
-          self.submissions = value
-        end
+      if attributes.key?(:'completion_percentage')
+        self.completion_percentage = attributes[:'completion_percentage']
+      else
+        self.completion_percentage = nil
       end
 
-      if attributes.has_key?(:'processed_at')
-        self.processed_at = attributes[:'processed_at']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'processed_at')
+        self.processed_at = attributes[:'processed_at']
+      else
+        self.processed_at = nil
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      else
+        self.metadata = nil
       end
 
-      if attributes.has_key?(:'error_count')
-        self.error_count = attributes[:'error_count']
+      if attributes.key?(:'submissions')
+        if (value = attributes[:'submissions']).is_a?(Array)
+          self.submissions = value
+        end
       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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @total_count.nil?
+        invalid_properties.push('invalid value for "total_count", total_count cannot be nil.')
+      end
+
+      if @pending_count.nil?
+        invalid_properties.push('invalid value for "pending_count", pending_count cannot be nil.')
+      end
+
+      if @error_count.nil?
+        invalid_properties.push('invalid value for "error_count", error_count cannot be nil.')
+      end
+
+      if @completion_percentage.nil?
+        invalid_properties.push('invalid value for "completion_percentage", completion_percentage cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata 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?
-      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'error'])
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @total_count.nil?
+      return false if @pending_count.nil?
+      return false if @error_count.nil?
+      return false if @completion_percentage.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
       return false unless state_validator.valid?(@state)
+      return false if @metadata.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'error'])
+      validator = EnumAttributeValidator.new('String', ["pending", "processed", "error"])
       unless validator.valid?(state)
-        fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
       end
       @state = state
     end
@@ -161,15 +234,15 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          id == o.id &&
+          total_count == o.total_count &&
           pending_count == o.pending_count &&
+          error_count == o.error_count &&
           completion_percentage == o.completion_percentage &&
-          metadata == o.metadata &&
-          total_count == o.total_count &&
-          submissions == o.submissions &&
-          processed_at == o.processed_at &&
-          id == o.id &&
           state == o.state &&
-          error_count == o.error_count
+          processed_at == o.processed_at &&
+          metadata == o.metadata &&
+          submissions == o.submissions
     end
 
     # @see the `==` method
@@ -179,39 +252,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [pending_count, completion_percentage, metadata, total_count, submissions, processed_at, id, state, error_count].hash
+      [id, total_count, pending_count, error_count, completion_percentage, state, processed_at, metadata, submissions].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
@@ -220,7 +296,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
@@ -241,8 +317,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
 
@@ -264,7 +341,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
@@ -287,5 +368,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end

data/lib/docspring/models/submission_batch_data.rb

@@ -3,14 +3,15 @@
 
 #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 SubmissionBatchData
@@ -20,6 +21,8 @@ module DocSpring
 
     attr_accessor :template_id
 
+    attr_accessor :template_version
+
     attr_accessor :test
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -28,43 +31,71 @@ module DocSpring
         :'metadata' => :'metadata',
         :'submissions' => :'submissions',
         :'template_id' => :'template_id',
+        :'template_version' => :'template_version',
         :'test' => :'test'
       }
     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
       {
         :'metadata' => :'Object',
         :'submissions' => :'Array<SubmissionDataBatchRequest>',
         :'template_id' => :'String',
-        :'test' => :'BOOLEAN'
+        :'template_version' => :'String',
+        :'test' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'template_id',
+        :'template_version',
+      ])
+    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::SubmissionBatchData` 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::SubmissionBatchData`. 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?(:'metadata')
+      if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'submissions')
+      if attributes.key?(:'submissions')
         if (value = attributes[:'submissions']).is_a?(Array)
           self.submissions = value
         end
+      else
+        self.submissions = nil
       end
 
-      if attributes.has_key?(:'template_id')
+      if attributes.key?(:'template_id')
         self.template_id = attributes[:'template_id']
       end
 
-      if attributes.has_key?(:'test')
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      end
+
+      if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
     end
@@ -72,6 +103,7 @@ 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 @submissions.nil?
         invalid_properties.push('invalid value for "submissions", submissions cannot be nil.')
@@ -83,6 +115,7 @@ module DocSpring
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @submissions.nil?
       true
     end
@@ -95,6 +128,7 @@ module DocSpring
           metadata == o.metadata &&
           submissions == o.submissions &&
           template_id == o.template_id &&
+          template_version == o.template_version &&
           test == o.test
     end
 
@@ -105,39 +139,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [metadata, submissions, template_id, test].hash
+      [metadata, submissions, template_id, template_version, test].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
@@ -146,7 +183,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
@@ -167,8 +204,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
 
@@ -190,7 +228,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
@@ -213,5 +255,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end