onfido 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b50846731ee3d1258557cfbb22b8348d5328af3d2f8b0fba18548e37dc8963ea
-  data.tar.gz: efef5ee6be4f2f839764d11e1fb00f23d24e554b1e1c5bbb33ec127fbe603534
+  metadata.gz: d9d1b25944b1a8260f459e08ea5fa12d445303f25066e75736c3d305ec77b52f
+  data.tar.gz: 700a5d91654fe610c6b95f206edf1d85366e06dd24ce9ff84fd95c8e89cc6cb1
 SHA512:
-  metadata.gz: 7460854cfadcc65b683f1087130da5b23f46c3f1e9e4787b9aa5e82a5b8d394e3bea826fd085b70614d5d591e6ab78eff73365bd615ff8bc6e6e7f9f107d9680
-  data.tar.gz: 567a9d3e0e751d042022ea2a41691485a1deedddaf91131f3c599e5390638f0e5155c855f4d58a233a69d0e2f3acd072e0f040d0ff022d0fe326a36034c29192
+  metadata.gz: 93a5c47f5302b73dd9666f85741c7c199731e9d6bb703b169d2dd3ec02521fac1fb1c5b1e0ee2402fe279e4e4d66b026ddc591e756dcf2d3da6c59a6c2ee589d
+  data.tar.gz: 683b92367a3e2ca427c7dbebbb5847927f45d61437786d78dd916d323e42fcebf78966196dc779a32998a6179ec3b49c1a089fb2dd9437c0856b4b9b80bcd9ae

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 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):
+  - CAT-1760: create get applicant consents endpoint
+  - Update Ruby library README template
+  - [CAT-1911] Fix document_with_driving_licence_information to be a list of objects
+  - [AF-1390] Fix: Device Intelligence Report Schema
+  - [CAT-1944] Add OAuth fields for Webhook authentication
+  - 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):
@@ -16,6 +34,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):
@@ -25,33 +45,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):
@@ -63,6 +95,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.0'
+gem 'onfido', '~> 5.2.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.0"
+      @user_agent = "onfido-ruby/5.2.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -175,7 +175,7 @@ module Onfido
 
       # reconstruct content
       content = stream.join
-      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'base64'  
       content = content.force_encoding(encoding)
 
       # return byte stream

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/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.0'
+  VERSION = '5.2.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'

data/spec/integrations/check_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_check'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::Check do
   describe 'Checks' do
@@ -74,10 +75,10 @@ describe Onfido::Check do
       onfido_api.resume_check(check_id)
     end
 
-    it 'downloads a check' do
-      file = onfido_api.download_check(check_id)
+    describe 'downloading a check' do
+      let(:file) { onfido_api.download_check(check_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PDF file"
     end
   end
 end

data/spec/integrations/document_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_document'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::Document do
   describe 'Documents' do
@@ -27,10 +28,10 @@ describe Onfido::Document do
       expect(get_document.id).to eq document_id
     end
 
-    it 'downloads a document' do
-      file = onfido_api.download_document(document_id)
+    describe 'downloading a document' do
+      let(:file) { onfido_api.download_document(document_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PNG file", 361771
     end
 
     it 'cannot download an inexistent document' do
@@ -41,10 +42,10 @@ describe Onfido::Document do
       }
     end
 
-    it 'downloads an NFC face' do
-      file = onfido_api.download_nfc_face(nfc_face_id)
+    describe 'downloading an NFC face' do
+      let(:file) { onfido_api.download_nfc_face(nfc_face_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PNG file", 471345
     end
 
     it 'cannot download an inexistent NFC face' do

data/spec/integrations/id_photo_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_applicant'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::IdPhoto do
   describe 'Id Photo' do
@@ -35,10 +36,10 @@ describe Onfido::IdPhoto do
       expect(get_id_photo.id).to eq id_photo_id
     end
 
-    it 'downloads id photo' do
-      file = onfido_api.download_id_photo(id_photo_id)
+    describe 'downloading id photo' do
+      let(:file) { onfido_api.download_id_photo(id_photo_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid PNG file", 395856
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent id photo' do

data/spec/integrations/live_photo_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_live_photo'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::LivePhoto do
   describe 'Live Photo' do
@@ -27,10 +28,10 @@ describe Onfido::LivePhoto do
       expect(live_photo).to be_an_instance_of Onfido::LivePhoto
     end
 
-    it 'downloads live photo' do
-      file = onfido_api.download_live_photo(live_photo_id)
+    describe 'downloading live photo' do
+      let(:file) { onfido_api.download_live_photo(live_photo_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid PNG file", 395856
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent live photo' do

data/spec/integrations/live_video_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_onfido'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::LiveVideo do
   describe 'Live Video' do
@@ -24,16 +25,16 @@ describe Onfido::LiveVideo do
       expect(get_live_video).to be_an_instance_of Onfido::LiveVideo
     end
 
-    it 'downloads live video' do
-      file = onfido_api.download_live_video(live_video_id)
+    describe 'downloading live video' do
+      let(:file) { onfido_api.download_live_video(live_video_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid MP4 file", 165093
     end
 
-    it 'downloads live video frame' do
-      file = onfido_api.download_live_video_frame(live_video_id)
+    describe 'downloading live video frame' do
+      let(:file) { onfido_api.download_live_video_frame(live_video_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid JPEG file", 1692
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent live video' do

data/spec/integrations/motion_capture_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_onfido'
+require_relative '../shared_examples/file_examples'
 
 describe Onfido::MotionCapture do
   describe 'Motion Capture' do
@@ -24,16 +25,16 @@ describe Onfido::MotionCapture do
       expect(get_motion_capture).to be_an_instance_of Onfido::MotionCapture
     end
 
-    it 'downloads motion capture' do
-      file = onfido_api.download_motion_capture(motion_id)
+    describe 'downloading live video' do
+      let(:file) { onfido_api.download_motion_capture(motion_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid MP4 file", 2720276
     end
 
-    it 'downloads motion capture frame' do
-      file = onfido_api.download_motion_capture_frame(motion_id)
+    describe 'downloading live video frame' do
+      let(:file) { onfido_api.download_motion_capture_frame(motion_id) }
 
-      expect(file.length).to be > 0
+      it_behaves_like "a valid JPEG file", 75627
     end
 
     it 'raises an error with the correct status code when trying to download an inexistent motion capture' do

data/spec/integrations/workflow_run_spec.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative '../shared_contexts/with_workflow_run'
+require_relative '../shared_examples/file_examples'
+
 require 'zip'
 
 describe Onfido::WorkflowRun do
@@ -47,10 +49,10 @@ describe Onfido::WorkflowRun do
       expect(get_workflow_run.id).to eq workflow_run_id
     end
 
-    it 'downloads evidence file' do
-      file = onfido_api.download_signed_evidence_file(workflow_run_id)
+    describe 'downloading evidence file' do
+      let(:file) { onfido_api.download_signed_evidence_file(workflow_run_id) }
 
-      expect(file.size).to be > 0
+      it_behaves_like "a valid PDF file", 497605
     end
 
     context 'with start -> approved workflow' do
@@ -78,7 +80,7 @@ describe Onfido::WorkflowRun do
           onfido_api.find_timeline_file(workflow_run_id, timeline_file_id)
         end
 
-        expect(file.size).to be > 0
+        expect(file.size).to be > 100000
       end
 
       it 'downloads an evidence folder' do
@@ -87,7 +89,7 @@ describe Onfido::WorkflowRun do
         end
 
         Zip::File.open(file.path) do |zip|
-          expect(zip.entries.size).to be > 0
+          expect(zip.entries.size).to be > 1
         end
       end
     end

data/spec/shared_examples/file_examples.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for "a valid file" do |expected_size|
+  it "is not nil and has a size greater than 0" do
+    expect(file).not_to be_nil
+    expect(file.size).to be > 0
+  end
+
+  it "has the expected file size" do
+    expect(file.size).to equal expected_size if expected_size
+  end
+end
+
+RSpec.shared_examples_for "a file with signature" do |signature, offset, length|
+  it "has a valid signature" do
+    signature_to_check = String.new(signature, encoding: 'BINARY')
+
+    File.open(file.path, 'rb') do |file_handler|
+      file_handler.rewind
+      content = file_handler.read(offset + length)
+      expect(content[offset, length]).to eq(signature_to_check)
+    end
+  end
+end
+
+RSpec.shared_examples_for "a valid PNG file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "\x89PNG\r\n\x1A\n", 0, 8
+end
+
+RSpec.shared_examples_for "a valid PDF file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "%PDF-", 0, 5
+end
+
+RSpec.shared_examples_for "a valid JPEG file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "\xFF\xD8\xFF\xE0\x00\x10JF", 0, 8
+end
+
+RSpec.shared_examples_for "a valid MP4 file" do |expected_size|
+  include_examples "a valid file", expected_size
+  include_examples "a file with signature", "ftyp", 4, 4
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-14 00:00:00.000000000 Z
+date: 2025-06-05 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
@@ -463,6 +465,7 @@ files:
 - spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_onfido.rb
 - spec/shared_contexts/with_workflow_run.rb
+- spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb
 homepage: https://github.com/onfido/onfido-ruby
@@ -490,33 +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/report_schema_spec.rb
+- spec/integrations/extraction_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/watchlist_monitor_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
-- spec/integrations/media/sample_photo.png
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/live_video_spec.rb
+- spec/integrations/sdk_token_spec.rb
 - spec/integrations/document_spec.rb
-- spec/integrations/webhook_spec.rb
-- spec/integrations/applicant_spec.rb
+- spec/integrations/tasks_spec.rb
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/media/sample_photo.png
+- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/id_photo_spec.rb
 - spec/integrations/address_picker_spec.rb
-- spec/integrations/workflow_run_spec.rb
+- spec/integrations/live_video_spec.rb
 - spec/integrations/qualified_electronic_signature_spec.rb
-- 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/media/studio_webhook_event_with_object_in_output.json
+- spec/integrations/check_spec.rb
+- spec/integrations/webhook_spec.rb
+- spec/integrations/applicant_spec.rb
+- spec/integrations/motion_capture_spec.rb
 - spec/media/studio_webhook_event_with_list_in_output.json
-- spec/shared_contexts/with_applicant.rb
+- spec/media/studio_webhook_event_with_object_in_output.json
 - spec/shared_contexts/with_check.rb
-- spec/shared_contexts/with_workflow_run.rb
-- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_live_photo.rb
+- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_workflow_run.rb
 - spec/shared_contexts/with_document.rb
+- spec/shared_examples/file_examples.rb
 - spec/spec_helper.rb
 - spec/studio_webhook_event_verifier_spec.rb