trinsic_api 3.0.0 → 3.0.2.pre.preview

data/lib/trinsic_api/models/kenya_nid_lookup2_address.rb

@@ -0,0 +1,269 @@
+=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.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Represents a Kenya address as stored in the IPRS (Integrated Population Registration System) database.              The structure reflects the pre-2010 provincial administration system: District > Division > Location. Since the 2010 constitutional change to counties, these legacy administrative divisions are still maintained in IPRS records for historical continuity.              The raw address from IPRS is a newline-separated string with labeled administrative components. Example format:              ``` P O BOX 41842 NAIROBI PARLIAMENT BUILDINGS LOCATION - CITY SQUARE DIVISION - CENTRAL DISTRICT - NAIROBI ```              The first lines contain informal address details (village, P.O. Box) while the suffixed lines contain official administrative designations prefixed with labels like \"LOCATION -\", \"DIVISION -\", \"DISTRICT -\".
+  class KenyaNidLookup2Address
+    # The district where the person resides.              This is the highest level of the pre-2010 administrative hierarchy stored in IPRS. Districts were the primary administrative units under Kenya's provincial system before the change to counties in 2010. Districts roughly correspond to sub-counties in the current administrative structure.
+    attr_accessor :district
+
+    # The division within the district.              This is the second level of the pre-2010 administrative hierarchy. Divisions were administrative units between districts and locations.
+    attr_accessor :division
+
+    # The location within the division.              This is the third level of the pre-2010 administrative hierarchy. Locations were the smallest administrative units.
+    attr_accessor :location
+
+    # Additional address lines that appear before the structured administrative parts.              May include P.O. Box (format: \"P O BOX [number] [location]\"), village names, estate names, or other informal locality information.
+    attr_accessor :additional_lines
+
+    # The raw, unparsed address string as returned from IPRS (Integrated Population Registration System).              This preserves the original newline-separated format containing both informal address components (village, P.O. Box) and labeled administrative divisions (LOCATION, DIVISION, DISTRICT).
+    attr_accessor :raw
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'district' => :'district',
+        :'division' => :'division',
+        :'location' => :'location',
+        :'additional_lines' => :'additionalLines',
+        :'raw' => :'raw'
+      }
+    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
+      {
+        :'district' => :'String',
+        :'division' => :'String',
+        :'location' => :'String',
+        :'additional_lines' => :'Array<String>',
+        :'raw' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'district',
+        :'division',
+        :'location',
+        :'additional_lines',
+        :'raw'
+      ])
+    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::KenyaNidLookup2Address` 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::KenyaNidLookup2Address`. 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?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.key?(:'division')
+        self.division = attributes[:'division']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'additional_lines')
+        if (value = attributes[:'additional_lines']).is_a?(Array)
+          self.additional_lines = value
+        end
+      end
+
+      if attributes.key?(:'raw')
+        self.raw = attributes[:'raw']
+      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 &&
+          district == o.district &&
+          division == o.division &&
+          location == o.location &&
+          additional_lines == o.additional_lines &&
+          raw == o.raw
+    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
+      [district, division, location, additional_lines, raw].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
+
+    # 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
+      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
+
+    # 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/kenya_nid_lookup2_provider_output.rb

@@ -0,0 +1,429 @@
+=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.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Exposed properties for the `kenya-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+  class KenyaNidLookup2ProviderOutput
+    # The first name (given name) of the ID holder as recorded in IPRS.
+    attr_accessor :first_name
+
+    # The surname (family name) of the ID holder as recorded in IPRS.
+    attr_accessor :surname
+
+    # The other name (middle name) of the ID holder as recorded in IPRS.
+    attr_accessor :other_name
+
+    # The sex of the ID holder as recorded on the National ID.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # The date of birth of the ID holder as recorded in IPRS.
+    attr_accessor :date_of_birth
+
+    # Citizenship status as recorded in the IPRS civil registry database.              For the Kenya National ID lookup, this value will always be \"Kenyan\" as the National ID is only issued to Kenyan citizens. Non-citizens residing in Kenya are issued different identification documents (Alien ID cards, refugee documentation, etc.) which are not supported by this provider.
+    attr_accessor :citizenship
+
+    # The Kenya National ID Number (Nambari ya Kitambulisho).              This is the primary unique identifier for Kenyan citizens in all government systems, issued by the National Registration Bureau (NRB). The format is 1 to 9 numeric digits (regex: /^[0-9]{1,9}$/). This number is assigned upon first registration at age 18 (or upon naturalization for new citizens) and remains constant for life.
+    attr_accessor :id_number
+
+    # 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
+
+    # The date the National ID was issued by the National Registration Bureau (NRB).
+    attr_accessor :date_of_issue
+
+    # Place of birth as recorded in Kenya's civil registry (IPRS).              This is structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location).
+    attr_accessor :place_of_birth
+
+    # Current residence address as registered in IPRS.              This represents the address on file at the time of ID registration or last update, structured according to Kenya's pre-2010 administrative hierarchy (District > Division > Location).
+    attr_accessor :place_of_residence
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'firstName',
+        :'surname' => :'surname',
+        :'other_name' => :'otherName',
+        :'sex' => :'sex',
+        :'date_of_birth' => :'dateOfBirth',
+        :'citizenship' => :'citizenship',
+        :'id_number' => :'idNumber',
+        :'serial_number' => :'serialNumber',
+        :'date_of_issue' => :'dateOfIssue',
+        :'place_of_birth' => :'placeOfBirth',
+        :'place_of_residence' => :'placeOfResidence'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'surname' => :'String',
+        :'other_name' => :'String',
+        :'sex' => :'String',
+        :'date_of_birth' => :'Date',
+        :'citizenship' => :'String',
+        :'id_number' => :'String',
+        :'serial_number' => :'String',
+        :'date_of_issue' => :'Date',
+        :'place_of_birth' => :'KenyaNidLookup2Address',
+        :'place_of_residence' => :'KenyaNidLookup2Address'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'other_name',
+        :'date_of_birth',
+        :'date_of_issue',
+        :'place_of_birth',
+        :'place_of_residence'
+      ])
+    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::KenyaNidLookup2ProviderOutput` 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::KenyaNidLookup2ProviderOutput`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'surname')
+        self.surname = attributes[:'surname']
+      else
+        self.surname = nil
+      end
+
+      if attributes.key?(:'other_name')
+        self.other_name = attributes[:'other_name']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      else
+        self.sex = nil
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'citizenship')
+        self.citizenship = attributes[:'citizenship']
+      else
+        self.citizenship = nil
+      end
+
+      if attributes.key?(:'id_number')
+        self.id_number = attributes[:'id_number']
+      else
+        self.id_number = nil
+      end
+
+      if attributes.key?(:'serial_number')
+        self.serial_number = attributes[:'serial_number']
+      else
+        self.serial_number = nil
+      end
+
+      if attributes.key?(:'date_of_issue')
+        self.date_of_issue = attributes[:'date_of_issue']
+      end
+
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
+      end
+
+      if attributes.key?(:'place_of_residence')
+        self.place_of_residence = attributes[:'place_of_residence']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @surname.nil?
+        invalid_properties.push('invalid value for "surname", surname cannot be nil.')
+      end
+
+      if @sex.nil?
+        invalid_properties.push('invalid value for "sex", sex cannot be nil.')
+      end
+
+      if @citizenship.nil?
+        invalid_properties.push('invalid value for "citizenship", citizenship cannot be nil.')
+      end
+
+      if @id_number.nil?
+        invalid_properties.push('invalid value for "id_number", id_number cannot be nil.')
+      end
+
+      if @serial_number.nil?
+        invalid_properties.push('invalid value for "serial_number", serial_number cannot be nil.')
+      end
+
+      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'
+      return false if @first_name.nil?
+      return false if @surname.nil?
+      return false if @sex.nil?
+      return false if @citizenship.nil?
+      return false if @id_number.nil?
+      return false if @serial_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] sex Value to be assigned
+    def sex=(sex)
+      if sex.nil?
+        fail ArgumentError, 'sex cannot be nil'
+      end
+
+      @sex = sex
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] citizenship Value to be assigned
+    def citizenship=(citizenship)
+      if citizenship.nil?
+        fail ArgumentError, 'citizenship cannot be nil'
+      end
+
+      @citizenship = citizenship
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id_number Value to be assigned
+    def id_number=(id_number)
+      if id_number.nil?
+        fail ArgumentError, 'id_number cannot be nil'
+      end
+
+      @id_number = id_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] serial_number Value to be assigned
+    def serial_number=(serial_number)
+      if serial_number.nil?
+        fail ArgumentError, 'serial_number cannot be nil'
+      end
+
+      @serial_number = serial_number
+    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 &&
+          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 &&
+          id_number == o.id_number &&
+          serial_number == o.serial_number &&
+          date_of_issue == o.date_of_issue &&
+          place_of_birth == o.place_of_birth &&
+          place_of_residence == o.place_of_residence
+    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
+      [first_name, surname, other_name, sex, date_of_birth, citizenship, id_number, serial_number, date_of_issue, place_of_birth, place_of_residence].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
+
+    # 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
+      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
+
+    # 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