onfido 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49647b89683e1a972dd4aa7fc52fe3b83a2ef5b91015b703f2f1825163aefdf
-  data.tar.gz: c2c0fc5cfef81086c92b90765ab0156b4d401bde312566350edfe8dd52d90a87
+  metadata.gz: 8b1b0a9b1f5e69e278fc7001f2cbbce7c86dbf87857592f0d484f995a30060e7
+  data.tar.gz: 558baf4a305a2834ccbe70e70b9170d22bcb5078fa95137b473362913a7512b4
 SHA512:
-  metadata.gz: 7ad579443fe7bb71ea26ebf39c622959f386bbae04a6450fb5d6617026e68a691c67a6ddb9928f97a4610161c246ac596a8ca8b226df907836a1ab6293e058b5
-  data.tar.gz: 667e52f85d7afb8d775c66db9ccfb6f121feb80510628784863ce576321f66cc19014f850397696598ad116d04171db1f465baf218cb99801a3ddf9cdfcff329
+  metadata.gz: 1f27173db1bf62e097539f20aac439d28b313d430756e44fee5ab981cc5c540cd1e8292546716db9e43946712361d3434ab20e2388349e2988f89a958f9c235e
+  data.tar.gz: c9edc6a9e9ad038140954efca57e884fa46139e27922ffddfe2be8f1a74aa66afbfd224a6d93bd5cda3d9372facffcdd5cc8c0c7f5ad28dcb60d155292ed099c

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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):
+  - Add missing fields in document report's properties
+
 ## v3.0.0 24th June 2024
 
 - Library has been rebuilt from scratch and automatically generated on [Onfido OpenAPI Spec](https://github.com/onfido/onfido-openapi-spec) (release [v3.0.0](https://github.com/onfido/onfido-openapi-spec/releases/tag/v3.0.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.1.0'
+gem onfido, '~> 3.3.0'
 ```
 
 Configure with your API token, region and optional timeout (default value is 30):
@@ -46,20 +46,20 @@ Documentation and code examples can be found at https://documentation.onfido.com
 
 ## Error Handling
 
-All errors are wrapped by `ApiError` coming from [FaradayExpection](https://www.rubydoc.info/github/lostisland/faraday/Faraday/ClientError):
+All errors are wrapped by `ApiError` coming from [FaradayException](https://www.rubydoc.info/github/lostisland/faraday/Faraday/ClientError):
 
 - `Connection timed out` is raised in case of `Faraday::TimeoutError`
 - `Connection failed` is raised in case of `Faraday::ConnectionFailed`
 
-All errors provide the `response_code`, `response_body`, `json_body`, `type` and `fields` of the error.
+All errors provide the `code`, `response_headers`, and `response_body` of the error.
 
 ```ruby
 def create_applicant
   onfido_api.create_applicant(params)
-rescue Faraday::ConnectionFailed => e
-  e.type          # => 'validation_error'
-  e.fields        # => { "email": { "messages": ["invalid format"] } }
-  e.response_code # => '422'
+rescue Onfido::ApiError => e
+  e.message       # => 'Unprocessable entity'
+  e.response_body # => { error: { type: "validation_error", message: "", fields: { "email": [ "invalid format" ] } } }
+  e.code          # => '422'
 end
 ```
 

data/lib/onfido/api/default_api.rb

@@ -1321,6 +1321,77 @@ module Onfido
       return data, status_code, headers
     end
 
+    # Retrieves the signed document or application form
+    # Retrieves the signed document or application form depending on the file_id provided. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+    # @param file_id [String] The unique identifier of the file which you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def download_qes_document(workflow_run_id, file_id, opts = {})
+      data, _status_code, _headers = download_qes_document_with_http_info(workflow_run_id, file_id, opts)
+      data
+    end
+
+    # Retrieves the signed document or application form
+    # Retrieves the signed document or application form depending on the file_id provided. 
+    # @param workflow_run_id [String] The unique identifier of the Workflow Run for which you want to retrieve the signed document.
+    # @param file_id [String] The unique identifier of the file which you want to retrieve.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def download_qes_document_with_http_info(workflow_run_id, file_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.download_qes_document ...'
+      end
+      # verify the required parameter 'workflow_run_id' is set
+      if @api_client.config.client_side_validation && workflow_run_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.download_qes_document"
+      end
+      # verify the required parameter 'file_id' is set
+      if @api_client.config.client_side_validation && file_id.nil?
+        fail ArgumentError, "Missing the required parameter 'file_id' when calling DefaultApi.download_qes_document"
+      end
+      # resource path
+      local_var_path = '/qualified_electronic_signature/documents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'workflow_run_id'] = workflow_run_id
+      query_params[:'file_id'] = file_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Token']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.download_qes_document",
+        :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#download_qes_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieve Workflow Run Evidence Summary File
     # Retrieves the signed evidence file for the designated Workflow Run 
     # @param workflow_run_id [String] Workflow Run ID
@@ -4030,7 +4101,7 @@ module Onfido
       if @api_client.config.client_side_validation && file.nil?
         fail ArgumentError, "Missing the required parameter 'file' when calling DefaultApi.upload_document"
       end
-      allowable_values = ["jpg", "png", "pdf", "unknown_default_open_api"]
+      allowable_values = ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"]
       if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type'])
         fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}"
       end

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

data/lib/onfido/models/document.rb

@@ -201,7 +201,7 @@ module Onfido
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      file_type_validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      file_type_validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"])
       return false unless file_type_validator.valid?(@file_type)
       side_validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"])
       return false unless side_validator.valid?(@side)
@@ -212,7 +212,7 @@ module Onfido
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] file_type Object to be assigned
     def file_type=(file_type)
-      validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"])
       unless validator.valid?(file_type)
         fail ArgumentError, "invalid value for \"file_type\", must be one of #{validator.allowable_values}."
       end

data/lib/onfido/models/document_properties.rb

@@ -27,12 +27,14 @@ module Onfido
 
     attr_accessor :first_name
 
+    attr_accessor :middle_name
+
+    attr_accessor :last_name
+
     attr_accessor :gender
 
     attr_accessor :issuing_country
 
-    attr_accessor :last_name
-
     attr_accessor :nationality
 
     attr_accessor :issuing_state
@@ -134,9 +136,10 @@ module Onfido
         :'document_numbers' => :'document_numbers',
         :'document_type' => :'document_type',
         :'first_name' => :'first_name',
+        :'middle_name' => :'middle_name',
+        :'last_name' => :'last_name',
         :'gender' => :'gender',
         :'issuing_country' => :'issuing_country',
-        :'last_name' => :'last_name',
         :'nationality' => :'nationality',
         :'issuing_state' => :'issuing_state',
         :'issuing_date' => :'issuing_date',
@@ -189,9 +192,10 @@ module Onfido
         :'document_numbers' => :'Array<DocumentPropertiesDocumentNumbersInner>',
         :'document_type' => :'String',
         :'first_name' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
         :'gender' => :'String',
         :'issuing_country' => :'String',
-        :'last_name' => :'String',
         :'nationality' => :'String',
         :'issuing_state' => :'String',
         :'issuing_date' => :'Date',
@@ -277,6 +281,14 @@ module Onfido
         self.first_name = attributes[:'first_name']
       end
 
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
       if attributes.key?(:'gender')
         self.gender = attributes[:'gender']
       end
@@ -285,10 +297,6 @@ module Onfido
         self.issuing_country = attributes[:'issuing_country']
       end
 
-      if attributes.key?(:'last_name')
-        self.last_name = attributes[:'last_name']
-      end
-
       if attributes.key?(:'nationality')
         self.nationality = attributes[:'nationality']
       end
@@ -494,9 +502,10 @@ module Onfido
           document_numbers == o.document_numbers &&
           document_type == o.document_type &&
           first_name == o.first_name &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
           gender == o.gender &&
           issuing_country == o.issuing_country &&
-          last_name == o.last_name &&
           nationality == o.nationality &&
           issuing_state == o.issuing_state &&
           issuing_date == o.issuing_date &&
@@ -543,7 +552,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, gender, issuing_country, last_name, 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].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].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/document_shared.rb

@@ -133,7 +133,7 @@ module Onfido
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      file_type_validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      file_type_validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"])
       return false unless file_type_validator.valid?(@file_type)
       side_validator = EnumAttributeValidator.new('String', ["front", "back", "unknown_default_open_api"])
       return false unless side_validator.valid?(@side)
@@ -143,7 +143,7 @@ module Onfido
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] file_type Object to be assigned
     def file_type=(file_type)
-      validator = EnumAttributeValidator.new('String', ["jpg", "png", "pdf", "unknown_default_open_api"])
+      validator = EnumAttributeValidator.new('String', ["jpg", "jpeg", "png", "pdf", "unknown_default_open_api"])
       unless validator.valid?(file_type)
         fail ArgumentError, "invalid value for \"file_type\", must be one of #{validator.allowable_values}."
       end

data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb

@@ -27,12 +27,14 @@ module Onfido
 
     attr_accessor :first_name
 
+    attr_accessor :middle_name
+
+    attr_accessor :last_name
+
     attr_accessor :gender
 
     attr_accessor :issuing_country
 
-    attr_accessor :last_name
-
     attr_accessor :nationality
 
     attr_accessor :issuing_state
@@ -151,9 +153,10 @@ module Onfido
         :'document_numbers' => :'document_numbers',
         :'document_type' => :'document_type',
         :'first_name' => :'first_name',
+        :'middle_name' => :'middle_name',
+        :'last_name' => :'last_name',
         :'gender' => :'gender',
         :'issuing_country' => :'issuing_country',
-        :'last_name' => :'last_name',
         :'nationality' => :'nationality',
         :'issuing_state' => :'issuing_state',
         :'issuing_date' => :'issuing_date',
@@ -212,9 +215,10 @@ module Onfido
         :'document_numbers' => :'Array<DocumentPropertiesDocumentNumbersInner>',
         :'document_type' => :'String',
         :'first_name' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
         :'gender' => :'String',
         :'issuing_country' => :'String',
-        :'last_name' => :'String',
         :'nationality' => :'String',
         :'issuing_state' => :'String',
         :'issuing_date' => :'Date',
@@ -313,6 +317,14 @@ module Onfido
         self.first_name = attributes[:'first_name']
       end
 
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
       if attributes.key?(:'gender')
         self.gender = attributes[:'gender']
       end
@@ -321,10 +333,6 @@ module Onfido
         self.issuing_country = attributes[:'issuing_country']
       end
 
-      if attributes.key?(:'last_name')
-        self.last_name = attributes[:'last_name']
-      end
-
       if attributes.key?(:'nationality')
         self.nationality = attributes[:'nationality']
       end
@@ -556,9 +564,10 @@ module Onfido
           document_numbers == o.document_numbers &&
           document_type == o.document_type &&
           first_name == o.first_name &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
           gender == o.gender &&
           issuing_country == o.issuing_country &&
-          last_name == o.last_name &&
           nationality == o.nationality &&
           issuing_state == o.issuing_state &&
           issuing_date == o.issuing_date &&
@@ -611,7 +620,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, gender, issuing_country, last_name, 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, vehicle_class_details, passenger_vehicle].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_event_payload_object.rb

@@ -22,6 +22,9 @@ module Onfido
     # The current state of the object, if available.
     attr_accessor :status
 
+    # The date and time when the operation was started, if available.
+    attr_accessor :started_at_iso8601
+
     # The date and time when the operation was completed, if available.
     attr_accessor :completed_at_iso8601
 
@@ -33,6 +36,7 @@ module Onfido
       {
         :'id' => :'id',
         :'status' => :'status',
+        :'started_at_iso8601' => :'started_at_iso8601',
         :'completed_at_iso8601' => :'completed_at_iso8601',
         :'href' => :'href'
       }
@@ -48,6 +52,7 @@ module Onfido
       {
         :'id' => :'String',
         :'status' => :'String',
+        :'started_at_iso8601' => :'Time',
         :'completed_at_iso8601' => :'Time',
         :'href' => :'String'
       }
@@ -84,6 +89,10 @@ module Onfido
         self.status = attributes[:'status']
       end
 
+      if attributes.key?(:'started_at_iso8601')
+        self.started_at_iso8601 = attributes[:'started_at_iso8601']
+      end
+
       if attributes.key?(:'completed_at_iso8601')
         self.completed_at_iso8601 = attributes[:'completed_at_iso8601']
       end
@@ -127,6 +136,7 @@ module Onfido
       self.class == o.class &&
           id == o.id &&
           status == o.status &&
+          started_at_iso8601 == o.started_at_iso8601 &&
           completed_at_iso8601 == o.completed_at_iso8601 &&
           href == o.href
     end
@@ -140,7 +150,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, status, completed_at_iso8601, href].hash
+      [id, status, started_at_iso8601, completed_at_iso8601, href].hash
     end
 
     # Builds the object from hash

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.1.0'
+  VERSION = '3.3.0'
 end

data/spec/integrations/qualified_electronic_signature_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../shared_contexts/with_workflow_run'
+
+describe Onfido::WorkflowRun do
+  include_context 'with applicant'
+
+  let(:workflow_id) { '8b74614f-9e7f-42fd-852a-5f2bcc852587' }
+
+  let(:workflow_run_builder) do
+    Onfido::WorkflowRunBuilder.new({
+      applicant_id: applicant_id,
+      workflow_id: workflow_id,
+      custom_data: {
+        country_of_operation: "GBR",
+        document_date_of_expiry: "2022-01-01",
+        document_issuing_country: "FRA",
+        document_issuing_date: "2022-01-01",
+        document_number: "Example string",
+        document_to_sign_url: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
+        document_type: "driving_licence",
+      }
+    })
+  end
+
+  let(:workflow_run) { onfido_api.create_workflow_run(workflow_run_builder) }
+  let!(:workflow_run_id) { workflow_run.id }
+
+  let(:file_id) do
+    task = onfido_api.list_tasks(workflow_run_id)[0]
+
+    output = repeat_request_until_task_output_changes(
+      max_retries = 10,
+      interval = 3
+    ) { onfido_api.find_task(workflow_run_id, task.id) }.output
+
+    output[:properties][:signed_documents][0][:id]
+  end
+
+  describe 'Workflow run' do
+    it 'downloads qes document' do
+      file = onfido_api.download_qes_document(workflow_run_id, file_id)
+
+      expect(file.size).to be > 0
+    end
+  end
+end

data/spec/integrations/webhook_spec.rb

@@ -14,7 +14,7 @@ describe Onfido::Webhook do
     end
 
     let(:webhook) { onfido_api.create_webhook(webhook_builder) }
-    let(:webhook_id) { webhook.id }
+    let!(:webhook_id) { webhook.id }
 
     it 'creates a webhook' do
       expect(webhook).to be_an_instance_of Onfido::Webhook

data/spec/shared_contexts/with_applicant.rb

@@ -15,6 +15,8 @@ RSpec.shared_context 'with applicant', shared_context: :metadata do
     {
       'first_name' => 'Test',
       'last_name' => 'Applicant',
+      'email' => "first.last@gmail.com",
+      'phone_number' => "351911111111",
       'location' => {
         'ip_address' => '127.0.0.1',
         'country_of_residence' => 'GBR'

data/spec/spec_helper.rb

@@ -86,6 +86,26 @@ def repeat_request_until_status_changes(expected_status, max_retries = 10,
   instance
 end
 
+def repeat_request_until_task_output_changes(max_retries = 10,
+  interval = 1, &proc)
+  # max_retries     --> how many times to retry the request
+  # interval        --> how many seconds to wait until the next retry
+  # proc            --> code containing the request
+
+  instance = proc.call
+
+  iteration = 0
+  while instance.output == nil
+    raise "task output did not change in time" if iteration > max_retries
+
+    iteration += 1
+    sleep(interval)
+    instance = proc.call
+  end
+
+  instance
+end
+
 def repeat_request_unti_http_code_changes(max_retries = 10,
   interval = 1, &proc)
   # max_retries        --> how many times to retry the request

metadata

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