trinsic_api 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +137 -0
  4. data/Rakefile +10 -0
  5. data/docs/Address.md +32 -0
  6. data/docs/Attachments.md +24 -0
  7. data/docs/AttachmentsApi.md +76 -0
  8. data/docs/CancelSessionResponse.md +18 -0
  9. data/docs/CreateSessionRequest.md +22 -0
  10. data/docs/CreateSessionResponse.md +20 -0
  11. data/docs/DisclosedFields.md +40 -0
  12. data/docs/DisclosedFieldsRequest.md +40 -0
  13. data/docs/DocumentData.md +28 -0
  14. data/docs/ExchangeAttachmentAccessKeyRequest.md +18 -0
  15. data/docs/ExchangeResultsKeyRequest.md +18 -0
  16. data/docs/ExchangeResultsKeyResponse.md +20 -0
  17. data/docs/FailureMessage.md +18 -0
  18. data/docs/GetSessionResponse.md +18 -0
  19. data/docs/IdentityData.md +24 -0
  20. data/docs/IdentityLookupResponse.md +18 -0
  21. data/docs/ListProvidersResponse.md +18 -0
  22. data/docs/ListSessionsResponse.md +22 -0
  23. data/docs/NetworkApi.md +140 -0
  24. data/docs/OrderDirection.md +15 -0
  25. data/docs/PersonData.md +34 -0
  26. data/docs/ProviderInfo.md +22 -0
  27. data/docs/Session.md +30 -0
  28. data/docs/SessionFailCode.md +15 -0
  29. data/docs/SessionOrdering.md +15 -0
  30. data/docs/SessionState.md +15 -0
  31. data/docs/SessionsApi.md +428 -0
  32. data/docs/ValidationResult.md +20 -0
  33. data/docs/Verification.md +20 -0
  34. data/docs/VerificationFailCode.md +15 -0
  35. data/git_push.sh +57 -0
  36. data/lib/trinsic_api/api/attachments_api.rb +84 -0
  37. data/lib/trinsic_api/api/network_api.rb +138 -0
  38. data/lib/trinsic_api/api/sessions_api.rb +418 -0
  39. data/lib/trinsic_api/api_client.rb +394 -0
  40. data/lib/trinsic_api/api_error.rb +58 -0
  41. data/lib/trinsic_api/configuration.rb +308 -0
  42. data/lib/trinsic_api/models/address.rb +279 -0
  43. data/lib/trinsic_api/models/attachments.rb +246 -0
  44. data/lib/trinsic_api/models/cancel_session_response.rb +221 -0
  45. data/lib/trinsic_api/models/create_session_request.rb +237 -0
  46. data/lib/trinsic_api/models/create_session_response.rb +232 -0
  47. data/lib/trinsic_api/models/disclosed_fields.rb +397 -0
  48. data/lib/trinsic_api/models/disclosed_fields_request.rb +313 -0
  49. data/lib/trinsic_api/models/document_data.rb +259 -0
  50. data/lib/trinsic_api/models/exchange_attachment_access_key_request.rb +241 -0
  51. data/lib/trinsic_api/models/exchange_results_key_request.rb +222 -0
  52. data/lib/trinsic_api/models/exchange_results_key_response.rb +230 -0
  53. data/lib/trinsic_api/models/failure_message.rb +221 -0
  54. data/lib/trinsic_api/models/get_session_response.rb +221 -0
  55. data/lib/trinsic_api/models/identity_data.rb +245 -0
  56. data/lib/trinsic_api/models/identity_lookup_response.rb +222 -0
  57. data/lib/trinsic_api/models/list_providers_response.rb +224 -0
  58. data/lib/trinsic_api/models/list_sessions_response.rb +257 -0
  59. data/lib/trinsic_api/models/order_direction.rb +40 -0
  60. data/lib/trinsic_api/models/person_data.rb +292 -0
  61. data/lib/trinsic_api/models/provider_info.rb +257 -0
  62. data/lib/trinsic_api/models/session.rb +338 -0
  63. data/lib/trinsic_api/models/session_fail_code.rb +45 -0
  64. data/lib/trinsic_api/models/session_ordering.rb +41 -0
  65. data/lib/trinsic_api/models/session_state.rb +44 -0
  66. data/lib/trinsic_api/models/validation_result.rb +232 -0
  67. data/lib/trinsic_api/models/verification.rb +248 -0
  68. data/lib/trinsic_api/models/verification_fail_code.rb +43 -0
  69. data/lib/trinsic_api/version.rb +15 -0
  70. data/lib/trinsic_api.rb +69 -0
  71. data/spec/api/attachments_api_spec.rb +46 -0
  72. data/spec/api/network_api_spec.rb +56 -0
  73. data/spec/api/sessions_api_spec.rb +105 -0
  74. data/spec/models/address_spec.rb +78 -0
  75. data/spec/models/attachments_spec.rb +54 -0
  76. data/spec/models/cancel_session_response_spec.rb +36 -0
  77. data/spec/models/create_session_request_spec.rb +48 -0
  78. data/spec/models/create_session_response_spec.rb +42 -0
  79. data/spec/models/disclosed_fields_request_spec.rb +102 -0
  80. data/spec/models/disclosed_fields_spec.rb +102 -0
  81. data/spec/models/document_data_spec.rb +66 -0
  82. data/spec/models/exchange_attachment_access_key_request_spec.rb +36 -0
  83. data/spec/models/exchange_results_key_request_spec.rb +36 -0
  84. data/spec/models/exchange_results_key_response_spec.rb +42 -0
  85. data/spec/models/failure_message_spec.rb +36 -0
  86. data/spec/models/get_session_response_spec.rb +36 -0
  87. data/spec/models/identity_data_spec.rb +54 -0
  88. data/spec/models/identity_lookup_response_spec.rb +36 -0
  89. data/spec/models/list_providers_response_spec.rb +36 -0
  90. data/spec/models/list_sessions_response_spec.rb +48 -0
  91. data/spec/models/order_direction_spec.rb +30 -0
  92. data/spec/models/person_data_spec.rb +84 -0
  93. data/spec/models/provider_info_spec.rb +48 -0
  94. data/spec/models/session_fail_code_spec.rb +30 -0
  95. data/spec/models/session_ordering_spec.rb +30 -0
  96. data/spec/models/session_spec.rb +72 -0
  97. data/spec/models/session_state_spec.rb +30 -0
  98. data/spec/models/validation_result_spec.rb +42 -0
  99. data/spec/models/verification_fail_code_spec.rb +30 -0
  100. data/spec/models/verification_spec.rb +42 -0
  101. data/spec/spec_helper.rb +111 -0
  102. data/trinsic_api.gemspec +39 -0
  103. metadata +215 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 0b650b61100978c4f6cc8aea2249d041eefc5316e89183f4bd5658b23ba54c51
4
+ data.tar.gz: a16b1b87244afa788b2ba0ab1ee61e3db66af8652c0292aa8b4d3f2bf3d1b1f9
5
+ SHA512:
6
+ metadata.gz: d081cf682426fde3f91bbf8dff5ce522dbec774f7efcad79d649d5935b60b955e4adc94a6ed48aaba28000ba60a2339f774453be2cb65e89984416aba921edd3
7
+ data.tar.gz: 0a841c4a960db6c62859128c225a6829de322cd98b8d338bbce3c7ddaf7ebde6a4cbfc920ced53802efe17cb3b23c775f80f4fb4d1589a04ea46db2600c1d2fd
data/Gemfile ADDED
@@ -0,0 +1,9 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 13.0.1'
7
+ gem 'pry-byebug'
8
+ gem 'rubocop', '~> 0.66.0'
9
+ end
data/README.md ADDED
@@ -0,0 +1,137 @@
1
+ # trinsic_api
2
+
3
+ TrinsicApi - the Ruby gem for the Connect API
4
+
5
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: v1
10
+ - Package version: 0.2.3
11
+ - Generator version: 7.7.0
12
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
+
14
+ ## Installation
15
+
16
+ ### Build a gem
17
+
18
+ To build the Ruby code into a gem:
19
+
20
+ ```shell
21
+ gem build trinsic_api.gemspec
22
+ ```
23
+
24
+ Then either install the gem locally:
25
+
26
+ ```shell
27
+ gem install ./trinsic_api-0.2.3.gem
28
+ ```
29
+
30
+ (for development, run `gem install --dev ./trinsic_api-0.2.3.gem` to install the development dependencies)
31
+
32
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
+
34
+ Finally add this to the Gemfile:
35
+
36
+ gem 'trinsic_api', '~> 0.2.3'
37
+
38
+ ### Install from Git
39
+
40
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
41
+
42
+ gem 'trinsic_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43
+
44
+ ### Include the Ruby code directly
45
+
46
+ Include the Ruby code directly using `-I` as follows:
47
+
48
+ ```shell
49
+ ruby -Ilib script.rb
50
+ ```
51
+
52
+ ## Getting Started
53
+
54
+ Please follow the [installation](#installation) procedure and then run the following code:
55
+
56
+ ```ruby
57
+ # Load the gem
58
+ require 'trinsic_api'
59
+
60
+ # Setup authorization
61
+ TrinsicApi.configure do |config|
62
+ # Configure Bearer authorization: Bearer
63
+ config.access_token = 'YOUR_BEARER_TOKEN'
64
+ # Configure a proc to get access tokens in lieu of the static access_token configuration
65
+ config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
66
+ end
67
+
68
+ api_instance = TrinsicApi::AttachmentsApi.new
69
+ opts = {
70
+ exchange_attachment_access_key_request: TrinsicApi::ExchangeAttachmentAccessKeyRequest.new({attachment_access_key: 'attachment_access_key_example'}) # ExchangeAttachmentAccessKeyRequest |
71
+ }
72
+
73
+ begin
74
+ #Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later.
75
+ api_instance.exchange_attachment_access_key(opts)
76
+ rescue TrinsicApi::ApiError => e
77
+ puts "Exception when calling AttachmentsApi->exchange_attachment_access_key: #{e}"
78
+ end
79
+
80
+ ```
81
+
82
+ ## Documentation for API Endpoints
83
+
84
+ All URIs are relative to *https://api.trinsic.id*
85
+
86
+ Class | Method | HTTP request | Description
87
+ ------------ | ------------- | ------------- | -------------
88
+ *TrinsicApi::AttachmentsApi* | [**exchange_attachment_access_key**](docs/AttachmentsApi.md#exchange_attachment_access_key) | **POST** /api/v1/attachments/exchange | Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later.
89
+ *TrinsicApi::NetworkApi* | [**identity_lookup**](docs/NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Query the availability of an identity in the Trinsic Network by phone number
90
+ *TrinsicApi::NetworkApi* | [**list_providers**](docs/NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List all identity providers available for use
91
+ *TrinsicApi::SessionsApi* | [**cancel_session**](docs/SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel a Session by its ID
92
+ *TrinsicApi::SessionsApi* | [**create_session**](docs/SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create a Session to verify a user's identity
93
+ *TrinsicApi::SessionsApi* | [**exchange_results_key**](docs/SessionsApi.md#exchange_results_key) | **POST** /api/v1/sessions/{sessionId}/results/exchange | Exchange a Results Access Key for Identity Data
94
+ *TrinsicApi::SessionsApi* | [**get_session**](docs/SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get a Session by its ID
95
+ *TrinsicApi::SessionsApi* | [**list_sessions**](docs/SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions created by your account
96
+ *TrinsicApi::SessionsApi* | [**redact_session**](docs/SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact a Session, removing all identity data from Trinsic's servers. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
97
+
98
+
99
+ ## Documentation for Models
100
+
101
+ - [TrinsicApi::Address](docs/Address.md)
102
+ - [TrinsicApi::Attachments](docs/Attachments.md)
103
+ - [TrinsicApi::CancelSessionResponse](docs/CancelSessionResponse.md)
104
+ - [TrinsicApi::CreateSessionRequest](docs/CreateSessionRequest.md)
105
+ - [TrinsicApi::CreateSessionResponse](docs/CreateSessionResponse.md)
106
+ - [TrinsicApi::DisclosedFields](docs/DisclosedFields.md)
107
+ - [TrinsicApi::DisclosedFieldsRequest](docs/DisclosedFieldsRequest.md)
108
+ - [TrinsicApi::DocumentData](docs/DocumentData.md)
109
+ - [TrinsicApi::ExchangeAttachmentAccessKeyRequest](docs/ExchangeAttachmentAccessKeyRequest.md)
110
+ - [TrinsicApi::ExchangeResultsKeyRequest](docs/ExchangeResultsKeyRequest.md)
111
+ - [TrinsicApi::ExchangeResultsKeyResponse](docs/ExchangeResultsKeyResponse.md)
112
+ - [TrinsicApi::FailureMessage](docs/FailureMessage.md)
113
+ - [TrinsicApi::GetSessionResponse](docs/GetSessionResponse.md)
114
+ - [TrinsicApi::IdentityData](docs/IdentityData.md)
115
+ - [TrinsicApi::IdentityLookupResponse](docs/IdentityLookupResponse.md)
116
+ - [TrinsicApi::ListProvidersResponse](docs/ListProvidersResponse.md)
117
+ - [TrinsicApi::ListSessionsResponse](docs/ListSessionsResponse.md)
118
+ - [TrinsicApi::OrderDirection](docs/OrderDirection.md)
119
+ - [TrinsicApi::PersonData](docs/PersonData.md)
120
+ - [TrinsicApi::ProviderInfo](docs/ProviderInfo.md)
121
+ - [TrinsicApi::Session](docs/Session.md)
122
+ - [TrinsicApi::SessionFailCode](docs/SessionFailCode.md)
123
+ - [TrinsicApi::SessionOrdering](docs/SessionOrdering.md)
124
+ - [TrinsicApi::SessionState](docs/SessionState.md)
125
+ - [TrinsicApi::ValidationResult](docs/ValidationResult.md)
126
+ - [TrinsicApi::Verification](docs/Verification.md)
127
+ - [TrinsicApi::VerificationFailCode](docs/VerificationFailCode.md)
128
+
129
+
130
+ ## Documentation for Authorization
131
+
132
+
133
+ Authentication schemes defined for the API:
134
+ ### Bearer
135
+
136
+ - **Type**: Bearer authentication
137
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
data/docs/Address.md ADDED
@@ -0,0 +1,32 @@
1
+ # TrinsicApi::Address
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **line1** | **String** | | [optional] |
8
+ | **line2** | **String** | | [optional] |
9
+ | **line3** | **String** | | [optional] |
10
+ | **city** | **String** | | [optional] |
11
+ | **state** | **String** | | [optional] |
12
+ | **postal_code** | **String** | | [optional] |
13
+ | **country** | **String** | | [optional] |
14
+ | **full_address** | **String** | The full address as a single string | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trinsic_api'
20
+
21
+ instance = TrinsicApi::Address.new(
22
+ line1: null,
23
+ line2: null,
24
+ line3: null,
25
+ city: null,
26
+ state: null,
27
+ postal_code: null,
28
+ country: null,
29
+ full_address: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::Attachments
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **selfie** | **String** | Key to access the selfie image (if relevant) for this verification | [optional] |
8
+ | **document_front** | **String** | Key to access the document front image (if relevant) for this verification | [optional] |
9
+ | **document_back** | **String** | Key to access the document back image (if relevant) for this verification | [optional] |
10
+ | **document_portrait** | **String** | Key to access the document portrait image (if relevant and available) for this verification. Specifically, this is a cropped version of the document front image which includes only the portrait on the document. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::Attachments.new(
18
+ selfie: null,
19
+ document_front: null,
20
+ document_back: null,
21
+ document_portrait: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,76 @@
1
+ # TrinsicApi::AttachmentsApi
2
+
3
+ All URIs are relative to *https://api.trinsic.id*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**exchange_attachment_access_key**](AttachmentsApi.md#exchange_attachment_access_key) | **POST** /api/v1/attachments/exchange | Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later. |
8
+
9
+
10
+ ## exchange_attachment_access_key
11
+
12
+ > exchange_attachment_access_key(opts)
13
+
14
+ Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later.
15
+
16
+ ### Examples
17
+
18
+ ```ruby
19
+ require 'time'
20
+ require 'trinsic_api'
21
+ # setup authorization
22
+ TrinsicApi.configure do |config|
23
+ # Configure Bearer authorization: Bearer
24
+ config.access_token = 'YOUR_BEARER_TOKEN'
25
+ end
26
+
27
+ api_instance = TrinsicApi::AttachmentsApi.new
28
+ opts = {
29
+ exchange_attachment_access_key_request: TrinsicApi::ExchangeAttachmentAccessKeyRequest.new({attachment_access_key: 'attachment_access_key_example'}) # ExchangeAttachmentAccessKeyRequest |
30
+ }
31
+
32
+ begin
33
+ # Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later.
34
+ api_instance.exchange_attachment_access_key(opts)
35
+ rescue TrinsicApi::ApiError => e
36
+ puts "Error when calling AttachmentsApi->exchange_attachment_access_key: #{e}"
37
+ end
38
+ ```
39
+
40
+ #### Using the exchange_attachment_access_key_with_http_info variant
41
+
42
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
43
+
44
+ > <Array(nil, Integer, Hash)> exchange_attachment_access_key_with_http_info(opts)
45
+
46
+ ```ruby
47
+ begin
48
+ # Exchange an Attachment Access Key (from `IdentityData.Attachments`) 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 202 code, and you should try again later.
49
+ data, status_code, headers = api_instance.exchange_attachment_access_key_with_http_info(opts)
50
+ p status_code # => 2xx
51
+ p headers # => { ... }
52
+ p data # => nil
53
+ rescue TrinsicApi::ApiError => e
54
+ puts "Error when calling AttachmentsApi->exchange_attachment_access_key_with_http_info: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ | Name | Type | Description | Notes |
61
+ | ---- | ---- | ----------- | ----- |
62
+ | **exchange_attachment_access_key_request** | [**ExchangeAttachmentAccessKeyRequest**](ExchangeAttachmentAccessKeyRequest.md) | | [optional] |
63
+
64
+ ### Return type
65
+
66
+ nil (empty response body)
67
+
68
+ ### Authorization
69
+
70
+ [Bearer](../README.md#Bearer)
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json, text/json, application/*+json
75
+ - **Accept**: application/json
76
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::CancelSessionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session** | [**Session**](Session.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::CancelSessionResponse.new(
15
+ session: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::CreateSessionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **launch_method_directly** | **Boolean** | Whether to immediately launch the identity provider, without invoking the Trinsic Connect Widget UI. Users will not be shown the Connect Widget; therefore, reuse of Connect credentials, selection of an identity provider, and saving a verification for future reuse are not available to the end user in this mode. Sessions created with this option enabled must be created with a &#x60;RedirectUrl&#x60; specified, and cannot be invoked using the frontend SDK at this time. | [optional] |
8
+ | **providers** | **Array&lt;String&gt;** | The list of allowed identity providers. If not specified, all available providers will be allowed. If &#x60;LaunchMethodDirectly&#x60; is &#x60;true&#x60;, this field must be set, and must have only a single entry. If &#x60;LaunchMethodDirectly&#x60; is not specified or is &#x60;false&#x60;, this field may have any number of entries. | [optional] |
9
+ | **disclosed_fields** | [**DisclosedFieldsRequest**](DisclosedFieldsRequest.md) | Specific identity attributes to request. If not provided, all available attributes will be requested. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::CreateSessionRequest.new(
17
+ launch_method_directly: null,
18
+ providers: null,
19
+ disclosed_fields: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::CreateSessionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session** | [**Session**](Session.md) | The created Acceptance Session | |
8
+ | **launch_url** | **String** | The URL that should be used to invoke the Acceptance Session on your user&#39;s device. If the Session was created with &#x60;LaunchMethodDirectly&#x60; set to &#x60;true&#x60;, you should redirect your user&#39;s browser to this URL. The frontend SDK cannot presently be used to invoke these Sessions. Otherwise, you should pass this URL to your user&#39;s frontend and use the frontend SDK to invoke the Session. This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::CreateSessionResponse.new(
16
+ session: null,
17
+ launch_url: https://api.trinsic.id/api/session/launch?clientToken&#x3D;...
18
+ )
19
+ ```
20
+
@@ -0,0 +1,40 @@
1
+ # TrinsicApi::DisclosedFields
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id_number** | **Boolean** | | |
8
+ | **given_name** | **Boolean** | | |
9
+ | **family_name** | **Boolean** | | |
10
+ | **address** | **Boolean** | | |
11
+ | **date_of_birth** | **Boolean** | | |
12
+ | **country** | **Boolean** | | |
13
+ | **issue_date** | **Boolean** | | |
14
+ | **expiration_date** | **Boolean** | | |
15
+ | **document_front** | **Boolean** | | |
16
+ | **document_back** | **Boolean** | | |
17
+ | **document_portrait** | **Boolean** | | |
18
+ | **selfie** | **Boolean** | | |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'trinsic_api'
24
+
25
+ instance = TrinsicApi::DisclosedFields.new(
26
+ id_number: null,
27
+ given_name: null,
28
+ family_name: null,
29
+ address: null,
30
+ date_of_birth: null,
31
+ country: null,
32
+ issue_date: null,
33
+ expiration_date: null,
34
+ document_front: null,
35
+ document_back: null,
36
+ document_portrait: null,
37
+ selfie: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,40 @@
1
+ # TrinsicApi::DisclosedFieldsRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id_number** | **Boolean** | | [optional] |
8
+ | **given_name** | **Boolean** | | [optional] |
9
+ | **family_name** | **Boolean** | | [optional] |
10
+ | **address** | **Boolean** | | [optional] |
11
+ | **date_of_birth** | **Boolean** | | [optional] |
12
+ | **country** | **Boolean** | | [optional] |
13
+ | **issue_date** | **Boolean** | | [optional] |
14
+ | **expiration_date** | **Boolean** | | [optional] |
15
+ | **document_front** | **Boolean** | | [optional] |
16
+ | **document_back** | **Boolean** | | [optional] |
17
+ | **document_portrait** | **Boolean** | | [optional] |
18
+ | **selfie** | **Boolean** | | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'trinsic_api'
24
+
25
+ instance = TrinsicApi::DisclosedFieldsRequest.new(
26
+ id_number: null,
27
+ given_name: null,
28
+ family_name: null,
29
+ address: null,
30
+ date_of_birth: null,
31
+ country: null,
32
+ issue_date: null,
33
+ expiration_date: null,
34
+ document_front: null,
35
+ document_back: null,
36
+ document_portrait: null,
37
+ selfie: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,28 @@
1
+ # TrinsicApi::DocumentData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional] |
8
+ | **number** | **String** | | [optional] |
9
+ | **issue_date** | **String** | | [optional] |
10
+ | **expiration_date** | **String** | | [optional] |
11
+ | **issuing_country** | **String** | | [optional] |
12
+ | **issuing_authority** | **String** | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'trinsic_api'
18
+
19
+ instance = TrinsicApi::DocumentData.new(
20
+ type: null,
21
+ number: null,
22
+ issue_date: null,
23
+ expiration_date: null,
24
+ issuing_country: null,
25
+ issuing_authority: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::ExchangeAttachmentAccessKeyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **attachment_access_key** | **String** | The Attachment Access Key to exchange for the raw file contents of the related Attachment | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::ExchangeAttachmentAccessKeyRequest.new(
15
+ attachment_access_key: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::ExchangeResultsKeyRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **results_access_key** | **String** | The Results Access Key to exchange | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::ExchangeResultsKeyRequest.new(
15
+ results_access_key: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::ExchangeResultsKeyResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session** | [**Session**](Session.md) | | |
8
+ | **identity_data** | [**IdentityData**](IdentityData.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::ExchangeResultsKeyResponse.new(
16
+ session: null,
17
+ identity_data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::FailureMessage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::FailureMessage.new(
15
+ message: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::GetSessionResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session** | [**Session**](Session.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::GetSessionResponse.new(
15
+ session: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::IdentityData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **originating_provider_id** | **String** | The ID of the integration from which this data originated (eg \&quot;yoti\&quot;, \&quot;clear\&quot;) | [optional] |
8
+ | **person** | [**PersonData**](PersonData.md) | Identity data of the individual who was verified | [optional] |
9
+ | **document** | [**DocumentData**](DocumentData.md) | Identity data of the document involved in verification, if relevant | [optional] |
10
+ | **attachments** | [**Attachments**](Attachments.md) | Access keys for attachments (eg document/selfie images) | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::IdentityData.new(
18
+ originating_provider_id: null,
19
+ person: null,
20
+ document: null,
21
+ attachments: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::IdentityLookupResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identity_in_network** | **Boolean** | Whether the given phone number is known to have an identity in the network. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::IdentityLookupResponse.new(
15
+ identity_in_network: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::ListProvidersResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **providers** | [**Array&lt;ProviderInfo&gt;**](ProviderInfo.md) | The list of identity providers available to your account | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::ListProvidersResponse.new(
15
+ providers: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::ListSessionsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sessions** | [**Array&lt;Session&gt;**](Session.md) | | |
8
+ | **total** | **Integer** | The total number of sessions tied to your account | |
9
+ | **more** | **Boolean** | Whether there are additional pages of sessions to retrieve | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::ListSessionsResponse.new(
17
+ sessions: null,
18
+ total: 101,
19
+ more: true
20
+ )
21
+ ```
22
+