onfido 3.4.0 → 4.0.0

data/lib/onfido/models/check_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
 
@@ -24,7 +24,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.
@@ -42,6 +41,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
@@ -75,7 +78,9 @@ module Onfido
         :'form_uri' => :'form_uri',
         :'results_uri' => :'results_uri',
         :'report_ids' => :'report_ids',
-        :'sandbox' => :'sandbox'
+        :'sandbox' => :'sandbox',
+        :'paused' => :'paused',
+        :'version' => :'version'
       }
     end
 
@@ -90,12 +95,14 @@ module Onfido
         :'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
 
@@ -159,6 +166,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?
@@ -178,23 +193,11 @@ module Onfido
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       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)
@@ -218,7 +221,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
@@ -230,7 +235,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, href, status, result, form_uri, results_uri, report_ids, sandbox].hash
+      [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_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
 
@@ -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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -37,7 +39,8 @@ module Onfido
         :'applicant_id' => :'applicant_id',
         :'applicant_provides_data' => :'applicant_provides_data',
         :'tags' => :'tags',
-        :'redirect_uri' => :'redirect_uri'
+        :'redirect_uri' => :'redirect_uri',
+        :'privacy_notices_read_consent_given' => :'privacy_notices_read_consent_given'
       }
     end
 
@@ -53,7 +56,8 @@ module Onfido
         :'applicant_id' => :'String',
         :'applicant_provides_data' => :'Boolean',
         :'tags' => :'Array<String>',
-        :'redirect_uri' => :'String'
+        :'redirect_uri' => :'String',
+        :'privacy_notices_read_consent_given' => :'Boolean'
       }
     end
 
@@ -103,6 +107,10 @@ module Onfido
       if attributes.key?(:'redirect_uri')
         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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -134,7 +142,8 @@ module Onfido
           applicant_id == o.applicant_id &&
           applicant_provides_data == o.applicant_provides_data &&
           tags == o.tags &&
-          redirect_uri == o.redirect_uri
+          redirect_uri == o.redirect_uri &&
+          privacy_notices_read_consent_given == o.privacy_notices_read_consent_given
     end
 
     # @see the `==` method
@@ -146,7 +155,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].hash
+      [webhook_ids, applicant_id, applicant_provides_data, tags, redirect_uri, privacy_notices_read_consent_given].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/check_status.rb

@@ -0,0 +1,45 @@
+=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 CheckStatus
+    IN_PROGRESS = "in_progress".freeze
+    AWAITING_APPLICANT = "awaiting_applicant".freeze
+    COMPLETE = "complete".freeze
+    WITHDRAWN = "withdrawn".freeze
+    PAUSED = "paused".freeze
+    REOPENED = "reopened".freeze
+    UNKNOWN_DEFAULT_OPEN_API = "unknown_default_open_api".freeze
+
+    def self.all_vars
+      @all_vars ||= [IN_PROGRESS, AWAITING_APPLICANT, COMPLETE, WITHDRAWN, PAUSED, REOPENED, 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 CheckStatus.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CheckStatus"
+    end
+  end
+end

data/lib/onfido/models/checks_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/complete_task_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/complete_task_data_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/country_codes.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/device_intelligence_breakdown.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/device_intelligence_breakdown_breakdown.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/device_intelligence_breakdown_breakdown_device.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/device_intelligence_breakdown_breakdown_device_breakdown.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/device_intelligence_breakdown_properties.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/device_intelligence_breakdown_properties_device.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
 
@@ -42,18 +42,6 @@ module Onfido
     # Whether device is using stolen security tokens to send the network information.
     attr_accessor :fake_network_request
 
-    # The true operating system of the device.
-    attr_accessor :true_os
-
-    # The likelihood of an operating system anomaly between the true OS and the OS sent by the device.
-    attr_accessor :os_anomaly
-
-    # Whether the device is rooted.
-    attr_accessor :rooted
-
-    # Whether the device is controlled via remote software.
-    attr_accessor :remote_software
-
     # Whether there is highly suspicious traffic related to the IP address. The risk depends on the overall ratio of clear checks on a given IP.
     attr_accessor :ip_reputation
 
@@ -103,10 +91,6 @@ module Onfido
         :'emulator' => :'emulator',
         :'randomized_device' => :'randomized_device',
         :'fake_network_request' => :'fake_network_request',
-        :'true_os' => :'true_os',
-        :'os_anomaly' => :'os_anomaly',
-        :'rooted' => :'rooted',
-        :'remote_software' => :'remote_software',
         :'ip_reputation' => :'ip_reputation',
         :'device_fingerprint_reuse' => :'device_fingerprint_reuse',
         :'single_device_used' => :'single_device_used',
@@ -132,10 +116,6 @@ module Onfido
         :'emulator' => :'Boolean',
         :'randomized_device' => :'Boolean',
         :'fake_network_request' => :'Boolean',
-        :'true_os' => :'String',
-        :'os_anomaly' => :'String',
-        :'rooted' => :'Boolean',
-        :'remote_software' => :'Boolean',
         :'ip_reputation' => :'String',
         :'device_fingerprint_reuse' => :'Integer',
         :'single_device_used' => :'Boolean',
@@ -202,22 +182,6 @@ module Onfido
         self.fake_network_request = attributes[:'fake_network_request']
       end
 
-      if attributes.key?(:'true_os')
-        self.true_os = attributes[:'true_os']
-      end
-
-      if attributes.key?(:'os_anomaly')
-        self.os_anomaly = attributes[:'os_anomaly']
-      end
-
-      if attributes.key?(:'rooted')
-        self.rooted = attributes[:'rooted']
-      end
-
-      if attributes.key?(:'remote_software')
-        self.remote_software = attributes[:'remote_software']
-      end
-
       if attributes.key?(:'ip_reputation')
         self.ip_reputation = attributes[:'ip_reputation']
       end
@@ -328,10 +292,6 @@ module Onfido
           emulator == o.emulator &&
           randomized_device == o.randomized_device &&
           fake_network_request == o.fake_network_request &&
-          true_os == o.true_os &&
-          os_anomaly == o.os_anomaly &&
-          rooted == o.rooted &&
-          remote_software == o.remote_software &&
           ip_reputation == o.ip_reputation &&
           device_fingerprint_reuse == o.device_fingerprint_reuse &&
           single_device_used == o.single_device_used &&
@@ -348,7 +308,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sdk_version, sdk_source, authentication_type, raw_model, os, browser, emulator, randomized_device, fake_network_request, true_os, os_anomaly, rooted, remote_software, ip_reputation, device_fingerprint_reuse, single_device_used, document_capture, biometric_capture].hash
+      [sdk_version, sdk_source, authentication_type, raw_model, os, browser, emulator, randomized_device, fake_network_request, ip_reputation, device_fingerprint_reuse, single_device_used, document_capture, biometric_capture].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/device_intelligence_breakdown_properties_geolocation.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/device_intelligence_breakdown_properties_ip.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
 
@@ -18,22 +18,10 @@ module Onfido
     # The IP address that uploaded the media.
     attr_accessor :address
 
-    # The likelihood of the network connection being a VPN.
-    attr_accessor :vpn_detection
-
-    # The likelihood of the network connection being a Proxy.
-    attr_accessor :proxy_detection
-
-    # The type of organization that owns this IP address.
-    attr_accessor :type
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'address' => :'address',
-        :'vpn_detection' => :'vpn_detection',
-        :'proxy_detection' => :'proxy_detection',
-        :'type' => :'type'
+        :'address' => :'address'
       }
     end
 
@@ -45,10 +33,7 @@ module Onfido
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'address' => :'String',
-        :'vpn_detection' => :'String',
-        :'proxy_detection' => :'String',
-        :'type' => :'String'
+        :'address' => :'String'
       }
     end
 
@@ -76,18 +61,6 @@ module Onfido
       if attributes.key?(:'address')
         self.address = attributes[:'address']
       end
-
-      if attributes.key?(:'vpn_detection')
-        self.vpn_detection = attributes[:'vpn_detection']
-      end
-
-      if attributes.key?(:'proxy_detection')
-        self.proxy_detection = attributes[:'proxy_detection']
-      end
-
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -110,10 +83,7 @@ module Onfido
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          address == o.address &&
-          vpn_detection == o.vpn_detection &&
-          proxy_detection == o.proxy_detection &&
-          type == o.type
+          address == o.address
     end
 
     # @see the `==` method
@@ -125,7 +95,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [address, vpn_detection, proxy_detection, type].hash
+      [address].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/device_intelligence_report.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/document.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
 
@@ -96,7 +96,7 @@ module Onfido
     def self.openapi_types
       {
         :'file_type' => :'String',
-        :'type' => :'String',
+        :'type' => :'DocumentTypes',
         :'side' => :'String',
         :'issuing_country' => :'CountryCodes',
         :'applicant_id' => :'String',

data/lib/onfido/models/document_breakdown.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/document_breakdown_age_validation.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/document_breakdown_age_validation_breakdown.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/document_breakdown_compromised_document.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/document_breakdown_compromised_document_breakdown.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/document_breakdown_data_comparison.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/document_breakdown_data_comparison_breakdown.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/document_breakdown_data_comparison_breakdown_issuing_country.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/document_breakdown_data_consistency.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/document_breakdown_data_consistency_breakdown.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/document_breakdown_data_validation.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/document_breakdown_data_validation_breakdown.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/document_breakdown_data_validation_breakdown_document_expiration.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/document_breakdown_data_validation_breakdown_expiry_date.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