onfido 5.0.0 → 5.1.0

data/lib/onfido/models/device_intelligence_properties.rb

@@ -0,0 +1,232 @@
+=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.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Onfido
+  class DeviceIntelligenceProperties
+    attr_accessor :device
+
+    attr_accessor :ip
+
+    attr_accessor :geolocation
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'device' => :'device',
+        :'ip' => :'ip',
+        :'geolocation' => :'geolocation'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'device' => :'DeviceIntelligenceBreakdownPropertiesDevice',
+        :'ip' => :'DeviceIntelligenceBreakdownPropertiesIp',
+        :'geolocation' => :'DeviceIntelligenceBreakdownPropertiesGeolocation'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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::DeviceIntelligenceProperties` 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::DeviceIntelligenceProperties`. 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
+      }
+
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.key?(:'ip')
+        self.ip = attributes[:'ip']
+      end
+
+      if attributes.key?(:'geolocation')
+        self.geolocation = attributes[:'geolocation']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          device == o.device &&
+          ip == o.ip &&
+          geolocation == o.geolocation
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [device, ip, geolocation].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Onfido.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/onfido/models/device_intelligence_report.rb

@@ -37,6 +37,8 @@ module Onfido
 
     attr_accessor :breakdown
 
+    attr_accessor :properties
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -70,7 +72,8 @@ module Onfido
         :'sub_result' => :'sub_result',
         :'check_id' => :'check_id',
         :'name' => :'name',
-        :'breakdown' => :'breakdown'
+        :'breakdown' => :'breakdown',
+        :'properties' => :'properties'
       }
     end
 
@@ -90,7 +93,8 @@ module Onfido
         :'sub_result' => :'ReportSubResult',
         :'check_id' => :'String',
         :'name' => :'ReportName',
-        :'breakdown' => :'DeviceIntelligenceBreakdown'
+        :'breakdown' => :'DeviceIntelligenceBreakdown',
+        :'properties' => :'DeviceIntelligenceProperties'
       }
     end
 
@@ -161,6 +165,10 @@ module Onfido
       if attributes.key?(:'breakdown')
         self.breakdown = attributes[:'breakdown']
       end
+
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -201,7 +209,8 @@ module Onfido
           sub_result == o.sub_result &&
           check_id == o.check_id &&
           name == o.name &&
-          breakdown == o.breakdown
+          breakdown == o.breakdown &&
+          properties == o.properties
     end
 
     # @see the `==` method
@@ -213,7 +222,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, created_at, href, status, result, sub_result, check_id, name, breakdown].hash
+      [id, created_at, href, status, result, sub_result, check_id, name, breakdown, properties].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/document_properties.rb

@@ -228,7 +228,7 @@ module Onfido
         :'address_lines' => :'DocumentPropertiesAddressLines',
         :'barcode' => :'Array<DocumentPropertiesBarcodeInner>',
         :'nfc' => :'DocumentPropertiesNfc',
-        :'driving_licence_information' => :'DocumentPropertiesDrivingLicenceInformation',
+        :'driving_licence_information' => :'Array<DocumentPropertiesDrivingLicenceInformationItem>',
         :'document_classification' => :'DocumentPropertiesDocumentClassification',
         :'extracted_data' => :'DocumentPropertiesExtractedData'
       }
@@ -428,7 +428,9 @@ module Onfido
       end
 
       if attributes.key?(:'driving_licence_information')
-        self.driving_licence_information = attributes[:'driving_licence_information']
+        if (value = attributes[:'driving_licence_information']).is_a?(Array)
+          self.driving_licence_information = value
+        end
       end
 
       if attributes.key?(:'document_classification')

data/lib/onfido/models/{document_properties_driving_licence_information.rb → document_properties_driving_licence_information_item.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Onfido
-  class DocumentPropertiesDrivingLicenceInformation
+  class DocumentPropertiesDrivingLicenceInformationItem
     attr_accessor :category
 
     attr_accessor :obtainment_date
@@ -58,13 +58,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::DocumentPropertiesDrivingLicenceInformation` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::DocumentPropertiesDrivingLicenceInformationItem` 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::DocumentPropertiesDrivingLicenceInformation`. 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::DocumentPropertiesDrivingLicenceInformationItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/onfido/models/document_with_driver_verification_report_all_of_properties.rb

@@ -251,7 +251,7 @@ module Onfido
         :'address_lines' => :'DocumentPropertiesAddressLines',
         :'barcode' => :'Array<DocumentPropertiesBarcodeInner>',
         :'nfc' => :'DocumentPropertiesNfc',
-        :'driving_licence_information' => :'DocumentPropertiesDrivingLicenceInformation',
+        :'driving_licence_information' => :'Array<DocumentPropertiesDrivingLicenceInformationItem>',
         :'document_classification' => :'DocumentPropertiesDocumentClassification',
         :'extracted_data' => :'DocumentPropertiesExtractedData',
         :'drivers_licence' => :'Boolean',
@@ -464,7 +464,9 @@ module Onfido
       end
 
       if attributes.key?(:'driving_licence_information')
-        self.driving_licence_information = attributes[:'driving_licence_information']
+        if (value = attributes[:'driving_licence_information']).is_a?(Array)
+          self.driving_licence_information = value
+        end
       end
 
       if attributes.key?(:'document_classification')

data/lib/onfido/models/webhook.rb

@@ -27,6 +27,21 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # The unique identifier of the webhook.
     attr_accessor :id
 
@@ -46,6 +61,11 @@ module Onfido
         :'events' => :'events',
         :'environments' => :'environments',
         :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope',
         :'id' => :'id',
         :'url' => :'url',
         :'token' => :'token',
@@ -65,6 +85,11 @@ module Onfido
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
         :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String',
         :'id' => :'String',
         :'url' => :'String',
         :'token' => :'String',
@@ -121,6 +146,26 @@ module Onfido
         self.payload_version = attributes[:'payload_version']
       end
 
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       else
@@ -169,6 +214,11 @@ module Onfido
           events == o.events &&
           environments == o.environments &&
           payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope &&
           id == o.id &&
           url == o.url &&
           token == o.token &&
@@ -184,7 +234,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version, id, url, token, href].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, id, url, token, href].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_builder.rb

@@ -27,6 +27,21 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # The url that will listen to notifications (must be https).
     attr_accessor :url
 
@@ -37,6 +52,11 @@ module Onfido
         :'events' => :'events',
         :'environments' => :'environments',
         :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope',
         :'url' => :'url'
       }
     end
@@ -53,6 +73,11 @@ module Onfido
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
         :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String',
         :'url' => :'String'
       }
     end
@@ -106,6 +131,26 @@ module Onfido
         self.payload_version = attributes[:'payload_version']
       end
 
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       else
@@ -142,6 +187,11 @@ module Onfido
           events == o.events &&
           environments == o.environments &&
           payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope &&
           url == o.url
     end
 
@@ -154,7 +204,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version, url].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope, url].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/webhook_shared.rb

@@ -27,13 +27,33 @@ module Onfido
     # Webhook version used to control the payload object when sending webhooks.
     attr_accessor :payload_version
 
+    # Determines if the webhook will fetch OAuth access tokens to send in the Authorization header.
+    attr_accessor :oauth_enabled
+
+    # The url to fetch the OAuth access token using client credentials grant.
+    attr_accessor :oauth_server_url
+
+    # The client id to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_id
+
+    # The client secret to authenticate the client credentials grant.
+    attr_accessor :oauth_server_client_secret
+
+    # The scopes to be sent when requesting the access token.
+    attr_accessor :oauth_server_scope
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'enabled' => :'enabled',
         :'events' => :'events',
         :'environments' => :'environments',
-        :'payload_version' => :'payload_version'
+        :'payload_version' => :'payload_version',
+        :'oauth_enabled' => :'oauth_enabled',
+        :'oauth_server_url' => :'oauth_server_url',
+        :'oauth_server_client_id' => :'oauth_server_client_id',
+        :'oauth_server_client_secret' => :'oauth_server_client_secret',
+        :'oauth_server_scope' => :'oauth_server_scope'
       }
     end
 
@@ -48,7 +68,12 @@ module Onfido
         :'enabled' => :'Boolean',
         :'events' => :'Array<WebhookEventType>',
         :'environments' => :'Array<String>',
-        :'payload_version' => :'Integer'
+        :'payload_version' => :'Integer',
+        :'oauth_enabled' => :'Boolean',
+        :'oauth_server_url' => :'String',
+        :'oauth_server_client_id' => :'String',
+        :'oauth_server_client_secret' => :'String',
+        :'oauth_server_scope' => :'String'
       }
     end
 
@@ -92,6 +117,26 @@ module Onfido
       if attributes.key?(:'payload_version')
         self.payload_version = attributes[:'payload_version']
       end
+
+      if attributes.key?(:'oauth_enabled')
+        self.oauth_enabled = attributes[:'oauth_enabled']
+      end
+
+      if attributes.key?(:'oauth_server_url')
+        self.oauth_server_url = attributes[:'oauth_server_url']
+      end
+
+      if attributes.key?(:'oauth_server_client_id')
+        self.oauth_server_client_id = attributes[:'oauth_server_client_id']
+      end
+
+      if attributes.key?(:'oauth_server_client_secret')
+        self.oauth_server_client_secret = attributes[:'oauth_server_client_secret']
+      end
+
+      if attributes.key?(:'oauth_server_scope')
+        self.oauth_server_scope = attributes[:'oauth_server_scope']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -117,7 +162,12 @@ module Onfido
           enabled == o.enabled &&
           events == o.events &&
           environments == o.environments &&
-          payload_version == o.payload_version
+          payload_version == o.payload_version &&
+          oauth_enabled == o.oauth_enabled &&
+          oauth_server_url == o.oauth_server_url &&
+          oauth_server_client_id == o.oauth_server_client_id &&
+          oauth_server_client_secret == o.oauth_server_client_secret &&
+          oauth_server_scope == o.oauth_server_scope
     end
 
     # @see the `==` method
@@ -129,7 +179,7 @@ module Onfido
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, events, environments, payload_version].hash
+      [enabled, events, environments, payload_version, oauth_enabled, oauth_server_url, oauth_server_client_id, oauth_server_client_secret, oauth_server_scope].hash
     end
 
     # Builds the object from hash