trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb

@@ -34,10 +34,10 @@ module TrinsicApi
     # Country of birth as an ISO 3166-1 alpha-2 code.
     attr_accessor :birth_country
 
-    # National Identification Number (NIN).              This is a unique, permanent identifier assigned by the National Identity Management Commission upon enrollment.              Format: 11 numeric digits (regex: /^[0-9]{11}$/). The digits are validated using the Verhoeff algorithm, meaning the last digit serves as a check digit.
+    # National Identification Number (NIN).              This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment.              Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm
     attr_accessor :national_identity_number
 
-    # Phone number registered with the National Identity Management Commission.
+    # Phone number registered with the National Identity Management Commission.              Format: - Valid Nigerian numbers are returned in international E.164 format   (for example, +2348031234567). - Otherwise, the value is returned in trunk notation (leading zero included)   as provided by the authority (for example, 0123456789).
     attr_accessor :phone_number
 
     # Email address registered with the National Identity Management Commission.
@@ -101,10 +101,13 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'first_name',
         :'middle_name',
+        :'surname',
         :'sex',
         :'date_of_birth',
         :'birth_country',
+        :'national_identity_number',
         :'phone_number',
         :'email',
         :'address',
@@ -131,8 +134,6 @@ module TrinsicApi
 
       if attributes.key?(:'first_name')
         self.first_name = attributes[:'first_name']
-      else
-        self.first_name = nil
       end
 
       if attributes.key?(:'middle_name')
@@ -141,8 +142,6 @@ module TrinsicApi
 
       if attributes.key?(:'surname')
         self.surname = attributes[:'surname']
-      else
-        self.surname = nil
       end
 
       if attributes.key?(:'sex')
@@ -159,8 +158,6 @@ module TrinsicApi
 
       if attributes.key?(:'national_identity_number')
         self.national_identity_number = attributes[:'national_identity_number']
-      else
-        self.national_identity_number = nil
       end
 
       if attributes.key?(:'phone_number')
@@ -189,18 +186,6 @@ module TrinsicApi
     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.')
-      end
-
-      if @surname.nil?
-        invalid_properties.push('invalid value for "surname", surname cannot be nil.')
-      end
-
-      if @national_identity_number.nil?
-        invalid_properties.push('invalid value for "national_identity_number", national_identity_number cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -208,42 +193,9 @@ module TrinsicApi
     # @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 @surname.nil?
-      return false if @national_identity_number.nil?
       true
     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'
-      end
-
-      @first_name = first_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] surname Value to be assigned
-    def surname=(surname)
-      if surname.nil?
-        fail ArgumentError, 'surname cannot be nil'
-      end
-
-      @surname = surname
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] national_identity_number Value to be assigned
-    def national_identity_number=(national_identity_number)
-      if national_identity_number.nil?
-        fail ArgumentError, 'national_identity_number cannot be nil'
-      end
-
-      @national_identity_number = national_identity_number
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/{nigeria_nin_biometric2_input.rb → nigeria_nin_lookup3_input.rb}

@@ -14,22 +14,14 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class NigeriaNinBiometric2Input < ApiModelBase
-    # The user's Nigerian National ID number (NIN)
+  class NigeriaNinLookup3Input < ApiModelBase
+    # National Identification Number (NIN).              This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment.              Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm
     attr_accessor :id_number
 
-    # An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size.
-    attr_accessor :liveness_images
-
-    # Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
-    attr_accessor :test_selfie
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_number' => :'idNumber',
-        :'liveness_images' => :'livenessImages',
-        :'test_selfie' => :'testSelfie'
+        :'id_number' => :'idNumber'
       }
     end
 
@@ -46,18 +38,14 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_number' => :'String',
-        :'liveness_images' => :'Array<String>',
-        :'test_selfie' => :'String'
+        :'id_number' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id_number',
-        :'liveness_images',
-        :'test_selfie'
+        :'id_number'
       ])
     end
 
@@ -65,14 +53,14 @@ module TrinsicApi
     # @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::NigeriaNinBiometric2Input` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::NigeriaNinLookup3Input` 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::NigeriaNinBiometric2Input`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::NigeriaNinLookup3Input`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -80,16 +68,6 @@ module TrinsicApi
       if attributes.key?(:'id_number')
         self.id_number = attributes[:'id_number']
       end
-
-      if attributes.key?(:'liveness_images')
-        if (value = attributes[:'liveness_images']).is_a?(Array)
-          self.liveness_images = value
-        end
-      end
-
-      if attributes.key?(:'test_selfie')
-        self.test_selfie = attributes[:'test_selfie']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -112,9 +90,7 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id_number == o.id_number &&
-          liveness_images == o.liveness_images &&
-          test_selfie == o.test_selfie
+          id_number == o.id_number
     end
 
     # @see the `==` method
@@ -126,7 +102,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_number, liveness_images, test_selfie].hash
+      [id_number].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/nigeria_nin_lookup3_provider_output.rb

@@ -0,0 +1,326 @@
+=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 `nigeria-nin-lookup-3` Provider which do not directly map to the normalized IdentityData model.
+  class NigeriaNinLookup3ProviderOutput < ApiModelBase
+    # National Identification Number (NIN).              This is a unique, permanent identifier assigned by the National Identity Management Commission (NIMC) upon enrollment.              Format: - 11 numeric digits - No publicly known encoding scheme is used to encode personal information in the NIN - Last digit is a checksum using the Verhoeff algorithm
+    attr_accessor :national_identity_number
+
+    # The given name of the individual.
+    attr_accessor :given_name
+
+    # The middle name of the individual.
+    attr_accessor :middle_name
+
+    # The family name of the individual.
+    attr_accessor :family_name
+
+    # The sex of the individual.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # Country of birth as an ISO 3166-1 alpha-2 code.
+    attr_accessor :birth_country
+
+    # State of birth as recorded by National Identity Management Commission (NIMC).
+    attr_accessor :birth_state
+
+    # Phone number registered with National Identity Management Commission (NIMC).              Format: - International E.164
+    attr_accessor :phone_number
+
+    # Street or residence line registered with National Identity Management Commission (NIMC).              This is the street-level address line only. Town, Local Government Area, and state are returned separately.
+    attr_accessor :street_address
+
+    # Town of residence registered with National Identity Management Commission (NIMC).
+    attr_accessor :residence_town
+
+    # Local Government Area of residence.              Nigeria is divided into 774 Local Government Areas (LGAs), which are the third-tier administrative divisions below states and the Federal Capital Territory. LGAs are roughly equivalent to counties or municipalities in other countries.
+    attr_accessor :local_government_area
+
+    # State of residence registered with National Identity Management Commission (NIMC).
+    attr_accessor :state
+
+    # First name of the individual's next of kin.
+    attr_accessor :next_of_kin_first_name
+
+    # Street or residence line of the individual's next of kin.
+    attr_accessor :next_of_kin_street_address
+
+    # Local Government Area of the individual's next of kin.
+    attr_accessor :next_of_kin_local_government_area
+
+    # Town of residence of the individual's next of kin.
+    attr_accessor :next_of_kin_town
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_identity_number' => :'nationalIdentityNumber',
+        :'given_name' => :'givenName',
+        :'middle_name' => :'middleName',
+        :'family_name' => :'familyName',
+        :'sex' => :'sex',
+        :'date_of_birth' => :'dateOfBirth',
+        :'birth_country' => :'birthCountry',
+        :'birth_state' => :'birthState',
+        :'phone_number' => :'phoneNumber',
+        :'street_address' => :'streetAddress',
+        :'residence_town' => :'residenceTown',
+        :'local_government_area' => :'localGovernmentArea',
+        :'state' => :'state',
+        :'next_of_kin_first_name' => :'nextOfKinFirstName',
+        :'next_of_kin_street_address' => :'nextOfKinStreetAddress',
+        :'next_of_kin_local_government_area' => :'nextOfKinLocalGovernmentArea',
+        :'next_of_kin_town' => :'nextOfKinTown'
+      }
+    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
+      {
+        :'national_identity_number' => :'String',
+        :'given_name' => :'String',
+        :'middle_name' => :'String',
+        :'family_name' => :'String',
+        :'sex' => :'String',
+        :'date_of_birth' => :'Date',
+        :'birth_country' => :'String',
+        :'birth_state' => :'String',
+        :'phone_number' => :'String',
+        :'street_address' => :'String',
+        :'residence_town' => :'String',
+        :'local_government_area' => :'String',
+        :'state' => :'String',
+        :'next_of_kin_first_name' => :'String',
+        :'next_of_kin_street_address' => :'String',
+        :'next_of_kin_local_government_area' => :'String',
+        :'next_of_kin_town' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'national_identity_number',
+        :'given_name',
+        :'middle_name',
+        :'family_name',
+        :'sex',
+        :'date_of_birth',
+        :'birth_country',
+        :'birth_state',
+        :'phone_number',
+        :'street_address',
+        :'residence_town',
+        :'local_government_area',
+        :'state',
+        :'next_of_kin_first_name',
+        :'next_of_kin_street_address',
+        :'next_of_kin_local_government_area',
+        :'next_of_kin_town'
+      ])
+    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::NigeriaNinLookup3ProviderOutput` 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::NigeriaNinLookup3ProviderOutput`. 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?(:'national_identity_number')
+        self.national_identity_number = attributes[:'national_identity_number']
+      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?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'birth_country')
+        self.birth_country = attributes[:'birth_country']
+      end
+
+      if attributes.key?(:'birth_state')
+        self.birth_state = attributes[:'birth_state']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'street_address')
+        self.street_address = attributes[:'street_address']
+      end
+
+      if attributes.key?(:'residence_town')
+        self.residence_town = attributes[:'residence_town']
+      end
+
+      if attributes.key?(:'local_government_area')
+        self.local_government_area = attributes[:'local_government_area']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'next_of_kin_first_name')
+        self.next_of_kin_first_name = attributes[:'next_of_kin_first_name']
+      end
+
+      if attributes.key?(:'next_of_kin_street_address')
+        self.next_of_kin_street_address = attributes[:'next_of_kin_street_address']
+      end
+
+      if attributes.key?(:'next_of_kin_local_government_area')
+        self.next_of_kin_local_government_area = attributes[:'next_of_kin_local_government_area']
+      end
+
+      if attributes.key?(:'next_of_kin_town')
+        self.next_of_kin_town = attributes[:'next_of_kin_town']
+      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 &&
+          national_identity_number == o.national_identity_number &&
+          given_name == o.given_name &&
+          middle_name == o.middle_name &&
+          family_name == o.family_name &&
+          sex == o.sex &&
+          date_of_birth == o.date_of_birth &&
+          birth_country == o.birth_country &&
+          birth_state == o.birth_state &&
+          phone_number == o.phone_number &&
+          street_address == o.street_address &&
+          residence_town == o.residence_town &&
+          local_government_area == o.local_government_area &&
+          state == o.state &&
+          next_of_kin_first_name == o.next_of_kin_first_name &&
+          next_of_kin_street_address == o.next_of_kin_street_address &&
+          next_of_kin_local_government_area == o.next_of_kin_local_government_area &&
+          next_of_kin_town == o.next_of_kin_town
+    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
+      [national_identity_number, given_name, middle_name, family_name, sex, date_of_birth, birth_country, birth_state, phone_number, street_address, residence_town, local_government_area, state, next_of_kin_first_name, next_of_kin_street_address, next_of_kin_local_government_area, next_of_kin_town].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