trinsic_api 3.0.1 → 3.1.0.pre.preview1

data/docs/CreateWidgetSessionRequest.md

@@ -1,24 +0,0 @@
-# TrinsicApi::CreateWidgetSessionRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. |  |
-| **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete.              *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as a popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
-| **providers** | **Array<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed. | [optional] |
-| **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Data that you already know about the user being verified.   This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::CreateWidgetSessionRequest.new(
-  verification_profile_id: null,
-  redirect_url: null,
-  providers: null,
-  recommendation_info: null
-)
-```
-

data/docs/CreateWidgetSessionResponse.md

@@ -1,22 +0,0 @@
-# TrinsicApi::CreateWidgetSessionResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **session_id** | **String** | The ID of the newly-created Acceptance Session |  |
-| **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user's device.              You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. |  |
-| **results_access_key** | **String** | The `resultsAccessKey` for the Acceptance Session.              This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.              Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.              Trinsic cannot access a Session's Data Vault without this key. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::CreateWidgetSessionResponse.new(
-  session_id: null,
-  launch_url: https://verify.trinsic.id/api/session/launch?clientToken=...,
-  results_access_key: 417zNGHMJp6Ht2jCoktTLNGDRZEt4BqTwwQ8Q9ZaQz8aS4Jd7nD1xff2WLhPS69j5q9QT4gvgV79Gv7QtaXwu5YC9Utr35...
-)
-```
-

data/docs/HttpValidationProblemDetails.md

@@ -1,28 +0,0 @@
-# TrinsicApi::HttpValidationProblemDetails
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | **String** | A URI reference that identifies the problem type. | [optional] |
-| **title** | **String** | A short, human-readable summary of the error. | [optional] |
-| **status** | **Integer** | The HTTP status code returned for the request. | [optional] |
-| **detail** | **String** | A human-readable explanation specific of the problem. | [optional] |
-| **instance** | **String** | A URI reference that identifies the specific occurrence of the problem. | [optional] |
-| **errors** | **Hash<String, Array<String>>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::HttpValidationProblemDetails.new(
-  type: null,
-  title: null,
-  status: null,
-  detail: null,
-  instance: null,
-  errors: null
-)
-```
-

data/lib/trinsic_api/models/create_widget_session_request.rb

@@ -1,273 +0,0 @@
-=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 CreateWidgetSessionRequest
-    # The ID of the Verification Profile to use for this session.
-    attr_accessor :verification_profile_id
-
-    # The URL to redirect the user to after the widget session is complete.              *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as a popup; in that case, session resolution is handled by our SDK, not via redirect.
-    attr_accessor :redirect_url
-
-    # The list of allowed identity providers. If not specified, all available providers will be allowed.
-    attr_accessor :providers
-
-    # Data that you already know about the user being verified.   This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first.
-    attr_accessor :recommendation_info
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'verification_profile_id' => :'verificationProfileId',
-        :'redirect_url' => :'redirectUrl',
-        :'providers' => :'providers',
-        :'recommendation_info' => :'recommendationInfo'
-      }
-    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
-      {
-        :'verification_profile_id' => :'String',
-        :'redirect_url' => :'String',
-        :'providers' => :'Array<String>',
-        :'recommendation_info' => :'RecommendationInfo'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'redirect_url',
-        :'providers',
-        :'recommendation_info'
-      ])
-    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::CreateWidgetSessionRequest` 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::CreateWidgetSessionRequest`. 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?(:'verification_profile_id')
-        self.verification_profile_id = attributes[:'verification_profile_id']
-      else
-        self.verification_profile_id = nil
-      end
-
-      if attributes.key?(:'redirect_url')
-        self.redirect_url = attributes[:'redirect_url']
-      end
-
-      if attributes.key?(:'providers')
-        if (value = attributes[:'providers']).is_a?(Array)
-          self.providers = value
-        end
-      end
-
-      if attributes.key?(:'recommendation_info')
-        self.recommendation_info = attributes[:'recommendation_info']
-      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 @verification_profile_id.nil?
-        invalid_properties.push('invalid value for "verification_profile_id", verification_profile_id 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 @verification_profile_id.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] verification_profile_id Value to be assigned
-    def verification_profile_id=(verification_profile_id)
-      if verification_profile_id.nil?
-        fail ArgumentError, 'verification_profile_id cannot be nil'
-      end
-
-      @verification_profile_id = verification_profile_id
-    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 &&
-          verification_profile_id == o.verification_profile_id &&
-          redirect_url == o.redirect_url &&
-          providers == o.providers &&
-          recommendation_info == o.recommendation_info
-    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
-      [verification_profile_id, redirect_url, providers, recommendation_info].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_widget_session_response.rb

@@ -1,292 +0,0 @@
-=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 CreateWidgetSessionResponse
-    # The ID of the newly-created Acceptance Session
-    attr_accessor :session_id
-
-    # The URL that should be used to invoke the Acceptance Session on your user's device.              You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.              This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
-    attr_accessor :launch_url
-
-    # The `resultsAccessKey` for the Acceptance Session.              This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.              Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.              Trinsic cannot access a Session's Data Vault without this key.
-    attr_accessor :results_access_key
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'session_id' => :'sessionId',
-        :'launch_url' => :'launchUrl',
-        :'results_access_key' => :'resultsAccessKey'
-      }
-    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
-      {
-        :'session_id' => :'String',
-        :'launch_url' => :'String',
-        :'results_access_key' => :'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::CreateWidgetSessionResponse` 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::CreateWidgetSessionResponse`. 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?(:'session_id')
-        self.session_id = attributes[:'session_id']
-      else
-        self.session_id = nil
-      end
-
-      if attributes.key?(:'launch_url')
-        self.launch_url = attributes[:'launch_url']
-      else
-        self.launch_url = nil
-      end
-
-      if attributes.key?(:'results_access_key')
-        self.results_access_key = attributes[:'results_access_key']
-      else
-        self.results_access_key = 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 @session_id.nil?
-        invalid_properties.push('invalid value for "session_id", session_id cannot be nil.')
-      end
-
-      if @launch_url.nil?
-        invalid_properties.push('invalid value for "launch_url", launch_url cannot be nil.')
-      end
-
-      if @results_access_key.nil?
-        invalid_properties.push('invalid value for "results_access_key", results_access_key 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 @session_id.nil?
-      return false if @launch_url.nil?
-      return false if @results_access_key.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] session_id Value to be assigned
-    def session_id=(session_id)
-      if session_id.nil?
-        fail ArgumentError, 'session_id cannot be nil'
-      end
-
-      @session_id = session_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] launch_url Value to be assigned
-    def launch_url=(launch_url)
-      if launch_url.nil?
-        fail ArgumentError, 'launch_url cannot be nil'
-      end
-
-      @launch_url = launch_url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] results_access_key Value to be assigned
-    def results_access_key=(results_access_key)
-      if results_access_key.nil?
-        fail ArgumentError, 'results_access_key cannot be nil'
-      end
-
-      @results_access_key = results_access_key
-    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 &&
-          session_id == o.session_id &&
-          launch_url == o.launch_url &&
-          results_access_key == o.results_access_key
-    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
-      [session_id, launch_url, results_access_key].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