trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/{recommend_response.rb → nigeria_nin_match2_input.rb}

@@ -14,22 +14,60 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class RecommendResponse
-    # The providers which the user is known to have a credential with.
-    attr_accessor :recognized
+  class NigeriaNinMatch2Input
+    # The user's Nigerian National ID number (NIN)
+    attr_accessor :id_number
 
-    # The providers which the user is deemed sufficiently likely to have a credential with.
-    attr_accessor :relevant
+    # The user's first name as it appears in their National ID
+    attr_accessor :given_name
 
-    # The providers which the user is unlikely to have a credential with.              This includes all providers available to your app which were not included in the Recognized or Relevant lists.
-    attr_accessor :remainder
+    # The user's last name as it appears in their National ID
+    attr_accessor :family_name
+
+    # The user's middle name as it appears in their National ID (optional)
+    attr_accessor :middle_name
+
+    # The user's date of birth, in `YYYY-MM-DD` format
+    attr_accessor :date_of_birth
+
+    # The user's sex as it appears in their National ID
+    attr_accessor :sex
+
+    # The user's phone number as it appears in their National ID (optional). Must be in E.164 international format: \"+234XXXXXXXXX\"
+    attr_accessor :phone_number
+
+    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
       {
-        :'recognized' => :'recognized',
-        :'relevant' => :'relevant',
-        :'remainder' => :'remainder'
+        :'id_number' => :'idNumber',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'middle_name' => :'middleName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'sex' => :'sex',
+        :'phone_number' => :'phoneNumber'
       }
     end
 
@@ -46,15 +84,26 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'recognized' => :'Array<ProviderInformation>',
-        :'relevant' => :'Array<ProviderInformation>',
-        :'remainder' => :'Array<ProviderInformation>'
+        :'id_number' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'middle_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'sex' => :'NigeriaNinMatch2InputSex',
+        :'phone_number' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'id_number',
+        :'given_name',
+        :'family_name',
+        :'middle_name',
+        :'date_of_birth',
+        :'sex',
+        :'phone_number'
       ])
     end
 
@@ -62,60 +111,52 @@ 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::RecommendResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::NigeriaNinMatch2Input` 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::RecommendResponse`. 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::NigeriaNinMatch2Input`. 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?(:'recognized')
-        if (value = attributes[:'recognized']).is_a?(Array)
-          self.recognized = value
-        end
-      else
-        self.recognized = nil
+      if attributes.key?(:'id_number')
+        self.id_number = attributes[:'id_number']
       end
 
-      if attributes.key?(:'relevant')
-        if (value = attributes[:'relevant']).is_a?(Array)
-          self.relevant = value
-        end
-      else
-        self.relevant = nil
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
       end
 
-      if attributes.key?(:'remainder')
-        if (value = attributes[:'remainder']).is_a?(Array)
-          self.remainder = value
-        end
-      else
-        self.remainder = nil
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
       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 @recognized.nil?
-        invalid_properties.push('invalid value for "recognized", recognized cannot be nil.')
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
       end
 
-      if @relevant.nil?
-        invalid_properties.push('invalid value for "relevant", relevant cannot be nil.')
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
       end
 
-      if @remainder.nil?
-        invalid_properties.push('invalid value for "remainder", remainder cannot be nil.')
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_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
 
@@ -123,50 +164,21 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @recognized.nil?
-      return false if @relevant.nil?
-      return false if @remainder.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] recognized Value to be assigned
-    def recognized=(recognized)
-      if recognized.nil?
-        fail ArgumentError, 'recognized cannot be nil'
-      end
-
-      @recognized = recognized
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] relevant Value to be assigned
-    def relevant=(relevant)
-      if relevant.nil?
-        fail ArgumentError, 'relevant cannot be nil'
-      end
-
-      @relevant = relevant
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] remainder Value to be assigned
-    def remainder=(remainder)
-      if remainder.nil?
-        fail ArgumentError, 'remainder cannot be nil'
-      end
-
-      @remainder = remainder
-    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 &&
-          recognized == o.recognized &&
-          relevant == o.relevant &&
-          remainder == o.remainder
+          id_number == o.id_number &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          middle_name == o.middle_name &&
+          date_of_birth == o.date_of_birth &&
+          sex == o.sex &&
+          phone_number == o.phone_number
     end
 
     # @see the `==` method
@@ -178,7 +190,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [recognized, relevant, remainder].hash
+      [id_number, given_name, family_name, middle_name, date_of_birth, sex, phone_number].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/nigeria_nin_match2_input_sex.rb

@@ -0,0 +1,40 @@
+=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
+  class NigeriaNinMatch2InputSex
+    MALE = "Male".freeze
+    FEMALE = "Female".freeze
+
+    def self.all_vars
+      @all_vars ||= [MALE, FEMALE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if NigeriaNinMatch2InputSex.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #NigeriaNinMatch2InputSex"
+    end
+  end
+end

data/lib/trinsic_api/models/person_data.rb

@@ -14,15 +14,21 @@ 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
 
+    # Suffix of the individual's name
     attr_accessor :suffix
 
     attr_accessor :nationality
@@ -31,6 +37,7 @@ module TrinsicApi
 
     attr_accessor :phone_number
 
+    # Address information for an individual
     attr_accessor :address
 
     attr_accessor :date_of_birth

data/lib/trinsic_api/models/{identifier.rb → peru_dni_address.rb}

@@ -14,19 +14,23 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class Identifier
-    attr_accessor :identifier
+  # Not a typical address. Does not include street or city. Instead, includes region, province and district.
+  class PeruDniAddress
+    # Region in Peru (also known as department). This is the first level subdivision in the country.              Format: - All uppercase.
+    attr_accessor :region
 
-    attr_accessor :scope
+    # Province within the region. This is the second level subdivision in the country.              Format: - All uppercase.
+    attr_accessor :province
 
-    attr_accessor :description
+    # District within the province. This is the third level subdivision in the country.              Format: - All uppercase.
+    attr_accessor :district
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'identifier' => :'identifier',
-        :'scope' => :'scope',
-        :'description' => :'description'
+        :'region' => :'region',
+        :'province' => :'province',
+        :'district' => :'district'
       }
     end
 
@@ -43,9 +47,9 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'identifier' => :'String',
-        :'scope' => :'String',
-        :'description' => :'String'
+        :'region' => :'String',
+        :'province' => :'String',
+        :'district' => :'String'
       }
     end
 
@@ -59,34 +63,34 @@ 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::Identifier` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::PeruDniAddress` 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::Identifier`. 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::PeruDniAddress`. 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?(:'identifier')
-        self.identifier = attributes[:'identifier']
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
       else
-        self.identifier = nil
+        self.region = nil
       end
 
-      if attributes.key?(:'scope')
-        self.scope = attributes[:'scope']
+      if attributes.key?(:'province')
+        self.province = attributes[:'province']
       else
-        self.scope = nil
+        self.province = nil
       end
 
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
+      if attributes.key?(:'district')
+        self.district = attributes[:'district']
       else
-        self.description = nil
+        self.district = nil
       end
     end
 
@@ -95,16 +99,16 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @identifier.nil?
-        invalid_properties.push('invalid value for "identifier", identifier cannot be nil.')
+      if @region.nil?
+        invalid_properties.push('invalid value for "region", region cannot be nil.')
       end
 
-      if @scope.nil?
-        invalid_properties.push('invalid value for "scope", scope cannot be nil.')
+      if @province.nil?
+        invalid_properties.push('invalid value for "province", province cannot be nil.')
       end
 
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      if @district.nil?
+        invalid_properties.push('invalid value for "district", district cannot be nil.')
       end
 
       invalid_properties
@@ -114,40 +118,40 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @identifier.nil?
-      return false if @scope.nil?
-      return false if @description.nil?
+      return false if @region.nil?
+      return false if @province.nil?
+      return false if @district.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] identifier Value to be assigned
-    def identifier=(identifier)
-      if identifier.nil?
-        fail ArgumentError, 'identifier cannot be nil'
+    # @param [Object] region Value to be assigned
+    def region=(region)
+      if region.nil?
+        fail ArgumentError, 'region cannot be nil'
       end
 
-      @identifier = identifier
+      @region = region
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] scope Value to be assigned
-    def scope=(scope)
-      if scope.nil?
-        fail ArgumentError, 'scope cannot be nil'
+    # @param [Object] province Value to be assigned
+    def province=(province)
+      if province.nil?
+        fail ArgumentError, 'province cannot be nil'
       end
 
-      @scope = scope
+      @province = province
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] description Value to be assigned
-    def description=(description)
-      if description.nil?
-        fail ArgumentError, 'description cannot be nil'
+    # @param [Object] district Value to be assigned
+    def district=(district)
+      if district.nil?
+        fail ArgumentError, 'district cannot be nil'
       end
 
-      @description = description
+      @district = district
     end
 
     # Checks equality by comparing each attribute.
@@ -155,9 +159,9 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          identifier == o.identifier &&
-          scope == o.scope &&
-          description == o.description
+          region == o.region &&
+          province == o.province &&
+          district == o.district
     end
 
     # @see the `==` method
@@ -169,7 +173,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [identifier, scope, description].hash
+      [region, province, district].hash
     end
 
     # Builds the object from hash