@trinsic/api 2.0.0-alpha3 → 2.0.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 (146) hide show
  1. package/.openapi-generator/FILES +11 -3
  2. package/dist/apis/AttachmentsApi.d.ts +4 -4
  3. package/dist/apis/AttachmentsApi.js +2 -2
  4. package/dist/apis/NetworkApi.d.ts +28 -5
  5. package/dist/apis/NetworkApi.js +36 -2
  6. package/dist/apis/SessionsApi.d.ts +8 -8
  7. package/dist/apis/SessionsApi.js +4 -4
  8. package/dist/esm/apis/AttachmentsApi.d.ts +4 -4
  9. package/dist/esm/apis/AttachmentsApi.js +2 -2
  10. package/dist/esm/apis/NetworkApi.d.ts +28 -5
  11. package/dist/esm/apis/NetworkApi.js +37 -3
  12. package/dist/esm/apis/SessionsApi.d.ts +8 -8
  13. package/dist/esm/apis/SessionsApi.js +4 -4
  14. package/dist/esm/models/CreateHostedProviderSessionResponse.d.ts +13 -1
  15. package/dist/esm/models/CreateHostedProviderSessionResponse.js +7 -1
  16. package/dist/esm/models/CreateWidgetSessionRequest.d.ts +6 -5
  17. package/dist/esm/models/CreateWidgetSessionRequest.js +3 -3
  18. package/dist/esm/models/CreateWidgetSessionResponse.d.ts +13 -1
  19. package/dist/esm/models/CreateWidgetSessionResponse.js +7 -1
  20. package/dist/esm/models/IdentityData.d.ts +6 -0
  21. package/dist/esm/models/IdentityData.js +2 -0
  22. package/dist/esm/models/IdinInput.d.ts +33 -0
  23. package/dist/esm/models/IdinInput.js +38 -0
  24. package/dist/esm/models/IntegrationLaunchMethod.d.ts +1 -1
  25. package/dist/esm/models/IntegrationLaunchMethod.js +1 -1
  26. package/dist/esm/models/Language.d.ts +26 -0
  27. package/dist/esm/models/Language.js +42 -0
  28. package/dist/esm/models/ListProviderContractsResponse.d.ts +32 -0
  29. package/dist/esm/models/ListProviderContractsResponse.js +41 -0
  30. package/dist/esm/models/MobileIdInput.d.ts +44 -0
  31. package/dist/esm/models/MobileIdInput.js +43 -0
  32. package/dist/esm/models/ProviderContract.d.ts +146 -0
  33. package/dist/esm/models/ProviderContract.js +97 -0
  34. package/dist/esm/models/ProviderInfo.d.ts +0 -6
  35. package/dist/esm/models/ProviderInfo.js +0 -2
  36. package/dist/esm/models/ProviderInformation.d.ts +4 -4
  37. package/dist/esm/models/ProviderInformation.js +1 -5
  38. package/dist/esm/models/ProviderInput.d.ts +62 -16
  39. package/dist/esm/models/ProviderInput.js +23 -5
  40. package/dist/esm/models/RecommendRequest.d.ts +4 -27
  41. package/dist/esm/models/RecommendRequest.js +3 -10
  42. package/dist/esm/models/RecommendationInfo.d.ts +55 -0
  43. package/dist/esm/models/RecommendationInfo.js +44 -0
  44. package/dist/esm/models/ResultCollection.d.ts +8 -2
  45. package/dist/esm/models/ResultCollection.js +3 -1
  46. package/dist/esm/models/SmartIdInput.d.ts +31 -0
  47. package/dist/esm/models/SmartIdInput.js +38 -0
  48. package/dist/esm/models/SpidInput.d.ts +33 -0
  49. package/dist/esm/models/SpidInput.js +38 -0
  50. package/dist/esm/models/SubProviderMetadata.d.ts +54 -0
  51. package/dist/esm/models/SubProviderMetadata.js +52 -0
  52. package/dist/esm/models/TrinsicTestDatabaseLookupInput.d.ts +66 -0
  53. package/dist/esm/models/TrinsicTestDatabaseLookupInput.js +44 -0
  54. package/dist/esm/models/TrinsicTestSubProvidersInput.d.ts +35 -0
  55. package/dist/esm/models/TrinsicTestSubProvidersInput.js +38 -0
  56. package/dist/esm/models/index.d.ts +11 -3
  57. package/dist/esm/models/index.js +11 -3
  58. package/dist/models/CreateHostedProviderSessionResponse.d.ts +13 -1
  59. package/dist/models/CreateHostedProviderSessionResponse.js +7 -1
  60. package/dist/models/CreateWidgetSessionRequest.d.ts +6 -5
  61. package/dist/models/CreateWidgetSessionRequest.js +3 -3
  62. package/dist/models/CreateWidgetSessionResponse.d.ts +13 -1
  63. package/dist/models/CreateWidgetSessionResponse.js +7 -1
  64. package/dist/models/IdentityData.d.ts +6 -0
  65. package/dist/models/IdentityData.js +2 -0
  66. package/dist/models/IdinInput.d.ts +33 -0
  67. package/dist/models/IdinInput.js +44 -0
  68. package/dist/models/IntegrationLaunchMethod.d.ts +1 -1
  69. package/dist/models/IntegrationLaunchMethod.js +1 -1
  70. package/dist/models/Language.d.ts +26 -0
  71. package/dist/models/Language.js +49 -0
  72. package/dist/models/ListProviderContractsResponse.d.ts +32 -0
  73. package/dist/models/ListProviderContractsResponse.js +47 -0
  74. package/dist/models/MobileIdInput.d.ts +44 -0
  75. package/dist/models/MobileIdInput.js +49 -0
  76. package/dist/models/ProviderContract.d.ts +146 -0
  77. package/dist/models/ProviderContract.js +103 -0
  78. package/dist/models/ProviderInfo.d.ts +0 -6
  79. package/dist/models/ProviderInfo.js +0 -2
  80. package/dist/models/ProviderInformation.d.ts +4 -4
  81. package/dist/models/ProviderInformation.js +1 -5
  82. package/dist/models/ProviderInput.d.ts +62 -16
  83. package/dist/models/ProviderInput.js +23 -5
  84. package/dist/models/RecommendRequest.d.ts +4 -27
  85. package/dist/models/RecommendRequest.js +3 -10
  86. package/dist/models/RecommendationInfo.d.ts +55 -0
  87. package/dist/models/RecommendationInfo.js +50 -0
  88. package/dist/models/ResultCollection.d.ts +8 -2
  89. package/dist/models/ResultCollection.js +3 -1
  90. package/dist/models/SmartIdInput.d.ts +31 -0
  91. package/dist/models/SmartIdInput.js +44 -0
  92. package/dist/models/SpidInput.d.ts +33 -0
  93. package/dist/models/SpidInput.js +44 -0
  94. package/dist/models/SubProviderMetadata.d.ts +54 -0
  95. package/dist/models/SubProviderMetadata.js +58 -0
  96. package/dist/models/TrinsicTestDatabaseLookupInput.d.ts +66 -0
  97. package/dist/models/TrinsicTestDatabaseLookupInput.js +50 -0
  98. package/dist/models/TrinsicTestSubProvidersInput.d.ts +35 -0
  99. package/dist/models/TrinsicTestSubProvidersInput.js +44 -0
  100. package/dist/models/index.d.ts +11 -3
  101. package/dist/models/index.js +11 -3
  102. package/package.json +1 -1
  103. package/src/apis/AttachmentsApi.ts +4 -4
  104. package/src/apis/NetworkApi.ts +58 -4
  105. package/src/apis/SessionsApi.ts +8 -8
  106. package/src/models/BrazilDigitalCnhInput.ts +8 -8
  107. package/src/models/CreateAdvancedProviderSessionRequest.ts +26 -26
  108. package/src/models/CreateHostedProviderSessionResponse.ts +24 -8
  109. package/src/models/CreateWidgetSessionRequest.ts +16 -15
  110. package/src/models/CreateWidgetSessionResponse.ts +22 -6
  111. package/src/models/IdentityData.ts +8 -0
  112. package/src/models/IdinInput.ts +62 -0
  113. package/src/models/IntegrationLaunchMethod.ts +1 -1
  114. package/src/models/Language.ts +51 -0
  115. package/src/models/ListProviderContractsResponse.ts +68 -0
  116. package/src/models/MobileIdInput.ts +85 -0
  117. package/src/models/ProviderContract.ts +235 -0
  118. package/src/models/ProviderInfo.ts +0 -8
  119. package/src/models/ProviderInformation.ts +4 -7
  120. package/src/models/ProviderInput.ts +128 -40
  121. package/src/models/RecommendRequest.ts +12 -37
  122. package/src/models/RecommendationInfo.ts +90 -0
  123. package/src/models/ResultCollection.ts +10 -3
  124. package/src/models/Session.ts +7 -7
  125. package/src/models/SmartIdInput.ts +60 -0
  126. package/src/models/SpidInput.ts +62 -0
  127. package/src/models/StepRefreshInfo.ts +2 -2
  128. package/src/models/SubProviderMetadata.ts +93 -0
  129. package/src/models/TrinsicTestDatabaseLookupInput.ts +101 -0
  130. package/src/models/TrinsicTestSubProvidersInput.ts +64 -0
  131. package/src/models/index.ts +11 -3
  132. package/dist/esm/models/KnownAddress.d.ts +0 -74
  133. package/dist/esm/models/KnownAddress.js +0 -52
  134. package/dist/esm/models/KnownIdentityData.d.ts +0 -34
  135. package/dist/esm/models/KnownIdentityData.js +0 -39
  136. package/dist/esm/models/KnownPersonData.d.ts +0 -74
  137. package/dist/esm/models/KnownPersonData.js +0 -53
  138. package/dist/models/KnownAddress.d.ts +0 -74
  139. package/dist/models/KnownAddress.js +0 -58
  140. package/dist/models/KnownIdentityData.d.ts +0 -34
  141. package/dist/models/KnownIdentityData.js +0 -45
  142. package/dist/models/KnownPersonData.d.ts +0 -74
  143. package/dist/models/KnownPersonData.js +0 -59
  144. package/src/models/KnownAddress.ts +0 -117
  145. package/src/models/KnownIdentityData.ts +0 -69
  146. package/src/models/KnownPersonData.ts +0 -123
@@ -15,12 +15,15 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ ListProviderContractsResponse,
18
19
  ListProvidersResponse,
19
20
  ProblemDetails,
20
21
  RecommendRequest,
21
22
  RecommendResponse,
22
23
  } from '../models/index';
23
24
  import {
25
+ ListProviderContractsResponseFromJSON,
26
+ ListProviderContractsResponseToJSON,
24
27
  ListProvidersResponseFromJSON,
25
28
  ListProvidersResponseToJSON,
26
29
  ProblemDetailsFromJSON,
@@ -42,9 +45,24 @@ export interface RecommendProvidersRequest {
42
45
  * @interface NetworkApiInterface
43
46
  */
44
47
  export interface NetworkApiInterface {
48
+ /**
49
+ * 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.
50
+ * @summary List Provider Contracts
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ * @memberof NetworkApiInterface
54
+ */
55
+ listProviderContractsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListProviderContractsResponse>>;
56
+
57
+ /**
58
+ * 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.
59
+ * List Provider Contracts
60
+ */
61
+ listProviderContracts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProviderContractsResponse>;
62
+
45
63
  /**
46
64
  * List all identity providers available for use
47
- * @summary List Identity Providers
65
+ * @summary List Providers
48
66
  * @param {*} [options] Override http request option.
49
67
  * @throws {RequiredError}
50
68
  * @memberof NetworkApiInterface
@@ -53,7 +71,7 @@ export interface NetworkApiInterface {
53
71
 
54
72
  /**
55
73
  * List all identity providers available for use
56
- * List Identity Providers
74
+ * List Providers
57
75
  */
58
76
  listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse>;
59
77
 
@@ -80,9 +98,45 @@ export interface NetworkApiInterface {
80
98
  */
81
99
  export class NetworkApi extends runtime.BaseAPI implements NetworkApiInterface {
82
100
 
101
+ /**
102
+ * 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.
103
+ * List Provider Contracts
104
+ */
105
+ async listProviderContractsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListProviderContractsResponse>> {
106
+ const queryParameters: any = {};
107
+
108
+ const headerParameters: runtime.HTTPHeaders = {};
109
+
110
+ if (this.configuration && this.configuration.accessToken) {
111
+ const token = this.configuration.accessToken;
112
+ const tokenString = await token("Bearer", []);
113
+
114
+ if (tokenString) {
115
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
116
+ }
117
+ }
118
+ const response = await this.request({
119
+ path: `/api/v1/network/providers/contracts`,
120
+ method: 'GET',
121
+ headers: headerParameters,
122
+ query: queryParameters,
123
+ }, initOverrides);
124
+
125
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListProviderContractsResponseFromJSON(jsonValue));
126
+ }
127
+
128
+ /**
129
+ * 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.
130
+ * List Provider Contracts
131
+ */
132
+ async listProviderContracts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProviderContractsResponse> {
133
+ const response = await this.listProviderContractsRaw(initOverrides);
134
+ return await response.value();
135
+ }
136
+
83
137
  /**
84
138
  * List all identity providers available for use
85
- * List Identity Providers
139
+ * List Providers
86
140
  */
87
141
  async listProvidersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListProvidersResponse>> {
88
142
  const queryParameters: any = {};
@@ -109,7 +163,7 @@ export class NetworkApi extends runtime.BaseAPI implements NetworkApiInterface {
109
163
 
110
164
  /**
111
165
  * List all identity providers available for use
112
- * List Identity Providers
166
+ * List Providers
113
167
  */
114
168
  async listProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListProvidersResponse> {
115
169
  const response = await this.listProvidersRaw(initOverrides);
@@ -132,7 +132,7 @@ export interface SessionsApiInterface {
132
132
  cancelSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSessionResponse>;
133
133
 
134
134
  /**
135
- * 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.
135
+ * 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.
136
136
  * @summary Create Advanced Provider Session
137
137
  * @param {CreateAdvancedProviderSessionRequest} [createAdvancedProviderSessionRequest]
138
138
  * @param {*} [options] Override http request option.
@@ -142,7 +142,7 @@ export interface SessionsApiInterface {
142
142
  createAdvancedProviderSessionRaw(requestParameters: CreateAdvancedProviderSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAdvancedProviderSessionResponse>>;
143
143
 
144
144
  /**
145
- * 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.
145
+ * 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.
146
146
  * Create Advanced Provider Session
147
147
  */
148
148
  createAdvancedProviderSession(createAdvancedProviderSessionRequest?: CreateAdvancedProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAdvancedProviderSessionResponse>;
@@ -231,7 +231,7 @@ export interface SessionsApiInterface {
231
231
  listSessions(orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse>;
232
232
 
233
233
  /**
234
- * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
234
+ * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
235
235
  * @summary Redact Session
236
236
  * @param {string} sessionId
237
237
  * @param {*} [options] Override http request option.
@@ -241,7 +241,7 @@ export interface SessionsApiInterface {
241
241
  redactSessionRaw(requestParameters: RedactSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
242
242
 
243
243
  /**
244
- * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
244
+ * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
245
245
  * Redact Session
246
246
  */
247
247
  redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -314,7 +314,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
314
314
  }
315
315
 
316
316
  /**
317
- * 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.
317
+ * 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.
318
318
  * Create Advanced Provider Session
319
319
  */
320
320
  async createAdvancedProviderSessionRaw(requestParameters: CreateAdvancedProviderSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAdvancedProviderSessionResponse>> {
@@ -344,7 +344,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
344
344
  }
345
345
 
346
346
  /**
347
- * 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.
347
+ * 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.
348
348
  * Create Advanced Provider Session
349
349
  */
350
350
  async createAdvancedProviderSession(createAdvancedProviderSessionRequest?: CreateAdvancedProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAdvancedProviderSessionResponse> {
@@ -570,7 +570,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
570
570
  }
571
571
 
572
572
  /**
573
- * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
573
+ * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
574
574
  * Redact Session
575
575
  */
576
576
  async redactSessionRaw(requestParameters: RedactSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -604,7 +604,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
604
604
  }
605
605
 
606
606
  /**
607
- * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
607
+ * Redact a Session, removing all identity data from Trinsic\'s servers. Every application has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately. Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
608
608
  * Redact Session
609
609
  */
610
610
  async redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
@@ -26,20 +26,20 @@ export interface BrazilDigitalCnhInput {
26
26
  */
27
27
  cpfNumber: string;
28
28
  /**
29
- * The raw bytes of the digital CNH file collected from the user.
30
- *
31
- * TODO: Lucas or JP help me describe these below vvvvvvvv
32
- * This can be:
33
- * - An image containing a physical or digital QR code
34
- * - A PDF file exported from the CNH app
29
+ * The raw bytes of the digital CNH file collected from the user.
30
+ *
31
+ * TODO: Lucas or JP help me describe these below vvvvvvvv
32
+ * This can be:
33
+ * - An image containing a physical or digital QR code
34
+ * - A PDF file exported from the CNH app
35
35
  * - Some scary third thing?
36
36
  * @type {string}
37
37
  * @memberof BrazilDigitalCnhInput
38
38
  */
39
39
  digitalCnhFile?: string | null;
40
40
  /**
41
- * The MIME Type of the file contained in `DigitalCnhFile`.
42
- *
41
+ * The MIME Type of the file contained in `DigitalCnhFile`.
42
+ *
43
43
  * Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
44
44
  * @type {string}
45
45
  * @memberof BrazilDigitalCnhInput
@@ -45,44 +45,44 @@ export interface CreateAdvancedProviderSessionRequest {
45
45
  */
46
46
  providerInput?: ProviderInput | null;
47
47
  /**
48
- * The Redirect URL to which the user should be sent after the session is complete.
49
- *
48
+ * The Redirect URL to which the user should be sent after the session is complete.
49
+ *
50
50
  * This field is required for providers which employ a redirect-based flow.
51
51
  * @type {string}
52
52
  * @memberof CreateAdvancedProviderSessionRequest
53
53
  */
54
54
  redirectUrl?: string | null;
55
55
  /**
56
- * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
57
- *
58
- * Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.
59
- * The exception being refresh content to support updating the content of the launch method.
60
- *
61
- * For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.
62
- * To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.
63
- *
64
- * If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.
65
- * If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.
66
- *
56
+ * The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering.
57
+ *
58
+ * Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`.
59
+ * The exception being refresh content to support updating the content of the launch method.
60
+ *
61
+ * For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities.
62
+ * To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities.
63
+ *
64
+ * If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities.
65
+ * If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation.
66
+ *
67
67
  * Read more on how to integrate at <a href="https://docs.trinsic.id/docs/advanced-provider-sessions">the guide on Advanced Provider Sessions</a>
68
68
  * @type {Array<IntegrationCapability>}
69
69
  * @memberof CreateAdvancedProviderSessionRequest
70
70
  */
71
71
  capabilities: Array<IntegrationCapability>;
72
72
  /**
73
- * Whether the session should fall back to a Trinsic-hosted UI in certain instances.
74
- *
75
- * Specifically, fallback will occur if any of the following are true:
76
- * - You attempted to launch a provider which requires a capability you did not express support for
77
- * - In this case, Trinsic's hosted UI will perform the necessary capability
78
- * - You attempted to launch a provider which requires input, and the input was either not provided or incomplete
79
- * - In this case, Trinsic's hosted UI will collect the necessary input from the user
80
- *
81
- * If fallback occurs, the session's NextStep will always be LaunchBrowser,
82
- * and the CollectionMethod will always be CaptureRedirect.
83
- *
84
- * If this field is set to `true`, you must also:
85
- * 1. Set the `RedirectUrl` field to a non-empty value
73
+ * Whether the session should fall back to a Trinsic-hosted UI in certain instances.
74
+ *
75
+ * Specifically, fallback will occur if any of the following are true:
76
+ * - You attempted to launch a provider which requires a capability you did not express support for
77
+ * - In this case, Trinsic's hosted UI will perform the necessary capability
78
+ * - You attempted to launch a provider which requires input, and the input was either not provided or incomplete
79
+ * - In this case, Trinsic's hosted UI will collect the necessary input from the user
80
+ *
81
+ * If fallback occurs, the session's NextStep will always be LaunchBrowser,
82
+ * and the CollectionMethod will always be CaptureRedirect.
83
+ *
84
+ * If this field is set to `true`, you must also:
85
+ * 1. Set the `RedirectUrl` field to a non-empty value
86
86
  * 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
87
87
  * @type {boolean}
88
88
  * @memberof CreateAdvancedProviderSessionRequest
@@ -26,17 +26,29 @@ export interface CreateHostedProviderSessionResponse {
26
26
  */
27
27
  sessionId: string;
28
28
  /**
29
- * The URL that should be used to launch the Hosted Provider Session on your user's device.
30
- *
31
- * There are two recommended ways to do so:
32
- * - Redirect their browser to the `LaunchUrl` as a top-level navigation
33
- * - Open a popup window and navigate it to the `LaunchUrl`
34
- *
29
+ * The URL that should be used to launch the Hosted Provider Session on your user's device.
30
+ *
31
+ * There are two recommended ways to do so:
32
+ * - Redirect their browser to the `LaunchUrl` as a top-level navigation
33
+ * - Open a popup window and navigate it to the `LaunchUrl`
34
+ *
35
35
  * This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
36
36
  * @type {string}
37
37
  * @memberof CreateHostedProviderSessionResponse
38
38
  */
39
- launchUrl?: string | null;
39
+ launchUrl: string;
40
+ /**
41
+ * The `resultsAccessKey` for the Acceptance Session.
42
+ *
43
+ * This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.
44
+ *
45
+ * Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.
46
+ *
47
+ * Trinsic cannot access a Session's Data Vault without this key.
48
+ * @type {string}
49
+ * @memberof CreateHostedProviderSessionResponse
50
+ */
51
+ resultsAccessKey: string;
40
52
  }
41
53
 
42
54
  /**
@@ -44,6 +56,8 @@ export interface CreateHostedProviderSessionResponse {
44
56
  */
45
57
  export function instanceOfCreateHostedProviderSessionResponse(value: object): value is CreateHostedProviderSessionResponse {
46
58
  if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
59
+ if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
60
+ if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined) return false;
47
61
  return true;
48
62
  }
49
63
 
@@ -58,7 +72,8 @@ export function CreateHostedProviderSessionResponseFromJSONTyped(json: any, igno
58
72
  return {
59
73
 
60
74
  'sessionId': json['sessionId'],
61
- 'launchUrl': json['launchUrl'] == null ? undefined : json['launchUrl'],
75
+ 'launchUrl': json['launchUrl'],
76
+ 'resultsAccessKey': json['resultsAccessKey'],
62
77
  };
63
78
  }
64
79
 
@@ -70,6 +85,7 @@ export function CreateHostedProviderSessionResponseToJSON(value?: CreateHostedPr
70
85
 
71
86
  'sessionId': value['sessionId'],
72
87
  'launchUrl': value['launchUrl'],
88
+ 'resultsAccessKey': value['resultsAccessKey'],
73
89
  };
74
90
  }
75
91
 
@@ -13,12 +13,12 @@
13
13
  */
14
14
 
15
15
  import { mapValues } from '../runtime';
16
- import type { KnownIdentityData } from './KnownIdentityData';
16
+ import type { RecommendationInfo } from './RecommendationInfo';
17
17
  import {
18
- KnownIdentityDataFromJSON,
19
- KnownIdentityDataFromJSONTyped,
20
- KnownIdentityDataToJSON,
21
- } from './KnownIdentityData';
18
+ RecommendationInfoFromJSON,
19
+ RecommendationInfoFromJSONTyped,
20
+ RecommendationInfoToJSON,
21
+ } from './RecommendationInfo';
22
22
 
23
23
  /**
24
24
  *
@@ -27,9 +27,9 @@ import {
27
27
  */
28
28
  export interface CreateWidgetSessionRequest {
29
29
  /**
30
- * The URL to redirect the user to after the widget session is complete.
31
- *
32
- * *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget
30
+ * The URL to redirect the user to after the widget session is complete.
31
+ *
32
+ * *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget
33
33
  * as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect.
34
34
  * @type {string}
35
35
  * @memberof CreateWidgetSessionRequest
@@ -42,13 +42,14 @@ export interface CreateWidgetSessionRequest {
42
42
  */
43
43
  providers?: Array<string> | null;
44
44
  /**
45
- * Known identity data of an individual being verified.
46
- *
47
- * Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
48
- * @type {KnownIdentityData}
45
+ * Data that you already know about the user being verified.
46
+ *
47
+ *
48
+ * This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first.
49
+ * @type {RecommendationInfo}
49
50
  * @memberof CreateWidgetSessionRequest
50
51
  */
51
- knownIdentityData?: KnownIdentityData | null;
52
+ recommendationInfo?: RecommendationInfo | null;
52
53
  }
53
54
 
54
55
  /**
@@ -70,7 +71,7 @@ export function CreateWidgetSessionRequestFromJSONTyped(json: any, ignoreDiscrim
70
71
 
71
72
  'redirectUrl': json['redirectUrl'] == null ? undefined : json['redirectUrl'],
72
73
  'providers': json['providers'] == null ? undefined : json['providers'],
73
- 'knownIdentityData': json['knownIdentityData'] == null ? undefined : KnownIdentityDataFromJSON(json['knownIdentityData']),
74
+ 'recommendationInfo': json['recommendationInfo'] == null ? undefined : RecommendationInfoFromJSON(json['recommendationInfo']),
74
75
  };
75
76
  }
76
77
 
@@ -82,7 +83,7 @@ export function CreateWidgetSessionRequestToJSON(value?: CreateWidgetSessionRequ
82
83
 
83
84
  'redirectUrl': value['redirectUrl'],
84
85
  'providers': value['providers'],
85
- 'knownIdentityData': KnownIdentityDataToJSON(value['knownIdentityData']),
86
+ 'recommendationInfo': RecommendationInfoToJSON(value['recommendationInfo']),
86
87
  };
87
88
  }
88
89
 
@@ -26,15 +26,27 @@ export interface CreateWidgetSessionResponse {
26
26
  */
27
27
  sessionId: string;
28
28
  /**
29
- * The URL that should be used to invoke the Acceptance Session on your user's device.
30
- *
31
- * You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.
32
- *
29
+ * The URL that should be used to invoke the Acceptance Session on your user's device.
30
+ *
31
+ * You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.
32
+ *
33
33
  * This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
34
34
  * @type {string}
35
35
  * @memberof CreateWidgetSessionResponse
36
36
  */
37
- launchUrl?: string | null;
37
+ launchUrl: string;
38
+ /**
39
+ * The `resultsAccessKey` for the Acceptance Session.
40
+ *
41
+ * This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault.
42
+ *
43
+ * Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault.
44
+ *
45
+ * Trinsic cannot access a Session's Data Vault without this key.
46
+ * @type {string}
47
+ * @memberof CreateWidgetSessionResponse
48
+ */
49
+ resultsAccessKey: string;
38
50
  }
39
51
 
40
52
  /**
@@ -42,6 +54,8 @@ export interface CreateWidgetSessionResponse {
42
54
  */
43
55
  export function instanceOfCreateWidgetSessionResponse(value: object): value is CreateWidgetSessionResponse {
44
56
  if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
57
+ if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
58
+ if (!('resultsAccessKey' in value) || value['resultsAccessKey'] === undefined) return false;
45
59
  return true;
46
60
  }
47
61
 
@@ -56,7 +70,8 @@ export function CreateWidgetSessionResponseFromJSONTyped(json: any, ignoreDiscri
56
70
  return {
57
71
 
58
72
  'sessionId': json['sessionId'],
59
- 'launchUrl': json['launchUrl'] == null ? undefined : json['launchUrl'],
73
+ 'launchUrl': json['launchUrl'],
74
+ 'resultsAccessKey': json['resultsAccessKey'],
60
75
  };
61
76
  }
62
77
 
@@ -68,6 +83,7 @@ export function CreateWidgetSessionResponseToJSON(value?: CreateWidgetSessionRes
68
83
 
69
84
  'sessionId': value['sessionId'],
70
85
  'launchUrl': value['launchUrl'],
86
+ 'resultsAccessKey': value['resultsAccessKey'],
71
87
  };
72
88
  }
73
89
 
@@ -44,6 +44,12 @@ export interface IdentityData {
44
44
  * @memberof IdentityData
45
45
  */
46
46
  originatingProviderId?: string | null;
47
+ /**
48
+ *
49
+ * @type {string}
50
+ * @memberof IdentityData
51
+ */
52
+ originatingSubProviderId?: string | null;
47
53
  /**
48
54
  *
49
55
  * @type {PersonData}
@@ -82,6 +88,7 @@ export function IdentityDataFromJSONTyped(json: any, ignoreDiscriminator: boolea
82
88
  return {
83
89
 
84
90
  'originatingProviderId': json['originatingProviderId'] == null ? undefined : json['originatingProviderId'],
91
+ 'originatingSubProviderId': json['originatingSubProviderId'] == null ? undefined : json['originatingSubProviderId'],
85
92
  'person': json['person'] == null ? undefined : PersonDataFromJSON(json['person']),
86
93
  'document': json['document'] == null ? undefined : DocumentDataFromJSON(json['document']),
87
94
  'attachmentAccessKeys': json['attachmentAccessKeys'] == null ? undefined : AttachmentAccessKeysFromJSON(json['attachmentAccessKeys']),
@@ -95,6 +102,7 @@ export function IdentityDataToJSON(value?: IdentityData | null): any {
95
102
  return {
96
103
 
97
104
  'originatingProviderId': value['originatingProviderId'],
105
+ 'originatingSubProviderId': value['originatingSubProviderId'],
98
106
  'person': PersonDataToJSON(value['person']),
99
107
  'document': DocumentDataToJSON(value['document']),
100
108
  'attachmentAccessKeys': AttachmentAccessKeysToJSON(value['attachmentAccessKeys']),
@@ -0,0 +1,62 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Trinsic API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface IdinInput
20
+ */
21
+ export interface IdinInput {
22
+ /**
23
+ * The ID of the specific bank to invoke with IDIN.
24
+ *
25
+ * If not specified, the user will be prompted to select a bank.
26
+ * @type {string}
27
+ * @memberof IdinInput
28
+ */
29
+ subProviderId?: string | null;
30
+ }
31
+
32
+ /**
33
+ * Check if a given object implements the IdinInput interface.
34
+ */
35
+ export function instanceOfIdinInput(value: object): value is IdinInput {
36
+ return true;
37
+ }
38
+
39
+ export function IdinInputFromJSON(json: any): IdinInput {
40
+ return IdinInputFromJSONTyped(json, false);
41
+ }
42
+
43
+ export function IdinInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): IdinInput {
44
+ if (json == null) {
45
+ return json;
46
+ }
47
+ return {
48
+
49
+ 'subProviderId': json['subProviderId'] == null ? undefined : json['subProviderId'],
50
+ };
51
+ }
52
+
53
+ export function IdinInputToJSON(value?: IdinInput | null): any {
54
+ if (value == null) {
55
+ return value;
56
+ }
57
+ return {
58
+
59
+ 'subProviderId': value['subProviderId'],
60
+ };
61
+ }
62
+
@@ -19,7 +19,7 @@
19
19
  */
20
20
  export const IntegrationLaunchMethod = {
21
21
  LaunchBrowser: 'LaunchBrowser',
22
- PollResult: 'PollResult',
22
+ None: 'None',
23
23
  DeeplinkToMobile: 'DeeplinkToMobile',
24
24
  ShowContent: 'ShowContent'
25
25
  } as const;
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Trinsic API
5
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
6
+ *
7
+ * The version of the OpenAPI document: v1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ /**
17
+ *
18
+ * @export
19
+ */
20
+ export const Language = {
21
+ Lit: 'LIT',
22
+ Est: 'EST',
23
+ Eng: 'ENG',
24
+ Rus: 'RUS'
25
+ } as const;
26
+ export type Language = typeof Language[keyof typeof Language];
27
+
28
+
29
+ export function instanceOfLanguage(value: any): boolean {
30
+ for (const key in Language) {
31
+ if (Object.prototype.hasOwnProperty.call(Language, key)) {
32
+ if (Language[key as keyof typeof Language] === value) {
33
+ return true;
34
+ }
35
+ }
36
+ }
37
+ return false;
38
+ }
39
+
40
+ export function LanguageFromJSON(json: any): Language {
41
+ return LanguageFromJSONTyped(json, false);
42
+ }
43
+
44
+ export function LanguageFromJSONTyped(json: any, ignoreDiscriminator: boolean): Language {
45
+ return json as Language;
46
+ }
47
+
48
+ export function LanguageToJSON(value?: Language | null): any {
49
+ return value as any;
50
+ }
51
+