docspring 1.4.1 → 2.0.0

data/lib/docspring/models/submission_data_request.rb

@@ -3,19 +3,22 @@
 
 #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 SubmissionDataRequest
     attr_accessor :id
 
+    attr_accessor :submission_id
+
     attr_accessor :name
 
     attr_accessor :email
@@ -80,6 +83,7 @@ module DocSpring
     def self.attribute_map
       {
         :'id' => :'id',
+        :'submission_id' => :'submission_id',
         :'name' => :'name',
         :'email' => :'email',
         :'order' => :'order',
@@ -102,10 +106,16 @@ 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',
+        :'submission_id' => :'String',
         :'name' => :'String',
         :'email' => :'String',
         :'order' => :'Integer',
@@ -128,93 +138,139 @@ module DocSpring
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'name',
+        :'email',
+        :'fields',
+        :'viewed_at',
+        :'completed_at',
+        :'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'
+      ])
+    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::SubmissionDataRequest` 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::SubmissionDataRequest`. 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?(:'name')
+      if attributes.key?(:'submission_id')
+        self.submission_id = attributes[:'submission_id']
+      end
+
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
+      else
+        self.name = nil
       end
 
-      if attributes.has_key?(:'email')
+      if attributes.key?(:'email')
         self.email = attributes[:'email']
+      else
+        self.email = nil
       end
 
-      if attributes.has_key?(:'order')
+      if attributes.key?(:'order')
         self.order = attributes[:'order']
+      else
+        self.order = nil
       end
 
-      if attributes.has_key?(:'sort_order')
+      if attributes.key?(:'sort_order')
         self.sort_order = attributes[:'sort_order']
+      else
+        self.sort_order = nil
       end
 
-      if attributes.has_key?(:'fields')
+      if attributes.key?(:'fields')
         if (value = attributes[:'fields']).is_a?(Array)
           self.fields = value
         end
+      else
+        self.fields = nil
       end
 
-      if attributes.has_key?(:'metadata')
+      if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
+      else
+        self.metadata = nil
       end
 
-      if attributes.has_key?(:'state')
+      if attributes.key?(:'state')
         self.state = attributes[:'state']
+      else
+        self.state = nil
       end
 
-      if attributes.has_key?(:'viewed_at')
+      if attributes.key?(:'viewed_at')
         self.viewed_at = attributes[:'viewed_at']
       end
 
-      if attributes.has_key?(:'completed_at')
+      if attributes.key?(:'completed_at')
         self.completed_at = attributes[:'completed_at']
       end
 
-      if attributes.has_key?(:'auth_type')
+      if attributes.key?(:'auth_type')
         self.auth_type = attributes[:'auth_type']
       end
 
-      if attributes.has_key?(:'auth_second_factor_type')
+      if attributes.key?(:'auth_second_factor_type')
         self.auth_second_factor_type = attributes[:'auth_second_factor_type']
       end
 
-      if attributes.has_key?(:'auth_provider')
+      if attributes.key?(:'auth_provider')
         self.auth_provider = attributes[:'auth_provider']
       end
 
-      if attributes.has_key?(:'auth_session_started_at')
+      if attributes.key?(:'auth_session_started_at')
         self.auth_session_started_at = attributes[:'auth_session_started_at']
       end
 
-      if attributes.has_key?(:'auth_session_id_hash')
+      if attributes.key?(:'auth_session_id_hash')
         self.auth_session_id_hash = attributes[:'auth_session_id_hash']
       end
 
-      if attributes.has_key?(:'auth_user_id_hash')
+      if attributes.key?(:'auth_user_id_hash')
         self.auth_user_id_hash = attributes[:'auth_user_id_hash']
       end
 
-      if attributes.has_key?(:'auth_username_hash')
+      if attributes.key?(:'auth_username_hash')
         self.auth_username_hash = attributes[:'auth_username_hash']
       end
 
-      if attributes.has_key?(:'auth_phone_number_hash')
+      if attributes.key?(:'auth_phone_number_hash')
         self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
       end
 
-      if attributes.has_key?(:'ip_address')
+      if attributes.key?(:'ip_address')
         self.ip_address = attributes[:'ip_address']
       end
 
-      if attributes.has_key?(:'user_agent')
+      if attributes.key?(:'user_agent')
         self.user_agent = attributes[:'user_agent']
       end
     end
@@ -222,6 +278,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.')
@@ -249,16 +306,17 @@ 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 @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'])
+      state_validator = EnumAttributeValidator.new('String', ["pending", "completed"])
       return false unless state_validator.valid?(@state)
-      auth_type_validator = EnumAttributeValidator.new('String', ['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml'])
+      auth_type_validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
       return false unless auth_type_validator.valid?(@auth_type)
-      auth_second_factor_type_validator = EnumAttributeValidator.new('String', ['none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint'])
+      auth_second_factor_type_validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
       return false unless auth_second_factor_type_validator.valid?(@auth_second_factor_type)
       true
     end
@@ -266,9 +324,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', 'completed'])
+      validator = EnumAttributeValidator.new('String', ["pending", "completed"])
       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
@@ -276,9 +334,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] auth_type Object to be assigned
     def auth_type=(auth_type)
-      validator = EnumAttributeValidator.new('String', ['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml'])
+      validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
       unless validator.valid?(auth_type)
-        fail ArgumentError, 'invalid value for "auth_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"auth_type\", must be one of #{validator.allowable_values}."
       end
       @auth_type = auth_type
     end
@@ -286,9 +344,9 @@ module DocSpring
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] auth_second_factor_type Object to be assigned
     def auth_second_factor_type=(auth_second_factor_type)
-      validator = EnumAttributeValidator.new('String', ['none', 'phone_number', 'totp', 'mobile_push', 'security_key', 'fingerprint'])
+      validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
       unless validator.valid?(auth_second_factor_type)
-        fail ArgumentError, 'invalid value for "auth_second_factor_type", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"auth_second_factor_type\", must be one of #{validator.allowable_values}."
       end
       @auth_second_factor_type = auth_second_factor_type
     end
@@ -299,6 +357,7 @@ module DocSpring
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          submission_id == o.submission_id &&
           name == o.name &&
           email == o.email &&
           order == o.order &&
@@ -327,39 +386,42 @@ module DocSpring
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def 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
+      [id, submission_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
     # @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
@@ -368,7 +430,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
@@ -389,8 +451,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
 
@@ -412,7 +475,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
@@ -435,5 +502,7 @@ module DocSpring
         value
       end
     end
+
   end
+
 end

data/lib/docspring/models/submission_data_request_event.rb

@@ -0,0 +1,309 @@
+=begin
+#API v1
+
+#DocSpring is a service 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 SubmissionDataRequestEvent
+    attr_accessor :id
+
+    attr_accessor :submission_id
+
+    attr_accessor :submission_data_request_id
+
+    attr_accessor :event_type
+
+    attr_accessor :message_type
+
+    attr_accessor :message_recipient
+
+    attr_accessor :occurred_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'submission_id' => :'submission_id',
+        :'submission_data_request_id' => :'submission_data_request_id',
+        :'event_type' => :'event_type',
+        :'message_type' => :'message_type',
+        :'message_recipient' => :'message_recipient',
+        :'occurred_at' => :'occurred_at'
+      }
+    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',
+        :'submission_id' => :'String',
+        :'submission_data_request_id' => :'String',
+        :'event_type' => :'String',
+        :'message_type' => :'String',
+        :'message_recipient' => :'String',
+        :'occurred_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'message_type',
+        :'message_recipient',
+      ])
+    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::SubmissionDataRequestEvent` 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::SubmissionDataRequestEvent`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'submission_id')
+        self.submission_id = attributes[:'submission_id']
+      else
+        self.submission_id = nil
+      end
+
+      if attributes.key?(:'submission_data_request_id')
+        self.submission_data_request_id = attributes[:'submission_data_request_id']
+      else
+        self.submission_data_request_id = nil
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'message_type')
+        self.message_type = attributes[:'message_type']
+      else
+        self.message_type = nil
+      end
+
+      if attributes.key?(:'message_recipient')
+        self.message_recipient = attributes[:'message_recipient']
+      else
+        self.message_recipient = nil
+      end
+
+      if attributes.key?(:'occurred_at')
+        self.occurred_at = attributes[:'occurred_at']
+      else
+        self.occurred_at = 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.')
+      end
+
+      if @submission_id.nil?
+        invalid_properties.push('invalid value for "submission_id", submission_id cannot be nil.')
+      end
+
+      if @submission_data_request_id.nil?
+        invalid_properties.push('invalid value for "submission_data_request_id", submission_data_request_id cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @occurred_at.nil?
+        invalid_properties.push('invalid value for "occurred_at", occurred_at 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 @id.nil?
+      return false if @submission_id.nil?
+      return false if @submission_data_request_id.nil?
+      return false if @event_type.nil?
+      return false if @occurred_at.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 &&
+          id == o.id &&
+          submission_id == o.submission_id &&
+          submission_data_request_id == o.submission_data_request_id &&
+          event_type == o.event_type &&
+          message_type == o.message_type &&
+          message_recipient == o.message_recipient &&
+          occurred_at == o.occurred_at
+    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
+      [id, submission_id, submission_data_request_id, event_type, message_type, message_recipient, occurred_at].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