trinsic_api 2.0.2 → 2.1.0.pre.alpha1

data/lib/trinsic_api/models/provider_info.rb

@@ -25,12 +25,28 @@ module TrinsicApi
     # A URL pointing to 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 recommended to be shown next to the name.              This is flavor text, not a full, human-readable description of the provider.
+    attr_accessor :description
+
+    # The current health status of the provider
+    attr_accessor :health
+
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
         :'name' => :'name',
-        :'logo_url' => :'logoUrl'
+        :'logo_url' => :'logoUrl',
+        :'subtext' => :'subtext',
+        :'description' => :'description',
+        :'health' => :'health',
+        :'sub_providers' => :'subProviders'
       }
     end
 
@@ -49,13 +65,18 @@ module TrinsicApi
       {
         :'id' => :'String',
         :'name' => :'String',
-        :'logo_url' => :'String'
+        :'logo_url' => :'String',
+        :'subtext' => :'String',
+        :'description' => :'String',
+        :'health' => :'String',
+        :'sub_providers' => :'Array<SubProviderMetadata>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'sub_providers'
       ])
     end
 
@@ -92,6 +113,30 @@ module TrinsicApi
       else
         self.logo_url = nil
       end
+
+      if attributes.key?(:'subtext')
+        self.subtext = attributes[:'subtext']
+      else
+        self.subtext = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'health')
+        self.health = attributes[:'health']
+      else
+        self.health = nil
+      end
+
+      if attributes.key?(:'sub_providers')
+        if (value = attributes[:'sub_providers']).is_a?(Array)
+          self.sub_providers = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -111,6 +156,18 @@ module TrinsicApi
         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
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @health.nil?
+        invalid_properties.push('invalid value for "health", health cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -121,6 +178,9 @@ module TrinsicApi
       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 @health.nil?
       true
     end
 
@@ -154,6 +214,36 @@ module TrinsicApi
       @logo_url = logo_url
     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)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      @description = description
+    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'
+      end
+
+      @health = health
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -161,7 +251,11 @@ module TrinsicApi
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
-          logo_url == o.logo_url
+          logo_url == o.logo_url &&
+          subtext == o.subtext &&
+          description == o.description &&
+          health == o.health &&
+          sub_providers == o.sub_providers
     end
 
     # @see the `==` method
@@ -173,7 +267,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, logo_url].hash
+      [id, name, logo_url, subtext, description, health, sub_providers].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/provider_information.rb

@@ -15,18 +15,45 @@ require 'time'
 
 module TrinsicApi
   class ProviderInformation
+    # The ID of the provider
+    attr_accessor :id
+
+    # The friendly, human-readable name of the provider
+    attr_accessor :name
+
+    # A URL pointing to 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 ID of the provider
     attr_accessor :provider_id
 
+    # The friendly, human-readable name of the provider
     attr_accessor :provider_display_name
 
+    # A URL pointing to the provider's logo
     attr_accessor :provider_logo
 
+    # The current health status of the provider
+    attr_accessor :health
+
+    # 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
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'logo_url' => :'logoUrl',
+        :'subtext' => :'subtext',
         :'provider_id' => :'providerId',
         :'provider_display_name' => :'providerDisplayName',
-        :'provider_logo' => :'providerLogo'
+        :'provider_logo' => :'providerLogo',
+        :'health' => :'health',
+        :'sub_providers' => :'subProviders'
       }
     end
 
@@ -43,15 +70,22 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'logo_url' => :'String',
+        :'subtext' => :'String',
         :'provider_id' => :'String',
         :'provider_display_name' => :'String',
-        :'provider_logo' => :'String'
+        :'provider_logo' => :'String',
+        :'health' => :'String',
+        :'sub_providers' => :'Array<SubProviderMetadata>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'sub_providers'
       ])
     end
 
@@ -71,6 +105,30 @@ module TrinsicApi
         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?(:'logo_url')
+        self.logo_url = attributes[:'logo_url']
+      else
+        self.logo_url = nil
+      end
+
+      if attributes.key?(:'subtext')
+        self.subtext = attributes[:'subtext']
+      else
+        self.subtext = nil
+      end
+
       if attributes.key?(:'provider_id')
         self.provider_id = attributes[:'provider_id']
       else
@@ -88,6 +146,18 @@ module TrinsicApi
       else
         self.provider_logo = nil
       end
+
+      if attributes.key?(:'health')
+        self.health = attributes[:'health']
+      else
+        self.health = nil
+      end
+
+      if attributes.key?(:'sub_providers')
+        if (value = attributes[:'sub_providers']).is_a?(Array)
+          self.sub_providers = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -95,6 +165,22 @@ module TrinsicApi
     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 @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
+
       if @provider_id.nil?
         invalid_properties.push('invalid value for "provider_id", provider_id cannot be nil.')
       end
@@ -107,6 +193,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "provider_logo", provider_logo cannot be nil.')
       end
 
+      if @health.nil?
+        invalid_properties.push('invalid value for "health", health cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -114,12 +204,57 @@ module TrinsicApi
     # @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 @logo_url.nil?
+      return false if @subtext.nil?
       return false if @provider_id.nil?
       return false if @provider_display_name.nil?
       return false if @provider_logo.nil?
+      return false if @health.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] 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)
+      if subtext.nil?
+        fail ArgumentError, 'subtext cannot be nil'
+      end
+
+      @subtext = subtext
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] provider_id Value to be assigned
     def provider_id=(provider_id)
@@ -150,14 +285,30 @@ module TrinsicApi
       @provider_logo = provider_logo
     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'
+      end
+
+      @health = health
+    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 &&
+          logo_url == o.logo_url &&
+          subtext == o.subtext &&
           provider_id == o.provider_id &&
           provider_display_name == o.provider_display_name &&
-          provider_logo == o.provider_logo
+          provider_logo == o.provider_logo &&
+          health == o.health &&
+          sub_providers == o.sub_providers
     end
 
     # @see the `==` method
@@ -169,7 +320,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [provider_id, provider_display_name, provider_logo].hash
+      [id, name, logo_url, subtext, provider_id, provider_display_name, provider_logo, health, sub_providers].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/provider_input.rb

@@ -15,37 +15,37 @@ require 'time'
 
 module TrinsicApi
   class ProviderInput
-    # Input for the `f-indonesia-nik` provider
+    # Input for the `indonesia-nik-lookup` provider
     attr_accessor :indonesia_nik
 
-    # Input for the `f-mexico-curp` provider
+    # Input for the `mexico-curp-lookup` provider
     attr_accessor :mexico_curp
 
-    # Input for the `f-south-africa-nid` provider
+    # Input for the `south-africa-nid-lookup` provider
     attr_accessor :south_africa_nid
 
-    # Input for the `f-kenya-nid` provider
+    # Input for the `kenya-nid-lookup` provider
     attr_accessor :kenya_nid
 
-    # Input for the `f-nigeria-nin` provider
+    # Input for the `nigeria-nin-lookup` provider
     attr_accessor :nigeria_nin
 
-    # Input for the `f-india-aadhaar-match` provider
+    # Input for the `india-digilocker-aadhaar-match` provider
     attr_accessor :aadhaar
 
     # Input for the `bangladesh-nid` provider
     attr_accessor :bangladesh_national_id
 
-    # Input for the `g-brazil-cpf` provider
+    # Input for the `brazil-cpf-lookup` provider
     attr_accessor :brazil_cpf_check
 
-    # Input for the `g-brazil-digital-cnh` provider
+    # Input for the `brazil-digital-cnh` provider
     attr_accessor :brazil_digital_cnh
 
-    # Input for the `b-philsys-biometric` provider
+    # Input for the `philippines-philsys-match` provider
     attr_accessor :philippine_match
 
-    # Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` providers
+    # Input for the `philippines-digital-national-id-qr` and `philippines-physical-national-id-qr` providers
     attr_accessor :philippine_qr
 
     # Input for the `smart-id` provider
@@ -54,10 +54,10 @@ module TrinsicApi
     # Input for the `mobile-id` provider
     attr_accessor :mobile_id
 
-    # Input for the `idin` provider
+    # Input for the `netherlands-idin` provider
     attr_accessor :idin
 
-    # Input for the `spid` provider
+    # Input for the `italy-spid` provider
     attr_accessor :spid
 
     # *TEST MODE ONLY.*              Input for the `trinsic-test-database-lookup` provider
@@ -108,7 +108,7 @@ module TrinsicApi
         :'kenya_nid' => :'KenyaNidInput',
         :'nigeria_nin' => :'NigeriaNinInput',
         :'aadhaar' => :'AadhaarInput',
-        :'bangladesh_national_id' => :'BangladeshNationalIdInput',
+        :'bangladesh_national_id' => :'BangladeshNidInput',
         :'brazil_cpf_check' => :'BrazilCpfCheckInput',
         :'brazil_digital_cnh' => :'BrazilDigitalCnhInput',
         :'philippine_match' => :'PhilippineMatchInput',

data/lib/trinsic_api/models/recommend_request.rb

@@ -18,10 +18,14 @@ module TrinsicApi
     # Information about the user you wish to generate a recommendation for.
     attr_accessor :recommendation_info
 
+    # Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"online\".
+    attr_accessor :health
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'recommendation_info' => :'recommendationInfo'
+        :'recommendation_info' => :'recommendationInfo',
+        :'health' => :'health'
       }
     end
 
@@ -38,14 +42,16 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'recommendation_info' => :'RecommendationInfo'
+        :'recommendation_info' => :'RecommendationInfo',
+        :'health' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'recommendation_info'
+        :'recommendation_info',
+        :'health'
       ])
     end
 
@@ -68,6 +74,10 @@ module TrinsicApi
       if attributes.key?(:'recommendation_info')
         self.recommendation_info = attributes[:'recommendation_info']
       end
+
+      if attributes.key?(:'health')
+        self.health = attributes[:'health']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +100,8 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          recommendation_info == o.recommendation_info
+          recommendation_info == o.recommendation_info &&
+          health == o.health
     end
 
     # @see the `==` method
@@ -102,7 +113,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [recommendation_info].hash
+      [recommendation_info, health].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/recommend_response.rb

@@ -15,13 +15,13 @@ require 'time'
 
 module TrinsicApi
   class RecommendResponse
-    # The list of providers that were recognized in Trinsic's network. These are providers that already verified this user
+    # The providers which the user is known to have a credential with.
     attr_accessor :recognized
 
-    # The list of providers that although not recognized, are relevant to the user's identity. The user may have been verified by these providers
+    # The providers which the user is deemed sufficiently likely to have a credential with.
     attr_accessor :relevant
 
-    # The list of providers that are not recognized and are not relevant to the user's identity
+    # The providers which the user is unlikely to have a credential with.              This includes all providers available to your app which were not included in the Recognized or Relevant lists.
     attr_accessor :remainder
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/refresh_step_content_request.rb

@@ -45,7 +45,6 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'results_access_key'
       ])
     end
 
@@ -67,6 +66,8 @@ module TrinsicApi
 
       if attributes.key?(:'results_access_key')
         self.results_access_key = attributes[:'results_access_key']
+      else
+        self.results_access_key = nil
       end
     end
 
@@ -75,6 +76,14 @@ module TrinsicApi
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @results_access_key.nil?
+        invalid_properties.push('invalid value for "results_access_key", results_access_key cannot be nil.')
+      end
+
+      if @results_access_key.to_s.length < 1
+        invalid_properties.push('invalid value for "results_access_key", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -82,9 +91,25 @@ module TrinsicApi
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @results_access_key.nil?
+      return false if @results_access_key.to_s.length < 1
       true
     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
+
+      if results_access_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "results_access_key", the character length must be great than or equal to 1.'
+      end
+
+      @results_access_key = results_access_key
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/trinsic_api/models/session.rb

@@ -29,7 +29,7 @@ module TrinsicApi
     # The unix timestamp, in seconds, when this session was created
     attr_accessor :created
 
-    # The unix timestamp, in seconds, when this session's state last changed
+    # The unix timestamp, in seconds, when this session's data was last updated
     attr_accessor :updated
 
     class EnumAttributeValidator