docspring 3.0.0 → 3.1.0

data/lib/docspring/models/restore_version_data.rb

@@ -0,0 +1,221 @@
+=begin
+#DocSpring API
+
+#DocSpring provides an API that helps you fill out and sign PDF templates.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module DocSpring
+  class RestoreVersionData
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'version' => :'version'
+      }
+    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
+      {
+        :'version' => :'String'
+      }
+    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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::RestoreVersionData` initialize method"
+      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::RestoreVersionData`. 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.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = 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 @version.nil?
+        invalid_properties.push('invalid value for "version", version 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 @version.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          version == o.version
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [version].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)
+      return nil unless attributes.is_a?(Hash)
+      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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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 self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # 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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        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
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/docspring/models/submission.rb

@@ -39,6 +39,10 @@ module DocSpring
 
     attr_accessor :template_id
 
+    attr_accessor :template_type
+
+    attr_accessor :template_version
+
     attr_accessor :test
 
     attr_accessor :truncated_text
@@ -100,6 +104,8 @@ module DocSpring
         :'processed_at' => :'processed_at',
         :'state' => :'state',
         :'template_id' => :'template_id',
+        :'template_type' => :'template_type',
+        :'template_version' => :'template_version',
         :'test' => :'test',
         :'truncated_text' => :'truncated_text',
         :'pdf_hash' => :'pdf_hash',
@@ -135,6 +141,8 @@ module DocSpring
         :'processed_at' => :'String',
         :'state' => :'String',
         :'template_id' => :'String',
+        :'template_type' => :'String',
+        :'template_version' => :'String',
         :'test' => :'Boolean',
         :'truncated_text' => :'Object',
         :'pdf_hash' => :'String',
@@ -161,6 +169,7 @@ module DocSpring
         :'password',
         :'processed_at',
         :'template_id',
+        :'template_version',
         :'truncated_text',
         :'pdf_hash',
         :'download_url',
@@ -264,6 +273,18 @@ module DocSpring
         self.template_id = nil
       end
 
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      else
+        self.template_type = nil
+      end
+
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      else
+        self.template_version = nil
+      end
+
       if attributes.key?(:'test')
         self.test = attributes[:'test']
       else
@@ -360,6 +381,10 @@ module DocSpring
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
+      if @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
+      end
+
       if @test.nil?
         invalid_properties.push('invalid value for "test", test cannot be nil.')
       end
@@ -385,6 +410,9 @@ module DocSpring
       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"])
       return false unless state_validator.valid?(@state)
+      return false if @template_type.nil?
+      template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
+      return false unless template_type_validator.valid?(@template_type)
       return false if @test.nil?
       return false if @actions.nil?
       return false if @source.nil?
@@ -403,6 +431,16 @@ module DocSpring
       @state = state
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] template_type Object to be assigned
+    def template_type=(template_type)
+      validator = EnumAttributeValidator.new('String', ["pdf", "html"])
+      unless validator.valid?(template_type)
+        fail ArgumentError, "invalid value for \"template_type\", must be one of #{validator.allowable_values}."
+      end
+      @template_type = template_type
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] source Object to be assigned
     def source=(source)
@@ -430,6 +468,8 @@ module DocSpring
           processed_at == o.processed_at &&
           state == o.state &&
           template_id == o.template_id &&
+          template_type == o.template_type &&
+          template_version == o.template_version &&
           test == o.test &&
           truncated_text == o.truncated_text &&
           pdf_hash == o.pdf_hash &&
@@ -453,7 +493,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions, source, referrer, data].hash
+      [batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions, source, referrer, data].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_data_request_event.rb

@@ -88,6 +88,7 @@ module DocSpring
         :'id',
         :'submission_id',
         :'submission_data_request_id',
+        :'message_type',
         :'message_recipient',
         :'occurred_at'
       ])
@@ -160,10 +161,6 @@ module DocSpring
         invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
       end
 
-      if @message_type.nil?
-        invalid_properties.push('invalid value for "message_type", message_type cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -174,7 +171,6 @@ module DocSpring
       return false if @event_type.nil?
       event_type_validator = EnumAttributeValidator.new('String', ["send_request", "view_request", "accepted_terms", "decline_request", "sign_request", "all_completed"])
       return false unless event_type_validator.valid?(@event_type)
-      return false if @message_type.nil?
       message_type_validator = EnumAttributeValidator.new('String', ["email", "sms", "fax", "mail", "slack", "msteams", "discord", "telegram", "whatsapp"])
       return false unless message_type_validator.valid?(@message_type)
       true

data/lib/docspring/models/submission_preview.rb

@@ -39,6 +39,10 @@ module DocSpring
 
     attr_accessor :template_id
 
+    attr_accessor :template_type
+
+    attr_accessor :template_version
+
     attr_accessor :test
 
     attr_accessor :truncated_text
@@ -94,6 +98,8 @@ module DocSpring
         :'processed_at' => :'processed_at',
         :'state' => :'state',
         :'template_id' => :'template_id',
+        :'template_type' => :'template_type',
+        :'template_version' => :'template_version',
         :'test' => :'test',
         :'truncated_text' => :'truncated_text',
         :'pdf_hash' => :'pdf_hash',
@@ -126,6 +132,8 @@ module DocSpring
         :'processed_at' => :'String',
         :'state' => :'String',
         :'template_id' => :'String',
+        :'template_type' => :'String',
+        :'template_version' => :'String',
         :'test' => :'Boolean',
         :'truncated_text' => :'Object',
         :'pdf_hash' => :'String',
@@ -149,6 +157,7 @@ module DocSpring
         :'password',
         :'processed_at',
         :'template_id',
+        :'template_version',
         :'truncated_text',
         :'pdf_hash',
         :'download_url',
@@ -250,6 +259,18 @@ module DocSpring
         self.template_id = nil
       end
 
+      if attributes.key?(:'template_type')
+        self.template_type = attributes[:'template_type']
+      else
+        self.template_type = nil
+      end
+
+      if attributes.key?(:'template_version')
+        self.template_version = attributes[:'template_version']
+      else
+        self.template_version = nil
+      end
+
       if attributes.key?(:'test')
         self.test = attributes[:'test']
       else
@@ -328,6 +349,10 @@ module DocSpring
         invalid_properties.push('invalid value for "state", state cannot be nil.')
       end
 
+      if @template_type.nil?
+        invalid_properties.push('invalid value for "template_type", template_type cannot be nil.')
+      end
+
       if @test.nil?
         invalid_properties.push('invalid value for "test", test cannot be nil.')
       end
@@ -349,6 +374,9 @@ module DocSpring
       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"])
       return false unless state_validator.valid?(@state)
+      return false if @template_type.nil?
+      template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
+      return false unless template_type_validator.valid?(@template_type)
       return false if @test.nil?
       return false if @actions.nil?
       true
@@ -364,6 +392,16 @@ module DocSpring
       @state = state
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] template_type Object to be assigned
+    def template_type=(template_type)
+      validator = EnumAttributeValidator.new('String', ["pdf", "html"])
+      unless validator.valid?(template_type)
+        fail ArgumentError, "invalid value for \"template_type\", must be one of #{validator.allowable_values}."
+      end
+      @template_type = template_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -381,6 +419,8 @@ module DocSpring
           processed_at == o.processed_at &&
           state == o.state &&
           template_id == o.template_id &&
+          template_type == o.template_type &&
+          template_version == o.template_version &&
           test == o.test &&
           truncated_text == o.truncated_text &&
           pdf_hash == o.pdf_hash &&
@@ -401,7 +441,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions].hash
+      [batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions].hash
     end
 
     # Builds the object from hash