trinsic_api 3.1.0.pre.preview1 → 3.1.0

data/docs/Iso180135StandardNamespaceOutput.md

@@ -0,0 +1,86 @@
+# TrinsicApi::Iso180135StandardNamespaceOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | First name(s), other name(s), or secondary identifier of the individual. | [optional] |
+| **given_name_national_character** | **String** | The given name of the individual using the full UTF-8 character set. | [optional] |
+| **family_name** | **String** | Last name, surname, or primary identifier of the individual. | [optional] |
+| **family_name_national_character** | **String** | The family name of the individual using the full UTF-8 character set. | [optional] |
+| **date_of_birth** | **Date** | The date of birth of the individual. | [optional] |
+| **issue_date** | **Date** | The date when the mDL was issued.              This date marks the beginning of the Administrative Validity Period of the mDL, which is usually (but not necessarily always) the same as the issue date of the underlying physical document used to create the mDL, if one exists. | [optional] |
+| **expiry_date** | **Date** | The date when the mDL expires.              This date marks the end of the Administrative Validity Period of the mDL, which is usually (but not necessarily always) the same as the expiration date of the underlying physical document used to create the mDL, if one exists. | [optional] |
+| **issuing_country** | **String** | Alpha-2 country code of the issuing authority's country or territory. | [optional] |
+| **issuing_authority** | **String** | Name or identifier of the mDL issuing authority.              This field's contents are arbitrary; it has no guaranteed format. | [optional] |
+| **issuing_jurisdiction** | **String** | ISO 3166-2 country-subdivision code for the jurisdiction that issued the mDL. | [optional] |
+| **nationality** | **String** | Nationality of the individual as an ISO 3166-1 alpha-2 country code. | [optional] |
+| **document_number** | **String** | The document number assigned to the mDL.              This is typically the same as the document number of the underlying physical document used to create the mDL, if one exists. | [optional] |
+| **driving_privileges** | [**Array<Iso180135DrivingPrivilege>**](Iso180135DrivingPrivilege.md) | Driving privileges of the individual, parsed per ISO 18013-5. | [optional] |
+| **un_distinguishing_sign** | **String** | The UN Distinguishing sign of the issuing country according to ISO/IEC 18013-1. | [optional] |
+| **administrative_number** | **String** | Audit control number assigned by the issuing authority.              The meaning and semantics of this field are defined by the issuing authority in question. | [optional] |
+| **sex** | **Integer** | The individual's sex as an ISO/IEC 5218 code.              Possible values:              - 0: Unknown - 1: Male - 2: Female - 9: Not Applicable | [optional] |
+| **height_centimeters** | **Integer** | The individual's height in centimeters. | [optional] |
+| **weight_kilograms** | **Integer** | The individual's weight in kilograms. | [optional] |
+| **eye_color** | **String** | The individual's eye color.              Possible values:              - \"black\" - \"blue\" - \"brown\" - \"dichromatic\" - \"grey\" - \"green\" - \"hazel\" - \"maroon\" - \"pink\" - \"unknown\" | [optional] |
+| **hair_color** | **String** | The individual's hair color.              Possible values: - \"bald\" - \"black\" - \"blond\" - \"brown\" - \"grey\" - \"red\" - \"auburn\" - \"sandy\" - \"white\" - \"unknown\" | [optional] |
+| **birth_place** | **String** | Country and municipality or state/province where the individual was born. | [optional] |
+| **resident_address** | **String** | Address where the individual resides.              The exact format of this field is variable and depends on the issuer. It may map exactly to a \"Line1\", or it may include city, state, and/or zip code as well. | [optional] |
+| **resident_city** | **String** | City where the individual resides. | [optional] |
+| **resident_state** | **String** | State, province, or district where the individual resides. | [optional] |
+| **resident_postal_code** | **String** | Postal code where the individual resides. | [optional] |
+| **resident_country** | **String** | Country where the individual resides as an ISO 3166-1 alpha-2 country code. | [optional] |
+| **portrait_capture_date** | **Time** | Date and time when the portrait image was captured. | [optional] |
+| **age_in_years** | **Integer** | Age of the individual in years. | [optional] |
+| **age_birth_year** | **Integer** | Year of birth of the individual. | [optional] |
+| **age_over** | [**Array<AgeOverOutput>**](AgeOverOutput.md) | Processed age-over claims returned by the mDL. | [optional] |
+| **biometric_template_face** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Facial biometric template group from `biometric_template_face`, parsed per ISO 18013-2 Annex C. | [optional] |
+| **biometric_template_voice** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Vocal biometric template group from `biometric_template_voice`, parsed per ISO 18013-2 Annex C. | [optional] |
+| **biometric_template_finger** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Fingerprint biometric template group from `biometric_template_finger`, parsed per ISO 18013-2 Annex C. | [optional] |
+| **biometric_template_iris** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Iris biometric template group from `biometric_template_iris`, parsed per ISO 18013-2 Annex C. | [optional] |
+| **biometric_template_retina** | [**Iso180132BiometricGroupTemplate**](Iso180132BiometricGroupTemplate.md) | Retinal biometric template group from `biometric_template_retina`, parsed per ISO 18013-2 Annex C. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Iso180135StandardNamespaceOutput.new(
+  given_name: JOHN,
+  given_name_national_character: JOHN,
+  family_name: DOE,
+  family_name_national_character: DOE,
+  date_of_birth: Wed Jan 31 00:00:00 UTC 1990,
+  issue_date: Fri Jan 31 00:00:00 UTC 2020,
+  expiry_date: Thu Jan 31 00:00:00 UTC 2030,
+  issuing_country: US,
+  issuing_authority: CA,USA,
+  issuing_jurisdiction: US-CA,
+  nationality: US,
+  document_number: D1234567,
+  driving_privileges: [{"vehicleCategoryCode":"C","issueDate":"2020-01-31","expiryDate":"2030-01-31"}],
+  un_distinguishing_sign: USA,
+  administrative_number: 123456789,
+  sex: 1,
+  height_centimeters: 180,
+  weight_kilograms: 75,
+  eye_color: brown,
+  hair_color: black,
+  birth_place: SACRAMENTO, CA,
+  resident_address: 123 MAIN ST,
+  resident_city: SACRAMENTO,
+  resident_state: CA,
+  resident_postal_code: 95814,
+  resident_country: US,
+  portrait_capture_date: 2020-01-31T12:34:56Z,
+  age_in_years: 35,
+  age_birth_year: 1990,
+  age_over: [{"age":18,"isOver":true},{"age":21,"isOver":true}],
+  biometric_template_face: null,
+  biometric_template_voice: null,
+  biometric_template_finger: null,
+  biometric_template_iris: null,
+  biometric_template_retina: null
+)
+```
+

data/docs/SamsungWalletProviderOutput.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **mobile_drivers_license** | [**Iso180135MobileDriversLicenseCredential**](Iso180135MobileDriversLicenseCredential.md) | A standard 18013-5 Mobile Driver's License credential, retrieved from the individual's wallet. | [optional] |
 | **raw_mdl_output** | [**MdlOutput**](MdlOutput.md) | The raw output of the mDL exchange performed through Samsung Wallet. |  |
 
 ## Example
@@ -12,6 +13,7 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::SamsungWalletProviderOutput.new(
+  mobile_drivers_license: null,
   raw_mdl_output: null
 )
 ```

data/lib/trinsic_api/models/age_over_output.rb

@@ -0,0 +1,193 @@
+=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
+  # Processed result of an \"age over X\" claim present in a credential.
+  class AgeOverOutput < ApiModelBase
+    # The age threshold from the `age over X` claim.
+    attr_accessor :age
+
+    # Whether the individual is at least the given age.
+    attr_accessor :is_over
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'age' => :'age',
+        :'is_over' => :'isOver'
+      }
+    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
+      {
+        :'age' => :'Integer',
+        :'is_over' => :'Boolean'
+      }
+    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 `TrinsicApi::AgeOverOutput` 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::AgeOverOutput`. 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?(:'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
+
+    # 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 @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
+
+    # 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 @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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          age == o.age &&
+          is_over == o.is_over
+    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
+      [age, is_over].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

@@ -16,12 +16,16 @@ require 'time'
 module TrinsicApi
   # Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model.
   class AppleWalletProviderOutput < 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 mDL exchange performed through Apple Wallet.
     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
@@ -39,6 +43,7 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'mobile_drivers_license' => :'Iso180135MobileDriversLicenseCredential',
         :'raw_mdl_output' => :'MdlOutput'
       }
     end
@@ -46,6 +51,7 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'mobile_drivers_license',
       ])
     end
 
@@ -65,6 +71,10 @@ module TrinsicApi
         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']
       else
@@ -107,6 +117,7 @@ module TrinsicApi
     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
 
@@ -119,7 +130,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [raw_mdl_output].hash
+      [mobile_drivers_license, raw_mdl_output].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/eudi_age_verification_credential.rb

@@ -0,0 +1,174 @@
+=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 EUDI Age Verification credential, with document type `eu.europa.ec.eudi.av.1`.              This is the age verification credential type defined in the EUDI Wallet framework.
+  class EudiAgeVerificationCredential < ApiModelBase
+    # Processed age-over claims returned by the credential.
+    attr_accessor :age_over
+
+    # Date when the age verification data expires.
+    attr_accessor :expiry_date
+
+    # ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the credential.
+    attr_accessor :issuing_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'age_over' => :'ageOver',
+        :'expiry_date' => :'expiryDate',
+        :'issuing_country' => :'issuingCountry'
+      }
+    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
+      {
+        :'age_over' => :'Array<AgeOverOutput>',
+        :'expiry_date' => :'Date',
+        :'issuing_country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'age_over',
+        :'expiry_date',
+        :'issuing_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::EudiAgeVerificationCredential` 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::EudiAgeVerificationCredential`. 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?(:'age_over')
+        if (value = attributes[:'age_over']).is_a?(Array)
+          self.age_over = value
+        end
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_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 &&
+          age_over == o.age_over &&
+          expiry_date == o.expiry_date &&
+          issuing_country == o.issuing_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
+      [age_over, expiry_date, issuing_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