onfido 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7d0e5a36b63c80054591811ae2e6ebe0a221b58352b53130da2e2cb53cf2bee
-  data.tar.gz: 5cd5f1afa7bb2d2dd82f0db84e407cad430bbe66cc8af3318fb54e9c9d0b10fc
+  metadata.gz: 8b1b0a9b1f5e69e278fc7001f2cbbce7c86dbf87857592f0d484f995a30060e7
+  data.tar.gz: 558baf4a305a2834ccbe70e70b9170d22bcb5078fa95137b473362913a7512b4
 SHA512:
-  metadata.gz: a372a4c0ad74bacd1a065b8b294e35002fd7fa9a5e8f27239ce50d4909c6ce5c481c778a5e7420e087ec1eb3afe673e19ef206ee771c5f5b2c62a7a75e0dbf8f
-  data.tar.gz: 86303e99596c6b75a194913bdacd6a192d4e00d8eee69e5e18f3105a7e87e262fece2060371237dfeb78c8010107f9a98ccc1d30839ee2f14ace835af0d71e50
+  metadata.gz: 1f27173db1bf62e097539f20aac439d28b313d430756e44fee5ab981cc5c540cd1e8292546716db9e43946712361d3434ab20e2388349e2988f89a958f9c235e
+  data.tar.gz: c9edc6a9e9ad038140954efca57e884fa46139e27922ffddfe2be8f1a74aa66afbfd224a6d93bd5cda3d9372facffcdd5cc8c0c7f5ad28dcb60d155292ed099c

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v3.2.0 18th July 2024
+
+- Release based on Onfido OpenAPI spec version [v3.2.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.2.0):
+  - [CAT-1289] Document report's properties: Add middle name
+  - chore(qes): add documents endpoint
+  - [CAT-1297] Webhook Event: remove uuid format from object.id
+  - fix(qes): fix download document http method
+  - Add started_at_iso8601 field in webhook event
+  - add jpeg file type for documents
+- Fix error handling documentation in README file
+
 ## v3.1.0 5th July 2024
 
 - Release based on Onfido OpenAPI spec version [v3.1.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.1.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, '~> 3.2.0'
+gem onfido, '~> 3.3.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/3.2.0"
+      @user_agent = "onfido-ruby/3.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/onfido/models/workflow_run.rb

@@ -24,6 +24,9 @@ module Onfido
     # Tags or labels assigned to the workflow run.
     attr_accessor :tags
 
+    # Customer-provided user identifier.
+    attr_accessor :customer_user_id
+
     attr_accessor :link
 
     # The date and time when the Workflow Run was created.
@@ -52,6 +55,9 @@ module Onfido
 
     attr_accessor :error
 
+    # Client token to use when loading this workflow run in the Onfido SDK.
+    attr_accessor :sdk_token
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -80,6 +86,7 @@ module Onfido
         :'applicant_id' => :'applicant_id',
         :'workflow_id' => :'workflow_id',
         :'tags' => :'tags',
+        :'customer_user_id' => :'customer_user_id',
         :'link' => :'link',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
@@ -89,7 +96,8 @@ module Onfido
         :'status' => :'status',
         :'output' => :'output',
         :'reasons' => :'reasons',
-        :'error' => :'error'
+        :'error' => :'error',
+        :'sdk_token' => :'sdk_token'
       }
     end
 
@@ -104,6 +112,7 @@ module Onfido
         :'applicant_id' => :'String',
         :'workflow_id' => :'String',
         :'tags' => :'Array<String>',
+        :'customer_user_id' => :'String',
         :'link' => :'WorkflowRunSharedLink',
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
@@ -113,7 +122,8 @@ module Onfido
         :'status' => :'String',
         :'output' => :'Object',
         :'reasons' => :'Array<String>',
-        :'error' => :'WorkflowRunResponseError'
+        :'error' => :'WorkflowRunResponseError',
+        :'sdk_token' => :'String'
       }
     end
 
@@ -121,6 +131,7 @@ module Onfido
     def self.openapi_nullable
       Set.new([
         :'tags',
+        :'sdk_token'
       ])
     end
 
@@ -165,6 +176,10 @@ module Onfido
         end
       end
 
+      if attributes.key?(:'customer_user_id')
+        self.customer_user_id = attributes[:'customer_user_id']
+      end
+
       if attributes.key?(:'link')
         self.link = attributes[:'link']
       end
@@ -208,6 +223,10 @@ module Onfido
       if attributes.key?(:'error')
         self.error = attributes[:'error']
       end
+
+      if attributes.key?(:'sdk_token')
+        self.sdk_token = attributes[:'sdk_token']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -227,6 +246,10 @@ module Onfido
         invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 30.')
       end
 
+      if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
+        invalid_properties.push('invalid value for "customer_user_id", the character length must be smaller than or equal to 256.')
+      end
+
       if @id.nil?
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
@@ -241,6 +264,7 @@ module Onfido
       return false if @applicant_id.nil?
       return false if @workflow_id.nil?
       return false if !@tags.nil? && @tags.length > 30
+      return false if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
       return false if @id.nil?
       status_validator = EnumAttributeValidator.new('String', ["awaiting_input", "processing", "abandoned", "error", "approved", "review", "declined", "unknown_default_open_api"])
       return false unless status_validator.valid?(@status)
@@ -257,6 +281,20 @@ module Onfido
       @tags = tags
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer_user_id Value to be assigned
+    def customer_user_id=(customer_user_id)
+      if customer_user_id.nil?
+        fail ArgumentError, 'customer_user_id cannot be nil'
+      end
+
+      if customer_user_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "customer_user_id", the character length must be smaller than or equal to 256.'
+      end
+
+      @customer_user_id = customer_user_id
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -275,6 +313,7 @@ module Onfido
           applicant_id == o.applicant_id &&
           workflow_id == o.workflow_id &&
           tags == o.tags &&
+          customer_user_id == o.customer_user_id &&
           link == o.link &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
@@ -284,7 +323,8 @@ module Onfido
           status == o.status &&
           output == o.output &&
           reasons == o.reasons &&
-          error == o.error
+          error == o.error &&
+          sdk_token == o.sdk_token
     end
 
     # @see the `==` method
@@ -296,7 +336,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [applicant_id, workflow_id, tags, link, created_at, updated_at, id, workflow_version_id, dashboard_url, status, output, reasons, error].hash
+      [applicant_id, workflow_id, tags, customer_user_id, link, created_at, updated_at, id, workflow_version_id, dashboard_url, status, output, reasons, error, sdk_token].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/workflow_run_builder.rb

@@ -24,6 +24,9 @@ module Onfido
     # Tags or labels assigned to the workflow run.
     attr_accessor :tags
 
+    # Customer-provided user identifier.
+    attr_accessor :customer_user_id
+
     attr_accessor :link
 
     # The date and time when the Workflow Run was created.
@@ -41,6 +44,7 @@ module Onfido
         :'applicant_id' => :'applicant_id',
         :'workflow_id' => :'workflow_id',
         :'tags' => :'tags',
+        :'customer_user_id' => :'customer_user_id',
         :'link' => :'link',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at',
@@ -59,6 +63,7 @@ module Onfido
         :'applicant_id' => :'String',
         :'workflow_id' => :'String',
         :'tags' => :'Array<String>',
+        :'customer_user_id' => :'String',
         :'link' => :'WorkflowRunSharedLink',
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
@@ -114,6 +119,10 @@ module Onfido
         end
       end
 
+      if attributes.key?(:'customer_user_id')
+        self.customer_user_id = attributes[:'customer_user_id']
+      end
+
       if attributes.key?(:'link')
         self.link = attributes[:'link']
       end
@@ -150,6 +159,10 @@ module Onfido
         invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 30.')
       end
 
+      if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
+        invalid_properties.push('invalid value for "customer_user_id", the character length must be smaller than or equal to 256.')
+      end
+
       invalid_properties
     end
 
@@ -160,6 +173,7 @@ module Onfido
       return false if @applicant_id.nil?
       return false if @workflow_id.nil?
       return false if !@tags.nil? && @tags.length > 30
+      return false if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
       true
     end
 
@@ -173,6 +187,20 @@ module Onfido
       @tags = tags
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer_user_id Value to be assigned
+    def customer_user_id=(customer_user_id)
+      if customer_user_id.nil?
+        fail ArgumentError, 'customer_user_id cannot be nil'
+      end
+
+      if customer_user_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "customer_user_id", the character length must be smaller than or equal to 256.'
+      end
+
+      @customer_user_id = customer_user_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -181,6 +209,7 @@ module Onfido
           applicant_id == o.applicant_id &&
           workflow_id == o.workflow_id &&
           tags == o.tags &&
+          customer_user_id == o.customer_user_id &&
           link == o.link &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
@@ -196,7 +225,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [applicant_id, workflow_id, tags, link, created_at, updated_at, custom_data].hash
+      [applicant_id, workflow_id, tags, customer_user_id, link, created_at, updated_at, custom_data].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/workflow_run_response.rb

@@ -35,6 +35,9 @@ module Onfido
 
     attr_accessor :error
 
+    # Client token to use when loading this workflow run in the Onfido SDK.
+    attr_accessor :sdk_token
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -66,7 +69,8 @@ module Onfido
         :'status' => :'status',
         :'output' => :'output',
         :'reasons' => :'reasons',
-        :'error' => :'error'
+        :'error' => :'error',
+        :'sdk_token' => :'sdk_token'
       }
     end
 
@@ -84,13 +88,15 @@ module Onfido
         :'status' => :'String',
         :'output' => :'Object',
         :'reasons' => :'Array<String>',
-        :'error' => :'WorkflowRunResponseError'
+        :'error' => :'WorkflowRunResponseError',
+        :'sdk_token' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'sdk_token'
       ])
     end
 
@@ -140,6 +146,10 @@ module Onfido
       if attributes.key?(:'error')
         self.error = attributes[:'error']
       end
+
+      if attributes.key?(:'sdk_token')
+        self.sdk_token = attributes[:'sdk_token']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -185,7 +195,8 @@ module Onfido
           status == o.status &&
           output == o.output &&
           reasons == o.reasons &&
-          error == o.error
+          error == o.error &&
+          sdk_token == o.sdk_token
     end
 
     # @see the `==` method
@@ -197,7 +208,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workflow_version_id, dashboard_url, status, output, reasons, error].hash
+      [id, workflow_version_id, dashboard_url, status, output, reasons, error, sdk_token].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/workflow_run_shared.rb

@@ -24,6 +24,9 @@ module Onfido
     # Tags or labels assigned to the workflow run.
     attr_accessor :tags
 
+    # Customer-provided user identifier.
+    attr_accessor :customer_user_id
+
     attr_accessor :link
 
     # The date and time when the Workflow Run was created.
@@ -38,6 +41,7 @@ module Onfido
         :'applicant_id' => :'applicant_id',
         :'workflow_id' => :'workflow_id',
         :'tags' => :'tags',
+        :'customer_user_id' => :'customer_user_id',
         :'link' => :'link',
         :'created_at' => :'created_at',
         :'updated_at' => :'updated_at'
@@ -55,6 +59,7 @@ module Onfido
         :'applicant_id' => :'String',
         :'workflow_id' => :'String',
         :'tags' => :'Array<String>',
+        :'customer_user_id' => :'String',
         :'link' => :'WorkflowRunSharedLink',
         :'created_at' => :'Time',
         :'updated_at' => :'Time'
@@ -101,6 +106,10 @@ module Onfido
         end
       end
 
+      if attributes.key?(:'customer_user_id')
+        self.customer_user_id = attributes[:'customer_user_id']
+      end
+
       if attributes.key?(:'link')
         self.link = attributes[:'link']
       end
@@ -131,6 +140,10 @@ module Onfido
         invalid_properties.push('invalid value for "tags", number of items must be less than or equal to 30.')
       end
 
+      if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
+        invalid_properties.push('invalid value for "customer_user_id", the character length must be smaller than or equal to 256.')
+      end
+
       invalid_properties
     end
 
@@ -141,6 +154,7 @@ module Onfido
       return false if @applicant_id.nil?
       return false if @workflow_id.nil?
       return false if !@tags.nil? && @tags.length > 30
+      return false if !@customer_user_id.nil? && @customer_user_id.to_s.length > 256
       true
     end
 
@@ -154,6 +168,20 @@ module Onfido
       @tags = tags
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer_user_id Value to be assigned
+    def customer_user_id=(customer_user_id)
+      if customer_user_id.nil?
+        fail ArgumentError, 'customer_user_id cannot be nil'
+      end
+
+      if customer_user_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "customer_user_id", the character length must be smaller than or equal to 256.'
+      end
+
+      @customer_user_id = customer_user_id
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -162,6 +190,7 @@ module Onfido
           applicant_id == o.applicant_id &&
           workflow_id == o.workflow_id &&
           tags == o.tags &&
+          customer_user_id == o.customer_user_id &&
           link == o.link &&
           created_at == o.created_at &&
           updated_at == o.updated_at
@@ -176,7 +205,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [applicant_id, workflow_id, tags, link, created_at, updated_at].hash
+      [applicant_id, workflow_id, tags, customer_user_id, link, created_at, updated_at].hash
     end
 
     # Builds the object from hash

data/lib/onfido/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.6.0
 =end
 
 module Onfido
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -453,31 +453,31 @@ signing_key:
 specification_version: 4
 summary: The official Ruby library for integrating with the Onfido API.
 test_files:
-- spec/integrations/id_photo_spec.rb
+- spec/integrations/live_photo_spec.rb
+- spec/integrations/sdk_token_spec.rb
+- spec/integrations/watchlist_monitor_spec.rb
+- spec/integrations/live_video_spec.rb
+- spec/integrations/qualified_electronic_signature_spec.rb
 - spec/integrations/workflow_run_spec.rb
-- spec/integrations/media/sample_driving_licence.png
-- spec/integrations/media/sample_photo.png
-- spec/integrations/webhook_spec.rb
-- spec/integrations/report_spec.rb
-- spec/integrations/workflow_run_output_spec.rb
+- spec/integrations/applicant_spec.rb
 - spec/integrations/check_spec.rb
-- spec/integrations/tasks_spec.rb
+- spec/integrations/motion_capture_spec.rb
 - spec/integrations/extraction_spec.rb
-- spec/integrations/watchlist_monitor_spec.rb
+- spec/integrations/webhook_spec.rb
 - spec/integrations/address_picker_spec.rb
-- spec/integrations/applicant_spec.rb
-- spec/integrations/motion_capture_spec.rb
-- spec/integrations/live_photo_spec.rb
 - spec/integrations/report_schema_spec.rb
-- spec/integrations/qualified_electronic_signature_spec.rb
-- spec/integrations/sdk_token_spec.rb
+- spec/integrations/media/sample_photo.png
+- spec/integrations/media/sample_driving_licence.png
+- spec/integrations/report_spec.rb
+- spec/integrations/tasks_spec.rb
 - spec/integrations/document_spec.rb
-- spec/integrations/live_video_spec.rb
-- spec/shared_contexts/with_workflow_run.rb
-- spec/shared_contexts/with_live_photo.rb
-- spec/shared_contexts/with_onfido.rb
+- spec/integrations/id_photo_spec.rb
+- spec/integrations/workflow_run_output_spec.rb
+- spec/shared_contexts/with_applicant.rb
 - spec/shared_contexts/with_document.rb
+- spec/shared_contexts/with_onfido.rb
+- spec/shared_contexts/with_live_photo.rb
 - spec/shared_contexts/with_check.rb
-- spec/shared_contexts/with_applicant.rb
+- spec/shared_contexts/with_workflow_run.rb
 - spec/spec_helper.rb
 - spec/webhook_event_verifier_spec.rb