docspring 1.4.0 → 2.0.0

data/lib/docspring/models/submission_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 SubmissionData
@@ -20,8 +21,6 @@ module DocSpring
 
     attr_accessor :data_requests
 
-    attr_accessor :field_overrides
-
     attr_accessor :html
 
     attr_accessor :metadata
@@ -34,61 +33,75 @@ module DocSpring
         :'css' => :'css',
         :'data' => :'data',
         :'data_requests' => :'data_requests',
-        :'field_overrides' => :'field_overrides',
         :'html' => :'html',
         :'metadata' => :'metadata',
         :'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
       {
         :'css' => :'String',
         :'data' => :'Object',
         :'data_requests' => :'Array<CreateSubmissionDataRequestData>',
-        :'field_overrides' => :'Object',
         :'html' => :'String',
         :'metadata' => :'Object',
-        :'test' => :'BOOLEAN'
+        :'test' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SubmissionData` 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::SubmissionData`. 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?(:'css')
+      if attributes.key?(:'css')
         self.css = attributes[:'css']
       end
 
-      if attributes.has_key?(:'data')
+      if attributes.key?(:'data')
         self.data = attributes[:'data']
+      else
+        self.data = nil
       end
 
-      if attributes.has_key?(:'data_requests')
+      if attributes.key?(:'data_requests')
         if (value = attributes[:'data_requests']).is_a?(Array)
           self.data_requests = value
         end
       end
 
-      if attributes.has_key?(:'field_overrides')
-        self.field_overrides = attributes[:'field_overrides']
-      end
-
-      if attributes.has_key?(:'html')
+      if attributes.key?(:'html')
         self.html = attributes[:'html']
       end
 
-      if attributes.has_key?(:'metadata')
+      if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'test')
+      if attributes.key?(:'test')
         self.test = attributes[:'test']
       end
     end
@@ -96,6 +109,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 @data.nil?
         invalid_properties.push('invalid value for "data", data cannot be nil.')
@@ -107,6 +121,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 @data.nil?
       true
     end
@@ -119,7 +134,6 @@ module DocSpring
           css == o.css &&
           data == o.data &&
           data_requests == o.data_requests &&
-          field_overrides == o.field_overrides &&
           html == o.html &&
           metadata == o.metadata &&
           test == o.test
@@ -132,39 +146,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [css, data, data_requests, field_overrides, html, metadata, test].hash
+      [css, data, data_requests, html, metadata, 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
@@ -173,7 +190,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
@@ -194,8 +211,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
 
@@ -217,7 +235,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
@@ -240,5 +262,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end

data/lib/docspring/models/submission_data_batch_request.rb

@@ -3,96 +3,136 @@
 
 #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 SubmissionDataBatchRequest
     attr_accessor :css
 
-    attr_accessor :metadata
-
     attr_accessor :data
 
-    attr_accessor :test
-
     attr_accessor :html
 
+    attr_accessor :metadata
+
     attr_accessor :template_id
 
+    attr_accessor :template_version
+
+    attr_accessor :test
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'css' => :'css',
-        :'metadata' => :'metadata',
         :'data' => :'data',
-        :'test' => :'test',
         :'html' => :'html',
-        :'template_id' => :'template_id'
+        :'metadata' => :'metadata',
+        :'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
       {
         :'css' => :'String',
-        :'metadata' => :'Object',
         :'data' => :'Object',
-        :'test' => :'BOOLEAN',
         :'html' => :'String',
-        :'template_id' => :'String'
+        :'metadata' => :'Object',
+        :'template_id' => :'String',
+        :'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::SubmissionDataBatchRequest` 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::SubmissionDataBatchRequest`. 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?(:'css')
+      if attributes.key?(:'css')
         self.css = attributes[:'css']
       end
 
-      if attributes.has_key?(:'metadata')
-        self.metadata = attributes[:'metadata']
-      end
-
-      if attributes.has_key?(:'data')
+      if attributes.key?(:'data')
         self.data = attributes[:'data']
+      else
+        self.data = nil
       end
 
-      if attributes.has_key?(:'test')
-        self.test = attributes[:'test']
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
       end
 
-      if attributes.has_key?(:'html')
-        self.html = attributes[:'html']
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'template_id')
+      if attributes.key?(:'template_id')
         self.template_id = attributes[:'template_id']
+      else
+        self.template_id = nil
+      end
+
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      end
+
+      if attributes.key?(:'test')
+        self.test = attributes[:'test']
       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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @data.nil?
       true
     end
 
@@ -102,11 +142,12 @@ module DocSpring
       return true if self.equal?(o)
       self.class == o.class &&
           css == o.css &&
-          metadata == o.metadata &&
           data == o.data &&
-          test == o.test &&
           html == o.html &&
-          template_id == o.template_id
+          metadata == o.metadata &&
+          template_id == o.template_id &&
+          template_version == o.template_version &&
+          test == o.test
     end
 
     # @see the `==` method
@@ -116,39 +157,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [css, metadata, data, test, html, template_id].hash
+      [css, data, html, metadata, 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
@@ -157,7 +201,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
@@ -178,8 +222,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
 
@@ -201,7 +246,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
@@ -224,5 +273,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end