onfido 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1440532a4dd2a2ad41208150fe93557b9d302661b5068548dac11e67b8e3753a
-  data.tar.gz: 7c36df59da3fc856cda3aa51e0522d14c4866075a16124afd456e2e2076e6032
+  metadata.gz: 84c97682271bcf86f213850a497db54f4ca3d89574a9306a543decbfd8b5db29
+  data.tar.gz: b6f0a08180cfb57ed019b873776f1f723065e050d9c4e5ff512b0aabf8c73dfd
 SHA512:
-  metadata.gz: 7eab059fd49dd484100496de953606242571165688156376d23822434fe2af370f8ee2f9f491939f68f2db582b657b495f050a1dde7faea6ef2a930fa5db633d
-  data.tar.gz: a9d532d9efa8a25dc7be70bce86eb45f20e53efb928d0b7ce6f456b96e1383f180b2c7fca8ec229b280d6e6203f2fefd7711b93924d58e5045888205c81a5aa5
+  metadata.gz: eade09a8e29ab656d8c032e470c81a044f47b791e171b3b610a519ffd8866a22dea53dd9dba5df0c6a75d357299fb47852cd02c2349efece713ea7f812fa2d47
+  data.tar.gz: d5e4b6c96bf9c9ef1d189a5f5b14b0f31282fd7fa3178daa75eecb79c962b19940c2d2ffba1d93dde8253330f859dc9857f7c9c6de12d9767f1d683c567c7821

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 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):
+  - [CAT-1379] Add a few missing properties
+  - [CAT-1447] Fix applicant consents
+  - [CAT-1379] Fix check creation, remove some deprecated properties and deprecate others
+  - Use document-type enum for document upload
+  - [CAT-1306] Add webhooks event resource
+  - Upgrade OpenAPI generator to v7.9.0 (was v7.6.0)
+  - [Migration Guide](MIGRATION.md#upgrading-from-3x-to-4x)
+
 ## 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, '~> 4.0.0'
+gem onfido, '~> 4.1.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):

data/lib/onfido/api_client.rb

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

data/lib/onfido/models/document_properties.rb

@@ -226,7 +226,7 @@ module Onfido
         :'real_id_compliance' => :'Boolean',
         :'security_tier' => :'String',
         :'address_lines' => :'DocumentPropertiesAddressLines',
-        :'barcode' => :'Array<DocumentPropertiesBarcodeInner>',
+        :'barcode' => :'DocumentPropertiesBarcode',
         :'nfc' => :'DocumentPropertiesNfc',
         :'driving_licence_information' => :'DocumentPropertiesDrivingLicenceInformation',
         :'document_classification' => :'DocumentPropertiesDocumentClassification',
@@ -418,9 +418,7 @@ module Onfido
       end
 
       if attributes.key?(:'barcode')
-        if (value = attributes[:'barcode']).is_a?(Array)
-          self.barcode = value
-        end
+        self.barcode = attributes[:'barcode']
       end
 
       if attributes.key?(:'nfc')

data/lib/onfido/models/{document_properties_barcode_inner.rb → document_properties_barcode.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Onfido
-  class DocumentPropertiesBarcodeInner
+  class DocumentPropertiesBarcode
     attr_accessor :first_name
 
     attr_accessor :middle_name
@@ -114,13 +114,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::DocumentPropertiesBarcodeInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentPropertiesBarcode` 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::DocumentPropertiesBarcodeInner`. 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::DocumentPropertiesBarcode`. 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/document_with_driver_verification_report_all_of_properties.rb

@@ -249,7 +249,7 @@ module Onfido
         :'real_id_compliance' => :'Boolean',
         :'security_tier' => :'String',
         :'address_lines' => :'DocumentPropertiesAddressLines',
-        :'barcode' => :'Array<DocumentPropertiesBarcodeInner>',
+        :'barcode' => :'DocumentPropertiesBarcode',
         :'nfc' => :'DocumentPropertiesNfc',
         :'driving_licence_information' => :'DocumentPropertiesDrivingLicenceInformation',
         :'document_classification' => :'DocumentPropertiesDocumentClassification',
@@ -454,9 +454,7 @@ module Onfido
       end
 
       if attributes.key?(:'barcode')
-        if (value = attributes[:'barcode']).is_a?(Array)
-          self.barcode = value
-        end
+        self.barcode = attributes[:'barcode']
       end
 
       if attributes.key?(:'nfc')

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.9.0
 =end
 
 module Onfido
-  VERSION = '4.0.0'
+  VERSION = '4.1.0'
 end

data/lib/onfido.rb

@@ -92,7 +92,7 @@ require 'onfido/models/document_iq_reasons'
 require 'onfido/models/document_odp_reasons'
 require 'onfido/models/document_properties'
 require 'onfido/models/document_properties_address_lines'
-require 'onfido/models/document_properties_barcode_inner'
+require 'onfido/models/document_properties_barcode'
 require 'onfido/models/document_properties_document_classification'
 require 'onfido/models/document_properties_document_numbers_inner'
 require 'onfido/models/document_properties_driving_licence_information'

data/spec/integrations/report_schema_spec.rb

@@ -41,5 +41,22 @@ describe Onfido::Report do
 
       expect(facial_similarity_report).to be_an_instance_of Onfido::FacialSimilarityPhotoReport
     end
+
+    it 'schema of Document With Address Information report is valid' do
+      report_id = onfido_api.create_check(
+        Onfido::CheckBuilder.new(
+          applicant_id: applicant_id,
+          document_ids: [document_id],
+          report_names: [Onfido::ReportName::DOCUMENT_WITH_ADDRESS_INFORMATION],
+      )).report_ids[0]
+
+      report = repeat_request_until_status_changes(
+        Onfido::ReportStatus::COMPLETE
+      ) { onfido_api.find_report(report_id) }
+
+      expect(report).to be_an_instance_of Onfido::DocumentWithAddressInformationReport
+      expect(report.properties.barcode).to be_an_instance_of Onfido::DocumentPropertiesBarcode
+      expect(report.properties.barcode.document_type).to eq("driving_licence")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-24 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -213,7 +213,7 @@ files:
 - lib/onfido/models/document_odp_reasons.rb
 - lib/onfido/models/document_properties.rb
 - lib/onfido/models/document_properties_address_lines.rb
-- lib/onfido/models/document_properties_barcode_inner.rb
+- lib/onfido/models/document_properties_barcode.rb
 - lib/onfido/models/document_properties_document_classification.rb
 - lib/onfido/models/document_properties_document_numbers_inner.rb
 - lib/onfido/models/document_properties_driving_licence_information.rb