trinsic_api 3.1.0 → 3.2.1

data/lib/trinsic_api/models/south_africa_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 SouthAfricaNidMatch2NationalIdNumberField < ApiModelBase
+    # The South African National Identity Number (13 digits) is issued for life by the Department of Home Affairs (DHA) and stored in the Home Affairs National Identification System (HANIS) 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 :input_value
+
+    # The outcome of verifying the national ID number.              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::SouthAfricaNidMatch2NationalIdNumberField` 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::SouthAfricaNidMatch2NationalIdNumberField`. 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/south_africa_nid_match2_provider_output.rb

@@ -0,0 +1,194 @@
+=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-match-2` Provider which do not directly map to the normalized IdentityData model.
+  class SouthAfricaNidMatch2ProviderOutput < ApiModelBase
+    # Outcome of the verification of the national ID number.
+    attr_accessor :national_id_number
+
+    # Outcome of the verification of the full name.
+    attr_accessor :full_name
+
+    # Outcome of the verification of the date of birth.
+    attr_accessor :date_of_birth
+
+    # Outcome of the verification of the sex.
+    attr_accessor :sex
+
+    # Citizenship status of the individual, if the ID number is valid.              Possible values: - Citizen - PermanentResident
+    attr_accessor :citizenship_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'national_id_number' => :'nationalIdNumber',
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'sex' => :'sex',
+        :'citizenship_status' => :'citizenshipStatus'
+      }
+    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' => :'SouthAfricaNidMatch2NationalIdNumberField',
+        :'full_name' => :'SouthAfricaNidMatch2FullNameField',
+        :'date_of_birth' => :'SouthAfricaNidMatch2DateOfBirthField',
+        :'sex' => :'SouthAfricaNidMatch2SexField',
+        :'citizenship_status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'national_id_number',
+        :'full_name',
+        :'date_of_birth',
+        :'sex',
+        :'citizenship_status'
+      ])
+    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::SouthAfricaNidMatch2ProviderOutput` 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::SouthAfricaNidMatch2ProviderOutput`. 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?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'citizenship_status')
+        self.citizenship_status = attributes[:'citizenship_status']
+      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 &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          sex == o.sex &&
+          citizenship_status == o.citizenship_status
+    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, full_name, date_of_birth, sex, citizenship_status].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_sex_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 SouthAfricaNidMatch2SexField < ApiModelBase
+    # The sex value submitted for this check.              Possible input values: - Male - Female
+    attr_accessor :input_value
+
+    # The outcome of comparing the submitted sex to the issuer record.              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([
+        :'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::SouthAfricaNidMatch2SexField` 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::SouthAfricaNidMatch2SexField`. 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/spid_billing_information.rb

@@ -56,6 +56,9 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'is_billable',
+        :'verification_type',
+        :'verification_level'
       ])
     end
 
@@ -77,20 +80,14 @@ module TrinsicApi
 
       if attributes.key?(:'is_billable')
         self.is_billable = attributes[:'is_billable']
-      else
-        self.is_billable = nil
       end
 
       if attributes.key?(:'verification_type')
         self.verification_type = attributes[:'verification_type']
-      else
-        self.verification_type = nil
       end
 
       if attributes.key?(:'verification_level')
         self.verification_level = attributes[:'verification_level']
-      else
-        self.verification_level = nil
       end
     end
 
@@ -99,18 +96,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @is_billable.nil?
-        invalid_properties.push('invalid value for "is_billable", is_billable cannot be nil.')
-      end
-
-      if @verification_type.nil?
-        invalid_properties.push('invalid value for "verification_type", verification_type cannot be nil.')
-      end
-
-      if @verification_level.nil?
-        invalid_properties.push('invalid value for "verification_level", verification_level cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -118,42 +103,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @is_billable.nil?
-      return false if @verification_type.nil?
-      return false if @verification_level.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] is_billable Value to be assigned
-    def is_billable=(is_billable)
-      if is_billable.nil?
-        fail ArgumentError, 'is_billable cannot be nil'
-      end
-
-      @is_billable = is_billable
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] verification_type Value to be assigned
-    def verification_type=(verification_type)
-      if verification_type.nil?
-        fail ArgumentError, 'verification_type cannot be nil'
-      end
-
-      @verification_type = verification_type
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] verification_level Value to be assigned
-    def verification_level=(verification_level)
-      if verification_level.nil?
-        fail ArgumentError, 'verification_level cannot be nil'
-      end
-
-      @verification_level = verification_level
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/spid_provider_output.rb

@@ -162,6 +162,8 @@ module TrinsicApi
     def self.openapi_nullable
       Set.new([
         :'billing_information',
+        :'identity_provider_entity_id',
+        :'spid_code',
         :'spid_credential_expiration_date',
         :'raw_id_card',
         :'given_name',
@@ -208,14 +210,10 @@ module TrinsicApi
 
       if attributes.key?(:'identity_provider_entity_id')
         self.identity_provider_entity_id = attributes[:'identity_provider_entity_id']
-      else
-        self.identity_provider_entity_id = nil
       end
 
       if attributes.key?(:'spid_code')
         self.spid_code = attributes[:'spid_code']
-      else
-        self.spid_code = nil
       end
 
       if attributes.key?(:'spid_credential_expiration_date')
@@ -308,14 +306,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @identity_provider_entity_id.nil?
-        invalid_properties.push('invalid value for "identity_provider_entity_id", identity_provider_entity_id cannot be nil.')
-      end
-
-      if @spid_code.nil?
-        invalid_properties.push('invalid value for "spid_code", spid_code cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -323,31 +313,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @identity_provider_entity_id.nil?
-      return false if @spid_code.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] identity_provider_entity_id Value to be assigned
-    def identity_provider_entity_id=(identity_provider_entity_id)
-      if identity_provider_entity_id.nil?
-        fail ArgumentError, 'identity_provider_entity_id cannot be nil'
-      end
-
-      @identity_provider_entity_id = identity_provider_entity_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] spid_code Value to be assigned
-    def spid_code=(spid_code)
-      if spid_code.nil?
-        fail ArgumentError, 'spid_code cannot be nil'
-      end
-
-      @spid_code = spid_code
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)