onfido 2.9.0 → 3.0.0

data/lib/onfido/models/applicant.rb

@@ -0,0 +1,390 @@
+=begin
+#Onfido API v3.6
+
+#The Onfido API (v3.6)
+
+The version of the OpenAPI document: v3.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  class Applicant
+    # The applicant's email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
+    attr_accessor :email
+
+    # The applicant's date of birth
+    attr_accessor :dob
+
+    attr_accessor :id_numbers
+
+    # The applicant's phone number
+    attr_accessor :phone_number
+
+    # The applicant's first name
+    attr_accessor :first_name
+
+    # The applicant's surname
+    attr_accessor :last_name
+
+    # The unique identifier for the applicant.
+    attr_accessor :id
+
+    # The date and time when this applicant was created.
+    attr_accessor :created_at
+
+    # The date and time when this applicant is scheduled to be deleted.
+    attr_accessor :delete_at
+
+    # The uri of this resource.
+    attr_accessor :href
+
+    attr_accessor :sandbox
+
+    attr_accessor :address
+
+    attr_accessor :location
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'dob' => :'dob',
+        :'id_numbers' => :'id_numbers',
+        :'phone_number' => :'phone_number',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'id' => :'id',
+        :'created_at' => :'created_at',
+        :'delete_at' => :'delete_at',
+        :'href' => :'href',
+        :'sandbox' => :'sandbox',
+        :'address' => :'address',
+        :'location' => :'location'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'dob' => :'Date',
+        :'id_numbers' => :'Array<IdNumber>',
+        :'phone_number' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'id' => :'String',
+        :'created_at' => :'Time',
+        :'delete_at' => :'Time',
+        :'href' => :'String',
+        :'sandbox' => :'Boolean',
+        :'address' => :'Address',
+        :'location' => :'Location'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ApplicantResponse',
+      :'ApplicantShared'
+      ]
+    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 `Onfido::Applicant` 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 `Onfido::Applicant`. 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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'dob')
+        self.dob = attributes[:'dob']
+      end
+
+      if attributes.key?(:'id_numbers')
+        if (value = attributes[:'id_numbers']).is_a?(Array)
+          self.id_numbers = value
+        end
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'delete_at')
+        self.delete_at = attributes[:'delete_at']
+      end
+
+      if attributes.key?(:'href')
+        self.href = attributes[:'href']
+      end
+
+      if attributes.key?(:'sandbox')
+        self.sandbox = attributes[:'sandbox']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      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
+      pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      if !@first_name.nil? && @first_name !~ pattern
+        invalid_properties.push("invalid value for \"first_name\", must conform to the pattern #{pattern}.")
+      end
+
+      pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      if !@last_name.nil? && @last_name !~ pattern
+        invalid_properties.push("invalid value for \"last_name\", must conform to the pattern #{pattern}.")
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@first_name.nil? && @first_name !~ Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      return false if !@last_name.nil? && @last_name !~ Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      return false if @id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      if first_name.nil?
+        fail ArgumentError, 'first_name cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      if first_name !~ pattern
+        fail ArgumentError, "invalid value for \"first_name\", must conform to the pattern #{pattern}."
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[^!#$%*=<>;{}"]*$/)
+      if last_name !~ pattern
+        fail ArgumentError, "invalid value for \"last_name\", must conform to the pattern #{pattern}."
+      end
+
+      @last_name = last_name
+    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 &&
+          email == o.email &&
+          dob == o.dob &&
+          id_numbers == o.id_numbers &&
+          phone_number == o.phone_number &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          id == o.id &&
+          created_at == o.created_at &&
+          delete_at == o.delete_at &&
+          href == o.href &&
+          sandbox == o.sandbox &&
+          address == o.address &&
+          location == o.location
+    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
+      [email, dob, id_numbers, phone_number, first_name, last_name, id, created_at, delete_at, href, sandbox, address, location].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 = Onfido.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