docspring 1.4.0 → 2.0.0

data/lib/docspring/models/submission.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 Submission
@@ -99,14 +100,19 @@ module DocSpring
       }
     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',
         :'template_id' => :'String',
-        :'test' => :'BOOLEAN',
-        :'editable' => :'BOOLEAN',
-        :'expired' => :'BOOLEAN',
+        :'test' => :'Boolean',
+        :'editable' => :'Boolean',
+        :'expired' => :'Boolean',
         :'expires_at' => :'String',
         :'processed_at' => :'String',
         :'state' => :'String',
@@ -124,91 +130,122 @@ module DocSpring
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'editable',
+        :'expires_at',
+        :'processed_at',
+        :'data',
+        :'pdf_hash',
+        :'download_url',
+        :'permanent_download_url',
+        :'batch_id',
+        :'source',
+        :'referrer'
+      ])
+    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::Submission` 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::Submission`. 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?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = 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?(:'test')
         self.test = attributes[:'test']
+      else
+        self.test = nil
       end
 
-      if attributes.has_key?(:'editable')
+      if attributes.key?(:'editable')
         self.editable = attributes[:'editable']
       end
 
-      if attributes.has_key?(:'expired')
+      if attributes.key?(:'expired')
         self.expired = attributes[:'expired']
+      else
+        self.expired = nil
       end
 
-      if attributes.has_key?(:'expires_at')
+      if attributes.key?(:'expires_at')
         self.expires_at = attributes[:'expires_at']
       end
 
-      if attributes.has_key?(:'processed_at')
+      if attributes.key?(:'processed_at')
         self.processed_at = attributes[:'processed_at']
       end
 
-      if attributes.has_key?(:'state')
+      if attributes.key?(:'state')
         self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
-      if attributes.has_key?(:'data')
+      if attributes.key?(:'data')
         self.data = attributes[:'data']
       end
 
-      if attributes.has_key?(:'metadata')
+      if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
-      if attributes.has_key?(:'truncated_text')
+      if attributes.key?(:'truncated_text')
         self.truncated_text = attributes[:'truncated_text']
       end
 
-      if attributes.has_key?(:'pdf_hash')
+      if attributes.key?(:'pdf_hash')
         self.pdf_hash = attributes[:'pdf_hash']
       end
 
-      if attributes.has_key?(:'download_url')
+      if attributes.key?(:'download_url')
         self.download_url = attributes[:'download_url']
       end
 
-      if attributes.has_key?(:'permanent_download_url')
+      if attributes.key?(:'permanent_download_url')
         self.permanent_download_url = attributes[:'permanent_download_url']
       end
 
-      if attributes.has_key?(:'batch_id')
+      if attributes.key?(:'batch_id')
         self.batch_id = attributes[:'batch_id']
       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?(:'actions')
+      if attributes.key?(:'actions')
         if (value = attributes[:'actions']).is_a?(Array)
           self.actions = value
         end
       end
 
-      if attributes.has_key?(:'source')
+      if attributes.key?(:'source')
         self.source = attributes[:'source']
       end
 
-      if attributes.has_key?(:'referrer')
+      if attributes.key?(:'referrer')
         self.referrer = attributes[:'referrer']
       end
     end
@@ -216,6 +253,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 @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
@@ -239,11 +277,12 @@ 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 @id.nil?
       return false if @test.nil?
       return false if @expired.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental'])
+      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "account_suspended", "license_revoked", "accidental"])
       return false unless state_validator.valid?(@state)
       true
     end
@@ -251,9 +290,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'invalid_data', 'error', 'image_download_failed', 'image_processing_failed', 'waiting_for_data_requests', 'syntax_error', 'account_suspended', 'license_revoked', 'accidental'])
+      validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "account_suspended", "license_revoked", "accidental"])
       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
@@ -291,7 +330,7 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, template_id, test, editable, expired, expires_at, processed_at, state, data, metadata, truncated_text, pdf_hash, download_url, permanent_download_url, batch_id, data_requests, actions, source, referrer].hash
     end
@@ -299,31 +338,34 @@ module DocSpring
     # 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
@@ -332,7 +374,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
@@ -353,8 +395,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
 
@@ -376,7 +419,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
@@ -399,5 +446,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end

data/lib/docspring/models/submission_action.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 SubmissionAction
@@ -60,6 +61,11 @@ module DocSpring
       }
     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
       {
@@ -72,42 +78,69 @@ module DocSpring
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'integration_id',
+      ])
+    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::SubmissionAction` 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::SubmissionAction`. 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?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.has_key?(:'integration_id')
+      if attributes.key?(:'integration_id')
         self.integration_id = attributes[:'integration_id']
+      else
+        self.integration_id = nil
       end
 
-      if attributes.has_key?(:'state')
+      if attributes.key?(:'state')
         self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
-      if attributes.has_key?(:'action_category')
+      if attributes.key?(:'action_category')
         self.action_category = attributes[:'action_category']
+      else
+        self.action_category = nil
       end
 
-      if attributes.has_key?(:'action_type')
+      if attributes.key?(:'action_type')
         self.action_type = attributes[:'action_type']
+      else
+        self.action_type = nil
       end
 
-      if attributes.has_key?(:'result_data')
+      if attributes.key?(:'result_data')
         self.result_data = attributes[:'result_data']
+      else
+        self.result_data = nil
       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.')
@@ -135,15 +168,16 @@ 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 @id.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "failed", "error"])
       return false unless state_validator.valid?(@state)
       return false if @action_category.nil?
-      action_category_validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      action_category_validator = EnumAttributeValidator.new('String', ["notification", "file_upload"])
       return false unless action_category_validator.valid?(@action_category)
       return false if @action_type.nil?
-      action_type_validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      action_type_validator = EnumAttributeValidator.new('String', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
       return false unless action_type_validator.valid?(@action_type)
       return false if @result_data.nil?
       true
@@ -152,9 +186,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'failed', 'error'])
+      validator = EnumAttributeValidator.new('String', ["pending", "processed", "failed", "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
@@ -162,9 +196,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] action_category Object to be assigned
     def action_category=(action_category)
-      validator = EnumAttributeValidator.new('String', ['notification', 'file_upload'])
+      validator = EnumAttributeValidator.new('String', ["notification", "file_upload"])
       unless validator.valid?(action_category)
-        fail ArgumentError, 'invalid value for "action_category", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"action_category\", must be one of #{validator.allowable_values}."
       end
       @action_category = action_category
     end
@@ -172,9 +206,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] action_type Object to be assigned
     def action_type=(action_type)
-      validator = EnumAttributeValidator.new('String', ['webhook', 'slack_webhook', 'email', 'aws_s3_upload'])
+      validator = EnumAttributeValidator.new('String', ["webhook", "slack_webhook", "email", "aws_s3_upload"])
       unless validator.valid?(action_type)
-        fail ArgumentError, 'invalid value for "action_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"action_type\", must be one of #{validator.allowable_values}."
       end
       @action_type = action_type
     end
@@ -199,7 +233,7 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, integration_id, state, action_category, action_type, result_data].hash
     end
@@ -207,31 +241,34 @@ module DocSpring
     # 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
@@ -240,7 +277,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
@@ -261,8 +298,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
 
@@ -284,7 +322,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
@@ -307,5 +349,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end