trinsic_api 3.2.0 → 3.2.1

data/docs/IdemiaPreviewProviderAddress.md

@@ -1,32 +0,0 @@
-# TrinsicApi::IdemiaPreviewProviderAddress
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **formatted** | **String** | The formatted address. | [optional] |
-| **street_address** | **String** | The street address. | [optional] |
-| **locality** | **String** | The city or locality. | [optional] |
-| **region** | **String** | The state, province, region, or other subdivision. | [optional] |
-| **postal_code** | **String** | The postal code. | [optional] |
-| **country** | **String** | The country. | [optional] |
-| **room_number** | **String** | The room number. | [optional] |
-| **post_office_box** | **String** | The post office box. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::IdemiaPreviewProviderAddress.new(
-  formatted: 123 Main St, Albany, NY 12207, US,
-  street_address: 123 Main St,
-  locality: Albany,
-  region: NY,
-  postal_code: 12207,
-  country: US,
-  room_number: 12A,
-  post_office_box: PO Box 123
-)
-```
-

data/docs/IdemiaPreviewProviderOutput.md

@@ -1,76 +0,0 @@
-# TrinsicApi::IdemiaPreviewProviderOutput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **sub** | **String** | The OpenID Connect subject identifier for the verified individual. | [optional] |
-| **name** | **String** | The individual's full name. | [optional] |
-| **given_name** | **String** | The individual's given name. | [optional] |
-| **middle_name** | **String** | The individual's middle name. | [optional] |
-| **family_name** | **String** | The individual's family name. | [optional] |
-| **nickname** | **String** | The individual's nickname. | [optional] |
-| **preferred_username** | **String** | The individual's preferred username. | [optional] |
-| **profile** | **String** | The individual's profile URL. | [optional] |
-| **picture** | **String** | URL of the individual's profile picture. | [optional] |
-| **website** | **String** | The individual's website URL. | [optional] |
-| **birthdate** | **String** | The individual's date of birth in YYYY-MM-DD format. | [optional] |
-| **date_of_birth** | **Date** | The individual's date of birth as returned by legacy Idemia claim sets. | [optional] |
-| **gender** | **String** | The individual's gender. | [optional] |
-| **zoneinfo** | **String** | The individual's time zone. | [optional] |
-| **locale** | **String** | The individual's locale. | [optional] |
-| **preferred_language** | **String** | The individual's preferred language. | [optional] |
-| **updated_at** | **Integer** | Timestamp when the individual's profile data was last updated. | [optional] |
-| **email** | **String** | The individual's email address. | [optional] |
-| **email_verified** | **Boolean** | Whether the individual's email address has been verified. | [optional] |
-| **phone_number** | **String** | The individual's phone number. | [optional] |
-| **phone_number_verified** | **Boolean** | Whether the individual's phone number has been verified. | [optional] |
-| **mobile_phone_number** | **String** | The individual's mobile phone number returned by the mobile_phone scope. | [optional] |
-| **address** | [**IdemiaPreviewProviderAddress**](IdemiaPreviewProviderAddress.md) | The individual's address. | [optional] |
-| **pcr** | **String** | Idemia pairwise relying-party correlation reference. | [optional] |
-| **mid_uid** | **String** | Idemia Mobile ID unique identifier. | [optional] |
-| **user_name** | **String** | The user name returned by Idemia. | [optional] |
-| **inum** | **String** | Idemia client information identifier. | [optional] |
-| **role** | **String** | Permission role returned by Idemia. | [optional] |
-| **personal_identity_code** | **String** | Personal identity code returned by Idemia when available. | [optional] |
-| **person_identity_code_sample** | **String** | Sample personal identity code returned by Idemia when available. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::IdemiaPreviewProviderOutput.new(
-  sub: 248289761001,
-  name: Jane Doe,
-  given_name: Jane,
-  middle_name: Anne,
-  family_name: Doe,
-  nickname: Janey,
-  preferred_username: jane.doe,
-  profile: https://example.com/jane.doe,
-  picture: https://example.com/jane.doe/photo.png,
-  website: https://example.com,
-  birthdate: 1985-01-31,
-  date_of_birth: Thu Jan 31 00:00:00 UTC 1985,
-  gender: female,
-  zoneinfo: America/New_York,
-  locale: en-US,
-  preferred_language: en,
-  updated_at: 1717171717,
-  email: jane.doe@example.com,
-  email_verified: true,
-  phone_number: +15551234567,
-  phone_number_verified: true,
-  mobile_phone_number: +15551234567,
-  address: null,
-  pcr: rp_abc123,
-  mid_uid: mid_abc123,
-  user_name: jane.doe,
-  inum: inum123,
-  role: verified_user,
-  personal_identity_code: ABC123456,
-  person_identity_code_sample: ABC123456
-)
-```
-

data/docs/VerimiAddressOutput.md

@@ -1,28 +0,0 @@
-# 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

@@ -1,68 +0,0 @@
-# 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/lib/trinsic_api/models/idemia_preview_provider_output.rb

@@ -1,469 +0,0 @@
-=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 `idemia-preview` Provider which do not directly map to the normalized IdentityData model.
-  class IdemiaPreviewProviderOutput < ApiModelBase
-    # The OpenID Connect subject identifier for the verified individual.
-    attr_accessor :sub
-
-    # The individual's full name.
-    attr_accessor :name
-
-    # The individual's given name.
-    attr_accessor :given_name
-
-    # The individual's middle name.
-    attr_accessor :middle_name
-
-    # The individual's family name.
-    attr_accessor :family_name
-
-    # The individual's nickname.
-    attr_accessor :nickname
-
-    # The individual's preferred username.
-    attr_accessor :preferred_username
-
-    # The individual's profile URL.
-    attr_accessor :profile
-
-    # URL of the individual's profile picture.
-    attr_accessor :picture
-
-    # The individual's website URL.
-    attr_accessor :website
-
-    # The individual's date of birth in YYYY-MM-DD format.
-    attr_accessor :birthdate
-
-    # The individual's date of birth as returned by legacy Idemia claim sets.
-    attr_accessor :date_of_birth
-
-    # The individual's gender.
-    attr_accessor :gender
-
-    # The individual's time zone.
-    attr_accessor :zoneinfo
-
-    # The individual's locale.
-    attr_accessor :locale
-
-    # The individual's preferred language.
-    attr_accessor :preferred_language
-
-    # Timestamp when the individual's profile data was last updated.
-    attr_accessor :updated_at
-
-    # The individual's email address.
-    attr_accessor :email
-
-    # Whether the individual's email address has been verified.
-    attr_accessor :email_verified
-
-    # The individual's phone number.
-    attr_accessor :phone_number
-
-    # Whether the individual's phone number has been verified.
-    attr_accessor :phone_number_verified
-
-    # The individual's mobile phone number returned by the mobile_phone scope.
-    attr_accessor :mobile_phone_number
-
-    # The individual's address.
-    attr_accessor :address
-
-    # Idemia pairwise relying-party correlation reference.
-    attr_accessor :pcr
-
-    # Idemia Mobile ID unique identifier.
-    attr_accessor :mid_uid
-
-    # The user name returned by Idemia.
-    attr_accessor :user_name
-
-    # Idemia client information identifier.
-    attr_accessor :inum
-
-    # Permission role returned by Idemia.
-    attr_accessor :role
-
-    # Personal identity code returned by Idemia when available.
-    attr_accessor :personal_identity_code
-
-    # Sample personal identity code returned by Idemia when available.
-    attr_accessor :person_identity_code_sample
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'sub' => :'sub',
-        :'name' => :'name',
-        :'given_name' => :'givenName',
-        :'middle_name' => :'middleName',
-        :'family_name' => :'familyName',
-        :'nickname' => :'nickname',
-        :'preferred_username' => :'preferredUsername',
-        :'profile' => :'profile',
-        :'picture' => :'picture',
-        :'website' => :'website',
-        :'birthdate' => :'birthdate',
-        :'date_of_birth' => :'dateOfBirth',
-        :'gender' => :'gender',
-        :'zoneinfo' => :'zoneinfo',
-        :'locale' => :'locale',
-        :'preferred_language' => :'preferredLanguage',
-        :'updated_at' => :'updatedAt',
-        :'email' => :'email',
-        :'email_verified' => :'emailVerified',
-        :'phone_number' => :'phoneNumber',
-        :'phone_number_verified' => :'phoneNumberVerified',
-        :'mobile_phone_number' => :'mobilePhoneNumber',
-        :'address' => :'address',
-        :'pcr' => :'pcr',
-        :'mid_uid' => :'midUid',
-        :'user_name' => :'userName',
-        :'inum' => :'inum',
-        :'role' => :'role',
-        :'personal_identity_code' => :'personalIdentityCode',
-        :'person_identity_code_sample' => :'personIdentityCodeSample'
-      }
-    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
-      {
-        :'sub' => :'String',
-        :'name' => :'String',
-        :'given_name' => :'String',
-        :'middle_name' => :'String',
-        :'family_name' => :'String',
-        :'nickname' => :'String',
-        :'preferred_username' => :'String',
-        :'profile' => :'String',
-        :'picture' => :'String',
-        :'website' => :'String',
-        :'birthdate' => :'String',
-        :'date_of_birth' => :'Date',
-        :'gender' => :'String',
-        :'zoneinfo' => :'String',
-        :'locale' => :'String',
-        :'preferred_language' => :'String',
-        :'updated_at' => :'Integer',
-        :'email' => :'String',
-        :'email_verified' => :'Boolean',
-        :'phone_number' => :'String',
-        :'phone_number_verified' => :'Boolean',
-        :'mobile_phone_number' => :'String',
-        :'address' => :'IdemiaPreviewProviderAddress',
-        :'pcr' => :'String',
-        :'mid_uid' => :'String',
-        :'user_name' => :'String',
-        :'inum' => :'String',
-        :'role' => :'String',
-        :'personal_identity_code' => :'String',
-        :'person_identity_code_sample' => :'String'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'sub',
-        :'name',
-        :'given_name',
-        :'middle_name',
-        :'family_name',
-        :'nickname',
-        :'preferred_username',
-        :'profile',
-        :'picture',
-        :'website',
-        :'birthdate',
-        :'date_of_birth',
-        :'gender',
-        :'zoneinfo',
-        :'locale',
-        :'preferred_language',
-        :'updated_at',
-        :'email',
-        :'email_verified',
-        :'phone_number',
-        :'phone_number_verified',
-        :'mobile_phone_number',
-        :'address',
-        :'pcr',
-        :'mid_uid',
-        :'user_name',
-        :'inum',
-        :'role',
-        :'personal_identity_code',
-        :'person_identity_code_sample'
-      ])
-    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::IdemiaPreviewProviderOutput` 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::IdemiaPreviewProviderOutput`. 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?(:'sub')
-        self.sub = attributes[:'sub']
-      end
-
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.key?(:'given_name')
-        self.given_name = attributes[:'given_name']
-      end
-
-      if attributes.key?(:'middle_name')
-        self.middle_name = attributes[:'middle_name']
-      end
-
-      if attributes.key?(:'family_name')
-        self.family_name = attributes[:'family_name']
-      end
-
-      if attributes.key?(:'nickname')
-        self.nickname = attributes[:'nickname']
-      end
-
-      if attributes.key?(:'preferred_username')
-        self.preferred_username = attributes[:'preferred_username']
-      end
-
-      if attributes.key?(:'profile')
-        self.profile = attributes[:'profile']
-      end
-
-      if attributes.key?(:'picture')
-        self.picture = attributes[:'picture']
-      end
-
-      if attributes.key?(:'website')
-        self.website = attributes[:'website']
-      end
-
-      if attributes.key?(:'birthdate')
-        self.birthdate = attributes[:'birthdate']
-      end
-
-      if attributes.key?(:'date_of_birth')
-        self.date_of_birth = attributes[:'date_of_birth']
-      end
-
-      if attributes.key?(:'gender')
-        self.gender = attributes[:'gender']
-      end
-
-      if attributes.key?(:'zoneinfo')
-        self.zoneinfo = attributes[:'zoneinfo']
-      end
-
-      if attributes.key?(:'locale')
-        self.locale = attributes[:'locale']
-      end
-
-      if attributes.key?(:'preferred_language')
-        self.preferred_language = attributes[:'preferred_language']
-      end
-
-      if attributes.key?(:'updated_at')
-        self.updated_at = attributes[:'updated_at']
-      end
-
-      if attributes.key?(:'email')
-        self.email = attributes[:'email']
-      end
-
-      if attributes.key?(:'email_verified')
-        self.email_verified = attributes[:'email_verified']
-      end
-
-      if attributes.key?(:'phone_number')
-        self.phone_number = attributes[:'phone_number']
-      end
-
-      if attributes.key?(:'phone_number_verified')
-        self.phone_number_verified = attributes[:'phone_number_verified']
-      end
-
-      if attributes.key?(:'mobile_phone_number')
-        self.mobile_phone_number = attributes[:'mobile_phone_number']
-      end
-
-      if attributes.key?(:'address')
-        self.address = attributes[:'address']
-      end
-
-      if attributes.key?(:'pcr')
-        self.pcr = attributes[:'pcr']
-      end
-
-      if attributes.key?(:'mid_uid')
-        self.mid_uid = attributes[:'mid_uid']
-      end
-
-      if attributes.key?(:'user_name')
-        self.user_name = attributes[:'user_name']
-      end
-
-      if attributes.key?(:'inum')
-        self.inum = attributes[:'inum']
-      end
-
-      if attributes.key?(:'role')
-        self.role = attributes[:'role']
-      end
-
-      if attributes.key?(:'personal_identity_code')
-        self.personal_identity_code = attributes[:'personal_identity_code']
-      end
-
-      if attributes.key?(:'person_identity_code_sample')
-        self.person_identity_code_sample = attributes[:'person_identity_code_sample']
-      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 &&
-          sub == o.sub &&
-          name == o.name &&
-          given_name == o.given_name &&
-          middle_name == o.middle_name &&
-          family_name == o.family_name &&
-          nickname == o.nickname &&
-          preferred_username == o.preferred_username &&
-          profile == o.profile &&
-          picture == o.picture &&
-          website == o.website &&
-          birthdate == o.birthdate &&
-          date_of_birth == o.date_of_birth &&
-          gender == o.gender &&
-          zoneinfo == o.zoneinfo &&
-          locale == o.locale &&
-          preferred_language == o.preferred_language &&
-          updated_at == o.updated_at &&
-          email == o.email &&
-          email_verified == o.email_verified &&
-          phone_number == o.phone_number &&
-          phone_number_verified == o.phone_number_verified &&
-          mobile_phone_number == o.mobile_phone_number &&
-          address == o.address &&
-          pcr == o.pcr &&
-          mid_uid == o.mid_uid &&
-          user_name == o.user_name &&
-          inum == o.inum &&
-          role == o.role &&
-          personal_identity_code == o.personal_identity_code &&
-          person_identity_code_sample == o.person_identity_code_sample
-    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
-      [sub, name, given_name, middle_name, family_name, nickname, preferred_username, profile, picture, website, birthdate, date_of_birth, gender, zoneinfo, locale, preferred_language, updated_at, email, email_verified, phone_number, phone_number_verified, mobile_phone_number, address, pcr, mid_uid, user_name, inum, role, personal_identity_code, person_identity_code_sample].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