trinsic_api 3.1.0.pre.preview1 → 3.2.0

data/lib/trinsic_api/models/verimi_provider_output.rb

@@ -0,0 +1,425 @@
+=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 `verimi` Provider which do not directly map to the normalized IdentityData model.
+  class VerimiProviderOutput < ApiModelBase
+    # The full name of the individual.
+    attr_accessor :full_name
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # The given name of the individual.
+    attr_accessor :given_name
+
+    # The middle name of the individual.
+    attr_accessor :middle_name
+
+    # The family name of the individual.
+    attr_accessor :family_name
+
+    # The email address of the individual.
+    attr_accessor :email
+
+    # Whether the email address has been verified by Verimi.
+    attr_accessor :email_verified
+
+    # The phone number of the individual in E.164 format.
+    attr_accessor :phone_number
+
+    # Whether the phone number has been verified by Verimi.
+    attr_accessor :phone_number_verified
+
+    # The gender of the individual.
+    attr_accessor :gender
+
+    # The individual's time zone as an IANA Time Zone Database zoneinfo identifier.
+    attr_accessor :zone_information
+
+    # The selected language or locale of the individual as a BCP 47 language tag.
+    attr_accessor :locale
+
+    # The citizenship of the individual.              This is an ISO-3166-1 alpha-2 country code.
+    attr_accessor :citizenship
+
+    # The place of birth of the individual.
+    attr_accessor :place_of_birth
+
+    # The document number of the identity document used by the individual.
+    attr_accessor :document_number
+
+    # The identity document type.              Known values: - I: ID card. - P: Passport.
+    attr_accessor :document_type
+
+    # The expiration date of the identity document.
+    attr_accessor :document_expiration_date
+
+    # The issue date of the identity document.
+    attr_accessor :document_issue_date
+
+    # The authority that issued the identity document.
+    attr_accessor :document_issuing_authority
+
+    # The verification method used to prove the individual's identity.
+    attr_accessor :verification_method
+
+    # The date when the individual proved their identity with Verimi.
+    attr_accessor :verification_date
+
+    # The level of assurance for the verification.              Known values: - Low: The individual has self-asserted their identity. - Substantial: The individual has completed identity proofing and strong authentication. - High: The individual has completed identity proofing with stronger cryptographic authentication requirements.
+    attr_accessor :level_of_assurance
+
+    # The authentication method for the completed identification.              Known values: - email - loa.dipp.default - loa.dipp.2fa - idcard
+    attr_accessor :authentication_method
+
+    # The pseudonymous identifier.              For German eID, this is the restricted identifier (rID), scoped to the relying-party sector.
+    attr_accessor :pseudonym
+
+    # The individual's structured address.
+    attr_accessor :address
+
+    # The ISO 3166-1 alpha-2 country code for the country that issued the identity document.
+    attr_accessor :issuing_country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'given_name' => :'givenName',
+        :'middle_name' => :'middleName',
+        :'family_name' => :'familyName',
+        :'email' => :'email',
+        :'email_verified' => :'emailVerified',
+        :'phone_number' => :'phoneNumber',
+        :'phone_number_verified' => :'phoneNumberVerified',
+        :'gender' => :'gender',
+        :'zone_information' => :'zoneInformation',
+        :'locale' => :'locale',
+        :'citizenship' => :'citizenship',
+        :'place_of_birth' => :'placeOfBirth',
+        :'document_number' => :'documentNumber',
+        :'document_type' => :'documentType',
+        :'document_expiration_date' => :'documentExpirationDate',
+        :'document_issue_date' => :'documentIssueDate',
+        :'document_issuing_authority' => :'documentIssuingAuthority',
+        :'verification_method' => :'verificationMethod',
+        :'verification_date' => :'verificationDate',
+        :'level_of_assurance' => :'levelOfAssurance',
+        :'authentication_method' => :'authenticationMethod',
+        :'pseudonym' => :'pseudonym',
+        :'address' => :'address',
+        :'issuing_country' => :'issuingCountry'
+      }
+    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
+      {
+        :'full_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'given_name' => :'String',
+        :'middle_name' => :'String',
+        :'family_name' => :'String',
+        :'email' => :'String',
+        :'email_verified' => :'Boolean',
+        :'phone_number' => :'String',
+        :'phone_number_verified' => :'Boolean',
+        :'gender' => :'String',
+        :'zone_information' => :'String',
+        :'locale' => :'String',
+        :'citizenship' => :'String',
+        :'place_of_birth' => :'String',
+        :'document_number' => :'String',
+        :'document_type' => :'String',
+        :'document_expiration_date' => :'Date',
+        :'document_issue_date' => :'Date',
+        :'document_issuing_authority' => :'String',
+        :'verification_method' => :'String',
+        :'verification_date' => :'Date',
+        :'level_of_assurance' => :'String',
+        :'authentication_method' => :'String',
+        :'pseudonym' => :'String',
+        :'address' => :'VerimiAddressOutput',
+        :'issuing_country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'date_of_birth',
+        :'given_name',
+        :'middle_name',
+        :'family_name',
+        :'email',
+        :'email_verified',
+        :'phone_number',
+        :'phone_number_verified',
+        :'gender',
+        :'zone_information',
+        :'locale',
+        :'citizenship',
+        :'place_of_birth',
+        :'document_number',
+        :'document_type',
+        :'document_expiration_date',
+        :'document_issue_date',
+        :'document_issuing_authority',
+        :'verification_method',
+        :'verification_date',
+        :'level_of_assurance',
+        :'authentication_method',
+        :'pseudonym',
+        :'address',
+        :'issuing_country'
+      ])
+    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::VerimiProviderOutput` 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::VerimiProviderOutput`. 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?(:'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?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'middle_name')
+        self.middle_name = attributes[:'middle_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'email_verified')
+        self.email_verified = attributes[:'email_verified']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'phone_number_verified')
+        self.phone_number_verified = attributes[:'phone_number_verified']
+      end
+
+      if attributes.key?(:'gender')
+        self.gender = attributes[:'gender']
+      end
+
+      if attributes.key?(:'zone_information')
+        self.zone_information = attributes[:'zone_information']
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
+
+      if attributes.key?(:'citizenship')
+        self.citizenship = attributes[:'citizenship']
+      end
+
+      if attributes.key?(:'place_of_birth')
+        self.place_of_birth = attributes[:'place_of_birth']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'document_type')
+        self.document_type = attributes[:'document_type']
+      end
+
+      if attributes.key?(:'document_expiration_date')
+        self.document_expiration_date = attributes[:'document_expiration_date']
+      end
+
+      if attributes.key?(:'document_issue_date')
+        self.document_issue_date = attributes[:'document_issue_date']
+      end
+
+      if attributes.key?(:'document_issuing_authority')
+        self.document_issuing_authority = attributes[:'document_issuing_authority']
+      end
+
+      if attributes.key?(:'verification_method')
+        self.verification_method = attributes[:'verification_method']
+      end
+
+      if attributes.key?(:'verification_date')
+        self.verification_date = attributes[:'verification_date']
+      end
+
+      if attributes.key?(:'level_of_assurance')
+        self.level_of_assurance = attributes[:'level_of_assurance']
+      end
+
+      if attributes.key?(:'authentication_method')
+        self.authentication_method = attributes[:'authentication_method']
+      end
+
+      if attributes.key?(:'pseudonym')
+        self.pseudonym = attributes[:'pseudonym']
+      end
+
+      if attributes.key?(:'address')
+        self.address = attributes[:'address']
+      end
+
+      if attributes.key?(:'issuing_country')
+        self.issuing_country = attributes[:'issuing_country']
+      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 &&
+          full_name == o.full_name &&
+          date_of_birth == o.date_of_birth &&
+          given_name == o.given_name &&
+          middle_name == o.middle_name &&
+          family_name == o.family_name &&
+          email == o.email &&
+          email_verified == o.email_verified &&
+          phone_number == o.phone_number &&
+          phone_number_verified == o.phone_number_verified &&
+          gender == o.gender &&
+          zone_information == o.zone_information &&
+          locale == o.locale &&
+          citizenship == o.citizenship &&
+          place_of_birth == o.place_of_birth &&
+          document_number == o.document_number &&
+          document_type == o.document_type &&
+          document_expiration_date == o.document_expiration_date &&
+          document_issue_date == o.document_issue_date &&
+          document_issuing_authority == o.document_issuing_authority &&
+          verification_method == o.verification_method &&
+          verification_date == o.verification_date &&
+          level_of_assurance == o.level_of_assurance &&
+          authentication_method == o.authentication_method &&
+          pseudonym == o.pseudonym &&
+          address == o.address &&
+          issuing_country == o.issuing_country
+    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
+      [full_name, date_of_birth, given_name, middle_name, family_name, email, email_verified, phone_number, phone_number_verified, gender, zone_information, locale, citizenship, place_of_birth, document_number, document_type, document_expiration_date, document_issue_date, document_issuing_authority, verification_method, verification_date, level_of_assurance, authentication_method, pseudonym, address, issuing_country].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.