trinsic_api 3.0.1 → 3.1.0.pre.preview1

data/lib/trinsic_api/models/fayda_provider_output.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -15,14 +15,50 @@ require 'time'
 
 module TrinsicApi
   # Exposed properties for the `ethiopia-fayda` Provider which do not directly map to the normalized IdentityData model.
-  class FaydaProviderOutput
-    # A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered.              Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when the user was initially registered to do a comparison of the subs to verify that it is the same person.
+  class FaydaProviderOutput < ApiModelBase
+    # A unique eKYC identifying token used to match the original eKYC token received from the provider when the individual was initially registered.              Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique individual token received from Fayda when the individual was initially registered to do a comparison of the subs to verify that it is the same person.
     attr_accessor :sub
 
+    # The full name of the verified individual.              This may be an English or Arabic name if the individual only has it one language, otherwise this will be null and the other names will be populated.
+    attr_accessor :name
+
+    # The full English name of the verified individual.
+    attr_accessor :english_name
+
+    # The full Arabic name of the verified individual.
+    attr_accessor :arabic_name
+
+    # The date of birth of the verified individual.              This attribute is only available if registered directly.
+    attr_accessor :birthdate
+
+    # The sex of the verified individual.              Possible values: - Unknown - NotApplicable - Male - Female              This attribute is only available if registered directly.
+    attr_accessor :gender
+
+    # The nationality of the verified individual as an ISO 3166-1 alpha-2 country code.              This attribute is only available if registered directly.
+    attr_accessor :nationality
+
+    # The phone number of the verified individual.              This attribute is only available if registered directly.
+    attr_accessor :phone_number
+
+    # The email address of the verified individual.              This attribute is only available if registered directly.
+    attr_accessor :email
+
+    # The address of the verified individual.              This attribute is only available if registered directly.
+    attr_accessor :address
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'sub' => :'sub'
+        :'sub' => :'sub',
+        :'name' => :'name',
+        :'english_name' => :'englishName',
+        :'arabic_name' => :'arabicName',
+        :'birthdate' => :'birthdate',
+        :'gender' => :'gender',
+        :'nationality' => :'nationality',
+        :'phone_number' => :'phoneNumber',
+        :'email' => :'email',
+        :'address' => :'address'
       }
     end
 
@@ -39,14 +75,32 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'sub' => :'String'
+        :'sub' => :'String',
+        :'name' => :'String',
+        :'english_name' => :'String',
+        :'arabic_name' => :'String',
+        :'birthdate' => :'Date',
+        :'gender' => :'String',
+        :'nationality' => :'String',
+        :'phone_number' => :'String',
+        :'email' => :'String',
+        :'address' => :'FaydaProviderAddress'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'sub'
+        :'sub',
+        :'name',
+        :'english_name',
+        :'arabic_name',
+        :'birthdate',
+        :'gender',
+        :'nationality',
+        :'phone_number',
+        :'email',
+        :'address'
       ])
     end
 
@@ -69,6 +123,42 @@ module TrinsicApi
       if attributes.key?(:'sub')
         self.sub = attributes[:'sub']
       end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'english_name')
+        self.english_name = attributes[:'english_name']
+      end
+
+      if attributes.key?(:'arabic_name')
+        self.arabic_name = attributes[:'arabic_name']
+      end
+
+      if attributes.key?(:'birthdate')
+        self.birthdate = attributes[:'birthdate']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +181,16 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          sub == o.sub
+          sub == o.sub &&
+          name == o.name &&
+          english_name == o.english_name &&
+          arabic_name == o.arabic_name &&
+          birthdate == o.birthdate &&
+          gender == o.gender &&
+          nationality == o.nationality &&
+          phone_number == o.phone_number &&
+          email == o.email &&
+          address == o.address
     end
 
     # @see the `==` method
@@ -103,7 +202,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sub].hash
+      [sub, name, english_name, arabic_name, birthdate, gender, nationality, phone_number, email, address].hash
     end
 
     # Builds the object from hash
@@ -129,61 +228,6 @@ module TrinsicApi
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = TrinsicApi.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -200,24 +244,6 @@ module TrinsicApi
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end

data/lib/trinsic_api/models/finland_id_card_provider_output.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-Generator version: 7.13.0
+Generator version: 7.21.0
 
 =end
 
@@ -15,7 +15,7 @@ require 'time'
 
 module TrinsicApi
   # Exposed properties for the `a-fi-id-login` Provider which do not directly map to the normalized IdentityData model.
-  class FinlandIdCardProviderOutput
+  class FinlandIdCardProviderOutput < ApiModelBase
     # The first name of the verified individual
     attr_accessor :first_name
 
@@ -226,61 +226,6 @@ module TrinsicApi
       new(transformed_hash)
     end
 
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def self._deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = TrinsicApi.const_get(type)
-        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
@@ -297,24 +242,6 @@ module TrinsicApi
       hash
     end
 
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
   end
 
 end

data/lib/trinsic_api/models/finnish_trust_network_provider_output.rb

@@ -0,0 +1,260 @@
+=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 `finnish-trust-network` Provider which do not directly map to the normalized IdentityData model.
+  class FinnishTrustNetworkProviderOutput < ApiModelBase
+    # The full name of the individual.
+    attr_accessor :full_name
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # The 11-digit Finnish Personal Identification Code (Henkilötunnus) of the verified individual.              This is in the format DDMMYYCZZZQ, where: - DDMMYY is the date of birth - C is a symbol which determines the century of birth - ZZZ is an individual number, indicating gender - Q is a checksum character              If ZZZ is even, the individual is female. If ZZZ is odd, the individual is male.              If C is '+', the individual was born in the 19th century (1800-1899). If C is '-', 'U', 'V', 'W', 'X', or 'Y', the individual was born in the 20th century (1900-1999). If C is 'A', 'B', 'C', 'D', 'E', or 'F', the individual was born in the 21st century (2000-2099).
+    attr_accessor :personal_identification_code
+
+    # The 9-digit Finnish Unique Identification Number (FINUID, or sähköinen asiointitunnus SATU) of the verified individual. This number is typically used for online transactions and unlike the Finnish Personal Identification Code, does not reveal personal information such as birthdate.              The first 8 digits are randomly generated and the last character is a check control.
+    attr_accessor :unique_identification_number
+
+    # The given name of the individual.
+    attr_accessor :given_name
+
+    # The family name of the individual.
+    attr_accessor :family_name
+
+    # The level of assurance (LOA) for the verification.              The LOA refers to the degree of confidence in the claimed identity of a person. The European Digital Identity Framework (EUDI) measures the confidence of the digital identity's verification and authentication strength by a set of requirements for different levels. To learn more, see: https://ec.europa.eu/digital-building-blocks/sites/spaces/DIGITAL/pages/467110081/eIDAS+Levels+of+Assurance              Possible values: - Low: The individual has self asserted their identity and multifactor authentication is not required. - Substantial: The individual has performed either a remote or in-person identity verification and multifactor authentication is required. - High: The individual has performed an in-person identity proofing with an authorized representative and has strong cryptographic authentication requirements such as using a smart card.
+    attr_accessor :level_of_assurance
+
+    # The bank used to perform the identification for the verified individual.
+    attr_accessor :bank
+
+    # The phone number of the verified individual.              This is only returned if the individual authenticated with MobileID (Mobiilivarmenne).
+    attr_accessor :phone_number
+
+    # The organization name that the individual is associated with.              This is returned for requests that contain the organization scope.
+    attr_accessor :organization_name
+
+    # The VAT number of the organization that the individual is associated with.              This is returned for requests that contain the organization scope.
+    attr_accessor :vat_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'personal_identification_code' => :'personalIdentificationCode',
+        :'unique_identification_number' => :'uniqueIdentificationNumber',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'level_of_assurance' => :'levelOfAssurance',
+        :'bank' => :'bank',
+        :'phone_number' => :'phoneNumber',
+        :'organization_name' => :'organizationName',
+        :'vat_number' => :'vatNumber'
+      }
+    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
+      {
+        :'full_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'personal_identification_code' => :'String',
+        :'unique_identification_number' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'level_of_assurance' => :'String',
+        :'bank' => :'String',
+        :'phone_number' => :'String',
+        :'organization_name' => :'String',
+        :'vat_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'date_of_birth',
+        :'personal_identification_code',
+        :'unique_identification_number',
+        :'given_name',
+        :'family_name',
+        :'level_of_assurance',
+        :'bank',
+        :'phone_number',
+        :'organization_name',
+        :'vat_number'
+      ])
+    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::FinnishTrustNetworkProviderOutput` 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::FinnishTrustNetworkProviderOutput`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'personal_identification_code')
+        self.personal_identification_code = attributes[:'personal_identification_code']
+      end
+
+      if attributes.key?(:'unique_identification_number')
+        self.unique_identification_number = attributes[:'unique_identification_number']
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'level_of_assurance')
+        self.level_of_assurance = attributes[:'level_of_assurance']
+      end
+
+      if attributes.key?(:'bank')
+        self.bank = attributes[:'bank']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'organization_name')
+        self.organization_name = attributes[:'organization_name']
+      end
+
+      if attributes.key?(:'vat_number')
+        self.vat_number = attributes[:'vat_number']
+      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 &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          personal_identification_code == o.personal_identification_code &&
+          unique_identification_number == o.unique_identification_number &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          level_of_assurance == o.level_of_assurance &&
+          bank == o.bank &&
+          phone_number == o.phone_number &&
+          organization_name == o.organization_name &&
+          vat_number == o.vat_number
+    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
+      [full_name, date_of_birth, personal_identification_code, unique_identification_number, given_name, family_name, level_of_assurance, bank, phone_number, organization_name, vat_number].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