trinsic_api 3.1.0 → 3.2.0

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 |  |
+| **outcome** | **String** | The outcome of comparing the submitted card number with NIRA database.              Possible values: - Exact Match - No Match - Not Returned |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::UgandaNidMatch2SecondaryIdNumberField.new(
+  input_value: 012345678,
+  outcome: Exact Match
+)
+```
+

data/docs/VerimiAddressOutput.md

@@ -0,0 +1,28 @@
+# TrinsicApi::VerimiAddressOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_address** | **String** | The formatted address. | [optional] |
+| **country_code** | **String** | The ISO 3166-1 alpha-2 country code. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **street** | **String** | The street name. | [optional] |
+| **building_number** | **String** | The building number. | [optional] |
+| **city** | **String** | The city. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::VerimiAddressOutput.new(
+  full_address: Willy-Brandt-Strasse 1 10557 Berlin Deutschland,
+  country_code: DE,
+  postal_code: 10557,
+  street: Willy-Brandt-Strasse,
+  building_number: 1,
+  city: Berlin
+)
+```
+

data/docs/VerimiProviderOutput.md

@@ -0,0 +1,68 @@
+# TrinsicApi::VerimiProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The full name of the individual. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **given_name** | **String** | The given name of the individual. | [optional] |
+| **middle_name** | **String** | The middle name of the individual. | [optional] |
+| **family_name** | **String** | The family name of the individual. | [optional] |
+| **email** | **String** | The email address of the individual. | [optional] |
+| **email_verified** | **Boolean** | Whether the email address has been verified by Verimi. | [optional] |
+| **phone_number** | **String** | The phone number of the individual in E.164 format. | [optional] |
+| **phone_number_verified** | **Boolean** | Whether the phone number has been verified by Verimi. | [optional] |
+| **gender** | **String** | The gender of the individual. | [optional] |
+| **zone_information** | **String** | The individual's time zone as an IANA Time Zone Database zoneinfo identifier. | [optional] |
+| **locale** | **String** | The selected language or locale of the individual as a BCP 47 language tag. | [optional] |
+| **citizenship** | **String** | The citizenship of the individual.              This is an ISO-3166-1 alpha-2 country code. | [optional] |
+| **place_of_birth** | **String** | The place of birth of the individual. | [optional] |
+| **document_number** | **String** | The document number of the identity document used by the individual. | [optional] |
+| **document_type** | **String** | The identity document type.              Known values: - I: ID card. - P: Passport. | [optional] |
+| **document_expiration_date** | **Date** | The expiration date of the identity document. | [optional] |
+| **document_issue_date** | **Date** | The issue date of the identity document. | [optional] |
+| **document_issuing_authority** | **String** | The authority that issued the identity document. | [optional] |
+| **verification_method** | **String** | The verification method used to prove the individual's identity. | [optional] |
+| **verification_date** | **Date** | The date when the individual proved their identity with Verimi. | [optional] |
+| **level_of_assurance** | **String** | The level of assurance for the verification.              Known values: - Low: The individual has self-asserted their identity. - Substantial: The individual has completed identity proofing and strong authentication. - High: The individual has completed identity proofing with stronger cryptographic authentication requirements. | [optional] |
+| **authentication_method** | **String** | The authentication method for the completed identification.              Known values: - email - loa.dipp.default - loa.dipp.2fa - idcard | [optional] |
+| **pseudonym** | **String** | The pseudonymous identifier.              For German eID, this is the restricted identifier (rID), scoped to the relying-party sector. | [optional] |
+| **address** | [**VerimiAddressOutput**](VerimiAddressOutput.md) | The individual's structured address. | [optional] |
+| **issuing_country** | **String** | The ISO 3166-1 alpha-2 country code for the country that issued the identity document. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::VerimiProviderOutput.new(
+  full_name: Ove Henriksen,
+  date_of_birth: Sun Aug 15 00:00:00 UTC 1943,
+  given_name: Erika,
+  middle_name: Maria,
+  family_name: Mustermann,
+  email: erika.mustermann@example.de,
+  email_verified: true,
+  phone_number: +4915112345678,
+  phone_number_verified: true,
+  gender: female,
+  zone_information: Europe/Berlin,
+  locale: de-DE,
+  citizenship: DE,
+  place_of_birth: Munich,
+  document_number: C01X00T47,
+  document_type: I,
+  document_expiration_date: Mon May 20 00:00:00 UTC 2030,
+  document_issue_date: Thu May 21 00:00:00 UTC 2020,
+  document_issuing_authority: Stadt Koln,
+  verification_method: EID,
+  verification_date: Wed Apr 23 00:00:00 UTC 2025,
+  level_of_assurance: Substantial,
+  authentication_method: idcard,
+  pseudonym: 9f6a5d89e2b741c0a7f8d3e4b5c6a91234567890abcdef1234567890abcdef12,
+  address: null,
+  issuing_country: DE
+)
+```
+

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 |  |
+| **given_name** | **String** | Given name(s) of the individual. |  |
+| **family_name** | **String** | Family name of the individual. |  |
+| **full_name** | **String** | Full name of the individual. |  |
+| **sex** | **String** | Sex of the individual.              Possible values: - Male - Female - Not Applicable - Unknown |  |
+| **date_of_birth** | **Date** | Date of birth of the individual. |  |
+| **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/models/apple_wallet_digital_id_birth_date.rb

@@ -0,0 +1,177 @@
+=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
+  # 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 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
+      {
+        :'date_of_birth' => :'dateOfBirth',
+        :'approximate_mask' => :'approximateMask'
+      }
+    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
+      {
+        :'date_of_birth' => :'Date',
+        :'approximate_mask' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'approximate_mask'
+      ])
+    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::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::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?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      else
+        self.date_of_birth = nil
+      end
+
+      if attributes.key?(:'approximate_mask')
+        self.approximate_mask = attributes[:'approximate_mask']
+      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 @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth 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 @date_of_birth.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      if date_of_birth.nil?
+        fail ArgumentError, 'date_of_birth cannot be nil'
+      end
+
+      @date_of_birth = date_of_birth
+    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 &&
+          date_of_birth == o.date_of_birth &&
+          approximate_mask == o.approximate_mask
+    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
+      [date_of_birth, approximate_mask].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