trinsic_api 3.0.0 → 3.0.2.pre.preview

data/lib/trinsic_api/models/united_kingdom_evisa_provider_output.rb

@@ -0,0 +1,333 @@
+=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
+  # Exposed properties for the `uk-evisa-lookup` Provider which do not directly map to the normalized IdentityData model.
+  class UnitedKingdomEvisaProviderOutput
+    # The first name of the individual as recorded on the eVisa.
+    attr_accessor :first_name
+
+    # The last name of the individual as recorded on the eVisa.
+    attr_accessor :last_name
+
+    # The date of birth of the individual.
+    attr_accessor :date_of_birth
+
+    # The 9-character share code used for the verification.
+    attr_accessor :share_code
+
+    # The eVisa reference number issued by UK Visas and Immigration (UKVI).
+    attr_accessor :reference_number
+
+    # The expiration date of the eVisa. Only present for immigration_status verifications.
+    attr_accessor :expiration_date
+
+    # The start date from which the eVisa is valid. Only returned for immigration_status and right_to_rent verifications — not returned for right_to_work.
+    attr_accessor :valid_from
+
+    # The nationality of the individual as recorded on the eVisa. Only present for immigration_status verifications.
+    attr_accessor :nationality
+
+    # The immigration status of the individual. Only present for immigration_status verifications. This is a personalized record for each individual, and there is no single definitive list. Some common values: - Settled - Pre-settled - Student - Graduate - Youth Mobility - Global Talent - Skilled Worker - Limited leave
+    attr_accessor :immigration_status
+
+    # Overall verification outcome: \"pass\" or \"fail\".
+    attr_accessor :outcome
+
+    # Type of verification. List of possible values: - immigration_status - right_to_work - right_to_rent
+    attr_accessor :evidence_type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'date_of_birth' => :'dateOfBirth',
+        :'share_code' => :'shareCode',
+        :'reference_number' => :'referenceNumber',
+        :'expiration_date' => :'expirationDate',
+        :'valid_from' => :'validFrom',
+        :'nationality' => :'nationality',
+        :'immigration_status' => :'immigrationStatus',
+        :'outcome' => :'outcome',
+        :'evidence_type' => :'evidenceType'
+      }
+    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
+      {
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'date_of_birth' => :'Date',
+        :'share_code' => :'String',
+        :'reference_number' => :'String',
+        :'expiration_date' => :'Date',
+        :'valid_from' => :'Date',
+        :'nationality' => :'String',
+        :'immigration_status' => :'String',
+        :'outcome' => :'String',
+        :'evidence_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'first_name',
+        :'last_name',
+        :'date_of_birth',
+        :'share_code',
+        :'reference_number',
+        :'expiration_date',
+        :'valid_from',
+        :'nationality',
+        :'immigration_status',
+        :'outcome',
+        :'evidence_type'
+      ])
+    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::UnitedKingdomEvisaProviderOutput` 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::UnitedKingdomEvisaProviderOutput`. 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?(:'first_name')
+        self.first_name = attributes[:'first_name']
+      end
+
+      if attributes.key?(:'last_name')
+        self.last_name = attributes[:'last_name']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'share_code')
+        self.share_code = attributes[:'share_code']
+      end
+
+      if attributes.key?(:'reference_number')
+        self.reference_number = attributes[:'reference_number']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      end
+
+      if attributes.key?(:'valid_from')
+        self.valid_from = attributes[:'valid_from']
+      end
+
+      if attributes.key?(:'nationality')
+        self.nationality = attributes[:'nationality']
+      end
+
+      if attributes.key?(:'immigration_status')
+        self.immigration_status = attributes[:'immigration_status']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'evidence_type')
+        self.evidence_type = attributes[:'evidence_type']
+      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 &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          date_of_birth == o.date_of_birth &&
+          share_code == o.share_code &&
+          reference_number == o.reference_number &&
+          expiration_date == o.expiration_date &&
+          valid_from == o.valid_from &&
+          nationality == o.nationality &&
+          immigration_status == o.immigration_status &&
+          outcome == o.outcome &&
+          evidence_type == o.evidence_type
+    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
+      [first_name, last_name, date_of_birth, share_code, reference_number, expiration_date, valid_from, nationality, immigration_status, outcome, evidence_type].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/verification_profile_response.rb

@@ -33,6 +33,9 @@ module TrinsicApi
     # The providers that are currently enabled for the verification profile.
     attr_accessor :enabled_providers
 
+    # The session expiration for verification sessions created with this profile.
+    attr_accessor :session_expiration
+
     # Whether this profile is for production usage. Only applicable for Live environment profiles.
     attr_accessor :is_production_usage
 
@@ -45,6 +48,7 @@ module TrinsicApi
         :'logo_url' => :'logoUrl',
         :'primary_color' => :'primaryColor',
         :'enabled_providers' => :'enabledProviders',
+        :'session_expiration' => :'sessionExpiration',
         :'is_production_usage' => :'isProductionUsage'
       }
     end
@@ -68,6 +72,7 @@ module TrinsicApi
         :'logo_url' => :'String',
         :'primary_color' => :'String',
         :'enabled_providers' => :'Array<String>',
+        :'session_expiration' => :'String',
         :'is_production_usage' => :'Boolean'
       }
     end
@@ -132,6 +137,12 @@ module TrinsicApi
         self.enabled_providers = nil
       end
 
+      if attributes.key?(:'session_expiration')
+        self.session_expiration = attributes[:'session_expiration']
+      else
+        self.session_expiration = nil
+      end
+
       if attributes.key?(:'is_production_usage')
         self.is_production_usage = attributes[:'is_production_usage']
       else
@@ -168,6 +179,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "enabled_providers", enabled_providers cannot be nil.')
       end
 
+      if @session_expiration.nil?
+        invalid_properties.push('invalid value for "session_expiration", session_expiration cannot be nil.')
+      end
+
       if @is_production_usage.nil?
         invalid_properties.push('invalid value for "is_production_usage", is_production_usage cannot be nil.')
       end
@@ -185,6 +200,7 @@ module TrinsicApi
       return false if @logo_url.nil?
       return false if @primary_color.nil?
       return false if @enabled_providers.nil?
+      return false if @session_expiration.nil?
       return false if @is_production_usage.nil?
       true
     end
@@ -249,6 +265,16 @@ module TrinsicApi
       @enabled_providers = enabled_providers
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] session_expiration Value to be assigned
+    def session_expiration=(session_expiration)
+      if session_expiration.nil?
+        fail ArgumentError, 'session_expiration cannot be nil'
+      end
+
+      @session_expiration = session_expiration
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] is_production_usage Value to be assigned
     def is_production_usage=(is_production_usage)
@@ -270,6 +296,7 @@ module TrinsicApi
           logo_url == o.logo_url &&
           primary_color == o.primary_color &&
           enabled_providers == o.enabled_providers &&
+          session_expiration == o.session_expiration &&
           is_production_usage == o.is_production_usage
     end
 
@@ -282,7 +309,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, _alias, brand_name, logo_url, primary_color, enabled_providers, is_production_usage].hash
+      [id, _alias, brand_name, logo_url, primary_color, enabled_providers, session_expiration, is_production_usage].hash
     end
 
     # Builds the object from hash