@gbg/go-core 0.1.3 → 0.2.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (918) hide show
  1. package/FUNCTIONS.md +6 -4
  2. package/README.md +159 -59
  3. package/dist/commonjs/funcs/addresses-retrieve.d.ts +19 -0
  4. package/dist/commonjs/funcs/addresses-retrieve.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/{tasks-list.js → addresses-retrieve.js} +21 -10
  6. package/dist/commonjs/funcs/addresses-retrieve.js.map +1 -0
  7. package/dist/{esm/funcs/tasks-list-schema.d.ts → commonjs/funcs/addresses-search.d.ts} +6 -6
  8. package/dist/commonjs/funcs/addresses-search.d.ts.map +1 -0
  9. package/dist/commonjs/funcs/{tasks-update.js → addresses-search.js} +21 -10
  10. package/dist/commonjs/funcs/addresses-search.js.map +1 -0
  11. package/dist/commonjs/funcs/devices-add.d.ts +5 -3
  12. package/dist/commonjs/funcs/devices-add.d.ts.map +1 -1
  13. package/dist/commonjs/funcs/devices-add.js +8 -3
  14. package/dist/commonjs/funcs/devices-add.js.map +1 -1
  15. package/dist/commonjs/funcs/devices-connect.d.ts +5 -3
  16. package/dist/commonjs/funcs/devices-connect.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/devices-connect.js +9 -5
  18. package/dist/commonjs/funcs/devices-connect.js.map +1 -1
  19. package/dist/{esm/funcs/health-get.d.ts → commonjs/funcs/devices-refresh.d.ts} +6 -5
  20. package/dist/commonjs/funcs/devices-refresh.d.ts.map +1 -0
  21. package/dist/commonjs/funcs/{health-get.js → devices-refresh.js} +16 -17
  22. package/dist/commonjs/funcs/devices-refresh.js.map +1 -0
  23. package/dist/commonjs/funcs/{health-get.d.ts → devices-validate.d.ts} +6 -4
  24. package/dist/commonjs/funcs/devices-validate.d.ts.map +1 -0
  25. package/dist/commonjs/funcs/devices-validate.js +113 -0
  26. package/dist/commonjs/funcs/devices-validate.js.map +1 -0
  27. package/dist/commonjs/funcs/instances-delete.d.ts +5 -3
  28. package/dist/commonjs/funcs/instances-delete.d.ts.map +1 -1
  29. package/dist/commonjs/funcs/instances-delete.js +8 -3
  30. package/dist/commonjs/funcs/instances-delete.js.map +1 -1
  31. package/dist/commonjs/funcs/instances-handoff-token.d.ts +19 -0
  32. package/dist/commonjs/funcs/instances-handoff-token.d.ts.map +1 -0
  33. package/dist/commonjs/funcs/instances-handoff-token.js +130 -0
  34. package/dist/commonjs/funcs/instances-handoff-token.js.map +1 -0
  35. package/dist/commonjs/funcs/interactions-fetch.d.ts +4 -3
  36. package/dist/commonjs/funcs/interactions-fetch.d.ts.map +1 -1
  37. package/dist/commonjs/funcs/interactions-fetch.js +18 -6
  38. package/dist/commonjs/funcs/interactions-fetch.js.map +1 -1
  39. package/dist/commonjs/funcs/interactions-submit.d.ts +5 -3
  40. package/dist/commonjs/funcs/interactions-submit.d.ts.map +1 -1
  41. package/dist/commonjs/funcs/interactions-submit.js +14 -3
  42. package/dist/commonjs/funcs/interactions-submit.js.map +1 -1
  43. package/dist/commonjs/funcs/interactions-upload-asset.d.ts +18 -0
  44. package/dist/commonjs/funcs/interactions-upload-asset.d.ts.map +1 -0
  45. package/dist/commonjs/funcs/interactions-upload-asset.js +119 -0
  46. package/dist/commonjs/funcs/interactions-upload-asset.js.map +1 -0
  47. package/dist/commonjs/funcs/journeys-get-schemas.d.ts +46 -0
  48. package/dist/commonjs/funcs/journeys-get-schemas.d.ts.map +1 -0
  49. package/dist/commonjs/funcs/journeys-get-schemas.js +150 -0
  50. package/dist/commonjs/funcs/journeys-get-schemas.js.map +1 -0
  51. package/dist/commonjs/funcs/journeys-get-state.d.ts +4 -3
  52. package/dist/commonjs/funcs/journeys-get-state.d.ts.map +1 -1
  53. package/dist/commonjs/funcs/journeys-get-state.js +12 -6
  54. package/dist/commonjs/funcs/journeys-get-state.js.map +1 -1
  55. package/dist/commonjs/funcs/journeys-start.d.ts +5 -3
  56. package/dist/commonjs/funcs/journeys-start.d.ts.map +1 -1
  57. package/dist/commonjs/funcs/journeys-start.js +8 -3
  58. package/dist/commonjs/funcs/journeys-start.js.map +1 -1
  59. package/dist/commonjs/funcs/journeys-terminate.d.ts +21 -0
  60. package/dist/commonjs/funcs/journeys-terminate.d.ts.map +1 -0
  61. package/dist/commonjs/funcs/{tasks-list-schema.js → journeys-terminate.js} +14 -9
  62. package/dist/commonjs/funcs/journeys-terminate.js.map +1 -0
  63. package/dist/commonjs/funcs/tasks-get-schema.d.ts +8 -3
  64. package/dist/commonjs/funcs/tasks-get-schema.d.ts.map +1 -1
  65. package/dist/commonjs/funcs/tasks-get-schema.js +9 -3
  66. package/dist/commonjs/funcs/tasks-get-schema.js.map +1 -1
  67. package/dist/commonjs/funcs/test-scenarios-create.d.ts +21 -0
  68. package/dist/commonjs/funcs/test-scenarios-create.d.ts.map +1 -0
  69. package/dist/commonjs/funcs/test-scenarios-create.js +129 -0
  70. package/dist/commonjs/funcs/test-scenarios-create.js.map +1 -0
  71. package/dist/commonjs/funcs/test-scenarios-delete.d.ts +20 -0
  72. package/dist/commonjs/funcs/test-scenarios-delete.d.ts.map +1 -0
  73. package/dist/commonjs/funcs/test-scenarios-delete.js +131 -0
  74. package/dist/commonjs/funcs/test-scenarios-delete.js.map +1 -0
  75. package/dist/commonjs/funcs/test-scenarios-get.d.ts +21 -0
  76. package/dist/commonjs/funcs/test-scenarios-get.d.ts.map +1 -0
  77. package/dist/commonjs/funcs/test-scenarios-get.js +136 -0
  78. package/dist/commonjs/funcs/test-scenarios-get.js.map +1 -0
  79. package/dist/commonjs/funcs/test-scenarios-list.d.ts +21 -0
  80. package/dist/commonjs/funcs/test-scenarios-list.d.ts.map +1 -0
  81. package/dist/commonjs/funcs/test-scenarios-list.js +132 -0
  82. package/dist/commonjs/funcs/test-scenarios-list.js.map +1 -0
  83. package/dist/commonjs/funcs/test-scenarios-put.d.ts +21 -0
  84. package/dist/commonjs/funcs/test-scenarios-put.d.ts.map +1 -0
  85. package/dist/commonjs/funcs/test-scenarios-put.js +133 -0
  86. package/dist/commonjs/funcs/test-scenarios-put.js.map +1 -0
  87. package/dist/commonjs/funcs/tokens-generate.d.ts +2 -1
  88. package/dist/commonjs/funcs/tokens-generate.d.ts.map +1 -1
  89. package/dist/commonjs/funcs/tokens-generate.js +6 -2
  90. package/dist/commonjs/funcs/tokens-generate.js.map +1 -1
  91. package/dist/commonjs/lib/config.d.ts +4 -4
  92. package/dist/commonjs/lib/config.d.ts.map +1 -1
  93. package/dist/commonjs/lib/config.js +13 -4
  94. package/dist/commonjs/lib/config.js.map +1 -1
  95. package/dist/commonjs/models/create-test-scenario-request.d.ts +29 -0
  96. package/dist/commonjs/models/create-test-scenario-request.d.ts.map +1 -0
  97. package/dist/commonjs/models/create-test-scenario-request.js +56 -0
  98. package/dist/commonjs/models/create-test-scenario-request.js.map +1 -0
  99. package/dist/commonjs/models/delete-response.d.ts +19 -0
  100. package/dist/commonjs/models/delete-response.d.ts.map +1 -0
  101. package/dist/commonjs/models/delete-response.js +57 -0
  102. package/dist/commonjs/models/delete-response.js.map +1 -0
  103. package/dist/commonjs/models/device-connect-request.d.ts +29 -0
  104. package/dist/commonjs/models/device-connect-request.d.ts.map +1 -0
  105. package/dist/commonjs/models/device-connect-request.js +59 -0
  106. package/dist/commonjs/models/device-connect-request.js.map +1 -0
  107. package/dist/commonjs/models/device-connect-response.d.ts +25 -0
  108. package/dist/commonjs/models/device-connect-response.d.ts.map +1 -0
  109. package/dist/commonjs/models/device-connect-response.js +63 -0
  110. package/dist/commonjs/models/device-connect-response.js.map +1 -0
  111. package/dist/commonjs/models/device-refresh-response.d.ts +16 -0
  112. package/dist/commonjs/models/device-refresh-response.d.ts.map +1 -0
  113. package/dist/commonjs/models/device-refresh-response.js +56 -0
  114. package/dist/commonjs/models/device-refresh-response.js.map +1 -0
  115. package/dist/commonjs/models/device-start-response.d.ts +20 -0
  116. package/dist/commonjs/models/device-start-response.d.ts.map +1 -0
  117. package/dist/commonjs/models/device-start-response.js +58 -0
  118. package/dist/commonjs/models/device-start-response.js.map +1 -0
  119. package/dist/commonjs/models/device-validate-response.d.ts +14 -0
  120. package/dist/commonjs/models/device-validate-response.d.ts.map +1 -0
  121. package/dist/commonjs/models/device-validate-response.js +54 -0
  122. package/dist/commonjs/models/device-validate-response.js.map +1 -0
  123. package/dist/commonjs/models/errors/error-response.d.ts +19 -0
  124. package/dist/commonjs/models/errors/error-response.d.ts.map +1 -0
  125. package/dist/commonjs/models/errors/error-response.js +68 -0
  126. package/dist/commonjs/models/errors/error-response.js.map +1 -0
  127. package/dist/commonjs/models/errors/index.d.ts +2 -0
  128. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  129. package/dist/commonjs/models/errors/index.js +2 -0
  130. package/dist/commonjs/models/errors/index.js.map +1 -1
  131. package/dist/commonjs/models/errors/o-auth-error-response.d.ts +32 -0
  132. package/dist/commonjs/models/errors/o-auth-error-response.d.ts.map +1 -0
  133. package/dist/commonjs/models/errors/o-auth-error-response.js +75 -0
  134. package/dist/commonjs/models/errors/o-auth-error-response.js.map +1 -0
  135. package/dist/commonjs/models/gbg-error.d.ts +28 -0
  136. package/dist/commonjs/models/gbg-error.d.ts.map +1 -0
  137. package/dist/commonjs/models/gbg-error.js +68 -0
  138. package/dist/commonjs/models/gbg-error.js.map +1 -0
  139. package/dist/commonjs/models/handoff-token-response.d.ts +20 -0
  140. package/dist/commonjs/models/handoff-token-response.d.ts.map +1 -0
  141. package/dist/commonjs/models/handoff-token-response.js +59 -0
  142. package/dist/commonjs/models/handoff-token-response.js.map +1 -0
  143. package/dist/commonjs/models/index.d.ts +33 -0
  144. package/dist/commonjs/models/index.d.ts.map +1 -1
  145. package/dist/commonjs/models/index.js +33 -0
  146. package/dist/commonjs/models/index.js.map +1 -1
  147. package/dist/commonjs/models/interaction-fetch-response.d.ts +40 -0
  148. package/dist/commonjs/models/interaction-fetch-response.d.ts.map +1 -0
  149. package/dist/commonjs/models/interaction-fetch-response.js +78 -0
  150. package/dist/commonjs/models/interaction-fetch-response.js.map +1 -0
  151. package/dist/commonjs/models/interaction-submit-response.d.ts +17 -0
  152. package/dist/commonjs/models/interaction-submit-response.d.ts.map +1 -0
  153. package/dist/commonjs/models/interaction-submit-response.js +55 -0
  154. package/dist/commonjs/models/interaction-submit-response.js.map +1 -0
  155. package/dist/commonjs/models/journey-start-response.d.ts +34 -0
  156. package/dist/commonjs/models/journey-start-response.d.ts.map +1 -0
  157. package/dist/commonjs/models/journey-start-response.js +67 -0
  158. package/dist/commonjs/models/journey-start-response.js.map +1 -0
  159. package/dist/commonjs/models/loqate-retrieve-response.d.ts +12 -0
  160. package/dist/commonjs/models/loqate-retrieve-response.d.ts.map +1 -0
  161. package/dist/commonjs/models/loqate-retrieve-response.js +55 -0
  162. package/dist/commonjs/models/loqate-retrieve-response.js.map +1 -0
  163. package/dist/commonjs/models/loqate-search-response.d.ts +12 -0
  164. package/dist/commonjs/models/loqate-search-response.d.ts.map +1 -0
  165. package/dist/commonjs/models/loqate-search-response.js +55 -0
  166. package/dist/commonjs/models/loqate-search-response.js.map +1 -0
  167. package/dist/commonjs/models/operations/add-device.d.ts +8 -92
  168. package/dist/commonjs/models/operations/add-device.d.ts.map +1 -1
  169. package/dist/commonjs/models/operations/add-device.js +6 -76
  170. package/dist/commonjs/models/operations/add-device.js.map +1 -1
  171. package/dist/commonjs/models/operations/create-handoff-token.d.ts +22 -0
  172. package/dist/commonjs/models/operations/create-handoff-token.d.ts.map +1 -0
  173. package/dist/commonjs/models/operations/create-handoff-token.js +62 -0
  174. package/dist/commonjs/models/operations/create-handoff-token.js.map +1 -0
  175. package/dist/commonjs/models/operations/create-test-scenario.d.ts +18 -0
  176. package/dist/commonjs/models/operations/create-test-scenario.d.ts.map +1 -0
  177. package/dist/commonjs/models/operations/create-test-scenario.js +51 -0
  178. package/dist/commonjs/models/operations/create-test-scenario.js.map +1 -0
  179. package/dist/commonjs/models/operations/delete-instance.d.ts +1 -14
  180. package/dist/commonjs/models/operations/delete-instance.d.ts.map +1 -1
  181. package/dist/commonjs/models/operations/delete-instance.js +3 -13
  182. package/dist/commonjs/models/operations/delete-instance.js.map +1 -1
  183. package/dist/commonjs/models/operations/delete-test-scenario.d.ts +20 -0
  184. package/dist/commonjs/models/operations/delete-test-scenario.d.ts.map +1 -0
  185. package/dist/commonjs/models/operations/delete-test-scenario.js +50 -0
  186. package/dist/commonjs/models/operations/delete-test-scenario.js.map +1 -0
  187. package/dist/commonjs/models/operations/device-connect.d.ts +0 -91
  188. package/dist/commonjs/models/operations/device-connect.d.ts.map +1 -1
  189. package/dist/commonjs/models/operations/device-connect.js +1 -69
  190. package/dist/commonjs/models/operations/device-connect.js.map +1 -1
  191. package/dist/commonjs/models/operations/device-validate.d.ts +12 -0
  192. package/dist/commonjs/models/operations/device-validate.d.ts.map +1 -0
  193. package/dist/commonjs/models/operations/device-validate.js +54 -0
  194. package/dist/commonjs/models/operations/device-validate.js.map +1 -0
  195. package/dist/commonjs/models/operations/fetch-interaction.d.ts +35 -1621
  196. package/dist/commonjs/models/operations/fetch-interaction.d.ts.map +1 -1
  197. package/dist/commonjs/models/operations/fetch-interaction.js +24 -1336
  198. package/dist/commonjs/models/operations/fetch-interaction.js.map +1 -1
  199. package/dist/commonjs/models/operations/get-journey-schemas.d.ts +16 -0
  200. package/dist/commonjs/models/operations/get-journey-schemas.d.ts.map +1 -0
  201. package/dist/commonjs/models/operations/get-journey-schemas.js +51 -0
  202. package/dist/commonjs/models/operations/get-journey-schemas.js.map +1 -0
  203. package/dist/commonjs/models/operations/get-journey-state.d.ts +19 -1383
  204. package/dist/commonjs/models/operations/get-journey-state.d.ts.map +1 -1
  205. package/dist/commonjs/models/operations/get-journey-state.js +15 -1068
  206. package/dist/commonjs/models/operations/get-journey-state.js.map +1 -1
  207. package/dist/commonjs/models/operations/get-task-schema.d.ts +1 -17
  208. package/dist/commonjs/models/operations/get-task-schema.d.ts.map +1 -1
  209. package/dist/commonjs/models/operations/get-task-schema.js +1 -19
  210. package/dist/commonjs/models/operations/get-task-schema.js.map +1 -1
  211. package/dist/commonjs/models/operations/get-test-scenario.d.ts +39 -0
  212. package/dist/commonjs/models/operations/get-test-scenario.d.ts.map +1 -0
  213. package/dist/commonjs/models/operations/get-test-scenario.js +60 -0
  214. package/dist/commonjs/models/operations/get-test-scenario.js.map +1 -0
  215. package/dist/commonjs/models/operations/index.d.ts +12 -4
  216. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  217. package/dist/commonjs/models/operations/index.js +12 -4
  218. package/dist/commonjs/models/operations/index.js.map +1 -1
  219. package/dist/commonjs/models/operations/list-test-scenarios.d.ts +34 -0
  220. package/dist/commonjs/models/operations/list-test-scenarios.d.ts.map +1 -0
  221. package/dist/commonjs/models/operations/list-test-scenarios.js +59 -0
  222. package/dist/commonjs/models/operations/list-test-scenarios.js.map +1 -0
  223. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts +2 -2
  224. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  225. package/dist/commonjs/models/operations/post-as-token-oauth2.js +4 -5
  226. package/dist/commonjs/models/operations/post-as-token-oauth2.js.map +1 -1
  227. package/dist/commonjs/models/operations/put-test-scenario.d.ts +23 -0
  228. package/dist/commonjs/models/operations/put-test-scenario.d.ts.map +1 -0
  229. package/dist/commonjs/models/operations/put-test-scenario.js +52 -0
  230. package/dist/commonjs/models/operations/put-test-scenario.js.map +1 -0
  231. package/dist/commonjs/models/operations/retrieve-address.d.ts +29 -0
  232. package/dist/commonjs/models/operations/retrieve-address.d.ts.map +1 -0
  233. package/dist/commonjs/models/operations/retrieve-address.js +65 -0
  234. package/dist/commonjs/models/operations/retrieve-address.js.map +1 -0
  235. package/dist/commonjs/models/operations/search-addresses.d.ts +33 -0
  236. package/dist/commonjs/models/operations/search-addresses.d.ts.map +1 -0
  237. package/dist/commonjs/models/operations/search-addresses.js +67 -0
  238. package/dist/commonjs/models/operations/search-addresses.js.map +1 -0
  239. package/dist/commonjs/models/operations/start-journey.d.ts +1214 -112
  240. package/dist/commonjs/models/operations/start-journey.d.ts.map +1 -1
  241. package/dist/commonjs/models/operations/start-journey.js +602 -66
  242. package/dist/commonjs/models/operations/start-journey.js.map +1 -1
  243. package/dist/commonjs/models/operations/submit-interaction.d.ts +1074 -92
  244. package/dist/commonjs/models/operations/submit-interaction.d.ts.map +1 -1
  245. package/dist/commonjs/models/operations/submit-interaction.js +535 -51
  246. package/dist/commonjs/models/operations/submit-interaction.js.map +1 -1
  247. package/dist/commonjs/models/operations/terminate-journey.d.ts +19 -0
  248. package/dist/commonjs/models/operations/terminate-journey.d.ts.map +1 -0
  249. package/dist/commonjs/models/operations/terminate-journey.js +50 -0
  250. package/dist/commonjs/models/operations/terminate-journey.js.map +1 -0
  251. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts +26 -0
  252. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts.map +1 -0
  253. package/dist/commonjs/models/operations/upload-interaction-asset.js +66 -0
  254. package/dist/commonjs/models/operations/upload-interaction-asset.js.map +1 -0
  255. package/dist/commonjs/models/outstanding-group.d.ts +15 -0
  256. package/dist/commonjs/models/outstanding-group.d.ts.map +1 -0
  257. package/dist/commonjs/models/{operations/health.js → outstanding-group.js} +11 -10
  258. package/dist/commonjs/models/outstanding-group.js.map +1 -0
  259. package/dist/commonjs/models/schema-fetch-response.d.ts +22 -0
  260. package/dist/commonjs/models/schema-fetch-response.d.ts.map +1 -0
  261. package/dist/commonjs/models/schema-fetch-response.js +62 -0
  262. package/dist/commonjs/models/schema-fetch-response.js.map +1 -0
  263. package/dist/commonjs/models/slim-document.d.ts +57 -0
  264. package/dist/commonjs/models/slim-document.d.ts.map +1 -0
  265. package/dist/commonjs/models/slim-document.js +92 -0
  266. package/dist/commonjs/models/slim-document.js.map +1 -0
  267. package/dist/commonjs/models/slim-extraction.d.ts +74 -0
  268. package/dist/commonjs/models/slim-extraction.d.ts.map +1 -0
  269. package/dist/commonjs/models/slim-extraction.js +128 -0
  270. package/dist/commonjs/models/slim-extraction.js.map +1 -0
  271. package/dist/commonjs/models/slim-identity.d.ts +202 -0
  272. package/dist/commonjs/models/slim-identity.d.ts.map +1 -0
  273. package/dist/commonjs/models/slim-identity.js +142 -0
  274. package/dist/commonjs/models/slim-identity.js.map +1 -0
  275. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts +46 -0
  276. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts.map +1 -0
  277. package/dist/commonjs/models/slim-interaction-fetch-response.js +87 -0
  278. package/dist/commonjs/models/slim-interaction-fetch-response.js.map +1 -0
  279. package/dist/commonjs/models/slim-journey.d.ts +14 -0
  280. package/dist/commonjs/models/slim-journey.d.ts.map +1 -0
  281. package/dist/commonjs/models/slim-journey.js +55 -0
  282. package/dist/commonjs/models/slim-journey.js.map +1 -0
  283. package/dist/commonjs/models/slim-module-step-error.d.ts +50 -0
  284. package/dist/commonjs/models/slim-module-step-error.d.ts.map +1 -0
  285. package/dist/commonjs/models/slim-module-step-error.js +79 -0
  286. package/dist/commonjs/models/slim-module-step-error.js.map +1 -0
  287. package/dist/commonjs/models/slim-result.d.ts +49 -0
  288. package/dist/commonjs/models/slim-result.d.ts.map +1 -0
  289. package/dist/commonjs/models/slim-result.js +76 -0
  290. package/dist/commonjs/models/slim-result.js.map +1 -0
  291. package/dist/commonjs/models/slim-state-fetch-response.d.ts +27 -0
  292. package/dist/commonjs/models/slim-state-fetch-response.d.ts.map +1 -0
  293. package/dist/commonjs/models/slim-state-fetch-response.js +66 -0
  294. package/dist/commonjs/models/slim-state-fetch-response.js.map +1 -0
  295. package/dist/commonjs/models/slim-step.d.ts +40 -0
  296. package/dist/commonjs/models/slim-step.d.ts.map +1 -0
  297. package/dist/commonjs/models/slim-step.js +73 -0
  298. package/dist/commonjs/models/slim-step.js.map +1 -0
  299. package/dist/commonjs/models/slim-validation.d.ts +69 -0
  300. package/dist/commonjs/models/slim-validation.d.ts.map +1 -0
  301. package/dist/commonjs/models/slim-validation.js +121 -0
  302. package/dist/commonjs/models/slim-validation.js.map +1 -0
  303. package/dist/commonjs/models/slim-verified-data.d.ts +16 -0
  304. package/dist/commonjs/models/slim-verified-data.d.ts.map +1 -0
  305. package/dist/commonjs/models/slim-verified-data.js +53 -0
  306. package/dist/commonjs/models/slim-verified-data.js.map +1 -0
  307. package/dist/commonjs/models/state-fetch-response.d.ts +25 -0
  308. package/dist/commonjs/models/state-fetch-response.d.ts.map +1 -0
  309. package/dist/commonjs/models/state-fetch-response.js +59 -0
  310. package/dist/commonjs/models/state-fetch-response.js.map +1 -0
  311. package/dist/commonjs/models/terminate-response.d.ts +10 -0
  312. package/dist/commonjs/models/terminate-response.d.ts.map +1 -0
  313. package/dist/commonjs/models/terminate-response.js +50 -0
  314. package/dist/commonjs/models/terminate-response.js.map +1 -0
  315. package/dist/commonjs/models/test-scenario-summary.d.ts +29 -0
  316. package/dist/commonjs/models/test-scenario-summary.d.ts.map +1 -0
  317. package/dist/commonjs/models/test-scenario-summary.js +62 -0
  318. package/dist/commonjs/models/test-scenario-summary.js.map +1 -0
  319. package/dist/commonjs/models/test-scenario-written.d.ts +19 -0
  320. package/dist/commonjs/models/test-scenario-written.d.ts.map +1 -0
  321. package/dist/commonjs/models/test-scenario-written.js +57 -0
  322. package/dist/commonjs/models/test-scenario-written.js.map +1 -0
  323. package/dist/commonjs/models/test-scenario.d.ts +31 -0
  324. package/dist/commonjs/models/test-scenario.d.ts.map +1 -0
  325. package/dist/commonjs/models/test-scenario.js +62 -0
  326. package/dist/commonjs/models/test-scenario.js.map +1 -0
  327. package/dist/commonjs/models/update-test-scenario-request.d.ts +24 -0
  328. package/dist/commonjs/models/update-test-scenario-request.d.ts.map +1 -0
  329. package/dist/commonjs/models/update-test-scenario-request.js +55 -0
  330. package/dist/commonjs/models/update-test-scenario-request.js.map +1 -0
  331. package/dist/commonjs/sdk/addresses.d.ts +20 -0
  332. package/dist/commonjs/sdk/addresses.d.ts.map +1 -0
  333. package/dist/commonjs/sdk/addresses.js +32 -0
  334. package/dist/commonjs/sdk/addresses.js.map +1 -0
  335. package/dist/commonjs/sdk/devices.d.ts +21 -6
  336. package/dist/commonjs/sdk/devices.d.ts.map +1 -1
  337. package/dist/commonjs/sdk/devices.js +26 -6
  338. package/dist/commonjs/sdk/devices.js.map +1 -1
  339. package/dist/commonjs/sdk/instances.d.ts +11 -3
  340. package/dist/commonjs/sdk/instances.d.ts.map +1 -1
  341. package/dist/commonjs/sdk/instances.js +12 -2
  342. package/dist/commonjs/sdk/instances.js.map +1 -1
  343. package/dist/commonjs/sdk/interactions.d.ts +14 -6
  344. package/dist/commonjs/sdk/interactions.d.ts.map +1 -1
  345. package/dist/commonjs/sdk/interactions.js +16 -6
  346. package/dist/commonjs/sdk/interactions.js.map +1 -1
  347. package/dist/commonjs/sdk/journeys.d.ts +45 -5
  348. package/dist/commonjs/sdk/journeys.d.ts.map +1 -1
  349. package/dist/commonjs/sdk/journeys.js +49 -4
  350. package/dist/commonjs/sdk/journeys.js.map +1 -1
  351. package/dist/commonjs/sdk/sdk.d.ts +14 -11
  352. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  353. package/dist/commonjs/sdk/sdk.js +17 -13
  354. package/dist/commonjs/sdk/sdk.js.map +1 -1
  355. package/dist/commonjs/sdk/tasks.d.ts +6 -23
  356. package/dist/commonjs/sdk/tasks.d.ts.map +1 -1
  357. package/dist/commonjs/sdk/tasks.js +3 -31
  358. package/dist/commonjs/sdk/tasks.js.map +1 -1
  359. package/dist/commonjs/sdk/test-scenarios.d.ts +41 -0
  360. package/dist/commonjs/sdk/test-scenarios.d.ts.map +1 -0
  361. package/dist/commonjs/sdk/test-scenarios.js +62 -0
  362. package/dist/commonjs/sdk/test-scenarios.js.map +1 -0
  363. package/dist/commonjs/types/discriminated-union.d.ts.map +1 -1
  364. package/dist/commonjs/types/discriminated-union.js +0 -4
  365. package/dist/commonjs/types/discriminated-union.js.map +1 -1
  366. package/dist/commonjs/types/index.d.ts +0 -2
  367. package/dist/commonjs/types/index.d.ts.map +1 -1
  368. package/dist/commonjs/types/index.js +0 -2
  369. package/dist/commonjs/types/index.js.map +1 -1
  370. package/dist/commonjs/types/smart-union.d.ts.map +1 -1
  371. package/dist/commonjs/types/smart-union.js +14 -14
  372. package/dist/commonjs/types/smart-union.js.map +1 -1
  373. package/dist/esm/funcs/addresses-retrieve.d.ts +19 -0
  374. package/dist/esm/funcs/addresses-retrieve.d.ts.map +1 -0
  375. package/dist/esm/funcs/{tasks-update.js → addresses-retrieve.js} +20 -9
  376. package/dist/esm/funcs/addresses-retrieve.js.map +1 -0
  377. package/dist/{commonjs/funcs/tasks-list-schema.d.ts → esm/funcs/addresses-search.d.ts} +6 -6
  378. package/dist/esm/funcs/addresses-search.d.ts.map +1 -0
  379. package/dist/esm/funcs/{tasks-list.js → addresses-search.js} +20 -9
  380. package/dist/esm/funcs/addresses-search.js.map +1 -0
  381. package/dist/esm/funcs/devices-add.d.ts +5 -3
  382. package/dist/esm/funcs/devices-add.d.ts.map +1 -1
  383. package/dist/esm/funcs/devices-add.js +8 -3
  384. package/dist/esm/funcs/devices-add.js.map +1 -1
  385. package/dist/esm/funcs/devices-connect.d.ts +5 -3
  386. package/dist/esm/funcs/devices-connect.d.ts.map +1 -1
  387. package/dist/esm/funcs/devices-connect.js +9 -5
  388. package/dist/esm/funcs/devices-connect.js.map +1 -1
  389. package/dist/{commonjs/funcs/tasks-update.d.ts → esm/funcs/devices-refresh.d.ts} +6 -5
  390. package/dist/esm/funcs/devices-refresh.d.ts.map +1 -0
  391. package/dist/esm/funcs/{health-get.js → devices-refresh.js} +15 -16
  392. package/dist/esm/funcs/devices-refresh.js.map +1 -0
  393. package/dist/{commonjs/funcs/tasks-list.d.ts → esm/funcs/devices-validate.d.ts} +6 -4
  394. package/dist/esm/funcs/devices-validate.d.ts.map +1 -0
  395. package/dist/esm/funcs/devices-validate.js +77 -0
  396. package/dist/esm/funcs/devices-validate.js.map +1 -0
  397. package/dist/esm/funcs/instances-delete.d.ts +5 -3
  398. package/dist/esm/funcs/instances-delete.d.ts.map +1 -1
  399. package/dist/esm/funcs/instances-delete.js +8 -3
  400. package/dist/esm/funcs/instances-delete.js.map +1 -1
  401. package/dist/esm/funcs/instances-handoff-token.d.ts +19 -0
  402. package/dist/esm/funcs/instances-handoff-token.d.ts.map +1 -0
  403. package/dist/esm/funcs/instances-handoff-token.js +94 -0
  404. package/dist/esm/funcs/instances-handoff-token.js.map +1 -0
  405. package/dist/esm/funcs/interactions-fetch.d.ts +4 -3
  406. package/dist/esm/funcs/interactions-fetch.d.ts.map +1 -1
  407. package/dist/esm/funcs/interactions-fetch.js +19 -7
  408. package/dist/esm/funcs/interactions-fetch.js.map +1 -1
  409. package/dist/esm/funcs/interactions-submit.d.ts +5 -3
  410. package/dist/esm/funcs/interactions-submit.d.ts.map +1 -1
  411. package/dist/esm/funcs/interactions-submit.js +14 -3
  412. package/dist/esm/funcs/interactions-submit.js.map +1 -1
  413. package/dist/esm/funcs/interactions-upload-asset.d.ts +18 -0
  414. package/dist/esm/funcs/interactions-upload-asset.d.ts.map +1 -0
  415. package/dist/esm/funcs/interactions-upload-asset.js +83 -0
  416. package/dist/esm/funcs/interactions-upload-asset.js.map +1 -0
  417. package/dist/esm/funcs/journeys-get-schemas.d.ts +46 -0
  418. package/dist/esm/funcs/journeys-get-schemas.d.ts.map +1 -0
  419. package/dist/esm/funcs/journeys-get-schemas.js +114 -0
  420. package/dist/esm/funcs/journeys-get-schemas.js.map +1 -0
  421. package/dist/esm/funcs/journeys-get-state.d.ts +4 -3
  422. package/dist/esm/funcs/journeys-get-state.d.ts.map +1 -1
  423. package/dist/esm/funcs/journeys-get-state.js +13 -7
  424. package/dist/esm/funcs/journeys-get-state.js.map +1 -1
  425. package/dist/esm/funcs/journeys-start.d.ts +5 -3
  426. package/dist/esm/funcs/journeys-start.d.ts.map +1 -1
  427. package/dist/esm/funcs/journeys-start.js +8 -3
  428. package/dist/esm/funcs/journeys-start.js.map +1 -1
  429. package/dist/esm/funcs/journeys-terminate.d.ts +21 -0
  430. package/dist/esm/funcs/journeys-terminate.d.ts.map +1 -0
  431. package/dist/esm/funcs/{tasks-list-schema.js → journeys-terminate.js} +13 -8
  432. package/dist/esm/funcs/journeys-terminate.js.map +1 -0
  433. package/dist/esm/funcs/tasks-get-schema.d.ts +8 -3
  434. package/dist/esm/funcs/tasks-get-schema.d.ts.map +1 -1
  435. package/dist/esm/funcs/tasks-get-schema.js +9 -3
  436. package/dist/esm/funcs/tasks-get-schema.js.map +1 -1
  437. package/dist/esm/funcs/test-scenarios-create.d.ts +21 -0
  438. package/dist/esm/funcs/test-scenarios-create.d.ts.map +1 -0
  439. package/dist/esm/funcs/test-scenarios-create.js +93 -0
  440. package/dist/esm/funcs/test-scenarios-create.js.map +1 -0
  441. package/dist/esm/funcs/test-scenarios-delete.d.ts +20 -0
  442. package/dist/esm/funcs/test-scenarios-delete.d.ts.map +1 -0
  443. package/dist/esm/funcs/test-scenarios-delete.js +95 -0
  444. package/dist/esm/funcs/test-scenarios-delete.js.map +1 -0
  445. package/dist/esm/funcs/test-scenarios-get.d.ts +21 -0
  446. package/dist/esm/funcs/test-scenarios-get.d.ts.map +1 -0
  447. package/dist/esm/funcs/test-scenarios-get.js +100 -0
  448. package/dist/esm/funcs/test-scenarios-get.js.map +1 -0
  449. package/dist/esm/funcs/test-scenarios-list.d.ts +21 -0
  450. package/dist/esm/funcs/test-scenarios-list.d.ts.map +1 -0
  451. package/dist/esm/funcs/test-scenarios-list.js +96 -0
  452. package/dist/esm/funcs/test-scenarios-list.js.map +1 -0
  453. package/dist/esm/funcs/test-scenarios-put.d.ts +21 -0
  454. package/dist/esm/funcs/test-scenarios-put.d.ts.map +1 -0
  455. package/dist/esm/funcs/test-scenarios-put.js +97 -0
  456. package/dist/esm/funcs/test-scenarios-put.js.map +1 -0
  457. package/dist/esm/funcs/tokens-generate.d.ts +2 -1
  458. package/dist/esm/funcs/tokens-generate.d.ts.map +1 -1
  459. package/dist/esm/funcs/tokens-generate.js +6 -2
  460. package/dist/esm/funcs/tokens-generate.js.map +1 -1
  461. package/dist/esm/lib/config.d.ts +4 -4
  462. package/dist/esm/lib/config.d.ts.map +1 -1
  463. package/dist/esm/lib/config.js +13 -4
  464. package/dist/esm/lib/config.js.map +1 -1
  465. package/dist/esm/models/create-test-scenario-request.d.ts +29 -0
  466. package/dist/esm/models/create-test-scenario-request.d.ts.map +1 -0
  467. package/dist/esm/models/create-test-scenario-request.js +18 -0
  468. package/dist/esm/models/create-test-scenario-request.js.map +1 -0
  469. package/dist/esm/models/delete-response.d.ts +19 -0
  470. package/dist/esm/models/delete-response.d.ts.map +1 -0
  471. package/dist/esm/models/delete-response.js +20 -0
  472. package/dist/esm/models/delete-response.js.map +1 -0
  473. package/dist/esm/models/device-connect-request.d.ts +29 -0
  474. package/dist/esm/models/device-connect-request.d.ts.map +1 -0
  475. package/dist/esm/models/device-connect-request.js +21 -0
  476. package/dist/esm/models/device-connect-request.js.map +1 -0
  477. package/dist/esm/models/device-connect-response.d.ts +25 -0
  478. package/dist/esm/models/device-connect-response.d.ts.map +1 -0
  479. package/dist/esm/models/device-connect-response.js +26 -0
  480. package/dist/esm/models/device-connect-response.js.map +1 -0
  481. package/dist/esm/models/device-refresh-response.d.ts +16 -0
  482. package/dist/esm/models/device-refresh-response.d.ts.map +1 -0
  483. package/dist/esm/models/device-refresh-response.js +19 -0
  484. package/dist/esm/models/device-refresh-response.js.map +1 -0
  485. package/dist/esm/models/device-start-response.d.ts +20 -0
  486. package/dist/esm/models/device-start-response.d.ts.map +1 -0
  487. package/dist/esm/models/device-start-response.js +21 -0
  488. package/dist/esm/models/device-start-response.js.map +1 -0
  489. package/dist/esm/models/device-validate-response.d.ts +14 -0
  490. package/dist/esm/models/device-validate-response.d.ts.map +1 -0
  491. package/dist/esm/models/device-validate-response.js +17 -0
  492. package/dist/esm/models/device-validate-response.js.map +1 -0
  493. package/dist/esm/models/errors/error-response.d.ts +19 -0
  494. package/dist/esm/models/errors/error-response.d.ts.map +1 -0
  495. package/dist/esm/models/errors/error-response.js +31 -0
  496. package/dist/esm/models/errors/error-response.js.map +1 -0
  497. package/dist/esm/models/errors/index.d.ts +2 -0
  498. package/dist/esm/models/errors/index.d.ts.map +1 -1
  499. package/dist/esm/models/errors/index.js +2 -0
  500. package/dist/esm/models/errors/index.js.map +1 -1
  501. package/dist/esm/models/errors/o-auth-error-response.d.ts +32 -0
  502. package/dist/esm/models/errors/o-auth-error-response.d.ts.map +1 -0
  503. package/dist/esm/models/errors/o-auth-error-response.js +38 -0
  504. package/dist/esm/models/errors/o-auth-error-response.js.map +1 -0
  505. package/dist/esm/models/gbg-error.d.ts +28 -0
  506. package/dist/esm/models/gbg-error.d.ts.map +1 -0
  507. package/dist/esm/models/gbg-error.js +31 -0
  508. package/dist/esm/models/gbg-error.js.map +1 -0
  509. package/dist/esm/models/handoff-token-response.d.ts +20 -0
  510. package/dist/esm/models/handoff-token-response.d.ts.map +1 -0
  511. package/dist/esm/models/handoff-token-response.js +22 -0
  512. package/dist/esm/models/handoff-token-response.js.map +1 -0
  513. package/dist/esm/models/index.d.ts +33 -0
  514. package/dist/esm/models/index.d.ts.map +1 -1
  515. package/dist/esm/models/index.js +33 -0
  516. package/dist/esm/models/index.js.map +1 -1
  517. package/dist/esm/models/interaction-fetch-response.d.ts +40 -0
  518. package/dist/esm/models/interaction-fetch-response.d.ts.map +1 -0
  519. package/dist/esm/models/interaction-fetch-response.js +39 -0
  520. package/dist/esm/models/interaction-fetch-response.js.map +1 -0
  521. package/dist/esm/models/interaction-submit-response.d.ts +17 -0
  522. package/dist/esm/models/interaction-submit-response.d.ts.map +1 -0
  523. package/dist/esm/models/interaction-submit-response.js +18 -0
  524. package/dist/esm/models/interaction-submit-response.js.map +1 -0
  525. package/dist/esm/models/journey-start-response.d.ts +34 -0
  526. package/dist/esm/models/journey-start-response.d.ts.map +1 -0
  527. package/dist/esm/models/journey-start-response.js +30 -0
  528. package/dist/esm/models/journey-start-response.js.map +1 -0
  529. package/dist/esm/models/loqate-retrieve-response.d.ts +12 -0
  530. package/dist/esm/models/loqate-retrieve-response.d.ts.map +1 -0
  531. package/dist/esm/models/loqate-retrieve-response.js +18 -0
  532. package/dist/esm/models/loqate-retrieve-response.js.map +1 -0
  533. package/dist/esm/models/loqate-search-response.d.ts +12 -0
  534. package/dist/esm/models/loqate-search-response.d.ts.map +1 -0
  535. package/dist/esm/models/loqate-search-response.js +18 -0
  536. package/dist/esm/models/loqate-search-response.js.map +1 -0
  537. package/dist/esm/models/operations/add-device.d.ts +8 -92
  538. package/dist/esm/models/operations/add-device.d.ts.map +1 -1
  539. package/dist/esm/models/operations/add-device.js +5 -72
  540. package/dist/esm/models/operations/add-device.js.map +1 -1
  541. package/dist/esm/models/operations/create-handoff-token.d.ts +22 -0
  542. package/dist/esm/models/operations/create-handoff-token.d.ts.map +1 -0
  543. package/dist/esm/models/operations/create-handoff-token.js +24 -0
  544. package/dist/esm/models/operations/create-handoff-token.js.map +1 -0
  545. package/dist/esm/models/operations/create-test-scenario.d.ts +18 -0
  546. package/dist/esm/models/operations/create-test-scenario.d.ts.map +1 -0
  547. package/dist/esm/models/operations/create-test-scenario.js +14 -0
  548. package/dist/esm/models/operations/create-test-scenario.js.map +1 -0
  549. package/dist/esm/models/operations/delete-instance.d.ts +1 -14
  550. package/dist/esm/models/operations/delete-instance.d.ts.map +1 -1
  551. package/dist/esm/models/operations/delete-instance.js +2 -11
  552. package/dist/esm/models/operations/delete-instance.js.map +1 -1
  553. package/dist/esm/models/operations/delete-test-scenario.d.ts +20 -0
  554. package/dist/esm/models/operations/delete-test-scenario.d.ts.map +1 -0
  555. package/dist/esm/models/operations/delete-test-scenario.js +13 -0
  556. package/dist/esm/models/operations/delete-test-scenario.js.map +1 -0
  557. package/dist/esm/models/operations/device-connect.d.ts +0 -91
  558. package/dist/esm/models/operations/device-connect.d.ts.map +1 -1
  559. package/dist/esm/models/operations/device-connect.js +0 -63
  560. package/dist/esm/models/operations/device-connect.js.map +1 -1
  561. package/dist/esm/models/operations/device-validate.d.ts +12 -0
  562. package/dist/esm/models/operations/device-validate.d.ts.map +1 -0
  563. package/dist/esm/models/operations/device-validate.js +17 -0
  564. package/dist/esm/models/operations/device-validate.js.map +1 -0
  565. package/dist/esm/models/operations/fetch-interaction.d.ts +35 -1621
  566. package/dist/esm/models/operations/fetch-interaction.d.ts.map +1 -1
  567. package/dist/esm/models/operations/fetch-interaction.js +22 -1247
  568. package/dist/esm/models/operations/fetch-interaction.js.map +1 -1
  569. package/dist/esm/models/operations/get-journey-schemas.d.ts +16 -0
  570. package/dist/esm/models/operations/get-journey-schemas.d.ts.map +1 -0
  571. package/dist/esm/models/operations/get-journey-schemas.js +14 -0
  572. package/dist/esm/models/operations/get-journey-schemas.js.map +1 -0
  573. package/dist/esm/models/operations/get-journey-state.d.ts +19 -1383
  574. package/dist/esm/models/operations/get-journey-state.d.ts.map +1 -1
  575. package/dist/esm/models/operations/get-journey-state.js +13 -997
  576. package/dist/esm/models/operations/get-journey-state.js.map +1 -1
  577. package/dist/esm/models/operations/get-task-schema.d.ts +1 -17
  578. package/dist/esm/models/operations/get-task-schema.d.ts.map +1 -1
  579. package/dist/esm/models/operations/get-task-schema.js +0 -17
  580. package/dist/esm/models/operations/get-task-schema.js.map +1 -1
  581. package/dist/esm/models/operations/get-test-scenario.d.ts +39 -0
  582. package/dist/esm/models/operations/get-test-scenario.d.ts.map +1 -0
  583. package/dist/esm/models/operations/get-test-scenario.js +23 -0
  584. package/dist/esm/models/operations/get-test-scenario.js.map +1 -0
  585. package/dist/esm/models/operations/index.d.ts +12 -4
  586. package/dist/esm/models/operations/index.d.ts.map +1 -1
  587. package/dist/esm/models/operations/index.js +12 -4
  588. package/dist/esm/models/operations/index.js.map +1 -1
  589. package/dist/esm/models/operations/list-test-scenarios.d.ts +34 -0
  590. package/dist/esm/models/operations/list-test-scenarios.d.ts.map +1 -0
  591. package/dist/esm/models/operations/list-test-scenarios.js +22 -0
  592. package/dist/esm/models/operations/list-test-scenarios.js.map +1 -0
  593. package/dist/esm/models/operations/post-as-token-oauth2.d.ts +2 -2
  594. package/dist/esm/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  595. package/dist/esm/models/operations/post-as-token-oauth2.js +4 -5
  596. package/dist/esm/models/operations/post-as-token-oauth2.js.map +1 -1
  597. package/dist/esm/models/operations/put-test-scenario.d.ts +23 -0
  598. package/dist/esm/models/operations/put-test-scenario.d.ts.map +1 -0
  599. package/dist/esm/models/operations/put-test-scenario.js +15 -0
  600. package/dist/esm/models/operations/put-test-scenario.js.map +1 -0
  601. package/dist/esm/models/operations/retrieve-address.d.ts +29 -0
  602. package/dist/esm/models/operations/retrieve-address.d.ts.map +1 -0
  603. package/dist/esm/models/operations/retrieve-address.js +27 -0
  604. package/dist/esm/models/operations/retrieve-address.js.map +1 -0
  605. package/dist/esm/models/operations/search-addresses.d.ts +33 -0
  606. package/dist/esm/models/operations/search-addresses.d.ts.map +1 -0
  607. package/dist/esm/models/operations/search-addresses.js +29 -0
  608. package/dist/esm/models/operations/search-addresses.js.map +1 -0
  609. package/dist/esm/models/operations/start-journey.d.ts +1214 -112
  610. package/dist/esm/models/operations/start-journey.d.ts.map +1 -1
  611. package/dist/esm/models/operations/start-journey.js +565 -58
  612. package/dist/esm/models/operations/start-journey.js.map +1 -1
  613. package/dist/esm/models/operations/submit-interaction.d.ts +1074 -92
  614. package/dist/esm/models/operations/submit-interaction.d.ts.map +1 -1
  615. package/dist/esm/models/operations/submit-interaction.js +505 -45
  616. package/dist/esm/models/operations/submit-interaction.js.map +1 -1
  617. package/dist/esm/models/operations/terminate-journey.d.ts +19 -0
  618. package/dist/esm/models/operations/terminate-journey.d.ts.map +1 -0
  619. package/dist/esm/models/operations/terminate-journey.js +13 -0
  620. package/dist/esm/models/operations/terminate-journey.js.map +1 -0
  621. package/dist/esm/models/operations/upload-interaction-asset.d.ts +26 -0
  622. package/dist/esm/models/operations/upload-interaction-asset.d.ts.map +1 -0
  623. package/dist/esm/models/operations/upload-interaction-asset.js +28 -0
  624. package/dist/esm/models/operations/upload-interaction-asset.js.map +1 -0
  625. package/dist/esm/models/outstanding-group.d.ts +15 -0
  626. package/dist/esm/models/outstanding-group.d.ts.map +1 -0
  627. package/dist/esm/models/outstanding-group.js +15 -0
  628. package/dist/esm/models/outstanding-group.js.map +1 -0
  629. package/dist/esm/models/schema-fetch-response.d.ts +22 -0
  630. package/dist/esm/models/schema-fetch-response.d.ts.map +1 -0
  631. package/dist/esm/models/schema-fetch-response.js +24 -0
  632. package/dist/esm/models/schema-fetch-response.js.map +1 -0
  633. package/dist/esm/models/slim-document.d.ts +57 -0
  634. package/dist/esm/models/slim-document.d.ts.map +1 -0
  635. package/dist/esm/models/slim-document.js +53 -0
  636. package/dist/esm/models/slim-document.js.map +1 -0
  637. package/dist/esm/models/slim-extraction.d.ts +74 -0
  638. package/dist/esm/models/slim-extraction.d.ts.map +1 -0
  639. package/dist/esm/models/slim-extraction.js +84 -0
  640. package/dist/esm/models/slim-extraction.js.map +1 -0
  641. package/dist/esm/models/slim-identity.d.ts +202 -0
  642. package/dist/esm/models/slim-identity.d.ts.map +1 -0
  643. package/dist/esm/models/slim-identity.js +100 -0
  644. package/dist/esm/models/slim-identity.js.map +1 -0
  645. package/dist/esm/models/slim-interaction-fetch-response.d.ts +46 -0
  646. package/dist/esm/models/slim-interaction-fetch-response.d.ts.map +1 -0
  647. package/dist/esm/models/slim-interaction-fetch-response.js +48 -0
  648. package/dist/esm/models/slim-interaction-fetch-response.js.map +1 -0
  649. package/dist/esm/models/slim-journey.d.ts +14 -0
  650. package/dist/esm/models/slim-journey.d.ts.map +1 -0
  651. package/dist/esm/models/slim-journey.js +18 -0
  652. package/dist/esm/models/slim-journey.js.map +1 -0
  653. package/dist/esm/models/slim-module-step-error.d.ts +50 -0
  654. package/dist/esm/models/slim-module-step-error.d.ts.map +1 -0
  655. package/dist/esm/models/slim-module-step-error.js +41 -0
  656. package/dist/esm/models/slim-module-step-error.js.map +1 -0
  657. package/dist/esm/models/slim-result.d.ts +49 -0
  658. package/dist/esm/models/slim-result.d.ts.map +1 -0
  659. package/dist/esm/models/slim-result.js +39 -0
  660. package/dist/esm/models/slim-result.js.map +1 -0
  661. package/dist/esm/models/slim-state-fetch-response.d.ts +27 -0
  662. package/dist/esm/models/slim-state-fetch-response.d.ts.map +1 -0
  663. package/dist/esm/models/slim-state-fetch-response.js +29 -0
  664. package/dist/esm/models/slim-state-fetch-response.js.map +1 -0
  665. package/dist/esm/models/slim-step.d.ts +40 -0
  666. package/dist/esm/models/slim-step.d.ts.map +1 -0
  667. package/dist/esm/models/slim-step.js +36 -0
  668. package/dist/esm/models/slim-step.js.map +1 -0
  669. package/dist/esm/models/slim-validation.d.ts +69 -0
  670. package/dist/esm/models/slim-validation.d.ts.map +1 -0
  671. package/dist/esm/models/slim-validation.js +78 -0
  672. package/dist/esm/models/slim-validation.js.map +1 -0
  673. package/dist/esm/models/slim-verified-data.d.ts +16 -0
  674. package/dist/esm/models/slim-verified-data.d.ts.map +1 -0
  675. package/dist/esm/models/slim-verified-data.js +16 -0
  676. package/dist/esm/models/slim-verified-data.js.map +1 -0
  677. package/dist/esm/models/state-fetch-response.d.ts +25 -0
  678. package/dist/esm/models/state-fetch-response.d.ts.map +1 -0
  679. package/dist/esm/models/state-fetch-response.js +22 -0
  680. package/dist/esm/models/state-fetch-response.js.map +1 -0
  681. package/dist/esm/models/terminate-response.d.ts +10 -0
  682. package/dist/esm/models/terminate-response.d.ts.map +1 -0
  683. package/dist/esm/models/terminate-response.js +13 -0
  684. package/dist/esm/models/terminate-response.js.map +1 -0
  685. package/dist/esm/models/test-scenario-summary.d.ts +29 -0
  686. package/dist/esm/models/test-scenario-summary.d.ts.map +1 -0
  687. package/dist/esm/models/test-scenario-summary.js +25 -0
  688. package/dist/esm/models/test-scenario-summary.js.map +1 -0
  689. package/dist/esm/models/test-scenario-written.d.ts +19 -0
  690. package/dist/esm/models/test-scenario-written.d.ts.map +1 -0
  691. package/dist/esm/models/test-scenario-written.js +20 -0
  692. package/dist/esm/models/test-scenario-written.js.map +1 -0
  693. package/dist/esm/models/test-scenario.d.ts +31 -0
  694. package/dist/esm/models/test-scenario.d.ts.map +1 -0
  695. package/dist/esm/models/test-scenario.js +25 -0
  696. package/dist/esm/models/test-scenario.js.map +1 -0
  697. package/dist/esm/models/update-test-scenario-request.d.ts +24 -0
  698. package/dist/esm/models/update-test-scenario-request.d.ts.map +1 -0
  699. package/dist/esm/models/update-test-scenario-request.js +17 -0
  700. package/dist/esm/models/update-test-scenario-request.js.map +1 -0
  701. package/dist/esm/sdk/addresses.d.ts +20 -0
  702. package/dist/esm/sdk/addresses.d.ts.map +1 -0
  703. package/dist/esm/sdk/addresses.js +28 -0
  704. package/dist/esm/sdk/addresses.js.map +1 -0
  705. package/dist/esm/sdk/devices.d.ts +21 -6
  706. package/dist/esm/sdk/devices.d.ts.map +1 -1
  707. package/dist/esm/sdk/devices.js +26 -6
  708. package/dist/esm/sdk/devices.js.map +1 -1
  709. package/dist/esm/sdk/instances.d.ts +11 -3
  710. package/dist/esm/sdk/instances.d.ts.map +1 -1
  711. package/dist/esm/sdk/instances.js +12 -2
  712. package/dist/esm/sdk/instances.js.map +1 -1
  713. package/dist/esm/sdk/interactions.d.ts +14 -6
  714. package/dist/esm/sdk/interactions.d.ts.map +1 -1
  715. package/dist/esm/sdk/interactions.js +16 -6
  716. package/dist/esm/sdk/interactions.js.map +1 -1
  717. package/dist/esm/sdk/journeys.d.ts +45 -5
  718. package/dist/esm/sdk/journeys.d.ts.map +1 -1
  719. package/dist/esm/sdk/journeys.js +49 -4
  720. package/dist/esm/sdk/journeys.js.map +1 -1
  721. package/dist/esm/sdk/sdk.d.ts +14 -11
  722. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  723. package/dist/esm/sdk/sdk.js +17 -13
  724. package/dist/esm/sdk/sdk.js.map +1 -1
  725. package/dist/esm/sdk/tasks.d.ts +6 -23
  726. package/dist/esm/sdk/tasks.d.ts.map +1 -1
  727. package/dist/esm/sdk/tasks.js +3 -31
  728. package/dist/esm/sdk/tasks.js.map +1 -1
  729. package/dist/esm/sdk/test-scenarios.d.ts +41 -0
  730. package/dist/esm/sdk/test-scenarios.d.ts.map +1 -0
  731. package/dist/esm/sdk/test-scenarios.js +58 -0
  732. package/dist/esm/sdk/test-scenarios.js.map +1 -0
  733. package/dist/esm/types/discriminated-union.d.ts.map +1 -1
  734. package/dist/esm/types/discriminated-union.js +0 -4
  735. package/dist/esm/types/discriminated-union.js.map +1 -1
  736. package/dist/esm/types/index.d.ts +0 -2
  737. package/dist/esm/types/index.d.ts.map +1 -1
  738. package/dist/esm/types/index.js +0 -2
  739. package/dist/esm/types/index.js.map +1 -1
  740. package/dist/esm/types/smart-union.d.ts.map +1 -1
  741. package/dist/esm/types/smart-union.js +14 -14
  742. package/dist/esm/types/smart-union.js.map +1 -1
  743. package/examples/{tokensGenerate.example.ts → journeysStart.example.ts} +5 -3
  744. package/jsr.json +1 -1
  745. package/package.json +1 -1
  746. package/src/funcs/{tasks-update.ts → addresses-retrieve.ts} +39 -18
  747. package/src/funcs/addresses-search.ts +196 -0
  748. package/src/funcs/devices-add.ts +20 -10
  749. package/src/funcs/devices-connect.ts +23 -16
  750. package/src/funcs/{health-get.ts → devices-refresh.ts} +26 -22
  751. package/src/funcs/{tasks-list.ts → devices-validate.ts} +26 -37
  752. package/src/funcs/instances-delete.ts +20 -9
  753. package/src/funcs/instances-handoff-token.ts +191 -0
  754. package/src/funcs/interactions-fetch.ts +29 -9
  755. package/src/funcs/interactions-submit.ts +27 -9
  756. package/src/funcs/interactions-upload-asset.ts +173 -0
  757. package/src/funcs/journeys-get-schemas.ts +207 -0
  758. package/src/funcs/journeys-get-state.ts +22 -9
  759. package/src/funcs/journeys-start.ts +23 -10
  760. package/src/funcs/{tasks-list-schema.ts → journeys-terminate.ts} +26 -15
  761. package/src/funcs/tasks-get-schema.ts +21 -9
  762. package/src/funcs/test-scenarios-create.ts +183 -0
  763. package/src/funcs/test-scenarios-delete.ts +187 -0
  764. package/src/funcs/test-scenarios-get.ts +192 -0
  765. package/src/funcs/test-scenarios-list.ts +187 -0
  766. package/src/funcs/test-scenarios-put.ts +188 -0
  767. package/src/funcs/tokens-generate.ts +12 -3
  768. package/src/lib/config.ts +13 -4
  769. package/src/models/create-test-scenario-request.ts +63 -0
  770. package/src/models/delete-response.ts +45 -0
  771. package/src/models/device-connect-request.ts +60 -0
  772. package/src/models/device-connect-response.ts +59 -0
  773. package/src/models/device-refresh-response.ts +42 -0
  774. package/src/models/device-start-response.ts +49 -0
  775. package/src/models/device-validate-response.ts +38 -0
  776. package/src/models/errors/error-response.ts +52 -0
  777. package/src/models/errors/index.ts +2 -0
  778. package/src/models/errors/o-auth-error-response.ts +74 -0
  779. package/src/models/gbg-error.ts +56 -0
  780. package/src/models/handoff-token-response.ts +48 -0
  781. package/src/models/index.ts +33 -0
  782. package/src/models/interaction-fetch-response.ts +103 -0
  783. package/src/models/interaction-submit-response.ts +43 -0
  784. package/src/models/journey-start-response.ts +71 -0
  785. package/src/models/loqate-retrieve-response.ts +38 -0
  786. package/src/models/loqate-search-response.ts +38 -0
  787. package/src/models/operations/add-device.ts +17 -176
  788. package/src/models/operations/create-handoff-token.ts +63 -0
  789. package/src/models/operations/create-test-scenario.ts +37 -0
  790. package/src/models/operations/delete-instance.ts +7 -38
  791. package/src/models/operations/delete-test-scenario.ts +39 -0
  792. package/src/models/operations/device-connect.ts +0 -189
  793. package/src/models/operations/device-validate.ts +38 -0
  794. package/src/models/operations/fetch-interaction.ts +100 -3798
  795. package/src/models/operations/get-journey-schemas.ts +36 -0
  796. package/src/models/operations/get-journey-state.ts +62 -3183
  797. package/src/models/operations/get-task-schema.ts +1 -44
  798. package/src/models/operations/get-test-scenario.ts +65 -0
  799. package/src/models/operations/index.ts +12 -4
  800. package/src/models/operations/list-test-scenarios.ts +59 -0
  801. package/src/models/operations/post-as-token-oauth2.ts +8 -9
  802. package/src/models/operations/put-test-scenario.ts +43 -0
  803. package/src/models/operations/retrieve-address.ts +73 -0
  804. package/src/models/operations/search-addresses.ts +79 -0
  805. package/src/models/operations/start-journey.ts +2838 -1025
  806. package/src/models/operations/submit-interaction.ts +2787 -1092
  807. package/src/models/operations/terminate-journey.ts +41 -0
  808. package/src/models/operations/upload-interaction-asset.ts +74 -0
  809. package/src/models/outstanding-group.ts +37 -0
  810. package/src/models/schema-fetch-response.ts +57 -0
  811. package/src/models/slim-document.ts +134 -0
  812. package/src/models/slim-extraction.ts +235 -0
  813. package/src/models/slim-identity.ts +347 -0
  814. package/src/models/slim-interaction-fetch-response.ts +124 -0
  815. package/src/models/slim-journey.ts +36 -0
  816. package/src/models/slim-module-step-error.ts +99 -0
  817. package/src/models/slim-result.ts +92 -0
  818. package/src/models/slim-state-fetch-response.ts +60 -0
  819. package/src/models/slim-step.ts +80 -0
  820. package/src/models/slim-validation.ts +229 -0
  821. package/src/models/slim-verified-data.ts +37 -0
  822. package/src/models/state-fetch-response.ts +49 -0
  823. package/src/models/terminate-response.ts +30 -0
  824. package/src/models/test-scenario-summary.ts +62 -0
  825. package/src/models/test-scenario-written.ts +47 -0
  826. package/src/models/test-scenario.ts +60 -0
  827. package/src/models/update-test-scenario-request.ts +57 -0
  828. package/src/sdk/addresses.ts +50 -0
  829. package/src/sdk/devices.ts +46 -11
  830. package/src/sdk/instances.ts +24 -3
  831. package/src/sdk/interactions.ts +30 -11
  832. package/src/sdk/journeys.ts +67 -5
  833. package/src/sdk/sdk.ts +25 -19
  834. package/src/sdk/tasks.ts +4 -60
  835. package/src/sdk/test-scenarios.ts +100 -0
  836. package/src/types/discriminated-union.ts +1 -4
  837. package/src/types/index.ts +0 -2
  838. package/src/types/smart-union.ts +19 -14
  839. package/dist/commonjs/funcs/health-get.d.ts.map +0 -1
  840. package/dist/commonjs/funcs/health-get.js.map +0 -1
  841. package/dist/commonjs/funcs/tasks-list-schema.d.ts.map +0 -1
  842. package/dist/commonjs/funcs/tasks-list-schema.js.map +0 -1
  843. package/dist/commonjs/funcs/tasks-list.d.ts.map +0 -1
  844. package/dist/commonjs/funcs/tasks-list.js.map +0 -1
  845. package/dist/commonjs/funcs/tasks-update.d.ts.map +0 -1
  846. package/dist/commonjs/funcs/tasks-update.js.map +0 -1
  847. package/dist/commonjs/models/operations/get-tasks-schema.d.ts +0 -71
  848. package/dist/commonjs/models/operations/get-tasks-schema.d.ts.map +0 -1
  849. package/dist/commonjs/models/operations/get-tasks-schema.js +0 -108
  850. package/dist/commonjs/models/operations/get-tasks-schema.js.map +0 -1
  851. package/dist/commonjs/models/operations/get-tasks.d.ts +0 -62
  852. package/dist/commonjs/models/operations/get-tasks.d.ts.map +0 -1
  853. package/dist/commonjs/models/operations/get-tasks.js +0 -91
  854. package/dist/commonjs/models/operations/get-tasks.js.map +0 -1
  855. package/dist/commonjs/models/operations/health.d.ts +0 -14
  856. package/dist/commonjs/models/operations/health.d.ts.map +0 -1
  857. package/dist/commonjs/models/operations/health.js.map +0 -1
  858. package/dist/commonjs/models/operations/update-task.d.ts +0 -2105
  859. package/dist/commonjs/models/operations/update-task.d.ts.map +0 -1
  860. package/dist/commonjs/models/operations/update-task.js +0 -1115
  861. package/dist/commonjs/models/operations/update-task.js.map +0 -1
  862. package/dist/commonjs/sdk/health.d.ts +0 -12
  863. package/dist/commonjs/sdk/health.d.ts.map +0 -1
  864. package/dist/commonjs/sdk/health.js +0 -22
  865. package/dist/commonjs/sdk/health.js.map +0 -1
  866. package/dist/commonjs/types/default-to-zero-value.d.ts +0 -12
  867. package/dist/commonjs/types/default-to-zero-value.d.ts.map +0 -1
  868. package/dist/commonjs/types/default-to-zero-value.js +0 -35
  869. package/dist/commonjs/types/default-to-zero-value.js.map +0 -1
  870. package/dist/commonjs/types/primitives.d.ts +0 -9
  871. package/dist/commonjs/types/primitives.d.ts.map +0 -1
  872. package/dist/commonjs/types/primitives.js +0 -151
  873. package/dist/commonjs/types/primitives.js.map +0 -1
  874. package/dist/esm/funcs/health-get.d.ts.map +0 -1
  875. package/dist/esm/funcs/health-get.js.map +0 -1
  876. package/dist/esm/funcs/tasks-list-schema.d.ts.map +0 -1
  877. package/dist/esm/funcs/tasks-list-schema.js.map +0 -1
  878. package/dist/esm/funcs/tasks-list.d.ts +0 -17
  879. package/dist/esm/funcs/tasks-list.d.ts.map +0 -1
  880. package/dist/esm/funcs/tasks-list.js.map +0 -1
  881. package/dist/esm/funcs/tasks-update.d.ts +0 -17
  882. package/dist/esm/funcs/tasks-update.d.ts.map +0 -1
  883. package/dist/esm/funcs/tasks-update.js.map +0 -1
  884. package/dist/esm/models/operations/get-tasks-schema.d.ts +0 -71
  885. package/dist/esm/models/operations/get-tasks-schema.d.ts.map +0 -1
  886. package/dist/esm/models/operations/get-tasks-schema.js +0 -67
  887. package/dist/esm/models/operations/get-tasks-schema.js.map +0 -1
  888. package/dist/esm/models/operations/get-tasks.d.ts +0 -62
  889. package/dist/esm/models/operations/get-tasks.d.ts.map +0 -1
  890. package/dist/esm/models/operations/get-tasks.js +0 -51
  891. package/dist/esm/models/operations/get-tasks.js.map +0 -1
  892. package/dist/esm/models/operations/health.d.ts +0 -14
  893. package/dist/esm/models/operations/health.d.ts.map +0 -1
  894. package/dist/esm/models/operations/health.js +0 -14
  895. package/dist/esm/models/operations/health.js.map +0 -1
  896. package/dist/esm/models/operations/update-task.d.ts +0 -2105
  897. package/dist/esm/models/operations/update-task.d.ts.map +0 -1
  898. package/dist/esm/models/operations/update-task.js +0 -1007
  899. package/dist/esm/models/operations/update-task.js.map +0 -1
  900. package/dist/esm/sdk/health.d.ts +0 -12
  901. package/dist/esm/sdk/health.d.ts.map +0 -1
  902. package/dist/esm/sdk/health.js +0 -18
  903. package/dist/esm/sdk/health.js.map +0 -1
  904. package/dist/esm/types/default-to-zero-value.d.ts +0 -12
  905. package/dist/esm/types/default-to-zero-value.d.ts.map +0 -1
  906. package/dist/esm/types/default-to-zero-value.js +0 -31
  907. package/dist/esm/types/default-to-zero-value.js.map +0 -1
  908. package/dist/esm/types/primitives.d.ts +0 -9
  909. package/dist/esm/types/primitives.d.ts.map +0 -1
  910. package/dist/esm/types/primitives.js +0 -109
  911. package/dist/esm/types/primitives.js.map +0 -1
  912. package/src/models/operations/get-tasks-schema.ts +0 -173
  913. package/src/models/operations/get-tasks.ts +0 -144
  914. package/src/models/operations/health.ts +0 -38
  915. package/src/models/operations/update-task.ts +0 -3818
  916. package/src/sdk/health.ts +0 -25
  917. package/src/types/default-to-zero-value.ts +0 -33
  918. package/src/types/primitives.ts +0 -140
@@ -1,24 +1,5 @@
1
1
  import * as z from "zod/v4-mini";
2
2
  import { ClosedEnum } from "../../types/enums.js";
3
- import { Result as SafeParseResult } from "../../types/fp.js";
4
- import { SDKValidationError } from "../errors/sdk-validation-error.js";
5
- /**
6
- * The method by which the End User will consume the journey.
7
- */
8
- export declare const Delivery: {
9
- readonly Page: "page";
10
- readonly Api: "api";
11
- };
12
- /**
13
- * The method by which the End User will consume the journey.
14
- */
15
- export type Delivery = ClosedEnum<typeof Delivery>;
16
- export type Config = {
17
- /**
18
- * The method by which the End User will consume the journey.
19
- */
20
- delivery: Delivery;
21
- };
22
3
  export type StartJourneyIdentityAlias = {
23
4
  /**
24
5
  * Title of an individual such as Mr, Mrs, Dr, Sir
@@ -40,10 +21,15 @@ export type StartJourneyIdentityAlias = {
40
21
  * Any family names for the individual
41
22
  */
42
23
  lastNamesAtBirth?: Array<string> | undefined;
24
+ /**
25
+ * The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
26
+ */
27
+ fullName?: string | undefined;
43
28
  };
44
29
  export declare const StartJourneyIdentityRelationship: {
45
30
  readonly Mother: "mother";
46
31
  readonly Father: "father";
32
+ readonly Spouse: "spouse";
47
33
  readonly MaternalGrandFather: "maternalGrandFather";
48
34
  readonly MaternalGrandMother: "maternalGrandMother";
49
35
  readonly PaternalGrandFather: "paternalGrandFather";
@@ -92,15 +78,15 @@ export type StartJourneyIdentityCurrentAddress = {
92
78
  */
93
79
  addressString?: string | undefined;
94
80
  /**
95
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
81
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
96
82
  */
97
83
  premise?: string | undefined;
98
84
  /**
99
- * The name of a building or a building complex. In the US, this is the street number.
85
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
100
86
  */
101
87
  building?: string | undefined;
102
88
  /**
103
- * The name of a sub-building, such as a flat or apartment number.
89
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
104
90
  */
105
91
  subBuilding?: string | undefined;
106
92
  /**
@@ -160,15 +146,15 @@ export type StartJourneyIdentityPreviousAddress = {
160
146
  */
161
147
  addressString?: string | undefined;
162
148
  /**
163
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
149
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
164
150
  */
165
151
  premise?: string | undefined;
166
152
  /**
167
- * The name of a building or a building complex. In the US, this is the street number.
153
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
168
154
  */
169
155
  building?: string | undefined;
170
156
  /**
171
- * The name of a sub-building, such as a flat or apartment number.
157
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
172
158
  */
173
159
  subBuilding?: string | undefined;
174
160
  /**
@@ -211,11 +197,11 @@ export type StartJourneyIdentityPreviousAddress = {
211
197
  /**
212
198
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
213
199
  */
214
- fromDate: string;
200
+ fromDate?: string | undefined;
215
201
  /**
216
202
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
217
203
  */
218
- toDate: string;
204
+ toDate?: string | undefined;
219
205
  };
220
206
  export type StartJourneyIdentityPlaceOfBirthLocation = {
221
207
  latitude?: string | undefined;
@@ -236,15 +222,15 @@ export type StartJourneyIdentityPlaceOfBirth = {
236
222
  */
237
223
  addressString?: string | undefined;
238
224
  /**
239
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
225
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
240
226
  */
241
227
  premise?: string | undefined;
242
228
  /**
243
- * The name of a building or a building complex. In the US, this is the street number.
229
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
244
230
  */
245
231
  building?: string | undefined;
246
232
  /**
247
- * The name of a sub-building, such as a flat or apartment number.
233
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
248
234
  */
249
235
  subBuilding?: string | undefined;
250
236
  /**
@@ -311,7 +297,7 @@ export type StartJourneyIdentityPhone = {
311
297
  };
312
298
  export type StartJourneyIdentityEmail = {
313
299
  /**
314
- * The type of email, such as home, work, unknown etc
300
+ * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
315
301
  */
316
302
  type: string;
317
303
  /**
@@ -350,6 +336,9 @@ export type StartJourneyIdentity = {
350
336
  * Any family names for the individual
351
337
  */
352
338
  lastNamesAtBirth?: Array<string> | undefined;
339
+ /**
340
+ * Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
341
+ */
353
342
  aliases?: Array<StartJourneyIdentityAlias> | undefined;
354
343
  relatedPersons?: Array<StartJourneyIdentityRelatedPerson> | undefined;
355
344
  /**
@@ -368,8 +357,441 @@ export type StartJourneyIdentity = {
368
357
  * The subject's mother's maiden name, used for identity verification
369
358
  */
370
359
  mothersMaidenName?: string | undefined;
360
+ /**
361
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
362
+ */
363
+ nationality?: string | undefined;
364
+ };
365
+ export declare const StartJourneyTypePrimary1: {
366
+ readonly Primary: "primary";
367
+ };
368
+ export type StartJourneyTypePrimary1 = ClosedEnum<typeof StartJourneyTypePrimary1>;
369
+ export declare const StartJourneyStatus: {
370
+ readonly Active: "active";
371
+ readonly Suspended: "suspended";
372
+ readonly Dormant: "dormant";
373
+ readonly Dissolved: "dissolved";
374
+ readonly StruckOff: "struckOff";
375
+ readonly Unknown: "unknown";
376
+ };
377
+ export type StartJourneyStatus = ClosedEnum<typeof StartJourneyStatus>;
378
+ export type StartJourneyAddressLocation = {
379
+ latitude?: string | undefined;
380
+ longitude?: string | undefined;
381
+ geoAccuracy?: string | undefined;
382
+ /**
383
+ * A What3words designation associated with this location with '.' separator.
384
+ */
385
+ what3words?: string | undefined;
386
+ };
387
+ export declare const StartJourneyPurpose: {
388
+ readonly Registered: "registered";
389
+ readonly Mailing: "mailing";
390
+ readonly Site: "site";
391
+ readonly Agent: "agent";
392
+ readonly Headquarters: "headquarters";
393
+ };
394
+ export type StartJourneyPurpose = ClosedEnum<typeof StartJourneyPurpose>;
395
+ export type StartJourneyAddressPrimary = {
396
+ /**
397
+ * Unformatted line based address
398
+ */
399
+ lines?: Array<string> | undefined;
400
+ /**
401
+ * The address as a single line
402
+ */
403
+ addressString?: string | undefined;
404
+ /**
405
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
406
+ */
407
+ premise?: string | undefined;
408
+ /**
409
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
410
+ */
411
+ building?: string | undefined;
412
+ /**
413
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
414
+ */
415
+ subBuilding?: string | undefined;
416
+ /**
417
+ * This field holds the most common street or block data element within a country. For instance, USA Street
418
+ */
419
+ thoroughfare?: string | undefined;
420
+ /**
421
+ * The name of a dependent street or block, such as a street within a complex.
422
+ */
423
+ dependentThoroughfare?: string | undefined;
424
+ /**
425
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
426
+ */
427
+ locality?: string | undefined;
428
+ /**
429
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
430
+ */
431
+ dependentLocality?: string | undefined;
432
+ /**
433
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
434
+ */
435
+ doubleDependentLocality?: string | undefined;
436
+ /**
437
+ * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
438
+ */
439
+ postalCode?: string | undefined;
440
+ /**
441
+ * This field contains the post box number associated with a particular delivery point, should one exist.
442
+ */
443
+ postBox?: string | undefined;
444
+ /**
445
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
446
+ */
447
+ country?: string | undefined;
448
+ superAdministrativeArea?: string | undefined;
449
+ administrativeArea?: string | undefined;
450
+ subAdministrativeArea?: string | undefined;
451
+ organization?: string | undefined;
452
+ location?: StartJourneyAddressLocation | undefined;
453
+ purpose?: StartJourneyPurpose | undefined;
454
+ };
455
+ export declare const StartJourneyTaxIdentifierType: {
456
+ readonly Tin: "TIN";
457
+ readonly Ein: "EIN";
371
458
  };
372
- export type StartJourneyAddress = {
459
+ export type StartJourneyTaxIdentifierType = ClosedEnum<typeof StartJourneyTaxIdentifierType>;
460
+ export type StartJourneyTaxIdentifier = {
461
+ type: StartJourneyTaxIdentifierType;
462
+ value: string;
463
+ /**
464
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
465
+ */
466
+ country?: string | undefined;
467
+ };
468
+ export declare const StartJourneySystem: {
469
+ readonly Naics2017: "naics2017";
470
+ readonly Naics2022: "naics2022";
471
+ readonly Sic: "sic";
472
+ readonly Mcc: "mcc";
473
+ };
474
+ export type StartJourneySystem = ClosedEnum<typeof StartJourneySystem>;
475
+ export type StartJourneyIndustryClassification = {
476
+ system: StartJourneySystem;
477
+ code: string;
478
+ description?: string | undefined;
479
+ };
480
+ export declare const StartJourneyRegistrationType: {
481
+ readonly Domestic: "domestic";
482
+ readonly Foreign: "foreign";
483
+ readonly Unknown: "unknown";
484
+ };
485
+ export type StartJourneyRegistrationType = ClosedEnum<typeof StartJourneyRegistrationType>;
486
+ export type StartJourneyRegisteredAddressLocation = {
487
+ latitude?: string | undefined;
488
+ longitude?: string | undefined;
489
+ geoAccuracy?: string | undefined;
490
+ /**
491
+ * A What3words designation associated with this location with '.' separator.
492
+ */
493
+ what3words?: string | undefined;
494
+ };
495
+ export type StartJourneyRegisteredAddress = {
496
+ /**
497
+ * Unformatted line based address
498
+ */
499
+ lines?: Array<string> | undefined;
500
+ /**
501
+ * The address as a single line
502
+ */
503
+ addressString?: string | undefined;
504
+ /**
505
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
506
+ */
507
+ premise?: string | undefined;
508
+ /**
509
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
510
+ */
511
+ building?: string | undefined;
512
+ /**
513
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
514
+ */
515
+ subBuilding?: string | undefined;
516
+ /**
517
+ * This field holds the most common street or block data element within a country. For instance, USA Street
518
+ */
519
+ thoroughfare?: string | undefined;
520
+ /**
521
+ * The name of a dependent street or block, such as a street within a complex.
522
+ */
523
+ dependentThoroughfare?: string | undefined;
524
+ /**
525
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
526
+ */
527
+ locality?: string | undefined;
528
+ /**
529
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
530
+ */
531
+ dependentLocality?: string | undefined;
532
+ /**
533
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
534
+ */
535
+ doubleDependentLocality?: string | undefined;
536
+ /**
537
+ * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
538
+ */
539
+ postalCode?: string | undefined;
540
+ /**
541
+ * This field contains the post box number associated with a particular delivery point, should one exist.
542
+ */
543
+ postBox?: string | undefined;
544
+ /**
545
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
546
+ */
547
+ country?: string | undefined;
548
+ superAdministrativeArea?: string | undefined;
549
+ administrativeArea?: string | undefined;
550
+ subAdministrativeArea?: string | undefined;
551
+ organization?: string | undefined;
552
+ location?: StartJourneyRegisteredAddressLocation | undefined;
553
+ };
554
+ export type StartJourneyAgentAddressLocation = {
555
+ latitude?: string | undefined;
556
+ longitude?: string | undefined;
557
+ geoAccuracy?: string | undefined;
558
+ /**
559
+ * A What3words designation associated with this location with '.' separator.
560
+ */
561
+ what3words?: string | undefined;
562
+ };
563
+ export type StartJourneyAgentAddress = {
564
+ /**
565
+ * Unformatted line based address
566
+ */
567
+ lines?: Array<string> | undefined;
568
+ /**
569
+ * The address as a single line
570
+ */
571
+ addressString?: string | undefined;
572
+ /**
573
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
574
+ */
575
+ premise?: string | undefined;
576
+ /**
577
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
578
+ */
579
+ building?: string | undefined;
580
+ /**
581
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
582
+ */
583
+ subBuilding?: string | undefined;
584
+ /**
585
+ * This field holds the most common street or block data element within a country. For instance, USA Street
586
+ */
587
+ thoroughfare?: string | undefined;
588
+ /**
589
+ * The name of a dependent street or block, such as a street within a complex.
590
+ */
591
+ dependentThoroughfare?: string | undefined;
592
+ /**
593
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
594
+ */
595
+ locality?: string | undefined;
596
+ /**
597
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
598
+ */
599
+ dependentLocality?: string | undefined;
600
+ /**
601
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
602
+ */
603
+ doubleDependentLocality?: string | undefined;
604
+ /**
605
+ * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
606
+ */
607
+ postalCode?: string | undefined;
608
+ /**
609
+ * This field contains the post box number associated with a particular delivery point, should one exist.
610
+ */
611
+ postBox?: string | undefined;
612
+ /**
613
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
614
+ */
615
+ country?: string | undefined;
616
+ superAdministrativeArea?: string | undefined;
617
+ administrativeArea?: string | undefined;
618
+ subAdministrativeArea?: string | undefined;
619
+ organization?: string | undefined;
620
+ location?: StartJourneyAgentAddressLocation | undefined;
621
+ };
622
+ export type StartJourneyRegistration = {
623
+ jurisdiction?: string | undefined;
624
+ registrationType?: StartJourneyRegistrationType | undefined;
625
+ fileNumber?: string | undefined;
626
+ /**
627
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
628
+ */
629
+ issueDate?: string | undefined;
630
+ registeredAddress?: StartJourneyRegisteredAddress | undefined;
631
+ agentName?: string | undefined;
632
+ agentAddress?: StartJourneyAgentAddress | undefined;
633
+ };
634
+ export declare const StartJourneyTypePrimary2: {
635
+ readonly Primary: "primary";
636
+ };
637
+ export type StartJourneyTypePrimary2 = ClosedEnum<typeof StartJourneyTypePrimary2>;
638
+ export declare const StartJourneyRole: {
639
+ readonly UltimateBeneficialOwner: "ultimateBeneficialOwner";
640
+ readonly Director: "director";
641
+ readonly Officer: "officer";
642
+ readonly Secretary: "secretary";
643
+ readonly Shareholder: "shareholder";
644
+ readonly Partner: "partner";
645
+ };
646
+ export type StartJourneyRole = ClosedEnum<typeof StartJourneyRole>;
647
+ export type StartJourneyCurrentAddressLocationPrimary = {
648
+ latitude?: string | undefined;
649
+ longitude?: string | undefined;
650
+ geoAccuracy?: string | undefined;
651
+ /**
652
+ * A What3words designation associated with this location with '.' separator.
653
+ */
654
+ what3words?: string | undefined;
655
+ };
656
+ export type StartJourneyCurrentAddressPrimary = {
657
+ /**
658
+ * Unformatted line based address
659
+ */
660
+ lines?: Array<string> | undefined;
661
+ /**
662
+ * The address as a single line
663
+ */
664
+ addressString?: string | undefined;
665
+ /**
666
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
667
+ */
668
+ premise?: string | undefined;
669
+ /**
670
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
671
+ */
672
+ building?: string | undefined;
673
+ /**
674
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
675
+ */
676
+ subBuilding?: string | undefined;
677
+ /**
678
+ * This field holds the most common street or block data element within a country. For instance, USA Street
679
+ */
680
+ thoroughfare?: string | undefined;
681
+ /**
682
+ * The name of a dependent street or block, such as a street within a complex.
683
+ */
684
+ dependentThoroughfare?: string | undefined;
685
+ /**
686
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
687
+ */
688
+ locality?: string | undefined;
689
+ /**
690
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
691
+ */
692
+ dependentLocality?: string | undefined;
693
+ /**
694
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
695
+ */
696
+ doubleDependentLocality?: string | undefined;
697
+ /**
698
+ * This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
699
+ */
700
+ postalCode?: string | undefined;
701
+ /**
702
+ * This field contains the post box number associated with a particular delivery point, should one exist.
703
+ */
704
+ postBox?: string | undefined;
705
+ /**
706
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
707
+ */
708
+ country?: string | undefined;
709
+ superAdministrativeArea?: string | undefined;
710
+ administrativeArea?: string | undefined;
711
+ subAdministrativeArea?: string | undefined;
712
+ organization?: string | undefined;
713
+ location?: StartJourneyCurrentAddressLocationPrimary | undefined;
714
+ };
715
+ export type StartJourneyPerson = {
716
+ /**
717
+ * Title of an individual such as Mr, Mrs, Dr, Sir
718
+ */
719
+ title?: string | undefined;
720
+ /**
721
+ * A person's name used by their collegues and friends to address them
722
+ */
723
+ firstName?: string | undefined;
724
+ /**
725
+ * Any other registered names used by the individual, not aliases
726
+ */
727
+ middleNames?: Array<string> | undefined;
728
+ /**
729
+ * Any family names for the individual
730
+ */
731
+ lastNames?: Array<string> | undefined;
732
+ /**
733
+ * Any family names for the individual
734
+ */
735
+ lastNamesAtBirth?: Array<string> | undefined;
736
+ id?: string | undefined;
737
+ type?: StartJourneyTypePrimary2 | undefined;
738
+ role?: StartJourneyRole | undefined;
739
+ position?: string | undefined;
740
+ ownershipPercentage?: number | undefined;
741
+ /**
742
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
743
+ */
744
+ nationality?: string | undefined;
745
+ dateOfBirth?: string | undefined;
746
+ /**
747
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
748
+ */
749
+ startDate?: string | undefined;
750
+ /**
751
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
752
+ */
753
+ endDate?: string | undefined;
754
+ currentAddress?: StartJourneyCurrentAddressPrimary | undefined;
755
+ };
756
+ export type StartJourneyPhonePrimary = {
757
+ /**
758
+ * The type of phone number, such as landline, mobile, fax, unknown etc
759
+ */
760
+ type: string;
761
+ /**
762
+ * Phone number, ideally in international format with +(Country Code)
763
+ */
764
+ number: string;
765
+ };
766
+ export type StartJourneyEntity = {
767
+ id?: string | undefined;
768
+ type?: StartJourneyTypePrimary1 | undefined;
769
+ name?: string | undefined;
770
+ aliases?: Array<string> | undefined;
771
+ businessType?: string | undefined;
772
+ status?: StartJourneyStatus | undefined;
773
+ description?: string | undefined;
774
+ addresses?: Array<StartJourneyAddressPrimary> | undefined;
775
+ taxIdentifiers?: Array<StartJourneyTaxIdentifier> | undefined;
776
+ companyNumber?: string | undefined;
777
+ industryClassifications?: Array<StartJourneyIndustryClassification> | undefined;
778
+ registrations?: Array<StartJourneyRegistration> | undefined;
779
+ corporateStructure?: string | undefined;
780
+ persons?: Array<StartJourneyPerson> | undefined;
781
+ /**
782
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
783
+ */
784
+ incorporationDate?: string | undefined;
785
+ /**
786
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
787
+ */
788
+ dissolutionDate?: string | undefined;
789
+ phones?: Array<StartJourneyPhonePrimary> | undefined;
790
+ websites?: Array<string> | undefined;
791
+ headcount?: number | undefined;
792
+ isNonProfit?: boolean | undefined;
793
+ };
794
+ export type StartJourneyDocumentAddress = {
373
795
  addressString?: string | undefined;
374
796
  extractedAddressString?: string | undefined;
375
797
  addressLine1?: string | undefined;
@@ -387,6 +809,24 @@ export type StartJourneyDocumentDevice = {
387
809
  serialNumber?: string | undefined;
388
810
  manufacturer?: string | undefined;
389
811
  };
812
+ export type StartJourneySide1Device = {
813
+ type?: string | undefined;
814
+ model?: string | undefined;
815
+ hasContactlessReader?: boolean | undefined;
816
+ hasMagneticStripeReader?: boolean | undefined;
817
+ hasCamera?: boolean | undefined;
818
+ serialNumber?: string | undefined;
819
+ manufacturer?: string | undefined;
820
+ };
821
+ export type StartJourneySide2Device = {
822
+ type?: string | undefined;
823
+ model?: string | undefined;
824
+ hasContactlessReader?: boolean | undefined;
825
+ hasMagneticStripeReader?: boolean | undefined;
826
+ hasCamera?: boolean | undefined;
827
+ serialNumber?: string | undefined;
828
+ manufacturer?: string | undefined;
829
+ };
390
830
  export declare const StartJourneyName: {
391
831
  readonly Com: "COM";
392
832
  readonly Sod: "SOD";
@@ -579,10 +1019,15 @@ export type StartJourneyDocumentAlias = {
579
1019
  * Any family names for the individual
580
1020
  */
581
1021
  lastNamesAtBirth?: Array<string> | undefined;
1022
+ /**
1023
+ * The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
1024
+ */
1025
+ fullName?: string | undefined;
582
1026
  };
583
1027
  export declare const StartJourneyDocumentRelationship: {
584
1028
  readonly Mother: "mother";
585
1029
  readonly Father: "father";
1030
+ readonly Spouse: "spouse";
586
1031
  readonly MaternalGrandFather: "maternalGrandFather";
587
1032
  readonly MaternalGrandMother: "maternalGrandMother";
588
1033
  readonly PaternalGrandFather: "paternalGrandFather";
@@ -631,15 +1076,15 @@ export type StartJourneyDocumentCurrentAddress = {
631
1076
  */
632
1077
  addressString?: string | undefined;
633
1078
  /**
634
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
1079
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
635
1080
  */
636
1081
  premise?: string | undefined;
637
1082
  /**
638
- * The name of a building or a building complex. In the US, this is the street number.
1083
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
639
1084
  */
640
1085
  building?: string | undefined;
641
1086
  /**
642
- * The name of a sub-building, such as a flat or apartment number.
1087
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
643
1088
  */
644
1089
  subBuilding?: string | undefined;
645
1090
  /**
@@ -699,15 +1144,15 @@ export type StartJourneyDocumentPreviousAddress = {
699
1144
  */
700
1145
  addressString?: string | undefined;
701
1146
  /**
702
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
1147
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
703
1148
  */
704
1149
  premise?: string | undefined;
705
1150
  /**
706
- * The name of a building or a building complex. In the US, this is the street number.
1151
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
707
1152
  */
708
1153
  building?: string | undefined;
709
1154
  /**
710
- * The name of a sub-building, such as a flat or apartment number.
1155
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
711
1156
  */
712
1157
  subBuilding?: string | undefined;
713
1158
  /**
@@ -750,11 +1195,11 @@ export type StartJourneyDocumentPreviousAddress = {
750
1195
  /**
751
1196
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
752
1197
  */
753
- fromDate: string;
1198
+ fromDate?: string | undefined;
754
1199
  /**
755
1200
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
756
1201
  */
757
- toDate: string;
1202
+ toDate?: string | undefined;
758
1203
  };
759
1204
  export type StartJourneyDocumentPlaceOfBirthLocation = {
760
1205
  latitude?: string | undefined;
@@ -775,15 +1220,15 @@ export type StartJourneyDocumentPlaceOfBirth = {
775
1220
  */
776
1221
  addressString?: string | undefined;
777
1222
  /**
778
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
1223
+ * The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
779
1224
  */
780
1225
  premise?: string | undefined;
781
1226
  /**
782
- * The name of a building or a building complex. In the US, this is the street number.
1227
+ * The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
783
1228
  */
784
1229
  building?: string | undefined;
785
1230
  /**
786
- * The name of a sub-building, such as a flat or apartment number.
1231
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
787
1232
  */
788
1233
  subBuilding?: string | undefined;
789
1234
  /**
@@ -850,7 +1295,7 @@ export type StartJourneyDocumentPhone = {
850
1295
  };
851
1296
  export type StartJourneyDocumentEmail = {
852
1297
  /**
853
- * The type of email, such as home, work, unknown etc
1298
+ * Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other', 'unknown'. Four map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails, 'unknown' -> UnknownEmail (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work', 'other' or 'unknown' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
854
1299
  */
855
1300
  type: string;
856
1301
  /**
@@ -889,6 +1334,9 @@ export type StartJourneyDocumentSubject = {
889
1334
  * Any family names for the individual
890
1335
  */
891
1336
  lastNamesAtBirth?: Array<string> | undefined;
1337
+ /**
1338
+ * Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
1339
+ */
892
1340
  aliases?: Array<StartJourneyDocumentAlias> | undefined;
893
1341
  relatedPersons?: Array<StartJourneyDocumentRelatedPerson> | undefined;
894
1342
  /**
@@ -907,10 +1355,14 @@ export type StartJourneyDocumentSubject = {
907
1355
  * The subject's mother's maiden name, used for identity verification
908
1356
  */
909
1357
  mothersMaidenName?: string | undefined;
1358
+ /**
1359
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1360
+ */
1361
+ nationality?: string | undefined;
910
1362
  };
911
1363
  export type StartJourneyDocument = {
912
1364
  oneDBarcode?: string | undefined;
913
- address?: StartJourneyAddress | undefined;
1365
+ address?: StartJourneyDocumentAddress | undefined;
914
1366
  applicationDate?: string | undefined;
915
1367
  applicationNumber?: string | undefined;
916
1368
  dateOfBirth?: string | undefined;
@@ -988,13 +1440,15 @@ export type StartJourneyDocument = {
988
1440
  */
989
1441
  issuerCountryCode?: string | undefined;
990
1442
  id?: string | undefined;
991
- type?: string | undefined;
1443
+ type: string;
992
1444
  category?: string | undefined;
993
1445
  subtype?: string | undefined;
994
1446
  format?: string | undefined;
995
1447
  device?: StartJourneyDocumentDevice | undefined;
996
1448
  side1Image?: string | undefined;
997
1449
  side2Image?: string | undefined;
1450
+ side1Device?: StartJourneySide1Device | undefined;
1451
+ side2Device?: StartJourneySide2Device | undefined;
998
1452
  chip?: StartJourneyChip | undefined;
999
1453
  classification?: StartJourneyClassification | undefined;
1000
1454
  extraction?: StartJourneyExtraction | undefined;
@@ -1005,11 +1459,70 @@ export type StartJourneyDocument = {
1005
1459
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1006
1460
  */
1007
1461
  expiryDate?: string | undefined;
1462
+ cardType?: string | undefined;
1463
+ /**
1464
+ * Year and month in ISO 8601 format: YYYY-MM
1465
+ */
1466
+ expiryMonth?: string | undefined;
1467
+ cardColour?: string | undefined;
1468
+ cardStatus?: string | undefined;
1008
1469
  subject?: StartJourneyDocumentSubject | undefined;
1009
1470
  /**
1010
1471
  * Country the address is in. It must be a valid ISO2 or ISO3 country code
1011
1472
  */
1012
1473
  country?: string | undefined;
1474
+ certificateFormat?: string | undefined;
1475
+ registrationNumber?: string | undefined;
1476
+ /**
1477
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1478
+ */
1479
+ registrationDate?: string | undefined;
1480
+ /**
1481
+ * Four-digit calendar year in ISO 8601 format: YYYY
1482
+ */
1483
+ registrationYear?: string | undefined;
1484
+ partyRole?: string | undefined;
1485
+ /**
1486
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1487
+ */
1488
+ dateOfEvent?: string | undefined;
1489
+ /**
1490
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1491
+ */
1492
+ acquisitionDate?: string | undefined;
1493
+ previousFirstName?: string | undefined;
1494
+ previousMiddleName?: string | undefined;
1495
+ previousSurname?: string | undefined;
1496
+ individualReferenceNumber?: string | undefined;
1497
+ nameLine1?: string | undefined;
1498
+ nameLine2?: string | undefined;
1499
+ nameLine3?: string | undefined;
1500
+ nameLine4?: string | undefined;
1501
+ };
1502
+ export declare const StartJourneyTypeOrphanedStoredFace: {
1503
+ readonly OrphanedStoredFace: "orphanedStoredFace";
1504
+ };
1505
+ export type StartJourneyTypeOrphanedStoredFace = ClosedEnum<typeof StartJourneyTypeOrphanedStoredFace>;
1506
+ export type StartJourneyBiometricOrphanedStoredFace = {
1507
+ id?: string | undefined;
1508
+ type: StartJourneyTypeOrphanedStoredFace;
1509
+ templateReference: string;
1510
+ collectionReference?: string | undefined;
1511
+ };
1512
+ export declare const StartJourneyTypeStoredFace: {
1513
+ readonly StoredFace: "storedFace";
1514
+ };
1515
+ export type StartJourneyTypeStoredFace = ClosedEnum<typeof StartJourneyTypeStoredFace>;
1516
+ export type StartJourneyBiometricStoredFace = {
1517
+ id?: string | undefined;
1518
+ type: StartJourneyTypeStoredFace;
1519
+ templateReference: string;
1520
+ collectionReference?: string | undefined;
1521
+ };
1522
+ export type StartJourneyBiometric5 = {
1523
+ id?: string | undefined;
1524
+ type?: string | undefined;
1525
+ anchorImage: string;
1013
1526
  };
1014
1527
  export type StartJourneyBiometric4 = {
1015
1528
  id?: string | undefined;
@@ -1034,11 +1547,11 @@ export type StartJourneyBiometric1 = {
1034
1547
  face1Image: string;
1035
1548
  face2Image: string;
1036
1549
  };
1037
- export type StartJourneyBiometricUnion = StartJourneyBiometric1 | StartJourneyBiometric2 | StartJourneyBiometric3 | StartJourneyBiometric4;
1550
+ export type StartJourneyBiometricUnion = StartJourneyBiometric1 | StartJourneyBiometric2 | StartJourneyBiometricStoredFace | StartJourneyBiometricOrphanedStoredFace | StartJourneyBiometric3 | StartJourneyBiometric4 | StartJourneyBiometric5;
1038
1551
  export type StartJourneyUser = {
1039
1552
  id: string;
1040
- email: string;
1041
- domain: string;
1553
+ email?: string | undefined;
1554
+ domain?: string | undefined;
1042
1555
  };
1043
1556
  export type StartJourneyClient = {
1044
1557
  id: string;
@@ -1075,6 +1588,9 @@ export type StartJourneySessionAuth = {
1075
1588
  clientSecret?: string | undefined;
1076
1589
  };
1077
1590
  export type StartJourneySession = {
1591
+ id?: string | undefined;
1592
+ type?: string | undefined;
1593
+ provider?: string | undefined;
1078
1594
  user?: StartJourneyUser | undefined;
1079
1595
  client?: StartJourneyClient | undefined;
1080
1596
  device?: StartJourneySessionDevice | undefined;
@@ -1105,13 +1621,13 @@ export type StartJourneyConsent = {
1105
1621
  };
1106
1622
  export type StartJourneyAccount = {
1107
1623
  /**
1108
- * The type of account, e.g. Bank Account, Building Society
1624
+ * The type of account (canonical camelCase, e.g. "bankAccount"). Legacy value "Bank Account" is still read but new writes emit the canonical form.
1109
1625
  */
1110
1626
  type: string;
1111
1627
  /**
1112
- * Account number
1628
+ * Account number in its domestic form. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough. Independent of `iban`; when both are supplied they are not cross-checked.
1113
1629
  */
1114
- accountNumber: string;
1630
+ accountNumber?: string | undefined;
1115
1631
  /**
1116
1632
  * UK sort code
1117
1633
  */
@@ -1121,7 +1637,7 @@ export type StartJourneyAccount = {
1121
1637
  */
1122
1638
  routingNumber?: string | undefined;
1123
1639
  /**
1124
- * International Bank Account Number
1640
+ * International Bank Account Number, stored exactly as supplied — not format-checked (no ISO 13616 mod-97) at this boundary. Optional on its own: an account must carry at least one account identifier — `accountNumber` or `iban` — and either alone is enough.
1125
1641
  */
1126
1642
  iban?: string | undefined;
1127
1643
  /**
@@ -1145,66 +1661,209 @@ export type StartJourneyAccount = {
1145
1661
  */
1146
1662
  accountType?: string | undefined;
1147
1663
  };
1148
- export type StartJourneySubject = {
1664
+ export type StartJourneyChoice = {
1665
+ label: string;
1666
+ text: string;
1667
+ };
1668
+ export type StartJourneyQuestion = {
1669
+ id: number;
1670
+ questionText: string;
1671
+ helpText?: string | undefined;
1672
+ choices: Array<StartJourneyChoice>;
1673
+ };
1674
+ export type StartJourneyAnswer = {
1675
+ id: number;
1676
+ choices: Array<string>;
1677
+ };
1678
+ export type StartJourneyKba = {
1679
+ questions: Array<StartJourneyQuestion>;
1680
+ answers: Array<StartJourneyAnswer>;
1681
+ };
1682
+ export declare const StartJourneyOffered: {
1683
+ readonly AustraliaPassport: "australiaPassport";
1684
+ readonly AustraliaDrivingLicense: "australiaDrivingLicense";
1685
+ readonly AustraliaBirthCertificate: "australiaBirthCertificate";
1686
+ readonly AustraliaCentrelink: "australiaCentrelink";
1687
+ readonly AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate";
1688
+ readonly AustraliaVisa: "australiaVisa";
1689
+ readonly AustraliaMedicare: "australiaMedicare";
1690
+ readonly AustraliaImmicard: "australiaImmicard";
1691
+ readonly AustraliaMarriageCertificate: "australiaMarriageCertificate";
1692
+ readonly AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate";
1693
+ readonly AustraliaElectoralRoll: "australiaElectoralRoll";
1694
+ readonly NewZealandPassport: "newZealandPassport";
1695
+ readonly NewZealandDrivingLicense: "newZealandDrivingLicense";
1696
+ readonly NewZealandBirthCertificate: "newZealandBirthCertificate";
1697
+ readonly NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate";
1698
+ readonly NoneOfThese: "noneOfThese";
1699
+ };
1700
+ export type StartJourneyOffered = ClosedEnum<typeof StartJourneyOffered>;
1701
+ export declare const StartJourneySelected: {
1702
+ readonly AustraliaPassport: "australiaPassport";
1703
+ readonly AustraliaDrivingLicense: "australiaDrivingLicense";
1704
+ readonly AustraliaBirthCertificate: "australiaBirthCertificate";
1705
+ readonly AustraliaCentrelink: "australiaCentrelink";
1706
+ readonly AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate";
1707
+ readonly AustraliaVisa: "australiaVisa";
1708
+ readonly AustraliaMedicare: "australiaMedicare";
1709
+ readonly AustraliaImmicard: "australiaImmicard";
1710
+ readonly AustraliaMarriageCertificate: "australiaMarriageCertificate";
1711
+ readonly AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate";
1712
+ readonly AustraliaElectoralRoll: "australiaElectoralRoll";
1713
+ readonly NewZealandPassport: "newZealandPassport";
1714
+ readonly NewZealandDrivingLicense: "newZealandDrivingLicense";
1715
+ readonly NewZealandBirthCertificate: "newZealandBirthCertificate";
1716
+ readonly NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate";
1717
+ readonly NoneOfThese: "noneOfThese";
1718
+ };
1719
+ export type StartJourneySelected = ClosedEnum<typeof StartJourneySelected>;
1720
+ export type StartJourneyDocumentTypeSelection = {
1721
+ offered?: Array<StartJourneyOffered> | undefined;
1722
+ selected?: StartJourneySelected | undefined;
1723
+ };
1724
+ export type StartJourneyContextSubject = {
1149
1725
  identity?: StartJourneyIdentity | undefined;
1726
+ entities?: Array<StartJourneyEntity> | undefined;
1150
1727
  documents?: Array<StartJourneyDocument> | undefined;
1151
- biometrics?: Array<StartJourneyBiometric1 | StartJourneyBiometric2 | StartJourneyBiometric3 | StartJourneyBiometric4> | undefined;
1728
+ biometrics?: Array<StartJourneyBiometric1 | StartJourneyBiometric2 | StartJourneyBiometricStoredFace | StartJourneyBiometricOrphanedStoredFace | StartJourneyBiometric3 | StartJourneyBiometric4 | StartJourneyBiometric5> | undefined;
1152
1729
  sessions?: Array<StartJourneySession> | undefined;
1153
1730
  consent?: Array<StartJourneyConsent> | undefined;
1154
1731
  accounts?: Array<StartJourneyAccount> | undefined;
1732
+ kba?: StartJourneyKba | undefined;
1733
+ documentTypeSelection?: StartJourneyDocumentTypeSelection | undefined;
1155
1734
  uid?: string | undefined;
1156
1735
  };
1157
- export type StartJourneyContext = {
1158
- config: Config;
1159
- subject: StartJourneySubject;
1736
+ /**
1737
+ * How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
1738
+ */
1739
+ export declare const ResumeMode: {
1740
+ readonly Off: "off";
1741
+ readonly Resume: "resume";
1160
1742
  };
1161
- export type StartJourneyRequest = {
1743
+ /**
1744
+ * How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
1745
+ */
1746
+ export type ResumeMode = ClosedEnum<typeof ResumeMode>;
1747
+ /**
1748
+ * Reminders for an invite journey: the invite link is sent again every intervalMinutes, at most maxReminders times, until the journey finishes or the link expires (ttlMinutes), whichever comes first. Resolved as ONE unit, not per member: the first tier that sets it (journey start, then delivery, then organization) wins, and an interval from one tier is never combined with a count from another. Absent everywhere means off. A journey without an invite ignores it. Captain refuses an interval below its operator floor with a 400 naming the tier. Frozen at journey start: editing it later does not reach a running journey.
1749
+ */
1750
+ export type Reminders = {
1162
1751
  /**
1163
- * Resource Id, a unique identifier for a resource, such as a journey or instance.
1752
+ * Minutes between one send of the invite link and the next reminder.
1164
1753
  */
1165
- resourceId: string;
1166
- context?: StartJourneyContext | undefined;
1167
- data?: {
1168
- [k: string]: any;
1169
- } | undefined;
1754
+ intervalMinutes: number;
1755
+ /**
1756
+ * Reminders sent after the first invite, at most 5. 0 turns reminders off.
1757
+ */
1758
+ maxReminders: number;
1759
+ };
1760
+ /**
1761
+ * Per-journey link lifetime and resume behavior. Every member is optional, and each is resolved independently across the per-journey, delivery, organization and system-default tiers, then clamped down to the operator bounds. All three members reach runtime behavior: ttlMinutes bounds how long the link stays startable, and the resolved resumeMode and resumeExpiryMinutes are frozen onto the delivery-token and connect-secret records, read at connect, and enforced when a resume credential is minted and exchanged. None of the resolved values is echoed on any response — the journey-start log line is where the resolved mode, its tier and any clamp are reported. An absent ttlMinutes falls back to the delivery resource's linkConfig, then to the organization's value, then to the deprecated flat deliveryUrlTtlMinutes, then to the system default.
1762
+ */
1763
+ export type LinkConfig = {
1764
+ /**
1765
+ * Lifetime of the delivery link in minutes: the deadline for STARTING a journey, governing the connect secret and therefore how long an unopened link stays usable. It no longer bounds how long an applicant may come BACK — that is resumeExpiryMinutes, which is anchored at first connect and may outlast this. Replaces the deprecated flat deliveryUrlTtlMinutes. Bounded by the operator ceiling at runtime, not here: a value above the ceiling is clamped down to it. A shorter lifetime is always honored exactly as supplied — there is no lower bound, and nothing lengthens a link beyond what was requested.
1766
+ */
1767
+ ttlMinutes?: number | undefined;
1768
+ /**
1769
+ * How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
1770
+ */
1771
+ resumeMode?: ResumeMode | undefined;
1772
+ /**
1773
+ * Resume-credential lifetime in minutes, ABSOLUTE from the applicant first connecting — not from link issue, and not sliding from last use. Nothing renews it: returning many times neither extends nor shortens it. Valid only when resumeMode is resume; supplying it alongside off is rejected. Clamped downward only. It may fall AFTER the link expires, which is deliberate — the link bounds starting, this bounds coming back. Because nothing renews it, a small value is a total journey budget rather than an idle timeout, and will cut off an applicant who never stopped working.
1774
+ */
1775
+ resumeExpiryMinutes?: number | undefined;
1776
+ /**
1777
+ * Reminders for an invite journey: the invite link is sent again every intervalMinutes, at most maxReminders times, until the journey finishes or the link expires (ttlMinutes), whichever comes first. Resolved as ONE unit, not per member: the first tier that sets it (journey start, then delivery, then organization) wins, and an interval from one tier is never combined with a count from another. Absent everywhere means off. A journey without an invite ignores it. Captain refuses an interval below its operator floor with a 400 naming the tier. Frozen at journey start: editing it later does not reach a running journey.
1778
+ */
1779
+ reminders?: Reminders | undefined;
1780
+ };
1781
+ /**
1782
+ * Selects which revision of this organisation configuration overlay this execution runs against. It participates in the delivery cache key, so naming a version guarantees the start is served a graph built from that exact overlay instead of a cached one. Omitting it is a no-op: the latest overlay applies and the request behaves as it did before this member existed.
1783
+ */
1784
+ export type Overlay = {
1785
+ /**
1786
+ * The overlay revision to apply for this execution. Supply the version returned when the overlay was saved to have the change take effect on this start rather than after the delivery cache expires. Omit it to run the latest overlay, which is the behavior when this member is absent.
1787
+ */
1788
+ version: string;
1789
+ };
1790
+ export type Config = {
1791
+ delivery: string;
1792
+ branding?: any | undefined;
1793
+ /**
1794
+ * Marks this start as operator-completed (assisted) rather than customer-completed, so the two populations can be told apart in downstream telemetry. Accepted and logged but not yet enforced: supplying it does not change validation, routing, execution or the response, and omitting it leaves the request byte-identical to an ordinary start. It is an attribution signal only, and whether anything ever reads it to change behavior is a separate decision that has not been taken.
1795
+ */
1796
+ assisted?: boolean | undefined;
1797
+ /**
1798
+ * Opt-in synchronous execution: when true, the start call waits for the journey and returns its outcome inline (completed, failed, awaiting-input or pending) instead of returning immediately with just an instanceId. Requires delivery "api" and a durable engine; otherwise the request is rejected with 400 before any journey is created. false is accepted and means the same as omitting it. Same name as Captain V1, but the response shape differs: the journey state is nested under "state".
1799
+ */
1800
+ inlineResult?: boolean | undefined;
1801
+ /**
1802
+ * How many seconds the caller is willing to wait; requires inlineResult: true. Optional: absent means wait up to the platform ceiling, which is the load balancer's idle timeout minus 10 seconds (50 today). Send a smaller value if your own HTTP client gives up sooner. A value above the ceiling is clamped, not rejected, and the clamp is logged.
1803
+ */
1804
+ syncWaitSeconds?: number | undefined;
1805
+ /**
1806
+ * Per-journey link lifetime and resume behavior. Every member is optional, and each is resolved independently across the per-journey, delivery, organization and system-default tiers, then clamped down to the operator bounds. All three members reach runtime behavior: ttlMinutes bounds how long the link stays startable, and the resolved resumeMode and resumeExpiryMinutes are frozen onto the delivery-token and connect-secret records, read at connect, and enforced when a resume credential is minted and exchanged. None of the resolved values is echoed on any response — the journey-start log line is where the resolved mode, its tier and any clamp are reported. An absent ttlMinutes falls back to the delivery resource's linkConfig, then to the organization's value, then to the deprecated flat deliveryUrlTtlMinutes, then to the system default.
1807
+ */
1808
+ linkConfig?: LinkConfig | undefined;
1809
+ /**
1810
+ * Selects which revision of this organisation configuration overlay this execution runs against. It participates in the delivery cache key, so naming a version guarantees the start is served a graph built from that exact overlay instead of a cached one. Omitting it is a no-op: the latest overlay applies and the request behaves as it did before this member existed.
1811
+ */
1812
+ overlay?: Overlay | undefined;
1813
+ [additionalProperties: string]: unknown;
1814
+ };
1815
+ export type StartJourneyContext = {
1816
+ subject?: StartJourneyContextSubject | undefined;
1817
+ config: Config;
1818
+ [additionalProperties: string]: unknown;
1170
1819
  };
1171
1820
  /**
1172
- * Start Response contains the Journey Instance Id
1821
+ * Domain-element values this module override returns in result.subject.
1173
1822
  */
1174
- export type StartJourneyResponseBody2 = {
1823
+ export type ModulesSubject = {};
1824
+ export type Modules = {
1825
+ outcome: string;
1826
+ advice?: {
1827
+ [k: string]: any;
1828
+ } | undefined;
1175
1829
  /**
1176
- * Journey Instance Id, a unique identifier for a started journey instance.
1830
+ * Domain-element values this module override returns in result.subject.
1177
1831
  */
1178
- instanceId: string;
1832
+ subject?: ModulesSubject | undefined;
1179
1833
  [additionalProperties: string]: unknown;
1180
1834
  };
1181
1835
  /**
1182
- * Start Response contains the Journey Instance Id
1836
+ * Fallback subject values applied when a module entry has no subject of its own.
1183
1837
  */
1184
- export type StartJourneyResponseBody1 = {
1838
+ export type DefaultSubject = {};
1839
+ export type Scenario = {
1840
+ modules: {
1841
+ [k: string]: Modules;
1842
+ };
1843
+ defaultOutcome?: string | undefined;
1844
+ defaultAdvice?: {
1845
+ [k: string]: any;
1846
+ } | undefined;
1185
1847
  /**
1186
- * Journey Instance Id, a unique identifier for a started journey instance.
1848
+ * Fallback subject values applied when a module entry has no subject of its own.
1187
1849
  */
1188
- instanceId: string;
1850
+ defaultSubject?: DefaultSubject | undefined;
1851
+ description?: string | undefined;
1189
1852
  [additionalProperties: string]: unknown;
1190
1853
  };
1191
- export type StartJourneyResponse = StartJourneyResponseBody1 | StartJourneyResponseBody2;
1192
- /** @internal */
1193
- export declare const Delivery$outboundSchema: z.ZodMiniEnum<typeof Delivery>;
1194
- /** @internal */
1195
- export type Config$Outbound = {
1196
- delivery: string;
1854
+ export type StartJourneyRequest = {
1855
+ resourceId: string;
1856
+ context: StartJourneyContext;
1857
+ scenario?: Scenario | undefined;
1197
1858
  };
1198
1859
  /** @internal */
1199
- export declare const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config>;
1200
- export declare function configToJSON(config: Config): string;
1201
- /** @internal */
1202
1860
  export type StartJourneyIdentityAlias$Outbound = {
1203
1861
  title?: string | undefined;
1204
1862
  firstName?: string | undefined;
1205
1863
  middleNames?: Array<string> | undefined;
1206
1864
  lastNames?: Array<string> | undefined;
1207
1865
  lastNamesAtBirth?: Array<string> | undefined;
1866
+ fullName?: string | undefined;
1208
1867
  };
1209
1868
  /** @internal */
1210
1869
  export declare const StartJourneyIdentityAlias$outboundSchema: z.ZodMiniType<StartJourneyIdentityAlias$Outbound, StartJourneyIdentityAlias>;
@@ -1287,8 +1946,8 @@ export type StartJourneyIdentityPreviousAddress$Outbound = {
1287
1946
  subAdministrativeArea?: string | undefined;
1288
1947
  organization?: string | undefined;
1289
1948
  location?: StartJourneyIdentityPreviousAddressLocation$Outbound | undefined;
1290
- fromDate: string;
1291
- toDate: string;
1949
+ fromDate?: string | undefined;
1950
+ toDate?: string | undefined;
1292
1951
  };
1293
1952
  /** @internal */
1294
1953
  export declare const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<StartJourneyIdentityPreviousAddress$Outbound, StartJourneyIdentityPreviousAddress>;
@@ -1379,12 +2038,252 @@ export type StartJourneyIdentity$Outbound = {
1379
2038
  emails?: Array<StartJourneyIdentityEmail$Outbound> | undefined;
1380
2039
  socials?: Array<StartJourneyIdentitySocial$Outbound> | undefined;
1381
2040
  mothersMaidenName?: string | undefined;
2041
+ nationality?: string | undefined;
1382
2042
  };
1383
2043
  /** @internal */
1384
2044
  export declare const StartJourneyIdentity$outboundSchema: z.ZodMiniType<StartJourneyIdentity$Outbound, StartJourneyIdentity>;
1385
2045
  export declare function startJourneyIdentityToJSON(startJourneyIdentity: StartJourneyIdentity): string;
1386
2046
  /** @internal */
1387
- export type StartJourneyAddress$Outbound = {
2047
+ export declare const StartJourneyTypePrimary1$outboundSchema: z.ZodMiniEnum<typeof StartJourneyTypePrimary1>;
2048
+ /** @internal */
2049
+ export declare const StartJourneyStatus$outboundSchema: z.ZodMiniEnum<typeof StartJourneyStatus>;
2050
+ /** @internal */
2051
+ export type StartJourneyAddressLocation$Outbound = {
2052
+ latitude?: string | undefined;
2053
+ longitude?: string | undefined;
2054
+ geoAccuracy?: string | undefined;
2055
+ what3words?: string | undefined;
2056
+ };
2057
+ /** @internal */
2058
+ export declare const StartJourneyAddressLocation$outboundSchema: z.ZodMiniType<StartJourneyAddressLocation$Outbound, StartJourneyAddressLocation>;
2059
+ export declare function startJourneyAddressLocationToJSON(startJourneyAddressLocation: StartJourneyAddressLocation): string;
2060
+ /** @internal */
2061
+ export declare const StartJourneyPurpose$outboundSchema: z.ZodMiniEnum<typeof StartJourneyPurpose>;
2062
+ /** @internal */
2063
+ export type StartJourneyAddressPrimary$Outbound = {
2064
+ lines?: Array<string> | undefined;
2065
+ addressString?: string | undefined;
2066
+ premise?: string | undefined;
2067
+ building?: string | undefined;
2068
+ subBuilding?: string | undefined;
2069
+ thoroughfare?: string | undefined;
2070
+ dependentThoroughfare?: string | undefined;
2071
+ locality?: string | undefined;
2072
+ dependentLocality?: string | undefined;
2073
+ doubleDependentLocality?: string | undefined;
2074
+ postalCode?: string | undefined;
2075
+ postBox?: string | undefined;
2076
+ country?: string | undefined;
2077
+ superAdministrativeArea?: string | undefined;
2078
+ administrativeArea?: string | undefined;
2079
+ subAdministrativeArea?: string | undefined;
2080
+ organization?: string | undefined;
2081
+ location?: StartJourneyAddressLocation$Outbound | undefined;
2082
+ purpose?: string | undefined;
2083
+ };
2084
+ /** @internal */
2085
+ export declare const StartJourneyAddressPrimary$outboundSchema: z.ZodMiniType<StartJourneyAddressPrimary$Outbound, StartJourneyAddressPrimary>;
2086
+ export declare function startJourneyAddressPrimaryToJSON(startJourneyAddressPrimary: StartJourneyAddressPrimary): string;
2087
+ /** @internal */
2088
+ export declare const StartJourneyTaxIdentifierType$outboundSchema: z.ZodMiniEnum<typeof StartJourneyTaxIdentifierType>;
2089
+ /** @internal */
2090
+ export type StartJourneyTaxIdentifier$Outbound = {
2091
+ type: string;
2092
+ value: string;
2093
+ country?: string | undefined;
2094
+ };
2095
+ /** @internal */
2096
+ export declare const StartJourneyTaxIdentifier$outboundSchema: z.ZodMiniType<StartJourneyTaxIdentifier$Outbound, StartJourneyTaxIdentifier>;
2097
+ export declare function startJourneyTaxIdentifierToJSON(startJourneyTaxIdentifier: StartJourneyTaxIdentifier): string;
2098
+ /** @internal */
2099
+ export declare const StartJourneySystem$outboundSchema: z.ZodMiniEnum<typeof StartJourneySystem>;
2100
+ /** @internal */
2101
+ export type StartJourneyIndustryClassification$Outbound = {
2102
+ system: string;
2103
+ code: string;
2104
+ description?: string | undefined;
2105
+ };
2106
+ /** @internal */
2107
+ export declare const StartJourneyIndustryClassification$outboundSchema: z.ZodMiniType<StartJourneyIndustryClassification$Outbound, StartJourneyIndustryClassification>;
2108
+ export declare function startJourneyIndustryClassificationToJSON(startJourneyIndustryClassification: StartJourneyIndustryClassification): string;
2109
+ /** @internal */
2110
+ export declare const StartJourneyRegistrationType$outboundSchema: z.ZodMiniEnum<typeof StartJourneyRegistrationType>;
2111
+ /** @internal */
2112
+ export type StartJourneyRegisteredAddressLocation$Outbound = {
2113
+ latitude?: string | undefined;
2114
+ longitude?: string | undefined;
2115
+ geoAccuracy?: string | undefined;
2116
+ what3words?: string | undefined;
2117
+ };
2118
+ /** @internal */
2119
+ export declare const StartJourneyRegisteredAddressLocation$outboundSchema: z.ZodMiniType<StartJourneyRegisteredAddressLocation$Outbound, StartJourneyRegisteredAddressLocation>;
2120
+ export declare function startJourneyRegisteredAddressLocationToJSON(startJourneyRegisteredAddressLocation: StartJourneyRegisteredAddressLocation): string;
2121
+ /** @internal */
2122
+ export type StartJourneyRegisteredAddress$Outbound = {
2123
+ lines?: Array<string> | undefined;
2124
+ addressString?: string | undefined;
2125
+ premise?: string | undefined;
2126
+ building?: string | undefined;
2127
+ subBuilding?: string | undefined;
2128
+ thoroughfare?: string | undefined;
2129
+ dependentThoroughfare?: string | undefined;
2130
+ locality?: string | undefined;
2131
+ dependentLocality?: string | undefined;
2132
+ doubleDependentLocality?: string | undefined;
2133
+ postalCode?: string | undefined;
2134
+ postBox?: string | undefined;
2135
+ country?: string | undefined;
2136
+ superAdministrativeArea?: string | undefined;
2137
+ administrativeArea?: string | undefined;
2138
+ subAdministrativeArea?: string | undefined;
2139
+ organization?: string | undefined;
2140
+ location?: StartJourneyRegisteredAddressLocation$Outbound | undefined;
2141
+ };
2142
+ /** @internal */
2143
+ export declare const StartJourneyRegisteredAddress$outboundSchema: z.ZodMiniType<StartJourneyRegisteredAddress$Outbound, StartJourneyRegisteredAddress>;
2144
+ export declare function startJourneyRegisteredAddressToJSON(startJourneyRegisteredAddress: StartJourneyRegisteredAddress): string;
2145
+ /** @internal */
2146
+ export type StartJourneyAgentAddressLocation$Outbound = {
2147
+ latitude?: string | undefined;
2148
+ longitude?: string | undefined;
2149
+ geoAccuracy?: string | undefined;
2150
+ what3words?: string | undefined;
2151
+ };
2152
+ /** @internal */
2153
+ export declare const StartJourneyAgentAddressLocation$outboundSchema: z.ZodMiniType<StartJourneyAgentAddressLocation$Outbound, StartJourneyAgentAddressLocation>;
2154
+ export declare function startJourneyAgentAddressLocationToJSON(startJourneyAgentAddressLocation: StartJourneyAgentAddressLocation): string;
2155
+ /** @internal */
2156
+ export type StartJourneyAgentAddress$Outbound = {
2157
+ lines?: Array<string> | undefined;
2158
+ addressString?: string | undefined;
2159
+ premise?: string | undefined;
2160
+ building?: string | undefined;
2161
+ subBuilding?: string | undefined;
2162
+ thoroughfare?: string | undefined;
2163
+ dependentThoroughfare?: string | undefined;
2164
+ locality?: string | undefined;
2165
+ dependentLocality?: string | undefined;
2166
+ doubleDependentLocality?: string | undefined;
2167
+ postalCode?: string | undefined;
2168
+ postBox?: string | undefined;
2169
+ country?: string | undefined;
2170
+ superAdministrativeArea?: string | undefined;
2171
+ administrativeArea?: string | undefined;
2172
+ subAdministrativeArea?: string | undefined;
2173
+ organization?: string | undefined;
2174
+ location?: StartJourneyAgentAddressLocation$Outbound | undefined;
2175
+ };
2176
+ /** @internal */
2177
+ export declare const StartJourneyAgentAddress$outboundSchema: z.ZodMiniType<StartJourneyAgentAddress$Outbound, StartJourneyAgentAddress>;
2178
+ export declare function startJourneyAgentAddressToJSON(startJourneyAgentAddress: StartJourneyAgentAddress): string;
2179
+ /** @internal */
2180
+ export type StartJourneyRegistration$Outbound = {
2181
+ jurisdiction?: string | undefined;
2182
+ registrationType?: string | undefined;
2183
+ fileNumber?: string | undefined;
2184
+ issueDate?: string | undefined;
2185
+ registeredAddress?: StartJourneyRegisteredAddress$Outbound | undefined;
2186
+ agentName?: string | undefined;
2187
+ agentAddress?: StartJourneyAgentAddress$Outbound | undefined;
2188
+ };
2189
+ /** @internal */
2190
+ export declare const StartJourneyRegistration$outboundSchema: z.ZodMiniType<StartJourneyRegistration$Outbound, StartJourneyRegistration>;
2191
+ export declare function startJourneyRegistrationToJSON(startJourneyRegistration: StartJourneyRegistration): string;
2192
+ /** @internal */
2193
+ export declare const StartJourneyTypePrimary2$outboundSchema: z.ZodMiniEnum<typeof StartJourneyTypePrimary2>;
2194
+ /** @internal */
2195
+ export declare const StartJourneyRole$outboundSchema: z.ZodMiniEnum<typeof StartJourneyRole>;
2196
+ /** @internal */
2197
+ export type StartJourneyCurrentAddressLocationPrimary$Outbound = {
2198
+ latitude?: string | undefined;
2199
+ longitude?: string | undefined;
2200
+ geoAccuracy?: string | undefined;
2201
+ what3words?: string | undefined;
2202
+ };
2203
+ /** @internal */
2204
+ export declare const StartJourneyCurrentAddressLocationPrimary$outboundSchema: z.ZodMiniType<StartJourneyCurrentAddressLocationPrimary$Outbound, StartJourneyCurrentAddressLocationPrimary>;
2205
+ export declare function startJourneyCurrentAddressLocationPrimaryToJSON(startJourneyCurrentAddressLocationPrimary: StartJourneyCurrentAddressLocationPrimary): string;
2206
+ /** @internal */
2207
+ export type StartJourneyCurrentAddressPrimary$Outbound = {
2208
+ lines?: Array<string> | undefined;
2209
+ addressString?: string | undefined;
2210
+ premise?: string | undefined;
2211
+ building?: string | undefined;
2212
+ subBuilding?: string | undefined;
2213
+ thoroughfare?: string | undefined;
2214
+ dependentThoroughfare?: string | undefined;
2215
+ locality?: string | undefined;
2216
+ dependentLocality?: string | undefined;
2217
+ doubleDependentLocality?: string | undefined;
2218
+ postalCode?: string | undefined;
2219
+ postBox?: string | undefined;
2220
+ country?: string | undefined;
2221
+ superAdministrativeArea?: string | undefined;
2222
+ administrativeArea?: string | undefined;
2223
+ subAdministrativeArea?: string | undefined;
2224
+ organization?: string | undefined;
2225
+ location?: StartJourneyCurrentAddressLocationPrimary$Outbound | undefined;
2226
+ };
2227
+ /** @internal */
2228
+ export declare const StartJourneyCurrentAddressPrimary$outboundSchema: z.ZodMiniType<StartJourneyCurrentAddressPrimary$Outbound, StartJourneyCurrentAddressPrimary>;
2229
+ export declare function startJourneyCurrentAddressPrimaryToJSON(startJourneyCurrentAddressPrimary: StartJourneyCurrentAddressPrimary): string;
2230
+ /** @internal */
2231
+ export type StartJourneyPerson$Outbound = {
2232
+ title?: string | undefined;
2233
+ firstName?: string | undefined;
2234
+ middleNames?: Array<string> | undefined;
2235
+ lastNames?: Array<string> | undefined;
2236
+ lastNamesAtBirth?: Array<string> | undefined;
2237
+ id?: string | undefined;
2238
+ type?: string | undefined;
2239
+ role?: string | undefined;
2240
+ position?: string | undefined;
2241
+ ownershipPercentage?: number | undefined;
2242
+ nationality?: string | undefined;
2243
+ dateOfBirth?: string | undefined;
2244
+ startDate?: string | undefined;
2245
+ endDate?: string | undefined;
2246
+ currentAddress?: StartJourneyCurrentAddressPrimary$Outbound | undefined;
2247
+ };
2248
+ /** @internal */
2249
+ export declare const StartJourneyPerson$outboundSchema: z.ZodMiniType<StartJourneyPerson$Outbound, StartJourneyPerson>;
2250
+ export declare function startJourneyPersonToJSON(startJourneyPerson: StartJourneyPerson): string;
2251
+ /** @internal */
2252
+ export type StartJourneyPhonePrimary$Outbound = {
2253
+ type: string;
2254
+ number: string;
2255
+ };
2256
+ /** @internal */
2257
+ export declare const StartJourneyPhonePrimary$outboundSchema: z.ZodMiniType<StartJourneyPhonePrimary$Outbound, StartJourneyPhonePrimary>;
2258
+ export declare function startJourneyPhonePrimaryToJSON(startJourneyPhonePrimary: StartJourneyPhonePrimary): string;
2259
+ /** @internal */
2260
+ export type StartJourneyEntity$Outbound = {
2261
+ id?: string | undefined;
2262
+ type?: string | undefined;
2263
+ name?: string | undefined;
2264
+ aliases?: Array<string> | undefined;
2265
+ businessType?: string | undefined;
2266
+ status?: string | undefined;
2267
+ description?: string | undefined;
2268
+ addresses?: Array<StartJourneyAddressPrimary$Outbound> | undefined;
2269
+ taxIdentifiers?: Array<StartJourneyTaxIdentifier$Outbound> | undefined;
2270
+ companyNumber?: string | undefined;
2271
+ industryClassifications?: Array<StartJourneyIndustryClassification$Outbound> | undefined;
2272
+ registrations?: Array<StartJourneyRegistration$Outbound> | undefined;
2273
+ corporateStructure?: string | undefined;
2274
+ persons?: Array<StartJourneyPerson$Outbound> | undefined;
2275
+ incorporationDate?: string | undefined;
2276
+ dissolutionDate?: string | undefined;
2277
+ phones?: Array<StartJourneyPhonePrimary$Outbound> | undefined;
2278
+ websites?: Array<string> | undefined;
2279
+ headcount?: number | undefined;
2280
+ isNonProfit?: boolean | undefined;
2281
+ };
2282
+ /** @internal */
2283
+ export declare const StartJourneyEntity$outboundSchema: z.ZodMiniType<StartJourneyEntity$Outbound, StartJourneyEntity>;
2284
+ export declare function startJourneyEntityToJSON(startJourneyEntity: StartJourneyEntity): string;
2285
+ /** @internal */
2286
+ export type StartJourneyDocumentAddress$Outbound = {
1388
2287
  addressString?: string | undefined;
1389
2288
  extractedAddressString?: string | undefined;
1390
2289
  addressLine1?: string | undefined;
@@ -1394,8 +2293,8 @@ export type StartJourneyAddress$Outbound = {
1394
2293
  postalCode?: string | undefined;
1395
2294
  };
1396
2295
  /** @internal */
1397
- export declare const StartJourneyAddress$outboundSchema: z.ZodMiniType<StartJourneyAddress$Outbound, StartJourneyAddress>;
1398
- export declare function startJourneyAddressToJSON(startJourneyAddress: StartJourneyAddress): string;
2296
+ export declare const StartJourneyDocumentAddress$outboundSchema: z.ZodMiniType<StartJourneyDocumentAddress$Outbound, StartJourneyDocumentAddress>;
2297
+ export declare function startJourneyDocumentAddressToJSON(startJourneyDocumentAddress: StartJourneyDocumentAddress): string;
1399
2298
  /** @internal */
1400
2299
  export type StartJourneyDocumentDevice$Outbound = {
1401
2300
  type?: string | undefined;
@@ -1410,6 +2309,32 @@ export type StartJourneyDocumentDevice$Outbound = {
1410
2309
  export declare const StartJourneyDocumentDevice$outboundSchema: z.ZodMiniType<StartJourneyDocumentDevice$Outbound, StartJourneyDocumentDevice>;
1411
2310
  export declare function startJourneyDocumentDeviceToJSON(startJourneyDocumentDevice: StartJourneyDocumentDevice): string;
1412
2311
  /** @internal */
2312
+ export type StartJourneySide1Device$Outbound = {
2313
+ type?: string | undefined;
2314
+ model?: string | undefined;
2315
+ hasContactlessReader?: boolean | undefined;
2316
+ hasMagneticStripeReader?: boolean | undefined;
2317
+ hasCamera?: boolean | undefined;
2318
+ serialNumber?: string | undefined;
2319
+ manufacturer?: string | undefined;
2320
+ };
2321
+ /** @internal */
2322
+ export declare const StartJourneySide1Device$outboundSchema: z.ZodMiniType<StartJourneySide1Device$Outbound, StartJourneySide1Device>;
2323
+ export declare function startJourneySide1DeviceToJSON(startJourneySide1Device: StartJourneySide1Device): string;
2324
+ /** @internal */
2325
+ export type StartJourneySide2Device$Outbound = {
2326
+ type?: string | undefined;
2327
+ model?: string | undefined;
2328
+ hasContactlessReader?: boolean | undefined;
2329
+ hasMagneticStripeReader?: boolean | undefined;
2330
+ hasCamera?: boolean | undefined;
2331
+ serialNumber?: string | undefined;
2332
+ manufacturer?: string | undefined;
2333
+ };
2334
+ /** @internal */
2335
+ export declare const StartJourneySide2Device$outboundSchema: z.ZodMiniType<StartJourneySide2Device$Outbound, StartJourneySide2Device>;
2336
+ export declare function startJourneySide2DeviceToJSON(startJourneySide2Device: StartJourneySide2Device): string;
2337
+ /** @internal */
1413
2338
  export declare const StartJourneyName$outboundSchema: z.ZodMiniEnum<typeof StartJourneyName>;
1414
2339
  /** @internal */
1415
2340
  export type StartJourneyLd$Outbound = {
@@ -1641,6 +2566,7 @@ export type StartJourneyDocumentAlias$Outbound = {
1641
2566
  middleNames?: Array<string> | undefined;
1642
2567
  lastNames?: Array<string> | undefined;
1643
2568
  lastNamesAtBirth?: Array<string> | undefined;
2569
+ fullName?: string | undefined;
1644
2570
  };
1645
2571
  /** @internal */
1646
2572
  export declare const StartJourneyDocumentAlias$outboundSchema: z.ZodMiniType<StartJourneyDocumentAlias$Outbound, StartJourneyDocumentAlias>;
@@ -1723,8 +2649,8 @@ export type StartJourneyDocumentPreviousAddress$Outbound = {
1723
2649
  subAdministrativeArea?: string | undefined;
1724
2650
  organization?: string | undefined;
1725
2651
  location?: StartJourneyDocumentPreviousAddressLocation$Outbound | undefined;
1726
- fromDate: string;
1727
- toDate: string;
2652
+ fromDate?: string | undefined;
2653
+ toDate?: string | undefined;
1728
2654
  };
1729
2655
  /** @internal */
1730
2656
  export declare const StartJourneyDocumentPreviousAddress$outboundSchema: z.ZodMiniType<StartJourneyDocumentPreviousAddress$Outbound, StartJourneyDocumentPreviousAddress>;
@@ -1815,6 +2741,7 @@ export type StartJourneyDocumentSubject$Outbound = {
1815
2741
  emails?: Array<StartJourneyDocumentEmail$Outbound> | undefined;
1816
2742
  socials?: Array<StartJourneyDocumentSocial$Outbound> | undefined;
1817
2743
  mothersMaidenName?: string | undefined;
2744
+ nationality?: string | undefined;
1818
2745
  };
1819
2746
  /** @internal */
1820
2747
  export declare const StartJourneyDocumentSubject$outboundSchema: z.ZodMiniType<StartJourneyDocumentSubject$Outbound, StartJourneyDocumentSubject>;
@@ -1822,7 +2749,7 @@ export declare function startJourneyDocumentSubjectToJSON(startJourneyDocumentSu
1822
2749
  /** @internal */
1823
2750
  export type StartJourneyDocument$Outbound = {
1824
2751
  oneDBarcode?: string | undefined;
1825
- address?: StartJourneyAddress$Outbound | undefined;
2752
+ address?: StartJourneyDocumentAddress$Outbound | undefined;
1826
2753
  applicationDate?: string | undefined;
1827
2754
  applicationNumber?: string | undefined;
1828
2755
  dateOfBirth?: string | undefined;
@@ -1894,13 +2821,15 @@ export type StartJourneyDocument$Outbound = {
1894
2821
  cardNumber?: string | undefined;
1895
2822
  issuerCountryCode?: string | undefined;
1896
2823
  id?: string | undefined;
1897
- type?: string | undefined;
2824
+ type: string;
1898
2825
  category?: string | undefined;
1899
2826
  subtype?: string | undefined;
1900
2827
  format?: string | undefined;
1901
2828
  device?: StartJourneyDocumentDevice$Outbound | undefined;
1902
2829
  side1Image?: string | undefined;
1903
2830
  side2Image?: string | undefined;
2831
+ side1Device?: StartJourneySide1Device$Outbound | undefined;
2832
+ side2Device?: StartJourneySide2Device$Outbound | undefined;
1904
2833
  chip?: StartJourneyChip$Outbound | undefined;
1905
2834
  classification?: StartJourneyClassification$Outbound | undefined;
1906
2835
  extraction?: StartJourneyExtraction$Outbound | undefined;
@@ -1908,13 +2837,65 @@ export type StartJourneyDocument$Outbound = {
1908
2837
  subType?: string | undefined;
1909
2838
  number?: string | undefined;
1910
2839
  expiryDate?: string | undefined;
2840
+ cardType?: string | undefined;
2841
+ expiryMonth?: string | undefined;
2842
+ cardColour?: string | undefined;
2843
+ cardStatus?: string | undefined;
1911
2844
  subject?: StartJourneyDocumentSubject$Outbound | undefined;
1912
2845
  country?: string | undefined;
2846
+ certificateFormat?: string | undefined;
2847
+ registrationNumber?: string | undefined;
2848
+ registrationDate?: string | undefined;
2849
+ registrationYear?: string | undefined;
2850
+ partyRole?: string | undefined;
2851
+ dateOfEvent?: string | undefined;
2852
+ acquisitionDate?: string | undefined;
2853
+ previousFirstName?: string | undefined;
2854
+ previousMiddleName?: string | undefined;
2855
+ previousSurname?: string | undefined;
2856
+ individualReferenceNumber?: string | undefined;
2857
+ nameLine1?: string | undefined;
2858
+ nameLine2?: string | undefined;
2859
+ nameLine3?: string | undefined;
2860
+ nameLine4?: string | undefined;
1913
2861
  };
1914
2862
  /** @internal */
1915
2863
  export declare const StartJourneyDocument$outboundSchema: z.ZodMiniType<StartJourneyDocument$Outbound, StartJourneyDocument>;
1916
2864
  export declare function startJourneyDocumentToJSON(startJourneyDocument: StartJourneyDocument): string;
1917
2865
  /** @internal */
2866
+ export declare const StartJourneyTypeOrphanedStoredFace$outboundSchema: z.ZodMiniEnum<typeof StartJourneyTypeOrphanedStoredFace>;
2867
+ /** @internal */
2868
+ export type StartJourneyBiometricOrphanedStoredFace$Outbound = {
2869
+ id?: string | undefined;
2870
+ type: string;
2871
+ templateReference: string;
2872
+ collectionReference?: string | undefined;
2873
+ };
2874
+ /** @internal */
2875
+ export declare const StartJourneyBiometricOrphanedStoredFace$outboundSchema: z.ZodMiniType<StartJourneyBiometricOrphanedStoredFace$Outbound, StartJourneyBiometricOrphanedStoredFace>;
2876
+ export declare function startJourneyBiometricOrphanedStoredFaceToJSON(startJourneyBiometricOrphanedStoredFace: StartJourneyBiometricOrphanedStoredFace): string;
2877
+ /** @internal */
2878
+ export declare const StartJourneyTypeStoredFace$outboundSchema: z.ZodMiniEnum<typeof StartJourneyTypeStoredFace>;
2879
+ /** @internal */
2880
+ export type StartJourneyBiometricStoredFace$Outbound = {
2881
+ id?: string | undefined;
2882
+ type: string;
2883
+ templateReference: string;
2884
+ collectionReference?: string | undefined;
2885
+ };
2886
+ /** @internal */
2887
+ export declare const StartJourneyBiometricStoredFace$outboundSchema: z.ZodMiniType<StartJourneyBiometricStoredFace$Outbound, StartJourneyBiometricStoredFace>;
2888
+ export declare function startJourneyBiometricStoredFaceToJSON(startJourneyBiometricStoredFace: StartJourneyBiometricStoredFace): string;
2889
+ /** @internal */
2890
+ export type StartJourneyBiometric5$Outbound = {
2891
+ id?: string | undefined;
2892
+ type?: string | undefined;
2893
+ anchorImage: string;
2894
+ };
2895
+ /** @internal */
2896
+ export declare const StartJourneyBiometric5$outboundSchema: z.ZodMiniType<StartJourneyBiometric5$Outbound, StartJourneyBiometric5>;
2897
+ export declare function startJourneyBiometric5ToJSON(startJourneyBiometric5: StartJourneyBiometric5): string;
2898
+ /** @internal */
1918
2899
  export type StartJourneyBiometric4$Outbound = {
1919
2900
  id?: string | undefined;
1920
2901
  type?: string | undefined;
@@ -1954,15 +2935,15 @@ export type StartJourneyBiometric1$Outbound = {
1954
2935
  export declare const StartJourneyBiometric1$outboundSchema: z.ZodMiniType<StartJourneyBiometric1$Outbound, StartJourneyBiometric1>;
1955
2936
  export declare function startJourneyBiometric1ToJSON(startJourneyBiometric1: StartJourneyBiometric1): string;
1956
2937
  /** @internal */
1957
- export type StartJourneyBiometricUnion$Outbound = StartJourneyBiometric1$Outbound | StartJourneyBiometric2$Outbound | StartJourneyBiometric3$Outbound | StartJourneyBiometric4$Outbound;
2938
+ export type StartJourneyBiometricUnion$Outbound = StartJourneyBiometric1$Outbound | StartJourneyBiometric2$Outbound | StartJourneyBiometricStoredFace$Outbound | StartJourneyBiometricOrphanedStoredFace$Outbound | StartJourneyBiometric3$Outbound | StartJourneyBiometric4$Outbound | StartJourneyBiometric5$Outbound;
1958
2939
  /** @internal */
1959
2940
  export declare const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<StartJourneyBiometricUnion$Outbound, StartJourneyBiometricUnion>;
1960
2941
  export declare function startJourneyBiometricUnionToJSON(startJourneyBiometricUnion: StartJourneyBiometricUnion): string;
1961
2942
  /** @internal */
1962
2943
  export type StartJourneyUser$Outbound = {
1963
2944
  id: string;
1964
- email: string;
1965
- domain: string;
2945
+ email?: string | undefined;
2946
+ domain?: string | undefined;
1966
2947
  };
1967
2948
  /** @internal */
1968
2949
  export declare const StartJourneyUser$outboundSchema: z.ZodMiniType<StartJourneyUser$Outbound, StartJourneyUser>;
@@ -2031,6 +3012,9 @@ export declare const StartJourneySessionAuth$outboundSchema: z.ZodMiniType<Start
2031
3012
  export declare function startJourneySessionAuthToJSON(startJourneySessionAuth: StartJourneySessionAuth): string;
2032
3013
  /** @internal */
2033
3014
  export type StartJourneySession$Outbound = {
3015
+ id?: string | undefined;
3016
+ type?: string | undefined;
3017
+ provider?: string | undefined;
2034
3018
  user?: StartJourneyUser$Outbound | undefined;
2035
3019
  client?: StartJourneyClient$Outbound | undefined;
2036
3020
  device?: StartJourneySessionDevice$Outbound | undefined;
@@ -2065,7 +3049,7 @@ export declare function startJourneyConsentToJSON(startJourneyConsent: StartJour
2065
3049
  /** @internal */
2066
3050
  export type StartJourneyAccount$Outbound = {
2067
3051
  type: string;
2068
- accountNumber: string;
3052
+ accountNumber?: string | undefined;
2069
3053
  sortCode?: string | undefined;
2070
3054
  routingNumber?: string | undefined;
2071
3055
  iban?: string | undefined;
@@ -2079,44 +3063,162 @@ export type StartJourneyAccount$Outbound = {
2079
3063
  export declare const StartJourneyAccount$outboundSchema: z.ZodMiniType<StartJourneyAccount$Outbound, StartJourneyAccount>;
2080
3064
  export declare function startJourneyAccountToJSON(startJourneyAccount: StartJourneyAccount): string;
2081
3065
  /** @internal */
2082
- export type StartJourneySubject$Outbound = {
3066
+ export type StartJourneyChoice$Outbound = {
3067
+ label: string;
3068
+ text: string;
3069
+ };
3070
+ /** @internal */
3071
+ export declare const StartJourneyChoice$outboundSchema: z.ZodMiniType<StartJourneyChoice$Outbound, StartJourneyChoice>;
3072
+ export declare function startJourneyChoiceToJSON(startJourneyChoice: StartJourneyChoice): string;
3073
+ /** @internal */
3074
+ export type StartJourneyQuestion$Outbound = {
3075
+ id: number;
3076
+ questionText: string;
3077
+ helpText?: string | undefined;
3078
+ choices: Array<StartJourneyChoice$Outbound>;
3079
+ };
3080
+ /** @internal */
3081
+ export declare const StartJourneyQuestion$outboundSchema: z.ZodMiniType<StartJourneyQuestion$Outbound, StartJourneyQuestion>;
3082
+ export declare function startJourneyQuestionToJSON(startJourneyQuestion: StartJourneyQuestion): string;
3083
+ /** @internal */
3084
+ export type StartJourneyAnswer$Outbound = {
3085
+ id: number;
3086
+ choices: Array<string>;
3087
+ };
3088
+ /** @internal */
3089
+ export declare const StartJourneyAnswer$outboundSchema: z.ZodMiniType<StartJourneyAnswer$Outbound, StartJourneyAnswer>;
3090
+ export declare function startJourneyAnswerToJSON(startJourneyAnswer: StartJourneyAnswer): string;
3091
+ /** @internal */
3092
+ export type StartJourneyKba$Outbound = {
3093
+ questions: Array<StartJourneyQuestion$Outbound>;
3094
+ answers: Array<StartJourneyAnswer$Outbound>;
3095
+ };
3096
+ /** @internal */
3097
+ export declare const StartJourneyKba$outboundSchema: z.ZodMiniType<StartJourneyKba$Outbound, StartJourneyKba>;
3098
+ export declare function startJourneyKbaToJSON(startJourneyKba: StartJourneyKba): string;
3099
+ /** @internal */
3100
+ export declare const StartJourneyOffered$outboundSchema: z.ZodMiniEnum<typeof StartJourneyOffered>;
3101
+ /** @internal */
3102
+ export declare const StartJourneySelected$outboundSchema: z.ZodMiniEnum<typeof StartJourneySelected>;
3103
+ /** @internal */
3104
+ export type StartJourneyDocumentTypeSelection$Outbound = {
3105
+ offered?: Array<string> | undefined;
3106
+ selected?: string | undefined;
3107
+ };
3108
+ /** @internal */
3109
+ export declare const StartJourneyDocumentTypeSelection$outboundSchema: z.ZodMiniType<StartJourneyDocumentTypeSelection$Outbound, StartJourneyDocumentTypeSelection>;
3110
+ export declare function startJourneyDocumentTypeSelectionToJSON(startJourneyDocumentTypeSelection: StartJourneyDocumentTypeSelection): string;
3111
+ /** @internal */
3112
+ export type StartJourneyContextSubject$Outbound = {
2083
3113
  identity?: StartJourneyIdentity$Outbound | undefined;
3114
+ entities?: Array<StartJourneyEntity$Outbound> | undefined;
2084
3115
  documents?: Array<StartJourneyDocument$Outbound> | undefined;
2085
- biometrics?: Array<StartJourneyBiometric1$Outbound | StartJourneyBiometric2$Outbound | StartJourneyBiometric3$Outbound | StartJourneyBiometric4$Outbound> | undefined;
3116
+ biometrics?: Array<StartJourneyBiometric1$Outbound | StartJourneyBiometric2$Outbound | StartJourneyBiometricStoredFace$Outbound | StartJourneyBiometricOrphanedStoredFace$Outbound | StartJourneyBiometric3$Outbound | StartJourneyBiometric4$Outbound | StartJourneyBiometric5$Outbound> | undefined;
2086
3117
  sessions?: Array<StartJourneySession$Outbound> | undefined;
2087
3118
  consent?: Array<StartJourneyConsent$Outbound> | undefined;
2088
3119
  accounts?: Array<StartJourneyAccount$Outbound> | undefined;
3120
+ kba?: StartJourneyKba$Outbound | undefined;
3121
+ documentTypeSelection?: StartJourneyDocumentTypeSelection$Outbound | undefined;
2089
3122
  uid?: string | undefined;
2090
3123
  };
2091
3124
  /** @internal */
2092
- export declare const StartJourneySubject$outboundSchema: z.ZodMiniType<StartJourneySubject$Outbound, StartJourneySubject>;
2093
- export declare function startJourneySubjectToJSON(startJourneySubject: StartJourneySubject): string;
3125
+ export declare const StartJourneyContextSubject$outboundSchema: z.ZodMiniType<StartJourneyContextSubject$Outbound, StartJourneyContextSubject>;
3126
+ export declare function startJourneyContextSubjectToJSON(startJourneyContextSubject: StartJourneyContextSubject): string;
3127
+ /** @internal */
3128
+ export declare const ResumeMode$outboundSchema: z.ZodMiniEnum<typeof ResumeMode>;
3129
+ /** @internal */
3130
+ export type Reminders$Outbound = {
3131
+ intervalMinutes: number;
3132
+ maxReminders: number;
3133
+ };
3134
+ /** @internal */
3135
+ export declare const Reminders$outboundSchema: z.ZodMiniType<Reminders$Outbound, Reminders>;
3136
+ export declare function remindersToJSON(reminders: Reminders): string;
3137
+ /** @internal */
3138
+ export type LinkConfig$Outbound = {
3139
+ ttlMinutes?: number | undefined;
3140
+ resumeMode?: string | undefined;
3141
+ resumeExpiryMinutes?: number | undefined;
3142
+ reminders?: Reminders$Outbound | undefined;
3143
+ };
3144
+ /** @internal */
3145
+ export declare const LinkConfig$outboundSchema: z.ZodMiniType<LinkConfig$Outbound, LinkConfig>;
3146
+ export declare function linkConfigToJSON(linkConfig: LinkConfig): string;
3147
+ /** @internal */
3148
+ export type Overlay$Outbound = {
3149
+ version: string;
3150
+ };
3151
+ /** @internal */
3152
+ export declare const Overlay$outboundSchema: z.ZodMiniType<Overlay$Outbound, Overlay>;
3153
+ export declare function overlayToJSON(overlay: Overlay): string;
3154
+ /** @internal */
3155
+ export type Config$Outbound = {
3156
+ delivery: string;
3157
+ branding?: any | undefined;
3158
+ assisted?: boolean | undefined;
3159
+ inlineResult?: boolean | undefined;
3160
+ syncWaitSeconds?: number | undefined;
3161
+ linkConfig?: LinkConfig$Outbound | undefined;
3162
+ overlay?: Overlay$Outbound | undefined;
3163
+ [additionalProperties: string]: unknown;
3164
+ };
3165
+ /** @internal */
3166
+ export declare const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config>;
3167
+ export declare function configToJSON(config: Config): string;
2094
3168
  /** @internal */
2095
3169
  export type StartJourneyContext$Outbound = {
3170
+ subject?: StartJourneyContextSubject$Outbound | undefined;
2096
3171
  config: Config$Outbound;
2097
- subject: StartJourneySubject$Outbound;
3172
+ [additionalProperties: string]: unknown;
2098
3173
  };
2099
3174
  /** @internal */
2100
3175
  export declare const StartJourneyContext$outboundSchema: z.ZodMiniType<StartJourneyContext$Outbound, StartJourneyContext>;
2101
3176
  export declare function startJourneyContextToJSON(startJourneyContext: StartJourneyContext): string;
2102
3177
  /** @internal */
2103
- export type StartJourneyRequest$Outbound = {
2104
- resourceId: string;
2105
- context?: StartJourneyContext$Outbound | undefined;
2106
- data?: {
3178
+ export type ModulesSubject$Outbound = {};
3179
+ /** @internal */
3180
+ export declare const ModulesSubject$outboundSchema: z.ZodMiniType<ModulesSubject$Outbound, ModulesSubject>;
3181
+ export declare function modulesSubjectToJSON(modulesSubject: ModulesSubject): string;
3182
+ /** @internal */
3183
+ export type Modules$Outbound = {
3184
+ outcome: string;
3185
+ advice?: {
2107
3186
  [k: string]: any;
2108
3187
  } | undefined;
3188
+ subject?: ModulesSubject$Outbound | undefined;
3189
+ [additionalProperties: string]: unknown;
2109
3190
  };
2110
3191
  /** @internal */
2111
- export declare const StartJourneyRequest$outboundSchema: z.ZodMiniType<StartJourneyRequest$Outbound, StartJourneyRequest>;
2112
- export declare function startJourneyRequestToJSON(startJourneyRequest: StartJourneyRequest): string;
3192
+ export declare const Modules$outboundSchema: z.ZodMiniType<Modules$Outbound, Modules>;
3193
+ export declare function modulesToJSON(modules: Modules): string;
3194
+ /** @internal */
3195
+ export type DefaultSubject$Outbound = {};
3196
+ /** @internal */
3197
+ export declare const DefaultSubject$outboundSchema: z.ZodMiniType<DefaultSubject$Outbound, DefaultSubject>;
3198
+ export declare function defaultSubjectToJSON(defaultSubject: DefaultSubject): string;
3199
+ /** @internal */
3200
+ export type Scenario$Outbound = {
3201
+ modules: {
3202
+ [k: string]: Modules$Outbound;
3203
+ };
3204
+ defaultOutcome?: string | undefined;
3205
+ defaultAdvice?: {
3206
+ [k: string]: any;
3207
+ } | undefined;
3208
+ defaultSubject?: DefaultSubject$Outbound | undefined;
3209
+ description?: string | undefined;
3210
+ [additionalProperties: string]: unknown;
3211
+ };
2113
3212
  /** @internal */
2114
- export declare const StartJourneyResponseBody2$inboundSchema: z.ZodMiniType<StartJourneyResponseBody2, unknown>;
2115
- export declare function startJourneyResponseBody2FromJSON(jsonString: string): SafeParseResult<StartJourneyResponseBody2, SDKValidationError>;
3213
+ export declare const Scenario$outboundSchema: z.ZodMiniType<Scenario$Outbound, Scenario>;
3214
+ export declare function scenarioToJSON(scenario: Scenario): string;
2116
3215
  /** @internal */
2117
- export declare const StartJourneyResponseBody1$inboundSchema: z.ZodMiniType<StartJourneyResponseBody1, unknown>;
2118
- export declare function startJourneyResponseBody1FromJSON(jsonString: string): SafeParseResult<StartJourneyResponseBody1, SDKValidationError>;
3216
+ export type StartJourneyRequest$Outbound = {
3217
+ resourceId: string;
3218
+ context: StartJourneyContext$Outbound;
3219
+ scenario?: Scenario$Outbound | undefined;
3220
+ };
2119
3221
  /** @internal */
2120
- export declare const StartJourneyResponse$inboundSchema: z.ZodMiniType<StartJourneyResponse, unknown>;
2121
- export declare function startJourneyResponseFromJSON(jsonString: string): SafeParseResult<StartJourneyResponse, SDKValidationError>;
3222
+ export declare const StartJourneyRequest$outboundSchema: z.ZodMiniType<StartJourneyRequest$Outbound, StartJourneyRequest>;
3223
+ export declare function startJourneyRequestToJSON(startJourneyRequest: StartJourneyRequest): string;
2122
3224
  //# sourceMappingURL=start-journey.d.ts.map