trinsic_api 2.0.0.pre.alpha3 → 2.0.1

data/lib/trinsic_api/models/provider_contract.rb

@@ -0,0 +1,655 @@
+=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 ProviderContract
+    # The ID of the Provider for this contract.
+    attr_accessor :id
+
+    # The Provider's Name as it appears in Trinsic's Dashboard and Widget
+    attr_accessor :name
+
+    # 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
+
+    # A URL pointing to the Provider's logo on Trinsic's CDN.              May be a PNG, JPG, or SVG image.
+    attr_accessor :logo_url
+
+    # Whether the Provider is available for use in your App.              If `false`, you will need to contact Trinsic to enable this Provider for your App.
+    attr_accessor :available
+
+    # The geographies within the Regions the Provider is available.
+    attr_accessor :geography
+
+    # The regions within which the Provider is available.
+    attr_accessor :regions
+
+    # Relevant only to Advanced Provider Sessions.              The `LaunchMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions.
+    attr_accessor :launch_method
+
+    # 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.
+    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.
+    attr_accessor :has_refreshable_content
+
+    # Relevant to Hosted Provider Sessions and Advanced Provider Sessions.              If `true`, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user.
+    attr_accessor :requires_input
+
+    # Whether there exists a Trinsic-hosted UI for this Provider.              This is `true` for any Provider which is not a simple, OIDC-like redirect flow.
+    attr_accessor :has_trinsic_interface
+
+    # 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
+
+    # 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
+
+    # The current status of the provider and if it is available to launch. If the status is disabled, there is an issue that prevents a provider being able to launch a session.
+    attr_accessor :status
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'description' => :'description',
+        :'logo_url' => :'logoUrl',
+        :'available' => :'available',
+        :'geography' => :'geography',
+        :'regions' => :'regions',
+        :'launch_method' => :'launchMethod',
+        :'collection_method' => :'collectionMethod',
+        :'results_may_be_delayed_after_redirect' => :'resultsMayBeDelayedAfterRedirect',
+        :'has_refreshable_content' => :'hasRefreshableContent',
+        :'requires_input' => :'requiresInput',
+        :'has_trinsic_interface' => :'hasTrinsicInterface',
+        :'supports_advanced_provider_sessions' => :'supportsAdvancedProviderSessions',
+        :'sub_providers' => :'subProviders',
+        :'status' => :'status'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'description' => :'String',
+        :'logo_url' => :'String',
+        :'available' => :'Boolean',
+        :'geography' => :'Array<String>',
+        :'regions' => :'Array<String>',
+        :'launch_method' => :'IntegrationLaunchMethod',
+        :'collection_method' => :'ResultCollectionMethod',
+        :'results_may_be_delayed_after_redirect' => :'Boolean',
+        :'has_refreshable_content' => :'Boolean',
+        :'requires_input' => :'Boolean',
+        :'has_trinsic_interface' => :'Boolean',
+        :'supports_advanced_provider_sessions' => :'Boolean',
+        :'sub_providers' => :'Array<SubProviderMetadata>',
+        :'status' => :'ProviderHealth'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sub_providers',
+      ])
+    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::ProviderContract` 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::ProviderContract`. 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')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      else
+        self.logo_url = nil
+      end
+
+      if attributes.key?(:'available')
+        self.available = attributes[:'available']
+      else
+        self.available = nil
+      end
+
+      if attributes.key?(:'geography')
+        if (value = attributes[:'geography']).is_a?(Array)
+          self.geography = value
+        end
+      else
+        self.geography = nil
+      end
+
+      if attributes.key?(:'regions')
+        if (value = attributes[:'regions']).is_a?(Array)
+          self.regions = value
+        end
+      else
+        self.regions = nil
+      end
+
+      if attributes.key?(:'launch_method')
+        self.launch_method = attributes[:'launch_method']
+      else
+        self.launch_method = nil
+      end
+
+      if attributes.key?(:'collection_method')
+        self.collection_method = attributes[:'collection_method']
+      else
+        self.collection_method = nil
+      end
+
+      if attributes.key?(:'results_may_be_delayed_after_redirect')
+        self.results_may_be_delayed_after_redirect = attributes[:'results_may_be_delayed_after_redirect']
+      else
+        self.results_may_be_delayed_after_redirect = nil
+      end
+
+      if attributes.key?(:'has_refreshable_content')
+        self.has_refreshable_content = attributes[:'has_refreshable_content']
+      else
+        self.has_refreshable_content = nil
+      end
+
+      if attributes.key?(:'requires_input')
+        self.requires_input = attributes[:'requires_input']
+      else
+        self.requires_input = nil
+      end
+
+      if attributes.key?(:'has_trinsic_interface')
+        self.has_trinsic_interface = attributes[:'has_trinsic_interface']
+      else
+        self.has_trinsic_interface = nil
+      end
+
+      if attributes.key?(:'supports_advanced_provider_sessions')
+        self.supports_advanced_provider_sessions = attributes[:'supports_advanced_provider_sessions']
+      else
+        self.supports_advanced_provider_sessions = nil
+      end
+
+      if attributes.key?(:'sub_providers')
+        if (value = attributes[:'sub_providers']).is_a?(Array)
+          self.sub_providers = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @logo_url.nil?
+        invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
+      end
+
+      if @available.nil?
+        invalid_properties.push('invalid value for "available", available cannot be nil.')
+      end
+
+      if @geography.nil?
+        invalid_properties.push('invalid value for "geography", geography cannot be nil.')
+      end
+
+      if @regions.nil?
+        invalid_properties.push('invalid value for "regions", regions cannot be nil.')
+      end
+
+      if @launch_method.nil?
+        invalid_properties.push('invalid value for "launch_method", launch_method cannot be nil.')
+      end
+
+      if @collection_method.nil?
+        invalid_properties.push('invalid value for "collection_method", collection_method cannot be nil.')
+      end
+
+      if @results_may_be_delayed_after_redirect.nil?
+        invalid_properties.push('invalid value for "results_may_be_delayed_after_redirect", results_may_be_delayed_after_redirect cannot be nil.')
+      end
+
+      if @has_refreshable_content.nil?
+        invalid_properties.push('invalid value for "has_refreshable_content", has_refreshable_content cannot be nil.')
+      end
+
+      if @requires_input.nil?
+        invalid_properties.push('invalid value for "requires_input", requires_input cannot be nil.')
+      end
+
+      if @has_trinsic_interface.nil?
+        invalid_properties.push('invalid value for "has_trinsic_interface", has_trinsic_interface cannot be nil.')
+      end
+
+      if @supports_advanced_provider_sessions.nil?
+        invalid_properties.push('invalid value for "supports_advanced_provider_sessions", supports_advanced_provider_sessions cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @id.nil?
+      return false if @name.nil?
+      return false if @description.nil?
+      return false if @logo_url.nil?
+      return false if @available.nil?
+      return false if @geography.nil?
+      return false if @regions.nil?
+      return false if @launch_method.nil?
+      return false if @collection_method.nil?
+      return false if @results_may_be_delayed_after_redirect.nil?
+      return false if @has_refreshable_content.nil?
+      return false if @requires_input.nil?
+      return false if @has_trinsic_interface.nil?
+      return false if @supports_advanced_provider_sessions.nil?
+      return false if @status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    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] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] logo_url Value to be assigned
+    def logo_url=(logo_url)
+      if logo_url.nil?
+        fail ArgumentError, 'logo_url cannot be nil'
+      end
+
+      @logo_url = logo_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] available Value to be assigned
+    def available=(available)
+      if available.nil?
+        fail ArgumentError, 'available cannot be nil'
+      end
+
+      @available = available
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] geography Value to be assigned
+    def geography=(geography)
+      if geography.nil?
+        fail ArgumentError, 'geography cannot be nil'
+      end
+
+      @geography = geography
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] regions Value to be assigned
+    def regions=(regions)
+      if regions.nil?
+        fail ArgumentError, 'regions cannot be nil'
+      end
+
+      @regions = regions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] launch_method Value to be assigned
+    def launch_method=(launch_method)
+      if launch_method.nil?
+        fail ArgumentError, 'launch_method cannot be nil'
+      end
+
+      @launch_method = launch_method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] collection_method Value to be assigned
+    def collection_method=(collection_method)
+      if collection_method.nil?
+        fail ArgumentError, 'collection_method cannot be nil'
+      end
+
+      @collection_method = collection_method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] results_may_be_delayed_after_redirect Value to be assigned
+    def results_may_be_delayed_after_redirect=(results_may_be_delayed_after_redirect)
+      if results_may_be_delayed_after_redirect.nil?
+        fail ArgumentError, 'results_may_be_delayed_after_redirect cannot be nil'
+      end
+
+      @results_may_be_delayed_after_redirect = results_may_be_delayed_after_redirect
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_refreshable_content Value to be assigned
+    def has_refreshable_content=(has_refreshable_content)
+      if has_refreshable_content.nil?
+        fail ArgumentError, 'has_refreshable_content cannot be nil'
+      end
+
+      @has_refreshable_content = has_refreshable_content
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requires_input Value to be assigned
+    def requires_input=(requires_input)
+      if requires_input.nil?
+        fail ArgumentError, 'requires_input cannot be nil'
+      end
+
+      @requires_input = requires_input
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_trinsic_interface Value to be assigned
+    def has_trinsic_interface=(has_trinsic_interface)
+      if has_trinsic_interface.nil?
+        fail ArgumentError, 'has_trinsic_interface cannot be nil'
+      end
+
+      @has_trinsic_interface = has_trinsic_interface
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] supports_advanced_provider_sessions Value to be assigned
+    def supports_advanced_provider_sessions=(supports_advanced_provider_sessions)
+      if supports_advanced_provider_sessions.nil?
+        fail ArgumentError, 'supports_advanced_provider_sessions cannot be nil'
+      end
+
+      @supports_advanced_provider_sessions = supports_advanced_provider_sessions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    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 == o.id &&
+          name == o.name &&
+          description == o.description &&
+          logo_url == o.logo_url &&
+          available == o.available &&
+          geography == o.geography &&
+          regions == o.regions &&
+          launch_method == o.launch_method &&
+          collection_method == o.collection_method &&
+          results_may_be_delayed_after_redirect == o.results_may_be_delayed_after_redirect &&
+          has_refreshable_content == o.has_refreshable_content &&
+          requires_input == o.requires_input &&
+          has_trinsic_interface == o.has_trinsic_interface &&
+          supports_advanced_provider_sessions == o.supports_advanced_provider_sessions &&
+          sub_providers == o.sub_providers &&
+          status == o.status
+    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
+      [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, status].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/provider_health.rb

@@ -0,0 +1,40 @@
+=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 ProviderHealth
+    ONLINE = "Online".freeze
+    OFFLINE = "Offline".freeze
+
+    def self.all_vars
+      @all_vars ||= [ONLINE, OFFLINE].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 ProviderHealth.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #ProviderHealth"
+    end
+  end
+end