onfido 5.1.1 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11bed99ce3f8728f3f344682bf2bd77fc5a24c02ee28fb0ba498e62b338ec0ba
-  data.tar.gz: 101c8c0b12326edc85a44f6ffdfa6803e25b88c01392d99715dae7d188cb8579
+  metadata.gz: 89d4e3b1ff4f2b746cd887bf6c5851d871ddab48f848c02c2e321d168e8124bf
+  data.tar.gz: 8e7d37918c9e9751113dd8e390e69cc92e7e5847bd48cc8426e5084a32fecfb8
 SHA512:
-  metadata.gz: 0106e4ca114ac27bf511ac9b77544ec999b2eaf464811f6ecbda7e40a3e36dd9c458b5a498873c1051eff7bda2781b3f328681874c357c576f5ec727631f1b98
-  data.tar.gz: 65fcb7074155ef64bbbf581fa53f342607d17375e169703231d4353f7f59ea3c00693c64480aa1bc74cbc71d4b9ba9e891551b7be694e909c71cf4b98ee66516
+  metadata.gz: d60100dd4e03fe9cdc6cf890251940c5a532c94bbf059cfd3e7669f3cb348388ef2757c116d7720fdb568c32630c9a08a41598dfc48a84591c74e6a57b5cb810
+  data.tar.gz: d7bddea0dcbcc52d7afd6467aed32e0dc3c7ce062f7acd5dd5947481ed8e7d0506c68a918e48c50379337894f93c0f699eefbe24fbbfdb29d91bea71f9d5ae60

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v5.2.0 5th June 2025
+
+- Release based on Onfido OpenAPI spec version [v5.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.2.0):
+  - [BIO-7260] Add report configuration (including use_case) to checks
+
+## v5.1.1 19th May 2025
+
+- Release based on Onfido OpenAPI spec version [v5.1.1](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.1.1):
+  - [CAT-1952] Fix corruption in file download
+
 ## v5.1.0 14th May 2025
 
 - Release based on Onfido OpenAPI spec version [v5.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.1.0):
@@ -11,6 +21,8 @@
   - Fix storage of device_fingerprint_reuse breakdown and properties as float
   - Add .markdownlint.json to templates
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v5.0.0 21st February 2025
 
 - Release based on Onfido OpenAPI spec version [v5.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v5.0.0):
@@ -27,6 +39,8 @@
 - Add tests for Download NFC Face endpoint
 - [Migration Guide](MIGRATION.md#upgrading-from-4x-to-5x)
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.6.0 24th January 2025
 
 - Release based on Onfido OpenAPI spec version [v4.6.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.6.0):
@@ -36,33 +50,45 @@
   - Add customer_user_id in the webhook event resource
 - test: wait for evidence folder to be available
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.5.0 8th January 2025
 
 - Release based on Onfido OpenAPI spec version [v4.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.5.0):
   - [STUDIO-4305] Add download evidence folder path
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.4.0 20th December 2024
 
 - Release based on Onfido OpenAPI spec version [v4.4.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.4.0):
   - [CAT-1593] Fix missing webhook type and evidence folder webhook
   - [CAT-1590] Allow any type for the workflow task output
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.3.0 27th November 2024
 
 - Release based on Onfido OpenAPI spec version [v4.3.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.3.0):
   - [CAT-1581] Revert "[CAT-1528] Fix barcode field in document properties object"
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.2.0 19th November 2024
 
 - Release based on Onfido OpenAPI spec version [v4.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.2.0):
   - feat: add new fields to facial similarity report objects
   - [CAT-1552] Add missing document types
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.1.0 8th November 2024
 
 - Release based on Onfido OpenAPI spec version [v4.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.1.0):
   - [CAT-1528] Fix barcode field in document properties object
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v4.0.0 24th October 2024
 
 - Release based on Onfido OpenAPI spec version [v4.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v4.0.0):
@@ -74,6 +100,8 @@
   - Upgrade OpenAPI generator to v7.9.0 (was v7.6.0)
   - [Migration Guide](MIGRATION.md#upgrading-from-3x-to-4x)
 
+**DEPRECATION NOTICE**: This release has been **deprecated** in favour of [v5.1.1](#v511-19th-may-2025).
+
 ## v3.4.0 20th September 2024
 
 - Release based on Onfido OpenAPI spec version [v3.5.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.5.0):

data/README.md

@@ -14,7 +14,7 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem 'onfido', '~> 5.1.1'
+gem 'onfido', '~> 5.3.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):

data/lib/onfido/api_client.rb

@@ -35,7 +35,7 @@ module Onfido
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "onfido-ruby/5.1.1"
+      @user_agent = "onfido-ruby/5.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/models/check_builder.rb

@@ -52,6 +52,8 @@ module Onfido
 
     attr_accessor :us_driving_licence
 
+    attr_accessor :report_configuration
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -67,7 +69,8 @@ module Onfido
         :'suppress_form_emails' => :'suppress_form_emails',
         :'sub_result' => :'sub_result',
         :'consider' => :'consider',
-        :'us_driving_licence' => :'us_driving_licence'
+        :'us_driving_licence' => :'us_driving_licence',
+        :'report_configuration' => :'report_configuration'
       }
     end
 
@@ -91,7 +94,8 @@ module Onfido
         :'suppress_form_emails' => :'Boolean',
         :'sub_result' => :'String',
         :'consider' => :'Array<ReportName>',
-        :'us_driving_licence' => :'UsDrivingLicenceBuilder'
+        :'us_driving_licence' => :'UsDrivingLicenceBuilder',
+        :'report_configuration' => :'ReportConfiguration'
       }
     end
 
@@ -193,6 +197,10 @@ module Onfido
       if attributes.key?(:'us_driving_licence')
         self.us_driving_licence = attributes[:'us_driving_licence']
       end
+
+      if attributes.key?(:'report_configuration')
+        self.report_configuration = attributes[:'report_configuration']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -237,7 +245,8 @@ module Onfido
           suppress_form_emails == o.suppress_form_emails &&
           sub_result == o.sub_result &&
           consider == o.consider &&
-          us_driving_licence == o.us_driving_licence
+          us_driving_licence == o.us_driving_licence &&
+          report_configuration == o.report_configuration
     end
 
     # @see the `==` method
@@ -249,7 +258,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_ids, applicant_id, applicant_provides_data, tags, redirect_uri, privacy_notices_read_consent_given, report_names, document_ids, asynchronous, suppress_form_emails, sub_result, consider, us_driving_licence].hash
+      [webhook_ids, applicant_id, applicant_provides_data, tags, redirect_uri, privacy_notices_read_consent_given, report_names, document_ids, asynchronous, suppress_form_emails, sub_result, consider, us_driving_licence, report_configuration].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/check_request.rb

@@ -38,6 +38,8 @@ module Onfido
 
     attr_accessor :us_driving_licence
 
+    attr_accessor :report_configuration
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +50,8 @@ module Onfido
         :'suppress_form_emails' => :'suppress_form_emails',
         :'sub_result' => :'sub_result',
         :'consider' => :'consider',
-        :'us_driving_licence' => :'us_driving_licence'
+        :'us_driving_licence' => :'us_driving_licence',
+        :'report_configuration' => :'report_configuration'
       }
     end
 
@@ -67,7 +70,8 @@ module Onfido
         :'suppress_form_emails' => :'Boolean',
         :'sub_result' => :'String',
         :'consider' => :'Array<ReportName>',
-        :'us_driving_licence' => :'UsDrivingLicenceBuilder'
+        :'us_driving_licence' => :'UsDrivingLicenceBuilder',
+        :'report_configuration' => :'ReportConfiguration'
       }
     end
 
@@ -135,6 +139,10 @@ module Onfido
       if attributes.key?(:'us_driving_licence')
         self.us_driving_licence = attributes[:'us_driving_licence']
       end
+
+      if attributes.key?(:'report_configuration')
+        self.report_configuration = attributes[:'report_configuration']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -169,7 +177,8 @@ module Onfido
           suppress_form_emails == o.suppress_form_emails &&
           sub_result == o.sub_result &&
           consider == o.consider &&
-          us_driving_licence == o.us_driving_licence
+          us_driving_licence == o.us_driving_licence &&
+          report_configuration == o.report_configuration
     end
 
     # @see the `==` method
@@ -181,7 +190,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [report_names, document_ids, applicant_provides_data, asynchronous, suppress_form_emails, sub_result, consider, us_driving_licence].hash
+      [report_names, document_ids, applicant_provides_data, asynchronous, suppress_form_emails, sub_result, consider, us_driving_licence, report_configuration].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb

@@ -117,6 +117,9 @@ module Onfido
     # Comma-separated vehicle classes that the user is qualified for
     attr_accessor :raw_vehicle_classes
 
+    # True if the user is not qualified to drive a manual transmission
+    attr_accessor :manual_transmission_restriction
+
     # Detailed classes/categories information
     attr_accessor :vehicle_class_details
 
@@ -196,6 +199,7 @@ module Onfido
         :'restricted_licence' => :'restricted_licence',
         :'raw_licence_category' => :'raw_licence_category',
         :'raw_vehicle_classes' => :'raw_vehicle_classes',
+        :'manual_transmission_restriction' => :'manual_transmission_restriction',
         :'vehicle_class_details' => :'vehicle_class_details',
         :'passenger_vehicle' => :'passenger_vehicle'
       }
@@ -258,6 +262,7 @@ module Onfido
         :'restricted_licence' => :'Boolean',
         :'raw_licence_category' => :'String',
         :'raw_vehicle_classes' => :'String',
+        :'manual_transmission_restriction' => :'Boolean',
         :'vehicle_class_details' => :'Array<DocumentWithDriverVerificationReportAllOfPropertiesAllOfVehicleClassDetailsInner>',
         :'passenger_vehicle' => :'DocumentWithDriverVerificationReportAllOfPropertiesAllOfPassengerVehicle'
       }
@@ -493,6 +498,10 @@ module Onfido
         self.raw_vehicle_classes = attributes[:'raw_vehicle_classes']
       end
 
+      if attributes.key?(:'manual_transmission_restriction')
+        self.manual_transmission_restriction = attributes[:'manual_transmission_restriction']
+      end
+
       if attributes.key?(:'vehicle_class_details')
         if (value = attributes[:'vehicle_class_details']).is_a?(Array)
           self.vehicle_class_details = value
@@ -609,6 +618,7 @@ module Onfido
           restricted_licence == o.restricted_licence &&
           raw_licence_category == o.raw_licence_category &&
           raw_vehicle_classes == o.raw_vehicle_classes &&
+          manual_transmission_restriction == o.manual_transmission_restriction &&
           vehicle_class_details == o.vehicle_class_details &&
           passenger_vehicle == o.passenger_vehicle
     end
@@ -622,7 +632,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [date_of_birth, date_of_expiry, personal_number, document_numbers, document_type, first_name, middle_name, last_name, gender, issuing_country, nationality, issuing_state, issuing_date, categorisation, mrz_line1, mrz_line2, mrz_line3, address, place_of_birth, spouse_name, widow_name, alias_name, issuing_authority, remarks, civil_state, expatriation, father_name, mother_name, religion, type_of_permit, version_number, document_subtype, profession, security_document_number, tax_number, nist_identity_evidence_strength, has_issuance_confirmation, real_id_compliance, security_tier, address_lines, barcode, nfc, driving_licence_information, document_classification, extracted_data, drivers_licence, restricted_licence, raw_licence_category, raw_vehicle_classes, vehicle_class_details, passenger_vehicle].hash
+      [date_of_birth, date_of_expiry, personal_number, document_numbers, document_type, first_name, middle_name, last_name, gender, issuing_country, nationality, issuing_state, issuing_date, categorisation, mrz_line1, mrz_line2, mrz_line3, address, place_of_birth, spouse_name, widow_name, alias_name, issuing_authority, remarks, civil_state, expatriation, father_name, mother_name, religion, type_of_permit, version_number, document_subtype, profession, security_document_number, tax_number, nist_identity_evidence_strength, has_issuance_confirmation, real_id_compliance, security_tier, address_lines, barcode, nfc, driving_licence_information, document_classification, extracted_data, drivers_licence, restricted_licence, raw_licence_category, raw_vehicle_classes, manual_transmission_restriction, vehicle_class_details, passenger_vehicle].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/report_configuration.rb

@@ -0,0 +1,242 @@
+=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.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  # Defines configuration options for facial similarity checks used to distinguish between onboarding and reverification scenarios. 
+  class ReportConfiguration
+    attr_accessor :facial_similarity_photo
+
+    attr_accessor :facial_similarity_photo_fully_auto
+
+    attr_accessor :facial_similarity_video
+
+    attr_accessor :facial_similarity_motion
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'facial_similarity_photo' => :'facial_similarity_photo',
+        :'facial_similarity_photo_fully_auto' => :'facial_similarity_photo_fully_auto',
+        :'facial_similarity_video' => :'facial_similarity_video',
+        :'facial_similarity_motion' => :'facial_similarity_motion'
+      }
+    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
+      {
+        :'facial_similarity_photo' => :'ReportConfigurationFacialSimilarity',
+        :'facial_similarity_photo_fully_auto' => :'ReportConfigurationFacialSimilarity',
+        :'facial_similarity_video' => :'ReportConfigurationFacialSimilarity',
+        :'facial_similarity_motion' => :'ReportConfigurationFacialSimilarity'
+      }
+    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::ReportConfiguration` 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::ReportConfiguration`. 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?(:'facial_similarity_photo')
+        self.facial_similarity_photo = attributes[:'facial_similarity_photo']
+      end
+
+      if attributes.key?(:'facial_similarity_photo_fully_auto')
+        self.facial_similarity_photo_fully_auto = attributes[:'facial_similarity_photo_fully_auto']
+      end
+
+      if attributes.key?(:'facial_similarity_video')
+        self.facial_similarity_video = attributes[:'facial_similarity_video']
+      end
+
+      if attributes.key?(:'facial_similarity_motion')
+        self.facial_similarity_motion = attributes[:'facial_similarity_motion']
+      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'
+      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 &&
+          facial_similarity_photo == o.facial_similarity_photo &&
+          facial_similarity_photo_fully_auto == o.facial_similarity_photo_fully_auto &&
+          facial_similarity_video == o.facial_similarity_video &&
+          facial_similarity_motion == o.facial_similarity_motion
+    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
+      [facial_similarity_photo, facial_similarity_photo_fully_auto, facial_similarity_video, facial_similarity_motion].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_configuration_facial_similarity.rb

@@ -0,0 +1,249 @@
+=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.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  class ReportConfigurationFacialSimilarity
+    # You should set it to \"reverification\" on a post-onboarding scenario (e.g. ongoing authentication). 
+    attr_accessor :use_case
+
+    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
+      {
+        :'use_case' => :'use_case'
+      }
+    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
+      {
+        :'use_case' => :'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::ReportConfigurationFacialSimilarity` 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::ReportConfigurationFacialSimilarity`. 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?(:'use_case')
+        self.use_case = attributes[:'use_case']
+      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'
+      use_case_validator = EnumAttributeValidator.new('String', ["onboarding", "reverification", "unknown_default_open_api"])
+      return false unless use_case_validator.valid?(@use_case)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] use_case Object to be assigned
+    def use_case=(use_case)
+      validator = EnumAttributeValidator.new('String', ["onboarding", "reverification", "unknown_default_open_api"])
+      unless validator.valid?(use_case)
+        fail ArgumentError, "invalid value for \"use_case\", must be one of #{validator.allowable_values}."
+      end
+      @use_case = use_case
+    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 &&
+          use_case == o.use_case
+    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
+      [use_case].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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.11.0
 =end
 
 module Onfido
-  VERSION = '5.1.1'
+  VERSION = '5.3.0'
 end

data/lib/onfido.rb

@@ -228,6 +228,8 @@ require 'onfido/models/proof_of_address_report'
 require 'onfido/models/repeat_attempts_list'
 require 'onfido/models/repeat_attempts_list_repeat_attempts_inner'
 require 'onfido/models/report'
+require 'onfido/models/report_configuration'
+require 'onfido/models/report_configuration_facial_similarity'
 require 'onfido/models/report_document'
 require 'onfido/models/report_name'
 require 'onfido/models/report_result'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 5.1.1
+  version: 5.3.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -349,6 +349,8 @@ files:
 - lib/onfido/models/repeat_attempts_list.rb
 - lib/onfido/models/repeat_attempts_list_repeat_attempts_inner.rb
 - lib/onfido/models/report.rb
+- lib/onfido/models/report_configuration.rb
+- lib/onfido/models/report_configuration_facial_similarity.rb
 - lib/onfido/models/report_document.rb
 - lib/onfido/models/report_name.rb
 - lib/onfido/models/report_result.rb
@@ -491,34 +493,34 @@ specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
 - spec/classic_webhook_event_verifier_spec.rb
-- spec/integrations/motion_capture_spec.rb
-- spec/integrations/id_photo_spec.rb
-- spec/integrations/check_spec.rb
+- spec/integrations/sdk_token_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/applicant_spec.rb
+- spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/integrations/live_photo_spec.rb
+- spec/integrations/extraction_spec.rb
+- spec/integrations/live_video_spec.rb
+- spec/integrations/tasks_spec.rb
+- spec/integrations/document_spec.rb
 - spec/integrations/watchlist_monitor_spec.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/motion_capture_spec.rb
 - spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/media/sample_photo.png
+- spec/integrations/check_spec.rb
+- spec/integrations/report_spec.rb
 - spec/integrations/media/sample_driving_licence.png
-- spec/integrations/live_video_spec.rb
-- spec/integrations/document_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/address_picker_spec.rb
-- spec/integrations/workflow_run_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
+- spec/integrations/media/sample_photo.png
 - spec/integrations/report_schema_spec.rb
-- spec/integrations/sdk_token_spec.rb
-- spec/integrations/tasks_spec.rb
-- spec/integrations/report_spec.rb
-- spec/integrations/extraction_spec.rb
+- spec/integrations/address_picker_spec.rb
 - spec/media/studio_webhook_event_with_object_in_output.json
 - spec/media/studio_webhook_event_with_list_in_output.json
-- spec/shared_contexts/with_applicant.rb
+- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_document.rb
 - spec/shared_contexts/with_check.rb
+- spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_workflow_run.rb
-- spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_live_photo.rb
-- spec/shared_contexts/with_document.rb
 - spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb