trinsic_api 2.0.0.pre.alpha3 → 2.0.0

data/lib/trinsic_api/models/provider_input.rb

@@ -15,39 +15,57 @@ require 'time'
 
 module TrinsicApi
   class ProviderInput
-    # Input for the `f-indonesia-nik` integration
+    # Input for the `f-indonesia-nik` provider
     attr_accessor :indonesia_nik
 
-    # Input for the `f-mexico-curp` integration
+    # Input for the `f-mexico-curp` provider
     attr_accessor :mexico_curp
 
-    # Input for the `f-south-africa-nid` integration
+    # Input for the `f-south-africa-nid` provider
     attr_accessor :south_africa_nid
 
-    # Input for the `f-kenya-nid` integration
+    # Input for the `f-kenya-nid` provider
     attr_accessor :kenya_nid
 
-    # Input for the `f-nigeria-nin` integration
+    # Input for the `f-nigeria-nin` provider
     attr_accessor :nigeria_nin
 
-    # Input for the `f-india-aadhaar-match` integration
+    # Input for the `f-india-aadhaar-match` provider
     attr_accessor :aadhaar
 
-    # Input for the `bangladesh-nid` integration
+    # Input for the `bangladesh-nid` provider
     attr_accessor :bangladesh_national_id
 
-    # Input for the `g-brazil-cpf` integration
+    # Input for the `g-brazil-cpf` provider
     attr_accessor :brazil_cpf_check
 
-    # Input for the `g-brazil-digital-cnh` integration
+    # Input for the `g-brazil-digital-cnh` provider
     attr_accessor :brazil_digital_cnh
 
-    # Input for the `b-philsys-biometric` integration
+    # Input for the `b-philsys-biometric` provider
     attr_accessor :philippine_match
 
-    # Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` integrations
+    # Input for the `b-philippine-qr-digital-national-id` and `b-philippine-qr-ephill-id` providers
     attr_accessor :philippine_qr
 
+    # Input for the `smart-id` provider
+    attr_accessor :smart_id
+
+    # Input for the `mobile-id` provider
+    attr_accessor :mobile_id
+
+    # Input for the `idin` provider
+    attr_accessor :idin
+
+    # Input for the `spid` provider
+    attr_accessor :spid
+
+    # *TEST MODE ONLY.*              Input for the `trinsic-test-database-lookup` provider
+    attr_accessor :trinsic_test_database_lookup
+
+    # *TEST MODE ONLY.*              Input for the `trinsic-test-sub-providers` provider
+    attr_accessor :trinsic_test_sub_providers
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -61,7 +79,13 @@ module TrinsicApi
         :'brazil_cpf_check' => :'brazilCpfCheck',
         :'brazil_digital_cnh' => :'brazilDigitalCnh',
         :'philippine_match' => :'philippineMatch',
-        :'philippine_qr' => :'philippineQR'
+        :'philippine_qr' => :'philippineQR',
+        :'smart_id' => :'smartId',
+        :'mobile_id' => :'mobileId',
+        :'idin' => :'idin',
+        :'spid' => :'spid',
+        :'trinsic_test_database_lookup' => :'trinsicTestDatabaseLookup',
+        :'trinsic_test_sub_providers' => :'trinsicTestSubProviders'
       }
     end
 
@@ -83,7 +107,13 @@ module TrinsicApi
         :'brazil_cpf_check' => :'BrazilCpfCheckInput',
         :'brazil_digital_cnh' => :'BrazilDigitalCnhInput',
         :'philippine_match' => :'PhilippineMatchInput',
-        :'philippine_qr' => :'PhilippineQRInput'
+        :'philippine_qr' => :'PhilippineQRInput',
+        :'smart_id' => :'SmartIdInput',
+        :'mobile_id' => :'MobileIdInput',
+        :'idin' => :'IdinInput',
+        :'spid' => :'SpidInput',
+        :'trinsic_test_database_lookup' => :'TrinsicTestDatabaseLookupInput',
+        :'trinsic_test_sub_providers' => :'TrinsicTestSubProvidersInput'
       }
     end
 
@@ -100,7 +130,13 @@ module TrinsicApi
         :'brazil_cpf_check',
         :'brazil_digital_cnh',
         :'philippine_match',
-        :'philippine_qr'
+        :'philippine_qr',
+        :'smart_id',
+        :'mobile_id',
+        :'idin',
+        :'spid',
+        :'trinsic_test_database_lookup',
+        :'trinsic_test_sub_providers'
       ])
     end
 
@@ -162,6 +198,30 @@ module TrinsicApi
       if attributes.key?(:'philippine_qr')
         self.philippine_qr = attributes[:'philippine_qr']
       end
+
+      if attributes.key?(:'smart_id')
+        self.smart_id = attributes[:'smart_id']
+      end
+
+      if attributes.key?(:'mobile_id')
+        self.mobile_id = attributes[:'mobile_id']
+      end
+
+      if attributes.key?(:'idin')
+        self.idin = attributes[:'idin']
+      end
+
+      if attributes.key?(:'spid')
+        self.spid = attributes[:'spid']
+      end
+
+      if attributes.key?(:'trinsic_test_database_lookup')
+        self.trinsic_test_database_lookup = attributes[:'trinsic_test_database_lookup']
+      end
+
+      if attributes.key?(:'trinsic_test_sub_providers')
+        self.trinsic_test_sub_providers = attributes[:'trinsic_test_sub_providers']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -194,7 +254,13 @@ module TrinsicApi
           brazil_cpf_check == o.brazil_cpf_check &&
           brazil_digital_cnh == o.brazil_digital_cnh &&
           philippine_match == o.philippine_match &&
-          philippine_qr == o.philippine_qr
+          philippine_qr == o.philippine_qr &&
+          smart_id == o.smart_id &&
+          mobile_id == o.mobile_id &&
+          idin == o.idin &&
+          spid == o.spid &&
+          trinsic_test_database_lookup == o.trinsic_test_database_lookup &&
+          trinsic_test_sub_providers == o.trinsic_test_sub_providers
     end
 
     # @see the `==` method
@@ -206,7 +272,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [indonesia_nik, mexico_curp, south_africa_nid, kenya_nid, nigeria_nin, aadhaar, bangladesh_national_id, brazil_cpf_check, brazil_digital_cnh, philippine_match, philippine_qr].hash
+      [indonesia_nik, mexico_curp, south_africa_nid, kenya_nid, nigeria_nin, aadhaar, bangladesh_national_id, brazil_cpf_check, brazil_digital_cnh, philippine_match, philippine_qr, smart_id, mobile_id, idin, spid, trinsic_test_database_lookup, trinsic_test_sub_providers].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/recommend_request.rb

@@ -15,29 +15,13 @@ require 'time'
 
 module TrinsicApi
   class RecommendRequest
-    # The phone number of the user you wish to generate a recommendation for. Will be used to look up the user's identity in the network
-    attr_accessor :phone_number
-
-    # A list of countries, in alpha-2 ISO 3166 format, you wish to specify for the recommendation, this can include the user's country of residence, nationality, etc.
-    attr_accessor :countries
-
-    # If one of the countries has subdivisions, for example the US states, you can specify a list of these to further refine the recommendation (e.g., CA, UT, NY)
-    attr_accessor :subdivisions
-
-    # Provide the IP addresses of the user you wish to generate a recommendation for. Will be used to look up the user's geographic location.
-    attr_accessor :ip_addresses
-
-    # If true, the recommendation will include providers that are disabled for the app
-    attr_accessor :include_disabled_providers
+    # Information about the user you wish to generate a recommendation for.
+    attr_accessor :recommendation_info
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'phone_number' => :'phoneNumber',
-        :'countries' => :'countries',
-        :'subdivisions' => :'subdivisions',
-        :'ip_addresses' => :'ipAddresses',
-        :'include_disabled_providers' => :'includeDisabledProviders'
+        :'recommendation_info' => :'recommendationInfo'
       }
     end
 
@@ -49,22 +33,14 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'phone_number' => :'String',
-        :'countries' => :'Array<String>',
-        :'subdivisions' => :'Array<String>',
-        :'ip_addresses' => :'Array<String>',
-        :'include_disabled_providers' => :'Boolean'
+        :'recommendation_info' => :'RecommendationInfo'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'phone_number',
-        :'countries',
-        :'subdivisions',
-        :'ip_addresses',
-        :'include_disabled_providers'
+        :'recommendation_info'
       ])
     end
 
@@ -83,30 +59,8 @@ module TrinsicApi
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'phone_number')
-        self.phone_number = attributes[:'phone_number']
-      end
-
-      if attributes.key?(:'countries')
-        if (value = attributes[:'countries']).is_a?(Array)
-          self.countries = value
-        end
-      end
-
-      if attributes.key?(:'subdivisions')
-        if (value = attributes[:'subdivisions']).is_a?(Array)
-          self.subdivisions = value
-        end
-      end
-
-      if attributes.key?(:'ip_addresses')
-        if (value = attributes[:'ip_addresses']).is_a?(Array)
-          self.ip_addresses = value
-        end
-      end
-
-      if attributes.key?(:'include_disabled_providers')
-        self.include_disabled_providers = attributes[:'include_disabled_providers']
+      if attributes.key?(:'recommendation_info')
+        self.recommendation_info = attributes[:'recommendation_info']
       end
     end
 
@@ -130,11 +84,7 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          phone_number == o.phone_number &&
-          countries == o.countries &&
-          subdivisions == o.subdivisions &&
-          ip_addresses == o.ip_addresses &&
-          include_disabled_providers == o.include_disabled_providers
+          recommendation_info == o.recommendation_info
     end
 
     # @see the `==` method
@@ -146,7 +96,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, countries, subdivisions, ip_addresses, include_disabled_providers].hash
+      [recommendation_info].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/models/recommendation_info.rb

@@ -0,0 +1,256 @@
+=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.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Information relating to a user; used to generated Identity Provider recommendations.
+  class RecommendationInfo
+    # The phone number of the user you wish to generate a recommendation for.              Will be used to look up the user's identity in the network, as well as to determine the user's geographic location.
+    attr_accessor :phone_number
+
+    # A list of countries, in alpha-2 ISO 3166 format, which the user is related to.              This can include the user's country of residence, nationality, etc.
+    attr_accessor :countries
+
+    # If one of the countries has subdivisions (for example: US states), specify those related to the user here (e.g., CA, UT, NY)
+    attr_accessor :subdivisions
+
+    # Any IP addresses related to the user.              Will be used to determine the user's geographic location.
+    attr_accessor :ip_addresses
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'phone_number' => :'phoneNumber',
+        :'countries' => :'countries',
+        :'subdivisions' => :'subdivisions',
+        :'ip_addresses' => :'ipAddresses'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'phone_number' => :'String',
+        :'countries' => :'Array<String>',
+        :'subdivisions' => :'Array<String>',
+        :'ip_addresses' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'phone_number',
+        :'countries',
+        :'subdivisions',
+        :'ip_addresses'
+      ])
+    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::RecommendationInfo` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::RecommendationInfo`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      end
+
+      if attributes.key?(:'subdivisions')
+        if (value = attributes[:'subdivisions']).is_a?(Array)
+          self.subdivisions = value
+        end
+      end
+
+      if attributes.key?(:'ip_addresses')
+        if (value = attributes[:'ip_addresses']).is_a?(Array)
+          self.ip_addresses = value
+        end
+      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
+      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'
+      true
+    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 &&
+          phone_number == o.phone_number &&
+          countries == o.countries &&
+          subdivisions == o.subdivisions &&
+          ip_addresses == o.ip_addresses
+    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
+      [phone_number, countries, subdivisions, ip_addresses].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/result_collection.rb

@@ -18,7 +18,7 @@ module TrinsicApi
     # The method by which the results of the Acceptance Session should be collected.
     attr_accessor :method
 
-    # If the method is `PollResult`, this is the key that should be used to poll for the results.
+    # 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
 
     class EnumAttributeValidator
@@ -67,7 +67,6 @@ module TrinsicApi
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'results_access_key'
       ])
     end
 
@@ -94,6 +93,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
 
@@ -106,6 +107,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "method", method 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
 
@@ -114,6 +119,7 @@ module TrinsicApi
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @method.nil?
+      return false if @results_access_key.nil?
       true
     end
 

data/lib/trinsic_api/models/session.rb

@@ -17,13 +17,13 @@ module TrinsicApi
   class Session
     attr_accessor :id
 
-    # Whether the Session is in a terminal / final state.                If this is `true`, inspect the value of `Success` to determine whether the Session was successful.
+    # Whether the Session is in a terminal / final state.              If this is `true`, inspect the value of `Success` to determine whether the Session was successful.
     attr_accessor :done
 
-    # Whether the Session has completed successfully.                If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information.  If this is `true`, the Session has completed successfully.
+    # Whether the Session has completed successfully.              If this is `false`, the Session is either not yet done, or has failed. Inspect `Done` and `ErrorCode` for more information. If this is `true`, the Session has completed successfully.
     attr_accessor :success
 
-    # The reason for the Session's failure.                Only present if `Success` is `false`.
+    # The reason for the Session's failure.              Only present if `Success` is `false`.
     attr_accessor :error_code
 
     # The unix timestamp, in seconds, when this session was created