trinsic_api 3.1.0 → 3.2.0

data/lib/trinsic_api/models/apple_wallet_digital_id_credential.rb

@@ -0,0 +1,350 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # An Apple Wallet Digital ID credential, with document type `org.iso.23220.photoid.1`.              This is a passport-derived digital credential issued by Apple.
+  class AppleWalletDigitalIdCredential < ApiModelBase
+    # First name(s), other name(s), or secondary identifier of the individual.              This field uses the full UTF-8 character set and can represent any name.
+    attr_accessor :given_name_unicode
+
+    # First name(s), other name(s), or secondary identifier of the individual.              This field uses the Latin-1 character set and is limited to names represented by the English alphabet. represented using the English alphabet.
+    attr_accessor :given_name_latin1
+
+    # Last name, surname, or primary identifier of the individual.              This field uses the full UTF-8 character set and can represent any name.
+    attr_accessor :family_name_unicode
+
+    # Last name, surname, or primary identifier of the individual.              This field uses only the Latin-1 character set and is largely limited to names which can be represented using the English alphabet.
+    attr_accessor :family_name_latin1
+
+    # The individual's sex as an ISO/IEC 5218 code.              Possible values: - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable
+    attr_accessor :sex
+
+    # The date of birth of the individual, possibly with an \"approximate mask\" indicating uncertain digits.
+    attr_accessor :date_of_birth
+
+    # The document number of the underlying passport used to create the Digital ID.
+    attr_accessor :document_number
+
+    # Name or identifier of the issuing authority of the credential, using the full UTF-8 character set.              This field's contents are arbitrary; it has no guaranteed format.
+    attr_accessor :issuing_authority_unicode
+
+    # ISO 3166-2 country-subdivision code for the jurisdiction that issued the credential.
+    attr_accessor :issuing_subdivision
+
+    # ISO 3166-1 alpha-2 country code of the issuing authority's country or territory.
+    attr_accessor :issuing_country
+
+    # Date when the underlying passport used to create the Digital ID was issued.
+    attr_accessor :issue_date
+
+    # Date when the underlying passport used to create the Digital ID expires.
+    attr_accessor :expiry_date
+
+    # The age of the individual, as of the issuance date of the credential.
+    attr_accessor :age_in_years
+
+    # Processed age-over claims returned by the credential.
+    attr_accessor :age_over
+
+    # The permanent address of the individual, using the full UTF-8 character set.              This is only present if the underlying passport contained an address, which is uncommon.
+    attr_accessor :resident_address_unicode
+
+    # City of the individual's permanent address, using the full UTF-8 character set.              This is only present if the underlying passport contained an address, which is uncommon.
+    attr_accessor :resident_city_unicode
+
+    # City of the individual's permanent address, using the Latin-1 character set.              This is only present if the underlying passport contained an address, which is uncommon.
+    attr_accessor :resident_city_latin1
+
+    # Postal code of the individual's permanent address.              This is only present if the underlying passport contained an address, which is uncommon.
+    attr_accessor :resident_postal_code
+
+    # ISO 3166-1 alpha-2 country code of the individual's permanent address.              This is only present if the underlying passport contained an address, which is uncommon.
+    attr_accessor :resident_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'given_name_unicode' => :'givenNameUnicode',
+        :'given_name_latin1' => :'givenNameLatin1',
+        :'family_name_unicode' => :'familyNameUnicode',
+        :'family_name_latin1' => :'familyNameLatin1',
+        :'sex' => :'sex',
+        :'date_of_birth' => :'dateOfBirth',
+        :'document_number' => :'documentNumber',
+        :'issuing_authority_unicode' => :'issuingAuthorityUnicode',
+        :'issuing_subdivision' => :'issuingSubdivision',
+        :'issuing_country' => :'issuingCountry',
+        :'issue_date' => :'issueDate',
+        :'expiry_date' => :'expiryDate',
+        :'age_in_years' => :'ageInYears',
+        :'age_over' => :'ageOver',
+        :'resident_address_unicode' => :'residentAddressUnicode',
+        :'resident_city_unicode' => :'residentCityUnicode',
+        :'resident_city_latin1' => :'residentCityLatin1',
+        :'resident_postal_code' => :'residentPostalCode',
+        :'resident_country' => :'residentCountry'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'given_name_unicode' => :'String',
+        :'given_name_latin1' => :'String',
+        :'family_name_unicode' => :'String',
+        :'family_name_latin1' => :'String',
+        :'sex' => :'Integer',
+        :'date_of_birth' => :'AppleWalletDigitalIdBirthDate',
+        :'document_number' => :'String',
+        :'issuing_authority_unicode' => :'String',
+        :'issuing_subdivision' => :'String',
+        :'issuing_country' => :'String',
+        :'issue_date' => :'Date',
+        :'expiry_date' => :'Date',
+        :'age_in_years' => :'Integer',
+        :'age_over' => :'Array<AgeOverOutput>',
+        :'resident_address_unicode' => :'String',
+        :'resident_city_unicode' => :'String',
+        :'resident_city_latin1' => :'String',
+        :'resident_postal_code' => :'String',
+        :'resident_country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'given_name_unicode',
+        :'given_name_latin1',
+        :'family_name_unicode',
+        :'family_name_latin1',
+        :'sex',
+        :'date_of_birth',
+        :'document_number',
+        :'issuing_authority_unicode',
+        :'issuing_subdivision',
+        :'issuing_country',
+        :'issue_date',
+        :'expiry_date',
+        :'age_in_years',
+        :'age_over',
+        :'resident_address_unicode',
+        :'resident_city_unicode',
+        :'resident_city_latin1',
+        :'resident_postal_code',
+        :'resident_country'
+      ])
+    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 `TrinsicApi::AppleWalletDigitalIdCredential` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::AppleWalletDigitalIdCredential`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'given_name_unicode')
+        self.given_name_unicode = attributes[:'given_name_unicode']
+      end
+
+      if attributes.key?(:'given_name_latin1')
+        self.given_name_latin1 = attributes[:'given_name_latin1']
+      end
+
+      if attributes.key?(:'family_name_unicode')
+        self.family_name_unicode = attributes[:'family_name_unicode']
+      end
+
+      if attributes.key?(:'family_name_latin1')
+        self.family_name_latin1 = attributes[:'family_name_latin1']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'issuing_authority_unicode')
+        self.issuing_authority_unicode = attributes[:'issuing_authority_unicode']
+      end
+
+      if attributes.key?(:'issuing_subdivision')
+        self.issuing_subdivision = attributes[:'issuing_subdivision']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_country']
+      end
+
+      if attributes.key?(:'issue_date')
+        self.issue_date = attributes[:'issue_date']
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'age_in_years')
+        self.age_in_years = attributes[:'age_in_years']
+      end
+
+      if attributes.key?(:'age_over')
+        if (value = attributes[:'age_over']).is_a?(Array)
+          self.age_over = value
+        end
+      end
+
+      if attributes.key?(:'resident_address_unicode')
+        self.resident_address_unicode = attributes[:'resident_address_unicode']
+      end
+
+      if attributes.key?(:'resident_city_unicode')
+        self.resident_city_unicode = attributes[:'resident_city_unicode']
+      end
+
+      if attributes.key?(:'resident_city_latin1')
+        self.resident_city_latin1 = attributes[:'resident_city_latin1']
+      end
+
+      if attributes.key?(:'resident_postal_code')
+        self.resident_postal_code = attributes[:'resident_postal_code']
+      end
+
+      if attributes.key?(:'resident_country')
+        self.resident_country = attributes[:'resident_country']
+      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 &&
+          given_name_unicode == o.given_name_unicode &&
+          given_name_latin1 == o.given_name_latin1 &&
+          family_name_unicode == o.family_name_unicode &&
+          family_name_latin1 == o.family_name_latin1 &&
+          sex == o.sex &&
+          date_of_birth == o.date_of_birth &&
+          document_number == o.document_number &&
+          issuing_authority_unicode == o.issuing_authority_unicode &&
+          issuing_subdivision == o.issuing_subdivision &&
+          issuing_country == o.issuing_country &&
+          issue_date == o.issue_date &&
+          expiry_date == o.expiry_date &&
+          age_in_years == o.age_in_years &&
+          age_over == o.age_over &&
+          resident_address_unicode == o.resident_address_unicode &&
+          resident_city_unicode == o.resident_city_unicode &&
+          resident_city_latin1 == o.resident_city_latin1 &&
+          resident_postal_code == o.resident_postal_code &&
+          resident_country == o.resident_country
+    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
+      [given_name_unicode, given_name_latin1, family_name_unicode, family_name_latin1, sex, date_of_birth, document_number, issuing_authority_unicode, issuing_subdivision, issuing_country, issue_date, expiry_date, age_in_years, age_over, resident_address_unicode, resident_city_unicode, resident_city_latin1, resident_postal_code, resident_country].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
+
+    # 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
+
+  end
+
+end

data/lib/trinsic_api/models/apple_wallet_provider_output.rb

@@ -19,6 +19,9 @@ module TrinsicApi
     # A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet.
     attr_accessor :mobile_drivers_license
 
+    # An Apple Wallet Digital ID credential (`org.iso.23220.photoid.1`), retrieved from the individual's wallet.
+    attr_accessor :digital_id
+
     # The raw output of the mDL exchange performed through Apple Wallet.
     attr_accessor :raw_mdl_output
 
@@ -26,6 +29,7 @@ module TrinsicApi
     def self.attribute_map
       {
         :'mobile_drivers_license' => :'mobileDriversLicense',
+        :'digital_id' => :'digitalId',
         :'raw_mdl_output' => :'rawMdlOutput'
       }
     end
@@ -44,6 +48,7 @@ module TrinsicApi
     def self.openapi_types
       {
         :'mobile_drivers_license' => :'Iso180135MobileDriversLicenseCredential',
+        :'digital_id' => :'AppleWalletDigitalIdCredential',
         :'raw_mdl_output' => :'MdlOutput'
       }
     end
@@ -52,6 +57,7 @@ module TrinsicApi
     def self.openapi_nullable
       Set.new([
         :'mobile_drivers_license',
+        :'digital_id',
       ])
     end
 
@@ -75,6 +81,10 @@ module TrinsicApi
         self.mobile_drivers_license = attributes[:'mobile_drivers_license']
       end
 
+      if attributes.key?(:'digital_id')
+        self.digital_id = attributes[:'digital_id']
+      end
+
       if attributes.key?(:'raw_mdl_output')
         self.raw_mdl_output = attributes[:'raw_mdl_output']
       else
@@ -118,6 +128,7 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           mobile_drivers_license == o.mobile_drivers_license &&
+          digital_id == o.digital_id &&
           raw_mdl_output == o.raw_mdl_output
     end
 
@@ -130,7 +141,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mobile_drivers_license, raw_mdl_output].hash
+      [mobile_drivers_license, digital_id, raw_mdl_output].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/brazil_cnh_facial_biometry_output.rb

@@ -0,0 +1,198 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class BrazilCnhFacialBiometryOutput < ApiModelBase
+    # Whether the government database had facial biometrics available for comparison.
+    attr_accessor :database_face_available
+
+    # Probability bucket returned by Serpro for the facial biometric comparison.              Known values: - VeryLow - Low - High - VeryHigh
+    attr_accessor :probability
+
+    # Similarity score returned by Serpro for the facial biometric comparison.              Ranges from 0.0 to 1.0, where 1.0 is a perfect match.
+    attr_accessor :similarity_score
+
+    # Liveness result returned by Serpro when liveness is part of the validation response.              Known values: - BAD_QUALITY: The image quality was too low for liveness validation. - FAKE: Liveness validation detected a presentation attack or non-live face. - REAL: Liveness validation detected a live face.
+    attr_accessor :liveness
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'database_face_available' => :'databaseFaceAvailable',
+        :'probability' => :'probability',
+        :'similarity_score' => :'similarityScore',
+        :'liveness' => :'liveness'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'database_face_available' => :'Boolean',
+        :'probability' => :'String',
+        :'similarity_score' => :'Float',
+        :'liveness' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'probability',
+        :'similarity_score',
+        :'liveness'
+      ])
+    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 `TrinsicApi::BrazilCnhFacialBiometryOutput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::BrazilCnhFacialBiometryOutput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'database_face_available')
+        self.database_face_available = attributes[:'database_face_available']
+      else
+        self.database_face_available = nil
+      end
+
+      if attributes.key?(:'probability')
+        self.probability = attributes[:'probability']
+      end
+
+      if attributes.key?(:'similarity_score')
+        self.similarity_score = attributes[:'similarity_score']
+      end
+
+      if attributes.key?(:'liveness')
+        self.liveness = attributes[:'liveness']
+      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
+      if @database_face_available.nil?
+        invalid_properties.push('invalid value for "database_face_available", database_face_available cannot be nil.')
+      end
+
+      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'
+      return false if @database_face_available.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] database_face_available Value to be assigned
+    def database_face_available=(database_face_available)
+      if database_face_available.nil?
+        fail ArgumentError, 'database_face_available cannot be nil'
+      end
+
+      @database_face_available = database_face_available
+    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 &&
+          database_face_available == o.database_face_available &&
+          probability == o.probability &&
+          similarity_score == o.similarity_score &&
+          liveness == o.liveness
+    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
+      [database_face_available, probability, similarity_score, liveness].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
+
+    # 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
+
+  end
+
+end