onfido 2.8.0 → 3.0.0

data/lib/onfido/models/document_shared.rb

@@ -0,0 +1,301 @@
+=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 DocumentShared
+    # The file type of the uploaded file
+    attr_accessor :file_type
+
+    # The type of document
+    attr_accessor :type
+
+    # The side of the document, if applicable. The possible values are front and back
+    attr_accessor :side
+
+    # The issuing country of the document, a 3-letter ISO code.
+    attr_accessor :issuing_country
+
+    # The ID of the applicant whose document is being uploaded.
+    attr_accessor :applicant_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'file_type' => :'file_type',
+        :'type' => :'type',
+        :'side' => :'side',
+        :'issuing_country' => :'issuing_country',
+        :'applicant_id' => :'applicant_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
+      {
+        :'file_type' => :'String',
+        :'type' => :'String',
+        :'side' => :'String',
+        :'issuing_country' => :'CountryCodes',
+        :'applicant_id' => :'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 `Onfido::DocumentShared` 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::DocumentShared`. 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?(:'file_type')
+        self.file_type = attributes[:'file_type']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'side')
+        self.side = attributes[:'side']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_country']
+      end
+
+      if attributes.key?(:'applicant_id')
+        self.applicant_id = attributes[:'applicant_id']
+      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
+      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'
+      file_type_validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      return false unless file_type_validator.valid?(@file_type)
+      side_validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"])
+      return false unless side_validator.valid?(@side)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] file_type Object to be assigned
+    def file_type=(file_type)
+      validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      unless validator.valid?(file_type)
+        fail ArgumentError, "invalid value for \"file_type\", must be one of #{validator.allowable_values}."
+      end
+      @file_type = file_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] side Object to be assigned
+    def side=(side)
+      validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"])
+      unless validator.valid?(side)
+        fail ArgumentError, "invalid value for \"side\", must be one of #{validator.allowable_values}."
+      end
+      @side = side
+    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 &&
+          file_type == o.file_type &&
+          type == o.type &&
+          side == o.side &&
+          issuing_country == o.issuing_country &&
+          applicant_id == o.applicant_id
+    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
+      [file_type, type, side, issuing_country, applicant_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 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

data/lib/onfido/models/document_types.rb

@@ -0,0 +1,64 @@
+=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 DocumentTypes
+    PASSPORT = "passport".freeze
+    DRIVING_LICENCE = "driving_licence".freeze
+    NATIONAL_IDENTITY_CARD = "national_identity_card".freeze
+    RESIDENCE_PERMIT = "residence_permit".freeze
+    PASSPORT_CARD = "passport_card".freeze
+    TAX_ID = "tax_id".freeze
+    VISA = "visa".freeze
+    VOTER_ID = "voter_id".freeze
+    RESIDENCE_STATUS_DOCUMENT = "residence_status_document".freeze
+    POSTAL_IDENTITY_CARD = "postal_identity_card".freeze
+    SOCIAL_SECURITY_CARD = "social_security_card".freeze
+    WORK_PERMIT = "work_permit".freeze
+    ASYLUM_REGISTRATION_CARD = "asylum_registration_card".freeze
+    NATIONAL_HEALTH_INSURANCE_CARD = "national_health_insurance_card".freeze
+    MUNICIPALITY_IDENTITY_CARD = "municipality_identity_card".freeze
+    PRIVATE_OPERATORS_CARD = "private_operators_card".freeze
+    PROOF_OF_CITIZENSHIP = "proof_of_citizenship".freeze
+    SERVICE_ID_CARD = "service_id_card".freeze
+    IMMIGRATION_STATUS_DOCUMENT = "immigration_status_document".freeze
+    INDIGENOUS_CARD = "indigenous_card".freeze
+    VEHICLE_REGISTRATION_CARD = "vehicle_registration_card".freeze
+    CERTIFICATE_OF_NATURALISATION = "certificate_of_naturalisation".freeze
+    PROFESSIONAL_QUALIFICATION_CARD = "professional_qualification_card".freeze
+    CONSULAR_ID = "consular_id".freeze
+    INTERNATIONAL_DRIVING_LICENCE = "international_driving_licence".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [PASSPORT, DRIVING_LICENCE, NATIONAL_IDENTITY_CARD, RESIDENCE_PERMIT, PASSPORT_CARD, TAX_ID, VISA, VOTER_ID, RESIDENCE_STATUS_DOCUMENT, POSTAL_IDENTITY_CARD, SOCIAL_SECURITY_CARD, WORK_PERMIT, ASYLUM_REGISTRATION_CARD, NATIONAL_HEALTH_INSURANCE_CARD, MUNICIPALITY_IDENTITY_CARD, PRIVATE_OPERATORS_CARD, PROOF_OF_CITIZENSHIP, SERVICE_ID_CARD, IMMIGRATION_STATUS_DOCUMENT, INDIGENOUS_CARD, VEHICLE_REGISTRATION_CARD, CERTIFICATE_OF_NATURALISATION, PROFESSIONAL_QUALIFICATION_CARD, CONSULAR_ID, INTERNATIONAL_DRIVING_LICENCE, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if DocumentTypes.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #DocumentTypes"
+    end
+  end
+end