trinsic_api 3.1.0 → 3.2.0

data/lib/trinsic_api/models/{south_africa_nid_biometric2_input.rb → brazil_cnh_match_field_date_only.rb}

@@ -14,22 +14,18 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class SouthAfricaNidBiometric2Input < ApiModelBase
-    # The user's South African National ID number
-    attr_accessor :id_number
+  class BrazilCnhMatchFieldDateOnly < ApiModelBase
+    # Decoded CNH QR Code value used for this match field.
+    attr_accessor :content
 
-    # An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size.
-    attr_accessor :liveness_images
-
-    # Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
-    attr_accessor :test_selfie
+    # Whether the decoded CNH QR Code value matched the government database.
+    attr_accessor :match_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_number' => :'idNumber',
-        :'liveness_images' => :'livenessImages',
-        :'test_selfie' => :'testSelfie'
+        :'content' => :'content',
+        :'match_value' => :'matchValue'
       }
     end
 
@@ -46,18 +42,15 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_number' => :'String',
-        :'liveness_images' => :'Array<String>',
-        :'test_selfie' => :'String'
+        :'content' => :'Date',
+        :'match_value' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id_number',
-        :'liveness_images',
-        :'test_selfie'
+        :'match_value'
       ])
     end
 
@@ -65,30 +58,26 @@ 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::SouthAfricaNidBiometric2Input` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::BrazilCnhMatchFieldDateOnly` 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::SouthAfricaNidBiometric2Input`. 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::BrazilCnhMatchFieldDateOnly`. 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']
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      else
+        self.content = nil
       end
 
-      if attributes.key?(:'liveness_images')
-        if (value = attributes[:'liveness_images']).is_a?(Array)
-          self.liveness_images = value
-        end
-      end
-
-      if attributes.key?(:'test_selfie')
-        self.test_selfie = attributes[:'test_selfie']
+      if attributes.key?(:'match_value')
+        self.match_value = attributes[:'match_value']
       end
     end
 
@@ -97,6 +86,10 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @content.nil?
+        invalid_properties.push('invalid value for "content", content cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -104,17 +97,27 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @content.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] content Value to be assigned
+    def content=(content)
+      if content.nil?
+        fail ArgumentError, 'content cannot be nil'
+      end
+
+      @content = content
+    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 &&
-          liveness_images == o.liveness_images &&
-          test_selfie == o.test_selfie
+          content == o.content &&
+          match_value == o.match_value
     end
 
     # @see the `==` method
@@ -126,7 +129,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_number, liveness_images, test_selfie].hash
+      [content, match_value].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/{nigeria_nin_biometric2_input.rb → brazil_cnh_match_field_string.rb}

@@ -14,22 +14,18 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class NigeriaNinBiometric2Input < ApiModelBase
-    # The user's Nigerian National ID number (NIN)
-    attr_accessor :id_number
+  class BrazilCnhMatchFieldString < ApiModelBase
+    # Decoded CNH QR Code value used for this match field.
+    attr_accessor :content
 
-    # An array of exactly 8 images required for biometric liveness verification. The first 7 images should be liveness frames captured during the liveness detection process, and the last image (8th) should be a selfie of the user. All images must be in JPEG format and each image must be less than 15MB in size.
-    attr_accessor :liveness_images
-
-    # Test selfie for test environment (optional, maximum 15MB). Must be JPEG format.
-    attr_accessor :test_selfie
+    # Whether the decoded CNH QR Code value matched the government database.
+    attr_accessor :match_value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id_number' => :'idNumber',
-        :'liveness_images' => :'livenessImages',
-        :'test_selfie' => :'testSelfie'
+        :'content' => :'content',
+        :'match_value' => :'matchValue'
       }
     end
 
@@ -46,18 +42,16 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id_number' => :'String',
-        :'liveness_images' => :'Array<String>',
-        :'test_selfie' => :'String'
+        :'content' => :'String',
+        :'match_value' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'id_number',
-        :'liveness_images',
-        :'test_selfie'
+        :'content',
+        :'match_value'
       ])
     end
 
@@ -65,30 +59,24 @@ 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::NigeriaNinBiometric2Input` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::BrazilCnhMatchFieldString` 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::NigeriaNinBiometric2Input`. 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::BrazilCnhMatchFieldString`. 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?(:'liveness_images')
-        if (value = attributes[:'liveness_images']).is_a?(Array)
-          self.liveness_images = value
-        end
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
       end
 
-      if attributes.key?(:'test_selfie')
-        self.test_selfie = attributes[:'test_selfie']
+      if attributes.key?(:'match_value')
+        self.match_value = attributes[:'match_value']
       end
     end
 
@@ -112,9 +100,8 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id_number == o.id_number &&
-          liveness_images == o.liveness_images &&
-          test_selfie == o.test_selfie
+          content == o.content &&
+          match_value == o.match_value
     end
 
     # @see the `==` method
@@ -126,7 +113,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id_number, liveness_images, test_selfie].hash
+      [content, match_value].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/brazil_cnh_provider_output.rb

@@ -0,0 +1,315 @@
+=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 `brazil-digital-cnh` Provider which do not directly map to the normalized IdentityData model.
+  class BrazilCnhProviderOutput < ApiModelBase
+    # Full name decoded from the CNH QR Code and whether it matched the government database.
+    attr_accessor :full_name
+
+    # Similarity score for the decoded full name from the CNH QR Code.              Ranges from 0.0 to 1.0, where 1.0 is an exact match.
+    attr_accessor :full_name_similarity
+
+    # Source identity document number/reference for the CNH record, decoded from the CNH QR Code.
+    attr_accessor :origin_document
+
+    # Date of birth decoded from the CNH QR Code and whether it matched the government database.
+    attr_accessor :date_of_birth
+
+    # Mother's full name decoded from the CNH QR Code.
+    attr_accessor :mother_full_name
+
+    # Father's full name decoded from the CNH QR Code.
+    attr_accessor :father_full_name
+
+    # Driver license category decoded from the CNH QR Code.              Known values: - A: Two- or three-wheeled motor vehicles, with or without a sidecar. - B: Motor vehicles outside category A up to 3,500 kg, with capacity for up to eight passengers besides the driver, and without articulation or trailer. - C: Category B vehicles and rigid cargo vehicles above 3,500 kg. - D: Category C vehicles and passenger vehicles with capacity above eight passengers besides the driver. - E: Category D vehicles, trailers, semi-trailers, and articulated buses.
+    attr_accessor :category
+
+    # National Registry (Registro Nacional de Habilitacao) number decoded from the CNH QR Code and whether it matched the government database.              Is an 11-character ID with the format XXXXXXXXX@@: - XXXXXXXXX: Base characters. The value is unique to the driver for their lifetime. - @@: Security check digits
+    attr_accessor :registration_number
+
+    # Whether the National Registry number satisfies the CNH modulo-11 check digit routine.
+    attr_accessor :registration_number_check_digits_valid
+
+    # Date when the driver was first licensed, decoded from the CNH QR Code.
+    attr_accessor :first_issue_date
+
+    # CNH observations decoded from the QR Code.              May include EAR for paid driving activity and one or more restriction codes: - A: Corrective lenses required. - B: Hearing prosthesis required. - C: Left-side accelerator required. - D: Automatic transmission vehicle required. - E: Steering-wheel grip, handle, or knob required. - F: Power steering vehicle required. - G: Manual clutch, automated clutch, or automatic transmission vehicle required. - H: Hand accelerator and brake required. - I: Dashboard control adaptations to the steering wheel required. - J: Dashboard control adaptations for lower limbs or other body parts required. - K: Gear-shift lever extension and/or fixed height/depth compensation cushions required. - L: Pedal extensions and floor elevation and/or fixed height/depth compensation cushions required. - M: Motorcycle with adapted gear-shift pedal required. - N: Motorcycle with adapted rear-brake pedal required. - O: Motorcycle with adapted front-brake handle required. - P: Motorcycle with adapted clutch handle required. - Q: Motorcycle with sidecar or tricycle required. - R: Scooter with sidecar or tricycle required. - S: Motorcycle with automated gear shifting required. - T: Driving on highways and high-speed roads prohibited. - U: Driving after sunset prohibited. - V: Helmet with visor and unrestricted field of vision required. - X: Other restrictions.
+    attr_accessor :observations
+
+    # City where the CNH was issued, decoded from the QR Code.
+    attr_accessor :issue_city
+
+    # Brazilian state where the CNH was issued, decoded from the QR Code.              Format is a two-letter Brazilian state abbreviation when present.
+    attr_accessor :issue_state
+
+    # Numeric security validation code decoded from the CNH QR Code.              This is an 11-digit code generated from Departamento Estadual de Trânsito (State Traffic Department or DETRAN) owned data for each CNH and used to validate the document. The algorithm is proprietary, so no further information is available on this number.
+    attr_accessor :validation_number
+
+    # Registro Nacional de Condutores Habilitados (RENACH) form number decoded from the CNH QR Code.              Is an 11-character ID with the format FFXXXXXXXX@: - FF: The issuing federation unit abbreviation. It identifies the state where the driver was licensed or last had record changes. - XXXXXXXXX: Serial number - @: Modulo-11 security check digit
+    attr_accessor :renach_number
+
+    # Facial biometric comparison result if submitted and available.
+    attr_accessor :facial_biometry
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'full_name' => :'fullName',
+        :'full_name_similarity' => :'fullNameSimilarity',
+        :'origin_document' => :'originDocument',
+        :'date_of_birth' => :'dateOfBirth',
+        :'mother_full_name' => :'motherFullName',
+        :'father_full_name' => :'fatherFullName',
+        :'category' => :'category',
+        :'registration_number' => :'registrationNumber',
+        :'registration_number_check_digits_valid' => :'registrationNumberCheckDigitsValid',
+        :'first_issue_date' => :'firstIssueDate',
+        :'observations' => :'observations',
+        :'issue_city' => :'issueCity',
+        :'issue_state' => :'issueState',
+        :'validation_number' => :'validationNumber',
+        :'renach_number' => :'renachNumber',
+        :'facial_biometry' => :'facialBiometry'
+      }
+    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' => :'BrazilCnhMatchFieldString',
+        :'full_name_similarity' => :'Float',
+        :'origin_document' => :'String',
+        :'date_of_birth' => :'BrazilCnhMatchFieldDateOnly',
+        :'mother_full_name' => :'String',
+        :'father_full_name' => :'String',
+        :'category' => :'String',
+        :'registration_number' => :'BrazilCnhMatchFieldString',
+        :'registration_number_check_digits_valid' => :'Boolean',
+        :'first_issue_date' => :'Date',
+        :'observations' => :'String',
+        :'issue_city' => :'String',
+        :'issue_state' => :'String',
+        :'validation_number' => :'String',
+        :'renach_number' => :'String',
+        :'facial_biometry' => :'BrazilCnhFacialBiometryOutput'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'full_name_similarity',
+        :'origin_document',
+        :'date_of_birth',
+        :'mother_full_name',
+        :'father_full_name',
+        :'category',
+        :'registration_number',
+        :'registration_number_check_digits_valid',
+        :'first_issue_date',
+        :'observations',
+        :'issue_city',
+        :'issue_state',
+        :'validation_number',
+        :'renach_number',
+        :'facial_biometry'
+      ])
+    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::BrazilCnhProviderOutput` 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::BrazilCnhProviderOutput`. 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?(:'full_name_similarity')
+        self.full_name_similarity = attributes[:'full_name_similarity']
+      end
+
+      if attributes.key?(:'origin_document')
+        self.origin_document = attributes[:'origin_document']
+      end
+
+      if attributes.key?(:'date_of_birth')
+        self.date_of_birth = attributes[:'date_of_birth']
+      end
+
+      if attributes.key?(:'mother_full_name')
+        self.mother_full_name = attributes[:'mother_full_name']
+      end
+
+      if attributes.key?(:'father_full_name')
+        self.father_full_name = attributes[:'father_full_name']
+      end
+
+      if attributes.key?(:'category')
+        self.category = attributes[:'category']
+      end
+
+      if attributes.key?(:'registration_number')
+        self.registration_number = attributes[:'registration_number']
+      end
+
+      if attributes.key?(:'registration_number_check_digits_valid')
+        self.registration_number_check_digits_valid = attributes[:'registration_number_check_digits_valid']
+      end
+
+      if attributes.key?(:'first_issue_date')
+        self.first_issue_date = attributes[:'first_issue_date']
+      end
+
+      if attributes.key?(:'observations')
+        self.observations = attributes[:'observations']
+      end
+
+      if attributes.key?(:'issue_city')
+        self.issue_city = attributes[:'issue_city']
+      end
+
+      if attributes.key?(:'issue_state')
+        self.issue_state = attributes[:'issue_state']
+      end
+
+      if attributes.key?(:'validation_number')
+        self.validation_number = attributes[:'validation_number']
+      end
+
+      if attributes.key?(:'renach_number')
+        self.renach_number = attributes[:'renach_number']
+      end
+
+      if attributes.key?(:'facial_biometry')
+        self.facial_biometry = attributes[:'facial_biometry']
+      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 &&
+          full_name_similarity == o.full_name_similarity &&
+          origin_document == o.origin_document &&
+          date_of_birth == o.date_of_birth &&
+          mother_full_name == o.mother_full_name &&
+          father_full_name == o.father_full_name &&
+          category == o.category &&
+          registration_number == o.registration_number &&
+          registration_number_check_digits_valid == o.registration_number_check_digits_valid &&
+          first_issue_date == o.first_issue_date &&
+          observations == o.observations &&
+          issue_city == o.issue_city &&
+          issue_state == o.issue_state &&
+          validation_number == o.validation_number &&
+          renach_number == o.renach_number &&
+          facial_biometry == o.facial_biometry
+    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, full_name_similarity, origin_document, date_of_birth, mother_full_name, father_full_name, category, registration_number, registration_number_check_digits_valid, first_issue_date, observations, issue_city, issue_state, validation_number, renach_number, facial_biometry].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/create_direct_provider_session_request.rb

@@ -30,7 +30,7 @@ module TrinsicApi
     # Whether the session should fall back to a Trinsic-hosted UI in certain instances.              Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for     - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete     - In this case, Trinsic's hosted UI will collect the necessary input from the user              If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect.              If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
     attr_accessor :fallback_to_hosted_ui
 
-    # Preferences for languages to show first if the session falls back to the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English. This only will be used if the session falls back to the Trinsic-hosted UI.
+    # Preferences for languages to show first in supported provider launch flows and, if the session falls back, in the Trinsic-hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English.
     attr_accessor :browser_languages
 
     # Provider-specific input for those providers which require it.

data/lib/trinsic_api/models/create_hosted_provider_session_request.rb

@@ -24,7 +24,7 @@ module TrinsicApi
     # The Redirect URL to which the user should be sent after the session is complete.
     attr_accessor :redirect_url
 
-    # Preferences for languages to show first in the Hosted UI. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English.
+    # Preferences for languages to show first in the Hosted UI and supported provider launch flows. If left empty, the Hosted UI defaults to the user's navigator languages. If no preferred language is available, the Hosted UI falls back to English.
     attr_accessor :browser_languages
 
     # Provider-specific input for those providers which require it.   <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Direct Session endpoint instead.