trinsic_api 3.2.0 → 3.3.0.pre.alpha2

data/lib/trinsic_api/models/kenya_nid_lookup3_provider_output.rb

@@ -0,0 +1,227 @@
+=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 `kenya-nid-lookup-3` Provider which do not directly map to the normalized IdentityData model.
+  class KenyaNidLookup3ProviderOutput < ApiModelBase
+    # The Kenya National ID Number (Nambari ya Kitambulisho) or Unique Personal Identifier (Maisha Namba).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is either 8 digits for National ID or 9 digits for Maisha Namba UPI (the new format since 2023).
+    attr_accessor :id_number
+
+    # The first name of the individual.
+    attr_accessor :first_name
+
+    # The surname of the individual.
+    attr_accessor :surname
+
+    # Other name (middle name) of the individual.
+    attr_accessor :other_name
+
+    # The sex of the individual.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # The date of birth of the individual.              Format - YYYY-MM-DD
+    attr_accessor :date_of_birth
+
+    # Citizenship of the individual.              Format - ISO 3166-1 alpha-2 country code
+    attr_accessor :citizenship
+
+    # The physical card serial number printed on the Kenya National ID card.              This is distinct from the ID Number and serves as a card issuance tracking identifier maintained by IPRS. This value changes each time a new physical card is issued (loss, damage, renewal).
+    attr_accessor :serial_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id_number' => :'idNumber',
+        :'first_name' => :'firstName',
+        :'surname' => :'surname',
+        :'other_name' => :'otherName',
+        :'sex' => :'sex',
+        :'date_of_birth' => :'dateOfBirth',
+        :'citizenship' => :'citizenship',
+        :'serial_number' => :'serialNumber'
+      }
+    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
+      {
+        :'id_number' => :'String',
+        :'first_name' => :'String',
+        :'surname' => :'String',
+        :'other_name' => :'String',
+        :'sex' => :'String',
+        :'date_of_birth' => :'Date',
+        :'citizenship' => :'String',
+        :'serial_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id_number',
+        :'first_name',
+        :'surname',
+        :'other_name',
+        :'sex',
+        :'date_of_birth',
+        :'citizenship',
+        :'serial_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::KenyaNidLookup3ProviderOutput` 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::KenyaNidLookup3ProviderOutput`. 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?(:'id_number')
+        self.id_number = attributes[:'id_number']
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'surname')
+        self.surname = attributes[:'surname']
+      end
+
+      if attributes.key?(:'other_name')
+        self.other_name = attributes[:'other_name']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'citizenship')
+        self.citizenship = attributes[:'citizenship']
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_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 &&
+          id_number == o.id_number &&
+          first_name == o.first_name &&
+          surname == o.surname &&
+          other_name == o.other_name &&
+          sex == o.sex &&
+          date_of_birth == o.date_of_birth &&
+          citizenship == o.citizenship &&
+          serial_number == o.serial_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
+      [id_number, first_name, surname, other_name, sex, date_of_birth, citizenship, serial_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

data/lib/trinsic_api/models/kenya_nid_match2_date_of_birth_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/kenya_nid_match2_full_name_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/kenya_nid_match2_national_id_number_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/kenya_nid_match2_provider_output.rb

@@ -61,6 +61,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'national_id_number',
+        :'full_name',
         :'date_of_birth',
         :'sex'
       ])
@@ -84,14 +86,10 @@ module TrinsicApi
 
       if attributes.key?(:'national_id_number')
         self.national_id_number = attributes[:'national_id_number']
-      else
-        self.national_id_number = nil
       end
 
       if attributes.key?(:'full_name')
         self.full_name = attributes[:'full_name']
-      else
-        self.full_name = nil
       end
 
       if attributes.key?(:'date_of_birth')
@@ -108,14 +106,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @national_id_number.nil?
-        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
-      end
-
-      if @full_name.nil?
-        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -123,31 +113,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @national_id_number.nil?
-      return false if @full_name.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] national_id_number Value to be assigned
-    def national_id_number=(national_id_number)
-      if national_id_number.nil?
-        fail ArgumentError, 'national_id_number cannot be nil'
-      end
-
-      @national_id_number = national_id_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] full_name Value to be assigned
-    def full_name=(full_name)
-      if full_name.nil?
-        fail ArgumentError, 'full_name cannot be nil'
-      end
-
-      @full_name = full_name
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/kenya_nid_match2_sex_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/korea_telco_match_provider_output.rb

@@ -16,13 +16,13 @@ require 'time'
 module TrinsicApi
   # Exposed properties for the `korea-telco-match` Provider which do not directly map to the normalized IdentityData model.
   class KoreaTelcoMatchProviderOutput < ApiModelBase
-    # The verified phone number as submitted by the relying party.
+    # The phone number submitted for the carrier match.
     attr_accessor :phone_number
 
-    # The mobile carrier used for verification. Possible values: <list type=\"bullet\"><item><description>Lgu</description></item><item><description>Skt</description></item><item><description>Kt</description></item></list>
+    # The mobile carrier used for the match.              Supported values: Lgu, Skt, Kt.
     attr_accessor :tele_type
 
-    # The RaonSecure result code returned by the carrier verification system. \"0000\" indicates a successful match.              Common error codes: - \"0000\": Successful match - \"0001\": Identity Verification Failed - Verification Information Mismatch (General) - \"0002\": Identity Verification Failed - Unable to Verify Phone Number - \"0004\": Identity Verification Failed - Date of Birth Verification Error - \"0005\": Identity Verification Failed - Gender Verification Error - \"0006\": Identity Verification Failed - Name Verification Error - \"0009\": Identity Verification Failed - Device OS Mismatch
+    # The carrier match result code.              Common result codes: - \"0000\": Successful match - \"0001\": Failed - Verification Information Mismatch (General) - \"0002\": Failed - Unable to Verify Phone Number - \"0004\": Failed - Date of Birth Verification Error - \"0005\": Failed - Gender Verification Error - \"0006\": Failed - Name Verification Error - \"0009\": Failed - Device OS Mismatch
     attr_accessor :result_code
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -56,6 +56,9 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'phone_number',
+        :'tele_type',
+        :'result_code'
       ])
     end
 
@@ -77,20 +80,14 @@ module TrinsicApi
 
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
-      else
-        self.phone_number = nil
       end
 
       if attributes.key?(:'tele_type')
         self.tele_type = attributes[:'tele_type']
-      else
-        self.tele_type = nil
       end
 
       if attributes.key?(:'result_code')
         self.result_code = attributes[:'result_code']
-      else
-        self.result_code = nil
       end
     end
 
@@ -99,18 +96,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @phone_number.nil?
-        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
-      end
-
-      if @tele_type.nil?
-        invalid_properties.push('invalid value for "tele_type", tele_type cannot be nil.')
-      end
-
-      if @result_code.nil?
-        invalid_properties.push('invalid value for "result_code", result_code cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -118,42 +103,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @phone_number.nil?
-      return false if @tele_type.nil?
-      return false if @result_code.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] phone_number Value to be assigned
-    def phone_number=(phone_number)
-      if phone_number.nil?
-        fail ArgumentError, 'phone_number cannot be nil'
-      end
-
-      @phone_number = phone_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] tele_type Value to be assigned
-    def tele_type=(tele_type)
-      if tele_type.nil?
-        fail ArgumentError, 'tele_type cannot be nil'
-      end
-
-      @tele_type = tele_type
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] result_code Value to be assigned
-    def result_code=(result_code)
-      if result_code.nil?
-        fail ArgumentError, 'result_code cannot be nil'
-      end
-
-      @result_code = result_code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)