trinsic_api 3.2.0 → 3.3.0.pre.alpha2

data/lib/trinsic_api/models/trinsic_hpke_metadata.rb

@@ -0,0 +1,327 @@
+=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
+  class TrinsicHPKEMetadata < ApiModelBase
+    # The HPKE mode in use. Trinsic only currently supports the Basic mode.              There are four modes defined in the HPKE specification:              - Basic (0): Sender is not authenticated - PSK (1): Sender is authenticated by proving possession of a Pre-Shared Key (byte array) which the recipient also knows. - Auth (2): Sender is authenticated by proving possession of a Private Key, for which the recipient knows the corresponding Public Key. - AuthPSK (3): Sender is authenticated by proving possession of both a Pre-Shared Key and a Private Key.
+    attr_accessor :mode
+
+    # The Key Encapsulation Mechanism (KEM) used for the HPKE handshake.              Trinsic currently only supports the DHKEM(P256, HKDF-SHA256) KEM, meaning that only P-256 keys are supported.
+    attr_accessor :kem
+
+    # The Key Derivation Function (KDF) used for the HPKE handshake.              Trinsic currently only supports HKDF-SHA256.
+    attr_accessor :kdf
+
+    # The symmetric encryption cipher used for ciphertext encryption and decryption.              Trinsic currently only supports AES-128-GCM.
+    attr_accessor :aead
+
+    # SHA-256 hash of the `info` parameter used during HPKE encryption.              This is not used in HPKE directly.              This is provided as a helper for debugging and development purposes, to verify that the same `info` hash is being used by both Trinsic and your integration.
+    attr_accessor :info_hash
+
+    # SHA-256 hash of the recipient's P-256 public key in raw uncompressed point encoding ([0x04][X][Y]).              This is not used in HPKE directly.              Use this to verify that an HPKE message was encrypted against your public key, and/or to identify which of your keys a message was encrypted against, before proceeding with decryption.              This and `recipientPublicKeyJwkThumbprint` are both effectively hashes of the recipient's (your) public key. Either is appropriate to use for the same purpose.
+    attr_accessor :recipient_public_key_hash
+
+    # JWK Thumbprint of the recipient's P-256 public key, in base64url encoding.              This is not used in HPKE directly.              Use this to verify that an HPKE message was encrypted against your public key, and/or to identify which of your keys a message was encrypted against, before proceeding with decryption.              This and `recipientPublicKeyHash` are both effectively hashes of the recipient's (your) public key. Either is appropriate to use for the same purpose.
+    attr_accessor :recipient_public_key_jwk_thumbprint
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'mode' => :'mode',
+        :'kem' => :'kem',
+        :'kdf' => :'kdf',
+        :'aead' => :'aead',
+        :'info_hash' => :'infoHash',
+        :'recipient_public_key_hash' => :'recipientPublicKeyHash',
+        :'recipient_public_key_jwk_thumbprint' => :'recipientPublicKeyJwkThumbprint'
+      }
+    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
+      {
+        :'mode' => :'Integer',
+        :'kem' => :'Integer',
+        :'kdf' => :'Integer',
+        :'aead' => :'Integer',
+        :'info_hash' => :'String',
+        :'recipient_public_key_hash' => :'String',
+        :'recipient_public_key_jwk_thumbprint' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::TrinsicHPKEMetadata` 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::TrinsicHPKEMetadata`. 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?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'kem')
+        self.kem = attributes[:'kem']
+      else
+        self.kem = nil
+      end
+
+      if attributes.key?(:'kdf')
+        self.kdf = attributes[:'kdf']
+      else
+        self.kdf = nil
+      end
+
+      if attributes.key?(:'aead')
+        self.aead = attributes[:'aead']
+      else
+        self.aead = nil
+      end
+
+      if attributes.key?(:'info_hash')
+        self.info_hash = attributes[:'info_hash']
+      else
+        self.info_hash = nil
+      end
+
+      if attributes.key?(:'recipient_public_key_hash')
+        self.recipient_public_key_hash = attributes[:'recipient_public_key_hash']
+      else
+        self.recipient_public_key_hash = nil
+      end
+
+      if attributes.key?(:'recipient_public_key_jwk_thumbprint')
+        self.recipient_public_key_jwk_thumbprint = attributes[:'recipient_public_key_jwk_thumbprint']
+      else
+        self.recipient_public_key_jwk_thumbprint = nil
+      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 @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode cannot be nil.')
+      end
+
+      if @kem.nil?
+        invalid_properties.push('invalid value for "kem", kem cannot be nil.')
+      end
+
+      if @kdf.nil?
+        invalid_properties.push('invalid value for "kdf", kdf cannot be nil.')
+      end
+
+      if @aead.nil?
+        invalid_properties.push('invalid value for "aead", aead cannot be nil.')
+      end
+
+      if @info_hash.nil?
+        invalid_properties.push('invalid value for "info_hash", info_hash cannot be nil.')
+      end
+
+      if @recipient_public_key_hash.nil?
+        invalid_properties.push('invalid value for "recipient_public_key_hash", recipient_public_key_hash cannot be nil.')
+      end
+
+      if @recipient_public_key_jwk_thumbprint.nil?
+        invalid_properties.push('invalid value for "recipient_public_key_jwk_thumbprint", recipient_public_key_jwk_thumbprint cannot be nil.')
+      end
+
+      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'
+      return false if @mode.nil?
+      return false if @kem.nil?
+      return false if @kdf.nil?
+      return false if @aead.nil?
+      return false if @info_hash.nil?
+      return false if @recipient_public_key_hash.nil?
+      return false if @recipient_public_key_jwk_thumbprint.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mode Value to be assigned
+    def mode=(mode)
+      if mode.nil?
+        fail ArgumentError, 'mode cannot be nil'
+      end
+
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kem Value to be assigned
+    def kem=(kem)
+      if kem.nil?
+        fail ArgumentError, 'kem cannot be nil'
+      end
+
+      @kem = kem
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kdf Value to be assigned
+    def kdf=(kdf)
+      if kdf.nil?
+        fail ArgumentError, 'kdf cannot be nil'
+      end
+
+      @kdf = kdf
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] aead Value to be assigned
+    def aead=(aead)
+      if aead.nil?
+        fail ArgumentError, 'aead cannot be nil'
+      end
+
+      @aead = aead
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] info_hash Value to be assigned
+    def info_hash=(info_hash)
+      if info_hash.nil?
+        fail ArgumentError, 'info_hash cannot be nil'
+      end
+
+      @info_hash = info_hash
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_public_key_hash Value to be assigned
+    def recipient_public_key_hash=(recipient_public_key_hash)
+      if recipient_public_key_hash.nil?
+        fail ArgumentError, 'recipient_public_key_hash cannot be nil'
+      end
+
+      @recipient_public_key_hash = recipient_public_key_hash
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient_public_key_jwk_thumbprint Value to be assigned
+    def recipient_public_key_jwk_thumbprint=(recipient_public_key_jwk_thumbprint)
+      if recipient_public_key_jwk_thumbprint.nil?
+        fail ArgumentError, 'recipient_public_key_jwk_thumbprint cannot be nil'
+      end
+
+      @recipient_public_key_jwk_thumbprint = recipient_public_key_jwk_thumbprint
+    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 &&
+          mode == o.mode &&
+          kem == o.kem &&
+          kdf == o.kdf &&
+          aead == o.aead &&
+          info_hash == o.info_hash &&
+          recipient_public_key_hash == o.recipient_public_key_hash &&
+          recipient_public_key_jwk_thumbprint == o.recipient_public_key_jwk_thumbprint
+    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
+      [mode, kem, kdf, aead, info_hash, recipient_public_key_hash, recipient_public_key_jwk_thumbprint].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/trinsic_test_database_lookup_input.rb

@@ -24,7 +24,7 @@ module TrinsicApi
     # A 6-digit code; must be \"123456\" for the Session to succeed.              This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user.              Any other value will cause the Session to fail.
     attr_accessor :identity_code
 
-    # An optional selfie image, base64-encoded.              Will replace the existing test selfie attachment output if provided.
+    # An optional selfie image in a Base64 string.              Will replace the existing test selfie attachment output if provided.
     attr_accessor :selfie_base64
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/uganda_nid_match2_date_of_birth_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/uganda_nid_match2_national_id_number_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/uganda_nid_match2_provider_output.rb

@@ -56,6 +56,9 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'national_id_number',
+        :'secondary_id_number',
+        :'date_of_birth'
       ])
     end
 
@@ -77,20 +80,14 @@ module TrinsicApi
 
       if attributes.key?(:'national_id_number')
         self.national_id_number = attributes[:'national_id_number']
-      else
-        self.national_id_number = nil
       end
 
       if attributes.key?(:'secondary_id_number')
         self.secondary_id_number = attributes[:'secondary_id_number']
-      else
-        self.secondary_id_number = nil
       end
 
       if attributes.key?(:'date_of_birth')
         self.date_of_birth = attributes[:'date_of_birth']
-      else
-        self.date_of_birth = nil
       end
     end
 
@@ -99,18 +96,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @national_id_number.nil?
-        invalid_properties.push('invalid value for "national_id_number", national_id_number cannot be nil.')
-      end
-
-      if @secondary_id_number.nil?
-        invalid_properties.push('invalid value for "secondary_id_number", secondary_id_number cannot be nil.')
-      end
-
-      if @date_of_birth.nil?
-        invalid_properties.push('invalid value for "date_of_birth", date_of_birth cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -118,42 +103,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @national_id_number.nil?
-      return false if @secondary_id_number.nil?
-      return false if @date_of_birth.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] national_id_number Value to be assigned
-    def national_id_number=(national_id_number)
-      if national_id_number.nil?
-        fail ArgumentError, 'national_id_number cannot be nil'
-      end
-
-      @national_id_number = national_id_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] secondary_id_number Value to be assigned
-    def secondary_id_number=(secondary_id_number)
-      if secondary_id_number.nil?
-        fail ArgumentError, 'secondary_id_number cannot be nil'
-      end
-
-      @secondary_id_number = secondary_id_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] date_of_birth Value to be assigned
-    def date_of_birth=(date_of_birth)
-      if date_of_birth.nil?
-        fail ArgumentError, 'date_of_birth cannot be nil'
-      end
-
-      @date_of_birth = date_of_birth
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/uganda_nid_match2_secondary_id_number_field.rb

@@ -50,6 +50,8 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'input_value',
+        :'outcome'
       ])
     end
 
@@ -71,14 +73,10 @@ module TrinsicApi
 
       if attributes.key?(:'input_value')
         self.input_value = attributes[:'input_value']
-      else
-        self.input_value = nil
       end
 
       if attributes.key?(:'outcome')
         self.outcome = attributes[:'outcome']
-      else
-        self.outcome = nil
       end
     end
 
@@ -87,14 +85,6 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @input_value.nil?
-        invalid_properties.push('invalid value for "input_value", input_value cannot be nil.')
-      end
-
-      if @outcome.nil?
-        invalid_properties.push('invalid value for "outcome", outcome cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,31 +92,9 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @input_value.nil?
-      return false if @outcome.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] input_value Value to be assigned
-    def input_value=(input_value)
-      if input_value.nil?
-        fail ArgumentError, 'input_value cannot be nil'
-      end
-
-      @input_value = input_value
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] outcome Value to be assigned
-    def outcome=(outcome)
-      if outcome.nil?
-        fail ArgumentError, 'outcome cannot be nil'
-      end
-
-      @outcome = outcome
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/uk_evisa_lookup_input.rb

@@ -15,7 +15,7 @@ require 'time'
 
 module TrinsicApi
   class UkEvisaLookupInput < ApiModelBase
-    # The 9-character share code.
+    # The 9-character alphanumeric UK Visas and Immigration (UKVI) share code. Must start with W for right to work, R for right to rent, or S for immigration status, matching the configured lookup type. Whitespace is removed and lowercase ASCII letters are converted to uppercase.
     attr_accessor :share_code
 
     # The user's date of birth, in `YYYY-MM-DD` format.