onfido 2.9.0 → 3.0.0

data/lib/onfido/models/report.rb

@@ -0,0 +1,93 @@
+=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
+  module Report
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'DeviceIntelligenceReport',
+          :'DocumentReport',
+          :'DocumentVideoReport',
+          :'DocumentVideoWithAddressInformationReport',
+          :'DocumentWithAddressInformationReport',
+          :'DocumentWithDriverVerificationReport',
+          :'DocumentWithDrivingLicenceInformationReport',
+          :'FacialSimilarityMotionReport',
+          :'FacialSimilarityPhotoFullyAutoReport',
+          :'FacialSimilarityPhotoReport',
+          :'FacialSimilarityVideoReport',
+          :'IdentityEnhancedReport',
+          :'IndiaPanReport',
+          :'KnownFacesReport',
+          :'ProofOfAddressReport',
+          :'UsDrivingLicenceReport',
+          :'WatchlistAmlReport',
+          :'WatchlistEnhancedReport',
+          :'WatchlistPepsOnlyReport',
+          :'WatchlistSanctionsOnlyReport',
+          :'WatchlistStandardReport'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'name'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'device_intelligence' => :'DeviceIntelligenceReport',
+          :'document' => :'DocumentReport',
+          :'document_video' => :'DocumentVideoReport',
+          :'document_video_with_address_information' => :'DocumentVideoWithAddressInformationReport',
+          :'document_with_address_information' => :'DocumentWithAddressInformationReport',
+          :'document_with_driver_verification' => :'DocumentWithDriverVerificationReport',
+          :'document_with_driving_licence_information' => :'DocumentWithDrivingLicenceInformationReport',
+          :'facial_similarity_motion' => :'FacialSimilarityMotionReport',
+          :'facial_similarity_photo' => :'FacialSimilarityPhotoReport',
+          :'facial_similarity_photo_fully_auto' => :'FacialSimilarityPhotoFullyAutoReport',
+          :'facial_similarity_video' => :'FacialSimilarityVideoReport',
+          :'identity_enhanced' => :'IdentityEnhancedReport',
+          :'india_pan' => :'IndiaPanReport',
+          :'known_faces' => :'KnownFacesReport',
+          :'proof_of_address' => :'ProofOfAddressReport',
+          :'us_driving_licence' => :'UsDrivingLicenceReport',
+          :'watchlist_aml' => :'WatchlistAmlReport',
+          :'watchlist_enhanced' => :'WatchlistEnhancedReport',
+          :'watchlist_peps_only' => :'WatchlistPepsOnlyReport',
+          :'watchlist_sanctions_only' => :'WatchlistSanctionsOnlyReport',
+          :'watchlist_standard' => :'WatchlistStandardReport'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        Onfido.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/onfido/models/report_document.rb

@@ -0,0 +1,222 @@
+=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 ReportDocument
+    # ID of uploaded document to use.
+    attr_accessor :id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'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
+      {
+        :'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::ReportDocument` 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::ReportDocument`. 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
+    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
+
+      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?
+      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
+    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].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/report_name.rb

@@ -0,0 +1,60 @@
+=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 ReportName
+    DOCUMENT = "document".freeze
+    DOCUMENT_VIDEO = "document_video".freeze
+    DOCUMENT_VIDEO_WITH_ADDRESS_INFORMATION = "document_video_with_address_information".freeze
+    DOCUMENT_WITH_ADDRESS_INFORMATION = "document_with_address_information".freeze
+    DOCUMENT_WITH_DRIVING_LICENCE_INFORMATION = "document_with_driving_licence_information".freeze
+    DOCUMENT_WITH_DRIVER_VERIFICATION = "document_with_driver_verification".freeze
+    FACIAL_SIMILARITY_PHOTO = "facial_similarity_photo".freeze
+    FACIAL_SIMILARITY_PHOTO_FULLY_AUTO = "facial_similarity_photo_fully_auto".freeze
+    FACIAL_SIMILARITY_VIDEO = "facial_similarity_video".freeze
+    FACIAL_SIMILARITY_MOTION = "facial_similarity_motion".freeze
+    KNOWN_FACES = "known_faces".freeze
+    IDENTITY_ENHANCED = "identity_enhanced".freeze
+    WATCHLIST_AML = "watchlist_aml".freeze
+    WATCHLIST_ENHANCED = "watchlist_enhanced".freeze
+    WATCHLIST_STANDARD = "watchlist_standard".freeze
+    WATCHLIST_PEPS_ONLY = "watchlist_peps_only".freeze
+    WATCHLIST_SANCTIONS_ONLY = "watchlist_sanctions_only".freeze
+    PROOF_OF_ADDRESS = "proof_of_address".freeze
+    US_DRIVING_LICENCE = "us_driving_licence".freeze
+    DEVICE_INTELLIGENCE = "device_intelligence".freeze
+    INDIA_PAN = "india_pan".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [DOCUMENT, DOCUMENT_VIDEO, DOCUMENT_VIDEO_WITH_ADDRESS_INFORMATION, DOCUMENT_WITH_ADDRESS_INFORMATION, DOCUMENT_WITH_DRIVING_LICENCE_INFORMATION, DOCUMENT_WITH_DRIVER_VERIFICATION, FACIAL_SIMILARITY_PHOTO, FACIAL_SIMILARITY_PHOTO_FULLY_AUTO, FACIAL_SIMILARITY_VIDEO, FACIAL_SIMILARITY_MOTION, KNOWN_FACES, IDENTITY_ENHANCED, WATCHLIST_AML, WATCHLIST_ENHANCED, WATCHLIST_STANDARD, WATCHLIST_PEPS_ONLY, WATCHLIST_SANCTIONS_ONLY, PROOF_OF_ADDRESS, US_DRIVING_LICENCE, DEVICE_INTELLIGENCE, INDIA_PAN, 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 ReportName.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ReportName"
+    end
+  end
+end

data/lib/onfido/models/report_result.rb

@@ -0,0 +1,42 @@
+=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 ReportResult
+    CLEAR = "clear".freeze
+    CONSIDER = "consider".freeze
+    UNIDENTIFIED = "unidentified".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [CLEAR, CONSIDER, UNIDENTIFIED, 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 ReportResult.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ReportResult"
+    end
+  end
+end