trinsic_api 3.1.0.pre.preview1 → 3.1.0

data/lib/trinsic_api/models/eudi_pid_credential.rb

@@ -0,0 +1,438 @@
+=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 Person Identification Data (PID) credential, with document type `eu.europa.ec.eudi.pid.1`.              This is the primary identity credential type defined in the EUDI Wallet framework.
+  class EudiPidCredential < ApiModelBase
+    # Current first name(s), including middle name(s) where applicable, of the individual to whom the PID relates.
+    attr_accessor :given_name
+
+    # First name(s), including middle name(s), of the individual at the time of birth.
+    attr_accessor :given_name_birth
+
+    # Current last name(s) or surname(s) of the individuals.
+    attr_accessor :family_name
+
+    # Last name(s) or surname(s) of the individual at the time of birth.
+    attr_accessor :family_name_birth
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # Country (ISO 3166-1 alpha-2), state, province, district, local area, municipality, city, town, or village where the individual was born.
+    attr_accessor :birth_place
+
+    # One or more ISO 3166-1 alpha-2 country codes representing the nationality of the individual.
+    attr_accessor :nationality
+
+    # Date when the PID expires.              Because PIDs are not necessarily backed by a physical document, this does not correspond to the expiration date of such.
+    attr_accessor :expiry_date
+
+    # Name of the administrative authority that issued the PID, or the ISO 3166 alpha-2 country code of the respective Member State if there is no separate authority entitled to issue PIDs.
+    attr_accessor :issuing_authority
+
+    # ISO 3166-1 alpha-2 country code of the country or territory of the issuer of the PID.
+    attr_accessor :issuing_country
+
+    # Date when the PID was issued and/or the administrative validity period began.
+    attr_accessor :issuance_date
+
+    # URL where a machine-readable trust anchor for verifying the PID can be found.
+    attr_accessor :trust_anchor
+
+    # Indicator that this credential has been issued specifically as PID.              When present, typically equal to \"PID\".
+    attr_accessor :attestation_legal_category
+
+    # A number assigned to the PID by the issuer.              This does not correspond to the document number of a physical document.
+    attr_accessor :document_number
+
+    # ISO 3166-2 country-subdivision code for the jurisdiction that issued the PID.
+    attr_accessor :issuing_jurisdiction
+
+    # Location of validity status information for the PID, where revocation information is published.
+    attr_accessor :location_status
+
+    # Sex of the individual.              This is a superset of the ISO/IEC 5218 sex code standard, defining additional \"other\", \"inter\", \"diverse\", and \"open\" values.              Possible values: - 0: Unknown - 1: Male - 2: Female - 3: Other - 4: Inter - 5: Diverse - 6: Open - 9: Not Applicable              For values 0, 1, 2, and 9, ISO/IEC 5218 applies.
+    attr_accessor :sex
+
+    # The individual's email address.
+    attr_accessor :email_address
+
+    # The mobile phone number of the individual, in international format.
+    attr_accessor :mobile_phone_number
+
+    # A value assigned to the individual that is unique among all personal administrative numbers issued by the provider.
+    attr_accessor :personal_administrative_number
+
+    # The full address of the individual's permanent residence.
+    attr_accessor :resident_address
+
+    # The street name of the individual's permanent residence.
+    attr_accessor :resident_street
+
+    # The house number of the individual's permanent residence.
+    attr_accessor :resident_house_number
+
+    # The municipality, city, town, or village of the individual's permanent residence.
+    attr_accessor :resident_city
+
+    # The state, province, district, or local area of the individual's permanent residence.
+    attr_accessor :resident_state
+
+    # The postal code of the individual's permanent residence.
+    attr_accessor :resident_postal_code
+
+    # The ISO 3166-1 alpha-2 country code of the individual's permanent residence.
+    attr_accessor :resident_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'given_name' => :'givenName',
+        :'given_name_birth' => :'givenNameBirth',
+        :'family_name' => :'familyName',
+        :'family_name_birth' => :'familyNameBirth',
+        :'date_of_birth' => :'dateOfBirth',
+        :'birth_place' => :'birthPlace',
+        :'nationality' => :'nationality',
+        :'expiry_date' => :'expiryDate',
+        :'issuing_authority' => :'issuingAuthority',
+        :'issuing_country' => :'issuingCountry',
+        :'issuance_date' => :'issuanceDate',
+        :'trust_anchor' => :'trustAnchor',
+        :'attestation_legal_category' => :'attestationLegalCategory',
+        :'document_number' => :'documentNumber',
+        :'issuing_jurisdiction' => :'issuingJurisdiction',
+        :'location_status' => :'locationStatus',
+        :'sex' => :'sex',
+        :'email_address' => :'emailAddress',
+        :'mobile_phone_number' => :'mobilePhoneNumber',
+        :'personal_administrative_number' => :'personalAdministrativeNumber',
+        :'resident_address' => :'residentAddress',
+        :'resident_street' => :'residentStreet',
+        :'resident_house_number' => :'residentHouseNumber',
+        :'resident_city' => :'residentCity',
+        :'resident_state' => :'residentState',
+        :'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' => :'String',
+        :'given_name_birth' => :'String',
+        :'family_name' => :'String',
+        :'family_name_birth' => :'String',
+        :'date_of_birth' => :'Date',
+        :'birth_place' => :'String',
+        :'nationality' => :'Array<String>',
+        :'expiry_date' => :'Date',
+        :'issuing_authority' => :'String',
+        :'issuing_country' => :'String',
+        :'issuance_date' => :'Date',
+        :'trust_anchor' => :'String',
+        :'attestation_legal_category' => :'String',
+        :'document_number' => :'String',
+        :'issuing_jurisdiction' => :'String',
+        :'location_status' => :'String',
+        :'sex' => :'Integer',
+        :'email_address' => :'String',
+        :'mobile_phone_number' => :'String',
+        :'personal_administrative_number' => :'String',
+        :'resident_address' => :'String',
+        :'resident_street' => :'String',
+        :'resident_house_number' => :'String',
+        :'resident_city' => :'String',
+        :'resident_state' => :'String',
+        :'resident_postal_code' => :'String',
+        :'resident_country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'given_name',
+        :'given_name_birth',
+        :'family_name',
+        :'family_name_birth',
+        :'date_of_birth',
+        :'birth_place',
+        :'nationality',
+        :'expiry_date',
+        :'issuing_authority',
+        :'issuing_country',
+        :'issuance_date',
+        :'trust_anchor',
+        :'attestation_legal_category',
+        :'document_number',
+        :'issuing_jurisdiction',
+        :'location_status',
+        :'sex',
+        :'email_address',
+        :'mobile_phone_number',
+        :'personal_administrative_number',
+        :'resident_address',
+        :'resident_street',
+        :'resident_house_number',
+        :'resident_city',
+        :'resident_state',
+        :'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::EudiPidCredential` 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::EudiPidCredential`. 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')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'given_name_birth')
+        self.given_name_birth = attributes[:'given_name_birth']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'family_name_birth')
+        self.family_name_birth = attributes[:'family_name_birth']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'birth_place')
+        self.birth_place = attributes[:'birth_place']
+      end
+
+      if attributes.key?(:'nationality')
+        if (value = attributes[:'nationality']).is_a?(Array)
+          self.nationality = value
+        end
+      end
+
+      if attributes.key?(:'expiry_date')
+        self.expiry_date = attributes[:'expiry_date']
+      end
+
+      if attributes.key?(:'issuing_authority')
+        self.issuing_authority = attributes[:'issuing_authority']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_country']
+      end
+
+      if attributes.key?(:'issuance_date')
+        self.issuance_date = attributes[:'issuance_date']
+      end
+
+      if attributes.key?(:'trust_anchor')
+        self.trust_anchor = attributes[:'trust_anchor']
+      end
+
+      if attributes.key?(:'attestation_legal_category')
+        self.attestation_legal_category = attributes[:'attestation_legal_category']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'issuing_jurisdiction')
+        self.issuing_jurisdiction = attributes[:'issuing_jurisdiction']
+      end
+
+      if attributes.key?(:'location_status')
+        self.location_status = attributes[:'location_status']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'mobile_phone_number')
+        self.mobile_phone_number = attributes[:'mobile_phone_number']
+      end
+
+      if attributes.key?(:'personal_administrative_number')
+        self.personal_administrative_number = attributes[:'personal_administrative_number']
+      end
+
+      if attributes.key?(:'resident_address')
+        self.resident_address = attributes[:'resident_address']
+      end
+
+      if attributes.key?(:'resident_street')
+        self.resident_street = attributes[:'resident_street']
+      end
+
+      if attributes.key?(:'resident_house_number')
+        self.resident_house_number = attributes[:'resident_house_number']
+      end
+
+      if attributes.key?(:'resident_city')
+        self.resident_city = attributes[:'resident_city']
+      end
+
+      if attributes.key?(:'resident_state')
+        self.resident_state = attributes[:'resident_state']
+      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 == o.given_name &&
+          given_name_birth == o.given_name_birth &&
+          family_name == o.family_name &&
+          family_name_birth == o.family_name_birth &&
+          date_of_birth == o.date_of_birth &&
+          birth_place == o.birth_place &&
+          nationality == o.nationality &&
+          expiry_date == o.expiry_date &&
+          issuing_authority == o.issuing_authority &&
+          issuing_country == o.issuing_country &&
+          issuance_date == o.issuance_date &&
+          trust_anchor == o.trust_anchor &&
+          attestation_legal_category == o.attestation_legal_category &&
+          document_number == o.document_number &&
+          issuing_jurisdiction == o.issuing_jurisdiction &&
+          location_status == o.location_status &&
+          sex == o.sex &&
+          email_address == o.email_address &&
+          mobile_phone_number == o.mobile_phone_number &&
+          personal_administrative_number == o.personal_administrative_number &&
+          resident_address == o.resident_address &&
+          resident_street == o.resident_street &&
+          resident_house_number == o.resident_house_number &&
+          resident_city == o.resident_city &&
+          resident_state == o.resident_state &&
+          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, given_name_birth, family_name, family_name_birth, date_of_birth, birth_place, nationality, expiry_date, issuing_authority, issuing_country, issuance_date, trust_anchor, attestation_legal_category, document_number, issuing_jurisdiction, location_status, sex, email_address, mobile_phone_number, personal_administrative_number, resident_address, resident_street, resident_house_number, resident_city, resident_state, 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/france_identite_provider_output.rb

@@ -16,12 +16,20 @@ require 'time'
 module TrinsicApi
   # Exposed properties for the `france-identite` Provider which do not directly map to the normalized IdentityData model.
   class FranceIdentiteProviderOutput < ApiModelBase
+    # An EUDI Person Identification Data (PID) credential, retrieved from the individual's wallet.
+    attr_accessor :pid
+
+    # An EUDI Age Verification credential, retrieved from the individual's wallet.
+    attr_accessor :age_verification
+
     # The raw output of the 18013-7 exchange performed through France Identité.
     attr_accessor :raw18013_output
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'pid' => :'pid',
+        :'age_verification' => :'ageVerification',
         :'raw18013_output' => :'raw18013Output'
       }
     end
@@ -39,6 +47,8 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'pid' => :'EudiPidCredential',
+        :'age_verification' => :'EudiAgeVerificationCredential',
         :'raw18013_output' => :'MdlOutput'
       }
     end
@@ -46,6 +56,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'pid',
+        :'age_verification',
       ])
     end
 
@@ -65,6 +77,14 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'pid')
+        self.pid = attributes[:'pid']
+      end
+
+      if attributes.key?(:'age_verification')
+        self.age_verification = attributes[:'age_verification']
+      end
+
       if attributes.key?(:'raw18013_output')
         self.raw18013_output = attributes[:'raw18013_output']
       else
@@ -107,6 +127,8 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          pid == o.pid &&
+          age_verification == o.age_verification &&
           raw18013_output == o.raw18013_output
     end
 
@@ -119,7 +141,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [raw18013_output].hash
+      [pid, age_verification, raw18013_output].hash
     end
 
     # Builds the object from hash