onfido 3.3.1 → 4.0.0

data/lib/onfido/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -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.3.1"
+      @user_agent = "onfido-ruby/4.0.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -164,35 +164,41 @@ module Onfido
       request.options.on_data = Proc.new do |chunk, overall_received_bytes|
         stream << chunk
       end
+
       stream
     end
 
     def deserialize_file(response, stream)
-      body = response.body
-      if @config.return_binary_data == true
-        # return byte stream
-        encoding = body.encoding
-        stream.join.force_encoding(encoding)
+      body     = response.body
+      encoding = body.encoding
+
+      # reconstruct content
+      content = stream.join
+      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
+      content = content.force_encoding(encoding)
+
+      # return byte stream
+      return content if @config.return_binary_data == true
+
+      # return file instead of binary data
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition && content_disposition =~ /filename=/i
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        prefix = sanitize_filename(filename)
       else
-        # return file instead of binary data
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        tempfile.write(stream.join.force_encoding(encoding))
-        tempfile.close
-        config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
-        tempfile
+        prefix = 'download-'
       end
+      prefix = prefix + '-' unless prefix.end_with?('-')
+
+      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+      tempfile.write(content)
+      tempfile.close
+
+      config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                          "explicitly with `tempfile.delete`"
+      tempfile
     end
 
     def connection(opts)

data/lib/onfido/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -87,6 +87,14 @@ module Onfido
     # @return [true, false]
     attr_accessor :debugging
 
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
     # Defines the logger used for debugging.
     # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
     #
@@ -178,6 +186,7 @@ module Onfido
       @return_binary_data = false
       @params_encoder = nil
       @debugging = false
+      @ignore_operation_servers = false
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
@@ -214,6 +223,7 @@ module Onfido
 
     # Returns base URL for specified operation based on server settings
     def base_url(operation = nil)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
       if operation_server_settings.key?(operation) then
         index = server_operation_index.fetch(operation, server_index)
         server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])

data/lib/onfido/models/address.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/address_builder.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/address_shared.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/addresses_list.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant_builder.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -26,6 +26,7 @@ module Onfido
     # The applicant's phone number
     attr_accessor :phone_number
 
+    # The applicant's consents
     attr_accessor :consents
 
     attr_accessor :address
@@ -65,7 +66,7 @@ module Onfido
         :'dob' => :'Date',
         :'id_numbers' => :'Array<IdNumber>',
         :'phone_number' => :'String',
-        :'consents' => :'ConsentsBuilder',
+        :'consents' => :'Array<ApplicantConsentBuilder>',
         :'address' => :'AddressBuilder',
         :'location' => :'LocationBuilder',
         :'first_name' => :'String',
@@ -122,7 +123,9 @@ module Onfido
       end
 
       if attributes.key?(:'consents')
-        self.consents = attributes[:'consents']
+        if (value = attributes[:'consents']).is_a?(Array)
+          self.consents = value
+        end
       end
 
       if attributes.key?(:'address')

data/lib/onfido/models/{consent_item.rb → applicant_consent_builder.rb}

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -14,8 +14,7 @@ require 'date'
 require 'time'
 
 module Onfido
-  # The applicant's consents
-  class ConsentItem
+  class ApplicantConsentBuilder
     attr_accessor :name
 
     attr_accessor :granted
@@ -58,7 +57,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
+        :'name' => :'ApplicantConsentName',
         :'granted' => :'Boolean'
       }
     end
@@ -73,13 +72,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::ConsentItem` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::ApplicantConsentBuilder` 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::ConsentItem`. 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::ApplicantConsentBuilder`. 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
       }
@@ -118,22 +117,10 @@ module Onfido
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @name.nil?
-      name_validator = EnumAttributeValidator.new('String', ["privacy_notices_read", "ssn_verification", "phone_number_verification", "unknown_default_open_api"])
-      return false unless name_validator.valid?(@name)
       return false if @granted.nil?
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] name Object to be assigned
-    def name=(name)
-      validator = EnumAttributeValidator.new('String', ["privacy_notices_read", "ssn_verification", "phone_number_verification", "unknown_default_open_api"])
-      unless validator.valid?(name)
-        fail ArgumentError, "invalid value for \"name\", must be one of #{validator.allowable_values}."
-      end
-      @name = name
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/onfido/models/applicant_consent_name.rb

@@ -0,0 +1,42 @@
+=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.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  class ApplicantConsentName
+    PRIVACY_NOTICES_READ = "privacy_notices_read".freeze
+    SSN_VERIFICATION = "ssn_verification".freeze
+    PHONE_NUMBER_VERIFICATION = "phone_number_verification".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [PRIVACY_NOTICES_READ, SSN_VERIFICATION, PHONE_NUMBER_VERIFICATION, UNKNOWN_DEFAULT_OPEN_API].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if ApplicantConsentName.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ApplicantConsentName"
+    end
+  end
+end

data/lib/onfido/models/applicant_create.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -15,6 +15,7 @@ require 'time'
 
 module Onfido
   class ApplicantRequest
+    # The applicant's consents
     attr_accessor :consents
 
     attr_accessor :address
@@ -38,7 +39,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'consents' => :'ConsentsBuilder',
+        :'consents' => :'Array<ApplicantConsentBuilder>',
         :'address' => :'AddressBuilder',
         :'location' => :'LocationBuilder'
       }
@@ -66,7 +67,9 @@ module Onfido
       }
 
       if attributes.key?(:'consents')
-        self.consents = attributes[:'consents']
+        if (value = attributes[:'consents']).is_a?(Array)
+          self.consents = value
+        end
       end
 
       if attributes.key?(:'address')

data/lib/onfido/models/applicant_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant_shared.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant_update.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/applicant_updater.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -26,6 +26,7 @@ module Onfido
     # The applicant's phone number
     attr_accessor :phone_number
 
+    # The applicant's consents
     attr_accessor :consents
 
     attr_accessor :address
@@ -65,7 +66,7 @@ module Onfido
         :'dob' => :'Date',
         :'id_numbers' => :'Array<IdNumber>',
         :'phone_number' => :'String',
-        :'consents' => :'ConsentsBuilder',
+        :'consents' => :'Array<ApplicantConsentBuilder>',
         :'address' => :'AddressBuilder',
         :'location' => :'LocationBuilder',
         :'first_name' => :'String',
@@ -122,7 +123,9 @@ module Onfido
       end
 
       if attributes.key?(:'consents')
-        self.consents = attributes[:'consents']
+        if (value = attributes[:'consents']).is_a?(Array)
+          self.consents = value
+        end
       end
 
       if attributes.key?(:'address')

data/lib/onfido/models/applicants_list.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 

data/lib/onfido/models/check.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -30,6 +30,8 @@ module Onfido
     # For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     attr_accessor :redirect_uri
 
+    attr_accessor :privacy_notices_read_consent_given
+
     # The unique identifier for the check.
     attr_accessor :id
 
@@ -39,7 +41,6 @@ module Onfido
     # The uri of this resource.
     attr_accessor :href
 
-    # The current state of the check in the checking process.
     attr_accessor :status
 
     # The overall result of the check, based on the results of the constituent reports.
@@ -57,6 +58,10 @@ module Onfido
     # Indicates whether the object was created in the sandbox or not.
     attr_accessor :sandbox
 
+    attr_accessor :paused
+
+    attr_accessor :version
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -87,6 +92,7 @@ module Onfido
         :'applicant_provides_data' => :'applicant_provides_data',
         :'tags' => :'tags',
         :'redirect_uri' => :'redirect_uri',
+        :'privacy_notices_read_consent_given' => :'privacy_notices_read_consent_given',
         :'id' => :'id',
         :'created_at' => :'created_at',
         :'href' => :'href',
@@ -95,7 +101,9 @@ module Onfido
         :'form_uri' => :'form_uri',
         :'results_uri' => :'results_uri',
         :'report_ids' => :'report_ids',
-        :'sandbox' => :'sandbox'
+        :'sandbox' => :'sandbox',
+        :'paused' => :'paused',
+        :'version' => :'version'
       }
     end
 
@@ -112,15 +120,18 @@ module Onfido
         :'applicant_provides_data' => :'Boolean',
         :'tags' => :'Array<String>',
         :'redirect_uri' => :'String',
+        :'privacy_notices_read_consent_given' => :'Boolean',
         :'id' => :'String',
         :'created_at' => :'Time',
         :'href' => :'String',
-        :'status' => :'String',
+        :'status' => :'CheckStatus',
         :'result' => :'String',
         :'form_uri' => :'String',
         :'results_uri' => :'String',
         :'report_ids' => :'Array<String>',
-        :'sandbox' => :'Boolean'
+        :'sandbox' => :'Boolean',
+        :'paused' => :'Boolean',
+        :'version' => :'String'
       }
     end
 
@@ -179,6 +190,10 @@ module Onfido
         self.redirect_uri = attributes[:'redirect_uri']
       end
 
+      if attributes.key?(:'privacy_notices_read_consent_given')
+        self.privacy_notices_read_consent_given = attributes[:'privacy_notices_read_consent_given']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       else
@@ -218,6 +233,14 @@ module Onfido
       if attributes.key?(:'sandbox')
         self.sandbox = attributes[:'sandbox']
       end
+
+      if attributes.key?(:'paused')
+        self.paused = attributes[:'paused']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -242,23 +265,11 @@ module Onfido
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @applicant_id.nil?
       return false if @id.nil?
-      status_validator = EnumAttributeValidator.new('String', ["in_progress", "awaiting_applicant", "complete", "withdrawn", "paused", "reopened", "unknown_default_open_api"])
-      return false unless status_validator.valid?(@status)
       result_validator = EnumAttributeValidator.new('String', ["clear", "consider", "unknown_default_open_api"])
       return false unless result_validator.valid?(@result)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] status Object to be assigned
-    def status=(status)
-      validator = EnumAttributeValidator.new('String', ["in_progress", "awaiting_applicant", "complete", "withdrawn", "paused", "reopened", "unknown_default_open_api"])
-      unless validator.valid?(status)
-        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
-      end
-      @status = status
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] result Object to be assigned
     def result=(result)
@@ -279,6 +290,7 @@ module Onfido
           applicant_provides_data == o.applicant_provides_data &&
           tags == o.tags &&
           redirect_uri == o.redirect_uri &&
+          privacy_notices_read_consent_given == o.privacy_notices_read_consent_given &&
           id == o.id &&
           created_at == o.created_at &&
           href == o.href &&
@@ -287,7 +299,9 @@ module Onfido
           form_uri == o.form_uri &&
           results_uri == o.results_uri &&
           report_ids == o.report_ids &&
-          sandbox == o.sandbox
+          sandbox == o.sandbox &&
+          paused == o.paused &&
+          version == o.version
     end
 
     # @see the `==` method
@@ -299,7 +313,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, id, created_at, href, status, result, form_uri, results_uri, report_ids, sandbox].hash
+      [webhook_ids, applicant_id, applicant_provides_data, tags, redirect_uri, privacy_notices_read_consent_given, id, created_at, href, status, result, form_uri, results_uri, report_ids, sandbox, paused, version].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/check_builder.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end
 
@@ -30,6 +30,8 @@ module Onfido
     # For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
     attr_accessor :redirect_uri
 
+    attr_accessor :privacy_notices_read_consent_given
+
     # An array of report names (strings).
     attr_accessor :report_names
 
@@ -58,6 +60,7 @@ module Onfido
         :'applicant_provides_data' => :'applicant_provides_data',
         :'tags' => :'tags',
         :'redirect_uri' => :'redirect_uri',
+        :'privacy_notices_read_consent_given' => :'privacy_notices_read_consent_given',
         :'report_names' => :'report_names',
         :'document_ids' => :'document_ids',
         :'asynchronous' => :'asynchronous',
@@ -81,6 +84,7 @@ module Onfido
         :'applicant_provides_data' => :'Boolean',
         :'tags' => :'Array<String>',
         :'redirect_uri' => :'String',
+        :'privacy_notices_read_consent_given' => :'Boolean',
         :'report_names' => :'Array<ReportName>',
         :'document_ids' => :'Array<String>',
         :'asynchronous' => :'Boolean',
@@ -148,6 +152,10 @@ module Onfido
         self.redirect_uri = attributes[:'redirect_uri']
       end
 
+      if attributes.key?(:'privacy_notices_read_consent_given')
+        self.privacy_notices_read_consent_given = attributes[:'privacy_notices_read_consent_given']
+      end
+
       if attributes.key?(:'report_names')
         if (value = attributes[:'report_names']).is_a?(Array)
           self.report_names = value
@@ -222,6 +230,7 @@ module Onfido
           applicant_provides_data == o.applicant_provides_data &&
           tags == o.tags &&
           redirect_uri == o.redirect_uri &&
+          privacy_notices_read_consent_given == o.privacy_notices_read_consent_given &&
           report_names == o.report_names &&
           document_ids == o.document_ids &&
           asynchronous == o.asynchronous &&
@@ -240,7 +249,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, 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].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/check_request.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v3.6
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.9.0
 
 =end