trinsic_api 2.1.1.pre.alpha2 → 2.2.0.pre.alpha1

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 +21 -18
  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 +103 -27
  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 +22 -14
  29. data/lib/trinsic_api/api/sessions_api.rb +99 -23
  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 +3 -3
  60. data/spec/api/sessions_api_spec.rb +21 -7
  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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fb8c1256f2b82fda2cfe039fe0f639205d0eaf4fb723e7e624dd3e1ac0a9e035
4
- data.tar.gz: 37e08a82c6a552c962d76f2944e9b5649671e2431bb7c2c6963d00e2d3517bd3
3
+ metadata.gz: 1606f679ee6a3a00fd03d49a806262a05f341b274e73896f92d1399ea41189ae
4
+ data.tar.gz: 53386531142f18cf674f449b2936a68401ee7ea38f4725538cf04e150d7bcad3
5
5
  SHA512:
6
- metadata.gz: e1e545618fdf78ebbfdc87b5196c25182dd8307c1decff05bddbaea687c6047626f24ff4f47492f02fac8e1b130d82bb08f1d32f94ddff9c9641d49c5e511706
7
- data.tar.gz: 52bca12c0a068c80774e791d8c143a6145f9bb8b5a7b13dec6e2bc7d6db91c9c231ae8ed6e1beb536d65a7cecaefdb8ca983d8feb9eb9441378f885e290fbf32
6
+ metadata.gz: 72dc95e2cc0ca0624bf7e809b4cf51b9421f7b914a7dd73b9e9eac8b3378833b971660632690d9ebcc5fba1f4616ecf03a5b1d773c4d28c09e6d0eeaf67090a4
7
+ data.tar.gz: 5edb021eec2b2e0ed975b3730202d61f3fcba4d340dcfc4b652b53a9b09f8ca67448e08261f0a68574f964b46226a80ffc85f15dfea2abbe09913828621a609b
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::AppleWalletInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The exchange mechanism to use for this Apple Wallet verification. Use `DigitalCredentialsApi` for Digital Credentials API on web, or `NativeApp` for a native iOS app. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::AppleWalletInput.new(
15
+ exchange_mechanism: null
16
+ )
17
+ ```
18
+
@@ -28,7 +28,7 @@ end
28
28
 
29
29
  api_instance = TrinsicApi::AttachmentsApi.new
30
30
  opts = {
31
- get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example'}) # GetAttachmentRequest |
31
+ get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example', session_id: '00000000-0000-0000-0000-000000000000'}) # GetAttachmentRequest |
32
32
  }
33
33
 
34
34
  begin
@@ -1,12 +1,13 @@
1
- # TrinsicApi::CreateAdvancedProviderSessionRequest
1
+ # TrinsicApi::CreateDirectProviderSessionRequest
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **provider** | **String** | The ID of the provider to launch | |
8
+ | **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. | |
8
9
  | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. This field is required for providers which employ a redirect-based flow. | [optional] |
9
- | **capabilities** | [**Array<IntegrationCapability>**](IntegrationCapability.md) | The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/advanced-provider-sessions\">the guide on Advanced Provider Sessions</a> | |
10
+ | **capabilities** | [**Array<IntegrationCapability>**](IntegrationCapability.md) | The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/direct-provider-sessions\">the guide on Direct Provider Sessions</a> | |
10
11
  | **fallback_to_hosted_ui** | **Boolean** | Whether the session should fall back to a Trinsic-hosted UI in certain instances. Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete - In this case, Trinsic's hosted UI will collect the necessary input from the user If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect. If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field | [optional] |
11
12
  | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. | [optional] |
12
13
 
@@ -15,8 +16,9 @@
15
16
  ```ruby
16
17
  require 'trinsic_api'
17
18
 
18
- instance = TrinsicApi::CreateAdvancedProviderSessionRequest.new(
19
+ instance = TrinsicApi::CreateDirectProviderSessionRequest.new(
19
20
  provider: null,
21
+ verification_profile_id: null,
20
22
  redirect_url: null,
21
23
  capabilities: null,
22
24
  fallback_to_hosted_ui: null,
@@ -1,4 +1,4 @@
1
- # TrinsicApi::CreateAdvancedProviderSessionResponse
1
+ # TrinsicApi::CreateDirectProviderSessionResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'trinsic_api'
15
15
 
16
- instance = TrinsicApi::CreateAdvancedProviderSessionResponse.new(
16
+ instance = TrinsicApi::CreateDirectProviderSessionResponse.new(
17
17
  session_id: 00000000-0000-0000-0000-000000000000,
18
18
  result_collection: null,
19
19
  next_step: null
@@ -5,8 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **provider** | **String** | The ID of the provider to launch | |
8
+ | **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. | |
8
9
  | **redirect_url** | **String** | The Redirect URL to which the user should be sent after the session is complete. | |
9
- | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Advanced Session endpoint instead. | [optional] |
10
+ | **provider_input** | [**ProviderInput**](ProviderInput.md) | Provider-specific input for those providers which require it. <b>Deprecated:</b> In the future, Hosted Provider Sessions will not accept input on creation, and will instead always redirect the user to a hosted interface to collect input. If you need to collect input from the user yourself, please use the Create Direct Session endpoint instead. | [optional] |
10
11
 
11
12
  ## Example
12
13
 
@@ -15,6 +16,7 @@ require 'trinsic_api'
15
16
 
16
17
  instance = TrinsicApi::CreateHostedProviderSessionRequest.new(
17
18
  provider: null,
19
+ verification_profile_id: null,
18
20
  redirect_url: null,
19
21
  provider_input: null
20
22
  )
@@ -0,0 +1,32 @@
1
+ # TrinsicApi::CreateMdlExchangeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this mDL exchange. | |
8
+ | **provider** | **String** | The ID of the provider to use for this mDL exchange. | |
9
+ | **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The mechanism by which the mDL exchange will occur (web, native SDK, etc.) | |
10
+ | **document_type** | **String** | The document type to request from the wallet. Typically, this is one of the following values: - `org.iso.18013.5.1.mDL` (Mobile Driver's License) - `com.google.wallet.idcard.1` (Google Wallet ID Pass) | |
11
+ | **name_spaces** | **Hash<String, Hash<String, Boolean>>** | The namespaces and fields to request from the mDL. This is a nested map / dictionary. The outer dictionary's keys are namespaces (e.g. \"org.iso.18013.5.1\"). The inner dictionary's keys are field names within each namespace, with boolean values indicating whether the specified field will be retained post-verification. | |
12
+ | **digital_credentials_api_host** | **String** | If using the `DigitalCredentialsApi` exchange mechanism, this is the hostname on which the Digital Credentials API will be called. For example, if the user is on the page `https://foo.example.com/verify-mdl`, the proper value to use is `foo.example.com`. Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
13
+ | **android_native_app_package_name** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the package name of the Android App which will execute the mDL exchange. This should be set to the package name of your app. Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
14
+ | **android_native_app_signing_certificate_fingerprint** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the SHA-256 fingerprint of the signing certificate used to sign the Android App which will execute the mDL exchange. Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'trinsic_api'
20
+
21
+ instance = TrinsicApi::CreateMdlExchangeRequest.new(
22
+ verification_profile_id: null,
23
+ provider: google-wallet,
24
+ exchange_mechanism: null,
25
+ document_type: org.iso.18013.5.1.mDL,
26
+ name_spaces: {"org.iso.18013.5.1":{"given_name":true,"family_name":true,"birth_date":true,"age_over_21":true}},
27
+ digital_credentials_api_host: verify.trinsic.id,
28
+ android_native_app_package_name: id.trinsic.example,
29
+ android_native_app_signing_certificate_fingerprint: 96:77:82:71:A3:FC:26:54:4C:8E:06:70:B7:BA:5D:E2:A5:36:F1:ED:8F:8A:70:81:26:98:EC:87:86:0F:D4:42
30
+ )
31
+ ```
32
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::CreateMdlExchangeResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **exchange_id** | **String** | The ID of the mDL exchange which was created. | |
8
+ | **request_object_base64_url** | **String** | The request object for this mDL exchange. Pass this into a Trinsic mDL SDK (Web, iOS, Android) exactly as-is to initiate the mDL exchange. | |
9
+ | **exchange_context** | **String** | The encrypted exchange context for this mDL exchange. This must be passed back to the API during finalization, alongside the response token from the wallet. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::CreateMdlExchangeResponse.new(
17
+ exchange_id: null,
18
+ request_object_base64_url: null,
19
+ exchange_context: null
20
+ )
21
+ ```
22
+
@@ -4,7 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete. *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
7
+ | **verification_profile_id** | **String** | The ID of the Verification Profile to use for this session. | |
8
+ | **redirect_url** | **String** | The URL to redirect the user to after the widget session is complete. *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as a popup; in that case, session resolution is handled by our SDK, not via redirect. | [optional] |
8
9
  | **providers** | **Array<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed. | [optional] |
9
10
  | **recommendation_info** | [**RecommendationInfo**](RecommendationInfo.md) | Data that you already know about the user being verified. This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first. | [optional] |
10
11
 
@@ -14,6 +15,7 @@
14
15
  require 'trinsic_api'
15
16
 
16
17
  instance = TrinsicApi::CreateWidgetSessionRequest.new(
18
+ verification_profile_id: null,
17
19
  redirect_url: null,
18
20
  providers: null,
19
21
  recommendation_info: null
@@ -0,0 +1,20 @@
1
+ # TrinsicApi::ExternalMdlFieldData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | [**MdlFieldDataType**](MdlFieldDataType.md) | The type of data contained in `value`. | |
8
+ | **value** | **String** | The string-encoded value of the field. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'trinsic_api'
14
+
15
+ instance = TrinsicApi::ExternalMdlFieldData.new(
16
+ type: null,
17
+ value: 123 Fake St
18
+ )
19
+ ```
20
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::FinalizeMdlExchangeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **verification_profile_id** | **String** | The ID of the VerificationProfile which was used to create the mDL exchange. | |
8
+ | **exchange_id** | **String** | The ID of the mDL exchange to finalize. | |
9
+ | **exchange_context** | **String** | The encrypted exchange context which was returned when the mDL exchange was created. | |
10
+ | **response_token** | **String** | The response token returned by Trinsic's SDK after a successful mDL exchange. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::FinalizeMdlExchangeRequest.new(
18
+ verification_profile_id: null,
19
+ exchange_id: null,
20
+ exchange_context: null,
21
+ response_token: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::FinalizeMdlExchangeResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **exchange_id** | **String** | The Exchange ID of the mDL exchange which was just finalized. | |
8
+ | **created_session** | [**Session**](Session.md) | The AcceptanceSession which was created as a result of finalizing this mDL exchange. | |
9
+ | **mdl_data** | [**MdlIdentityData**](MdlIdentityData.md) | The identity data from the mDL exchange, in a semi-normalized format. Supports all possible fields and namespaces, but does not map them to Trinsic's common data model. | [optional] |
10
+ | **normalized_identity_data** | [**IdentityData**](IdentityData.md) | The identity data from the mDL exchange, normalized into Trinsic's common data model. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::FinalizeMdlExchangeResponse.new(
18
+ exchange_id: null,
19
+ created_session: null,
20
+ mdl_data: null,
21
+ normalized_identity_data: null
22
+ )
23
+ ```
24
+
@@ -5,6 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **attachment_access_key** | **String** | The Attachment Access Key to exchange for the raw file contents of the related Attachment | |
8
+ | **session_id** | **String** | The ID of the Acceptance Session for which the Attachment is being requested. | |
8
9
 
9
10
  ## Example
10
11
 
@@ -12,7 +13,8 @@
12
13
  require 'trinsic_api'
13
14
 
14
15
  instance = TrinsicApi::GetAttachmentRequest.new(
15
- attachment_access_key: null
16
+ attachment_access_key: null,
17
+ session_id: 00000000-0000-0000-0000-000000000000
16
18
  )
17
19
  ```
18
20
 
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::GoogleWalletInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The exchange mechanism to use for this Google Wallet verification. Use `DigitalCredentialsApi` for Digital Credentials API on web, or `NativeApp` for a native Android app. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::GoogleWalletInput.new(
15
+ exchange_mechanism: null
16
+ )
17
+ ```
18
+
data/docs/MdlApi.md ADDED
@@ -0,0 +1,151 @@
1
+ # TrinsicApi::MdlApi
2
+
3
+ All URIs are relative to *https://api.trinsic.id*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_mdl_exchange**](MdlApi.md#create_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/create | Create mDL Exchange |
8
+ | [**finalize_mdl_exchange**](MdlApi.md#finalize_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/finalize | Finalize mDL Exchange |
9
+
10
+
11
+ ## create_mdl_exchange
12
+
13
+ > <CreateMdlExchangeResponse> create_mdl_exchange(opts)
14
+
15
+ Create mDL Exchange
16
+
17
+ 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.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'trinsic_api'
24
+ # setup authorization
25
+ TrinsicApi.configure do |config|
26
+ # Configure Bearer authorization: Bearer
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = TrinsicApi::MdlApi.new
31
+ opts = {
32
+ create_mdl_exchange_request: TrinsicApi::CreateMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', provider: 'google-wallet', exchange_mechanism: TrinsicApi::MdlExchangeMechanism::NATIVE_APP, document_type: 'org.iso.18013.5.1.mDL', name_spaces: { key: { key: false}}}) # CreateMdlExchangeRequest |
33
+ }
34
+
35
+ begin
36
+ # Create mDL Exchange
37
+ result = api_instance.create_mdl_exchange(opts)
38
+ p result
39
+ rescue TrinsicApi::ApiError => e
40
+ puts "Error when calling MdlApi->create_mdl_exchange: #{e}"
41
+ end
42
+ ```
43
+
44
+ #### Using the create_mdl_exchange_with_http_info variant
45
+
46
+ This returns an Array which contains the response data, status code and headers.
47
+
48
+ > <Array(<CreateMdlExchangeResponse>, Integer, Hash)> create_mdl_exchange_with_http_info(opts)
49
+
50
+ ```ruby
51
+ begin
52
+ # Create mDL Exchange
53
+ data, status_code, headers = api_instance.create_mdl_exchange_with_http_info(opts)
54
+ p status_code # => 2xx
55
+ p headers # => { ... }
56
+ p data # => <CreateMdlExchangeResponse>
57
+ rescue TrinsicApi::ApiError => e
58
+ puts "Error when calling MdlApi->create_mdl_exchange_with_http_info: #{e}"
59
+ end
60
+ ```
61
+
62
+ ### Parameters
63
+
64
+ | Name | Type | Description | Notes |
65
+ | ---- | ---- | ----------- | ----- |
66
+ | **create_mdl_exchange_request** | [**CreateMdlExchangeRequest**](CreateMdlExchangeRequest.md) | | [optional] |
67
+
68
+ ### Return type
69
+
70
+ [**CreateMdlExchangeResponse**](CreateMdlExchangeResponse.md)
71
+
72
+ ### Authorization
73
+
74
+ [Bearer](../README.md#Bearer)
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: application/json, text/json, application/*+json
79
+ - **Accept**: text/plain, application/json, text/json, application/problem+json
80
+
81
+
82
+ ## finalize_mdl_exchange
83
+
84
+ > <FinalizeMdlExchangeResponse> finalize_mdl_exchange(opts)
85
+
86
+ Finalize mDL Exchange
87
+
88
+ Finalizes an mDL Exchange, processing the results
89
+
90
+ ### Examples
91
+
92
+ ```ruby
93
+ require 'time'
94
+ require 'trinsic_api'
95
+ # setup authorization
96
+ TrinsicApi.configure do |config|
97
+ # Configure Bearer authorization: Bearer
98
+ config.access_token = 'YOUR_BEARER_TOKEN'
99
+ end
100
+
101
+ api_instance = TrinsicApi::MdlApi.new
102
+ opts = {
103
+ finalize_mdl_exchange_request: TrinsicApi::FinalizeMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', exchange_id: 'exchange_id_example', exchange_context: 'exchange_context_example', response_token: 'response_token_example'}) # FinalizeMdlExchangeRequest |
104
+ }
105
+
106
+ begin
107
+ # Finalize mDL Exchange
108
+ result = api_instance.finalize_mdl_exchange(opts)
109
+ p result
110
+ rescue TrinsicApi::ApiError => e
111
+ puts "Error when calling MdlApi->finalize_mdl_exchange: #{e}"
112
+ end
113
+ ```
114
+
115
+ #### Using the finalize_mdl_exchange_with_http_info variant
116
+
117
+ This returns an Array which contains the response data, status code and headers.
118
+
119
+ > <Array(<FinalizeMdlExchangeResponse>, Integer, Hash)> finalize_mdl_exchange_with_http_info(opts)
120
+
121
+ ```ruby
122
+ begin
123
+ # Finalize mDL Exchange
124
+ data, status_code, headers = api_instance.finalize_mdl_exchange_with_http_info(opts)
125
+ p status_code # => 2xx
126
+ p headers # => { ... }
127
+ p data # => <FinalizeMdlExchangeResponse>
128
+ rescue TrinsicApi::ApiError => e
129
+ puts "Error when calling MdlApi->finalize_mdl_exchange_with_http_info: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ | Name | Type | Description | Notes |
136
+ | ---- | ---- | ----------- | ----- |
137
+ | **finalize_mdl_exchange_request** | [**FinalizeMdlExchangeRequest**](FinalizeMdlExchangeRequest.md) | | [optional] |
138
+
139
+ ### Return type
140
+
141
+ [**FinalizeMdlExchangeResponse**](FinalizeMdlExchangeResponse.md)
142
+
143
+ ### Authorization
144
+
145
+ [Bearer](../README.md#Bearer)
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: application/json, text/json, application/*+json
150
+ - **Accept**: text/plain, application/json, text/json, application/problem+json
151
+
@@ -0,0 +1,26 @@
1
+ # TrinsicApi::MdlCertificateData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **serial_number** | **String** | The serial number of the certificate | |
8
+ | **common_name** | **String** | The common name (CN) of the certificate | |
9
+ | **state_or_province_name** | **String** | The state or province name (ST) of the certificate. May be an empty string for certificates which are not state-specific (e.g., Google Wallet&#39;s ID Pass certificates). | |
10
+ | **not_before** | **Time** | The date before which this certificate is not valid. | |
11
+ | **not_after** | **Time** | The date after which this certificate is not valid. | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'trinsic_api'
17
+
18
+ instance = TrinsicApi::MdlCertificateData.new(
19
+ serial_number: null,
20
+ common_name: null,
21
+ state_or_province_name: null,
22
+ not_before: null,
23
+ not_after: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,15 @@
1
+ # TrinsicApi::MdlExchangeMechanism
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trinsic_api'
12
+
13
+ instance = TrinsicApi::MdlExchangeMechanism.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # TrinsicApi::MdlFieldDataType
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'trinsic_api'
12
+
13
+ instance = TrinsicApi::MdlFieldDataType.new()
14
+ ```
15
+
@@ -0,0 +1,22 @@
1
+ # TrinsicApi::MdlIdentityData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **iaca_root_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the IACA Root Certificate which signed the Issuer Certificate for this mDL. | |
8
+ | **document_signer_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the Document Signer Certificate which signed the mDL presented by the user. | |
9
+ | **name_spaces** | **Hash&lt;String, Hash&lt;String, ExternalMdlFieldData&gt;&gt;** | The namespaces, and fields within those namespaces, which were present in the processed mDL. | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'trinsic_api'
15
+
16
+ instance = TrinsicApi::MdlIdentityData.new(
17
+ iaca_root_certificate: null,
18
+ document_signer_certificate: null,
19
+ name_spaces: {&quot;org.iso.18013.5.1&quot;:{&quot;family_name&quot;:{&quot;type&quot;:&quot;String&quot;,&quot;value&quot;:&quot;DOE&quot;},&quot;given_name&quot;:{&quot;type&quot;:&quot;String&quot;,&quot;value&quot;:&quot;JOHN&quot;},&quot;birth_date&quot;:{&quot;type&quot;:&quot;String&quot;,&quot;value&quot;:&quot;2000-03-27&quot;},&quot;age_over_21&quot;:{&quot;type&quot;:&quot;Boolean&quot;,&quot;value&quot;:&quot;true&quot;}}}
20
+ )
21
+ ```
22
+
data/docs/NetworkApi.md CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.trinsic.id*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/providers/contracts | List Provider Contracts |
8
- | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/providers | List Providers |
7
+ | [**list_provider_contracts**](NetworkApi.md#list_provider_contracts) | **GET** /api/v1/network/{verificationProfileId}/providers/contracts | List Provider Contracts |
8
+ | [**list_providers**](NetworkApi.md#list_providers) | **GET** /api/v1/network/{verificationProfileId}/providers | |
9
9
  | [**recommend_providers**](NetworkApi.md#recommend_providers) | **POST** /api/v1/network/recommend | Recommend Providers |
10
10
 
11
11
 
12
12
  ## list_provider_contracts
13
13
 
14
- > <ListProviderContractsResponse> list_provider_contracts
14
+ > <ListProviderContractsResponse> list_provider_contracts(verification_profile_id)
15
15
 
16
16
  List Provider Contracts
17
17
 
@@ -29,10 +29,11 @@ TrinsicApi.configure do |config|
29
29
  end
30
30
 
31
31
  api_instance = TrinsicApi::NetworkApi.new
32
+ verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
32
33
 
33
34
  begin
34
35
  # List Provider Contracts
35
- result = api_instance.list_provider_contracts
36
+ result = api_instance.list_provider_contracts(verification_profile_id)
36
37
  p result
37
38
  rescue TrinsicApi::ApiError => e
38
39
  puts "Error when calling NetworkApi->list_provider_contracts: #{e}"
@@ -43,12 +44,12 @@ end
43
44
 
44
45
  This returns an Array which contains the response data, status code and headers.
45
46
 
46
- > <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info
47
+ > <Array(<ListProviderContractsResponse>, Integer, Hash)> list_provider_contracts_with_http_info(verification_profile_id)
47
48
 
48
49
  ```ruby
49
50
  begin
50
51
  # List Provider Contracts
51
- data, status_code, headers = api_instance.list_provider_contracts_with_http_info
52
+ data, status_code, headers = api_instance.list_provider_contracts_with_http_info(verification_profile_id)
52
53
  p status_code # => 2xx
53
54
  p headers # => { ... }
54
55
  p data # => <ListProviderContractsResponse>
@@ -59,7 +60,9 @@ end
59
60
 
60
61
  ### Parameters
61
62
 
62
- This endpoint does not need any parameter.
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **verification_profile_id** | **String** | | |
63
66
 
64
67
  ### Return type
65
68
 
@@ -77,11 +80,9 @@ This endpoint does not need any parameter.
77
80
 
78
81
  ## list_providers
79
82
 
80
- > <ListProvidersResponse> list_providers(opts)
83
+ > <ListProvidersResponse> list_providers(verification_profile_id, opts)
81
84
 
82
- List Providers
83
85
 
84
- List all identity providers available for use
85
86
 
86
87
  ### Examples
87
88
 
@@ -95,13 +96,14 @@ TrinsicApi.configure do |config|
95
96
  end
96
97
 
97
98
  api_instance = TrinsicApi::NetworkApi.new
99
+ verification_profile_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
98
100
  opts = {
99
- health: 'health_example' # String | Filter providers by health status. Valid values: \"online\", \"offline\", \"all\". Defaults to \"all\".
101
+ health: 'health_example' # String |
100
102
  }
101
103
 
102
104
  begin
103
- # List Providers
104
- result = api_instance.list_providers(opts)
105
+
106
+ result = api_instance.list_providers(verification_profile_id, opts)
105
107
  p result
106
108
  rescue TrinsicApi::ApiError => e
107
109
  puts "Error when calling NetworkApi->list_providers: #{e}"
@@ -112,12 +114,12 @@ end
112
114
 
113
115
  This returns an Array which contains the response data, status code and headers.
114
116
 
115
- > <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info(opts)
117
+ > <Array(<ListProvidersResponse>, Integer, Hash)> list_providers_with_http_info(verification_profile_id, opts)
116
118
 
117
119
  ```ruby
118
120
  begin
119
- # List Providers
120
- data, status_code, headers = api_instance.list_providers_with_http_info(opts)
121
+
122
+ data, status_code, headers = api_instance.list_providers_with_http_info(verification_profile_id, opts)
121
123
  p status_code # => 2xx
122
124
  p headers # => { ... }
123
125
  p data # => <ListProvidersResponse>
@@ -130,7 +132,8 @@ end
130
132
 
131
133
  | Name | Type | Description | Notes |
132
134
  | ---- | ---- | ----------- | ----- |
133
- | **health** | **String** | Filter providers by health status. Valid values: \&quot;online\&quot;, \&quot;offline\&quot;, \&quot;all\&quot;. Defaults to \&quot;all\&quot;. | [optional] |
135
+ | **verification_profile_id** | **String** | | |
136
+ | **health** | **String** | | [optional] |
134
137
 
135
138
  ### Return type
136
139
 
@@ -167,7 +170,7 @@ end
167
170
 
168
171
  api_instance = TrinsicApi::NetworkApi.new
169
172
  opts = {
170
- recommend_request: TrinsicApi::RecommendRequest.new # RecommendRequest |
173
+ recommend_request: TrinsicApi::RecommendRequest.new({verification_profile_id: 'verification_profile_id_example'}) # RecommendRequest |
171
174
  }
172
175
 
173
176
  begin