trinsic_api 1.2.0 → 2.0.0

data/lib/trinsic_api/models/nigeria_nin_input.rb

@@ -0,0 +1,383 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class NigeriaNinInput
+    # The user's first name as it appears in their National ID
+    attr_accessor :first_name
+
+    # The user's middle name as it appears in their National ID (optional)
+    attr_accessor :middle_name
+
+    # The user's last name as it appears in their National ID (optional)
+    attr_accessor :last_name
+
+    # The user's phone number (optional)
+    attr_accessor :phone_number
+
+    # The user's date of birth, in `YYYY-MM-DD` format
+    attr_accessor :date_of_birth
+
+    # The user's gender as it appears in their National ID (e.g., male, female)
+    attr_accessor :gender
+
+    # The user's South African National ID number
+    attr_accessor :national_id_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'firstName',
+        :'middle_name' => :'middleName',
+        :'last_name' => :'lastName',
+        :'phone_number' => :'phoneNumber',
+        :'date_of_birth' => :'dateOfBirth',
+        :'gender' => :'gender',
+        :'national_id_number' => :'nationalIdNumber'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'first_name' => :'String',
+        :'middle_name' => :'String',
+        :'last_name' => :'String',
+        :'phone_number' => :'String',
+        :'date_of_birth' => :'Date',
+        :'gender' => :'String',
+        :'national_id_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'middle_name',
+        :'phone_number',
+        :'gender',
+      ])
+    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::NigeriaNinInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::NigeriaNinInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.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?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      else
+        self.last_name = nil
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      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?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'national_id_number')
+        self.national_id_number = attributes[:'national_id_number']
+      else
+        self.national_id_number = 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 @first_name.nil?
+        invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+      end
+
+      if @first_name.to_s.length < 1
+        invalid_properties.push('invalid value for "first_name", the character length must be great than or equal to 1.')
+      end
+
+      if @last_name.nil?
+        invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+      end
+
+      if @last_name.to_s.length < 1
+        invalid_properties.push('invalid value for "last_name", the character length must be great than or equal to 1.')
+      end
+
+      if @date_of_birth.nil?
+        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
+      end
+
+      if @national_id_number.nil?
+        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
+      end
+
+      if @national_id_number.to_s.length > 11
+        invalid_properties.push('invalid value for "national_id_number", the character length must be smaller than or equal to 11.')
+      end
+
+      if @national_id_number.to_s.length < 11
+        invalid_properties.push('invalid value for "national_id_number", the character length must be great than or equal to 11.')
+      end
+
+      pattern = Regexp.new(/^\d*$/)
+      if @national_id_number !~ pattern
+        invalid_properties.push("invalid value for \"national_id_number\", must conform to the pattern #{pattern}.")
+      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 @first_name.to_s.length < 1
+      return false if @last_name.nil?
+      return false if @last_name.to_s.length < 1
+      return false if @date_of_birth.nil?
+      return false if @national_id_number.nil?
+      return false if @national_id_number.to_s.length > 11
+      return false if @national_id_number.to_s.length < 11
+      return false if @national_id_number !~ Regexp.new(/^\d*$/)
+      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
+
+      if first_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "first_name", the character length must be great than or equal to 1.'
+      end
+
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      if last_name.nil?
+        fail ArgumentError, 'last_name cannot be nil'
+      end
+
+      if last_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "last_name", the character length must be great than or equal to 1.'
+      end
+
+      @last_name = last_name
+    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
+
+      if national_id_number.to_s.length > 11
+        fail ArgumentError, 'invalid value for "national_id_number", the character length must be smaller than or equal to 11.'
+      end
+
+      if national_id_number.to_s.length < 11
+        fail ArgumentError, 'invalid value for "national_id_number", the character length must be great than or equal to 11.'
+      end
+
+      pattern = Regexp.new(/^\d*$/)
+      if national_id_number !~ pattern
+        fail ArgumentError, "invalid value for \"national_id_number\", must conform to the pattern #{pattern}."
+      end
+
+      @national_id_number = national_id_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 &&
+          middle_name == o.middle_name &&
+          last_name == o.last_name &&
+          phone_number == o.phone_number &&
+          date_of_birth == o.date_of_birth &&
+          gender == o.gender &&
+          national_id_number == o.national_id_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
+      [first_name, middle_name, last_name, phone_number, date_of_birth, gender, national_id_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
+
+    # 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/order_direction.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 

data/lib/trinsic_api/models/person_data.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -14,31 +14,49 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  # Identity information for the individual being verified
   class PersonData
-    # Given (first) name of the individual
     attr_accessor :given_name
 
-    # Family (last) name of the individual
     attr_accessor :family_name
 
-    # Middle name of the individual
     attr_accessor :middle_name
 
-    # The individual's full name as a single string.                Useful for names which do not fit into a \"first middle last\" structure.
     attr_accessor :full_name
 
+    attr_accessor :suffix
+
     attr_accessor :nationality
 
-    attr_accessor :gender
+    attr_accessor :sex
 
     attr_accessor :phone_number
 
-    # Address information for an individual
     attr_accessor :address
 
     attr_accessor :date_of_birth
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,8 +64,9 @@ module TrinsicApi
         :'family_name' => :'familyName',
         :'middle_name' => :'middleName',
         :'full_name' => :'fullName',
+        :'suffix' => :'suffix',
         :'nationality' => :'nationality',
-        :'gender' => :'gender',
+        :'sex' => :'sex',
         :'phone_number' => :'phoneNumber',
         :'address' => :'address',
         :'date_of_birth' => :'dateOfBirth'
@@ -66,17 +85,28 @@ module TrinsicApi
         :'family_name' => :'String',
         :'middle_name' => :'String',
         :'full_name' => :'String',
+        :'suffix' => :'String',
         :'nationality' => :'String',
-        :'gender' => :'String',
+        :'sex' => :'Sex',
         :'phone_number' => :'String',
         :'address' => :'Address',
-        :'date_of_birth' => :'String'
+        :'date_of_birth' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'given_name',
+        :'family_name',
+        :'middle_name',
+        :'full_name',
+        :'suffix',
+        :'nationality',
+        :'sex',
+        :'phone_number',
+        :'address',
+        :'date_of_birth'
       ])
     end
 
@@ -111,12 +141,16 @@ module TrinsicApi
         self.full_name = attributes[:'full_name']
       end
 
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
+      end
+
       if attributes.key?(:'nationality')
         self.nationality = attributes[:'nationality']
       end
 
-      if attributes.key?(:'gender')
-        self.gender = attributes[:'gender']
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
       end
 
       if attributes.key?(:'phone_number')
@@ -156,8 +190,9 @@ module TrinsicApi
           family_name == o.family_name &&
           middle_name == o.middle_name &&
           full_name == o.full_name &&
+          suffix == o.suffix &&
           nationality == o.nationality &&
-          gender == o.gender &&
+          sex == o.sex &&
           phone_number == o.phone_number &&
           address == o.address &&
           date_of_birth == o.date_of_birth
@@ -172,7 +207,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [given_name, family_name, middle_name, full_name, nationality, gender, phone_number, address, date_of_birth].hash
+      [given_name, family_name, middle_name, full_name, suffix, nationality, sex, phone_number, address, date_of_birth].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/{known_person_data.rb → philippine_match_input.rb}

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -14,33 +14,29 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class KnownPersonData
-    # Given (first) name of the individual
+  class PhilippineMatchInput
+    # The user's given / first name
     attr_accessor :given_name
 
-    # Family (last) name of the individual
-    attr_accessor :family_name
-
-    # Middle name of the individual
+    # The user's middle name
     attr_accessor :middle_name
 
-    # The phone number (with preceding + character and country code) of the individual being verified
-    attr_accessor :phone_number
+    # The user's family / last name
+    attr_accessor :family_name
 
-    # The address of the individual being verified
-    attr_accessor :address
+    # The user's name suffix
+    attr_accessor :suffix
 
-    # Date of birth of the individual, in the format \"YYYY-MM-DD\"
+    # The user's date of birth, in `YYYY-MM-DD` format
     attr_accessor :date_of_birth
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'given_name' => :'givenName',
-        :'family_name' => :'familyName',
         :'middle_name' => :'middleName',
-        :'phone_number' => :'phoneNumber',
-        :'address' => :'address',
+        :'family_name' => :'familyName',
+        :'suffix' => :'suffix',
         :'date_of_birth' => :'dateOfBirth'
       }
     end
@@ -54,17 +50,21 @@ module TrinsicApi
     def self.openapi_types
       {
         :'given_name' => :'String',
-        :'family_name' => :'String',
         :'middle_name' => :'String',
-        :'phone_number' => :'String',
-        :'address' => :'KnownAddress',
-        :'date_of_birth' => :'String'
+        :'family_name' => :'String',
+        :'suffix' => :'String',
+        :'date_of_birth' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'given_name',
+        :'middle_name',
+        :'family_name',
+        :'suffix',
+        :'date_of_birth'
       ])
     end
 
@@ -72,13 +72,13 @@ 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::KnownPersonData` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::PhilippineMatchInput` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::KnownPersonData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::PhilippineMatchInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -87,20 +87,16 @@ module TrinsicApi
         self.given_name = attributes[:'given_name']
       end
 
-      if attributes.key?(:'family_name')
-        self.family_name = attributes[:'family_name']
-      end
-
       if attributes.key?(:'middle_name')
         self.middle_name = attributes[:'middle_name']
       end
 
-      if attributes.key?(:'phone_number')
-        self.phone_number = attributes[:'phone_number']
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
       end
 
-      if attributes.key?(:'address')
-        self.address = attributes[:'address']
+      if attributes.key?(:'suffix')
+        self.suffix = attributes[:'suffix']
       end
 
       if attributes.key?(:'date_of_birth')
@@ -129,10 +125,9 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           given_name == o.given_name &&
-          family_name == o.family_name &&
           middle_name == o.middle_name &&
-          phone_number == o.phone_number &&
-          address == o.address &&
+          family_name == o.family_name &&
+          suffix == o.suffix &&
           date_of_birth == o.date_of_birth
     end
 
@@ -145,7 +140,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [given_name, family_name, middle_name, phone_number, address, date_of_birth].hash
+      [given_name, middle_name, family_name, suffix, date_of_birth].hash
     end
 
     # Builds the object from hash