trinsic_api 0.3.0 → 0.4.1

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 (76) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +21 -21
  3. data/docs/AttachmentsApi.md +15 -13
  4. data/docs/{ExchangeAttachmentAccessKeyRequest.md → GetAttachmentRequest.md} +2 -2
  5. data/docs/{ExchangeResultsKeyRequest.md → GetSessionResultRequest.md} +2 -2
  6. data/docs/{ExchangeResultsKeyResponse.md → GetSessionResultResponse.md} +2 -2
  7. data/docs/NetworkApi.md +10 -6
  8. data/docs/SessionsApi.md +56 -46
  9. data/lib/trinsic_api/api/attachments_api.rb +14 -12
  10. data/lib/trinsic_api/api/network_api.rb +7 -3
  11. data/lib/trinsic_api/api/sessions_api.rb +54 -44
  12. data/lib/trinsic_api/api_client.rb +1 -1
  13. data/lib/trinsic_api/api_error.rb +1 -1
  14. data/lib/trinsic_api/configuration.rb +1 -1
  15. data/lib/trinsic_api/models/address.rb +1 -1
  16. data/lib/trinsic_api/models/attachments.rb +1 -1
  17. data/lib/trinsic_api/models/cancel_session_response.rb +1 -1
  18. data/lib/trinsic_api/models/create_session_request.rb +1 -1
  19. data/lib/trinsic_api/models/create_session_response.rb +1 -1
  20. data/lib/trinsic_api/models/disclosed_fields.rb +1 -1
  21. data/lib/trinsic_api/models/disclosed_fields_request.rb +1 -1
  22. data/lib/trinsic_api/models/document_data.rb +1 -1
  23. data/lib/trinsic_api/models/failure_message.rb +1 -1
  24. data/lib/trinsic_api/models/{exchange_attachment_access_key_request.rb → get_attachment_request.rb} +4 -4
  25. data/lib/trinsic_api/models/get_session_response.rb +1 -1
  26. data/lib/trinsic_api/models/{exchange_results_key_request.rb → get_session_result_request.rb} +4 -4
  27. data/lib/trinsic_api/models/{exchange_results_key_response.rb → get_session_result_response.rb} +4 -4
  28. data/lib/trinsic_api/models/identity_data.rb +1 -1
  29. data/lib/trinsic_api/models/identity_lookup_response.rb +1 -1
  30. data/lib/trinsic_api/models/list_providers_response.rb +1 -1
  31. data/lib/trinsic_api/models/list_sessions_response.rb +1 -1
  32. data/lib/trinsic_api/models/order_direction.rb +1 -1
  33. data/lib/trinsic_api/models/person_data.rb +1 -1
  34. data/lib/trinsic_api/models/provider_info.rb +1 -1
  35. data/lib/trinsic_api/models/session.rb +1 -1
  36. data/lib/trinsic_api/models/session_fail_code.rb +1 -1
  37. data/lib/trinsic_api/models/session_ordering.rb +1 -1
  38. data/lib/trinsic_api/models/session_state.rb +1 -1
  39. data/lib/trinsic_api/models/validation_result.rb +1 -1
  40. data/lib/trinsic_api/models/verification.rb +1 -1
  41. data/lib/trinsic_api/models/verification_fail_code.rb +1 -1
  42. data/lib/trinsic_api/version.rb +2 -2
  43. data/lib/trinsic_api.rb +4 -4
  44. data/spec/api/attachments_api_spec.rb +5 -4
  45. data/spec/api/network_api_spec.rb +3 -1
  46. data/spec/api/sessions_api_spec.rb +15 -10
  47. data/spec/models/address_spec.rb +1 -1
  48. data/spec/models/attachments_spec.rb +1 -1
  49. data/spec/models/cancel_session_response_spec.rb +1 -1
  50. data/spec/models/create_session_request_spec.rb +1 -1
  51. data/spec/models/create_session_response_spec.rb +1 -1
  52. data/spec/models/disclosed_fields_request_spec.rb +1 -1
  53. data/spec/models/disclosed_fields_spec.rb +1 -1
  54. data/spec/models/document_data_spec.rb +1 -1
  55. data/spec/models/failure_message_spec.rb +1 -1
  56. data/spec/models/{exchange_attachment_access_key_request_spec.rb → get_attachment_request_spec.rb} +7 -7
  57. data/spec/models/get_session_response_spec.rb +1 -1
  58. data/spec/models/{exchange_results_key_request_spec.rb → get_session_result_request_spec.rb} +7 -7
  59. data/spec/models/{exchange_results_key_response_spec.rb → get_session_result_response_spec.rb} +7 -7
  60. data/spec/models/identity_data_spec.rb +1 -1
  61. data/spec/models/identity_lookup_response_spec.rb +1 -1
  62. data/spec/models/list_providers_response_spec.rb +1 -1
  63. data/spec/models/list_sessions_response_spec.rb +1 -1
  64. data/spec/models/order_direction_spec.rb +1 -1
  65. data/spec/models/person_data_spec.rb +1 -1
  66. data/spec/models/provider_info_spec.rb +1 -1
  67. data/spec/models/session_fail_code_spec.rb +1 -1
  68. data/spec/models/session_ordering_spec.rb +1 -1
  69. data/spec/models/session_spec.rb +1 -1
  70. data/spec/models/session_state_spec.rb +1 -1
  71. data/spec/models/validation_result_spec.rb +1 -1
  72. data/spec/models/verification_fail_code_spec.rb +1 -1
  73. data/spec/models/verification_spec.rb +1 -1
  74. data/spec/spec_helper.rb +1 -1
  75. data/trinsic_api.gemspec +3 -3
  76. metadata +16 -16
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c6ef7eed418ad2790015d85fc62a4830f3387856d7a418307f9701cc50dd6c3d
4
- data.tar.gz: 00b12248041681b87721a8e58975644e80e6b6b0bb5ce6e92d3893a82f793424
3
+ metadata.gz: 76aa55b89afef0d680b9b4485f5e3180e192415a1e2d7b2fafe03c45a66e5f53
4
+ data.tar.gz: b7fd23f5e97f24d05a31b435339194c71b38e206b12729fe3b1a1c36b303686c
5
5
  SHA512:
6
- metadata.gz: ef95f5abc743cb4ecfcbc874496cd12277d931199753271bdfade4358cea336cba525ba31ba404d578c704d8bac4732a84eb55a2763a750954d51743b579abaf
7
- data.tar.gz: 82b4ce63188dc422aabaede28eff2f7c60009c806112ec68608bbdac218cd73ccf8f059847e45541ace18f07e0960428eafadf2423a30a8faafcab8fedc73a95
6
+ metadata.gz: e0ab166cc2cab03144aba4f191ea11372160296837f3905cebb3c30908457ac28225ca6f856f2906062b05e773a449cc4db0092ecbfac7783ed128ee2c223abb
7
+ data.tar.gz: c6119547e90f277d889f3f76c1915f09100297c74594e2ea24092a6c45e487b86f7e8c74a6a3127a9e0a36bb31c96cf26236c697e0d51dd8f018e103d841df1b
data/README.md CHANGED
@@ -7,8 +7,8 @@ No description provided (generated by Openapi Generator https://github.com/opena
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 0.3.0
11
- - Generator version: 7.7.0
10
+ - Package version: 0.4.1
11
+ - Generator version: 7.8.0
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
 
14
14
  ## Installation
@@ -24,16 +24,16 @@ gem build trinsic_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./trinsic_api-0.3.0.gem
27
+ gem install ./trinsic_api-0.4.1.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./trinsic_api-0.3.0.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./trinsic_api-0.4.1.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'trinsic_api', '~> 0.3.0'
36
+ gem 'trinsic_api', '~> 0.4.1'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -67,14 +67,14 @@ end
67
67
 
68
68
  api_instance = TrinsicApi::AttachmentsApi.new
69
69
  opts = {
70
- exchange_attachment_access_key_request: TrinsicApi::ExchangeAttachmentAccessKeyRequest.new({attachment_access_key: 'attachment_access_key_example'}) # ExchangeAttachmentAccessKeyRequest |
70
+ get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example'}) # GetAttachmentRequest |
71
71
  }
72
72
 
73
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)
74
+ #Get Attachment
75
+ api_instance.get_attachment(opts)
76
76
  rescue TrinsicApi::ApiError => e
77
- puts "Exception when calling AttachmentsApi->exchange_attachment_access_key: #{e}"
77
+ puts "Exception when calling AttachmentsApi->get_attachment: #{e}"
78
78
  end
79
79
 
80
80
  ```
@@ -85,15 +85,15 @@ All URIs are relative to *https://api.trinsic.id*
85
85
 
86
86
  Class | Method | HTTP request | Description
87
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.
88
+ *TrinsicApi::AttachmentsApi* | [**get_attachment**](docs/AttachmentsApi.md#get_attachment) | **POST** /api/v1/attachments/attachment | Get Attachment
89
+ *TrinsicApi::NetworkApi* | [**identity_lookup**](docs/NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Lookup Identity
90
+ *TrinsicApi::NetworkApi* | [**list_providers**](docs/NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Identity Providers
91
+ *TrinsicApi::SessionsApi* | [**cancel_session**](docs/SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session
92
+ *TrinsicApi::SessionsApi* | [**create_session**](docs/SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create Session
93
+ *TrinsicApi::SessionsApi* | [**get_session**](docs/SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session
94
+ *TrinsicApi::SessionsApi* | [**get_session_result**](docs/SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results
95
+ *TrinsicApi::SessionsApi* | [**list_sessions**](docs/SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions
96
+ *TrinsicApi::SessionsApi* | [**redact_session**](docs/SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session
97
97
 
98
98
 
99
99
  ## Documentation for Models
@@ -106,11 +106,11 @@ Class | Method | HTTP request | Description
106
106
  - [TrinsicApi::DisclosedFields](docs/DisclosedFields.md)
107
107
  - [TrinsicApi::DisclosedFieldsRequest](docs/DisclosedFieldsRequest.md)
108
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
109
  - [TrinsicApi::FailureMessage](docs/FailureMessage.md)
110
+ - [TrinsicApi::GetAttachmentRequest](docs/GetAttachmentRequest.md)
113
111
  - [TrinsicApi::GetSessionResponse](docs/GetSessionResponse.md)
112
+ - [TrinsicApi::GetSessionResultRequest](docs/GetSessionResultRequest.md)
113
+ - [TrinsicApi::GetSessionResultResponse](docs/GetSessionResultResponse.md)
114
114
  - [TrinsicApi::IdentityData](docs/IdentityData.md)
115
115
  - [TrinsicApi::IdentityLookupResponse](docs/IdentityLookupResponse.md)
116
116
  - [TrinsicApi::ListProvidersResponse](docs/ListProvidersResponse.md)
@@ -4,12 +4,14 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
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. |
7
+ | [**get_attachment**](AttachmentsApi.md#get_attachment) | **POST** /api/v1/attachments/attachment | Get Attachment |
8
8
 
9
9
 
10
- ## exchange_attachment_access_key
10
+ ## get_attachment
11
11
 
12
- > exchange_attachment_access_key(opts)
12
+ > get_attachment(opts)
13
+
14
+ Get Attachment
13
15
 
14
16
  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
17
 
@@ -26,32 +28,32 @@ end
26
28
 
27
29
  api_instance = TrinsicApi::AttachmentsApi.new
28
30
  opts = {
29
- exchange_attachment_access_key_request: TrinsicApi::ExchangeAttachmentAccessKeyRequest.new({attachment_access_key: 'attachment_access_key_example'}) # ExchangeAttachmentAccessKeyRequest |
31
+ get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example'}) # GetAttachmentRequest |
30
32
  }
31
33
 
32
34
  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
+ # Get Attachment
36
+ api_instance.get_attachment(opts)
35
37
  rescue TrinsicApi::ApiError => e
36
- puts "Error when calling AttachmentsApi->exchange_attachment_access_key: #{e}"
38
+ puts "Error when calling AttachmentsApi->get_attachment: #{e}"
37
39
  end
38
40
  ```
39
41
 
40
- #### Using the exchange_attachment_access_key_with_http_info variant
42
+ #### Using the get_attachment_with_http_info variant
41
43
 
42
44
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
43
45
 
44
- > <Array(nil, Integer, Hash)> exchange_attachment_access_key_with_http_info(opts)
46
+ > <Array(nil, Integer, Hash)> get_attachment_with_http_info(opts)
45
47
 
46
48
  ```ruby
47
49
  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
+ # Get Attachment
51
+ data, status_code, headers = api_instance.get_attachment_with_http_info(opts)
50
52
  p status_code # => 2xx
51
53
  p headers # => { ... }
52
54
  p data # => nil
53
55
  rescue TrinsicApi::ApiError => e
54
- puts "Error when calling AttachmentsApi->exchange_attachment_access_key_with_http_info: #{e}"
56
+ puts "Error when calling AttachmentsApi->get_attachment_with_http_info: #{e}"
55
57
  end
56
58
  ```
57
59
 
@@ -59,7 +61,7 @@ end
59
61
 
60
62
  | Name | Type | Description | Notes |
61
63
  | ---- | ---- | ----------- | ----- |
62
- | **exchange_attachment_access_key_request** | [**ExchangeAttachmentAccessKeyRequest**](ExchangeAttachmentAccessKeyRequest.md) | | [optional] |
64
+ | **get_attachment_request** | [**GetAttachmentRequest**](GetAttachmentRequest.md) | | [optional] |
63
65
 
64
66
  ### Return type
65
67
 
@@ -1,4 +1,4 @@
1
- # TrinsicApi::ExchangeAttachmentAccessKeyRequest
1
+ # TrinsicApi::GetAttachmentRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'trinsic_api'
13
13
 
14
- instance = TrinsicApi::ExchangeAttachmentAccessKeyRequest.new(
14
+ instance = TrinsicApi::GetAttachmentRequest.new(
15
15
  attachment_access_key: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # TrinsicApi::ExchangeResultsKeyRequest
1
+ # TrinsicApi::GetSessionResultRequest
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'trinsic_api'
13
13
 
14
- instance = TrinsicApi::ExchangeResultsKeyRequest.new(
14
+ instance = TrinsicApi::GetSessionResultRequest.new(
15
15
  results_access_key: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # TrinsicApi::ExchangeResultsKeyResponse
1
+ # TrinsicApi::GetSessionResultResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'trinsic_api'
14
14
 
15
- instance = TrinsicApi::ExchangeResultsKeyResponse.new(
15
+ instance = TrinsicApi::GetSessionResultResponse.new(
16
16
  session: null,
17
17
  identity_data: null
18
18
  )
data/docs/NetworkApi.md CHANGED
@@ -4,14 +4,16 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**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 |
8
- | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List all identity providers available for use |
7
+ | [**identity_lookup**](NetworkApi.md#identity_lookup) | **GET** /api/v1/network/identities/{phoneNumber} | Lookup Identity |
8
+ | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Identity Providers |
9
9
 
10
10
 
11
11
  ## identity_lookup
12
12
 
13
13
  > <IdentityLookupResponse> identity_lookup(phone_number)
14
14
 
15
+ Lookup Identity
16
+
15
17
  Query the availability of an identity in the Trinsic Network by phone number
16
18
 
17
19
  ### Examples
@@ -29,7 +31,7 @@ api_instance = TrinsicApi::NetworkApi.new
29
31
  phone_number = 'phone_number_example' # String |
30
32
 
31
33
  begin
32
- # Query the availability of an identity in the Trinsic Network by phone number
34
+ # Lookup Identity
33
35
  result = api_instance.identity_lookup(phone_number)
34
36
  p result
35
37
  rescue TrinsicApi::ApiError => e
@@ -45,7 +47,7 @@ This returns an Array which contains the response data, status code and headers.
45
47
 
46
48
  ```ruby
47
49
  begin
48
- # Query the availability of an identity in the Trinsic Network by phone number
50
+ # Lookup Identity
49
51
  data, status_code, headers = api_instance.identity_lookup_with_http_info(phone_number)
50
52
  p status_code # => 2xx
51
53
  p headers # => { ... }
@@ -79,6 +81,8 @@ end
79
81
 
80
82
  > <ListProvidersResponse> list_providers
81
83
 
84
+ List Identity Providers
85
+
82
86
  List all identity providers available for use
83
87
 
84
88
  ### Examples
@@ -95,7 +99,7 @@ end
95
99
  api_instance = TrinsicApi::NetworkApi.new
96
100
 
97
101
  begin
98
- # List all identity providers available for use
102
+ # List Identity Providers
99
103
  result = api_instance.list_providers
100
104
  p result
101
105
  rescue TrinsicApi::ApiError => e
@@ -111,7 +115,7 @@ This returns an Array which contains the response data, status code and headers.
111
115
 
112
116
  ```ruby
113
117
  begin
114
- # List all identity providers available for use
118
+ # List Identity Providers
115
119
  data, status_code, headers = api_instance.list_providers_with_http_info
116
120
  p status_code # => 2xx
117
121
  p headers # => { ... }
data/docs/SessionsApi.md CHANGED
@@ -4,18 +4,20 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel a Session by its ID |
8
- | [**create_session**](SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create a Session to verify a user&#39;s identity |
9
- | [**exchange_results_key**](SessionsApi.md#exchange_results_key) | **POST** /api/v1/sessions/{sessionId}/results/exchange | Exchange a Results Access Key for Identity Data |
10
- | [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get a Session by its ID |
11
- | [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions created by your account |
12
- | [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact a Session, removing all identity data from Trinsic&#39;s servers. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted. |
7
+ | [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session |
8
+ | [**create_session**](SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create Session |
9
+ | [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session |
10
+ | [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
11
+ | [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions |
12
+ | [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
13
13
 
14
14
 
15
15
  ## cancel_session
16
16
 
17
17
  > <CancelSessionResponse> cancel_session(session_id)
18
18
 
19
+ Cancel Session
20
+
19
21
  Cancel a Session by its ID
20
22
 
21
23
  ### Examples
@@ -33,7 +35,7 @@ api_instance = TrinsicApi::SessionsApi.new
33
35
  session_id = 'session_id_example' # String |
34
36
 
35
37
  begin
36
- # Cancel a Session by its ID
38
+ # Cancel Session
37
39
  result = api_instance.cancel_session(session_id)
38
40
  p result
39
41
  rescue TrinsicApi::ApiError => e
@@ -49,7 +51,7 @@ This returns an Array which contains the response data, status code and headers.
49
51
 
50
52
  ```ruby
51
53
  begin
52
- # Cancel a Session by its ID
54
+ # Cancel Session
53
55
  data, status_code, headers = api_instance.cancel_session_with_http_info(session_id)
54
56
  p status_code # => 2xx
55
57
  p headers # => { ... }
@@ -83,6 +85,8 @@ end
83
85
 
84
86
  > <CreateSessionResponse> create_session(opts)
85
87
 
88
+ Create Session
89
+
86
90
  Create a Session to verify a user's identity
87
91
 
88
92
  ### Examples
@@ -102,7 +106,7 @@ opts = {
102
106
  }
103
107
 
104
108
  begin
105
- # Create a Session to verify a user's identity
109
+ # Create Session
106
110
  result = api_instance.create_session(opts)
107
111
  p result
108
112
  rescue TrinsicApi::ApiError => e
@@ -118,7 +122,7 @@ This returns an Array which contains the response data, status code and headers.
118
122
 
119
123
  ```ruby
120
124
  begin
121
- # Create a Session to verify a user's identity
125
+ # Create Session
122
126
  data, status_code, headers = api_instance.create_session_with_http_info(opts)
123
127
  p status_code # => 2xx
124
128
  p headers # => { ... }
@@ -148,11 +152,13 @@ end
148
152
  - **Accept**: text/plain, application/json, text/json
149
153
 
150
154
 
151
- ## exchange_results_key
155
+ ## get_session
152
156
 
153
- > <ExchangeResultsKeyResponse> exchange_results_key(session_id, opts)
157
+ > <GetSessionResponse> get_session(session_id)
154
158
 
155
- Exchange a Results Access Key for Identity Data
159
+ Get Session
160
+
161
+ Get a Session by its ID
156
162
 
157
163
  ### Examples
158
164
 
@@ -167,34 +173,31 @@ end
167
173
 
168
174
  api_instance = TrinsicApi::SessionsApi.new
169
175
  session_id = 'session_id_example' # String |
170
- opts = {
171
- exchange_results_key_request: TrinsicApi::ExchangeResultsKeyRequest.new({results_access_key: 'results_access_key_example'}) # ExchangeResultsKeyRequest |
172
- }
173
176
 
174
177
  begin
175
- # Exchange a Results Access Key for Identity Data
176
- result = api_instance.exchange_results_key(session_id, opts)
178
+ # Get Session
179
+ result = api_instance.get_session(session_id)
177
180
  p result
178
181
  rescue TrinsicApi::ApiError => e
179
- puts "Error when calling SessionsApi->exchange_results_key: #{e}"
182
+ puts "Error when calling SessionsApi->get_session: #{e}"
180
183
  end
181
184
  ```
182
185
 
183
- #### Using the exchange_results_key_with_http_info variant
186
+ #### Using the get_session_with_http_info variant
184
187
 
185
188
  This returns an Array which contains the response data, status code and headers.
186
189
 
187
- > <Array(<ExchangeResultsKeyResponse>, Integer, Hash)> exchange_results_key_with_http_info(session_id, opts)
190
+ > <Array(<GetSessionResponse>, Integer, Hash)> get_session_with_http_info(session_id)
188
191
 
189
192
  ```ruby
190
193
  begin
191
- # Exchange a Results Access Key for Identity Data
192
- data, status_code, headers = api_instance.exchange_results_key_with_http_info(session_id, opts)
194
+ # Get Session
195
+ data, status_code, headers = api_instance.get_session_with_http_info(session_id)
193
196
  p status_code # => 2xx
194
197
  p headers # => { ... }
195
- p data # => <ExchangeResultsKeyResponse>
198
+ p data # => <GetSessionResponse>
196
199
  rescue TrinsicApi::ApiError => e
197
- puts "Error when calling SessionsApi->exchange_results_key_with_http_info: #{e}"
200
+ puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
198
201
  end
199
202
  ```
200
203
 
@@ -203,11 +206,10 @@ end
203
206
  | Name | Type | Description | Notes |
204
207
  | ---- | ---- | ----------- | ----- |
205
208
  | **session_id** | **String** | | |
206
- | **exchange_results_key_request** | [**ExchangeResultsKeyRequest**](ExchangeResultsKeyRequest.md) | | [optional] |
207
209
 
208
210
  ### Return type
209
211
 
210
- [**ExchangeResultsKeyResponse**](ExchangeResultsKeyResponse.md)
212
+ [**GetSessionResponse**](GetSessionResponse.md)
211
213
 
212
214
  ### Authorization
213
215
 
@@ -215,15 +217,15 @@ end
215
217
 
216
218
  ### HTTP request headers
217
219
 
218
- - **Content-Type**: application/json, text/json, application/*+json
220
+ - **Content-Type**: Not defined
219
221
  - **Accept**: text/plain, application/json, text/json
220
222
 
221
223
 
222
- ## get_session
224
+ ## get_session_result
223
225
 
224
- > <GetSessionResponse> get_session(session_id)
226
+ > <GetSessionResultResponse> get_session_result(session_id, opts)
225
227
 
226
- Get a Session by its ID
228
+ Get Session Results
227
229
 
228
230
  ### Examples
229
231
 
@@ -238,31 +240,34 @@ end
238
240
 
239
241
  api_instance = TrinsicApi::SessionsApi.new
240
242
  session_id = 'session_id_example' # String |
243
+ opts = {
244
+ get_session_result_request: TrinsicApi::GetSessionResultRequest.new({results_access_key: 'results_access_key_example'}) # GetSessionResultRequest |
245
+ }
241
246
 
242
247
  begin
243
- # Get a Session by its ID
244
- result = api_instance.get_session(session_id)
248
+ # Get Session Results
249
+ result = api_instance.get_session_result(session_id, opts)
245
250
  p result
246
251
  rescue TrinsicApi::ApiError => e
247
- puts "Error when calling SessionsApi->get_session: #{e}"
252
+ puts "Error when calling SessionsApi->get_session_result: #{e}"
248
253
  end
249
254
  ```
250
255
 
251
- #### Using the get_session_with_http_info variant
256
+ #### Using the get_session_result_with_http_info variant
252
257
 
253
258
  This returns an Array which contains the response data, status code and headers.
254
259
 
255
- > <Array(<GetSessionResponse>, Integer, Hash)> get_session_with_http_info(session_id)
260
+ > <Array(<GetSessionResultResponse>, Integer, Hash)> get_session_result_with_http_info(session_id, opts)
256
261
 
257
262
  ```ruby
258
263
  begin
259
- # Get a Session by its ID
260
- data, status_code, headers = api_instance.get_session_with_http_info(session_id)
264
+ # Get Session Results
265
+ data, status_code, headers = api_instance.get_session_result_with_http_info(session_id, opts)
261
266
  p status_code # => 2xx
262
267
  p headers # => { ... }
263
- p data # => <GetSessionResponse>
268
+ p data # => <GetSessionResultResponse>
264
269
  rescue TrinsicApi::ApiError => e
265
- puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
270
+ puts "Error when calling SessionsApi->get_session_result_with_http_info: #{e}"
266
271
  end
267
272
  ```
268
273
 
@@ -271,10 +276,11 @@ end
271
276
  | Name | Type | Description | Notes |
272
277
  | ---- | ---- | ----------- | ----- |
273
278
  | **session_id** | **String** | | |
279
+ | **get_session_result_request** | [**GetSessionResultRequest**](GetSessionResultRequest.md) | | [optional] |
274
280
 
275
281
  ### Return type
276
282
 
277
- [**GetSessionResponse**](GetSessionResponse.md)
283
+ [**GetSessionResultResponse**](GetSessionResultResponse.md)
278
284
 
279
285
  ### Authorization
280
286
 
@@ -282,7 +288,7 @@ end
282
288
 
283
289
  ### HTTP request headers
284
290
 
285
- - **Content-Type**: Not defined
291
+ - **Content-Type**: application/json, text/json, application/*+json
286
292
  - **Accept**: text/plain, application/json, text/json
287
293
 
288
294
 
@@ -290,6 +296,8 @@ end
290
296
 
291
297
  > <ListSessionsResponse> list_sessions(opts)
292
298
 
299
+ List Sessions
300
+
293
301
  List Sessions created by your account
294
302
 
295
303
  ### Examples
@@ -312,7 +320,7 @@ opts = {
312
320
  }
313
321
 
314
322
  begin
315
- # List Sessions created by your account
323
+ # List Sessions
316
324
  result = api_instance.list_sessions(opts)
317
325
  p result
318
326
  rescue TrinsicApi::ApiError => e
@@ -328,7 +336,7 @@ This returns an Array which contains the response data, status code and headers.
328
336
 
329
337
  ```ruby
330
338
  begin
331
- # List Sessions created by your account
339
+ # List Sessions
332
340
  data, status_code, headers = api_instance.list_sessions_with_http_info(opts)
333
341
  p status_code # => 2xx
334
342
  p headers # => { ... }
@@ -365,6 +373,8 @@ end
365
373
 
366
374
  > redact_session(session_id)
367
375
 
376
+ Redact Session
377
+
368
378
  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.
369
379
 
370
380
  ### Examples
@@ -382,7 +392,7 @@ api_instance = TrinsicApi::SessionsApi.new
382
392
  session_id = 'session_id_example' # String |
383
393
 
384
394
  begin
385
- # 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.
395
+ # Redact Session
386
396
  api_instance.redact_session(session_id)
387
397
  rescue TrinsicApi::ApiError => e
388
398
  puts "Error when calling SessionsApi->redact_session: #{e}"
@@ -397,7 +407,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
397
407
 
398
408
  ```ruby
399
409
  begin
400
- # 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.
410
+ # Redact Session
401
411
  data, status_code, headers = api_instance.redact_session_with_http_info(session_id)
402
412
  p status_code # => 2xx
403
413
  p headers # => { ... }
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: v1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- Generator version: 7.7.0
9
+ Generator version: 7.8.0
10
10
 
11
11
  =end
12
12
 
@@ -19,25 +19,27 @@ module TrinsicApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Get Attachment
22
23
  # 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.
23
24
  # @param [Hash] opts the optional parameters
24
- # @option opts [ExchangeAttachmentAccessKeyRequest] :exchange_attachment_access_key_request
25
+ # @option opts [GetAttachmentRequest] :get_attachment_request
25
26
  # @return [nil]
26
- def exchange_attachment_access_key(opts = {})
27
- exchange_attachment_access_key_with_http_info(opts)
27
+ def get_attachment(opts = {})
28
+ get_attachment_with_http_info(opts)
28
29
  nil
29
30
  end
30
31
 
32
+ # Get Attachment
31
33
  # Exchange an Attachment Access Key (from &#x60;IdentityData.Attachments&#x60;) 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.
32
34
  # @param [Hash] opts the optional parameters
33
- # @option opts [ExchangeAttachmentAccessKeyRequest] :exchange_attachment_access_key_request
35
+ # @option opts [GetAttachmentRequest] :get_attachment_request
34
36
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
35
- def exchange_attachment_access_key_with_http_info(opts = {})
37
+ def get_attachment_with_http_info(opts = {})
36
38
  if @api_client.config.debugging
37
- @api_client.config.logger.debug 'Calling API: AttachmentsApi.exchange_attachment_access_key ...'
39
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.get_attachment ...'
38
40
  end
39
41
  # resource path
40
- local_var_path = '/api/v1/attachments/exchange'
42
+ local_var_path = '/api/v1/attachments/attachment'
41
43
 
42
44
  # query parameters
43
45
  query_params = opts[:query_params] || {}
@@ -45,7 +47,7 @@ module TrinsicApi
45
47
  # header parameters
46
48
  header_params = opts[:header_params] || {}
47
49
  # HTTP header 'Accept' (if needed)
48
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
50
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
49
51
  # HTTP header 'Content-Type'
50
52
  content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
51
53
  if !content_type.nil?
@@ -56,7 +58,7 @@ module TrinsicApi
56
58
  form_params = opts[:form_params] || {}
57
59
 
58
60
  # http body (model)
59
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'exchange_attachment_access_key_request'])
61
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'get_attachment_request'])
60
62
 
61
63
  # return_type
62
64
  return_type = opts[:debug_return_type]
@@ -65,7 +67,7 @@ module TrinsicApi
65
67
  auth_names = opts[:debug_auth_names] || ['Bearer']
66
68
 
67
69
  new_options = opts.merge(
68
- :operation => :"AttachmentsApi.exchange_attachment_access_key",
70
+ :operation => :"AttachmentsApi.get_attachment",
69
71
  :header_params => header_params,
70
72
  :query_params => query_params,
71
73
  :form_params => form_params,
@@ -76,7 +78,7 @@ module TrinsicApi
76
78
 
77
79
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
78
80
  if @api_client.config.debugging
79
- @api_client.config.logger.debug "API called: AttachmentsApi#exchange_attachment_access_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ @api_client.config.logger.debug "API called: AttachmentsApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
82
  end
81
83
  return data, status_code, headers
82
84
  end