trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/itsme_provider_address.rb

@@ -0,0 +1,200 @@
+=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 ItsmeProviderAddress < ApiModelBase
+    # The street address.              itsme documents this as an address member when the address claim is returned.
+    attr_accessor :street_address
+
+    # The postal code of the address.              itsme documents this as an address member when the address claim is returned.
+    attr_accessor :postal_code
+
+    # The country of the address as an ISO 3166-1 alpha-2 code, when returned.              This field is not part of itsme's documented address claim members; it is present only when itsme returns `address.country`.
+    attr_accessor :country
+
+    # The locality or city of the address.              itsme documents this as an address member when the address claim is returned.
+    attr_accessor :locality
+
+    # The full address formatted by itsme.              itsme documents this as an address member when the address claim is returned.
+    attr_accessor :formatted
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'street_address' => :'streetAddress',
+        :'postal_code' => :'postalCode',
+        :'country' => :'country',
+        :'locality' => :'locality',
+        :'formatted' => :'formatted'
+      }
+    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
+      {
+        :'street_address' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'locality' => :'String',
+        :'formatted' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'street_address',
+        :'postal_code',
+        :'country',
+        :'locality',
+        :'formatted'
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ItsmeAddressBase'
+      ]
+    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::ItsmeProviderAddress` 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::ItsmeProviderAddress`. 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?(:'street_address')
+        self.street_address = attributes[:'street_address']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'locality')
+        self.locality = attributes[:'locality']
+      end
+
+      if attributes.key?(:'formatted')
+        self.formatted = attributes[:'formatted']
+      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 &&
+          street_address == o.street_address &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          locality == o.locality &&
+          formatted == o.formatted
+    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
+      [street_address, postal_code, country, locality, formatted].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/itsme_provider_output.rb

@@ -14,31 +14,91 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  # Exposed properties for the `a-itsme-login` Provider which do not directly map to the normalized IdentityData model.
+  # Exposed properties for the `itsme` Provider which do not directly map to the normalized IdentityData model.
   class ItsmeProviderOutput < ApiModelBase
-    # The first name of the verified individual
-    attr_accessor :first_name
+    # The date of birth of the verified individual.              Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort.
+    attr_accessor :date_of_birth
 
-    # The last name of the verified individual
-    attr_accessor :last_name
+    # The email address of the verified individual.              Availability by ID document issuing country: best effort for all supported issuing countries.
+    attr_accessor :email
 
-    # The date of birth of the verified individual
-    attr_accessor :date_of_birth
+    # The phone number of the verified individual, with a leading + country calling code.              Availability by ID document issuing country: always returned for all supported issuing countries.
+    attr_accessor :phone_number
+
+    # The stable OpenID Connect (OIDC) subject (sub) identifier.              This should be a stable identifier, however, if a user deletes and recreates an account, this identifier will change.
+    attr_accessor :sub
+
+    # The full name of the verified individual.              Availability by ID document issuing country: always returned for all supported issuing countries.
+    attr_accessor :full_name
+
+    # The given name of the verified individual.              Availability by ID document issuing country: best effort for all supported issuing countries.
+    attr_accessor :given_name
+
+    # The family name of the verified individual.              Availability by ID document issuing country: always returned for all supported issuing countries.
+    attr_accessor :family_name
+
+    # The date of birth of the verified individual in itsme's document-facing string format.              Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries.
+    attr_accessor :date_of_birth_as_string
+
+    # The gender claim for the verified individual.              Availability by ID document issuing country: always returned for supported issuing countries except Netherlands, where it is best effort.              Known values: - Female - Male - Unknown
+    attr_accessor :gender
+
+    # The itsme app language as an uppercase language code.              Availability by ID document issuing country: best effort for all supported issuing countries.              Known values: - NL - FR - DE - EN
+    attr_accessor :locale
+
+    # The URL of the profile picture resource.              Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort.
+    attr_accessor :picture_url
+
+    # Whether itsme reports the email address as verified.              Availability by ID document issuing country: returned only if `email` is available.              Note: itsme currently documents that this value is usually false because email verification is not implemented in its systems.
+    attr_accessor :email_verified
+
+    # Whether itsme reports the phone number as verified.              Availability by ID document issuing country: always returned for all supported issuing countries.
+    attr_accessor :phone_number_verified
+
+    # The address of the verified individual.              Availability by ID document issuing country: always returned for Belgian-issued ID documents, best effort for Netherlands-issued ID documents, and not returned for other supported issuing countries.
+    attr_accessor :address
+
+    # The citizenship of the verified individual as an ISO 3166-1 alpha-2 country code.              Availability by ID document issuing country: always returned for supported issuing countries except Belgium, where it is best effort.
+    attr_accessor :citizenship
+
+    # The Belgian National Register Number and related metadata.              Availability by ID document issuing country: returned only for Belgian-issued ID documents.
+    attr_accessor :belgian_national_number
+
+    # The Belgian eID card document number and related metadata.              Availability by ID document issuing country: returned only for Belgian-issued ID documents.
+    attr_accessor :belgian_identity_card
+
+    # The identity document and related metadata.              Availability by ID document issuing country: always returned for all supported issuing countries.
+    attr_accessor :identity_document
 
-    # The hashed version of the Belgian National Register Number of the verified individual.              By default, itsme does not return the raw National Register Number of the individual; instead, only a hashed version is returned.              Your account must be approved by itsme to receive the raw, unhashed National Register Number.
-    attr_accessor :hashed_national_register_number
+    # The place of birth.              Availability by ID document issuing country: best effort for Belgian-issued ID documents; not returned for other supported issuing countries.
+    attr_accessor :place_of_birth
 
-    # The raw (not hashed) Belgian National Register Number (\"Rijksregisternummer\") of the verified individual.              Only returned if your account has been explicitly authorized to receive it by itsme; by law, this data is considered sensitive personal data.              This is an 11-digit number in the format YYMMDDXXXCC, where: - YYMMDD represents the individual's date of birth (year, month, day). - XXX is a sequential birth number, odd for females and even for males. - CC is a checksum, calculated with the equation: 97 - (YYMMDDXXX mod 97)              For births in the year 2000 or later, the digit '2' is prepended to the first 9 digits during checksum calculation.
-    attr_accessor :national_register_number
+    # The device metadata for the verification.              Availability by ID document issuing country: best effort for all supported issuing countries.
+    attr_accessor :device
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'first_name' => :'firstName',
-        :'last_name' => :'lastName',
         :'date_of_birth' => :'dateOfBirth',
-        :'hashed_national_register_number' => :'hashedNationalRegisterNumber',
-        :'national_register_number' => :'nationalRegisterNumber'
+        :'email' => :'email',
+        :'phone_number' => :'phoneNumber',
+        :'sub' => :'sub',
+        :'full_name' => :'fullName',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'date_of_birth_as_string' => :'dateOfBirthAsString',
+        :'gender' => :'gender',
+        :'locale' => :'locale',
+        :'picture_url' => :'pictureUrl',
+        :'email_verified' => :'emailVerified',
+        :'phone_number_verified' => :'phoneNumberVerified',
+        :'address' => :'address',
+        :'citizenship' => :'citizenship',
+        :'belgian_national_number' => :'belgianNationalNumber',
+        :'belgian_identity_card' => :'belgianIdentityCard',
+        :'identity_document' => :'identityDocument',
+        :'place_of_birth' => :'placeOfBirth',
+        :'device' => :'device'
       }
     end
 
@@ -55,19 +115,52 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'first_name' => :'String',
-        :'last_name' => :'String',
         :'date_of_birth' => :'Date',
-        :'hashed_national_register_number' => :'String',
-        :'national_register_number' => :'String'
+        :'email' => :'String',
+        :'phone_number' => :'String',
+        :'sub' => :'String',
+        :'full_name' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'date_of_birth_as_string' => :'String',
+        :'gender' => :'String',
+        :'locale' => :'String',
+        :'picture_url' => :'String',
+        :'email_verified' => :'Boolean',
+        :'phone_number_verified' => :'Boolean',
+        :'address' => :'ItsmeProviderAddress',
+        :'citizenship' => :'String',
+        :'belgian_national_number' => :'ItsmeBelgianNationalNumber',
+        :'belgian_identity_card' => :'ItsmeBelgianIdentityCard',
+        :'identity_document' => :'ItsmeIdentityDocument',
+        :'place_of_birth' => :'ItsmePlaceOfBirth',
+        :'device' => :'ItsmeDirectDevice'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'hashed_national_register_number',
-        :'national_register_number'
+        :'date_of_birth',
+        :'email',
+        :'phone_number',
+        :'sub',
+        :'full_name',
+        :'given_name',
+        :'family_name',
+        :'date_of_birth_as_string',
+        :'gender',
+        :'locale',
+        :'picture_url',
+        :'email_verified',
+        :'phone_number_verified',
+        :'address',
+        :'citizenship',
+        :'belgian_national_number',
+        :'belgian_identity_card',
+        :'identity_document',
+        :'place_of_birth',
+        :'device'
       ])
     end
 
@@ -87,91 +180,100 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'first_name')
-        self.first_name = attributes[:'first_name']
-      else
-        self.first_name = nil
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
       end
 
-      if attributes.key?(:'last_name')
-        self.last_name = attributes[:'last_name']
-      else
-        self.last_name = nil
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
       end
 
-      if attributes.key?(:'date_of_birth')
-        self.date_of_birth = attributes[:'date_of_birth']
-      else
-        self.date_of_birth = nil
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
       end
 
-      if attributes.key?(:'hashed_national_register_number')
-        self.hashed_national_register_number = attributes[:'hashed_national_register_number']
+      if attributes.key?(:'sub')
+        self.sub = attributes[:'sub']
       end
 
-      if attributes.key?(:'national_register_number')
-        self.national_register_number = attributes[:'national_register_number']
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
       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 @first_name.nil?
-        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
       end
 
-      if @last_name.nil?
-        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
       end
 
-      if @date_of_birth.nil?
-        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      if attributes.key?(:'date_of_birth_as_string')
+        self.date_of_birth_as_string = attributes[:'date_of_birth_as_string']
       end
 
-      invalid_properties
-    end
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      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 @first_name.nil?
-      return false if @last_name.nil?
-      return false if @date_of_birth.nil?
-      true
-    end
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
 
-    # Custom attribute writer method with validation
-    # @param [Object] first_name Value to be assigned
-    def first_name=(first_name)
-      if first_name.nil?
-        fail ArgumentError, 'first_name cannot be nil'
+      if attributes.key?(:'picture_url')
+        self.picture_url = attributes[:'picture_url']
       end
 
-      @first_name = first_name
-    end
+      if attributes.key?(:'email_verified')
+        self.email_verified = attributes[:'email_verified']
+      end
 
-    # Custom attribute writer method with validation
-    # @param [Object] last_name Value to be assigned
-    def last_name=(last_name)
-      if last_name.nil?
-        fail ArgumentError, 'last_name cannot be nil'
+      if attributes.key?(:'phone_number_verified')
+        self.phone_number_verified = attributes[:'phone_number_verified']
       end
 
-      @last_name = last_name
-    end
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'citizenship')
+        self.citizenship = attributes[:'citizenship']
+      end
+
+      if attributes.key?(:'belgian_national_number')
+        self.belgian_national_number = attributes[:'belgian_national_number']
+      end
+
+      if attributes.key?(:'belgian_identity_card')
+        self.belgian_identity_card = attributes[:'belgian_identity_card']
+      end
+
+      if attributes.key?(:'identity_document')
+        self.identity_document = attributes[:'identity_document']
+      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'
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
       end
 
-      @date_of_birth = date_of_birth
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      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.
@@ -179,11 +281,26 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          first_name == o.first_name &&
-          last_name == o.last_name &&
           date_of_birth == o.date_of_birth &&
-          hashed_national_register_number == o.hashed_national_register_number &&
-          national_register_number == o.national_register_number
+          email == o.email &&
+          phone_number == o.phone_number &&
+          sub == o.sub &&
+          full_name == o.full_name &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          date_of_birth_as_string == o.date_of_birth_as_string &&
+          gender == o.gender &&
+          locale == o.locale &&
+          picture_url == o.picture_url &&
+          email_verified == o.email_verified &&
+          phone_number_verified == o.phone_number_verified &&
+          address == o.address &&
+          citizenship == o.citizenship &&
+          belgian_national_number == o.belgian_national_number &&
+          belgian_identity_card == o.belgian_identity_card &&
+          identity_document == o.identity_document &&
+          place_of_birth == o.place_of_birth &&
+          device == o.device
     end
 
     # @see the `==` method
@@ -195,7 +312,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [first_name, last_name, date_of_birth, hashed_national_register_number, national_register_number].hash
+      [date_of_birth, email, phone_number, sub, full_name, given_name, family_name, date_of_birth_as_string, gender, locale, picture_url, email_verified, phone_number_verified, address, citizenship, belgian_national_number, belgian_identity_card, identity_document, place_of_birth, device].hash
     end
 
     # Builds the object from hash