trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/docs/NetworkApi.md

@@ -1,223 +0,0 @@
-# TrinsicApi::NetworkApi
-
-All URIs are relative to *https://api.trinsic.id*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/{verificationProfileId}/providers/contracts | List Provider Contracts |
-| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/{verificationProfileId}/providers | List Providers |
-| [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
-
-
-## list_provider_contracts
-
-> <ListProviderContractsResponse> list_provider_contracts(verification_profile_id)
-
-List Provider Contracts
-
-List the contracts for all Providers available to your App.              If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.
-
-### 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::NetworkApi.new
-verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
-
-begin
-  # List Provider Contracts
-  result = api_instance.list_provider_contracts(verification_profile_id)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_provider_contracts: #{e}"
-end
-```
-
-#### Using the list_provider_contracts_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info(verification_profile_id)
-
-```ruby
-begin
-  # List Provider Contracts
-  data, status_code, headers = api_instance.list_provider_contracts_with_http_info(verification_profile_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListProviderContractsResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_provider_contracts_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **verification_profile_id** | **String** |  |  |
-
-### Return type
-
-[**ListProviderContractsResponse**](ListProviderContractsResponse.md)
-
-### Authorization
-
-[Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: text/plain, application/json, text/json, application/problem+json
-
-
-## list_providers
-
-> <ListProvidersResponse> list_providers(verification_profile_id, opts)
-
-List Providers
-
-List all identity providers available for use
-
-### 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::NetworkApi.new
-verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
-opts = {
-  health: 'health_example' # String | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\".
-}
-
-begin
-  # List Providers
-  result = api_instance.list_providers(verification_profile_id, opts)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_providers: #{e}"
-end
-```
-
-#### Using the list_providers_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info(verification_profile_id, opts)
-
-```ruby
-begin
-  # List Providers
-  data, status_code, headers = api_instance.list_providers_with_http_info(verification_profile_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListProvidersResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->list_providers_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **verification_profile_id** | **String** |  |  |
-| **health** | **String** | Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;. | [optional] |
-
-### Return type
-
-[**ListProvidersResponse**](ListProvidersResponse.md)
-
-### Authorization
-
-[Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: text/plain, application/json, text/json, application/problem+json
-
-
-## recommend_providers
-
-> <RecommendResponse> recommend_providers(opts)
-
-Recommend Providers
-
-Generate provider recommendations based on signals about the user's location (phone number, countries, states).
-
-### 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::NetworkApi.new
-opts = {
-  recommend_request: TrinsicApi::RecommendRequest.new({verification_profile_id: 'verification_profile_id_example'}) # RecommendRequest | 
-}
-
-begin
-  # Recommend Providers
-  result = api_instance.recommend_providers(opts)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->recommend_providers: #{e}"
-end
-```
-
-#### Using the recommend_providers_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RecommendResponse>, Integer, Hash)> recommend_providers_with_http_info(opts)
-
-```ruby
-begin
-  # Recommend Providers
-  data, status_code, headers = api_instance.recommend_providers_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RecommendResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling NetworkApi->recommend_providers_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **recommend_request** | [**RecommendRequest**](RecommendRequest.md) |  | [optional] |
-
-### Return type
-
-[**RecommendResponse**](RecommendResponse.md)
-
-### Authorization
-
-[Bearer](../README.md#Bearer)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, text/json, application/*+json
-- **Accept**: text/plain, application/json, text/json, application/problem+json
-

data/docs/ProviderAttachments.md

@@ -1,18 +0,0 @@
-# TrinsicApi::ProviderAttachments
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **document_scan** | [**DocumentScanAttachments**](DocumentScanAttachments.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::ProviderAttachments.new(
-  document_scan: null
-)
-```
-

data/docs/ProviderInfo.md

@@ -1,30 +0,0 @@
-# TrinsicApi::ProviderInfo
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The ID of the provider |  |
-| **name** | **String** | The friendly, human-readable name of the provider |  |
-| **logo_url** | **String** | A URL pointing to the provider's logo |  |
-| **subtext** | **String** | 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. |  |
-| **description** | **String** | 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. |  |
-| **health** | **String** | The current health status of the provider |  |
-| **sub_providers** | [**Array<SubProviderMetadata>**](SubProviderMetadata.md) | 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. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::ProviderInfo.new(
-  id: yoti | clear | ...,
-  name: Yoti | CLEAR | ...,
-  logo_url: null,
-  subtext: dmv.ca.gov,
-  description: dmv.ca.gov,
-  health: online | offline,
-  sub_providers: null
-)
-```
-

data/docs/RecommendResponse.md

@@ -1,22 +0,0 @@
-# TrinsicApi::RecommendResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **recognized** | [**Array<ProviderInformation>**](ProviderInformation.md) | The providers which the user is known to have a credential with. |  |
-| **relevant** | [**Array<ProviderInformation>**](ProviderInformation.md) | The providers which the user is deemed sufficiently likely to have a credential with. |  |
-| **remainder** | [**Array<ProviderInformation>**](ProviderInformation.md) | 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. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::RecommendResponse.new(
-  recognized: null,
-  relevant: null,
-  remainder: null
-)
-```
-

data/lib/trinsic_api/api/attachments_api.rb

@@ -1,86 +0,0 @@
-=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 'cgi'
-
-module TrinsicApi
-  class AttachmentsApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Get Attachment
-    # Exchange an Attachment Access Key (from `IdentityData.AttachmentAccessKeys`) for the raw contents of the attachment.              Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant.              In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
-    # @param [Hash] opts the optional parameters
-    # @option opts [GetAttachmentRequest] :get_attachment_request 
-    # @return [GetAttachmentResponse]
-    def get_attachment(opts = {})
-      data, _status_code, _headers = get_attachment_with_http_info(opts)
-      data
-    end
-
-    # Get Attachment
-    # Exchange an Attachment Access Key (from `IdentityData.AttachmentAccessKeys`) for the raw contents of the attachment.              Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant.              In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
-    # @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(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AttachmentsApi.get_attachment ...'
-      end
-      # resource path
-      local_var_path = '/api/v1/attachments/attachment'
-
-      # 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 => :"AttachmentsApi.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: AttachmentsApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/trinsic_api/api/mdl_api.rb

@@ -1,150 +0,0 @@
-=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 'cgi'
-
-module TrinsicApi
-  class MdlApi
-    attr_accessor :api_client
-
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Create mDL Exchange
-    # Creates a new mDL Exchange, returning an exchange ID, request object string, and context string.              mDL Exchanges are ephemeral until completion -- no state is stored within Trinsic until the exchange is finalized.              This API currently only supports Google Wallet on Android via Web or Native. Apple Wallet support is coming soon.
-    # @param [Hash] opts the optional parameters
-    # @option opts [CreateMdlExchangeRequest] :create_mdl_exchange_request 
-    # @return [CreateMdlExchangeResponse]
-    def create_mdl_exchange(opts = {})
-      data, _status_code, _headers = create_mdl_exchange_with_http_info(opts)
-      data
-    end
-
-    # Create mDL Exchange
-    # Creates a new mDL Exchange, returning an exchange ID, request object string, and context string.              mDL Exchanges are ephemeral until completion -- no state is stored within Trinsic until the exchange is finalized.              This API currently only supports Google Wallet on Android via Web or Native. Apple Wallet support is coming soon.
-    # @param [Hash] opts the optional parameters
-    # @option opts [CreateMdlExchangeRequest] :create_mdl_exchange_request 
-    # @return [Array<(CreateMdlExchangeResponse, Integer, Hash)>] CreateMdlExchangeResponse data, response status code and response headers
-    def create_mdl_exchange_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MdlApi.create_mdl_exchange ...'
-      end
-      # resource path
-      local_var_path = '/api/valpha/mdl/exchanges/create'
-
-      # 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[:'create_mdl_exchange_request'])
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'CreateMdlExchangeResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['Bearer']
-
-      new_options = opts.merge(
-        :operation => :"MdlApi.create_mdl_exchange",
-        :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: MdlApi#create_mdl_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Finalize mDL Exchange
-    # Finalizes an mDL Exchange, processing the results
-    # @param [Hash] opts the optional parameters
-    # @option opts [FinalizeMdlExchangeRequest] :finalize_mdl_exchange_request 
-    # @return [FinalizeMdlExchangeResponse]
-    def finalize_mdl_exchange(opts = {})
-      data, _status_code, _headers = finalize_mdl_exchange_with_http_info(opts)
-      data
-    end
-
-    # Finalize mDL Exchange
-    # Finalizes an mDL Exchange, processing the results
-    # @param [Hash] opts the optional parameters
-    # @option opts [FinalizeMdlExchangeRequest] :finalize_mdl_exchange_request 
-    # @return [Array<(FinalizeMdlExchangeResponse, Integer, Hash)>] FinalizeMdlExchangeResponse data, response status code and response headers
-    def finalize_mdl_exchange_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: MdlApi.finalize_mdl_exchange ...'
-      end
-      # resource path
-      local_var_path = '/api/valpha/mdl/exchanges/finalize'
-
-      # 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[:'finalize_mdl_exchange_request'])
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'FinalizeMdlExchangeResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['Bearer']
-
-      new_options = opts.merge(
-        :operation => :"MdlApi.finalize_mdl_exchange",
-        :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: MdlApi#finalize_mdl_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end