trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/lib/trinsic_api/api/sessions_api.rb

@@ -274,6 +274,82 @@ module TrinsicApi
       return data, status_code, headers
     end
 
+    # Get Attachment
+    # Fetch an Attachment's contents.
+    # @param session_id [String] The ID of the Session to fetch the Attachment from
+    # @param attachment_id [String] The ID of the Attachment to fetch
+    # @param [Hash] opts the optional parameters
+    # @option opts [GetAttachmentRequest] :get_attachment_request 
+    # @return [GetAttachmentResponse]
+    def get_attachment(session_id, attachment_id, opts = {})
+      data, _status_code, _headers = get_attachment_with_http_info(session_id, attachment_id, opts)
+      data
+    end
+
+    # Get Attachment
+    # Fetch an Attachment's contents.
+    # @param session_id [String] The ID of the Session to fetch the Attachment from
+    # @param attachment_id [String] The ID of the Attachment to fetch
+    # @param [Hash] opts the optional parameters
+    # @option opts [GetAttachmentRequest] :get_attachment_request 
+    # @return [Array<(GetAttachmentResponse, Integer, Hash)>] GetAttachmentResponse data, response status code and response headers
+    def get_attachment_with_http_info(session_id, attachment_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SessionsApi.get_attachment ...'
+      end
+      # verify the required parameter 'session_id' is set
+      if @api_client.config.client_side_validation && session_id.nil?
+        fail ArgumentError, "Missing the required parameter 'session_id' when calling SessionsApi.get_attachment"
+      end
+      # verify the required parameter 'attachment_id' is set
+      if @api_client.config.client_side_validation && attachment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'attachment_id' when calling SessionsApi.get_attachment"
+      end
+      # resource path
+      local_var_path = '/api/v1/sessions/{sessionId}/attachments/{attachmentId}/get'.sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s)).sub('{' + 'attachmentId' + '}', CGI.escape(attachment_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'get_attachment_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAttachmentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"SessionsApi.get_attachment",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get Session
     # Get a Session by its ID
     # @param session_id [String] 
@@ -496,8 +572,72 @@ module TrinsicApi
       return data, status_code, headers
     end
 
+    # Recommend Providers
+    # Recommend providers for a specific user session. You can filter based on health (default=online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
+    # @param [Hash] opts the optional parameters
+    # @option opts [RecommendProvidersRequest] :recommend_providers_request 
+    # @return [RecommendProvidersResponse]
+    def recommend_providers(opts = {})
+      data, _status_code, _headers = recommend_providers_with_http_info(opts)
+      data
+    end
+
+    # Recommend Providers
+    # Recommend providers for a specific user session. You can filter based on health (default&#x3D;online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
+    # @param [Hash] opts the optional parameters
+    # @option opts [RecommendProvidersRequest] :recommend_providers_request 
+    # @return [Array<(RecommendProvidersResponse, Integer, Hash)>] RecommendProvidersResponse data, response status code and response headers
+    def recommend_providers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SessionsApi.recommend_providers ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/sessions/providers/recommend'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'recommend_providers_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RecommendProvidersResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"SessionsApi.recommend_providers",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#recommend_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Redact Session
-    # Redact a Session, removing all identity data from Trinsic's servers. Every application has a redaction period that dictates how long we will hold on to your users' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
+    # Redact a Session, removing all identity data from Trinsic's servers. Every verification profile has a redaction period that dictates how long we will hold on to your users' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
     # @param session_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -507,7 +647,7 @@ module TrinsicApi
     end
 
     # Redact Session
-    # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every application has a redaction period that dictates how long we will hold on to your users&#39; PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
+    # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every verification profile has a redaction period that dictates how long we will hold on to your users&#39; PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
     # @param session_id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

data/lib/trinsic_api/api/verification_profiles_api.rb

@@ -27,6 +27,7 @@ module TrinsicApi
     # @option opts [String] :primary_color The primary color of the verification profile. Must be a 6-character hex string prefixed with a '#' character. Example: #000000
     # @option opts [Array<String>] :providers The list of providers you&#39;d like to select for this profile. We will not currently enable any providers.
     # @option opts [File] :logo The logo of the verification profile.
+    # @option opts [Boolean] :is_production_usage Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
     # @return [CreateVerificationProfileResponse]
     def create_verification_profile(_alias, brand_name, opts = {})
       data, _status_code, _headers = create_verification_profile_with_http_info(_alias, brand_name, opts)
@@ -41,6 +42,7 @@ module TrinsicApi
     # @option opts [String] :primary_color The primary color of the verification profile. Must be a 6-character hex string prefixed with a &#39;#&#39; character. Example: #000000
     # @option opts [Array<String>] :providers The list of providers you&#39;d like to select for this profile. We will not currently enable any providers.
     # @option opts [File] :logo The logo of the verification profile.
+    # @option opts [Boolean] :is_production_usage Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
     # @return [Array<(CreateVerificationProfileResponse, Integer, Hash)>] CreateVerificationProfileResponse data, response status code and response headers
     def create_verification_profile_with_http_info(_alias, brand_name, opts = {})
       if @api_client.config.debugging
@@ -101,6 +103,7 @@ module TrinsicApi
       form_params['PrimaryColor'] = opts[:'primary_color'] if !opts[:'primary_color'].nil?
       form_params['Providers'] = @api_client.build_collection_param(opts[:'providers'], :multi) if !opts[:'providers'].nil?
       form_params['Logo'] = opts[:'logo'] if !opts[:'logo'].nil?
+      form_params['IsProductionUsage'] = opts[:'is_production_usage'] if !opts[:'is_production_usage'].nil?
 
       # http body (model)
       post_body = opts[:debug_body]

data/lib/trinsic_api/models/{environment_redirect_uris_add_request.rb → add_redirect_uri_request.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
-  class EnvironmentRedirectUrisAddRequest
+  class AddRedirectUriRequest
     attr_accessor :uri
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,14 +51,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::EnvironmentRedirectUrisAddRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::AddRedirectUriRequest` 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::EnvironmentRedirectUrisAddRequest`. 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::AddRedirectUriRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -79,6 +79,10 @@ module TrinsicApi
         invalid_properties.push('invalid value for "uri", uri cannot be nil.')
       end
 
+      if @uri.to_s.length < 1
+        invalid_properties.push('invalid value for "uri", the character length must be great than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -87,6 +91,7 @@ module TrinsicApi
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @uri.nil?
+      return false if @uri.to_s.length < 1
       true
     end
 
@@ -97,6 +102,10 @@ module TrinsicApi
         fail ArgumentError, 'uri cannot be nil'
       end
 
+      if uri.to_s.length < 1
+        fail ArgumentError, 'invalid value for "uri", the character length must be great than or equal to 1.'
+      end
+
       @uri = uri
     end
 

data/lib/trinsic_api/models/address.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module TrinsicApi
+  # Address information for an individual
   class Address
     attr_accessor :line1
 
@@ -23,12 +24,14 @@ module TrinsicApi
 
     attr_accessor :city
 
+    # The subdivision code of the address.              Subdivision refers to a state, province, or other similar division of a country. Examples include \"CA\" for California, \"QC\" for Québec, \"MD\" for Madrid, or \"NSW\" for New South Wales.
     attr_accessor :subdivision
 
     attr_accessor :postal_code
 
     attr_accessor :country
 
+    # The full address as a single string
     attr_accessor :full_address
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/trinsic_api/models/apple_wallet_provider_output.rb

@@ -0,0 +1,239 @@
+=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
+  # Exposed properties for the `apple-wallet` Provider which do not directly map to the normalized IdentityData model.
+  class AppleWalletProviderOutput
+    # The raw output of the mDL exchange performed through Apple Wallet.
+    attr_accessor :raw_mdl_output
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'raw_mdl_output' => :'rawMdlOutput'
+      }
+    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
+      {
+        :'raw_mdl_output' => :'MdlOutput'
+      }
+    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::AppleWalletProviderOutput` 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::AppleWalletProviderOutput`. 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?(:'raw_mdl_output')
+        self.raw_mdl_output = attributes[:'raw_mdl_output']
+      else
+        self.raw_mdl_output = 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 @raw_mdl_output.nil?
+        invalid_properties.push('invalid value for "raw_mdl_output", raw_mdl_output 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 @raw_mdl_output.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] raw_mdl_output Value to be assigned
+    def raw_mdl_output=(raw_mdl_output)
+      if raw_mdl_output.nil?
+        fail ArgumentError, 'raw_mdl_output cannot be nil'
+      end
+
+      @raw_mdl_output = raw_mdl_output
+    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 &&
+          raw_mdl_output == o.raw_mdl_output
+    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
+      [raw_mdl_output].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