trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/{provider_info.rb → sweden_bank_id_provider_output.rb}

@@ -14,39 +14,63 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  # A provider that can be specified when creating a `Session`
-  class ProviderInfo
-    # The ID of the provider
-    attr_accessor :id
+  # Exposed properties for the `sweden-bankid` Provider which do not directly map to the normalized IdentityData model.
+  class SwedenBankIdProviderOutput
+    # The full name of the individual.
+    attr_accessor :full_name
 
-    # The friendly, human-readable name of the provider
-    attr_accessor :name
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
 
-    # A URL pointing to the provider's logo
-    attr_accessor :logo_url
+    # The Swedish personal number (personnummer) associated with the verified individual. The value is typically a 12-digit number. This is in the format YYYYMMDDXXXX, where: - YYYYMMDD is the date of birth. - XXXX is an individual number, indicating gender.              If XXXX is even, the individual is female. If XXXX is odd, the individual is male.
+    attr_accessor :personal_identity_number
 
-    # The Provider's subtext recommended to be shown next to the name.              This is flavor text, not a full, human-readable description of the provider.
-    attr_accessor :subtext
+    # The given name of the individual
+    attr_accessor :given_name
 
-    # The Provider's description recommended to be shown next to the name.              This is flavor text, not a full, human-readable description of the provider.
-    attr_accessor :description
+    # The family name of the individual
+    attr_accessor :family_name
 
-    # The current health status of the provider
-    attr_accessor :health
+    # The end user's country on the verified certificate. This is ISO 2-character code of the country.
+    attr_accessor :country
 
-    # Metadata about the sub-providers which are available for this Provider.              For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
-    attr_accessor :sub_providers
+    # The object identifier policy of the individual's verified certificate
+    attr_accessor :certificate_policy
+
+    # The common name of the end user's verified certificate
+    attr_accessor :common_name
+
+    # The distinguished name of the end user's verified certificate
+    attr_accessor :distinguished_name
+
+    # The country that issued the Swedish personal number. This is an ISO 2-character code of the country and is extracted from the certificate. This will always be `SE`.
+    attr_accessor :personal_identity_number_issuing_country
+
+    # The IP address of the device used for authentication
+    attr_accessor :authentication_device_ip
+
+    # The certificate validity start date (not before) in UTC
+    attr_accessor :not_before
+
+    # The certificate validity end date (not after) in UTC
+    attr_accessor :not_after
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'name' => :'name',
-        :'logo_url' => :'logoUrl',
-        :'subtext' => :'subtext',
-        :'description' => :'description',
-        :'health' => :'health',
-        :'sub_providers' => :'subProviders'
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'personal_identity_number' => :'personalIdentityNumber',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'country' => :'country',
+        :'certificate_policy' => :'certificatePolicy',
+        :'common_name' => :'commonName',
+        :'distinguished_name' => :'distinguishedName',
+        :'personal_identity_number_issuing_country' => :'personalIdentityNumberIssuingCountry',
+        :'authentication_device_ip' => :'authenticationDeviceIp',
+        :'not_before' => :'notBefore',
+        :'not_after' => :'notAfter'
       }
     end
 
@@ -63,20 +87,38 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'name' => :'String',
-        :'logo_url' => :'String',
-        :'subtext' => :'String',
-        :'description' => :'String',
-        :'health' => :'String',
-        :'sub_providers' => :'Array<SubProviderMetadata>'
+        :'full_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'personal_identity_number' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'country' => :'String',
+        :'certificate_policy' => :'String',
+        :'common_name' => :'String',
+        :'distinguished_name' => :'String',
+        :'personal_identity_number_issuing_country' => :'String',
+        :'authentication_device_ip' => :'String',
+        :'not_before' => :'Time',
+        :'not_after' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'sub_providers'
+        :'full_name',
+        :'date_of_birth',
+        :'personal_identity_number',
+        :'given_name',
+        :'family_name',
+        :'country',
+        :'certificate_policy',
+        :'common_name',
+        :'distinguished_name',
+        :'personal_identity_number_issuing_country',
+        :'authentication_device_ip',
+        :'not_before',
+        :'not_after'
       ])
     end
 
@@ -84,90 +126,76 @@ 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::ProviderInfo` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::SwedenBankIdProviderOutput` 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::ProviderInfo`. 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::SwedenBankIdProviderOutput`. 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?(:'id')
-        self.id = attributes[:'id']
-      else
-        self.id = nil
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
       end
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      else
-        self.name = nil
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
       end
 
-      if attributes.key?(:'logo_url')
-        self.logo_url = attributes[:'logo_url']
-      else
-        self.logo_url = nil
+      if attributes.key?(:'personal_identity_number')
+        self.personal_identity_number = attributes[:'personal_identity_number']
       end
 
-      if attributes.key?(:'subtext')
-        self.subtext = attributes[:'subtext']
-      else
-        self.subtext = nil
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
       end
 
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
-      else
-        self.description = nil
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
       end
 
-      if attributes.key?(:'health')
-        self.health = attributes[:'health']
-      else
-        self.health = nil
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
       end
 
-      if attributes.key?(:'sub_providers')
-        if (value = attributes[:'sub_providers']).is_a?(Array)
-          self.sub_providers = value
-        end
+      if attributes.key?(:'certificate_policy')
+        self.certificate_policy = attributes[:'certificate_policy']
       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 @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      if attributes.key?(:'common_name')
+        self.common_name = attributes[:'common_name']
       end
 
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      if attributes.key?(:'distinguished_name')
+        self.distinguished_name = attributes[:'distinguished_name']
       end
 
-      if @logo_url.nil?
-        invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
+      if attributes.key?(:'personal_identity_number_issuing_country')
+        self.personal_identity_number_issuing_country = attributes[:'personal_identity_number_issuing_country']
       end
 
-      if @subtext.nil?
-        invalid_properties.push('invalid value for "subtext", subtext cannot be nil.')
+      if attributes.key?(:'authentication_device_ip')
+        self.authentication_device_ip = attributes[:'authentication_device_ip']
       end
 
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      if attributes.key?(:'not_before')
+        self.not_before = attributes[:'not_before']
       end
 
-      if @health.nil?
-        invalid_properties.push('invalid value for "health", health cannot be nil.')
+      if attributes.key?(:'not_after')
+        self.not_after = attributes[:'not_after']
       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
 
@@ -175,87 +203,27 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
-      return false if @name.nil?
-      return false if @logo_url.nil?
-      return false if @subtext.nil?
-      return false if @description.nil?
-      return false if @health.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] id Value to be assigned
-    def id=(id)
-      if id.nil?
-        fail ArgumentError, 'id cannot be nil'
-      end
-
-      @id = id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      @name = name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] logo_url Value to be assigned
-    def logo_url=(logo_url)
-      if logo_url.nil?
-        fail ArgumentError, 'logo_url cannot be nil'
-      end
-
-      @logo_url = logo_url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] subtext Value to be assigned
-    def subtext=(subtext)
-      if subtext.nil?
-        fail ArgumentError, 'subtext cannot be nil'
-      end
-
-      @subtext = subtext
-    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'
-      end
-
-      @description = description
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] health Value to be assigned
-    def health=(health)
-      if health.nil?
-        fail ArgumentError, 'health cannot be nil'
-      end
-
-      @health = health
-    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 &&
-          id == o.id &&
-          name == o.name &&
-          logo_url == o.logo_url &&
-          subtext == o.subtext &&
-          description == o.description &&
-          health == o.health &&
-          sub_providers == o.sub_providers
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          personal_identity_number == o.personal_identity_number &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          country == o.country &&
+          certificate_policy == o.certificate_policy &&
+          common_name == o.common_name &&
+          distinguished_name == o.distinguished_name &&
+          personal_identity_number_issuing_country == o.personal_identity_number_issuing_country &&
+          authentication_device_ip == o.authentication_device_ip &&
+          not_before == o.not_before &&
+          not_after == o.not_after
     end
 
     # @see the `==` method
@@ -267,7 +235,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, logo_url, subtext, description, health, sub_providers].hash
+      [full_name, date_of_birth, personal_identity_number, given_name, family_name, country, certificate_policy, common_name, distinguished_name, personal_identity_number_issuing_country, authentication_device_ip, not_before, not_after].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/uganda_nid_match2_input.rb

@@ -0,0 +1,244 @@
+=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 UgandaNidMatch2Input
+    # The user's Uganda National ID number (NIN) - 14 alphanumeric characters
+    attr_accessor :id_number
+
+    # The card number on the document (secondary ID number). Required for Uganda Basic KYC instead of first name and last name.
+    attr_accessor :secondary_id_number
+
+    # 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
+      {
+        :'id_number' => :'idNumber',
+        :'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
+      {
+        :'id_number' => :'String',
+        :'secondary_id_number' => :'String',
+        :'date_of_birth' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'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::UgandaNidMatch2Input` 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::UgandaNidMatch2Input`. 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?(:'id_number')
+        self.id_number = attributes[:'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 &&
+          id_number == o.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
+      [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
+
+    # 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