trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/uganda_nid_match2_national_id_number_field.rb

@@ -0,0 +1,160 @@
+=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 UgandaNidMatch2NationalIdNumberField < ApiModelBase
+    # Uganda National ID number (NID) assigned by the National Identification and Registration Authority (NIRA).              Format: - 14 alphanumeric characters (A-Z, 0-9) - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by NIRA
+    attr_accessor :input_value
+
+    # The outcome of looking up the NID in NIRA database.              Possible values: - Verified - Not Verified - Not Done - Issuer Unavailable - 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([
+        :'input_value',
+        :'outcome'
+      ])
+    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::UgandaNidMatch2NationalIdNumberField` 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::UgandaNidMatch2NationalIdNumberField`. 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']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      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 &&
+          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/uganda_nid_match2_provider_output.rb

@@ -0,0 +1,172 @@
+=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 `uganda-nid-match-2` Provider which do not directly map to the normalized IdentityData model.
+  class UgandaNidMatch2ProviderOutput < ApiModelBase
+    # Outcome of verifying the national identification number in the NIRA database.
+    attr_accessor :national_id_number
+
+    # Outcome of comparing the submitted card number with the NIRA database.
+    attr_accessor :secondary_id_number
+
+    # Outcome of comparing the submitted date of birth with the NIRA database.
+    attr_accessor :date_of_birth
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_id_number' => :'nationalIdNumber',
+        :'secondary_id_number' => :'secondaryIdNumber',
+        :'date_of_birth' => :'dateOfBirth'
+      }
+    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' => :'UgandaNidMatch2NationalIdNumberField',
+        :'secondary_id_number' => :'UgandaNidMatch2SecondaryIdNumberField',
+        :'date_of_birth' => :'UgandaNidMatch2DateOfBirthField'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'national_id_number',
+        :'secondary_id_number',
+        :'date_of_birth'
+      ])
+    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::UgandaNidMatch2ProviderOutput` 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::UgandaNidMatch2ProviderOutput`. 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']
+      end
+
+      if attributes.key?(:'secondary_id_number')
+        self.secondary_id_number = attributes[:'secondary_id_number']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      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 &&
+          national_id_number == o.national_id_number &&
+          secondary_id_number == o.secondary_id_number &&
+          date_of_birth == o.date_of_birth
+    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, secondary_id_number, date_of_birth].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/uganda_nid_match2_secondary_id_number_field.rb

@@ -0,0 +1,160 @@
+=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 UgandaNidMatch2SecondaryIdNumberField < ApiModelBase
+    # The card number on the national ID document, distinct from the National ID number.              Format: - 9 numeric digits - There is no publicly documented encoding scheme for encoding personal information in the card number - No check digit or algorithm has been publicly documented by NIRA
+    attr_accessor :input_value
+
+    # The outcome of comparing the submitted card number with NIRA database.              Possible values: - Exact Match - 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' => :'String',
+        :'outcome' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'input_value',
+        :'outcome'
+      ])
+    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::UgandaNidMatch2SecondaryIdNumberField` 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::UgandaNidMatch2SecondaryIdNumberField`. 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']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      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 &&
+          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/yoti_deeplink_provider_output.rb

@@ -17,7 +17,7 @@ module TrinsicApi
   # Exposed properties for the `yoti-deeplink` Provider which do not directly map to the normalized IdentityData model.
   class YotiDeeplinkProviderOutput < 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/yoti_provider_output.rb

@@ -17,7 +17,7 @@ module TrinsicApi
   # Exposed properties for the `yoti` Provider which do not directly map to the normalized IdentityData model.
   class YotiProviderOutput < 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/zimbabwe_nid_lookup2_input.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module TrinsicApi
   class ZimbabweNidLookup2Input < ApiModelBase
-    # The user's National ID number
+    # Zimbabwe National ID number (NID) issued by the Zimbabwean government.              Format: - 8-9 digits followed by 1 letter and 2 digits - Regex: /^[0-9]{8,9}[A-Za-z]\\d{2}$/ - There is no publicly documented encoding scheme for encoding personal information in the NID - No check digit or algorithm has been publicly documented by the Zimbabwean government
     attr_accessor :id_number
 
     # Attribute mapping from ruby-style variable name to JSON key.