docspring 1.4.1 → 2.0.0

data/lib/docspring/models/template.rb

@@ -3,56 +3,57 @@
 
 #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 Template
-    attr_accessor :expiration_interval
-
-    attr_accessor :webhook_url
-
-    attr_accessor :parent_folder_id
-
-    attr_accessor :expire_after
-
-    attr_accessor :allow_additional_properties
+    attr_accessor :name
 
     attr_accessor :description
 
+    attr_accessor :public_web_form
+
     attr_accessor :public_submissions
 
-    attr_accessor :slack_webhook_url
+    attr_accessor :expire_submissions
 
-    attr_accessor :path
+    attr_accessor :expire_after
 
-    attr_accessor :public_web_form
+    attr_accessor :expiration_interval
+
+    attr_accessor :allow_additional_properties
 
     attr_accessor :editable_submissions
 
-    attr_accessor :expire_submissions
+    attr_accessor :locked
 
-    attr_accessor :name
+    attr_accessor :webhook_url
 
-    attr_accessor :permanent_document_url
+    attr_accessor :slack_webhook_url
 
-    attr_accessor :template_type
+    attr_accessor :redirect_url
 
     attr_accessor :id
 
+    attr_accessor :template_type
+
     attr_accessor :page_dimensions
 
-    attr_accessor :locked
+    attr_accessor :document_url
 
-    attr_accessor :redirect_url
+    attr_accessor :permanent_document_url
 
-    attr_accessor :document_url
+    attr_accessor :path
+
+    attr_accessor :parent_folder_id
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -79,167 +80,291 @@ module DocSpring
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'expiration_interval' => :'expiration_interval',
-        :'webhook_url' => :'webhook_url',
-        :'parent_folder_id' => :'parent_folder_id',
-        :'expire_after' => :'expire_after',
-        :'allow_additional_properties' => :'allow_additional_properties',
+        :'name' => :'name',
         :'description' => :'description',
-        :'public_submissions' => :'public_submissions',
-        :'slack_webhook_url' => :'slack_webhook_url',
-        :'path' => :'path',
         :'public_web_form' => :'public_web_form',
-        :'editable_submissions' => :'editable_submissions',
+        :'public_submissions' => :'public_submissions',
         :'expire_submissions' => :'expire_submissions',
-        :'name' => :'name',
-        :'permanent_document_url' => :'permanent_document_url',
-        :'template_type' => :'template_type',
-        :'id' => :'id',
-        :'page_dimensions' => :'page_dimensions',
+        :'expire_after' => :'expire_after',
+        :'expiration_interval' => :'expiration_interval',
+        :'allow_additional_properties' => :'allow_additional_properties',
+        :'editable_submissions' => :'editable_submissions',
         :'locked' => :'locked',
+        :'webhook_url' => :'webhook_url',
+        :'slack_webhook_url' => :'slack_webhook_url',
         :'redirect_url' => :'redirect_url',
-        :'document_url' => :'document_url'
+        :'id' => :'id',
+        :'template_type' => :'template_type',
+        :'page_dimensions' => :'page_dimensions',
+        :'document_url' => :'document_url',
+        :'permanent_document_url' => :'permanent_document_url',
+        :'path' => :'path',
+        :'parent_folder_id' => :'parent_folder_id'
       }
     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
       {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'public_web_form' => :'Boolean',
+        :'public_submissions' => :'Boolean',
+        :'expire_submissions' => :'Boolean',
+        :'expire_after' => :'Float',
         :'expiration_interval' => :'String',
+        :'allow_additional_properties' => :'Boolean',
+        :'editable_submissions' => :'Boolean',
+        :'locked' => :'Boolean',
         :'webhook_url' => :'String',
-        :'parent_folder_id' => :'String',
-        :'expire_after' => :'Float',
-        :'allow_additional_properties' => :'BOOLEAN',
-        :'description' => :'String',
-        :'public_submissions' => :'BOOLEAN',
         :'slack_webhook_url' => :'String',
-        :'path' => :'String',
-        :'public_web_form' => :'BOOLEAN',
-        :'editable_submissions' => :'BOOLEAN',
-        :'expire_submissions' => :'BOOLEAN',
-        :'name' => :'String',
-        :'permanent_document_url' => :'String',
-        :'template_type' => :'String',
+        :'redirect_url' => :'String',
         :'id' => :'String',
+        :'template_type' => :'String',
         :'page_dimensions' => :'Array<Array<Float>>',
-        :'locked' => :'BOOLEAN',
-        :'redirect_url' => :'String',
-        :'document_url' => :'String'
+        :'document_url' => :'String',
+        :'permanent_document_url' => :'String',
+        :'path' => :'String',
+        :'parent_folder_id' => :'String'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'description',
+        :'webhook_url',
+        :'slack_webhook_url',
+        :'redirect_url',
+        :'page_dimensions',
+        :'document_url',
+        :'permanent_document_url',
+        :'parent_folder_id'
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
-
-      if attributes.has_key?(:'expiration_interval')
-        self.expiration_interval = attributes[:'expiration_interval']
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::Template` initialize method"
       end
 
-      if attributes.has_key?(:'webhook_url')
-        self.webhook_url = attributes[:'webhook_url']
-      end
+      # 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::Template`. 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?(:'parent_folder_id')
-        self.parent_folder_id = attributes[:'parent_folder_id']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
       end
 
-      if attributes.has_key?(:'expire_after')
-        self.expire_after = attributes[:'expire_after']
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
       end
 
-      if attributes.has_key?(:'allow_additional_properties')
-        self.allow_additional_properties = attributes[:'allow_additional_properties']
+      if attributes.key?(:'public_web_form')
+        self.public_web_form = attributes[:'public_web_form']
+      else
+        self.public_web_form = nil
       end
 
-      if attributes.has_key?(:'description')
-        self.description = attributes[:'description']
+      if attributes.key?(:'public_submissions')
+        self.public_submissions = attributes[:'public_submissions']
+      else
+        self.public_submissions = nil
       end
 
-      if attributes.has_key?(:'public_submissions')
-        self.public_submissions = attributes[:'public_submissions']
+      if attributes.key?(:'expire_submissions')
+        self.expire_submissions = attributes[:'expire_submissions']
+      else
+        self.expire_submissions = nil
       end
 
-      if attributes.has_key?(:'slack_webhook_url')
-        self.slack_webhook_url = attributes[:'slack_webhook_url']
+      if attributes.key?(:'expire_after')
+        self.expire_after = attributes[:'expire_after']
+      else
+        self.expire_after = nil
       end
 
-      if attributes.has_key?(:'path')
-        self.path = attributes[:'path']
+      if attributes.key?(:'expiration_interval')
+        self.expiration_interval = attributes[:'expiration_interval']
+      else
+        self.expiration_interval = nil
       end
 
-      if attributes.has_key?(:'public_web_form')
-        self.public_web_form = attributes[:'public_web_form']
+      if attributes.key?(:'allow_additional_properties')
+        self.allow_additional_properties = attributes[:'allow_additional_properties']
+      else
+        self.allow_additional_properties = nil
       end
 
-      if attributes.has_key?(:'editable_submissions')
+      if attributes.key?(:'editable_submissions')
         self.editable_submissions = attributes[:'editable_submissions']
+      else
+        self.editable_submissions = nil
       end
 
-      if attributes.has_key?(:'expire_submissions')
-        self.expire_submissions = attributes[:'expire_submissions']
+      if attributes.key?(:'locked')
+        self.locked = attributes[:'locked']
+      else
+        self.locked = nil
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'webhook_url')
+        self.webhook_url = attributes[:'webhook_url']
+      else
+        self.webhook_url = nil
       end
 
-      if attributes.has_key?(:'permanent_document_url')
-        self.permanent_document_url = attributes[:'permanent_document_url']
+      if attributes.key?(:'slack_webhook_url')
+        self.slack_webhook_url = attributes[:'slack_webhook_url']
+      else
+        self.slack_webhook_url = nil
       end
 
-      if attributes.has_key?(:'template_type')
-        self.template_type = attributes[:'template_type']
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      else
+        self.redirect_url = nil
       end
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.has_key?(:'page_dimensions')
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      else
+        self.template_type = nil
+      end
+
+      if attributes.key?(:'page_dimensions')
         if (value = attributes[:'page_dimensions']).is_a?(Array)
           self.page_dimensions = value
         end
+      else
+        self.page_dimensions = nil
       end
 
-      if attributes.has_key?(:'locked')
-        self.locked = attributes[:'locked']
+      if attributes.key?(:'document_url')
+        self.document_url = attributes[:'document_url']
+      else
+        self.document_url = nil
       end
 
-      if attributes.has_key?(:'redirect_url')
-        self.redirect_url = attributes[:'redirect_url']
+      if attributes.key?(:'permanent_document_url')
+        self.permanent_document_url = attributes[:'permanent_document_url']
+      else
+        self.permanent_document_url = nil
       end
 
-      if attributes.has_key?(:'document_url')
-        self.document_url = attributes[:'document_url']
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      else
+        self.path = nil
+      end
+
+      if attributes.key?(:'parent_folder_id')
+        self.parent_folder_id = attributes[:'parent_folder_id']
+      else
+        self.parent_folder_id = 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 @public_web_form.nil?
+        invalid_properties.push('invalid value for "public_web_form", public_web_form cannot be nil.')
+      end
+
+      if @public_submissions.nil?
+        invalid_properties.push('invalid value for "public_submissions", public_submissions cannot be nil.')
+      end
+
+      if @expire_submissions.nil?
+        invalid_properties.push('invalid value for "expire_submissions", expire_submissions cannot be nil.')
+      end
+
+      if @expire_after.nil?
+        invalid_properties.push('invalid value for "expire_after", expire_after cannot be nil.')
+      end
+
+      if @expiration_interval.nil?
+        invalid_properties.push('invalid value for "expiration_interval", expiration_interval cannot be nil.')
+      end
+
+      if @allow_additional_properties.nil?
+        invalid_properties.push('invalid value for "allow_additional_properties", allow_additional_properties cannot be nil.')
+      end
+
+      if @editable_submissions.nil?
+        invalid_properties.push('invalid value for "editable_submissions", editable_submissions cannot be nil.')
+      end
+
+      if @locked.nil?
+        invalid_properties.push('invalid value for "locked", locked cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
+      end
+
+      if @path.nil?
+        invalid_properties.push('invalid value for "path", path 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?
-      expiration_interval_validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days'])
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @public_web_form.nil?
+      return false if @public_submissions.nil?
+      return false if @expire_submissions.nil?
+      return false if @expire_after.nil?
+      return false if @expiration_interval.nil?
+      expiration_interval_validator = EnumAttributeValidator.new('String', ["minutes", "hours", "days"])
       return false unless expiration_interval_validator.valid?(@expiration_interval)
+      return false if @allow_additional_properties.nil?
+      return false if @editable_submissions.nil?
+      return false if @locked.nil?
+      return false if @id.nil?
+      return false if @template_type.nil?
+      return false if @path.nil?
       true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] expiration_interval Object to be assigned
     def expiration_interval=(expiration_interval)
-      validator = EnumAttributeValidator.new('String', ['minutes', 'hours', 'days'])
+      validator = EnumAttributeValidator.new('String', ["minutes", "hours", "days"])
       unless validator.valid?(expiration_interval)
-        fail ArgumentError, 'invalid value for "expiration_interval", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"expiration_interval\", must be one of #{validator.allowable_values}."
       end
       @expiration_interval = expiration_interval
     end
@@ -249,26 +374,26 @@ module DocSpring
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          expiration_interval == o.expiration_interval &&
-          webhook_url == o.webhook_url &&
-          parent_folder_id == o.parent_folder_id &&
-          expire_after == o.expire_after &&
-          allow_additional_properties == o.allow_additional_properties &&
+          name == o.name &&
           description == o.description &&
-          public_submissions == o.public_submissions &&
-          slack_webhook_url == o.slack_webhook_url &&
-          path == o.path &&
           public_web_form == o.public_web_form &&
-          editable_submissions == o.editable_submissions &&
+          public_submissions == o.public_submissions &&
           expire_submissions == o.expire_submissions &&
-          name == o.name &&
-          permanent_document_url == o.permanent_document_url &&
-          template_type == o.template_type &&
-          id == o.id &&
-          page_dimensions == o.page_dimensions &&
+          expire_after == o.expire_after &&
+          expiration_interval == o.expiration_interval &&
+          allow_additional_properties == o.allow_additional_properties &&
+          editable_submissions == o.editable_submissions &&
           locked == o.locked &&
+          webhook_url == o.webhook_url &&
+          slack_webhook_url == o.slack_webhook_url &&
           redirect_url == o.redirect_url &&
-          document_url == o.document_url
+          id == o.id &&
+          template_type == o.template_type &&
+          page_dimensions == o.page_dimensions &&
+          document_url == o.document_url &&
+          permanent_document_url == o.permanent_document_url &&
+          path == o.path &&
+          parent_folder_id == o.parent_folder_id
     end
 
     # @see the `==` method
@@ -278,39 +403,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [expiration_interval, webhook_url, parent_folder_id, expire_after, allow_additional_properties, description, public_submissions, slack_webhook_url, path, public_web_form, editable_submissions, expire_submissions, name, permanent_document_url, template_type, id, page_dimensions, locked, redirect_url, document_url].hash
+      [name, description, public_web_form, public_submissions, expire_submissions, expire_after, expiration_interval, allow_additional_properties, editable_submissions, locked, webhook_url, slack_webhook_url, redirect_url, id, template_type, page_dimensions, document_url, permanent_document_url, path, parent_folder_id].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
@@ -319,7 +447,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
@@ -340,8 +468,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
 
@@ -363,7 +492,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
@@ -386,5 +519,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end