trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/south_africa_nid_match2_input.rb

@@ -0,0 +1,310 @@
+=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 SouthAfricaNidMatch2Input
+    # The user's South African National ID number
+    attr_accessor :id_number
+
+    # The user's first name as it appears in their National ID
+    attr_accessor :given_name
+
+    # The user's last name as it appears in their National ID
+    attr_accessor :family_name
+
+    # The user's middle name as it appears in their National ID (optional)
+    attr_accessor :middle_name
+
+    # The user's date of birth, in `YYYY-MM-DD` format
+    attr_accessor :date_of_birth
+
+    # The user's sex as it appears in their National ID
+    attr_accessor :sex
+
+    # The user's phone number as it appears in their National ID (optional). Must be in E.164 international format: \"+27XXXXXXXXX\"
+    attr_accessor :phone_number
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id_number' => :'idNumber',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'middle_name' => :'middleName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'sex' => :'sex',
+        :'phone_number' => :'phoneNumber'
+      }
+    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',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'middle_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'sex' => :'SouthAfricaNidMatch2InputSex',
+        :'phone_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'id_number',
+        :'given_name',
+        :'family_name',
+        :'middle_name',
+        :'date_of_birth',
+        :'sex',
+        :'phone_number'
+      ])
+    end
+
+    # 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::SouthAfricaNidMatch2Input` 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::SouthAfricaNidMatch2Input`. 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?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'sex')
+        self.sex = attributes[:'sex']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # 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 &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          middle_name == o.middle_name &&
+          date_of_birth == o.date_of_birth &&
+          sex == o.sex &&
+          phone_number == o.phone_number
+    end
+
+    # @see the `==` method
+    # @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, given_name, family_name, middle_name, date_of_birth, sex, phone_number].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

data/lib/trinsic_api/models/south_africa_nid_match2_input_sex.rb

@@ -0,0 +1,40 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  class SouthAfricaNidMatch2InputSex
+    MALE = "Male".freeze
+    FEMALE = "Female".freeze
+
+    def self.all_vars
+      @all_vars ||= [MALE, FEMALE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if SouthAfricaNidMatch2InputSex.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SouthAfricaNidMatch2InputSex"
+    end
+  end
+end

data/lib/trinsic_api/models/spid_provider_output.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
+  # Exposed properties for the `italy-spid` Provider which do not directly map to the normalized IdentityData model.
   class SpidProviderOutput
     # Information about the billable status of this SPID Verification.              Present only if your account has period-based billing enabled for SPID. Contact Trinsic to enable this.
     attr_accessor :billing_information
@@ -21,40 +22,70 @@ module TrinsicApi
     # The SPID Entity ID of the Identity Provider which issued the SPID identity.              This is an HTTPS URI which uniquely identifies the IdP within the SPID federation.              A normalized / simplified representation of this value is present in the `originatingSubProviderId` field in Trinsic's normalized data model.
     attr_accessor :identity_provider_entity_id
 
-    # The identifier of the user's SPID credential.              This uniquely identifies the credential within the SPID federation.
+    # The identifier of the SPID credential, uniquely identifying it within the SPID federation.              The format of this string is specific to each individual Identity Provider.
     attr_accessor :spid_code
 
-    # Expiration date of the user's SPID credential.              This is not the same as the expiration date of the underlying identity document (such as a passport) which was used to create the SPID identity.
+    # Expiration date of the SPID credential.              This is not the same as the expiration date of the underlying identity document (such as a passport) which was used to create the SPID identity.
     attr_accessor :spid_credential_expiration_date
 
-    # The user's place of birth.
+    # The raw, space-separated string value for the \"IdCard\" field from the SPID credential.              Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model.
+    attr_accessor :raw_id_card
+
+    # The individual's first / given name(s)
+    attr_accessor :given_name
+
+    # The individual's last / family name(s)
+    attr_accessor :family_name
+
+    # The date of birth of the individual
+    attr_accessor :date_of_birth
+
+    # The gender of the individual.              Possible values: \"M\" | \"F\"
+    attr_accessor :gender
+
+    # The individual's place of birth.              This is a 4-digit Belfiore Code identifying either the municipality of birth (for births in Italy) or a foreign country (for births outside Italy).
     attr_accessor :place_of_birth
 
-    # The user's county of birth.
+    # The individual's county (province) of birth, abbreviated.              For foreign births, this is \"EE\".
     attr_accessor :county_of_birth
 
-    # The raw, space-separated string value for the \"IdCard\" field from the SPID identity.              Trinsic additionally parses this field and uses it to populate the `Document` object in the normalized data model.
-    attr_accessor :raw_id_card
+    # The street address of the individual's residence.              This includes street name, street type, and house number, in the standard format for the given state.
+    attr_accessor :domicile_street_address
+
+    # The postal code of the individual's residence
+    attr_accessor :domicile_postal_code
+
+    # The municipality of the individual's residence
+    attr_accessor :domicile_municipality
+
+    # The province of the individual's residence
+    attr_accessor :domicile_province
+
+    # The 2-digit country code of the individual's residence
+    attr_accessor :domicile_nation
 
-    # The email address of the user.
+    # The email address of the individual
     attr_accessor :email
 
-    # The digital address of the user.
+    # The mobile phone number of the individual, in Italian format.
+    attr_accessor :mobile_phone
+
+    # The PEC (Italian Certified Email) address of the individual or organization.
     attr_accessor :digital_address
 
-    # Fiscal tax number for the subject.
+    # Fiscal tax number for the individual.
     attr_accessor :fiscal_number
 
-    # VAT number for the subject.
+    # The VAT number of the organization which was verified, or of the organization which the verified individual is associated with.
     attr_accessor :iva_code
 
-    # The name of the company which the user is associated with.
+    # The name of the organization which was verified, or of the organization which the verified individual is associated with.
     attr_accessor :company_name
 
-    # The fiscal tax number of the company which the user is associated with.
+    # The fiscal tax number of the organization which was verified, or of the organization which the verified individual is associated with.
     attr_accessor :company_fiscal_number
 
-    # The registered office address of the company which the user is associated with.
+    # The registered office address of the organization which was verified, or of the organization which the verified individual is associated with.
     attr_accessor :registered_office
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -64,10 +95,20 @@ module TrinsicApi
         :'identity_provider_entity_id' => :'identityProviderEntityId',
         :'spid_code' => :'spidCode',
         :'spid_credential_expiration_date' => :'spidCredentialExpirationDate',
+        :'raw_id_card' => :'rawIdCard',
+        :'given_name' => :'givenName',
+        :'family_name' => :'familyName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'gender' => :'gender',
         :'place_of_birth' => :'placeOfBirth',
         :'county_of_birth' => :'countyOfBirth',
-        :'raw_id_card' => :'rawIdCard',
+        :'domicile_street_address' => :'domicileStreetAddress',
+        :'domicile_postal_code' => :'domicilePostalCode',
+        :'domicile_municipality' => :'domicileMunicipality',
+        :'domicile_province' => :'domicileProvince',
+        :'domicile_nation' => :'domicileNation',
         :'email' => :'email',
+        :'mobile_phone' => :'mobilePhone',
         :'digital_address' => :'digitalAddress',
         :'fiscal_number' => :'fiscalNumber',
         :'iva_code' => :'ivaCode',
@@ -94,10 +135,20 @@ module TrinsicApi
         :'identity_provider_entity_id' => :'String',
         :'spid_code' => :'String',
         :'spid_credential_expiration_date' => :'Date',
+        :'raw_id_card' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'gender' => :'String',
         :'place_of_birth' => :'String',
         :'county_of_birth' => :'String',
-        :'raw_id_card' => :'String',
+        :'domicile_street_address' => :'String',
+        :'domicile_postal_code' => :'String',
+        :'domicile_municipality' => :'String',
+        :'domicile_province' => :'String',
+        :'domicile_nation' => :'String',
         :'email' => :'String',
+        :'mobile_phone' => :'String',
         :'digital_address' => :'String',
         :'fiscal_number' => :'String',
         :'iva_code' => :'String',
@@ -112,10 +163,20 @@ module TrinsicApi
       Set.new([
         :'billing_information',
         :'spid_credential_expiration_date',
+        :'raw_id_card',
+        :'given_name',
+        :'family_name',
+        :'date_of_birth',
+        :'gender',
         :'place_of_birth',
         :'county_of_birth',
-        :'raw_id_card',
+        :'domicile_street_address',
+        :'domicile_postal_code',
+        :'domicile_municipality',
+        :'domicile_province',
+        :'domicile_nation',
         :'email',
+        :'mobile_phone',
         :'digital_address',
         :'fiscal_number',
         :'iva_code',
@@ -161,6 +222,26 @@ module TrinsicApi
         self.spid_credential_expiration_date = attributes[:'spid_credential_expiration_date']
       end
 
+      if attributes.key?(:'raw_id_card')
+        self.raw_id_card = attributes[:'raw_id_card']
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
       if attributes.key?(:'place_of_birth')
         self.place_of_birth = attributes[:'place_of_birth']
       end
@@ -169,14 +250,34 @@ module TrinsicApi
         self.county_of_birth = attributes[:'county_of_birth']
       end
 
-      if attributes.key?(:'raw_id_card')
-        self.raw_id_card = attributes[:'raw_id_card']
+      if attributes.key?(:'domicile_street_address')
+        self.domicile_street_address = attributes[:'domicile_street_address']
+      end
+
+      if attributes.key?(:'domicile_postal_code')
+        self.domicile_postal_code = attributes[:'domicile_postal_code']
+      end
+
+      if attributes.key?(:'domicile_municipality')
+        self.domicile_municipality = attributes[:'domicile_municipality']
+      end
+
+      if attributes.key?(:'domicile_province')
+        self.domicile_province = attributes[:'domicile_province']
+      end
+
+      if attributes.key?(:'domicile_nation')
+        self.domicile_nation = attributes[:'domicile_nation']
       end
 
       if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
 
+      if attributes.key?(:'mobile_phone')
+        self.mobile_phone = attributes[:'mobile_phone']
+      end
+
       if attributes.key?(:'digital_address')
         self.digital_address = attributes[:'digital_address']
       end
@@ -256,10 +357,20 @@ module TrinsicApi
           identity_provider_entity_id == o.identity_provider_entity_id &&
           spid_code == o.spid_code &&
           spid_credential_expiration_date == o.spid_credential_expiration_date &&
+          raw_id_card == o.raw_id_card &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          date_of_birth == o.date_of_birth &&
+          gender == o.gender &&
           place_of_birth == o.place_of_birth &&
           county_of_birth == o.county_of_birth &&
-          raw_id_card == o.raw_id_card &&
+          domicile_street_address == o.domicile_street_address &&
+          domicile_postal_code == o.domicile_postal_code &&
+          domicile_municipality == o.domicile_municipality &&
+          domicile_province == o.domicile_province &&
+          domicile_nation == o.domicile_nation &&
           email == o.email &&
+          mobile_phone == o.mobile_phone &&
           digital_address == o.digital_address &&
           fiscal_number == o.fiscal_number &&
           iva_code == o.iva_code &&
@@ -277,7 +388,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [billing_information, identity_provider_entity_id, spid_code, spid_credential_expiration_date, place_of_birth, county_of_birth, raw_id_card, email, digital_address, fiscal_number, iva_code, company_name, company_fiscal_number, registered_office].hash
+      [billing_information, identity_provider_entity_id, spid_code, spid_credential_expiration_date, raw_id_card, given_name, family_name, date_of_birth, gender, place_of_birth, county_of_birth, domicile_street_address, domicile_postal_code, domicile_municipality, domicile_province, domicile_nation, email, mobile_phone, digital_address, fiscal_number, iva_code, company_name, company_fiscal_number, registered_office].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/sub_provider_metadata.rb

@@ -25,9 +25,6 @@ module TrinsicApi
     # 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 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 :description
-
     # A URL pointing to the logo on Trinsic's CDN.              May be a PNG, JPG, or SVG image.
     attr_accessor :logo_url
 
@@ -37,7 +34,6 @@ module TrinsicApi
         :'id' => :'id',
         :'name' => :'name',
         :'subtext' => :'subtext',
-        :'description' => :'description',
         :'logo_url' => :'logoUrl'
       }
     end
@@ -58,7 +54,6 @@ module TrinsicApi
         :'id' => :'String',
         :'name' => :'String',
         :'subtext' => :'String',
-        :'description' => :'String',
         :'logo_url' => :'String'
       }
     end
@@ -103,12 +98,6 @@ module TrinsicApi
         self.subtext = nil
       end
 
-      if attributes.key?(:'description')
-        self.description = attributes[:'description']
-      else
-        self.description = nil
-      end
-
       if attributes.key?(:'logo_url')
         self.logo_url = attributes[:'logo_url']
       else
@@ -133,10 +122,6 @@ module TrinsicApi
         invalid_properties.push('invalid value for "subtext", subtext cannot be nil.')
       end
 
-      if @description.nil?
-        invalid_properties.push('invalid value for "description", description cannot be nil.')
-      end
-
       if @logo_url.nil?
         invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
       end
@@ -151,7 +136,6 @@ module TrinsicApi
       return false if @id.nil?
       return false if @name.nil?
       return false if @subtext.nil?
-      return false if @description.nil?
       return false if @logo_url.nil?
       true
     end
@@ -186,16 +170,6 @@ module TrinsicApi
       @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] logo_url Value to be assigned
     def logo_url=(logo_url)
@@ -214,7 +188,6 @@ module TrinsicApi
           id == o.id &&
           name == o.name &&
           subtext == o.subtext &&
-          description == o.description &&
           logo_url == o.logo_url
     end
 
@@ -227,7 +200,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, subtext, description, logo_url].hash
+      [id, name, subtext, logo_url].hash
     end
 
     # Builds the object from hash