trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/models/{provider_contract.rb → provider.rb}

@@ -14,31 +14,37 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class ProviderContract
-    # The ID of the Provider for this contract.
+  class Provider
+    # The unique identifier of the provider
     attr_accessor :id
 
-    # The Provider's Name as it appears in Trinsic's Dashboard and Widget
+    # The display name of the provider
     attr_accessor :name
 
+    # The URL of the provider's logo
+    attr_accessor :logo_url
+
     # 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.
+    # A description of the provider's capabilities
     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.
+    # Geographic regions where this provider operates
     attr_accessor :geography
 
-    # The regions within which the Provider is available.
+    # Specific regions supported by this provider
     attr_accessor :regions
 
+    # The countries where this Provider is available (as alpha-2 ISO codes).
+    attr_accessor :countries
+
+    # The subdivisions (states, provinces, etc.) where this Provider is available (as alpha-2 ISO codes).
+    attr_accessor :subdivisions
+
+    # Whether this provider is licensed for use by your organization
+    attr_accessor :licensed
+
     # Relevant only to Direct Provider Sessions.              The `LaunchMethod` which must be supported to launch the Provider Session in Direct Provider Sessions.
     attr_accessor :launch_method
 
@@ -57,23 +63,23 @@ module TrinsicApi
     # 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 Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function.
-    attr_accessor :supports_advanced_provider_sessions
-
     # Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function.
     attr_accessor :supports_direct_provider_sessions
 
-    # Information about the fields that this Provider will return in verification results.
-    attr_accessor :available_fields
+    # Information about the user attributes that this Provider will return in verification results.
+    attr_accessor :available_attributes
 
-    # Information about the identifiers this Provider returns in verification results.
-    attr_accessor :available_identifiers
+    # Information about the attachments that this Provider will return in verification results.
+    attr_accessor :available_attachments
 
-    # 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.
+    # Metadata about the sub-providers which are available for this Provider in the current Environment.              For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers.
     attr_accessor :sub_providers
 
-    # The health for an integration to be able to successfully perform a verification session.
-    attr_accessor :health
+    # The health for a provider in the live environment
+    attr_accessor :live_health
+
+    # The health for a provider in the test environment
+    attr_accessor :test_health
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -102,24 +108,26 @@ module TrinsicApi
       {
         :'id' => :'id',
         :'name' => :'name',
+        :'logo_url' => :'logoUrl',
         :'subtext' => :'subtext',
         :'description' => :'description',
-        :'logo_url' => :'logoUrl',
-        :'available' => :'available',
         :'geography' => :'geography',
         :'regions' => :'regions',
+        :'countries' => :'countries',
+        :'subdivisions' => :'subdivisions',
+        :'licensed' => :'licensed',
         :'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',
         :'supports_direct_provider_sessions' => :'supportsDirectProviderSessions',
-        :'available_fields' => :'availableFields',
-        :'available_identifiers' => :'availableIdentifiers',
+        :'available_attributes' => :'availableAttributes',
+        :'available_attachments' => :'availableAttachments',
         :'sub_providers' => :'subProviders',
-        :'health' => :'health'
+        :'live_health' => :'liveHealth',
+        :'test_health' => :'testHealth'
       }
     end
 
@@ -138,32 +146,34 @@ module TrinsicApi
       {
         :'id' => :'String',
         :'name' => :'String',
+        :'logo_url' => :'String',
         :'subtext' => :'String',
         :'description' => :'String',
-        :'logo_url' => :'String',
-        :'available' => :'Boolean',
         :'geography' => :'Array<String>',
         :'regions' => :'Array<String>',
+        :'countries' => :'Array<String>',
+        :'subdivisions' => :'Array<String>',
+        :'licensed' => :'Boolean',
         :'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',
         :'supports_direct_provider_sessions' => :'Boolean',
-        :'available_fields' => :'Array<ContractField>',
-        :'available_identifiers' => :'Array<ContractIdentifierField>',
+        :'available_attributes' => :'Array<ContractAttribute>',
+        :'available_attachments' => :'Array<ContractAttachment>',
         :'sub_providers' => :'Array<SubProviderMetadata>',
-        :'health' => :'ProviderHealth'
+        :'live_health' => :'ProviderHealth',
+        :'test_health' => :'ProviderHealth'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'available_fields',
-        :'available_identifiers',
+        :'available_attributes',
+        :'available_attachments',
         :'sub_providers',
       ])
     end
@@ -172,14 +182,14 @@ 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::ProviderContract` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::Provider` 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
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::Provider`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -196,6 +206,12 @@ module TrinsicApi
         self.name = nil
       end
 
+      if attributes.key?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      else
+        self.logo_url = nil
+      end
+
       if attributes.key?(:'subtext')
         self.subtext = attributes[:'subtext']
       else
@@ -208,18 +224,6 @@ module TrinsicApi
         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
@@ -236,6 +240,28 @@ module TrinsicApi
         self.regions = nil
       end
 
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      else
+        self.countries = nil
+      end
+
+      if attributes.key?(:'subdivisions')
+        if (value = attributes[:'subdivisions']).is_a?(Array)
+          self.subdivisions = value
+        end
+      else
+        self.subdivisions = nil
+      end
+
+      if attributes.key?(:'licensed')
+        self.licensed = attributes[:'licensed']
+      else
+        self.licensed = nil
+      end
+
       if attributes.key?(:'launch_method')
         self.launch_method = attributes[:'launch_method']
       else
@@ -272,27 +298,21 @@ module TrinsicApi
         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?(:'supports_direct_provider_sessions')
         self.supports_direct_provider_sessions = attributes[:'supports_direct_provider_sessions']
       else
         self.supports_direct_provider_sessions = nil
       end
 
-      if attributes.key?(:'available_fields')
-        if (value = attributes[:'available_fields']).is_a?(Array)
-          self.available_fields = value
+      if attributes.key?(:'available_attributes')
+        if (value = attributes[:'available_attributes']).is_a?(Array)
+          self.available_attributes = value
         end
       end
 
-      if attributes.key?(:'available_identifiers')
-        if (value = attributes[:'available_identifiers']).is_a?(Array)
-          self.available_identifiers = value
+      if attributes.key?(:'available_attachments')
+        if (value = attributes[:'available_attachments']).is_a?(Array)
+          self.available_attachments = value
         end
       end
 
@@ -302,10 +322,16 @@ module TrinsicApi
         end
       end
 
-      if attributes.key?(:'health')
-        self.health = attributes[:'health']
+      if attributes.key?(:'live_health')
+        self.live_health = attributes[:'live_health']
+      else
+        self.live_health = nil
+      end
+
+      if attributes.key?(:'test_health')
+        self.test_health = attributes[:'test_health']
       else
-        self.health = nil
+        self.test_health = nil
       end
     end
 
@@ -322,6 +348,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "name", name cannot be nil.')
       end
 
+      if @logo_url.nil?
+        invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
+      end
+
       if @subtext.nil?
         invalid_properties.push('invalid value for "subtext", subtext cannot be nil.')
       end
@@ -330,14 +360,6 @@ module TrinsicApi
         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
@@ -346,6 +368,18 @@ module TrinsicApi
         invalid_properties.push('invalid value for "regions", regions cannot be nil.')
       end
 
+      if @countries.nil?
+        invalid_properties.push('invalid value for "countries", countries cannot be nil.')
+      end
+
+      if @subdivisions.nil?
+        invalid_properties.push('invalid value for "subdivisions", subdivisions cannot be nil.')
+      end
+
+      if @licensed.nil?
+        invalid_properties.push('invalid value for "licensed", licensed cannot be nil.')
+      end
+
       if @launch_method.nil?
         invalid_properties.push('invalid value for "launch_method", launch_method cannot be nil.')
       end
@@ -370,16 +404,16 @@ module TrinsicApi
         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 @supports_direct_provider_sessions.nil?
         invalid_properties.push('invalid value for "supports_direct_provider_sessions", supports_direct_provider_sessions cannot be nil.')
       end
 
-      if @health.nil?
-        invalid_properties.push('invalid value for "health", health cannot be nil.')
+      if @live_health.nil?
+        invalid_properties.push('invalid value for "live_health", live_health cannot be nil.')
+      end
+
+      if @test_health.nil?
+        invalid_properties.push('invalid value for "test_health", test_health cannot be nil.')
       end
 
       invalid_properties
@@ -391,21 +425,23 @@ module TrinsicApi
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @name.nil?
+      return false if @logo_url.nil?
       return false if @subtext.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 @countries.nil?
+      return false if @subdivisions.nil?
+      return false if @licensed.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 @supports_direct_provider_sessions.nil?
-      return false if @health.nil?
+      return false if @live_health.nil?
+      return false if @test_health.nil?
       true
     end
 
@@ -429,6 +465,16 @@ module TrinsicApi
       @name = name
     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] subtext Value to be assigned
     def subtext=(subtext)
@@ -449,26 +495,6 @@ module TrinsicApi
       @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)
@@ -489,6 +515,36 @@ module TrinsicApi
       @regions = regions
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] countries Value to be assigned
+    def countries=(countries)
+      if countries.nil?
+        fail ArgumentError, 'countries cannot be nil'
+      end
+
+      @countries = countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subdivisions Value to be assigned
+    def subdivisions=(subdivisions)
+      if subdivisions.nil?
+        fail ArgumentError, 'subdivisions cannot be nil'
+      end
+
+      @subdivisions = subdivisions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] licensed Value to be assigned
+    def licensed=(licensed)
+      if licensed.nil?
+        fail ArgumentError, 'licensed cannot be nil'
+      end
+
+      @licensed = licensed
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] launch_method Value to be assigned
     def launch_method=(launch_method)
@@ -549,16 +605,6 @@ module TrinsicApi
       @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] supports_direct_provider_sessions Value to be assigned
     def supports_direct_provider_sessions=(supports_direct_provider_sessions)
@@ -570,13 +616,23 @@ module TrinsicApi
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] health Value to be assigned
-    def health=(health)
-      if health.nil?
-        fail ArgumentError, 'health cannot be nil'
+    # @param [Object] live_health Value to be assigned
+    def live_health=(live_health)
+      if live_health.nil?
+        fail ArgumentError, 'live_health cannot be nil'
       end
 
-      @health = health
+      @live_health = live_health
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] test_health Value to be assigned
+    def test_health=(test_health)
+      if test_health.nil?
+        fail ArgumentError, 'test_health cannot be nil'
+      end
+
+      @test_health = test_health
     end
 
     # Checks equality by comparing each attribute.
@@ -586,24 +642,26 @@ module TrinsicApi
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          logo_url == o.logo_url &&
           subtext == o.subtext &&
           description == o.description &&
-          logo_url == o.logo_url &&
-          available == o.available &&
           geography == o.geography &&
           regions == o.regions &&
+          countries == o.countries &&
+          subdivisions == o.subdivisions &&
+          licensed == o.licensed &&
           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 &&
           supports_direct_provider_sessions == o.supports_direct_provider_sessions &&
-          available_fields == o.available_fields &&
-          available_identifiers == o.available_identifiers &&
+          available_attributes == o.available_attributes &&
+          available_attachments == o.available_attachments &&
           sub_providers == o.sub_providers &&
-          health == o.health
+          live_health == o.live_health &&
+          test_health == o.test_health
     end
 
     # @see the `==` method
@@ -615,7 +673,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def 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, supports_direct_provider_sessions, available_fields, available_identifiers, sub_providers, health].hash
+      [id, name, logo_url, subtext, description, geography, regions, countries, subdivisions, licensed, launch_method, collection_method, results_may_be_delayed_after_redirect, has_refreshable_content, requires_input, has_trinsic_interface, supports_direct_provider_sessions, available_attributes, available_attachments, sub_providers, live_health, test_health].hash
     end
 
     # Builds the object from hash