trinsic_api 2.1.1.pre.alpha2 → 2.2.0

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 (82) hide show
  1. checksums.yaml +4 -4
  2. data/docs/AppleWalletInput.md +18 -0
  3. data/docs/AttachmentsApi.md +1 -1
  4. data/docs/{CreateAdvancedProviderSessionRequest.md → CreateDirectProviderSessionRequest.md} +5 -3
  5. data/docs/{CreateAdvancedProviderSessionResponse.md → CreateDirectProviderSessionResponse.md} +2 -2
  6. data/docs/CreateHostedProviderSessionRequest.md +3 -1
  7. data/docs/CreateMdlExchangeRequest.md +32 -0
  8. data/docs/CreateMdlExchangeResponse.md +22 -0
  9. data/docs/CreateWidgetSessionRequest.md +3 -1
  10. data/docs/ExternalMdlFieldData.md +20 -0
  11. data/docs/FinalizeMdlExchangeRequest.md +24 -0
  12. data/docs/FinalizeMdlExchangeResponse.md +24 -0
  13. data/docs/GetAttachmentRequest.md +3 -1
  14. data/docs/GoogleWalletInput.md +18 -0
  15. data/docs/MdlApi.md +151 -0
  16. data/docs/MdlCertificateData.md +26 -0
  17. data/docs/MdlExchangeMechanism.md +15 -0
  18. data/docs/MdlFieldDataType.md +15 -0
  19. data/docs/MdlIdentityData.md +22 -0
  20. data/docs/NetworkApi.md +17 -12
  21. data/docs/ProviderContract.md +7 -5
  22. data/docs/ProviderInput.md +4 -0
  23. data/docs/RecommendRequest.md +2 -0
  24. data/docs/SessionsApi.md +110 -34
  25. data/docs/SubmitNativeChallengeResponseRequest.md +20 -0
  26. data/docs/SubmitNativeChallengeResponseResponse.md +18 -0
  27. data/lib/trinsic_api/api/mdl_api.rb +150 -0
  28. data/lib/trinsic_api/api/network_api.rb +20 -8
  29. data/lib/trinsic_api/api/sessions_api.rb +108 -32
  30. data/lib/trinsic_api/models/apple_wallet_input.rb +244 -0
  31. data/lib/trinsic_api/models/{create_advanced_provider_session_request.rb → create_direct_provider_session_request.rb} +32 -5
  32. data/lib/trinsic_api/models/{create_advanced_provider_session_response.rb → create_direct_provider_session_response.rb} +3 -3
  33. data/lib/trinsic_api/models/create_hosted_provider_session_request.rb +29 -2
  34. data/lib/trinsic_api/models/create_mdl_exchange_request.rb +404 -0
  35. data/lib/trinsic_api/models/create_mdl_exchange_response.rb +292 -0
  36. data/lib/trinsic_api/models/create_widget_session_request.rb +29 -2
  37. data/lib/trinsic_api/models/external_mdl_field_data.rb +287 -0
  38. data/lib/trinsic_api/models/finalize_mdl_exchange_request.rb +319 -0
  39. data/lib/trinsic_api/models/finalize_mdl_exchange_response.rb +287 -0
  40. data/lib/trinsic_api/models/get_attachment_request.rb +31 -4
  41. data/lib/trinsic_api/models/google_wallet_input.rb +244 -0
  42. data/lib/trinsic_api/models/integration_capability.rb +2 -1
  43. data/lib/trinsic_api/models/integration_launch_method.rb +2 -1
  44. data/lib/trinsic_api/models/integration_step.rb +1 -1
  45. data/lib/trinsic_api/models/mdl_certificate_data.rb +346 -0
  46. data/lib/trinsic_api/models/mdl_exchange_mechanism.rb +40 -0
  47. data/lib/trinsic_api/models/mdl_field_data_type.rb +43 -0
  48. data/lib/trinsic_api/models/mdl_identity_data.rb +294 -0
  49. data/lib/trinsic_api/models/provider_contract.rb +33 -6
  50. data/lib/trinsic_api/models/provider_input.rb +23 -1
  51. data/lib/trinsic_api/models/recommend_request.rb +28 -1
  52. data/lib/trinsic_api/models/result_collection_method.rb +2 -1
  53. data/lib/trinsic_api/models/session_error_code.rb +3 -1
  54. data/lib/trinsic_api/models/submit_native_challenge_response_request.rb +283 -0
  55. data/lib/trinsic_api/models/submit_native_challenge_response_response.rb +238 -0
  56. data/lib/trinsic_api/version.rb +1 -1
  57. data/lib/trinsic_api.rb +16 -2
  58. data/spec/api/mdl_api_spec.rb +59 -0
  59. data/spec/api/network_api_spec.rb +2 -0
  60. data/spec/api/sessions_api_spec.rb +22 -8
  61. data/spec/models/apple_wallet_input_spec.rb +36 -0
  62. data/spec/models/{create_advanced_provider_session_request_spec.rb → create_direct_provider_session_request_spec.rb} +12 -6
  63. data/spec/models/{create_advanced_provider_session_response_spec.rb → create_direct_provider_session_response_spec.rb} +6 -6
  64. data/spec/models/create_hosted_provider_session_request_spec.rb +6 -0
  65. data/spec/models/create_mdl_exchange_request_spec.rb +78 -0
  66. data/spec/models/create_mdl_exchange_response_spec.rb +48 -0
  67. data/spec/models/create_widget_session_request_spec.rb +6 -0
  68. data/spec/models/external_mdl_field_data_spec.rb +42 -0
  69. data/spec/models/finalize_mdl_exchange_request_spec.rb +54 -0
  70. data/spec/models/finalize_mdl_exchange_response_spec.rb +54 -0
  71. data/spec/models/get_attachment_request_spec.rb +6 -0
  72. data/spec/models/google_wallet_input_spec.rb +36 -0
  73. data/spec/models/mdl_certificate_data_spec.rb +60 -0
  74. data/spec/models/mdl_exchange_mechanism_spec.rb +30 -0
  75. data/spec/models/mdl_field_data_type_spec.rb +30 -0
  76. data/spec/models/mdl_identity_data_spec.rb +48 -0
  77. data/spec/models/provider_contract_spec.rb +6 -0
  78. data/spec/models/provider_input_spec.rb +12 -0
  79. data/spec/models/recommend_request_spec.rb +6 -0
  80. data/spec/models/submit_native_challenge_response_request_spec.rb +42 -0
  81. data/spec/models/submit_native_challenge_response_response_spec.rb +36 -0
  82. metadata +124 -68
@@ -12,13 +12,14 @@
12
12
  | **available** | **Boolean** | Whether the Provider is available for use in your App. If `false`, you will need to contact Trinsic to enable this Provider for your App. | |
13
13
  | **geography** | **Array<String>** | The geographies within the Regions the Provider is available. | |
14
14
  | **regions** | **Array<String>** | The regions within which the Provider is available. | |
15
- | **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Advanced Provider Sessions. The `LaunchMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
16
- | **collection_method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | Relevant only to Advanced Provider Sessions. The `CollectionMethod` which must be supported to launch the Provider Session in Advanced Provider Sessions. | |
15
+ | **launch_method** | [**IntegrationLaunchMethod**](IntegrationLaunchMethod.md) | Relevant only to Direct Provider Sessions. The `LaunchMethod` which must be supported to launch the Provider Session in Direct Provider Sessions. | |
16
+ | **collection_method** | [**ResultCollectionMethod**](ResultCollectionMethod.md) | Relevant only to Direct Provider Sessions. The `CollectionMethod` which must be supported to launch the Provider Session in Direct Provider Sessions. | |
17
17
  | **results_may_be_delayed_after_redirect** | **Boolean** | If `true`, then the results for this Provider may not be available immediately after the user is redirected back to your application. In this case, the `GetSessionResults` API must be called until results are available. This is an uncommon scenario, and only applies to Providers which cannot guarantee the availability of results immediately after the user is redirected back to your application. | |
18
- | **has_refreshable_content** | **Boolean** | Relevant only to Advanced Provider Sessions. Whether the Provider requires the `RefreshStepContent` capability. For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow. | |
19
- | **requires_input** | **Boolean** | Relevant to Hosted Provider Sessions and Advanced Provider Sessions. If `true`, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user. | |
18
+ | **has_refreshable_content** | **Boolean** | Relevant only to Direct Provider Sessions. Whether the Provider requires the `RefreshStepContent` capability. For example, Samsung Wallet's deep links expire every 30 seconds, and must be refreshed periodically for a resilient user flow. | |
19
+ | **requires_input** | **Boolean** | Relevant to Hosted Provider Sessions and Direct Provider Sessions. If `true`, this Provider requires provider-specific input on Session creation. If this input is not provided, Trinsic's Hosted UI will be invoked to collect the input from the user. | |
20
20
  | **has_trinsic_interface** | **Boolean** | Whether there exists a Trinsic-hosted UI for this Provider. This is `true` for any Provider which is not a simple, OIDC-like redirect flow. | |
21
- | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Advanced Provider Sessions API. If `false`, the Provider may still be launched through Advanced Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. | |
21
+ | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API. If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. | |
22
+ | **supports_direct_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API. If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. | |
22
23
  | **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
23
24
  | **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] |
24
25
  | **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. | |
@@ -44,6 +45,7 @@ instance = TrinsicApi::ProviderContract.new(
44
45
  requires_input: false,
45
46
  has_trinsic_interface: true,
46
47
  supports_advanced_provider_sessions: true,
48
+ supports_direct_provider_sessions: true,
47
49
  available_fields: null,
48
50
  sub_providers: null,
49
51
  health: null
@@ -20,6 +20,8 @@
20
20
  | **mobile_id** | [**MobileIdInput**](MobileIdInput.md) | Input for the `mobile-id` provider | [optional] |
21
21
  | **idin** | [**IdinInput**](IdinInput.md) | Input for the `netherlands-idin` provider | [optional] |
22
22
  | **spid** | [**SpidInput**](SpidInput.md) | Input for the `italy-spid` provider | [optional] |
23
+ | **google_wallet** | [**GoogleWalletInput**](GoogleWalletInput.md) | Input for the `google-wallet` provider | [optional] |
24
+ | **apple_wallet** | [**AppleWalletInput**](AppleWalletInput.md) | Input for the `apple-wallet` provider | [optional] |
23
25
  | **trinsic_test_database_lookup** | [**TrinsicTestDatabaseLookupInput**](TrinsicTestDatabaseLookupInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-database-lookup` provider | [optional] |
24
26
  | **trinsic_test_sub_providers** | [**TrinsicTestSubProvidersInput**](TrinsicTestSubProvidersInput.md) | *TEST MODE ONLY.* Input for the `trinsic-test-sub-providers` provider | [optional] |
25
27
 
@@ -45,6 +47,8 @@ instance = TrinsicApi::ProviderInput.new(
45
47
  mobile_id: null,
46
48
  idin: null,
47
49
  spid: null,
50
+ google_wallet: null,
51
+ apple_wallet: null,
48
52
  trinsic_test_database_lookup: null,
49
53
  trinsic_test_sub_providers: null
50
54
  )
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this recommendation. | |
7
8
  | **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Information about the user you wish to generate a recommendation for. | [optional] |
8
9
  | **health** | **String** | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"online\". | [optional] |
9
10
 
@@ -13,6 +14,7 @@
13
14
  require 'trinsic_api'
14
15
 
15
16
  instance = TrinsicApi::RecommendRequest.new(
17
+ verification_profile_id: null,
16
18
  recommendation_info: null,
17
19
  health: null
18
20
  )
data/docs/SessionsApi.md CHANGED
@@ -5,14 +5,15 @@ All URIs are relative to *https://api.trinsic.id*
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel Session |
8
- | [**create_advanced_provider_session**](SessionsApi.md#create_advanced_provider_session) | **POST** /api/v1/sessions/provider/advanced | Create Advanced Provider Session |
8
+ | [**create_direct_provider_session**](SessionsApi.md#create_direct_provider_session) | **POST** /api/v1/sessions/provider/direct | Create Direct Provider Session |
9
9
  | [**create_hosted_provider_session**](SessionsApi.md#create_hosted_provider_session) | **POST** /api/v1/sessions/provider/hosted | Create Hosted Provider Session |
10
10
  | [**create_widget_session**](SessionsApi.md#create_widget_session) | **POST** /api/v1/sessions/widget | Create Widget Session |
11
11
  | [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get Session |
12
12
  | [**get_session_result**](SessionsApi.md#get_session_result) | **POST** /api/v1/sessions/{sessionId}/results | Get Session Results |
13
- | [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions/list | List Sessions |
13
+ | [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/verification-profiles/{verificationProfileId}/sessions | List Sessions |
14
14
  | [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact Session |
15
- | [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{acceptanceSessionId}/step/refresh | Refresh Step Content |
15
+ | [**refresh_step_content**](SessionsApi.md#refresh_step_content) | **POST** /api/v1/sessions/{sessionId}/step/refresh | Refresh Step Content |
16
+ | [**submit_native_challenge_response**](SessionsApi.md#submit_native_challenge_response) | **POST** /api/v1/sessions/{sessionId}/native-challenge/submit | Submit Native Challenge Response |
16
17
 
17
18
 
18
19
  ## cancel_session
@@ -84,11 +85,11 @@ end
84
85
  - **Accept**: text/plain, application/json, text/json, application/problem+json
85
86
 
86
87
 
87
- ## create_advanced_provider_session
88
+ ## create_direct_provider_session
88
89
 
89
- > <CreateAdvancedProviderSessionResponse> create_advanced_provider_session(opts)
90
+ > <CreateDirectProviderSessionResponse> create_direct_provider_session(opts)
90
91
 
91
- Create Advanced Provider Session
92
+ Create Direct Provider Session
92
93
 
93
94
  Verify a user's identity with a specific provider, handling additional user interaction in your own UI. Signal which kinds of user interactions your UI can handle using the `Capabilities` field. If `FallbackToHostedUi` is `true`, Trinsic's hosted UI will automatically be invoked to handle any capabilities you do not support.
94
95
 
@@ -105,33 +106,33 @@ end
105
106
 
106
107
  api_instance = TrinsicApi::SessionsApi.new
107
108
  opts = {
108
- create_advanced_provider_session_request: TrinsicApi::CreateAdvancedProviderSessionRequest.new({provider: 'provider_example', capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateAdvancedProviderSessionRequest |
109
+ create_direct_provider_session_request: TrinsicApi::CreateDirectProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', capabilities: [TrinsicApi::IntegrationCapability::LAUNCH_BROWSER]}) # CreateDirectProviderSessionRequest |
109
110
  }
110
111
 
111
112
  begin
112
- # Create Advanced Provider Session
113
- result = api_instance.create_advanced_provider_session(opts)
113
+ # Create Direct Provider Session
114
+ result = api_instance.create_direct_provider_session(opts)
114
115
  p result
115
116
  rescue TrinsicApi::ApiError => e
116
- puts "Error when calling SessionsApi->create_advanced_provider_session: #{e}"
117
+ puts "Error when calling SessionsApi->create_direct_provider_session: #{e}"
117
118
  end
118
119
  ```
119
120
 
120
- #### Using the create_advanced_provider_session_with_http_info variant
121
+ #### Using the create_direct_provider_session_with_http_info variant
121
122
 
122
123
  This returns an Array which contains the response data, status code and headers.
123
124
 
124
- > <Array(<CreateAdvancedProviderSessionResponse>, Integer, Hash)> create_advanced_provider_session_with_http_info(opts)
125
+ > <Array(<CreateDirectProviderSessionResponse>, Integer, Hash)> create_direct_provider_session_with_http_info(opts)
125
126
 
126
127
  ```ruby
127
128
  begin
128
- # Create Advanced Provider Session
129
- data, status_code, headers = api_instance.create_advanced_provider_session_with_http_info(opts)
129
+ # Create Direct Provider Session
130
+ data, status_code, headers = api_instance.create_direct_provider_session_with_http_info(opts)
130
131
  p status_code # => 2xx
131
132
  p headers # => { ... }
132
- p data # => <CreateAdvancedProviderSessionResponse>
133
+ p data # => <CreateDirectProviderSessionResponse>
133
134
  rescue TrinsicApi::ApiError => e
134
- puts "Error when calling SessionsApi->create_advanced_provider_session_with_http_info: #{e}"
135
+ puts "Error when calling SessionsApi->create_direct_provider_session_with_http_info: #{e}"
135
136
  end
136
137
  ```
137
138
 
@@ -139,11 +140,11 @@ end
139
140
 
140
141
  | Name | Type | Description | Notes |
141
142
  | ---- | ---- | ----------- | ----- |
142
- | **create_advanced_provider_session_request** | [**CreateAdvancedProviderSessionRequest**](CreateAdvancedProviderSessionRequest.md) | | [optional] |
143
+ | **create_direct_provider_session_request** | [**CreateDirectProviderSessionRequest**](CreateDirectProviderSessionRequest.md) | | [optional] |
143
144
 
144
145
  ### Return type
145
146
 
146
- [**CreateAdvancedProviderSessionResponse**](CreateAdvancedProviderSessionResponse.md)
147
+ [**CreateDirectProviderSessionResponse**](CreateDirectProviderSessionResponse.md)
147
148
 
148
149
  ### Authorization
149
150
 
@@ -176,7 +177,7 @@ end
176
177
 
177
178
  api_instance = TrinsicApi::SessionsApi.new
178
179
  opts = {
179
- create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', redirect_url: 'redirect_url_example'}) # CreateHostedProviderSessionRequest |
180
+ create_hosted_provider_session_request: TrinsicApi::CreateHostedProviderSessionRequest.new({provider: 'provider_example', verification_profile_id: 'verification_profile_id_example', redirect_url: 'redirect_url_example'}) # CreateHostedProviderSessionRequest |
180
181
  }
181
182
 
182
183
  begin
@@ -247,7 +248,7 @@ end
247
248
 
248
249
  api_instance = TrinsicApi::SessionsApi.new
249
250
  opts = {
250
- create_widget_session_request: TrinsicApi::CreateWidgetSessionRequest.new # CreateWidgetSessionRequest |
251
+ create_widget_session_request: TrinsicApi::CreateWidgetSessionRequest.new({verification_profile_id: 'verification_profile_id_example'}) # CreateWidgetSessionRequest |
251
252
  }
252
253
 
253
254
  begin
@@ -317,7 +318,7 @@ TrinsicApi.configure do |config|
317
318
  end
318
319
 
319
320
  api_instance = TrinsicApi::SessionsApi.new
320
- session_id = 'session_id_example' # String |
321
+ session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
321
322
 
322
323
  begin
323
324
  # Get Session
@@ -384,7 +385,7 @@ TrinsicApi.configure do |config|
384
385
  end
385
386
 
386
387
  api_instance = TrinsicApi::SessionsApi.new
387
- session_id = 'session_id_example' # String |
388
+ session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
388
389
  opts = {
389
390
  get_session_result_request: TrinsicApi::GetSessionResultRequest.new({results_access_key: 'results_access_key_example'}) # GetSessionResultRequest |
390
391
  }
@@ -439,11 +440,11 @@ end
439
440
 
440
441
  ## list_sessions
441
442
 
442
- > <ListSessionsResponse> list_sessions(opts)
443
+ > <ListSessionsResponse> list_sessions(verification_profile_id, opts)
443
444
 
444
445
  List Sessions
445
446
 
446
- List Sessions created by your account
447
+ List Sessions created for a specific Verification Profile
447
448
 
448
449
  ### Examples
449
450
 
@@ -457,6 +458,7 @@ TrinsicApi.configure do |config|
457
458
  end
458
459
 
459
460
  api_instance = TrinsicApi::SessionsApi.new
461
+ verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
460
462
  opts = {
461
463
  order_by: TrinsicApi::SessionOrdering::CREATED, # SessionOrdering | The field by which sessions should be ordered
462
464
  order_direction: TrinsicApi::OrderDirection::ASCENDING, # OrderDirection |
@@ -466,7 +468,7 @@ opts = {
466
468
 
467
469
  begin
468
470
  # List Sessions
469
- result = api_instance.list_sessions(opts)
471
+ result = api_instance.list_sessions(verification_profile_id, opts)
470
472
  p result
471
473
  rescue TrinsicApi::ApiError => e
472
474
  puts "Error when calling SessionsApi->list_sessions: #{e}"
@@ -477,12 +479,12 @@ end
477
479
 
478
480
  This returns an Array which contains the response data, status code and headers.
479
481
 
480
- > <Array(<ListSessionsResponse>, Integer, Hash)> list_sessions_with_http_info(opts)
482
+ > <Array(<ListSessionsResponse>, Integer, Hash)> list_sessions_with_http_info(verification_profile_id, opts)
481
483
 
482
484
  ```ruby
483
485
  begin
484
486
  # List Sessions
485
- data, status_code, headers = api_instance.list_sessions_with_http_info(opts)
487
+ data, status_code, headers = api_instance.list_sessions_with_http_info(verification_profile_id, opts)
486
488
  p status_code # => 2xx
487
489
  p headers # => { ... }
488
490
  p data # => <ListSessionsResponse>
@@ -495,6 +497,7 @@ end
495
497
 
496
498
  | Name | Type | Description | Notes |
497
499
  | ---- | ---- | ----------- | ----- |
500
+ | **verification_profile_id** | **String** | | |
498
501
  | **order_by** | [**SessionOrdering**](.md) | The field by which sessions should be ordered | [optional] |
499
502
  | **order_direction** | [**OrderDirection**](.md) | | [optional] |
500
503
  | **page_size** | **Integer** | The number of items to return per page -- must be between &#x60;1&#x60; and &#x60;50&#x60; | [optional] |
@@ -584,11 +587,11 @@ nil (empty response body)
584
587
 
585
588
  ## refresh_step_content
586
589
 
587
- > <RefreshStepContentResponse> refresh_step_content(acceptance_session_id, opts)
590
+ > <RefreshStepContentResponse> refresh_step_content(session_id, opts)
588
591
 
589
592
  Refresh Step Content
590
593
 
591
- Refreshes the content of a Step for an Advanced Provider Session.
594
+ Refreshes the content of a Step for a Direct Provider Session.
592
595
 
593
596
  ### Examples
594
597
 
@@ -602,14 +605,14 @@ TrinsicApi.configure do |config|
602
605
  end
603
606
 
604
607
  api_instance = TrinsicApi::SessionsApi.new
605
- acceptance_session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
608
+ session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
606
609
  opts = {
607
610
  refresh_step_content_request: TrinsicApi::RefreshStepContentRequest.new({results_access_key: 'results_access_key_example'}) # RefreshStepContentRequest |
608
611
  }
609
612
 
610
613
  begin
611
614
  # Refresh Step Content
612
- result = api_instance.refresh_step_content(acceptance_session_id, opts)
615
+ result = api_instance.refresh_step_content(session_id, opts)
613
616
  p result
614
617
  rescue TrinsicApi::ApiError => e
615
618
  puts "Error when calling SessionsApi->refresh_step_content: #{e}"
@@ -620,12 +623,12 @@ end
620
623
 
621
624
  This returns an Array which contains the response data, status code and headers.
622
625
 
623
- > <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(acceptance_session_id, opts)
626
+ > <Array(<RefreshStepContentResponse>, Integer, Hash)> refresh_step_content_with_http_info(session_id, opts)
624
627
 
625
628
  ```ruby
626
629
  begin
627
630
  # Refresh Step Content
628
- data, status_code, headers = api_instance.refresh_step_content_with_http_info(acceptance_session_id, opts)
631
+ data, status_code, headers = api_instance.refresh_step_content_with_http_info(session_id, opts)
629
632
  p status_code # => 2xx
630
633
  p headers # => { ... }
631
634
  p data # => <RefreshStepContentResponse>
@@ -638,7 +641,7 @@ end
638
641
 
639
642
  | Name | Type | Description | Notes |
640
643
  | ---- | ---- | ----------- | ----- |
641
- | **acceptance_session_id** | **String** | | |
644
+ | **session_id** | **String** | | |
642
645
  | **refresh_step_content_request** | [**RefreshStepContentRequest**](RefreshStepContentRequest.md) | | [optional] |
643
646
 
644
647
  ### Return type
@@ -654,3 +657,76 @@ end
654
657
  - **Content-Type**: application/json, text/json, application/*+json
655
658
  - **Accept**: text/plain, application/json, text/json, application/problem+json
656
659
 
660
+
661
+ ## submit_native_challenge_response
662
+
663
+ > <SubmitNativeChallengeResponseResponse> submit_native_challenge_response(session_id, opts)
664
+
665
+ Submit Native Challenge Response
666
+
667
+ Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
668
+
669
+ ### Examples
670
+
671
+ ```ruby
672
+ require 'time'
673
+ require 'trinsic_api'
674
+ # setup authorization
675
+ TrinsicApi.configure do |config|
676
+ # Configure Bearer authorization: Bearer
677
+ config.access_token = 'YOUR_BEARER_TOKEN'
678
+ end
679
+
680
+ api_instance = TrinsicApi::SessionsApi.new
681
+ session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
682
+ opts = {
683
+ submit_native_challenge_response_request: TrinsicApi::SubmitNativeChallengeResponseRequest.new({results_access_key: 'results_access_key_example', response_token: 'response_token_example'}) # SubmitNativeChallengeResponseRequest |
684
+ }
685
+
686
+ begin
687
+ # Submit Native Challenge Response
688
+ result = api_instance.submit_native_challenge_response(session_id, opts)
689
+ p result
690
+ rescue TrinsicApi::ApiError => e
691
+ puts "Error when calling SessionsApi->submit_native_challenge_response: #{e}"
692
+ end
693
+ ```
694
+
695
+ #### Using the submit_native_challenge_response_with_http_info variant
696
+
697
+ This returns an Array which contains the response data, status code and headers.
698
+
699
+ > <Array(<SubmitNativeChallengeResponseResponse>, Integer, Hash)> submit_native_challenge_response_with_http_info(session_id, opts)
700
+
701
+ ```ruby
702
+ begin
703
+ # Submit Native Challenge Response
704
+ data, status_code, headers = api_instance.submit_native_challenge_response_with_http_info(session_id, opts)
705
+ p status_code # => 2xx
706
+ p headers # => { ... }
707
+ p data # => <SubmitNativeChallengeResponseResponse>
708
+ rescue TrinsicApi::ApiError => e
709
+ puts "Error when calling SessionsApi->submit_native_challenge_response_with_http_info: #{e}"
710
+ end
711
+ ```
712
+
713
+ ### Parameters
714
+
715
+ | Name | Type | Description | Notes |
716
+ | ---- | ---- | ----------- | ----- |
717
+ | **session_id** | **String** | | |
718
+ | **submit_native_challenge_response_request** | [**SubmitNativeChallengeResponseRequest**](SubmitNativeChallengeResponseRequest.md) | | [optional] |
719
+
720
+ ### Return type
721
+
722
+ [**SubmitNativeChallengeResponseResponse**](SubmitNativeChallengeResponseResponse.md)
723
+
724
+ ### Authorization
725
+
726
+ [Bearer](../README.md#Bearer)
727
+
728
+ ### HTTP request headers
729
+
730
+ - **Content-Type**: application/json, text/json, application/*+json
731
+ - **Accept**: text/plain, application/json, text/json, application/problem+json
732
+
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::SubmitNativeChallengeResponseRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **results_access_key** | **String** | The Results Access Key for the Session in question | |
8
+ | **response_token** | **String** | The response token retrieved from a Trinsic UI SDK&#39;s performMdlExchange() call. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::SubmitNativeChallengeResponseRequest.new(
16
+ results_access_key: null,
17
+ response_token: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::SubmitNativeChallengeResponseResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **session** | [**Session**](Session.md) | The Session for which the challenge token was submitted | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::SubmitNativeChallengeResponseResponse.new(
15
+ session: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,150 @@
1
+ =begin
2
+ #Trinsic API
3
+
4
+ #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
5
+
6
+ The version of the OpenAPI document: v1
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.13.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module TrinsicApi
16
+ class MdlApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create mDL Exchange
23
+ # 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.
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [CreateMdlExchangeRequest] :create_mdl_exchange_request
26
+ # @return [CreateMdlExchangeResponse]
27
+ def create_mdl_exchange(opts = {})
28
+ data, _status_code, _headers = create_mdl_exchange_with_http_info(opts)
29
+ data
30
+ end
31
+
32
+ # Create mDL Exchange
33
+ # 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.
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [CreateMdlExchangeRequest] :create_mdl_exchange_request
36
+ # @return [Array<(CreateMdlExchangeResponse, Integer, Hash)>] CreateMdlExchangeResponse data, response status code and response headers
37
+ def create_mdl_exchange_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: MdlApi.create_mdl_exchange ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/api/valpha/mdl/exchanges/create'
43
+
44
+ # query parameters
45
+ query_params = opts[:query_params] || {}
46
+
47
+ # header parameters
48
+ header_params = opts[:header_params] || {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
51
+ # HTTP header 'Content-Type'
52
+ content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
53
+ if !content_type.nil?
54
+ header_params['Content-Type'] = content_type
55
+ end
56
+
57
+ # form parameters
58
+ form_params = opts[:form_params] || {}
59
+
60
+ # http body (model)
61
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_mdl_exchange_request'])
62
+
63
+ # return_type
64
+ return_type = opts[:debug_return_type] || 'CreateMdlExchangeResponse'
65
+
66
+ # auth_names
67
+ auth_names = opts[:debug_auth_names] || ['Bearer']
68
+
69
+ new_options = opts.merge(
70
+ :operation => :"MdlApi.create_mdl_exchange",
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: MdlApi#create_mdl_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # Finalize mDL Exchange
87
+ # Finalizes an mDL Exchange, processing the results
88
+ # @param [Hash] opts the optional parameters
89
+ # @option opts [FinalizeMdlExchangeRequest] :finalize_mdl_exchange_request
90
+ # @return [FinalizeMdlExchangeResponse]
91
+ def finalize_mdl_exchange(opts = {})
92
+ data, _status_code, _headers = finalize_mdl_exchange_with_http_info(opts)
93
+ data
94
+ end
95
+
96
+ # Finalize mDL Exchange
97
+ # Finalizes an mDL Exchange, processing the results
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [FinalizeMdlExchangeRequest] :finalize_mdl_exchange_request
100
+ # @return [Array<(FinalizeMdlExchangeResponse, Integer, Hash)>] FinalizeMdlExchangeResponse data, response status code and response headers
101
+ def finalize_mdl_exchange_with_http_info(opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: MdlApi.finalize_mdl_exchange ...'
104
+ end
105
+ # resource path
106
+ local_var_path = '/api/valpha/mdl/exchanges/finalize'
107
+
108
+ # query parameters
109
+ query_params = opts[:query_params] || {}
110
+
111
+ # header parameters
112
+ header_params = opts[:header_params] || {}
113
+ # HTTP header 'Accept' (if needed)
114
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/problem+json']) unless header_params['Accept']
115
+ # HTTP header 'Content-Type'
116
+ content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
117
+ if !content_type.nil?
118
+ header_params['Content-Type'] = content_type
119
+ end
120
+
121
+ # form parameters
122
+ form_params = opts[:form_params] || {}
123
+
124
+ # http body (model)
125
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'finalize_mdl_exchange_request'])
126
+
127
+ # return_type
128
+ return_type = opts[:debug_return_type] || 'FinalizeMdlExchangeResponse'
129
+
130
+ # auth_names
131
+ auth_names = opts[:debug_auth_names] || ['Bearer']
132
+
133
+ new_options = opts.merge(
134
+ :operation => :"MdlApi.finalize_mdl_exchange",
135
+ :header_params => header_params,
136
+ :query_params => query_params,
137
+ :form_params => form_params,
138
+ :body => post_body,
139
+ :auth_names => auth_names,
140
+ :return_type => return_type
141
+ )
142
+
143
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
144
+ if @api_client.config.debugging
145
+ @api_client.config.logger.debug "API called: MdlApi#finalize_mdl_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
146
+ end
147
+ return data, status_code, headers
148
+ end
149
+ end
150
+ end
@@ -21,23 +21,29 @@ module TrinsicApi
21
21
  end
22
22
  # List Provider Contracts
23
23
  # 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.
24
+ # @param verification_profile_id [String]
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [ListProviderContractsResponse]
26
- def list_provider_contracts(opts = {})
27
- data, _status_code, _headers = list_provider_contracts_with_http_info(opts)
27
+ def list_provider_contracts(verification_profile_id, opts = {})
28
+ data, _status_code, _headers = list_provider_contracts_with_http_info(verification_profile_id, opts)
28
29
  data
29
30
  end
30
31
 
31
32
  # List Provider Contracts
32
33
  # 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.
34
+ # @param verification_profile_id [String]
33
35
  # @param [Hash] opts the optional parameters
34
36
  # @return [Array<(ListProviderContractsResponse, Integer, Hash)>] ListProviderContractsResponse data, response status code and response headers
35
- def list_provider_contracts_with_http_info(opts = {})
37
+ def list_provider_contracts_with_http_info(verification_profile_id, opts = {})
36
38
  if @api_client.config.debugging
37
39
  @api_client.config.logger.debug 'Calling API: NetworkApi.list_provider_contracts ...'
38
40
  end
41
+ # verify the required parameter 'verification_profile_id' is set
42
+ if @api_client.config.client_side_validation && verification_profile_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'verification_profile_id' when calling NetworkApi.list_provider_contracts"
44
+ end
39
45
  # resource path
40
- local_var_path = '/api/v1/network/providers/contracts'
46
+ local_var_path = '/api/v1/network/{verificationProfileId}/providers/contracts'.sub('{' + 'verificationProfileId' + '}', CGI.escape(verification_profile_id.to_s))
41
47
 
42
48
  # query parameters
43
49
  query_params = opts[:query_params] || {}
@@ -78,25 +84,31 @@ module TrinsicApi
78
84
 
79
85
  # List Providers
80
86
  # List all identity providers available for use
87
+ # @param verification_profile_id [String]
81
88
  # @param [Hash] opts the optional parameters
82
89
  # @option opts [String] :health Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;.
83
90
  # @return [ListProvidersResponse]
84
- def list_providers(opts = {})
85
- data, _status_code, _headers = list_providers_with_http_info(opts)
91
+ def list_providers(verification_profile_id, opts = {})
92
+ data, _status_code, _headers = list_providers_with_http_info(verification_profile_id, opts)
86
93
  data
87
94
  end
88
95
 
89
96
  # List Providers
90
97
  # List all identity providers available for use
98
+ # @param verification_profile_id [String]
91
99
  # @param [Hash] opts the optional parameters
92
100
  # @option opts [String] :health Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;.
93
101
  # @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
94
- def list_providers_with_http_info(opts = {})
102
+ def list_providers_with_http_info(verification_profile_id, opts = {})
95
103
  if @api_client.config.debugging
96
104
  @api_client.config.logger.debug 'Calling API: NetworkApi.list_providers ...'
97
105
  end
106
+ # verify the required parameter 'verification_profile_id' is set
107
+ if @api_client.config.client_side_validation && verification_profile_id.nil?
108
+ fail ArgumentError, "Missing the required parameter 'verification_profile_id' when calling NetworkApi.list_providers"
109
+ end
98
110
  # resource path
99
- local_var_path = '/api/v1/network/providers'
111
+ local_var_path = '/api/v1/network/{verificationProfileId}/providers'.sub('{' + 'verificationProfileId' + '}', CGI.escape(verification_profile_id.to_s))
100
112
 
101
113
  # query parameters
102
114
  query_params = opts[:query_params] || {}