trinsic_api 1.1.2 → 2.0.0.pre.alpha3

data/docs/SessionsApi.md

@@ -5,11 +5,14 @@ All URIs are relative to *https://api.trinsic.id*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session |
-| [**create_session**](SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create Session |
+| [**create_advanced_provider_session**](SessionsApi.md#create_advanced_provider_session) | **POST** /api/v1/sessions/provider/advanced | Create Advanced Provider Session |
+| [**create_hosted_provider_session**](SessionsApi.md#create_hosted_provider_session) | **POST** /api/v1/sessions/provider/hosted | Create Hosted Provider Session |
+| [**create_widget_session**](SessionsApi.md#create_widget_session) | **POST** /api/v1/sessions/widget | Create Widget Session |
 | [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session |
 | [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
-| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions |
+| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions/list | List Sessions |
 | [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
+| [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{acceptanceSessionId}/step/refresh | Refresh Step Content |
 
 
 ## cancel_session
@@ -81,13 +84,13 @@ end
 - **Accept**: text/plain, application/json, text/json
 
 
-## create_session
+## create_advanced_provider_session
 
-> <CreateSessionResponse> create_session(opts)
+> <CreateAdvancedProviderSessionResponse> create_advanced_provider_session(opts)
 
-Create Session
+Create Advanced Provider Session
 
-Create a Session to verify a user's identity
+Verify a user's identity with a specific provider, handling additional user interaction in your own UI.    Signal which kinds of user interactions your UI can handle using the `Capabilities` field.    If `FallbackToHostedUi` is `true`, Trinsic's hosted UI will automatically be invoked to handle any capabilities you do not support.
 
 ### Examples
 
@@ -102,33 +105,33 @@ end
 
 api_instance = TrinsicApi::SessionsApi.new
 opts = {
-  create_session_request: TrinsicApi::CreateSessionRequest.new # CreateSessionRequest | 
+  create_advanced_provider_session_request: TrinsicApi::CreateAdvancedProviderSessionRequest.new({provider: 'provider_example', capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateAdvancedProviderSessionRequest | 
 }
 
 begin
-  # Create Session
-  result = api_instance.create_session(opts)
+  # Create Advanced Provider Session
+  result = api_instance.create_advanced_provider_session(opts)
   p result
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling SessionsApi->create_session: #{e}"
+  puts "Error when calling SessionsApi->create_advanced_provider_session: #{e}"
 end
 ```
 
-#### Using the create_session_with_http_info variant
+#### Using the create_advanced_provider_session_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CreateSessionResponse>, Integer, Hash)> create_session_with_http_info(opts)
+> <Array(<CreateAdvancedProviderSessionResponse>, Integer, Hash)> create_advanced_provider_session_with_http_info(opts)
 
 ```ruby
 begin
-  # Create Session
-  data, status_code, headers = api_instance.create_session_with_http_info(opts)
+  # Create Advanced Provider Session
+  data, status_code, headers = api_instance.create_advanced_provider_session_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <CreateSessionResponse>
+  p data # => <CreateAdvancedProviderSessionResponse>
 rescue TrinsicApi::ApiError => e
-  puts "Error when calling SessionsApi->create_session_with_http_info: #{e}"
+  puts "Error when calling SessionsApi->create_advanced_provider_session_with_http_info: #{e}"
 end
 ```
 
@@ -136,11 +139,153 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) |  | [optional] |
+| **create_advanced_provider_session_request** | [**CreateAdvancedProviderSessionRequest**](CreateAdvancedProviderSessionRequest.md) |  | [optional] |
 
 ### Return type
 
-[**CreateSessionResponse**](CreateSessionResponse.md)
+[**CreateAdvancedProviderSessionResponse**](CreateAdvancedProviderSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json
+
+
+## create_hosted_provider_session
+
+> <CreateHostedProviderSessionResponse> create_hosted_provider_session(opts)
+
+Create Hosted Provider Session
+
+Verify a user's identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::SessionsApi.new
+opts = {
+  create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', redirect_url: 'redirect_url_example'}) # CreateHostedProviderSessionRequest | 
+}
+
+begin
+  # Create Hosted Provider Session
+  result = api_instance.create_hosted_provider_session(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_hosted_provider_session: #{e}"
+end
+```
+
+#### Using the create_hosted_provider_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateHostedProviderSessionResponse>, Integer, Hash)> create_hosted_provider_session_with_http_info(opts)
+
+```ruby
+begin
+  # Create Hosted Provider Session
+  data, status_code, headers = api_instance.create_hosted_provider_session_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateHostedProviderSessionResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_hosted_provider_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_hosted_provider_session_request** | [**CreateHostedProviderSessionRequest**](CreateHostedProviderSessionRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateHostedProviderSessionResponse**](CreateHostedProviderSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json
+
+
+## create_widget_session
+
+> <CreateWidgetSessionResponse> create_widget_session(opts)
+
+Create Widget Session
+
+Verify a user's identity using Trinsic's hosted Widget flow.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::SessionsApi.new
+opts = {
+  create_widget_session_request: TrinsicApi::CreateWidgetSessionRequest.new # CreateWidgetSessionRequest | 
+}
+
+begin
+  # Create Widget Session
+  result = api_instance.create_widget_session(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_widget_session: #{e}"
+end
+```
+
+#### Using the create_widget_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWidgetSessionResponse>, Integer, Hash)> create_widget_session_with_http_info(opts)
+
+```ruby
+begin
+  # Create Widget Session
+  data, status_code, headers = api_instance.create_widget_session_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWidgetSessionResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_widget_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_widget_session_request** | [**CreateWidgetSessionRequest**](CreateWidgetSessionRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateWidgetSessionResponse**](CreateWidgetSessionResponse.md)
 
 ### Authorization
 
@@ -436,3 +581,76 @@ nil (empty response body)
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## refresh_step_content
+
+> <RefreshStepContentResponse> refresh_step_content(acceptance_session_id, opts)
+
+Refresh Step Content
+
+Refreshes the content of a Step for an Advanced Provider Session.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::SessionsApi.new
+acceptance_session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new # RefreshStepContentRequest | 
+}
+
+begin
+  # Refresh Step Content
+  result = api_instance.refresh_step_content(acceptance_session_id, opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->refresh_step_content: #{e}"
+end
+```
+
+#### Using the refresh_step_content_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(acceptance_session_id, opts)
+
+```ruby
+begin
+  # Refresh Step Content
+  data, status_code, headers = api_instance.refresh_step_content_with_http_info(acceptance_session_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RefreshStepContentResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->refresh_step_content_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **acceptance_session_id** | **String** |  |  |
+| **refresh_step_content_request** | [**RefreshStepContentRequest**](RefreshStepContentRequest.md) |  | [optional] |
+
+### Return type
+
+[**RefreshStepContentResponse**](RefreshStepContentResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json
+

data/docs/{SessionFailCode.md → Sex.md}

@@ -1,4 +1,4 @@
-# TrinsicApi::SessionFailCode
+# TrinsicApi::Sex
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'trinsic_api'
 
-instance = TrinsicApi::SessionFailCode.new()
+instance = TrinsicApi::Sex.new()
 ```
 

data/docs/SouthAfricaNidInput.md

@@ -0,0 +1,24 @@
+# TrinsicApi::SouthAfricaNidInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | The user's full name as it appears in their National ID |  |
+| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format |  |
+| **gender** | **String** | The user's gender as it appears in their National ID (e.g., male, female) |  |
+| **national_id_number** | **String** | The user's South African National ID number |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SouthAfricaNidInput.new(
+  full_name: null,
+  date_of_birth: null,
+  gender: null,
+  national_id_number: null
+)
+```
+

data/docs/StepRefreshInfo.md

@@ -0,0 +1,22 @@
+# TrinsicApi::StepRefreshInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** | The UTC date/time at which the step `content` will expire and should no longer be used.                Use the `Refresh Step Content` API to obtain a new value for `content`. |  |
+| **refresh_after** | **Time** | The UTC date/time after which Trinsic recommends you refresh the step `content`. |  |
+| **time_to_live_seconds** | **Integer** | The total lifetime of the step `content`. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::StepRefreshInfo.new(
+  expires_at: null,
+  refresh_after: null,
+  time_to_live_seconds: null
+)
+```
+

data/lib/trinsic_api/api/attachments_api.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 

data/lib/trinsic_api/api/network_api.rb

@@ -1,5 +1,5 @@
 =begin
-#Connect API
+#Trinsic API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
@@ -19,31 +19,25 @@ module TrinsicApi
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Lookup Identity
-    # Query the availability of an identity in the Trinsic Network by phone number
-    # @param phone_number [String] 
+    # List Identity Providers
+    # List all identity providers available for use
     # @param [Hash] opts the optional parameters
-    # @return [IdentityLookupResponse]
-    def identity_lookup(phone_number, opts = {})
-      data, _status_code, _headers = identity_lookup_with_http_info(phone_number, opts)
+    # @return [ListProvidersResponse]
+    def list_providers(opts = {})
+      data, _status_code, _headers = list_providers_with_http_info(opts)
       data
     end
 
-    # Lookup Identity
-    # Query the availability of an identity in the Trinsic Network by phone number
-    # @param phone_number [String] 
+    # List Identity Providers
+    # List all identity providers available for use
     # @param [Hash] opts the optional parameters
-    # @return [Array<(IdentityLookupResponse, Integer, Hash)>] IdentityLookupResponse data, response status code and response headers
-    def identity_lookup_with_http_info(phone_number, opts = {})
+    # @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
+    def list_providers_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: NetworkApi.identity_lookup ...'
-      end
-      # verify the required parameter 'phone_number' is set
-      if @api_client.config.client_side_validation && phone_number.nil?
-        fail ArgumentError, "Missing the required parameter 'phone_number' when calling NetworkApi.identity_lookup"
+        @api_client.config.logger.debug 'Calling API: NetworkApi.list_providers ...'
       end
       # resource path
-      local_var_path = '/api/v1/network/identities/{phoneNumber}'.sub('{' + 'phoneNumber' + '}', CGI.escape(phone_number.to_s))
+      local_var_path = '/api/v1/network/providers'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -60,13 +54,13 @@ module TrinsicApi
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'IdentityLookupResponse'
+      return_type = opts[:debug_return_type] || 'ListProvidersResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['Bearer']
 
       new_options = opts.merge(
-        :operation => :"NetworkApi.identity_lookup",
+        :operation => :"NetworkApi.list_providers",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -77,30 +71,32 @@ module TrinsicApi
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: NetworkApi#identity_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: NetworkApi#list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List Identity Providers
-    # List all identity providers available for use
+    # Recommend Providers
+    # Generate provider recommendations based on the given signals (phone number, countries, states).
     # @param [Hash] opts the optional parameters
-    # @return [ListProvidersResponse]
-    def list_providers(opts = {})
-      data, _status_code, _headers = list_providers_with_http_info(opts)
+    # @option opts [RecommendRequest] :recommend_request 
+    # @return [RecommendResponse]
+    def recommend_providers(opts = {})
+      data, _status_code, _headers = recommend_providers_with_http_info(opts)
       data
     end
 
-    # List Identity Providers
-    # List all identity providers available for use
+    # Recommend Providers
+    # Generate provider recommendations based on the given signals (phone number, countries, states).
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
-    def list_providers_with_http_info(opts = {})
+    # @option opts [RecommendRequest] :recommend_request 
+    # @return [Array<(RecommendResponse, Integer, Hash)>] RecommendResponse 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: NetworkApi.list_providers ...'
+        @api_client.config.logger.debug 'Calling API: NetworkApi.recommend_providers ...'
       end
       # resource path
-      local_var_path = '/api/v1/network/providers'
+      local_var_path = '/api/v1/network/recommend'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -109,21 +105,26 @@ module TrinsicApi
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/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]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'recommend_request'])
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ListProvidersResponse'
+      return_type = opts[:debug_return_type] || 'RecommendResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['Bearer']
 
       new_options = opts.merge(
-        :operation => :"NetworkApi.list_providers",
+        :operation => :"NetworkApi.recommend_providers",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -132,9 +133,9 @@ module TrinsicApi
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      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: NetworkApi#list_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: NetworkApi#recommend_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end