trinsic_api 3.2.0 → 3.2.1

data/lib/trinsic_api/models/clear_provider_output.rb

@@ -0,0 +1,375 @@
+=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 `clear` Provider which do not directly map to the normalized IdentityData model.
+  class ClearProviderOutput < ApiModelBase
+    # Whether CLEAR authenticated the individual.
+    attr_accessor :authenticated
+
+    # The methods the individual authenticated with during the CLEAR flow.              Known values: - webauthn - email - sms_otp
+    attr_accessor :authentication_methods
+
+    # The authentication methods the individual activated but did not use as a pre-existing credential during this session.              Known values: - webauthn - totp
+    attr_accessor :activated_authentication_methods
+
+    # The checks CLEAR performed on the individual's data and each check's result.
+    attr_accessor :checks
+
+    # CLEAR error or metadata codes that influenced check results.
+    attr_accessor :check_metadata
+
+    # The time the CLEAR verification session completed, as a UTC timestamp.
+    attr_accessor :completed_at
+
+    # The time the CLEAR verification session was created, as a UTC timestamp.
+    attr_accessor :created_at
+
+    # The individual's verified email address from the session.
+    attr_accessor :email
+
+    # The time the CLEAR verification session expires, as a UTC timestamp.
+    attr_accessor :expires_at
+
+    # The fields CLEAR still required to complete the current verification step.
+    attr_accessor :fields_to_collect
+
+    # The IP addresses used to access this CLEAR verification session.
+    attr_accessor :ip
+
+    # The individual's verified phone number, normalized to international E.164 format.
+    attr_accessor :phone
+
+    # The CLEAR verification session status.              Known values: - success - fail - awaiting_user_input - deferred - processing_data - expired - awaiting_manual_review - manual_success - manual_fail - canceled
+    attr_accessor :status
+
+    # The time the CLEAR verification session was most recently updated, as a UTC timestamp.
+    attr_accessor :updated_at
+
+    # The browser user agents that accessed this CLEAR verification session.
+    attr_accessor :user_agent
+
+    # Whether CLEAR created a new individual account during this session.
+    attr_accessor :user_created
+
+    # The CLEAR identifier for the individual.
+    attr_accessor :user_id
+
+    # The individual traits CLEAR returned after collecting enough information to make a decision.
+    attr_accessor :traits
+
+    # The identity verification status.              Known documented value: - verified: CLEAR indicates the individual is verified.
+    attr_accessor :idv_status
+
+    # Frontend session metadata CLEAR collected.
+    attr_accessor :sessions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'authenticated' => :'authenticated',
+        :'authentication_methods' => :'authenticationMethods',
+        :'activated_authentication_methods' => :'activatedAuthenticationMethods',
+        :'checks' => :'checks',
+        :'check_metadata' => :'checkMetadata',
+        :'completed_at' => :'completedAt',
+        :'created_at' => :'createdAt',
+        :'email' => :'email',
+        :'expires_at' => :'expiresAt',
+        :'fields_to_collect' => :'fieldsToCollect',
+        :'ip' => :'ip',
+        :'phone' => :'phone',
+        :'status' => :'status',
+        :'updated_at' => :'updatedAt',
+        :'user_agent' => :'userAgent',
+        :'user_created' => :'userCreated',
+        :'user_id' => :'userId',
+        :'traits' => :'traits',
+        :'idv_status' => :'idvStatus',
+        :'sessions' => :'sessions'
+      }
+    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
+      {
+        :'authenticated' => :'Boolean',
+        :'authentication_methods' => :'Array<String>',
+        :'activated_authentication_methods' => :'Array<String>',
+        :'checks' => :'Array<ClearProviderOutputCheck>',
+        :'check_metadata' => :'Array<String>',
+        :'completed_at' => :'Time',
+        :'created_at' => :'Time',
+        :'email' => :'String',
+        :'expires_at' => :'Time',
+        :'fields_to_collect' => :'Array<String>',
+        :'ip' => :'Array<String>',
+        :'phone' => :'String',
+        :'status' => :'String',
+        :'updated_at' => :'Time',
+        :'user_agent' => :'Array<String>',
+        :'user_created' => :'Boolean',
+        :'user_id' => :'String',
+        :'traits' => :'ClearProviderOutputTraits',
+        :'idv_status' => :'String',
+        :'sessions' => :'Array<ClearProviderOutputSessionInfo>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'authenticated',
+        :'authentication_methods',
+        :'activated_authentication_methods',
+        :'checks',
+        :'check_metadata',
+        :'completed_at',
+        :'created_at',
+        :'email',
+        :'expires_at',
+        :'fields_to_collect',
+        :'ip',
+        :'phone',
+        :'status',
+        :'updated_at',
+        :'user_agent',
+        :'user_created',
+        :'user_id',
+        :'traits',
+        :'idv_status',
+        :'sessions'
+      ])
+    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::ClearProviderOutput` 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::ClearProviderOutput`. 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?(:'authenticated')
+        self.authenticated = attributes[:'authenticated']
+      end
+
+      if attributes.key?(:'authentication_methods')
+        if (value = attributes[:'authentication_methods']).is_a?(Array)
+          self.authentication_methods = value
+        end
+      end
+
+      if attributes.key?(:'activated_authentication_methods')
+        if (value = attributes[:'activated_authentication_methods']).is_a?(Array)
+          self.activated_authentication_methods = value
+        end
+      end
+
+      if attributes.key?(:'checks')
+        if (value = attributes[:'checks']).is_a?(Array)
+          self.checks = value
+        end
+      end
+
+      if attributes.key?(:'check_metadata')
+        if (value = attributes[:'check_metadata']).is_a?(Array)
+          self.check_metadata = value
+        end
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'fields_to_collect')
+        if (value = attributes[:'fields_to_collect']).is_a?(Array)
+          self.fields_to_collect = value
+        end
+      end
+
+      if attributes.key?(:'ip')
+        if (value = attributes[:'ip']).is_a?(Array)
+          self.ip = value
+        end
+      end
+
+      if attributes.key?(:'phone')
+        self.phone = attributes[:'phone']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'user_agent')
+        if (value = attributes[:'user_agent']).is_a?(Array)
+          self.user_agent = value
+        end
+      end
+
+      if attributes.key?(:'user_created')
+        self.user_created = attributes[:'user_created']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'traits')
+        self.traits = attributes[:'traits']
+      end
+
+      if attributes.key?(:'idv_status')
+        self.idv_status = attributes[:'idv_status']
+      end
+
+      if attributes.key?(:'sessions')
+        if (value = attributes[:'sessions']).is_a?(Array)
+          self.sessions = value
+        end
+      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 &&
+          authenticated == o.authenticated &&
+          authentication_methods == o.authentication_methods &&
+          activated_authentication_methods == o.activated_authentication_methods &&
+          checks == o.checks &&
+          check_metadata == o.check_metadata &&
+          completed_at == o.completed_at &&
+          created_at == o.created_at &&
+          email == o.email &&
+          expires_at == o.expires_at &&
+          fields_to_collect == o.fields_to_collect &&
+          ip == o.ip &&
+          phone == o.phone &&
+          status == o.status &&
+          updated_at == o.updated_at &&
+          user_agent == o.user_agent &&
+          user_created == o.user_created &&
+          user_id == o.user_id &&
+          traits == o.traits &&
+          idv_status == o.idv_status &&
+          sessions == o.sessions
+    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
+      [authenticated, authentication_methods, activated_authentication_methods, checks, check_metadata, completed_at, created_at, email, expires_at, fields_to_collect, ip, phone, status, updated_at, user_agent, user_created, user_id, traits, idv_status, sessions].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/{verimi_address_output.rb → clear_provider_output_address.rb}

@@ -14,34 +14,34 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class VerimiAddressOutput < ApiModelBase
-    # The formatted address.
-    attr_accessor :full_address
+  class ClearProviderOutputAddress < ApiModelBase
+    # The first line of the address.
+    attr_accessor :line1
 
-    # The ISO 3166-1 alpha-2 country code.
-    attr_accessor :country_code
+    # The second line of the address, such as an apartment or suite.
+    attr_accessor :line2
 
-    # The postal code.
-    attr_accessor :postal_code
+    # The city.
+    attr_accessor :city
 
-    # The street name.
-    attr_accessor :street
+    # The state, province, or region.
+    attr_accessor :state
 
-    # The building number.
-    attr_accessor :building_number
+    # The postal code.
+    attr_accessor :postal_code
 
-    # The city.
-    attr_accessor :city
+    # The ISO 3166-1 alpha-2 country code.
+    attr_accessor :country
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'full_address' => :'fullAddress',
-        :'country_code' => :'countryCode',
+        :'line1' => :'line1',
+        :'line2' => :'line2',
+        :'city' => :'city',
+        :'state' => :'state',
         :'postal_code' => :'postalCode',
-        :'street' => :'street',
-        :'building_number' => :'buildingNumber',
-        :'city' => :'city'
+        :'country' => :'country'
       }
     end
 
@@ -58,24 +58,24 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'full_address' => :'String',
-        :'country_code' => :'String',
+        :'line1' => :'String',
+        :'line2' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
         :'postal_code' => :'String',
-        :'street' => :'String',
-        :'building_number' => :'String',
-        :'city' => :'String'
+        :'country' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'full_address',
-        :'country_code',
+        :'line1',
+        :'line2',
+        :'city',
+        :'state',
         :'postal_code',
-        :'street',
-        :'building_number',
-        :'city'
+        :'country'
       ])
     end
 
@@ -83,40 +83,40 @@ 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::VerimiAddressOutput` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::ClearProviderOutputAddress` 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::VerimiAddressOutput`. 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::ClearProviderOutputAddress`. 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_address')
-        self.full_address = attributes[:'full_address']
+      if attributes.key?(:'line1')
+        self.line1 = attributes[:'line1']
       end
 
-      if attributes.key?(:'country_code')
-        self.country_code = attributes[:'country_code']
+      if attributes.key?(:'line2')
+        self.line2 = attributes[:'line2']
       end
 
-      if attributes.key?(:'postal_code')
-        self.postal_code = attributes[:'postal_code']
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
       end
 
-      if attributes.key?(:'street')
-        self.street = attributes[:'street']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
-      if attributes.key?(:'building_number')
-        self.building_number = attributes[:'building_number']
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
       end
 
-      if attributes.key?(:'city')
-        self.city = attributes[:'city']
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
       end
     end
 
@@ -140,12 +140,12 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          full_address == o.full_address &&
-          country_code == o.country_code &&
+          line1 == o.line1 &&
+          line2 == o.line2 &&
+          city == o.city &&
+          state == o.state &&
           postal_code == o.postal_code &&
-          street == o.street &&
-          building_number == o.building_number &&
-          city == o.city
+          country == o.country
     end
 
     # @see the `==` method
@@ -157,7 +157,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [full_address, country_code, postal_code, street, building_number, city].hash
+      [line1, line2, city, state, postal_code, country].hash
     end
 
     # Builds the object from hash