trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/south_africa_nid_lookup2_provider_output.rb

@@ -0,0 +1,377 @@
+=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 `south-africa-nid-lookup-2` Provider which do not directly map to the normalized IdentityData model.
+  class SouthAfricaNidLookup2ProviderOutput < ApiModelBase
+    # The South African National Identity Number (13 digits).              Issued for life by the Department of Home Affairs (DHA) and stored in the HANIS (Home Affairs National Identification System) database. The same number is mandatory for banking, employment, taxation, and voting, and is printed on both the legacy green ID book and the Smart ID Card (rolled out from 2013 onward).              Format: - YYMMDD G(4) C A Z - YYMMDD is the date of birth - G(4) is the gender code (below 5000 female, 5000 or above male) - C is the citizenship indicator (0 citizen, 1 permanent resident) - A is reserved (it had a politically sensitive meaning in the past, but is currently   semantically meaningless) - Z is a Luhn check digit
+    attr_accessor :national_id_number
+
+    # Citizenship status of the individual.              Possible values: - Citizen - PermanentResident
+    attr_accessor :citizenship_status
+
+    # First name of the individual.
+    attr_accessor :first_name
+
+    # Family name of the individual.
+    attr_accessor :family_name
+
+    # Full name of the individual.
+    attr_accessor :full_name
+
+    # Sex of the individual.              Possible values: - Male - Female
+    attr_accessor :sex
+
+    # Date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # Nationality of the individual as an ISO 3166-1 alpha-2 country code.
+    attr_accessor :nationality
+
+    # Date of death of the individual, if recorded by DHA (Department of Home Affairs).              Null if the individual is alive, or the data is missing from the registry.
+    attr_accessor :date_of_death
+
+    # Country of birth of the individual as an ISO 3166-1 alpha-2 country code.
+    attr_accessor :birth_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_id_number' => :'nationalIdNumber',
+        :'citizenship_status' => :'citizenshipStatus',
+        :'first_name' => :'firstName',
+        :'family_name' => :'familyName',
+        :'full_name' => :'fullName',
+        :'sex' => :'sex',
+        :'date_of_birth' => :'dateOfBirth',
+        :'nationality' => :'nationality',
+        :'date_of_death' => :'dateOfDeath',
+        :'birth_country' => :'birthCountry'
+      }
+    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_id_number' => :'String',
+        :'citizenship_status' => :'String',
+        :'first_name' => :'String',
+        :'family_name' => :'String',
+        :'full_name' => :'String',
+        :'sex' => :'String',
+        :'date_of_birth' => :'Date',
+        :'nationality' => :'String',
+        :'date_of_death' => :'Date',
+        :'birth_country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'date_of_death',
+        :'birth_country'
+      ])
+    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::SouthAfricaNidLookup2ProviderOutput` 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::SouthAfricaNidLookup2ProviderOutput`. 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_id_number')
+        self.national_id_number = attributes[:'national_id_number']
+      else
+        self.national_id_number = nil
+      end
+
+      if attributes.key?(:'citizenship_status')
+        self.citizenship_status = attributes[:'citizenship_status']
+      else
+        self.citizenship_status = nil
+      end
+
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      else
+        self.first_name = nil
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      else
+        self.family_name = nil
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      else
+        self.full_name = nil
+      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']
+      else
+        self.date_of_birth = nil
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      else
+        self.nationality = nil
+      end
+
+      if attributes.key?(:'date_of_death')
+        self.date_of_death = attributes[:'date_of_death']
+      end
+
+      if attributes.key?(:'birth_country')
+        self.birth_country = attributes[:'birth_country']
+      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 @national_id_number.nil?
+        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
+      end
+
+      if @citizenship_status.nil?
+        invalid_properties.push('invalid value for "citizenship_status", citizenship_status cannot be nil.')
+      end
+
+      if @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @family_name.nil?
+        invalid_properties.push('invalid value for "family_name", family_name cannot be nil.')
+      end
+
+      if @full_name.nil?
+        invalid_properties.push('invalid value for "full_name", full_name cannot be nil.')
+      end
+
+      if @sex.nil?
+        invalid_properties.push('invalid value for "sex", sex cannot be nil.')
+      end
+
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      end
+
+      if @nationality.nil?
+        invalid_properties.push('invalid value for "nationality", nationality 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 @national_id_number.nil?
+      return false if @citizenship_status.nil?
+      return false if @first_name.nil?
+      return false if @family_name.nil?
+      return false if @full_name.nil?
+      return false if @sex.nil?
+      return false if @date_of_birth.nil?
+      return false if @nationality.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] citizenship_status Value to be assigned
+    def citizenship_status=(citizenship_status)
+      if citizenship_status.nil?
+        fail ArgumentError, 'citizenship_status cannot be nil'
+      end
+
+      @citizenship_status = citizenship_status
+    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] family_name Value to be assigned
+    def family_name=(family_name)
+      if family_name.nil?
+        fail ArgumentError, 'family_name cannot be nil'
+      end
+
+      @family_name = family_name
+    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
+
+    # 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] date_of_birth Value to be assigned
+    def date_of_birth=(date_of_birth)
+      if date_of_birth.nil?
+        fail ArgumentError, 'date_of_birth cannot be nil'
+      end
+
+      @date_of_birth = date_of_birth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] nationality Value to be assigned
+    def nationality=(nationality)
+      if nationality.nil?
+        fail ArgumentError, 'nationality cannot be nil'
+      end
+
+      @nationality = nationality
+    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_id_number == o.national_id_number &&
+          citizenship_status == o.citizenship_status &&
+          first_name == o.first_name &&
+          family_name == o.family_name &&
+          full_name == o.full_name &&
+          sex == o.sex &&
+          date_of_birth == o.date_of_birth &&
+          nationality == o.nationality &&
+          date_of_death == o.date_of_death &&
+          birth_country == o.birth_country
+    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_id_number, citizenship_status, first_name, family_name, full_name, sex, date_of_birth, nationality, date_of_death, birth_country].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/south_africa_nid_match2_date_of_birth_field.rb

@@ -0,0 +1,192 @@
+=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
+  class SouthAfricaNidMatch2DateOfBirthField < ApiModelBase
+    # The date of birth submitted for this check.
+    attr_accessor :input_value
+
+    # The outcome of comparing the submitted date of birth to the issuer record.              Possible values: - Exact Match - Partial Match - Transposed - No Match - Not Returned
+    attr_accessor :outcome
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input_value' => :'inputValue',
+        :'outcome' => :'outcome'
+      }
+    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
+      {
+        :'input_value' => :'Date',
+        :'outcome' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::SouthAfricaNidMatch2DateOfBirthField` 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::SouthAfricaNidMatch2DateOfBirthField`. 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?(:'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
+
+    # 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 @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
+
+    # 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 @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)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          input_value == o.input_value &&
+          outcome == o.outcome
+    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
+      [input_value, outcome].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