docraptor 2.0.0 → 3.1.0

data/lib/docraptor/models/doc.rb

@@ -3,14 +3,15 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
 require 'date'
+require 'time'
 
 module DocRaptor
   class Doc
@@ -109,21 +110,26 @@ module DocRaptor
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'name' => :'String',
         :'document_type' => :'String',
         :'document_content' => :'String',
         :'document_url' => :'String',
-        :'test' => :'BOOLEAN',
+        :'test' => :'Boolean',
         :'pipeline' => :'String',
         :'strict' => :'String',
-        :'ignore_resource_errors' => :'BOOLEAN',
-        :'ignore_console_messages' => :'BOOLEAN',
+        :'ignore_resource_errors' => :'Boolean',
+        :'ignore_console_messages' => :'Boolean',
         :'tag' => :'String',
-        :'help' => :'BOOLEAN',
-        :'javascript' => :'BOOLEAN',
+        :'help' => :'Boolean',
+        :'javascript' => :'Boolean',
         :'referrer' => :'String',
         :'callback_url' => :'String',
         :'hosted_download_limit' => :'Integer',
@@ -132,89 +138,102 @@ module DocRaptor
       }
     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 `DocRaptor::Doc` 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 `DocRaptor::Doc`. 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?(:'name')
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'document_type')
+      if attributes.key?(:'document_type')
         self.document_type = attributes[:'document_type']
       end
 
-      if attributes.has_key?(:'document_content')
+      if attributes.key?(:'document_content')
         self.document_content = attributes[:'document_content']
       end
 
-      if attributes.has_key?(:'document_url')
+      if attributes.key?(:'document_url')
         self.document_url = attributes[:'document_url']
       end
 
-      if attributes.has_key?(:'test')
+      if attributes.key?(:'test')
         self.test = attributes[:'test']
       else
         self.test = true
       end
 
-      if attributes.has_key?(:'pipeline')
+      if attributes.key?(:'pipeline')
         self.pipeline = attributes[:'pipeline']
       end
 
-      if attributes.has_key?(:'strict')
+      if attributes.key?(:'strict')
         self.strict = attributes[:'strict']
       end
 
-      if attributes.has_key?(:'ignore_resource_errors')
+      if attributes.key?(:'ignore_resource_errors')
         self.ignore_resource_errors = attributes[:'ignore_resource_errors']
       else
         self.ignore_resource_errors = true
       end
 
-      if attributes.has_key?(:'ignore_console_messages')
+      if attributes.key?(:'ignore_console_messages')
         self.ignore_console_messages = attributes[:'ignore_console_messages']
       else
         self.ignore_console_messages = false
       end
 
-      if attributes.has_key?(:'tag')
+      if attributes.key?(:'tag')
         self.tag = attributes[:'tag']
       end
 
-      if attributes.has_key?(:'help')
+      if attributes.key?(:'help')
         self.help = attributes[:'help']
       else
         self.help = false
       end
 
-      if attributes.has_key?(:'javascript')
+      if attributes.key?(:'javascript')
         self.javascript = attributes[:'javascript']
       else
         self.javascript = false
       end
 
-      if attributes.has_key?(:'referrer')
+      if attributes.key?(:'referrer')
         self.referrer = attributes[:'referrer']
       end
 
-      if attributes.has_key?(:'callback_url')
+      if attributes.key?(:'callback_url')
         self.callback_url = attributes[:'callback_url']
       end
 
-      if attributes.has_key?(:'hosted_download_limit')
+      if attributes.key?(:'hosted_download_limit')
         self.hosted_download_limit = attributes[:'hosted_download_limit']
       end
 
-      if attributes.has_key?(:'hosted_expires_at')
+      if attributes.key?(:'hosted_expires_at')
         self.hosted_expires_at = attributes[:'hosted_expires_at']
       end
 
-      if attributes.has_key?(:'prince_options')
+      if attributes.key?(:'prince_options')
         self.prince_options = attributes[:'prince_options']
       end
     end
@@ -231,10 +250,6 @@ module DocRaptor
         invalid_properties.push('invalid value for "document_type", document_type cannot be nil.')
       end
 
-      if @document_content.nil?
-        invalid_properties.push('invalid value for "document_content", document_content cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -243,10 +258,9 @@ module DocRaptor
     def valid?
       return false if @name.nil?
       return false if @document_type.nil?
-      document_type_validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
+      document_type_validator = EnumAttributeValidator.new('String', ["pdf", "xls", "xlsx"])
       return false unless document_type_validator.valid?(@document_type)
-      return false if @document_content.nil?
-      strict_validator = EnumAttributeValidator.new('String', ['none', 'html'])
+      strict_validator = EnumAttributeValidator.new('String', ["none", "html"])
       return false unless strict_validator.valid?(@strict)
       true
     end
@@ -254,9 +268,9 @@ module DocRaptor
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] document_type Object to be assigned
     def document_type=(document_type)
-      validator = EnumAttributeValidator.new('String', ['pdf', 'xls', 'xlsx'])
+      validator = EnumAttributeValidator.new('String', ["pdf", "xls", "xlsx"])
       unless validator.valid?(document_type)
-        fail ArgumentError, 'invalid value for "document_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"document_type\", must be one of #{validator.allowable_values}."
       end
       @document_type = document_type
     end
@@ -264,9 +278,9 @@ module DocRaptor
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] strict Object to be assigned
     def strict=(strict)
-      validator = EnumAttributeValidator.new('String', ['none', 'html'])
+      validator = EnumAttributeValidator.new('String', ["none", "html"])
       unless validator.valid?(strict)
-        fail ArgumentError, 'invalid value for "strict", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"strict\", must be one of #{validator.allowable_values}."
       end
       @strict = strict
     end
@@ -302,18 +316,28 @@ module DocRaptor
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [name, document_type, document_content, document_url, test, pipeline, strict, ignore_resource_errors, ignore_console_messages, tag, help, javascript, referrer, callback_url, hosted_download_limit, hosted_expires_at, prince_options].hash
     end
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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)
@@ -321,7 +345,7 @@ module DocRaptor
           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
       end
 
       self
@@ -333,8 +357,8 @@ module DocRaptor
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -343,7 +367,7 @@ module DocRaptor
         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
@@ -364,8 +388,9 @@ module DocRaptor
           end
         end
       else # model
-        temp_model = DocRaptor.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = DocRaptor.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -387,7 +412,11 @@ module DocRaptor
       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
@@ -412,4 +441,5 @@ module DocRaptor
     end
 
   end
+
 end

data/lib/docraptor/models/doc_status.rb

@@ -3,14 +3,15 @@
 
 #A native client library for the DocRaptor HTML to PDF/XLS service.
 
-OpenAPI spec version: 1.4.0
+The version of the OpenAPI document: 2.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.19
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
 require 'date'
+require 'time'
 
 module DocRaptor
   class DocStatus
@@ -44,8 +45,13 @@ module DocRaptor
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'status' => :'String',
         :'download_url' => :'String',
@@ -56,35 +62,48 @@ module DocRaptor
       }
     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 `DocRaptor::DocStatus` 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 `DocRaptor::DocStatus`. 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?(:'status')
+      if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
 
-      if attributes.has_key?(:'download_url')
+      if attributes.key?(:'download_url')
         self.download_url = attributes[:'download_url']
       end
 
-      if attributes.has_key?(:'download_id')
+      if attributes.key?(:'download_id')
         self.download_id = attributes[:'download_id']
       end
 
-      if attributes.has_key?(:'message')
+      if attributes.key?(:'message')
         self.message = attributes[:'message']
       end
 
-      if attributes.has_key?(:'number_of_pages')
+      if attributes.key?(:'number_of_pages')
         self.number_of_pages = attributes[:'number_of_pages']
       end
 
-      if attributes.has_key?(:'validation_errors')
+      if attributes.key?(:'validation_errors')
         self.validation_errors = attributes[:'validation_errors']
       end
     end
@@ -122,18 +141,28 @@ module DocRaptor
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [status, download_url, download_id, message, number_of_pages, validation_errors].hash
     end
 
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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)
@@ -141,7 +170,7 @@ module DocRaptor
           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
       end
 
       self
@@ -153,8 +182,8 @@ module DocRaptor
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -163,7 +192,7 @@ module DocRaptor
         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
@@ -184,8 +213,9 @@ module DocRaptor
           end
         end
       else # model
-        temp_model = DocRaptor.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = DocRaptor.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -207,7 +237,11 @@ module DocRaptor
       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
@@ -232,4 +266,5 @@ module DocRaptor
     end
 
   end
+
 end