onfido 3.4.0 → 4.6.0

data/lib/onfido/models/facial_similarity_report_shared.rb

@@ -0,0 +1,253 @@
+=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 FacialSimilarityReportShared
+    # Array of objects with live photo ids that were used in the Onfido engine.
+    attr_accessor :live_photos
+
+    # Array of objects with live video ids that were used in the Onfido engine.
+    attr_accessor :live_videos
+
+    # Array of objects with motion capture ids that were used in the Onfido engine.
+    attr_accessor :motion_captures
+
+    # Array of objects with id photo ids that were used in the Onfido engine.
+    attr_accessor :id_photos
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'live_photos' => :'live_photos',
+        :'live_videos' => :'live_videos',
+        :'motion_captures' => :'motion_captures',
+        :'id_photos' => :'id_photos'
+      }
+    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
+      {
+        :'live_photos' => :'Array<FacialSimilarityReportMedia>',
+        :'live_videos' => :'Array<FacialSimilarityReportMedia>',
+        :'motion_captures' => :'Array<FacialSimilarityReportMedia>',
+        :'id_photos' => :'Array<FacialSimilarityReportMedia>'
+      }
+    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::FacialSimilarityReportShared` 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::FacialSimilarityReportShared`. 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?(:'live_photos')
+        if (value = attributes[:'live_photos']).is_a?(Array)
+          self.live_photos = value
+        end
+      end
+
+      if attributes.key?(:'live_videos')
+        if (value = attributes[:'live_videos']).is_a?(Array)
+          self.live_videos = value
+        end
+      end
+
+      if attributes.key?(:'motion_captures')
+        if (value = attributes[:'motion_captures']).is_a?(Array)
+          self.motion_captures = value
+        end
+      end
+
+      if attributes.key?(:'id_photos')
+        if (value = attributes[:'id_photos']).is_a?(Array)
+          self.id_photos = value
+        end
+      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 &&
+          live_photos == o.live_photos &&
+          live_videos == o.live_videos &&
+          motion_captures == o.motion_captures &&
+          id_photos == o.id_photos
+    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
+      [live_photos, live_videos, motion_captures, id_photos].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/facial_similarity_video_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/facial_similarity_video_breakdown_face_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/facial_similarity_video_breakdown_image_integrity.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/facial_similarity_video_breakdown_image_integrity_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/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected.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/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity.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/facial_similarity_video_breakdown_visual_authenticity.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/facial_similarity_video_breakdown_visual_authenticity_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/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected.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/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection.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/facial_similarity_video_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/facial_similarity_video_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
 
@@ -38,6 +38,18 @@ module Onfido
 
     attr_accessor :name
 
+    # Array of objects with live photo ids that were used in the Onfido engine.
+    attr_accessor :live_photos
+
+    # Array of objects with live video ids that were used in the Onfido engine.
+    attr_accessor :live_videos
+
+    # Array of objects with motion capture ids that were used in the Onfido engine.
+    attr_accessor :motion_captures
+
+    # Array of objects with id photo ids that were used in the Onfido engine.
+    attr_accessor :id_photos
+
     attr_accessor :breakdown
 
     attr_accessor :properties
@@ -76,6 +88,10 @@ module Onfido
         :'check_id' => :'check_id',
         :'documents' => :'documents',
         :'name' => :'name',
+        :'live_photos' => :'live_photos',
+        :'live_videos' => :'live_videos',
+        :'motion_captures' => :'motion_captures',
+        :'id_photos' => :'id_photos',
         :'breakdown' => :'breakdown',
         :'properties' => :'properties'
       }
@@ -98,6 +114,10 @@ module Onfido
         :'check_id' => :'String',
         :'documents' => :'Array<ReportDocument>',
         :'name' => :'ReportName',
+        :'live_photos' => :'Array<FacialSimilarityReportMedia>',
+        :'live_videos' => :'Array<FacialSimilarityReportMedia>',
+        :'motion_captures' => :'Array<FacialSimilarityReportMedia>',
+        :'id_photos' => :'Array<FacialSimilarityReportMedia>',
         :'breakdown' => :'FacialSimilarityVideoBreakdown',
         :'properties' => :'FacialSimilarityVideoProperties'
       }
@@ -112,6 +132,7 @@ module Onfido
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
+      :'FacialSimilarityReportShared',
       :'ReportShared'
       ]
     end
@@ -173,6 +194,30 @@ module Onfido
         self.name = nil
       end
 
+      if attributes.key?(:'live_photos')
+        if (value = attributes[:'live_photos']).is_a?(Array)
+          self.live_photos = value
+        end
+      end
+
+      if attributes.key?(:'live_videos')
+        if (value = attributes[:'live_videos']).is_a?(Array)
+          self.live_videos = value
+        end
+      end
+
+      if attributes.key?(:'motion_captures')
+        if (value = attributes[:'motion_captures']).is_a?(Array)
+          self.motion_captures = value
+        end
+      end
+
+      if attributes.key?(:'id_photos')
+        if (value = attributes[:'id_photos']).is_a?(Array)
+          self.id_photos = value
+        end
+      end
+
       if attributes.key?(:'breakdown')
         self.breakdown = attributes[:'breakdown']
       end
@@ -221,6 +266,10 @@ module Onfido
           check_id == o.check_id &&
           documents == o.documents &&
           name == o.name &&
+          live_photos == o.live_photos &&
+          live_videos == o.live_videos &&
+          motion_captures == o.motion_captures &&
+          id_photos == o.id_photos &&
           breakdown == o.breakdown &&
           properties == o.properties
     end
@@ -234,7 +283,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, documents, name, breakdown, properties].hash
+      [id, created_at, href, status, result, sub_result, check_id, documents, name, live_photos, live_videos, motion_captures, id_photos, breakdown, properties].hash
     end
 
     # Builds the object from hash

data/lib/onfido/models/id_number.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
 
@@ -115,7 +115,7 @@ module Onfido
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      type_validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
+      type_validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_license", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
       return false unless type_validator.valid?(@type)
       true
     end
@@ -123,7 +123,7 @@ module Onfido
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
+      validator = EnumAttributeValidator.new('String', ["ssn", "social_insurance", "tax_id", "identity_card", "driving_license", "driving_licence", "share_code", "voter_id", "passport", "other", "unknown_default_open_api"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/onfido/models/id_photo.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/id_photo_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/id_photos_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/identity_enhanced_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/identity_enhanced_breakdown_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/identity_enhanced_breakdown_address_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/identity_enhanced_breakdown_address_breakdown_credit_agencies.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/identity_enhanced_breakdown_address_breakdown_credit_agencies_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/identity_enhanced_breakdown_address_breakdown_telephone_database.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/identity_enhanced_breakdown_address_breakdown_voting_register.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/identity_enhanced_breakdown_date_of_birth.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/identity_enhanced_breakdown_date_of_birth_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/identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies.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/identity_enhanced_breakdown_date_of_birth_breakdown_voting_register.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/identity_enhanced_breakdown_mortality.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/identity_enhanced_breakdown_sources.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/identity_enhanced_breakdown_sources_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