trinsic_api 2.0.3 → 2.1.0.pre.alpha1

data/lib/trinsic_api/models/contract_field.rb

@@ -0,0 +1,288 @@
+=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
+  # Information about a field that a Provider will return in verification results.
+  class ContractField
+    # The name of the field as it appears in verification results.
+    attr_accessor :name
+
+    # Indicates when this field will be present in verification results.
+    attr_accessor :outputted
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'outputted' => :'outputted'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'outputted' => :'FieldAvailability'
+      }
+    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::ContractField` 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::ContractField`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'outputted')
+        self.outputted = attributes[:'outputted']
+      else
+        self.outputted = 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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @outputted.nil?
+        invalid_properties.push('invalid value for "outputted", outputted 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 @name.nil?
+      return false if @outputted.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] outputted Value to be assigned
+    def outputted=(outputted)
+      if outputted.nil?
+        fail ArgumentError, 'outputted cannot be nil'
+      end
+
+      @outputted = outputted
+    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 &&
+          name == o.name &&
+          outputted == o.outputted
+    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
+      [name, outputted].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/create_advanced_provider_session_request.rb

@@ -18,9 +18,6 @@ module TrinsicApi
     # The ID of the provider to launch
     attr_accessor :provider
 
-    # Provider-specific input for those providers which require it.
-    attr_accessor :provider_input
-
     # The Redirect URL to which the user should be sent after the session is complete.              This field is required for providers which employ a redirect-based flow.
     attr_accessor :redirect_url
 
@@ -30,14 +27,17 @@ 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
 
+    # Provider-specific input for those providers which require it.
+    attr_accessor :provider_input
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'provider' => :'provider',
-        :'provider_input' => :'providerInput',
         :'redirect_url' => :'redirectUrl',
         :'capabilities' => :'capabilities',
-        :'fallback_to_hosted_ui' => :'fallbackToHostedUI'
+        :'fallback_to_hosted_ui' => :'fallbackToHostedUI',
+        :'provider_input' => :'providerInput'
       }
     end
 
@@ -55,19 +55,19 @@ module TrinsicApi
     def self.openapi_types
       {
         :'provider' => :'String',
-        :'provider_input' => :'ProviderInput',
         :'redirect_url' => :'String',
         :'capabilities' => :'Array<IntegrationCapability>',
-        :'fallback_to_hosted_ui' => :'Boolean'
+        :'fallback_to_hosted_ui' => :'Boolean',
+        :'provider_input' => :'ProviderInput'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'provider_input',
         :'redirect_url',
-        :'fallback_to_hosted_ui'
+        :'fallback_to_hosted_ui',
+        :'provider_input'
       ])
     end
 
@@ -93,10 +93,6 @@ module TrinsicApi
         self.provider = nil
       end
 
-      if attributes.key?(:'provider_input')
-        self.provider_input = attributes[:'provider_input']
-      end
-
       if attributes.key?(:'redirect_url')
         self.redirect_url = attributes[:'redirect_url']
       end
@@ -112,6 +108,10 @@ module TrinsicApi
       if attributes.key?(:'fallback_to_hosted_ui')
         self.fallback_to_hosted_ui = attributes[:'fallback_to_hosted_ui']
       end
+
+      if attributes.key?(:'provider_input')
+        self.provider_input = attributes[:'provider_input']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -183,10 +183,10 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           provider == o.provider &&
-          provider_input == o.provider_input &&
           redirect_url == o.redirect_url &&
           capabilities == o.capabilities &&
-          fallback_to_hosted_ui == o.fallback_to_hosted_ui
+          fallback_to_hosted_ui == o.fallback_to_hosted_ui &&
+          provider_input == o.provider_input
     end
 
     # @see the `==` method
@@ -198,7 +198,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [provider, provider_input, redirect_url, capabilities, fallback_to_hosted_ui].hash
+      [provider, redirect_url, capabilities, fallback_to_hosted_ui, provider_input].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/create_hosted_provider_session_request.rb

@@ -21,7 +21,7 @@ module TrinsicApi
     # The Redirect URL to which the user should be sent after the session is complete.
     attr_accessor :redirect_url
 
-    # Provider-specific input for those providers which require it.
+    # 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 Advanced Session endpoint instead.
     attr_accessor :provider_input
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/document_type.rb

@@ -19,9 +19,10 @@ module TrinsicApi
     DRIVERS_LICENSE = "DriversLicense".freeze
     NATIONAL_ID = "NationalId".freeze
     ID_CARD = "IdCard".freeze
+    OTHER = "Other".freeze
 
     def self.all_vars
-      @all_vars ||= [PASSPORT, DRIVERS_LICENSE, NATIONAL_ID, ID_CARD].freeze
+      @all_vars ||= [PASSPORT, DRIVERS_LICENSE, NATIONAL_ID, ID_CARD, OTHER].freeze
     end
 
     # Builds the enum from string

data/lib/trinsic_api/models/field_availability.rb

@@ -0,0 +1,41 @@
+=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
+  class FieldAvailability
+    NEVER = "Never".freeze
+    SOMETIMES = "Sometimes".freeze
+    ALWAYS = "Always".freeze
+
+    def self.all_vars
+      @all_vars ||= [NEVER, SOMETIMES, ALWAYS].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if FieldAvailability.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #FieldAvailability"
+    end
+  end
+end

data/lib/trinsic_api/models/integration_capability.rb

@@ -21,9 +21,10 @@ module TrinsicApi
     REFRESH_STEP_CONTENT = "RefreshStepContent".freeze
     CAPTURE_REDIRECT = "CaptureRedirect".freeze
     POLL_RESULT = "PollResult".freeze
+    POLL_AFTER_REDIRECT = "PollAfterRedirect".freeze
 
     def self.all_vars
-      @all_vars ||= [LAUNCH_BROWSER, DEEPLINK_TO_MOBILE, SHOW_CONTENT, REFRESH_STEP_CONTENT, CAPTURE_REDIRECT, POLL_RESULT].freeze
+      @all_vars ||= [LAUNCH_BROWSER, DEEPLINK_TO_MOBILE, SHOW_CONTENT, REFRESH_STEP_CONTENT, CAPTURE_REDIRECT, POLL_RESULT, POLL_AFTER_REDIRECT].freeze
     end
 
     # Builds the enum from string

data/lib/trinsic_api/models/provider_contract.rb

@@ -21,6 +21,9 @@ module TrinsicApi
     # The Provider's Name as it appears in Trinsic's Dashboard and Widget
     attr_accessor :name
 
+    # The Provider's subtext recommended to be shown next to the name.              This is flavor text, not a full, human-readable description of the provider.
+    attr_accessor :subtext
+
     # The Provider's description as it appears in Trinsic's Widget.              This is flavor text, not a full, human-readable description of the provider.
     attr_accessor :description
 
@@ -42,7 +45,7 @@ module TrinsicApi
     # Relevant only to Advanced Provider Sessions.              The `CollectionMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
     attr_accessor :collection_method
 
-    # If `true`, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the `GetSessionResults` API must be called until results are available.              This is an uncommon scenario, and typically only applies to Providers which use a biometric check or traditional document scan.
+    # If `true`, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the `GetSessionResults` API must be called until results are available.              This is an uncommon scenario, and only applies to Providers which cannot guarantee the availability of results immediately after the user is redirected back to your application.
     attr_accessor :results_may_be_delayed_after_redirect
 
     # Relevant only to Advanced Provider Sessions.              Whether the Provider requires the `RefreshStepContent` capability.              For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow.
@@ -57,6 +60,9 @@ module TrinsicApi
     # Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API.              If `false`, the Provider may still be launched through Advanced Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function.
     attr_accessor :supports_advanced_provider_sessions
 
+    # Information about the fields that this Provider will return in verification results.
+    attr_accessor :available_fields
+
     # Metadata about the sub-providers which are available for this Provider.              For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
     attr_accessor :sub_providers
 
@@ -90,6 +96,7 @@ module TrinsicApi
       {
         :'id' => :'id',
         :'name' => :'name',
+        :'subtext' => :'subtext',
         :'description' => :'description',
         :'logo_url' => :'logoUrl',
         :'available' => :'available',
@@ -102,6 +109,7 @@ module TrinsicApi
         :'requires_input' => :'requiresInput',
         :'has_trinsic_interface' => :'hasTrinsicInterface',
         :'supports_advanced_provider_sessions' => :'supportsAdvancedProviderSessions',
+        :'available_fields' => :'availableFields',
         :'sub_providers' => :'subProviders',
         :'health' => :'health'
       }
@@ -122,6 +130,7 @@ module TrinsicApi
       {
         :'id' => :'String',
         :'name' => :'String',
+        :'subtext' => :'String',
         :'description' => :'String',
         :'logo_url' => :'String',
         :'available' => :'Boolean',
@@ -134,6 +143,7 @@ module TrinsicApi
         :'requires_input' => :'Boolean',
         :'has_trinsic_interface' => :'Boolean',
         :'supports_advanced_provider_sessions' => :'Boolean',
+        :'available_fields' => :'Array<ContractField>',
         :'sub_providers' => :'Array<SubProviderMetadata>',
         :'health' => :'ProviderHealth'
       }
@@ -142,6 +152,7 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'available_fields',
         :'sub_providers',
       ])
     end
@@ -174,6 +185,12 @@ module TrinsicApi
         self.name = nil
       end
 
+      if attributes.key?(:'subtext')
+        self.subtext = attributes[:'subtext']
+      else
+        self.subtext = nil
+      end
+
       if attributes.key?(:'description')
         self.description = attributes[:'description']
       else
@@ -250,6 +267,12 @@ module TrinsicApi
         self.supports_advanced_provider_sessions = nil
       end
 
+      if attributes.key?(:'available_fields')
+        if (value = attributes[:'available_fields']).is_a?(Array)
+          self.available_fields = value
+        end
+      end
+
       if attributes.key?(:'sub_providers')
         if (value = attributes[:'sub_providers']).is_a?(Array)
           self.sub_providers = value
@@ -276,6 +299,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
+      if @subtext.nil?
+        invalid_properties.push('invalid value for "subtext", subtext cannot be nil.')
+      end
+
       if @description.nil?
         invalid_properties.push('invalid value for "description", description cannot be nil.')
       end
@@ -337,6 +364,7 @@ module TrinsicApi
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @name.nil?
+      return false if @subtext.nil?
       return false if @description.nil?
       return false if @logo_url.nil?
       return false if @available.nil?
@@ -373,6 +401,16 @@ module TrinsicApi
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] subtext Value to be assigned
+    def subtext=(subtext)
+      if subtext.nil?
+        fail ArgumentError, 'subtext cannot be nil'
+      end
+
+      @subtext = subtext
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] description Value to be assigned
     def description=(description)
@@ -510,6 +548,7 @@ module TrinsicApi
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          subtext == o.subtext &&
           description == o.description &&
           logo_url == o.logo_url &&
           available == o.available &&
@@ -522,6 +561,7 @@ module TrinsicApi
           requires_input == o.requires_input &&
           has_trinsic_interface == o.has_trinsic_interface &&
           supports_advanced_provider_sessions == o.supports_advanced_provider_sessions &&
+          available_fields == o.available_fields &&
           sub_providers == o.sub_providers &&
           health == o.health
     end
@@ -535,7 +575,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, description, logo_url, available, geography, regions, launch_method, collection_method, results_may_be_delayed_after_redirect, has_refreshable_content, requires_input, has_trinsic_interface, supports_advanced_provider_sessions, sub_providers, health].hash
+      [id, name, subtext, description, logo_url, available, geography, regions, launch_method, collection_method, results_may_be_delayed_after_redirect, has_refreshable_content, requires_input, has_trinsic_interface, supports_advanced_provider_sessions, available_fields, sub_providers, health].hash
     end
 
     # Builds the object from hash