onfido 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc79ec450f18e140b4d190ad2d68e2480a4bdacc24818ee605223e3dce3749c0
-  data.tar.gz: 0abfee9a6b0aec0849a0c98caf001775fb9dfd5fcaa04727bf55411a50e91f1d
+  metadata.gz: b50846731ee3d1258557cfbb22b8348d5328af3d2f8b0fba18548e37dc8963ea
+  data.tar.gz: efef5ee6be4f2f839764d11e1fb00f23d24e554b1e1c5bbb33ec127fbe603534
 SHA512:
-  metadata.gz: ee17ead11fb1487cf688a5f54818e5fbe3d0049090c3c5cd072a4c82225bac2d2e7e482eb6995e0cd3b596afcd90799d1e92905dfd7840ecd619f581bc6f6510
-  data.tar.gz: c6c2de626f28cd9eb007554753356889a087aa8d911d6ad260429a3fe20b018a5ebd78cae1765f573fbd3e88e801745cec9cd88b4000dd47c0743a231a85da78
+  metadata.gz: 7460854cfadcc65b683f1087130da5b23f46c3f1e9e4787b9aa5e82a5b8d394e3bea826fd085b70614d5d591e6ab78eff73365bd615ff8bc6e6e7f9f107d9680
+  data.tar.gz: 567a9d3e0e751d042022ea2a41691485a1deedddaf91131f3c599e5390638f0e5155c855f4d58a233a69d0e2f3acd072e0f040d0ff022d0fe326a36034c29192

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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):
+  - Denote webhook event payload.object.href as a not required property
+  - [CAT-1593] Drop invalid enum value from webhook event type
+  - Add applicant_id in GET /workflow_runs
+  - [CAT-1694] Define document file type as free text
+  - Add missing import in ApiClient
+  - [DOCCAP-2513] Add download-nfc-face endpoint
+  - [CAT-1719] Don't impose a type on deprecated records property in watchlist reports
+  - Remove documents property for reports where it's not applicable
+  - Update openapi generator version to v7.10.0 (was v7.9.0)
+  - Update openapi generator version to v7.11.0 (was v7.10.0)
+- Add tests for Download NFC Face endpoint
+- [Migration Guide](MIGRATION.md#upgrading-from-4x-to-5x)
+
 ## 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):

data/README.md

@@ -14,13 +14,13 @@ This version uses Onfido API v3.6. Refer to our [API versioning guide](https://d
 ### Installation
 
 ```ruby
-gem onfido, '~> 5.0.0'
+gem 'onfido', '~> 5.1.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
 
 ```ruby
-require onfido
+require 'onfido'
 
 Onfido.configure do |config|
   config.api_token = ENV["ONFIDO_API_TOKEN"]

data/lib/onfido/api/default_api.rb

@@ -1776,6 +1776,69 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Retrieve Applicant Consents
+    # Retrieves consents for single applicant. 
+    # @param applicant_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ApplicantConsent>]
+    def find_applicant_consents(applicant_id, opts = {})
+      data, _status_code, _headers = find_applicant_consents_with_http_info(applicant_id, opts)
+      data
+    end
+
+    # Retrieve Applicant Consents
+    # Retrieves consents for single applicant. 
+    # @param applicant_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ApplicantConsent>, Integer, Hash)>] Array<ApplicantConsent> data, response status code and response headers
+    def find_applicant_consents_with_http_info(applicant_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.find_applicant_consents ...'
+      end
+      # verify the required parameter 'applicant_id' is set
+      if @api_client.config.client_side_validation && applicant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'applicant_id' when calling DefaultApi.find_applicant_consents"
+      end
+      # resource path
+      local_var_path = '/applicants/{applicant_id}/consents'.sub('{' + 'applicant_id' + '}', CGI.escape(applicant_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ApplicantConsent>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.find_applicant_consents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DefaultApi#find_applicant_consents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve a Check
     # Retrieves a single check. Returns a check object. 
     # @param check_id [String] 

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.0.0"
+      @user_agent = "onfido-ruby/5.1.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/models/applicant_consent.rb

@@ -0,0 +1,272 @@
+=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 ApplicantConsent
+    attr_accessor :name
+
+    attr_accessor :granted
+
+    # The date and time when this applicant consent was granted, if not granted the value is nil.
+    attr_accessor :granted_at
+
+    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
+      {
+        :'name' => :'name',
+        :'granted' => :'granted',
+        :'granted_at' => :'granted_at'
+      }
+    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
+      {
+        :'name' => :'ApplicantConsentName',
+        :'granted' => :'Boolean',
+        :'granted_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'granted_at'
+      ])
+    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::ApplicantConsent` 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::ApplicantConsent`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'granted')
+        self.granted = attributes[:'granted']
+      else
+        self.granted = nil
+      end
+
+      if attributes.key?(:'granted_at')
+        self.granted_at = attributes[:'granted_at']
+      else
+        self.granted_at = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @granted.nil?
+        invalid_properties.push('invalid value for "granted", granted 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 @name.nil?
+      return false if @granted.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 &&
+          name == o.name &&
+          granted == o.granted &&
+          granted_at == o.granted_at
+    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
+      [name, granted, granted_at].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/device_intelligence_breakdown.rb

@@ -15,6 +15,8 @@ require 'time'
 
 module Onfido
   class DeviceIntelligenceBreakdown
+    attr_accessor :device
+
     attr_accessor :breakdown
 
     attr_accessor :properties
@@ -22,6 +24,7 @@ module Onfido
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'device' => :'device',
         :'breakdown' => :'breakdown',
         :'properties' => :'properties'
       }
@@ -35,6 +38,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'device' => :'DeviceIntelligenceBreakdownDevice',
         :'breakdown' => :'DeviceIntelligenceBreakdownBreakdown',
         :'properties' => :'DeviceIntelligenceBreakdownProperties'
       }
@@ -61,6 +65,10 @@ module Onfido
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+
       if attributes.key?(:'breakdown')
         self.breakdown = attributes[:'breakdown']
       end
@@ -90,6 +98,7 @@ module Onfido
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          device == o.device &&
           breakdown == o.breakdown &&
           properties == o.properties
     end
@@ -103,7 +112,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [breakdown, properties].hash
+      [device, breakdown, properties].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/device_intelligence_breakdown_breakdown.rb

@@ -32,7 +32,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'device' => :'DeviceIntelligenceBreakdownBreakdownDevice'
+        :'device' => :'DeviceIntelligenceBreakdownDevice'
       }
     end
 

data/lib/onfido/models/{device_intelligence_breakdown_breakdown_device.rb → device_intelligence_breakdown_device.rb}

@@ -15,7 +15,7 @@ require 'time'
 
 module Onfido
   # Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
-  class DeviceIntelligenceBreakdownBreakdownDevice
+  class DeviceIntelligenceBreakdownDevice
     attr_accessor :breakdown
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -33,7 +33,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'breakdown' => :'DeviceIntelligenceBreakdownBreakdownDeviceBreakdown'
+        :'breakdown' => :'DeviceIntelligenceBreakdownDeviceBreakdown'
       }
     end
 
@@ -47,13 +47,13 @@ module Onfido
     # @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::DeviceIntelligenceBreakdownBreakdownDevice` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DeviceIntelligenceBreakdownDevice` 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::DeviceIntelligenceBreakdownBreakdownDevice`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::DeviceIntelligenceBreakdownDevice`. 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
       }

data/lib/onfido/models/{device_intelligence_breakdown_breakdown_device_breakdown.rb → device_intelligence_breakdown_device_breakdown.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Onfido
-  class DeviceIntelligenceBreakdownBreakdownDeviceBreakdown
+  class DeviceIntelligenceBreakdownDeviceBreakdown
     attr_accessor :application_authenticity
 
     attr_accessor :device_integrity
@@ -54,13 +54,13 @@ module Onfido
     # @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::DeviceIntelligenceBreakdownBreakdownDeviceBreakdown` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DeviceIntelligenceBreakdownDeviceBreakdown` 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::DeviceIntelligenceBreakdownBreakdownDeviceBreakdown`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Onfido::DeviceIntelligenceBreakdownDeviceBreakdown`. 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
       }

data/lib/onfido/models/device_intelligence_breakdown_properties_device.rb

@@ -117,7 +117,7 @@ module Onfido
         :'randomized_device' => :'Boolean',
         :'fake_network_request' => :'Boolean',
         :'ip_reputation' => :'String',
-        :'device_fingerprint_reuse' => :'Integer',
+        :'device_fingerprint_reuse' => :'Float',
         :'single_device_used' => :'Boolean',
         :'document_capture' => :'String',
         :'biometric_capture' => :'String'