trinsic_api 0.2.3

data/docs/NetworkApi.md

@@ -0,0 +1,140 @@
+# TrinsicApi::NetworkApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**identity_lookup**](NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Query the availability of an identity in the Trinsic Network by phone number |
+| [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List all identity providers available for use |
+
+
+## identity_lookup
+
+> <IdentityLookupResponse> identity_lookup(phone_number)
+
+Query the availability of an identity in the Trinsic Network by phone number
+
+### 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
+phone_number = 'phone_number_example' # String | 
+
+begin
+  # Query the availability of an identity in the Trinsic Network by phone number
+  result = api_instance.identity_lookup(phone_number)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling NetworkApi->identity_lookup: #{e}"
+end
+```
+
+#### Using the identity_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IdentityLookupResponse>, Integer, Hash)> identity_lookup_with_http_info(phone_number)
+
+```ruby
+begin
+  # Query the availability of an identity in the Trinsic Network by phone number
+  data, status_code, headers = api_instance.identity_lookup_with_http_info(phone_number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IdentityLookupResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling NetworkApi->identity_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** |  |  |
+
+### Return type
+
+[**IdentityLookupResponse**](IdentityLookupResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+
+
+## list_providers
+
+> <ListProvidersResponse> 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
+
+begin
+  # List all identity providers available for use
+  result = api_instance.list_providers
+  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
+
+```ruby
+begin
+  # List all identity providers available for use
+  data, status_code, headers = api_instance.list_providers_with_http_info
+  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
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListProvidersResponse**](ListProvidersResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+

data/docs/OrderDirection.md

@@ -0,0 +1,15 @@
+# TrinsicApi::OrderDirection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::OrderDirection.new()
+```
+

data/docs/PersonData.md

@@ -0,0 +1,34 @@
+# TrinsicApi::PersonData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **given_name** | **String** | Given (first) name of the individual | [optional] |
+| **family_name** | **String** | Family (last) name of the individual | [optional] |
+| **middle_name** | **String** | Middle name of the individual | [optional] |
+| **full_name** | **String** | The individual's full name as a single string.                Useful for names which do not fit into a \"first middle last\" structure. | [optional] |
+| **nationality** | **String** |  | [optional] |
+| **gender** | **String** |  | [optional] |
+| **phone_number** | **String** |  | [optional] |
+| **address** | [**Address**](Address.md) | Address information for an individual | [optional] |
+| **date_of_birth** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::PersonData.new(
+  given_name: John,
+  family_name: Doe,
+  middle_name: Jacob,
+  full_name: John Jacob de Doe,
+  nationality: null,
+  gender: null,
+  phone_number: null,
+  address: null,
+  date_of_birth: null
+)
+```
+

data/docs/ProviderInfo.md

@@ -0,0 +1,22 @@
+# 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 |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderInfo.new(
+  id: yoti | clear | ...,
+  name: Yoti | CLEAR | ...,
+  logo_url: null
+)
+```
+

data/docs/Session.md

@@ -0,0 +1,30 @@
+# TrinsicApi::Session
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **state** | [**SessionState**](SessionState.md) | The state of the session |  |
+| **fail_code** | [**SessionFailCode**](SessionFailCode.md) | If the session is in state `IdvFailed`, this field contains the reason for failure. | [optional] |
+| **verification** | [**Verification**](Verification.md) | The underlying verification for this Session |  |
+| **disclosed_fields** | [**DisclosedFields**](DisclosedFields.md) | The fields that were requested to be disclosed when the Session was created |  |
+| **created** | **Integer** | The unix timestamp, in seconds, when this session was created |  |
+| **updated** | **Integer** | The unix timestamp, in seconds, when this session's state last changed |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Session.new(
+  id: 678c1ff6-2178-49e7-81d2-548afb6f85ec,
+  state: null,
+  fail_code: null,
+  verification: null,
+  disclosed_fields: null,
+  created: 1722526411,
+  updated: 1722526722
+)
+```
+

data/docs/SessionFailCode.md

@@ -0,0 +1,15 @@
+# TrinsicApi::SessionFailCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SessionFailCode.new()
+```
+

data/docs/SessionOrdering.md

@@ -0,0 +1,15 @@
+# TrinsicApi::SessionOrdering
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SessionOrdering.new()
+```
+

data/docs/SessionState.md

@@ -0,0 +1,15 @@
+# TrinsicApi::SessionState
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SessionState.new()
+```
+