trinsic_api 3.1.0 → 3.2.1

data/docs/UgandaNidMatch2DateOfBirthField.md

@@ -0,0 +1,20 @@
+# TrinsicApi::UgandaNidMatch2DateOfBirthField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input_value** | **Date** | The date of birth submitted for this check. | [optional] |
+| **outcome** | **String** | The outcome of comparing the submitted date of birth with NIRA database.              For Uganda match, partial or transposed outcomes are not used; matching is exact or no match.              Possible values: - Exact Match - No Match - Not Returned | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::UgandaNidMatch2DateOfBirthField.new(
+  input_value: Wed Sep 20 00:00:00 UTC 2000,
+  outcome: Exact Match
+)
+```
+

data/docs/UgandaNidMatch2Input.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_number** | **String** | The user's Uganda National ID number (NIN) - 14 alphanumeric characters | [optional] |
+| **id_number** | **String** | Uganda National ID number (NID) assigned by the National Identification and Registration Authority (NIRA).              Format: - 14 alphanumeric characters (A-Z, 0-9) - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by NIRA | [optional] |
 | **secondary_id_number** | **String** | The card number on the document (secondary ID number). Required for Uganda Basic KYC instead of first name and last name. | [optional] |
 | **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format | [optional] |
 

data/docs/UgandaNidMatch2NationalIdNumberField.md

@@ -0,0 +1,20 @@
+# TrinsicApi::UgandaNidMatch2NationalIdNumberField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input_value** | **String** | Uganda National ID number (NID) assigned by the National Identification and Registration Authority (NIRA).              Format: - 14 alphanumeric characters (A-Z, 0-9) - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by NIRA | [optional] |
+| **outcome** | **String** | The outcome of looking up the NID in NIRA database.              Possible values: - Verified - Not Verified - Not Done - Issuer Unavailable - Not Returned | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::UgandaNidMatch2NationalIdNumberField.new(
+  input_value: AB12CD34EF5678,
+  outcome: Verified
+)
+```
+

data/docs/UgandaNidMatch2ProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::UgandaNidMatch2ProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **national_id_number** | [**UgandaNidMatch2NationalIdNumberField**](UgandaNidMatch2NationalIdNumberField.md) | Outcome of verifying the national identification number in the NIRA database. | [optional] |
+| **secondary_id_number** | [**UgandaNidMatch2SecondaryIdNumberField**](UgandaNidMatch2SecondaryIdNumberField.md) | Outcome of comparing the submitted card number with the NIRA database. | [optional] |
+| **date_of_birth** | [**UgandaNidMatch2DateOfBirthField**](UgandaNidMatch2DateOfBirthField.md) | Outcome of comparing the submitted date of birth with the NIRA database. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::UgandaNidMatch2ProviderOutput.new(
+  national_id_number: null,
+  secondary_id_number: null,
+  date_of_birth: null
+)
+```
+

data/docs/UgandaNidMatch2SecondaryIdNumberField.md

@@ -0,0 +1,20 @@
+# TrinsicApi::UgandaNidMatch2SecondaryIdNumberField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input_value** | **String** | The card number on the national ID document, distinct from the National ID number.              Format: - 9 numeric digits - There is no publicly documented encoding scheme for encoding personal information in the card number - No check digit or algorithm has been publicly documented by NIRA | [optional] |
+| **outcome** | **String** | The outcome of comparing the submitted card number with NIRA database.              Possible values: - Exact Match - No Match - Not Returned | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::UgandaNidMatch2SecondaryIdNumberField.new(
+  input_value: 012345678,
+  outcome: Exact Match
+)
+```
+

data/docs/YotiDeeplinkProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
+| **yoti_remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
 | **email** | **String** | The email address of the individual | [optional] |
 | **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
 | **family_name** | **String** | The family name of the individual | [optional] |
@@ -23,7 +23,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::YotiDeeplinkProviderOutput.new(
-  remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  yoti_remember_me_id: Ic3NCB/dWVB1k4QPOD98IpDJ8ut04 lPHPSNV0RWikAc+szH2NrZFK1 nG+cZgaXe8,
   email: johndoe@example.com,
   given_name: John Alvin,
   family_name: Doe,

data/docs/YotiProviderOutput.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
+| **yoti_remember_me_id** | **String** | A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party. | [optional] |
 | **email** | **String** | The email address of the individual | [optional] |
 | **given_name** | **String** | The given name of the individual. This can correspond to first and middle names in English. | [optional] |
 | **family_name** | **String** | The family name of the individual | [optional] |
@@ -23,7 +23,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::YotiProviderOutput.new(
-  remember_me_id: 9f63ff98-e1e3-433c-9b86-7c697d0b4e5f,
+  yoti_remember_me_id: Ic3NCB/dWVB1k4QPOD98IpDJ8ut04 lPHPSNV0RWikAc+szH2NrZFK1 nG+cZgaXe8,
   email: johndoe@example.com,
   given_name: John Alvin,
   family_name: Doe,

data/docs/ZimbabweNidLookup2Input.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id_number** | **String** | The user's National ID number | [optional] |
+| **id_number** | **String** | Zimbabwe National ID number (NID) issued by the Zimbabwean government.              Format: - 8-9 digits followed by 1 letter and 2 digits - Regex: /^[0-9]{8,9}[A-Za-z]\\d{2}$/ - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by the Zimbabwean government | [optional] |
 
 ## Example
 

data/docs/ZimbabweNidLookup2ProviderOutput.md

@@ -0,0 +1,34 @@
+# TrinsicApi::ZimbabweNidLookup2ProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **national_id_number** | **String** | Zimbabwe National ID number (NID) issued by the Zimbabwean government.              Format: - 8-9 digits followed by 1 letter and 2 digits - Regex: /^[0-9]{8,9}[A-Za-z]\\d{2}$/ - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by the Zimbabwean government | [optional] |
+| **given_name** | **String** | Given name(s) of the individual. | [optional] |
+| **family_name** | **String** | Family name of the individual. | [optional] |
+| **full_name** | **String** | Full name of the individual. | [optional] |
+| **sex** | **String** | Sex of the individual.              Possible values: - Male - Female - Not Applicable - Unknown | [optional] |
+| **date_of_birth** | **Date** | Date of birth of the individual. | [optional] |
+| **place_of_birth** | **String** | Place of birth, typically a municipality or city within Zimbabwe. | [optional] |
+| **is_alive** | **Boolean** | Whether individual is reported as alive by the Zimbabwean government. | [optional] |
+| **date_of_death** | **Date** | Date of death of the individual, when available. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ZimbabweNidLookup2ProviderOutput.new(
+  national_id_number: 12345678A12,
+  given_name: ELIZABETH MARY,
+  family_name: MOYO,
+  full_name: ELIZABETH MARY MOYO,
+  sex: Female,
+  date_of_birth: Fri Nov 01 00:00:00 UTC 1940,
+  place_of_birth: Harare,
+  is_alive: false,
+  date_of_death: Wed Jan 10 00:00:00 UTC 2024
+)
+```
+

data/lib/trinsic_api/configuration.rb

@@ -260,6 +260,10 @@ module TrinsicApi
         {
           url: "https://api.trinsic.id",
           description: "Production server",
+        },
+        {
+          url: "https://api.eu.trinsic.id",
+          description: "Production server (EU data residency preview)",
         }
       ]
     end

data/lib/trinsic_api/models/aadhaar_language.rb

@@ -52,6 +52,7 @@ module TrinsicApi
     def self.openapi_nullable
       Set.new([
         :'language_code',
+        :'language_name'
       ])
     end
 
@@ -77,8 +78,6 @@ module TrinsicApi
 
       if attributes.key?(:'language_name')
         self.language_name = attributes[:'language_name']
-      else
-        self.language_name = nil
       end
     end
 
@@ -87,10 +86,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @language_name.nil?
-        invalid_properties.push('invalid value for "language_name", language_name cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -98,20 +93,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @language_name.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] language_name Value to be assigned
-    def language_name=(language_name)
-      if language_name.nil?
-        fail ArgumentError, 'language_name cannot be nil'
-      end
-
-      @language_name = language_name
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/age_over_output.rb

@@ -51,6 +51,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'age',
+        :'is_over'
       ])
     end
 
@@ -72,14 +74,10 @@ module TrinsicApi
 
       if attributes.key?(:'age')
         self.age = attributes[:'age']
-      else
-        self.age = nil
       end
 
       if attributes.key?(:'is_over')
         self.is_over = attributes[:'is_over']
-      else
-        self.is_over = nil
       end
     end
 
@@ -88,14 +86,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @age.nil?
-        invalid_properties.push('invalid value for "age", age cannot be nil.')
-      end
-
-      if @is_over.nil?
-        invalid_properties.push('invalid value for "is_over", is_over cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -103,31 +93,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @age.nil?
-      return false if @is_over.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] age Value to be assigned
-    def age=(age)
-      if age.nil?
-        fail ArgumentError, 'age cannot be nil'
-      end
-
-      @age = age
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] is_over Value to be assigned
-    def is_over=(is_over)
-      if is_over.nil?
-        fail ArgumentError, 'is_over cannot be nil'
-      end
-
-      @is_over = is_over
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/alaska_mobile_id_provider_output.rb

@@ -0,0 +1,161 @@
+=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
+  # Exposed properties for the `usa-alaska-mobile-id` Provider which do not directly map to the normalized IdentityData model.
+  class AlaskaMobileIdProviderOutput < ApiModelBase
+    # A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet.
+    attr_accessor :mobile_drivers_license
+
+    # The raw output of the 18013-7 mDL exchange performed through Alaska Mobile ID.
+    attr_accessor :raw_mdl_output
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'mobile_drivers_license' => :'mobileDriversLicense',
+        :'raw_mdl_output' => :'rawMdlOutput'
+      }
+    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
+      {
+        :'mobile_drivers_license' => :'Iso180135MobileDriversLicenseCredential',
+        :'raw_mdl_output' => :'MdlOutput'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'mobile_drivers_license',
+        :'raw_mdl_output'
+      ])
+    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::AlaskaMobileIdProviderOutput` 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::AlaskaMobileIdProviderOutput`. 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?(:'mobile_drivers_license')
+        self.mobile_drivers_license = attributes[:'mobile_drivers_license']
+      end
+
+      if attributes.key?(:'raw_mdl_output')
+        self.raw_mdl_output = attributes[:'raw_mdl_output']
+      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 &&
+          mobile_drivers_license == o.mobile_drivers_license &&
+          raw_mdl_output == o.raw_mdl_output
+    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
+      [mobile_drivers_license, raw_mdl_output].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/{south_africa_nid_biometric2_input.rb → apple_wallet_digital_id_birth_date.rb}

@@ -14,22 +14,19 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class SouthAfricaNidBiometric2Input < ApiModelBase
-    # The user's South African National ID number
-    attr_accessor :id_number
+  # A date of birth field as encoded in an Apple Wallet Digital ID credential, possibly with an \"approximate mask\" indicating uncertain digits.
+  class AppleWalletDigitalIdBirthDate < ApiModelBase
+    # The encoded date of birth.
+    attr_accessor :date_of_birth
 
-    # An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size.
-    attr_accessor :liveness_images
-
-    # Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
-    attr_accessor :test_selfie
+    # An 8-character mask of `1`s and `0`s, where a `1` indicates that the corresponding digit in the birth date (formatted as YYYYMMDD) is uncertain or unknown.              For example, a mask of \"00000011\" indicates that the day-of-month on which the individual was born is not certain.
+    attr_accessor :approximate_mask
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_number' => :'idNumber',
-        :'liveness_images' => :'livenessImages',
-        :'test_selfie' => :'testSelfie'
+        :'date_of_birth' => :'dateOfBirth',
+        :'approximate_mask' => :'approximateMask'
       }
     end
 
@@ -46,18 +43,16 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_number' => :'String',
-        :'liveness_images' => :'Array<String>',
-        :'test_selfie' => :'String'
+        :'date_of_birth' => :'Date',
+        :'approximate_mask' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id_number',
-        :'liveness_images',
-        :'test_selfie'
+        :'date_of_birth',
+        :'approximate_mask'
       ])
     end
 
@@ -65,30 +60,24 @@ module TrinsicApi
     # @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::SouthAfricaNidBiometric2Input` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::AppleWalletDigitalIdBirthDate` 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::SouthAfricaNidBiometric2Input`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::AppleWalletDigitalIdBirthDate`. 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?(:'id_number')
-        self.id_number = attributes[:'id_number']
-      end
-
-      if attributes.key?(:'liveness_images')
-        if (value = attributes[:'liveness_images']).is_a?(Array)
-          self.liveness_images = value
-        end
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
       end
 
-      if attributes.key?(:'test_selfie')
-        self.test_selfie = attributes[:'test_selfie']
+      if attributes.key?(:'approximate_mask')
+        self.approximate_mask = attributes[:'approximate_mask']
       end
     end
 
@@ -112,9 +101,8 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id_number == o.id_number &&
-          liveness_images == o.liveness_images &&
-          test_selfie == o.test_selfie
+          date_of_birth == o.date_of_birth &&
+          approximate_mask == o.approximate_mask
     end
 
     # @see the `==` method
@@ -126,7 +114,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_number, liveness_images, test_selfie].hash
+      [date_of_birth, approximate_mask].hash
     end
 
     # Builds the object from hash