docspring 1.3.0 → 1.4.1

data/lib/docspring/models/list_submissions_response.rb

@@ -0,0 +1,203 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0
+
+=end
+
+require 'date'
+
+module DocSpring
+  class ListSubmissionsResponse
+    attr_accessor :next_cursor
+
+    attr_accessor :submissions
+
+    attr_accessor :limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'next_cursor' => :'next_cursor',
+        :'submissions' => :'submissions',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'next_cursor' => :'String',
+        :'submissions' => :'Array<Submission>',
+        :'limit' => :'Float'
+      }
+    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?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.has_key?(:'submissions')
+        if (value = attributes[:'submissions']).is_a?(Array)
+          self.submissions = value
+        end
+      end
+
+      if attributes.has_key?(:'limit')
+        self.limit = attributes[:'limit']
+      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
+      invalid_properties = Array.new
+      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?
+      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 &&
+          next_cursor == o.next_cursor &&
+          submissions == o.submissions &&
+          limit == o.limit
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [next_cursor, submissions, limit].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)
+      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
+          # 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) })
+          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
+
+      self
+    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)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = DocSpring.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/move_template_data.rb

@@ -47,12 +47,17 @@ module DocSpring
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @parent_folder_id.nil?
+        invalid_properties.push('invalid value for "parent_folder_id", parent_folder_id 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?
+      return false if @parent_folder_id.nil?
       true
     end
 

data/lib/docspring/models/submission_data.rb

@@ -26,6 +26,8 @@ module DocSpring
 
     attr_accessor :metadata
 
+    attr_accessor :password
+
     attr_accessor :test
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -37,6 +39,7 @@ module DocSpring
         :'field_overrides' => :'field_overrides',
         :'html' => :'html',
         :'metadata' => :'metadata',
+        :'password' => :'password',
         :'test' => :'test'
       }
     end
@@ -50,6 +53,7 @@ module DocSpring
         :'field_overrides' => :'Object',
         :'html' => :'String',
         :'metadata' => :'Object',
+        :'password' => :'String',
         :'test' => :'BOOLEAN'
       }
     end
@@ -88,6 +92,10 @@ module DocSpring
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'password')
+        self.password = attributes[:'password']
+      end
+
       if attributes.has_key?(:'test')
         self.test = attributes[:'test']
       end
@@ -122,6 +130,7 @@ module DocSpring
           field_overrides == o.field_overrides &&
           html == o.html &&
           metadata == o.metadata &&
+          password == o.password &&
           test == o.test
     end
 
@@ -134,7 +143,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [css, data, data_requests, field_overrides, html, metadata, test].hash
+      [css, data, data_requests, field_overrides, html, metadata, password, test].hash
     end
 
     # Builds the object from hash

data/lib/docspring/models/submission_data_request.rb

@@ -22,6 +22,8 @@ module DocSpring
 
     attr_accessor :order
 
+    attr_accessor :sort_order
+
     attr_accessor :fields
 
     attr_accessor :metadata
@@ -81,6 +83,7 @@ module DocSpring
         :'name' => :'name',
         :'email' => :'email',
         :'order' => :'order',
+        :'sort_order' => :'sort_order',
         :'fields' => :'fields',
         :'metadata' => :'metadata',
         :'state' => :'state',
@@ -106,6 +109,7 @@ module DocSpring
         :'name' => :'String',
         :'email' => :'String',
         :'order' => :'Integer',
+        :'sort_order' => :'Integer',
         :'fields' => :'Array<String>',
         :'metadata' => :'Object',
         :'state' => :'String',
@@ -148,6 +152,10 @@ module DocSpring
         self.order = attributes[:'order']
       end
 
+      if attributes.has_key?(:'sort_order')
+        self.sort_order = attributes[:'sort_order']
+      end
+
       if attributes.has_key?(:'fields')
         if (value = attributes[:'fields']).is_a?(Array)
           self.fields = value
@@ -223,6 +231,10 @@ module DocSpring
         invalid_properties.push('invalid value for "order", order cannot be nil.')
       end
 
+      if @sort_order.nil?
+        invalid_properties.push('invalid value for "sort_order", sort_order cannot be nil.')
+      end
+
       if @metadata.nil?
         invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
       end
@@ -239,6 +251,7 @@ module DocSpring
     def valid?
       return false if @id.nil?
       return false if @order.nil?
+      return false if @sort_order.nil?
       return false if @metadata.nil?
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ['pending', 'completed'])
@@ -289,6 +302,7 @@ module DocSpring
           name == o.name &&
           email == o.email &&
           order == o.order &&
+          sort_order == o.sort_order &&
           fields == o.fields &&
           metadata == o.metadata &&
           state == o.state &&
@@ -315,7 +329,7 @@ module DocSpring
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, email, order, fields, metadata, state, viewed_at, completed_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent].hash
+      [id, name, email, order, sort_order, fields, metadata, state, viewed_at, completed_at, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent].hash
     end
 
     # Builds the object from hash