trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/kenya_nid_match2_sex_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 KenyaNidMatch2SexField < ApiModelBase
+    # The sex value submitted for this check.              Possible input values: - Male - Female
+    attr_accessor :input_value
+
+    # The outcome of comparing the submitted sex against the Integrated Population Registration System (IPRS).              Possible values: - Exact Match - No Match - Not Provided - 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' => :'String',
+        :'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::KenyaNidMatch2SexField` 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::KenyaNidMatch2SexField`. 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

data/lib/trinsic_api/models/lloyds_smart_id_provider_output.rb

@@ -17,7 +17,7 @@ module TrinsicApi
   # Exposed properties for the `lloyds-smart-id` Provider which do not directly map to the normalized IdentityData model.
   class LloydsSmartIdProviderOutput < ApiModelBase
     # A Yoti-generated unique ID for this individual, consistent across repeat shares and different for each Relying Party.
-    attr_accessor :remember_me_id
+    attr_accessor :yoti_remember_me_id
 
     # The email address of the individual
     attr_accessor :email
@@ -55,7 +55,7 @@ module TrinsicApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'remember_me_id' => :'rememberMeId',
+        :'yoti_remember_me_id' => :'yotiRememberMeId',
         :'email' => :'email',
         :'given_name' => :'givenName',
         :'family_name' => :'familyName',
@@ -83,7 +83,7 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'remember_me_id' => :'String',
+        :'yoti_remember_me_id' => :'String',
         :'email' => :'String',
         :'given_name' => :'String',
         :'family_name' => :'String',
@@ -101,7 +101,7 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'remember_me_id',
+        :'yoti_remember_me_id',
         :'email',
         :'given_name',
         :'family_name',
@@ -132,8 +132,8 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'remember_me_id')
-        self.remember_me_id = attributes[:'remember_me_id']
+      if attributes.key?(:'yoti_remember_me_id')
+        self.yoti_remember_me_id = attributes[:'yoti_remember_me_id']
       end
 
       if attributes.key?(:'email')
@@ -201,7 +201,7 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          remember_me_id == o.remember_me_id &&
+          yoti_remember_me_id == o.yoti_remember_me_id &&
           email == o.email &&
           given_name == o.given_name &&
           family_name == o.family_name &&
@@ -224,7 +224,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [remember_me_id, email, given_name, family_name, full_name, date_of_birth, gender, nationality, mobile_number, structured_postal_address, postal_address, document_details].hash
+      [yoti_remember_me_id, email, given_name, family_name, full_name, date_of_birth, gender, nationality, mobile_number, structured_postal_address, postal_address, document_details].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/mexico_curp_provider_output.rb

@@ -16,13 +16,57 @@ require 'time'
 module TrinsicApi
   # Exposed properties for the `mexico-curp-lookup` Provider which do not directly map to the normalized IdentityData model.
   class MexicoCurpProviderOutput < ApiModelBase
+    # First name of the individual.
+    attr_accessor :first_name
+
+    # The last name of the father of the individual.
+    attr_accessor :father_last_name
+
+    # The last name of the mother of the individual.
+    attr_accessor :mother_last_name
+
+    # The gender of the individual.   List of possible values:   - Male  - Female
+    attr_accessor :gender
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # The country of birth of the individual.
+    attr_accessor :country_of_birth
+
+    # The state of birth of the individual.
+    attr_accessor :state_of_birth
+
+    # The CURP (Clave Única de Registro de Población) that was verified.              A CURP code is a unique identifier assigned to individuals in Mexico. It is 18 alphanumeric characters, with a structured meaning:              ABCD YYMMDD G SS XYZ M C The first 4 letters (ABCD): A: The first letter of the paternal last name. B: First internal vowel of paternal last name. C: First letter of maternal last name. D: First letter of first name.              YYMMDD: 2-digit year, month, day.              G: Gender, H for Hombre (male) and M for Mujer (female).              SS: State code (2 letters), e.g. NL for Nuevo León.              X: First internal consonant of paternal last name. Y: First internal consonant of maternal last name. Z: First internal consonant of given name.              M: Millennium indicator (0-9 for pre-2000 birth date, A-Z for post-2000's birth dates.              C: Checksum character
+    attr_accessor :curp
+
     # Curp status for the subject.              Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive
     attr_accessor :curp_status
 
+    # The year the CURP number was registered in.
+    attr_accessor :registration_year
+
+    # The state the CURP number was registered in.
+    attr_accessor :registration_state
+
+    # The ACT (Número de Acta) number of the individual.              The Act number is a civil registry index number. Various state have various formats of specifying these.
+    attr_accessor :act_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'curp_status' => :'curpStatus'
+        :'first_name' => :'firstName',
+        :'father_last_name' => :'fatherLastName',
+        :'mother_last_name' => :'motherLastName',
+        :'gender' => :'gender',
+        :'date_of_birth' => :'dateOfBirth',
+        :'country_of_birth' => :'countryOfBirth',
+        :'state_of_birth' => :'stateOfBirth',
+        :'curp' => :'curp',
+        :'curp_status' => :'curpStatus',
+        :'registration_year' => :'registrationYear',
+        :'registration_state' => :'registrationState',
+        :'act_number' => :'actNumber'
       }
     end
 
@@ -39,14 +83,36 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'curp_status' => :'String'
+        :'first_name' => :'String',
+        :'father_last_name' => :'String',
+        :'mother_last_name' => :'String',
+        :'gender' => :'String',
+        :'date_of_birth' => :'Date',
+        :'country_of_birth' => :'String',
+        :'state_of_birth' => :'String',
+        :'curp' => :'String',
+        :'curp_status' => :'String',
+        :'registration_year' => :'Integer',
+        :'registration_state' => :'String',
+        :'act_number' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'curp_status'
+        :'first_name',
+        :'father_last_name',
+        :'mother_last_name',
+        :'gender',
+        :'date_of_birth',
+        :'country_of_birth',
+        :'state_of_birth',
+        :'curp',
+        :'curp_status',
+        :'registration_year',
+        :'registration_state',
+        :'act_number'
       ])
     end
 
@@ -66,9 +132,53 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'father_last_name')
+        self.father_last_name = attributes[:'father_last_name']
+      end
+
+      if attributes.key?(:'mother_last_name')
+        self.mother_last_name = attributes[:'mother_last_name']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'country_of_birth')
+        self.country_of_birth = attributes[:'country_of_birth']
+      end
+
+      if attributes.key?(:'state_of_birth')
+        self.state_of_birth = attributes[:'state_of_birth']
+      end
+
+      if attributes.key?(:'curp')
+        self.curp = attributes[:'curp']
+      end
+
       if attributes.key?(:'curp_status')
         self.curp_status = attributes[:'curp_status']
       end
+
+      if attributes.key?(:'registration_year')
+        self.registration_year = attributes[:'registration_year']
+      end
+
+      if attributes.key?(:'registration_state')
+        self.registration_state = attributes[:'registration_state']
+      end
+
+      if attributes.key?(:'act_number')
+        self.act_number = attributes[:'act_number']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +201,18 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          curp_status == o.curp_status
+          first_name == o.first_name &&
+          father_last_name == o.father_last_name &&
+          mother_last_name == o.mother_last_name &&
+          gender == o.gender &&
+          date_of_birth == o.date_of_birth &&
+          country_of_birth == o.country_of_birth &&
+          state_of_birth == o.state_of_birth &&
+          curp == o.curp &&
+          curp_status == o.curp_status &&
+          registration_year == o.registration_year &&
+          registration_state == o.registration_state &&
+          act_number == o.act_number
     end
 
     # @see the `==` method
@@ -103,7 +224,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [curp_status].hash
+      [first_name, father_last_name, mother_last_name, gender, date_of_birth, country_of_birth, state_of_birth, curp, curp_status, registration_year, registration_state, act_number].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/nigeria_nin_lookup2_input.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module TrinsicApi
   class NigeriaNinLookup2Input < ApiModelBase
-    # The user's National ID number (NIN)
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/nigeria_nin_lookup2_provider_output.rb

@@ -34,7 +34,7 @@ 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.

data/lib/trinsic_api/models/nigeria_nin_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 NigeriaNinMatch2DateOfBirthField < 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::NigeriaNinMatch2DateOfBirthField` 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::NigeriaNinMatch2DateOfBirthField`. 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