@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
@@ -3,31 +3,8 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v4-mini";
6
- import { safeParse } from "../../lib/schemas.js";
7
6
  import { ClosedEnum } from "../../types/enums.js";
8
- import { Result as SafeParseResult } from "../../types/fp.js";
9
- import * as types from "../../types/primitives.js";
10
7
  import { smartUnion } from "../../types/smart-union.js";
11
- import { SDKValidationError } from "../errors/sdk-validation-error.js";
12
-
13
- /**
14
- * The method by which the End User will consume the journey.
15
- */
16
- export const Delivery = {
17
- Page: "page",
18
- Api: "api",
19
- } as const;
20
- /**
21
- * The method by which the End User will consume the journey.
22
- */
23
- export type Delivery = ClosedEnum<typeof Delivery>;
24
-
25
- export type Config = {
26
- /**
27
- * The method by which the End User will consume the journey.
28
- */
29
- delivery: Delivery;
30
- };
31
8
 
32
9
  export type StartJourneyIdentityAlias = {
33
10
  /**
@@ -50,11 +27,16 @@ export type StartJourneyIdentityAlias = {
50
27
  * Any family names for the individual
51
28
  */
52
29
  lastNamesAtBirth?: Array<string> | undefined;
30
+ /**
31
+ * The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
32
+ */
33
+ fullName?: string | undefined;
53
34
  };
54
35
 
55
36
  export const StartJourneyIdentityRelationship = {
56
37
  Mother: "mother",
57
38
  Father: "father",
39
+ Spouse: "spouse",
58
40
  MaternalGrandFather: "maternalGrandFather",
59
41
  MaternalGrandMother: "maternalGrandMother",
60
42
  PaternalGrandFather: "paternalGrandFather",
@@ -108,15 +90,15 @@ export type StartJourneyIdentityCurrentAddress = {
108
90
  */
109
91
  addressString?: string | undefined;
110
92
  /**
111
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
93
+ * 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.
112
94
  */
113
95
  premise?: string | undefined;
114
96
  /**
115
- * The name of a building or a building complex. In the US, this is the street number.
97
+ * 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.
116
98
  */
117
99
  building?: string | undefined;
118
100
  /**
119
- * The name of a sub-building, such as a flat or apartment number.
101
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
120
102
  */
121
103
  subBuilding?: string | undefined;
122
104
  /**
@@ -178,15 +160,15 @@ export type StartJourneyIdentityPreviousAddress = {
178
160
  */
179
161
  addressString?: string | undefined;
180
162
  /**
181
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
163
+ * 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.
182
164
  */
183
165
  premise?: string | undefined;
184
166
  /**
185
- * The name of a building or a building complex. In the US, this is the street number.
167
+ * 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.
186
168
  */
187
169
  building?: string | undefined;
188
170
  /**
189
- * The name of a sub-building, such as a flat or apartment number.
171
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
190
172
  */
191
173
  subBuilding?: string | undefined;
192
174
  /**
@@ -229,11 +211,11 @@ export type StartJourneyIdentityPreviousAddress = {
229
211
  /**
230
212
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
231
213
  */
232
- fromDate: string;
214
+ fromDate?: string | undefined;
233
215
  /**
234
216
  * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
235
217
  */
236
- toDate: string;
218
+ toDate?: string | undefined;
237
219
  };
238
220
 
239
221
  export type StartJourneyIdentityPlaceOfBirthLocation = {
@@ -256,15 +238,15 @@ export type StartJourneyIdentityPlaceOfBirth = {
256
238
  */
257
239
  addressString?: string | undefined;
258
240
  /**
259
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
241
+ * 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.
260
242
  */
261
243
  premise?: string | undefined;
262
244
  /**
263
- * The name of a building or a building complex. In the US, this is the street number.
245
+ * 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.
264
246
  */
265
247
  building?: string | undefined;
266
248
  /**
267
- * The name of a sub-building, such as a flat or apartment number.
249
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
268
250
  */
269
251
  subBuilding?: string | undefined;
270
252
  /**
@@ -334,7 +316,7 @@ export type StartJourneyIdentityPhone = {
334
316
 
335
317
  export type StartJourneyIdentityEmail = {
336
318
  /**
337
- * The type of email, such as home, work, unknown etc
319
+ * 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').
338
320
  */
339
321
  type: string;
340
322
  /**
@@ -375,6 +357,9 @@ export type StartJourneyIdentity = {
375
357
  * Any family names for the individual
376
358
  */
377
359
  lastNamesAtBirth?: Array<string> | undefined;
360
+ /**
361
+ * Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
362
+ */
378
363
  aliases?: Array<StartJourneyIdentityAlias> | undefined;
379
364
  relatedPersons?: Array<StartJourneyIdentityRelatedPerson> | undefined;
380
365
  /**
@@ -393,299 +378,230 @@ export type StartJourneyIdentity = {
393
378
  * The subject's mother's maiden name, used for identity verification
394
379
  */
395
380
  mothersMaidenName?: string | undefined;
381
+ /**
382
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
383
+ */
384
+ nationality?: string | undefined;
396
385
  };
397
386
 
398
- export type StartJourneyAddress = {
399
- addressString?: string | undefined;
400
- extractedAddressString?: string | undefined;
401
- addressLine1?: string | undefined;
402
- addressLine2?: string | undefined;
403
- locality?: string | undefined;
404
- administrativeArea?: string | undefined;
405
- postalCode?: string | undefined;
406
- };
407
-
408
- export type StartJourneyDocumentDevice = {
409
- type?: string | undefined;
410
- model?: string | undefined;
411
- hasContactlessReader?: boolean | undefined;
412
- hasMagneticStripeReader?: boolean | undefined;
413
- hasCamera?: boolean | undefined;
414
- serialNumber?: string | undefined;
415
- manufacturer?: string | undefined;
416
- };
387
+ export const StartJourneyTypePrimary1 = {
388
+ Primary: "primary",
389
+ } as const;
390
+ export type StartJourneyTypePrimary1 = ClosedEnum<
391
+ typeof StartJourneyTypePrimary1
392
+ >;
417
393
 
418
- export const StartJourneyName = {
419
- Com: "COM",
420
- Sod: "SOD",
421
- Dg1: "DG1",
422
- Dg2: "DG2",
423
- Dg3: "DG3",
424
- Dg4: "DG4",
425
- Dg5: "DG5",
426
- Dg6: "DG6",
427
- Dg7: "DG7",
428
- Dg8: "DG8",
429
- Dg9: "DG9",
430
- Dg10: "DG10",
431
- Dg11: "DG11",
432
- Dg12: "DG12",
433
- Dg13: "DG13",
434
- Dg14: "DG14",
435
- Dg15: "DG15",
394
+ export const StartJourneyStatus = {
395
+ Active: "active",
396
+ Suspended: "suspended",
397
+ Dormant: "dormant",
398
+ Dissolved: "dissolved",
399
+ StruckOff: "struckOff",
400
+ Unknown: "unknown",
436
401
  } as const;
437
- export type StartJourneyName = ClosedEnum<typeof StartJourneyName>;
402
+ export type StartJourneyStatus = ClosedEnum<typeof StartJourneyStatus>;
438
403
 
439
- export type StartJourneyLd = {
440
- name: StartJourneyName;
441
- data: string;
442
- [additionalProperties: string]: unknown;
404
+ export type StartJourneyAddressLocation = {
405
+ latitude?: string | undefined;
406
+ longitude?: string | undefined;
407
+ geoAccuracy?: string | undefined;
408
+ /**
409
+ * A What3words designation associated with this location with '.' separator.
410
+ */
411
+ what3words?: string | undefined;
443
412
  };
444
413
 
445
- export const StartJourneyAuthType = {
446
- ActiveAuthentication: "ActiveAuthentication",
447
- BasicAccessControl: "BasicAccessControl",
448
- ChipAuthentication: "ChipAuthentication",
449
- PassiveAuthentication: "PassiveAuthentication",
450
- SupplementalAccessControl: "SupplementalAccessControl",
451
- ExtendedAccessControl: "ExtendedAccessControl",
452
- TerminalAuthentication: "TerminalAuthentication",
414
+ export const StartJourneyPurpose = {
415
+ Registered: "registered",
416
+ Mailing: "mailing",
417
+ Site: "site",
418
+ Agent: "agent",
419
+ Headquarters: "headquarters",
453
420
  } as const;
454
- export type StartJourneyAuthType = ClosedEnum<typeof StartJourneyAuthType>;
421
+ export type StartJourneyPurpose = ClosedEnum<typeof StartJourneyPurpose>;
455
422
 
456
- export const StartJourneyResult = {
457
- Success: "Success",
458
- Failure: "Failure",
459
- Skipped: "Skipped",
423
+ export type StartJourneyAddressPrimary = {
424
+ /**
425
+ * Unformatted line based address
426
+ */
427
+ lines?: Array<string> | undefined;
428
+ /**
429
+ * The address as a single line
430
+ */
431
+ addressString?: string | undefined;
432
+ /**
433
+ * 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.
434
+ */
435
+ premise?: string | undefined;
436
+ /**
437
+ * 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.
438
+ */
439
+ building?: string | undefined;
440
+ /**
441
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
442
+ */
443
+ subBuilding?: string | undefined;
444
+ /**
445
+ * This field holds the most common street or block data element within a country. For instance, USA Street
446
+ */
447
+ thoroughfare?: string | undefined;
448
+ /**
449
+ * The name of a dependent street or block, such as a street within a complex.
450
+ */
451
+ dependentThoroughfare?: string | undefined;
452
+ /**
453
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
454
+ */
455
+ locality?: string | undefined;
456
+ /**
457
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
458
+ */
459
+ dependentLocality?: string | undefined;
460
+ /**
461
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
462
+ */
463
+ doubleDependentLocality?: string | undefined;
464
+ /**
465
+ * 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
466
+ */
467
+ postalCode?: string | undefined;
468
+ /**
469
+ * This field contains the post box number associated with a particular delivery point, should one exist.
470
+ */
471
+ postBox?: string | undefined;
472
+ /**
473
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
474
+ */
475
+ country?: string | undefined;
476
+ superAdministrativeArea?: string | undefined;
477
+ administrativeArea?: string | undefined;
478
+ subAdministrativeArea?: string | undefined;
479
+ organization?: string | undefined;
480
+ location?: StartJourneyAddressLocation | undefined;
481
+ purpose?: StartJourneyPurpose | undefined;
482
+ };
483
+
484
+ export const StartJourneyTaxIdentifierType = {
485
+ Tin: "TIN",
486
+ Ein: "EIN",
460
487
  } as const;
461
- export type StartJourneyResult = ClosedEnum<typeof StartJourneyResult>;
488
+ export type StartJourneyTaxIdentifierType = ClosedEnum<
489
+ typeof StartJourneyTaxIdentifierType
490
+ >;
462
491
 
463
- export type StartJourneyChipAuth = {
464
- type: StartJourneyAuthType;
465
- result: StartJourneyResult;
466
- [additionalProperties: string]: unknown;
492
+ export type StartJourneyTaxIdentifier = {
493
+ type: StartJourneyTaxIdentifierType;
494
+ value: string;
495
+ /**
496
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
497
+ */
498
+ country?: string | undefined;
467
499
  };
468
500
 
469
- export type StartJourneyChip = {
470
- lds: Array<StartJourneyLd>;
471
- auth: Array<StartJourneyChipAuth>;
472
- [additionalProperties: string]: unknown;
473
- };
501
+ export const StartJourneySystem = {
502
+ Naics2017: "naics2017",
503
+ Naics2022: "naics2022",
504
+ Sic: "sic",
505
+ Mcc: "mcc",
506
+ } as const;
507
+ export type StartJourneySystem = ClosedEnum<typeof StartJourneySystem>;
474
508
 
475
- export type StartJourneySide = {
476
- side: string;
477
- id: string;
478
- documentQuality: string;
479
- documentQualityScore: number;
509
+ export type StartJourneyIndustryClassification = {
510
+ system: StartJourneySystem;
511
+ code: string;
512
+ description?: string | undefined;
480
513
  };
481
514
 
482
- export type StartJourneyClassification = {
483
- ids?: Array<string> | undefined;
484
- category?: string | undefined;
485
- type?: string | undefined;
486
- subtype?: string | undefined;
487
- isDoubleSided?: boolean | undefined;
488
- hasNFC?: boolean | undefined;
489
- year?: string | undefined;
490
- countryCode?: string | undefined;
491
- countryName?: string | undefined;
492
- stateCode?: string | undefined;
493
- stateName?: string | undefined;
494
- sides?: Array<StartJourneySide> | undefined;
515
+ export const StartJourneyRegistrationType = {
516
+ Domestic: "domestic",
517
+ Foreign: "foreign",
518
+ Unknown: "unknown",
519
+ } as const;
520
+ export type StartJourneyRegistrationType = ClosedEnum<
521
+ typeof StartJourneyRegistrationType
522
+ >;
523
+
524
+ export type StartJourneyRegisteredAddressLocation = {
525
+ latitude?: string | undefined;
526
+ longitude?: string | undefined;
527
+ geoAccuracy?: string | undefined;
528
+ /**
529
+ * A What3words designation associated with this location with '.' separator.
530
+ */
531
+ what3words?: string | undefined;
495
532
  };
496
533
 
497
- export type StartJourneyAggregatedFieldBoundingBox = {
498
- x: number;
499
- y: number;
500
- width: number;
501
- height: number;
534
+ export type StartJourneyRegisteredAddress = {
535
+ /**
536
+ * Unformatted line based address
537
+ */
538
+ lines?: Array<string> | undefined;
539
+ /**
540
+ * The address as a single line
541
+ */
542
+ addressString?: string | undefined;
543
+ /**
544
+ * 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.
545
+ */
546
+ premise?: string | undefined;
547
+ /**
548
+ * 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.
549
+ */
550
+ building?: string | undefined;
551
+ /**
552
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
553
+ */
554
+ subBuilding?: string | undefined;
555
+ /**
556
+ * This field holds the most common street or block data element within a country. For instance, USA Street
557
+ */
558
+ thoroughfare?: string | undefined;
559
+ /**
560
+ * The name of a dependent street or block, such as a street within a complex.
561
+ */
562
+ dependentThoroughfare?: string | undefined;
563
+ /**
564
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
565
+ */
566
+ locality?: string | undefined;
567
+ /**
568
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
569
+ */
570
+ dependentLocality?: string | undefined;
571
+ /**
572
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
573
+ */
574
+ doubleDependentLocality?: string | undefined;
575
+ /**
576
+ * 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
577
+ */
578
+ postalCode?: string | undefined;
579
+ /**
580
+ * This field contains the post box number associated with a particular delivery point, should one exist.
581
+ */
582
+ postBox?: string | undefined;
583
+ /**
584
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
585
+ */
586
+ country?: string | undefined;
587
+ superAdministrativeArea?: string | undefined;
588
+ administrativeArea?: string | undefined;
589
+ subAdministrativeArea?: string | undefined;
590
+ organization?: string | undefined;
591
+ location?: StartJourneyRegisteredAddressLocation | undefined;
502
592
  };
503
593
 
504
- export type StartJourneyAggregatedFieldRegionOfInterest = {
505
- boundingBox?: StartJourneyAggregatedFieldBoundingBox | undefined;
506
- side: string;
507
- spectrum?: string | undefined;
508
- imageId?: string | undefined;
594
+ export type StartJourneyAgentAddressLocation = {
595
+ latitude?: string | undefined;
596
+ longitude?: string | undefined;
597
+ geoAccuracy?: string | undefined;
598
+ /**
599
+ * A What3words designation associated with this location with '.' separator.
600
+ */
601
+ what3words?: string | undefined;
509
602
  };
510
603
 
511
- export type StartJourneyAggregatedField = {
512
- label: string;
513
- value: string;
514
- source: string;
515
- isNonLatin: boolean;
516
- regionOfInterest?: StartJourneyAggregatedFieldRegionOfInterest | undefined;
517
- };
518
-
519
- export type StartJourneyDetailBoundingBox = {
520
- x: number;
521
- y: number;
522
- width: number;
523
- height: number;
524
- };
525
-
526
- export type StartJourneyDetailRegionOfInterest = {
527
- boundingBox?: StartJourneyDetailBoundingBox | undefined;
528
- side: string;
529
- spectrum?: string | undefined;
530
- imageId?: string | undefined;
531
- };
532
-
533
- export type StartJourneyDetail = {
534
- label: string;
535
- value: string;
536
- source: string;
537
- isNonLatin: boolean;
538
- regionOfInterest?: StartJourneyDetailRegionOfInterest | undefined;
539
- };
540
-
541
- export type StartJourneyExtractedField = {
542
- label: string;
543
- details: Array<StartJourneyDetail>;
544
- };
545
-
546
- export type StartJourneyExtractedImage = {
547
- label: string;
548
- side: string;
549
- imageID: string;
550
- };
551
-
552
- export type StartJourneyExtraction = {
553
- aggregatedFields?: Array<StartJourneyAggregatedField> | undefined;
554
- extractedFields?: Array<StartJourneyExtractedField> | undefined;
555
- extractedImages?: Array<StartJourneyExtractedImage> | undefined;
556
- };
557
-
558
- export type StartJourneyValidationCheckBoundingBox = {
559
- x: number;
560
- y: number;
561
- width: number;
562
- height: number;
563
- };
564
-
565
- export type StartJourneyValidationCheckRegionOfInterest = {
566
- boundingBox?: StartJourneyValidationCheckBoundingBox | undefined;
567
- side: string;
568
- spectrum?: string | undefined;
569
- imageId?: string | undefined;
570
- };
571
-
572
- export type StartJourneyValidationCheck = {
573
- name: string;
574
- title: string;
575
- info: string;
576
- validationResult: string;
577
- resultInfo: string;
578
- weight: string;
579
- regionOfInterests?:
580
- | Array<StartJourneyValidationCheckRegionOfInterest>
581
- | undefined;
582
- type: string;
583
- };
584
-
585
- export type StartJourneyAggregatedValidationCheckBoundingBox = {
586
- x: number;
587
- y: number;
588
- width: number;
589
- height: number;
590
- };
591
-
592
- export type StartJourneyAggregatedValidationCheckRegionOfInterest = {
593
- boundingBox?: StartJourneyAggregatedValidationCheckBoundingBox | undefined;
594
- side: string;
595
- spectrum?: string | undefined;
596
- imageId?: string | undefined;
597
- };
598
-
599
- export type StartJourneyAggregatedValidationCheck = {
600
- name: string;
601
- title: string;
602
- info: string;
603
- validationResult: string;
604
- resultInfo: string;
605
- weight: string;
606
- regionOfInterests?:
607
- | Array<StartJourneyAggregatedValidationCheckRegionOfInterest>
608
- | undefined;
609
- type: string;
610
- };
611
-
612
- export type StartJourneyValidation = {
613
- validationChecks?: Array<StartJourneyValidationCheck> | undefined;
614
- aggregatedValidationChecks?:
615
- | Array<StartJourneyAggregatedValidationCheck>
616
- | undefined;
617
- };
618
-
619
- export type StartJourneyDocumentAlias = {
620
- /**
621
- * Title of an individual such as Mr, Mrs, Dr, Sir
622
- */
623
- title?: string | undefined;
624
- /**
625
- * A person's name used by their collegues and friends to address them
626
- */
627
- firstName?: string | undefined;
628
- /**
629
- * Any other registered names used by the individual, not aliases
630
- */
631
- middleNames?: Array<string> | undefined;
632
- /**
633
- * Any family names for the individual
634
- */
635
- lastNames?: Array<string> | undefined;
636
- /**
637
- * Any family names for the individual
638
- */
639
- lastNamesAtBirth?: Array<string> | undefined;
640
- };
641
-
642
- export const StartJourneyDocumentRelationship = {
643
- Mother: "mother",
644
- Father: "father",
645
- MaternalGrandFather: "maternalGrandFather",
646
- MaternalGrandMother: "maternalGrandMother",
647
- PaternalGrandFather: "paternalGrandFather",
648
- PaternalGrandMother: "paternalGrandMother",
649
- } as const;
650
- export type StartJourneyDocumentRelationship = ClosedEnum<
651
- typeof StartJourneyDocumentRelationship
652
- >;
653
-
654
- export type StartJourneyDocumentRelatedPerson = {
655
- /**
656
- * Title of an individual such as Mr, Mrs, Dr, Sir
657
- */
658
- title?: string | undefined;
659
- /**
660
- * A person's name used by their collegues and friends to address them
661
- */
662
- firstName?: string | undefined;
663
- /**
664
- * Any other registered names used by the individual, not aliases
665
- */
666
- middleNames?: Array<string> | undefined;
667
- /**
668
- * Any family names for the individual
669
- */
670
- lastNames?: Array<string> | undefined;
671
- /**
672
- * Any family names for the individual
673
- */
674
- lastNamesAtBirth?: Array<string> | undefined;
675
- relationship: StartJourneyDocumentRelationship;
676
- };
677
-
678
- export type StartJourneyDocumentCurrentAddressLocation = {
679
- latitude?: string | undefined;
680
- longitude?: string | undefined;
681
- geoAccuracy?: string | undefined;
682
- /**
683
- * A What3words designation associated with this location with '.' separator.
684
- */
685
- what3words?: string | undefined;
686
- };
687
-
688
- export type StartJourneyDocumentCurrentAddress = {
604
+ export type StartJourneyAgentAddress = {
689
605
  /**
690
606
  * Unformatted line based address
691
607
  */
@@ -695,15 +611,15 @@ export type StartJourneyDocumentCurrentAddress = {
695
611
  */
696
612
  addressString?: string | undefined;
697
613
  /**
698
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
614
+ * 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.
699
615
  */
700
616
  premise?: string | undefined;
701
617
  /**
702
- * The name of a building or a building complex. In the US, this is the street number.
618
+ * 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.
703
619
  */
704
620
  building?: string | undefined;
705
621
  /**
706
- * The name of a sub-building, such as a flat or apartment number.
622
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
707
623
  */
708
624
  subBuilding?: string | undefined;
709
625
  /**
@@ -742,10 +658,40 @@ export type StartJourneyDocumentCurrentAddress = {
742
658
  administrativeArea?: string | undefined;
743
659
  subAdministrativeArea?: string | undefined;
744
660
  organization?: string | undefined;
745
- location?: StartJourneyDocumentCurrentAddressLocation | undefined;
661
+ location?: StartJourneyAgentAddressLocation | undefined;
746
662
  };
747
663
 
748
- export type StartJourneyDocumentPreviousAddressLocation = {
664
+ export type StartJourneyRegistration = {
665
+ jurisdiction?: string | undefined;
666
+ registrationType?: StartJourneyRegistrationType | undefined;
667
+ fileNumber?: string | undefined;
668
+ /**
669
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
670
+ */
671
+ issueDate?: string | undefined;
672
+ registeredAddress?: StartJourneyRegisteredAddress | undefined;
673
+ agentName?: string | undefined;
674
+ agentAddress?: StartJourneyAgentAddress | undefined;
675
+ };
676
+
677
+ export const StartJourneyTypePrimary2 = {
678
+ Primary: "primary",
679
+ } as const;
680
+ export type StartJourneyTypePrimary2 = ClosedEnum<
681
+ typeof StartJourneyTypePrimary2
682
+ >;
683
+
684
+ export const StartJourneyRole = {
685
+ UltimateBeneficialOwner: "ultimateBeneficialOwner",
686
+ Director: "director",
687
+ Officer: "officer",
688
+ Secretary: "secretary",
689
+ Shareholder: "shareholder",
690
+ Partner: "partner",
691
+ } as const;
692
+ export type StartJourneyRole = ClosedEnum<typeof StartJourneyRole>;
693
+
694
+ export type StartJourneyCurrentAddressLocationPrimary = {
749
695
  latitude?: string | undefined;
750
696
  longitude?: string | undefined;
751
697
  geoAccuracy?: string | undefined;
@@ -755,7 +701,7 @@ export type StartJourneyDocumentPreviousAddressLocation = {
755
701
  what3words?: string | undefined;
756
702
  };
757
703
 
758
- export type StartJourneyDocumentPreviousAddress = {
704
+ export type StartJourneyCurrentAddressPrimary = {
759
705
  /**
760
706
  * Unformatted line based address
761
707
  */
@@ -765,15 +711,15 @@ export type StartJourneyDocumentPreviousAddress = {
765
711
  */
766
712
  addressString?: string | undefined;
767
713
  /**
768
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
714
+ * 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.
769
715
  */
770
716
  premise?: string | undefined;
771
717
  /**
772
- * The name of a building or a building complex. In the US, this is the street number.
718
+ * 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.
773
719
  */
774
720
  building?: string | undefined;
775
721
  /**
776
- * The name of a sub-building, such as a flat or apartment number.
722
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
777
723
  */
778
724
  subBuilding?: string | undefined;
779
725
  /**
@@ -812,583 +758,1955 @@ export type StartJourneyDocumentPreviousAddress = {
812
758
  administrativeArea?: string | undefined;
813
759
  subAdministrativeArea?: string | undefined;
814
760
  organization?: string | undefined;
815
- location?: StartJourneyDocumentPreviousAddressLocation | undefined;
816
- /**
817
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
818
- */
819
- fromDate: string;
820
- /**
821
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
822
- */
823
- toDate: string;
824
- };
825
-
826
- export type StartJourneyDocumentPlaceOfBirthLocation = {
827
- latitude?: string | undefined;
828
- longitude?: string | undefined;
829
- geoAccuracy?: string | undefined;
830
- /**
831
- * A What3words designation associated with this location with '.' separator.
832
- */
833
- what3words?: string | undefined;
761
+ location?: StartJourneyCurrentAddressLocationPrimary | undefined;
834
762
  };
835
763
 
836
- export type StartJourneyDocumentPlaceOfBirth = {
764
+ export type StartJourneyPerson = {
837
765
  /**
838
- * Unformatted line based address
766
+ * Title of an individual such as Mr, Mrs, Dr, Sir
839
767
  */
840
- lines?: Array<string> | undefined;
768
+ title?: string | undefined;
841
769
  /**
842
- * The address as a single line
770
+ * A person's name used by their collegues and friends to address them
843
771
  */
844
- addressString?: string | undefined;
772
+ firstName?: string | undefined;
845
773
  /**
846
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
774
+ * Any other registered names used by the individual, not aliases
847
775
  */
848
- premise?: string | undefined;
776
+ middleNames?: Array<string> | undefined;
849
777
  /**
850
- * The name of a building or a building complex. In the US, this is the street number.
778
+ * Any family names for the individual
851
779
  */
852
- building?: string | undefined;
780
+ lastNames?: Array<string> | undefined;
853
781
  /**
854
- * The name of a sub-building, such as a flat or apartment number.
782
+ * Any family names for the individual
855
783
  */
856
- subBuilding?: string | undefined;
784
+ lastNamesAtBirth?: Array<string> | undefined;
785
+ id?: string | undefined;
786
+ type?: StartJourneyTypePrimary2 | undefined;
787
+ role?: StartJourneyRole | undefined;
788
+ position?: string | undefined;
789
+ ownershipPercentage?: number | undefined;
857
790
  /**
858
- * This field holds the most common street or block data element within a country. For instance, USA Street
791
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
859
792
  */
860
- thoroughfare?: string | undefined;
793
+ nationality?: string | undefined;
794
+ dateOfBirth?: string | undefined;
861
795
  /**
862
- * The name of a dependent street or block, such as a street within a complex.
796
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
863
797
  */
864
- dependentThoroughfare?: string | undefined;
798
+ startDate?: string | undefined;
865
799
  /**
866
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
800
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
867
801
  */
868
- locality?: string | undefined;
802
+ endDate?: string | undefined;
803
+ currentAddress?: StartJourneyCurrentAddressPrimary | undefined;
804
+ };
805
+
806
+ export type StartJourneyPhonePrimary = {
869
807
  /**
870
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
808
+ * The type of phone number, such as landline, mobile, fax, unknown etc
871
809
  */
872
- dependentLocality?: string | undefined;
810
+ type: string;
873
811
  /**
874
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
812
+ * Phone number, ideally in international format with +(Country Code)
875
813
  */
876
- doubleDependentLocality?: string | undefined;
814
+ number: string;
815
+ };
816
+
817
+ export type StartJourneyEntity = {
818
+ id?: string | undefined;
819
+ type?: StartJourneyTypePrimary1 | undefined;
820
+ name?: string | undefined;
821
+ aliases?: Array<string> | undefined;
822
+ businessType?: string | undefined;
823
+ status?: StartJourneyStatus | undefined;
824
+ description?: string | undefined;
825
+ addresses?: Array<StartJourneyAddressPrimary> | undefined;
826
+ taxIdentifiers?: Array<StartJourneyTaxIdentifier> | undefined;
827
+ companyNumber?: string | undefined;
828
+ industryClassifications?:
829
+ | Array<StartJourneyIndustryClassification>
830
+ | undefined;
831
+ registrations?: Array<StartJourneyRegistration> | undefined;
832
+ corporateStructure?: string | undefined;
833
+ persons?: Array<StartJourneyPerson> | undefined;
877
834
  /**
878
- * 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
835
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
879
836
  */
880
- postalCode?: string | undefined;
837
+ incorporationDate?: string | undefined;
881
838
  /**
882
- * This field contains the post box number associated with a particular delivery point, should one exist.
839
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
883
840
  */
884
- postBox?: string | undefined;
841
+ dissolutionDate?: string | undefined;
842
+ phones?: Array<StartJourneyPhonePrimary> | undefined;
843
+ websites?: Array<string> | undefined;
844
+ headcount?: number | undefined;
845
+ isNonProfit?: boolean | undefined;
846
+ };
847
+
848
+ export type StartJourneyDocumentAddress = {
849
+ addressString?: string | undefined;
850
+ extractedAddressString?: string | undefined;
851
+ addressLine1?: string | undefined;
852
+ addressLine2?: string | undefined;
853
+ locality?: string | undefined;
854
+ administrativeArea?: string | undefined;
855
+ postalCode?: string | undefined;
856
+ };
857
+
858
+ export type StartJourneyDocumentDevice = {
859
+ type?: string | undefined;
860
+ model?: string | undefined;
861
+ hasContactlessReader?: boolean | undefined;
862
+ hasMagneticStripeReader?: boolean | undefined;
863
+ hasCamera?: boolean | undefined;
864
+ serialNumber?: string | undefined;
865
+ manufacturer?: string | undefined;
866
+ };
867
+
868
+ export type StartJourneySide1Device = {
869
+ type?: string | undefined;
870
+ model?: string | undefined;
871
+ hasContactlessReader?: boolean | undefined;
872
+ hasMagneticStripeReader?: boolean | undefined;
873
+ hasCamera?: boolean | undefined;
874
+ serialNumber?: string | undefined;
875
+ manufacturer?: string | undefined;
876
+ };
877
+
878
+ export type StartJourneySide2Device = {
879
+ type?: string | undefined;
880
+ model?: string | undefined;
881
+ hasContactlessReader?: boolean | undefined;
882
+ hasMagneticStripeReader?: boolean | undefined;
883
+ hasCamera?: boolean | undefined;
884
+ serialNumber?: string | undefined;
885
+ manufacturer?: string | undefined;
886
+ };
887
+
888
+ export const StartJourneyName = {
889
+ Com: "COM",
890
+ Sod: "SOD",
891
+ Dg1: "DG1",
892
+ Dg2: "DG2",
893
+ Dg3: "DG3",
894
+ Dg4: "DG4",
895
+ Dg5: "DG5",
896
+ Dg6: "DG6",
897
+ Dg7: "DG7",
898
+ Dg8: "DG8",
899
+ Dg9: "DG9",
900
+ Dg10: "DG10",
901
+ Dg11: "DG11",
902
+ Dg12: "DG12",
903
+ Dg13: "DG13",
904
+ Dg14: "DG14",
905
+ Dg15: "DG15",
906
+ } as const;
907
+ export type StartJourneyName = ClosedEnum<typeof StartJourneyName>;
908
+
909
+ export type StartJourneyLd = {
910
+ name: StartJourneyName;
911
+ data: string;
912
+ [additionalProperties: string]: unknown;
913
+ };
914
+
915
+ export const StartJourneyAuthType = {
916
+ ActiveAuthentication: "ActiveAuthentication",
917
+ BasicAccessControl: "BasicAccessControl",
918
+ ChipAuthentication: "ChipAuthentication",
919
+ PassiveAuthentication: "PassiveAuthentication",
920
+ SupplementalAccessControl: "SupplementalAccessControl",
921
+ ExtendedAccessControl: "ExtendedAccessControl",
922
+ TerminalAuthentication: "TerminalAuthentication",
923
+ } as const;
924
+ export type StartJourneyAuthType = ClosedEnum<typeof StartJourneyAuthType>;
925
+
926
+ export const StartJourneyResult = {
927
+ Success: "Success",
928
+ Failure: "Failure",
929
+ Skipped: "Skipped",
930
+ } as const;
931
+ export type StartJourneyResult = ClosedEnum<typeof StartJourneyResult>;
932
+
933
+ export type StartJourneyChipAuth = {
934
+ type: StartJourneyAuthType;
935
+ result: StartJourneyResult;
936
+ [additionalProperties: string]: unknown;
937
+ };
938
+
939
+ export type StartJourneyChip = {
940
+ lds: Array<StartJourneyLd>;
941
+ auth: Array<StartJourneyChipAuth>;
942
+ [additionalProperties: string]: unknown;
943
+ };
944
+
945
+ export type StartJourneySide = {
946
+ side: string;
947
+ id: string;
948
+ documentQuality: string;
949
+ documentQualityScore: number;
950
+ };
951
+
952
+ export type StartJourneyClassification = {
953
+ ids?: Array<string> | undefined;
954
+ category?: string | undefined;
955
+ type?: string | undefined;
956
+ subtype?: string | undefined;
957
+ isDoubleSided?: boolean | undefined;
958
+ hasNFC?: boolean | undefined;
959
+ year?: string | undefined;
960
+ countryCode?: string | undefined;
961
+ countryName?: string | undefined;
962
+ stateCode?: string | undefined;
963
+ stateName?: string | undefined;
964
+ sides?: Array<StartJourneySide> | undefined;
965
+ };
966
+
967
+ export type StartJourneyAggregatedFieldBoundingBox = {
968
+ x: number;
969
+ y: number;
970
+ width: number;
971
+ height: number;
972
+ };
973
+
974
+ export type StartJourneyAggregatedFieldRegionOfInterest = {
975
+ boundingBox?: StartJourneyAggregatedFieldBoundingBox | undefined;
976
+ side: string;
977
+ spectrum?: string | undefined;
978
+ imageId?: string | undefined;
979
+ };
980
+
981
+ export type StartJourneyAggregatedField = {
982
+ label: string;
983
+ value: string;
984
+ source: string;
985
+ isNonLatin: boolean;
986
+ regionOfInterest?: StartJourneyAggregatedFieldRegionOfInterest | undefined;
987
+ };
988
+
989
+ export type StartJourneyDetailBoundingBox = {
990
+ x: number;
991
+ y: number;
992
+ width: number;
993
+ height: number;
994
+ };
995
+
996
+ export type StartJourneyDetailRegionOfInterest = {
997
+ boundingBox?: StartJourneyDetailBoundingBox | undefined;
998
+ side: string;
999
+ spectrum?: string | undefined;
1000
+ imageId?: string | undefined;
1001
+ };
1002
+
1003
+ export type StartJourneyDetail = {
1004
+ label: string;
1005
+ value: string;
1006
+ source: string;
1007
+ isNonLatin: boolean;
1008
+ regionOfInterest?: StartJourneyDetailRegionOfInterest | undefined;
1009
+ };
1010
+
1011
+ export type StartJourneyExtractedField = {
1012
+ label: string;
1013
+ details: Array<StartJourneyDetail>;
1014
+ };
1015
+
1016
+ export type StartJourneyExtractedImage = {
1017
+ label: string;
1018
+ side: string;
1019
+ imageID: string;
1020
+ };
1021
+
1022
+ export type StartJourneyExtraction = {
1023
+ aggregatedFields?: Array<StartJourneyAggregatedField> | undefined;
1024
+ extractedFields?: Array<StartJourneyExtractedField> | undefined;
1025
+ extractedImages?: Array<StartJourneyExtractedImage> | undefined;
1026
+ };
1027
+
1028
+ export type StartJourneyValidationCheckBoundingBox = {
1029
+ x: number;
1030
+ y: number;
1031
+ width: number;
1032
+ height: number;
1033
+ };
1034
+
1035
+ export type StartJourneyValidationCheckRegionOfInterest = {
1036
+ boundingBox?: StartJourneyValidationCheckBoundingBox | undefined;
1037
+ side: string;
1038
+ spectrum?: string | undefined;
1039
+ imageId?: string | undefined;
1040
+ };
1041
+
1042
+ export type StartJourneyValidationCheck = {
1043
+ name: string;
1044
+ title: string;
1045
+ info: string;
1046
+ validationResult: string;
1047
+ resultInfo: string;
1048
+ weight: string;
1049
+ regionOfInterests?:
1050
+ | Array<StartJourneyValidationCheckRegionOfInterest>
1051
+ | undefined;
1052
+ type: string;
1053
+ };
1054
+
1055
+ export type StartJourneyAggregatedValidationCheckBoundingBox = {
1056
+ x: number;
1057
+ y: number;
1058
+ width: number;
1059
+ height: number;
1060
+ };
1061
+
1062
+ export type StartJourneyAggregatedValidationCheckRegionOfInterest = {
1063
+ boundingBox?: StartJourneyAggregatedValidationCheckBoundingBox | undefined;
1064
+ side: string;
1065
+ spectrum?: string | undefined;
1066
+ imageId?: string | undefined;
1067
+ };
1068
+
1069
+ export type StartJourneyAggregatedValidationCheck = {
1070
+ name: string;
1071
+ title: string;
1072
+ info: string;
1073
+ validationResult: string;
1074
+ resultInfo: string;
1075
+ weight: string;
1076
+ regionOfInterests?:
1077
+ | Array<StartJourneyAggregatedValidationCheckRegionOfInterest>
1078
+ | undefined;
1079
+ type: string;
1080
+ };
1081
+
1082
+ export type StartJourneyValidation = {
1083
+ validationChecks?: Array<StartJourneyValidationCheck> | undefined;
1084
+ aggregatedValidationChecks?:
1085
+ | Array<StartJourneyAggregatedValidationCheck>
1086
+ | undefined;
1087
+ };
1088
+
1089
+ export type StartJourneyDocumentAlias = {
1090
+ /**
1091
+ * Title of an individual such as Mr, Mrs, Dr, Sir
1092
+ */
1093
+ title?: string | undefined;
1094
+ /**
1095
+ * A person's name used by their collegues and friends to address them
1096
+ */
1097
+ firstName?: string | undefined;
1098
+ /**
1099
+ * Any other registered names used by the individual, not aliases
1100
+ */
1101
+ middleNames?: Array<string> | undefined;
1102
+ /**
1103
+ * Any family names for the individual
1104
+ */
1105
+ lastNames?: Array<string> | undefined;
1106
+ /**
1107
+ * Any family names for the individual
1108
+ */
1109
+ lastNamesAtBirth?: Array<string> | undefined;
1110
+ /**
1111
+ * The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
1112
+ */
1113
+ fullName?: string | undefined;
1114
+ };
1115
+
1116
+ export const StartJourneyDocumentRelationship = {
1117
+ Mother: "mother",
1118
+ Father: "father",
1119
+ Spouse: "spouse",
1120
+ MaternalGrandFather: "maternalGrandFather",
1121
+ MaternalGrandMother: "maternalGrandMother",
1122
+ PaternalGrandFather: "paternalGrandFather",
1123
+ PaternalGrandMother: "paternalGrandMother",
1124
+ } as const;
1125
+ export type StartJourneyDocumentRelationship = ClosedEnum<
1126
+ typeof StartJourneyDocumentRelationship
1127
+ >;
1128
+
1129
+ export type StartJourneyDocumentRelatedPerson = {
1130
+ /**
1131
+ * Title of an individual such as Mr, Mrs, Dr, Sir
1132
+ */
1133
+ title?: string | undefined;
1134
+ /**
1135
+ * A person's name used by their collegues and friends to address them
1136
+ */
1137
+ firstName?: string | undefined;
1138
+ /**
1139
+ * Any other registered names used by the individual, not aliases
1140
+ */
1141
+ middleNames?: Array<string> | undefined;
1142
+ /**
1143
+ * Any family names for the individual
1144
+ */
1145
+ lastNames?: Array<string> | undefined;
1146
+ /**
1147
+ * Any family names for the individual
1148
+ */
1149
+ lastNamesAtBirth?: Array<string> | undefined;
1150
+ relationship: StartJourneyDocumentRelationship;
1151
+ };
1152
+
1153
+ export type StartJourneyDocumentCurrentAddressLocation = {
1154
+ latitude?: string | undefined;
1155
+ longitude?: string | undefined;
1156
+ geoAccuracy?: string | undefined;
1157
+ /**
1158
+ * A What3words designation associated with this location with '.' separator.
1159
+ */
1160
+ what3words?: string | undefined;
1161
+ };
1162
+
1163
+ export type StartJourneyDocumentCurrentAddress = {
1164
+ /**
1165
+ * Unformatted line based address
1166
+ */
1167
+ lines?: Array<string> | undefined;
1168
+ /**
1169
+ * The address as a single line
1170
+ */
1171
+ addressString?: string | undefined;
1172
+ /**
1173
+ * 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.
1174
+ */
1175
+ premise?: string | undefined;
1176
+ /**
1177
+ * 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.
1178
+ */
1179
+ building?: string | undefined;
1180
+ /**
1181
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
1182
+ */
1183
+ subBuilding?: string | undefined;
1184
+ /**
1185
+ * This field holds the most common street or block data element within a country. For instance, USA Street
1186
+ */
1187
+ thoroughfare?: string | undefined;
1188
+ /**
1189
+ * The name of a dependent street or block, such as a street within a complex.
1190
+ */
1191
+ dependentThoroughfare?: string | undefined;
1192
+ /**
1193
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
1194
+ */
1195
+ locality?: string | undefined;
1196
+ /**
1197
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
1198
+ */
1199
+ dependentLocality?: string | undefined;
1200
+ /**
1201
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
1202
+ */
1203
+ doubleDependentLocality?: string | undefined;
1204
+ /**
1205
+ * 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
1206
+ */
1207
+ postalCode?: string | undefined;
1208
+ /**
1209
+ * This field contains the post box number associated with a particular delivery point, should one exist.
1210
+ */
1211
+ postBox?: string | undefined;
1212
+ /**
1213
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1214
+ */
1215
+ country?: string | undefined;
1216
+ superAdministrativeArea?: string | undefined;
1217
+ administrativeArea?: string | undefined;
1218
+ subAdministrativeArea?: string | undefined;
1219
+ organization?: string | undefined;
1220
+ location?: StartJourneyDocumentCurrentAddressLocation | undefined;
1221
+ };
1222
+
1223
+ export type StartJourneyDocumentPreviousAddressLocation = {
1224
+ latitude?: string | undefined;
1225
+ longitude?: string | undefined;
1226
+ geoAccuracy?: string | undefined;
1227
+ /**
1228
+ * A What3words designation associated with this location with '.' separator.
1229
+ */
1230
+ what3words?: string | undefined;
1231
+ };
1232
+
1233
+ export type StartJourneyDocumentPreviousAddress = {
1234
+ /**
1235
+ * Unformatted line based address
1236
+ */
1237
+ lines?: Array<string> | undefined;
1238
+ /**
1239
+ * The address as a single line
1240
+ */
1241
+ addressString?: string | undefined;
1242
+ /**
1243
+ * 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.
1244
+ */
1245
+ premise?: string | undefined;
1246
+ /**
1247
+ * 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.
1248
+ */
1249
+ building?: string | undefined;
1250
+ /**
1251
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
1252
+ */
1253
+ subBuilding?: string | undefined;
1254
+ /**
1255
+ * This field holds the most common street or block data element within a country. For instance, USA Street
1256
+ */
1257
+ thoroughfare?: string | undefined;
1258
+ /**
1259
+ * The name of a dependent street or block, such as a street within a complex.
1260
+ */
1261
+ dependentThoroughfare?: string | undefined;
1262
+ /**
1263
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
1264
+ */
1265
+ locality?: string | undefined;
1266
+ /**
1267
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
1268
+ */
1269
+ dependentLocality?: string | undefined;
1270
+ /**
1271
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
1272
+ */
1273
+ doubleDependentLocality?: string | undefined;
1274
+ /**
1275
+ * 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
1276
+ */
1277
+ postalCode?: string | undefined;
1278
+ /**
1279
+ * This field contains the post box number associated with a particular delivery point, should one exist.
1280
+ */
1281
+ postBox?: string | undefined;
1282
+ /**
1283
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1284
+ */
1285
+ country?: string | undefined;
1286
+ superAdministrativeArea?: string | undefined;
1287
+ administrativeArea?: string | undefined;
1288
+ subAdministrativeArea?: string | undefined;
1289
+ organization?: string | undefined;
1290
+ location?: StartJourneyDocumentPreviousAddressLocation | undefined;
1291
+ /**
1292
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1293
+ */
1294
+ fromDate?: string | undefined;
1295
+ /**
1296
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1297
+ */
1298
+ toDate?: string | undefined;
1299
+ };
1300
+
1301
+ export type StartJourneyDocumentPlaceOfBirthLocation = {
1302
+ latitude?: string | undefined;
1303
+ longitude?: string | undefined;
1304
+ geoAccuracy?: string | undefined;
1305
+ /**
1306
+ * A What3words designation associated with this location with '.' separator.
1307
+ */
1308
+ what3words?: string | undefined;
1309
+ };
1310
+
1311
+ export type StartJourneyDocumentPlaceOfBirth = {
1312
+ /**
1313
+ * Unformatted line based address
1314
+ */
1315
+ lines?: Array<string> | undefined;
1316
+ /**
1317
+ * The address as a single line
1318
+ */
1319
+ addressString?: string | undefined;
1320
+ /**
1321
+ * 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.
1322
+ */
1323
+ premise?: string | undefined;
1324
+ /**
1325
+ * 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.
1326
+ */
1327
+ building?: string | undefined;
1328
+ /**
1329
+ * The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
1330
+ */
1331
+ subBuilding?: string | undefined;
1332
+ /**
1333
+ * This field holds the most common street or block data element within a country. For instance, USA Street
1334
+ */
1335
+ thoroughfare?: string | undefined;
1336
+ /**
1337
+ * The name of a dependent street or block, such as a street within a complex.
1338
+ */
1339
+ dependentThoroughfare?: string | undefined;
1340
+ /**
1341
+ * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
1342
+ */
1343
+ locality?: string | undefined;
1344
+ /**
1345
+ * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
1346
+ */
1347
+ dependentLocality?: string | undefined;
1348
+ /**
1349
+ * This is an even smaller area within a dependent locality, often used in very detailed addresses.
1350
+ */
1351
+ doubleDependentLocality?: string | undefined;
1352
+ /**
1353
+ * 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
1354
+ */
1355
+ postalCode?: string | undefined;
1356
+ /**
1357
+ * This field contains the post box number associated with a particular delivery point, should one exist.
1358
+ */
1359
+ postBox?: string | undefined;
1360
+ /**
1361
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1362
+ */
1363
+ country?: string | undefined;
1364
+ superAdministrativeArea?: string | undefined;
1365
+ administrativeArea?: string | undefined;
1366
+ subAdministrativeArea?: string | undefined;
1367
+ organization?: string | undefined;
1368
+ location?: StartJourneyDocumentPlaceOfBirthLocation | undefined;
1369
+ };
1370
+
1371
+ export type StartJourneyDocumentIdNumber = {
1372
+ /**
1373
+ * The type of phone number, such as landline, mobile, fax, unknown etc
1374
+ */
1375
+ type: string;
1376
+ /**
1377
+ * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
1378
+ */
1379
+ idNumber: string;
1380
+ /**
1381
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1382
+ */
1383
+ country?: string | undefined;
1384
+ };
1385
+
1386
+ export type StartJourneyDocumentPhone = {
1387
+ /**
1388
+ * The type of phone number, such as landline, mobile, fax, unknown etc
1389
+ */
1390
+ type: string;
1391
+ /**
1392
+ * Phone number, ideally in international format with +(Country Code)
1393
+ */
1394
+ number: string;
1395
+ };
1396
+
1397
+ export type StartJourneyDocumentEmail = {
1398
+ /**
1399
+ * 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').
1400
+ */
1401
+ type: string;
1402
+ /**
1403
+ * Email address
1404
+ */
1405
+ email: string;
1406
+ };
1407
+
1408
+ export type StartJourneyDocumentSocial = {
1409
+ /**
1410
+ * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
1411
+ */
1412
+ type: string;
1413
+ /**
1414
+ * the identity used on this platform
1415
+ */
1416
+ identity: string;
1417
+ };
1418
+
1419
+ export type StartJourneyDocumentSubject = {
1420
+ /**
1421
+ * Title of an individual such as Mr, Mrs, Dr, Sir
1422
+ */
1423
+ title?: string | undefined;
1424
+ /**
1425
+ * A person's name used by their collegues and friends to address them
1426
+ */
1427
+ firstName?: string | undefined;
1428
+ /**
1429
+ * Any other registered names used by the individual, not aliases
1430
+ */
1431
+ middleNames?: Array<string> | undefined;
1432
+ /**
1433
+ * Any family names for the individual
1434
+ */
1435
+ lastNames?: Array<string> | undefined;
1436
+ /**
1437
+ * Any family names for the individual
1438
+ */
1439
+ lastNamesAtBirth?: Array<string> | undefined;
1440
+ /**
1441
+ * Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
1442
+ */
1443
+ aliases?: Array<StartJourneyDocumentAlias> | undefined;
1444
+ relatedPersons?: Array<StartJourneyDocumentRelatedPerson> | undefined;
1445
+ /**
1446
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1447
+ */
1448
+ dateOfBirth?: string | undefined;
1449
+ gender?: string | undefined;
1450
+ currentAddress?: StartJourneyDocumentCurrentAddress | undefined;
1451
+ previousAddresses?: Array<StartJourneyDocumentPreviousAddress> | undefined;
1452
+ placeOfBirth?: StartJourneyDocumentPlaceOfBirth | undefined;
1453
+ idNumbers?: Array<StartJourneyDocumentIdNumber> | undefined;
1454
+ phones?: Array<StartJourneyDocumentPhone> | undefined;
1455
+ emails?: Array<StartJourneyDocumentEmail> | undefined;
1456
+ socials?: Array<StartJourneyDocumentSocial> | undefined;
1457
+ /**
1458
+ * The subject's mother's maiden name, used for identity verification
1459
+ */
1460
+ mothersMaidenName?: string | undefined;
1461
+ /**
1462
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1463
+ */
1464
+ nationality?: string | undefined;
1465
+ };
1466
+
1467
+ export type StartJourneyDocument = {
1468
+ oneDBarcode?: string | undefined;
1469
+ address?: StartJourneyDocumentAddress | undefined;
1470
+ applicationDate?: string | undefined;
1471
+ applicationNumber?: string | undefined;
1472
+ dateOfBirth?: string | undefined;
1473
+ placeOfBirth?: string | undefined;
1474
+ placeOfBirthNative?: string | undefined;
1475
+ bloodType?: string | undefined;
1476
+ controlNumber?: string | undefined;
1477
+ countryCode?: string | undefined;
1478
+ countryName?: string | undefined;
1479
+ documentClassCode?: string | undefined;
1480
+ documentClassName?: string | undefined;
1481
+ documentNumber?: string | undefined;
1482
+ documentSignerCertificate?: string | undefined;
1483
+ employer?: string | undefined;
1484
+ employerAddress?: string | undefined;
1485
+ entries?: string | undefined;
1486
+ expirationDate?: string | undefined;
1487
+ eyeColor?: string | undefined;
1488
+ fathersName?: string | undefined;
1489
+ fathersNameNative?: string | undefined;
1490
+ fathersSurname?: string | undefined;
1491
+ firstName?: string | undefined;
1492
+ fullName?: string | undefined;
1493
+ fullNameNative?: string | undefined;
1494
+ givenName?: string | undefined;
1495
+ givenNameNative?: string | undefined;
1496
+ hairColor?: string | undefined;
1497
+ height?: string | undefined;
1498
+ /**
1499
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1500
+ */
1501
+ issueDate?: string | undefined;
1502
+ issuingAuthority?: string | undefined;
1503
+ issuingAuthorityNative?: string | undefined;
1504
+ issuingStateCode?: string | undefined;
1505
+ issuingStateName?: string | undefined;
1506
+ licenseClass?: string | undefined;
1507
+ licenseEndorsements?: string | undefined;
1508
+ licenseRestrictions?: string | undefined;
1509
+ mrz?: string | undefined;
1510
+ mrz1?: string | undefined;
1511
+ mrz2?: string | undefined;
1512
+ mrz3?: string | undefined;
1513
+ middleName?: string | undefined;
1514
+ mothersName?: string | undefined;
1515
+ mothersNameNative?: string | undefined;
1516
+ mothersSurname?: string | undefined;
1517
+ nameSuffix?: string | undefined;
1518
+ nationalityCode?: string | undefined;
1519
+ nationalityName?: string | undefined;
1520
+ nationalityNameNative?: string | undefined;
1521
+ occupation?: string | undefined;
1522
+ organDonor?: boolean | undefined;
1523
+ passportNumber?: string | undefined;
1524
+ permitNumber?: string | undefined;
1525
+ personalNumber?: string | undefined;
1526
+ photo?: string | undefined;
1527
+ photoCompressed?: string | undefined;
1528
+ photoEncoding?: string | undefined;
1529
+ sex?: string | undefined;
1530
+ sexNative?: string | undefined;
1531
+ signature?: string | undefined;
1532
+ signatureCompressed?: string | undefined;
1533
+ signatureEncoding?: string | undefined;
1534
+ socialSecurityNumber?: string | undefined;
1535
+ startDate?: string | undefined;
1536
+ surname?: string | undefined;
1537
+ surnameNative?: string | undefined;
1538
+ visaClass?: string | undefined;
1539
+ visaNumber?: string | undefined;
1540
+ weight?: string | undefined;
1541
+ cardNumber?: string | undefined;
1542
+ /**
1543
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
1544
+ */
1545
+ issuerCountryCode?: string | undefined;
1546
+ id?: string | undefined;
1547
+ type: string;
1548
+ category?: string | undefined;
1549
+ subtype?: string | undefined;
1550
+ format?: string | undefined;
1551
+ device?: StartJourneyDocumentDevice | undefined;
1552
+ side1Image?: string | undefined;
1553
+ side2Image?: string | undefined;
1554
+ side1Device?: StartJourneySide1Device | undefined;
1555
+ side2Device?: StartJourneySide2Device | undefined;
1556
+ chip?: StartJourneyChip | undefined;
1557
+ classification?: StartJourneyClassification | undefined;
1558
+ extraction?: StartJourneyExtraction | undefined;
1559
+ validation?: StartJourneyValidation | undefined;
1560
+ subType?: string | undefined;
1561
+ number?: string | undefined;
1562
+ /**
1563
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1564
+ */
1565
+ expiryDate?: string | undefined;
1566
+ cardType?: string | undefined;
1567
+ /**
1568
+ * Year and month in ISO 8601 format: YYYY-MM
1569
+ */
1570
+ expiryMonth?: string | undefined;
1571
+ cardColour?: string | undefined;
1572
+ cardStatus?: string | undefined;
1573
+ subject?: StartJourneyDocumentSubject | undefined;
885
1574
  /**
886
1575
  * Country the address is in. It must be a valid ISO2 or ISO3 country code
887
1576
  */
888
1577
  country?: string | undefined;
889
- superAdministrativeArea?: string | undefined;
890
- administrativeArea?: string | undefined;
891
- subAdministrativeArea?: string | undefined;
892
- organization?: string | undefined;
893
- location?: StartJourneyDocumentPlaceOfBirthLocation | undefined;
1578
+ certificateFormat?: string | undefined;
1579
+ registrationNumber?: string | undefined;
1580
+ /**
1581
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1582
+ */
1583
+ registrationDate?: string | undefined;
1584
+ /**
1585
+ * Four-digit calendar year in ISO 8601 format: YYYY
1586
+ */
1587
+ registrationYear?: string | undefined;
1588
+ partyRole?: string | undefined;
1589
+ /**
1590
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1591
+ */
1592
+ dateOfEvent?: string | undefined;
1593
+ /**
1594
+ * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1595
+ */
1596
+ acquisitionDate?: string | undefined;
1597
+ previousFirstName?: string | undefined;
1598
+ previousMiddleName?: string | undefined;
1599
+ previousSurname?: string | undefined;
1600
+ individualReferenceNumber?: string | undefined;
1601
+ nameLine1?: string | undefined;
1602
+ nameLine2?: string | undefined;
1603
+ nameLine3?: string | undefined;
1604
+ nameLine4?: string | undefined;
1605
+ };
1606
+
1607
+ export const StartJourneyTypeOrphanedStoredFace = {
1608
+ OrphanedStoredFace: "orphanedStoredFace",
1609
+ } as const;
1610
+ export type StartJourneyTypeOrphanedStoredFace = ClosedEnum<
1611
+ typeof StartJourneyTypeOrphanedStoredFace
1612
+ >;
1613
+
1614
+ export type StartJourneyBiometricOrphanedStoredFace = {
1615
+ id?: string | undefined;
1616
+ type: StartJourneyTypeOrphanedStoredFace;
1617
+ templateReference: string;
1618
+ collectionReference?: string | undefined;
1619
+ };
1620
+
1621
+ export const StartJourneyTypeStoredFace = {
1622
+ StoredFace: "storedFace",
1623
+ } as const;
1624
+ export type StartJourneyTypeStoredFace = ClosedEnum<
1625
+ typeof StartJourneyTypeStoredFace
1626
+ >;
1627
+
1628
+ export type StartJourneyBiometricStoredFace = {
1629
+ id?: string | undefined;
1630
+ type: StartJourneyTypeStoredFace;
1631
+ templateReference: string;
1632
+ collectionReference?: string | undefined;
1633
+ };
1634
+
1635
+ export type StartJourneyBiometric5 = {
1636
+ id?: string | undefined;
1637
+ type?: string | undefined;
1638
+ anchorImage: string;
1639
+ };
1640
+
1641
+ export type StartJourneyBiometric4 = {
1642
+ id?: string | undefined;
1643
+ type?: string | undefined;
1644
+ selfieImage: string;
1645
+ selfieImageEncryption?: boolean | undefined;
1646
+ };
1647
+
1648
+ export type StartJourneyBiometric3 = {
1649
+ id?: string | undefined;
1650
+ type?: string | undefined;
1651
+ faceImage: string;
1652
+ };
1653
+
1654
+ export type StartJourneyBiometric2 = {
1655
+ id?: string | undefined;
1656
+ type?: string | undefined;
1657
+ selfieImage: string;
1658
+ anchorImage: string;
1659
+ };
1660
+
1661
+ export type StartJourneyBiometric1 = {
1662
+ id?: string | undefined;
1663
+ type?: string | undefined;
1664
+ face1Image: string;
1665
+ face2Image: string;
1666
+ };
1667
+
1668
+ export type StartJourneyBiometricUnion =
1669
+ | StartJourneyBiometric1
1670
+ | StartJourneyBiometric2
1671
+ | StartJourneyBiometricStoredFace
1672
+ | StartJourneyBiometricOrphanedStoredFace
1673
+ | StartJourneyBiometric3
1674
+ | StartJourneyBiometric4
1675
+ | StartJourneyBiometric5;
1676
+
1677
+ export type StartJourneyUser = {
1678
+ id: string;
1679
+ email?: string | undefined;
1680
+ domain?: string | undefined;
1681
+ };
1682
+
1683
+ export type StartJourneyClient = {
1684
+ id: string;
1685
+ ip: string;
1686
+ address: string;
1687
+ };
1688
+
1689
+ export type StartJourneyModel = {
1690
+ identifier: string;
1691
+ name: string;
1692
+ };
1693
+
1694
+ export type StartJourneySessionDevice = {
1695
+ id: string;
1696
+ manufacturer: string;
1697
+ model: StartJourneyModel;
1698
+ };
1699
+
1700
+ export type StartJourneyTrace = {
1701
+ id: string;
1702
+ };
1703
+
1704
+ export type StartJourneySpan = {
1705
+ id: string;
1706
+ };
1707
+
1708
+ export type StartJourneyTransaction = {
1709
+ id: string;
1710
+ };
1711
+
1712
+ export type StartJourneySessionAuth = {
1713
+ id: string;
1714
+ scope?: string | undefined;
1715
+ codeVerifier?: string | undefined;
1716
+ code?: string | undefined;
1717
+ state?: string | undefined;
1718
+ redirectUri?: string | undefined;
1719
+ responseType?: string | undefined;
1720
+ clientId?: string | undefined;
1721
+ clientSecret?: string | undefined;
1722
+ };
1723
+
1724
+ export type StartJourneySession = {
1725
+ id?: string | undefined;
1726
+ type?: string | undefined;
1727
+ provider?: string | undefined;
1728
+ user?: StartJourneyUser | undefined;
1729
+ client?: StartJourneyClient | undefined;
1730
+ device?: StartJourneySessionDevice | undefined;
1731
+ trace?: StartJourneyTrace | undefined;
1732
+ span?: StartJourneySpan | undefined;
1733
+ transaction?: StartJourneyTransaction | undefined;
1734
+ auth?: Array<StartJourneySessionAuth> | undefined;
894
1735
  };
895
1736
 
896
- export type StartJourneyDocumentIdNumber = {
1737
+ export const StartJourneyConsentType = {
1738
+ Rollup: "rollup",
1739
+ Explicit: "explicit",
1740
+ Implicit: "implicit",
1741
+ } as const;
1742
+ export type StartJourneyConsentType = ClosedEnum<
1743
+ typeof StartJourneyConsentType
1744
+ >;
1745
+
1746
+ export type StartJourneyConsent = {
1747
+ type?: StartJourneyConsentType | undefined;
1748
+ id?: string | undefined;
1749
+ version?: string | undefined;
1750
+ url: string;
1751
+ effectiveDate?: string | undefined;
1752
+ expiryDate?: string | undefined;
1753
+ terms?: string | undefined;
1754
+ purpose?: string | undefined;
1755
+ legalBasis?: string | undefined;
1756
+ jurisdiction?: string | undefined;
1757
+ subject?: string | undefined;
1758
+ signatory?: string | undefined;
1759
+ };
1760
+
1761
+ export type StartJourneyAccount = {
897
1762
  /**
898
- * The type of phone number, such as landline, mobile, fax, unknown etc
1763
+ * The type of account (canonical camelCase, e.g. "bankAccount"). Legacy value "Bank Account" is still read but new writes emit the canonical form.
899
1764
  */
900
1765
  type: string;
901
1766
  /**
902
- * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
1767
+ * 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.
903
1768
  */
904
- idNumber: string;
1769
+ accountNumber?: string | undefined;
905
1770
  /**
906
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1771
+ * UK sort code
907
1772
  */
908
- country?: string | undefined;
909
- };
910
-
911
- export type StartJourneyDocumentPhone = {
1773
+ sortCode?: string | undefined;
912
1774
  /**
913
- * The type of phone number, such as landline, mobile, fax, unknown etc
1775
+ * US ABA routing number
914
1776
  */
915
- type: string;
1777
+ routingNumber?: string | undefined;
916
1778
  /**
917
- * Phone number, ideally in international format with +(Country Code)
1779
+ * 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.
918
1780
  */
919
- number: string;
920
- };
921
-
922
- export type StartJourneyDocumentEmail = {
1781
+ iban?: string | undefined;
923
1782
  /**
924
- * The type of email, such as home, work, unknown etc
1783
+ * BIC/SWIFT code
925
1784
  */
926
- type: string;
1785
+ bic?: string | undefined;
927
1786
  /**
928
- * Email address
1787
+ * Name on the account
929
1788
  */
930
- email: string;
931
- };
932
-
933
- export type StartJourneyDocumentSocial = {
1789
+ accountHolderName?: string | undefined;
934
1790
  /**
935
- * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
1791
+ * Name of the financial institution
936
1792
  */
937
- type: string;
1793
+ bankName?: string | undefined;
938
1794
  /**
939
- * the identity used on this platform
1795
+ * Country the address is in. It must be a valid ISO2 or ISO3 country code
940
1796
  */
941
- identity: string;
1797
+ country?: string | undefined;
1798
+ /**
1799
+ * Account classification, e.g. current, savings
1800
+ */
1801
+ accountType?: string | undefined;
942
1802
  };
943
1803
 
944
- export type StartJourneyDocumentSubject = {
1804
+ export type StartJourneyChoice = {
1805
+ label: string;
1806
+ text: string;
1807
+ };
1808
+
1809
+ export type StartJourneyQuestion = {
1810
+ id: number;
1811
+ questionText: string;
1812
+ helpText?: string | undefined;
1813
+ choices: Array<StartJourneyChoice>;
1814
+ };
1815
+
1816
+ export type StartJourneyAnswer = {
1817
+ id: number;
1818
+ choices: Array<string>;
1819
+ };
1820
+
1821
+ export type StartJourneyKba = {
1822
+ questions: Array<StartJourneyQuestion>;
1823
+ answers: Array<StartJourneyAnswer>;
1824
+ };
1825
+
1826
+ export const StartJourneyOffered = {
1827
+ AustraliaPassport: "australiaPassport",
1828
+ AustraliaDrivingLicense: "australiaDrivingLicense",
1829
+ AustraliaBirthCertificate: "australiaBirthCertificate",
1830
+ AustraliaCentrelink: "australiaCentrelink",
1831
+ AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate",
1832
+ AustraliaVisa: "australiaVisa",
1833
+ AustraliaMedicare: "australiaMedicare",
1834
+ AustraliaImmicard: "australiaImmicard",
1835
+ AustraliaMarriageCertificate: "australiaMarriageCertificate",
1836
+ AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate",
1837
+ AustraliaElectoralRoll: "australiaElectoralRoll",
1838
+ NewZealandPassport: "newZealandPassport",
1839
+ NewZealandDrivingLicense: "newZealandDrivingLicense",
1840
+ NewZealandBirthCertificate: "newZealandBirthCertificate",
1841
+ NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate",
1842
+ NoneOfThese: "noneOfThese",
1843
+ } as const;
1844
+ export type StartJourneyOffered = ClosedEnum<typeof StartJourneyOffered>;
1845
+
1846
+ export const StartJourneySelected = {
1847
+ AustraliaPassport: "australiaPassport",
1848
+ AustraliaDrivingLicense: "australiaDrivingLicense",
1849
+ AustraliaBirthCertificate: "australiaBirthCertificate",
1850
+ AustraliaCentrelink: "australiaCentrelink",
1851
+ AustraliaCitizenshipCertificate: "australiaCitizenshipCertificate",
1852
+ AustraliaVisa: "australiaVisa",
1853
+ AustraliaMedicare: "australiaMedicare",
1854
+ AustraliaImmicard: "australiaImmicard",
1855
+ AustraliaMarriageCertificate: "australiaMarriageCertificate",
1856
+ AustraliaChangeOfNameCertificate: "australiaChangeOfNameCertificate",
1857
+ AustraliaElectoralRoll: "australiaElectoralRoll",
1858
+ NewZealandPassport: "newZealandPassport",
1859
+ NewZealandDrivingLicense: "newZealandDrivingLicense",
1860
+ NewZealandBirthCertificate: "newZealandBirthCertificate",
1861
+ NewZealandCitizenshipCertificate: "newZealandCitizenshipCertificate",
1862
+ NoneOfThese: "noneOfThese",
1863
+ } as const;
1864
+ export type StartJourneySelected = ClosedEnum<typeof StartJourneySelected>;
1865
+
1866
+ export type StartJourneyDocumentTypeSelection = {
1867
+ offered?: Array<StartJourneyOffered> | undefined;
1868
+ selected?: StartJourneySelected | undefined;
1869
+ };
1870
+
1871
+ export type StartJourneyContextSubject = {
1872
+ identity?: StartJourneyIdentity | undefined;
1873
+ entities?: Array<StartJourneyEntity> | undefined;
1874
+ documents?: Array<StartJourneyDocument> | undefined;
1875
+ biometrics?:
1876
+ | Array<
1877
+ | StartJourneyBiometric1
1878
+ | StartJourneyBiometric2
1879
+ | StartJourneyBiometricStoredFace
1880
+ | StartJourneyBiometricOrphanedStoredFace
1881
+ | StartJourneyBiometric3
1882
+ | StartJourneyBiometric4
1883
+ | StartJourneyBiometric5
1884
+ >
1885
+ | undefined;
1886
+ sessions?: Array<StartJourneySession> | undefined;
1887
+ consent?: Array<StartJourneyConsent> | undefined;
1888
+ accounts?: Array<StartJourneyAccount> | undefined;
1889
+ kba?: StartJourneyKba | undefined;
1890
+ documentTypeSelection?: StartJourneyDocumentTypeSelection | undefined;
1891
+ uid?: string | undefined;
1892
+ };
1893
+
1894
+ /**
1895
+ * 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.
1896
+ */
1897
+ export const ResumeMode = {
1898
+ Off: "off",
1899
+ Resume: "resume",
1900
+ } as const;
1901
+ /**
1902
+ * 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.
1903
+ */
1904
+ export type ResumeMode = ClosedEnum<typeof ResumeMode>;
1905
+
1906
+ /**
1907
+ * 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.
1908
+ */
1909
+ export type Reminders = {
945
1910
  /**
946
- * Title of an individual such as Mr, Mrs, Dr, Sir
1911
+ * Minutes between one send of the invite link and the next reminder.
947
1912
  */
948
- title?: string | undefined;
1913
+ intervalMinutes: number;
949
1914
  /**
950
- * A person's name used by their collegues and friends to address them
1915
+ * Reminders sent after the first invite, at most 5. 0 turns reminders off.
951
1916
  */
952
- firstName?: string | undefined;
1917
+ maxReminders: number;
1918
+ };
1919
+
1920
+ /**
1921
+ * 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.
1922
+ */
1923
+ export type LinkConfig = {
953
1924
  /**
954
- * Any other registered names used by the individual, not aliases
1925
+ * 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.
955
1926
  */
956
- middleNames?: Array<string> | undefined;
1927
+ ttlMinutes?: number | undefined;
957
1928
  /**
958
- * Any family names for the individual
1929
+ * 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.
959
1930
  */
960
- lastNames?: Array<string> | undefined;
1931
+ resumeMode?: ResumeMode | undefined;
961
1932
  /**
962
- * Any family names for the individual
1933
+ * 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.
963
1934
  */
964
- lastNamesAtBirth?: Array<string> | undefined;
965
- aliases?: Array<StartJourneyDocumentAlias> | undefined;
966
- relatedPersons?: Array<StartJourneyDocumentRelatedPerson> | undefined;
1935
+ resumeExpiryMinutes?: number | undefined;
967
1936
  /**
968
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1937
+ * 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.
969
1938
  */
970
- dateOfBirth?: string | undefined;
971
- gender?: string | undefined;
972
- currentAddress?: StartJourneyDocumentCurrentAddress | undefined;
973
- previousAddresses?: Array<StartJourneyDocumentPreviousAddress> | undefined;
974
- placeOfBirth?: StartJourneyDocumentPlaceOfBirth | undefined;
975
- idNumbers?: Array<StartJourneyDocumentIdNumber> | undefined;
976
- phones?: Array<StartJourneyDocumentPhone> | undefined;
977
- emails?: Array<StartJourneyDocumentEmail> | undefined;
978
- socials?: Array<StartJourneyDocumentSocial> | undefined;
1939
+ reminders?: Reminders | undefined;
1940
+ };
1941
+
1942
+ /**
1943
+ * 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.
1944
+ */
1945
+ export type Overlay = {
979
1946
  /**
980
- * The subject's mother's maiden name, used for identity verification
1947
+ * 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.
981
1948
  */
982
- mothersMaidenName?: string | undefined;
1949
+ version: string;
983
1950
  };
984
1951
 
985
- export type StartJourneyDocument = {
986
- oneDBarcode?: string | undefined;
987
- address?: StartJourneyAddress | undefined;
988
- applicationDate?: string | undefined;
989
- applicationNumber?: string | undefined;
990
- dateOfBirth?: string | undefined;
991
- placeOfBirth?: string | undefined;
992
- placeOfBirthNative?: string | undefined;
993
- bloodType?: string | undefined;
994
- controlNumber?: string | undefined;
995
- countryCode?: string | undefined;
996
- countryName?: string | undefined;
997
- documentClassCode?: string | undefined;
998
- documentClassName?: string | undefined;
999
- documentNumber?: string | undefined;
1000
- documentSignerCertificate?: string | undefined;
1001
- employer?: string | undefined;
1002
- employerAddress?: string | undefined;
1003
- entries?: string | undefined;
1004
- expirationDate?: string | undefined;
1005
- eyeColor?: string | undefined;
1006
- fathersName?: string | undefined;
1007
- fathersNameNative?: string | undefined;
1008
- fathersSurname?: string | undefined;
1009
- firstName?: string | undefined;
1010
- fullName?: string | undefined;
1011
- fullNameNative?: string | undefined;
1012
- givenName?: string | undefined;
1013
- givenNameNative?: string | undefined;
1014
- hairColor?: string | undefined;
1015
- height?: string | undefined;
1952
+ export type Config = {
1953
+ delivery: string;
1954
+ branding?: any | undefined;
1016
1955
  /**
1017
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1956
+ * 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.
1018
1957
  */
1019
- issueDate?: string | undefined;
1020
- issuingAuthority?: string | undefined;
1021
- issuingAuthorityNative?: string | undefined;
1022
- issuingStateCode?: string | undefined;
1023
- issuingStateName?: string | undefined;
1024
- licenseClass?: string | undefined;
1025
- licenseEndorsements?: string | undefined;
1026
- licenseRestrictions?: string | undefined;
1027
- mrz?: string | undefined;
1028
- mrz1?: string | undefined;
1029
- mrz2?: string | undefined;
1030
- mrz3?: string | undefined;
1031
- middleName?: string | undefined;
1032
- mothersName?: string | undefined;
1033
- mothersNameNative?: string | undefined;
1034
- mothersSurname?: string | undefined;
1035
- nameSuffix?: string | undefined;
1036
- nationalityCode?: string | undefined;
1037
- nationalityName?: string | undefined;
1038
- nationalityNameNative?: string | undefined;
1039
- occupation?: string | undefined;
1040
- organDonor?: boolean | undefined;
1041
- passportNumber?: string | undefined;
1042
- permitNumber?: string | undefined;
1043
- personalNumber?: string | undefined;
1044
- photo?: string | undefined;
1045
- photoCompressed?: string | undefined;
1046
- photoEncoding?: string | undefined;
1047
- sex?: string | undefined;
1048
- sexNative?: string | undefined;
1049
- signature?: string | undefined;
1050
- signatureCompressed?: string | undefined;
1051
- signatureEncoding?: string | undefined;
1052
- socialSecurityNumber?: string | undefined;
1053
- startDate?: string | undefined;
1054
- surname?: string | undefined;
1055
- surnameNative?: string | undefined;
1056
- visaClass?: string | undefined;
1057
- visaNumber?: string | undefined;
1058
- weight?: string | undefined;
1059
- cardNumber?: string | undefined;
1958
+ assisted?: boolean | undefined;
1060
1959
  /**
1061
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1960
+ * 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".
1062
1961
  */
1063
- issuerCountryCode?: string | undefined;
1064
- id?: string | undefined;
1065
- type?: string | undefined;
1066
- category?: string | undefined;
1067
- subtype?: string | undefined;
1068
- format?: string | undefined;
1069
- device?: StartJourneyDocumentDevice | undefined;
1070
- side1Image?: string | undefined;
1071
- side2Image?: string | undefined;
1072
- chip?: StartJourneyChip | undefined;
1073
- classification?: StartJourneyClassification | undefined;
1074
- extraction?: StartJourneyExtraction | undefined;
1075
- validation?: StartJourneyValidation | undefined;
1076
- subType?: string | undefined;
1077
- number?: string | undefined;
1962
+ inlineResult?: boolean | undefined;
1078
1963
  /**
1079
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1964
+ * 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.
1080
1965
  */
1081
- expiryDate?: string | undefined;
1082
- subject?: StartJourneyDocumentSubject | undefined;
1966
+ syncWaitSeconds?: number | undefined;
1967
+ /**
1968
+ * 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.
1969
+ */
1970
+ linkConfig?: LinkConfig | undefined;
1971
+ /**
1972
+ * 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.
1973
+ */
1974
+ overlay?: Overlay | undefined;
1975
+ [additionalProperties: string]: unknown;
1976
+ };
1977
+
1978
+ export type StartJourneyContext = {
1979
+ subject?: StartJourneyContextSubject | undefined;
1980
+ config: Config;
1981
+ [additionalProperties: string]: unknown;
1982
+ };
1983
+
1984
+ /**
1985
+ * Domain-element values this module override returns in result.subject.
1986
+ */
1987
+ export type ModulesSubject = {};
1988
+
1989
+ export type Modules = {
1990
+ outcome: string;
1991
+ advice?: { [k: string]: any } | undefined;
1992
+ /**
1993
+ * Domain-element values this module override returns in result.subject.
1994
+ */
1995
+ subject?: ModulesSubject | undefined;
1996
+ [additionalProperties: string]: unknown;
1997
+ };
1998
+
1999
+ /**
2000
+ * Fallback subject values applied when a module entry has no subject of its own.
2001
+ */
2002
+ export type DefaultSubject = {};
2003
+
2004
+ export type Scenario = {
2005
+ modules: { [k: string]: Modules };
2006
+ defaultOutcome?: string | undefined;
2007
+ defaultAdvice?: { [k: string]: any } | undefined;
1083
2008
  /**
1084
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
2009
+ * Fallback subject values applied when a module entry has no subject of its own.
1085
2010
  */
1086
- country?: string | undefined;
2011
+ defaultSubject?: DefaultSubject | undefined;
2012
+ description?: string | undefined;
2013
+ [additionalProperties: string]: unknown;
1087
2014
  };
1088
2015
 
1089
- export type StartJourneyBiometric4 = {
1090
- id?: string | undefined;
1091
- type?: string | undefined;
1092
- selfieImage: string;
1093
- selfieImageEncryption?: boolean | undefined;
2016
+ export type StartJourneyRequest = {
2017
+ resourceId: string;
2018
+ context: StartJourneyContext;
2019
+ scenario?: Scenario | undefined;
1094
2020
  };
1095
2021
 
1096
- export type StartJourneyBiometric3 = {
1097
- id?: string | undefined;
1098
- type?: string | undefined;
1099
- faceImage: string;
2022
+ /** @internal */
2023
+ export type StartJourneyIdentityAlias$Outbound = {
2024
+ title?: string | undefined;
2025
+ firstName?: string | undefined;
2026
+ middleNames?: Array<string> | undefined;
2027
+ lastNames?: Array<string> | undefined;
2028
+ lastNamesAtBirth?: Array<string> | undefined;
2029
+ fullName?: string | undefined;
1100
2030
  };
1101
2031
 
1102
- export type StartJourneyBiometric2 = {
1103
- id?: string | undefined;
1104
- type?: string | undefined;
1105
- selfieImage: string;
1106
- anchorImage: string;
1107
- };
2032
+ /** @internal */
2033
+ export const StartJourneyIdentityAlias$outboundSchema: z.ZodMiniType<
2034
+ StartJourneyIdentityAlias$Outbound,
2035
+ StartJourneyIdentityAlias
2036
+ > = z.object({
2037
+ title: z.optional(z.string()),
2038
+ firstName: z.optional(z.string()),
2039
+ middleNames: z.optional(z.array(z.string())),
2040
+ lastNames: z.optional(z.array(z.string())),
2041
+ lastNamesAtBirth: z.optional(z.array(z.string())),
2042
+ fullName: z.optional(z.string()),
2043
+ });
1108
2044
 
1109
- export type StartJourneyBiometric1 = {
1110
- id?: string | undefined;
1111
- type?: string | undefined;
1112
- face1Image: string;
1113
- face2Image: string;
2045
+ export function startJourneyIdentityAliasToJSON(
2046
+ startJourneyIdentityAlias: StartJourneyIdentityAlias,
2047
+ ): string {
2048
+ return JSON.stringify(
2049
+ StartJourneyIdentityAlias$outboundSchema.parse(startJourneyIdentityAlias),
2050
+ );
2051
+ }
2052
+
2053
+ /** @internal */
2054
+ export const StartJourneyIdentityRelationship$outboundSchema: z.ZodMiniEnum<
2055
+ typeof StartJourneyIdentityRelationship
2056
+ > = z.enum(StartJourneyIdentityRelationship);
2057
+
2058
+ /** @internal */
2059
+ export type StartJourneyIdentityRelatedPerson$Outbound = {
2060
+ title?: string | undefined;
2061
+ firstName?: string | undefined;
2062
+ middleNames?: Array<string> | undefined;
2063
+ lastNames?: Array<string> | undefined;
2064
+ lastNamesAtBirth?: Array<string> | undefined;
2065
+ relationship: string;
1114
2066
  };
1115
2067
 
1116
- export type StartJourneyBiometricUnion =
1117
- | StartJourneyBiometric1
1118
- | StartJourneyBiometric2
1119
- | StartJourneyBiometric3
1120
- | StartJourneyBiometric4;
2068
+ /** @internal */
2069
+ export const StartJourneyIdentityRelatedPerson$outboundSchema: z.ZodMiniType<
2070
+ StartJourneyIdentityRelatedPerson$Outbound,
2071
+ StartJourneyIdentityRelatedPerson
2072
+ > = z.object({
2073
+ title: z.optional(z.string()),
2074
+ firstName: z.optional(z.string()),
2075
+ middleNames: z.optional(z.array(z.string())),
2076
+ lastNames: z.optional(z.array(z.string())),
2077
+ lastNamesAtBirth: z.optional(z.array(z.string())),
2078
+ relationship: StartJourneyIdentityRelationship$outboundSchema,
2079
+ });
1121
2080
 
1122
- export type StartJourneyUser = {
1123
- id: string;
1124
- email: string;
1125
- domain: string;
2081
+ export function startJourneyIdentityRelatedPersonToJSON(
2082
+ startJourneyIdentityRelatedPerson: StartJourneyIdentityRelatedPerson,
2083
+ ): string {
2084
+ return JSON.stringify(
2085
+ StartJourneyIdentityRelatedPerson$outboundSchema.parse(
2086
+ startJourneyIdentityRelatedPerson,
2087
+ ),
2088
+ );
2089
+ }
2090
+
2091
+ /** @internal */
2092
+ export type StartJourneyIdentityCurrentAddressLocation$Outbound = {
2093
+ latitude?: string | undefined;
2094
+ longitude?: string | undefined;
2095
+ geoAccuracy?: string | undefined;
2096
+ what3words?: string | undefined;
1126
2097
  };
1127
2098
 
1128
- export type StartJourneyClient = {
1129
- id: string;
1130
- ip: string;
1131
- address: string;
2099
+ /** @internal */
2100
+ export const StartJourneyIdentityCurrentAddressLocation$outboundSchema:
2101
+ z.ZodMiniType<
2102
+ StartJourneyIdentityCurrentAddressLocation$Outbound,
2103
+ StartJourneyIdentityCurrentAddressLocation
2104
+ > = z.object({
2105
+ latitude: z.optional(z.string()),
2106
+ longitude: z.optional(z.string()),
2107
+ geoAccuracy: z.optional(z.string()),
2108
+ what3words: z.optional(z.string()),
2109
+ });
2110
+
2111
+ export function startJourneyIdentityCurrentAddressLocationToJSON(
2112
+ startJourneyIdentityCurrentAddressLocation:
2113
+ StartJourneyIdentityCurrentAddressLocation,
2114
+ ): string {
2115
+ return JSON.stringify(
2116
+ StartJourneyIdentityCurrentAddressLocation$outboundSchema.parse(
2117
+ startJourneyIdentityCurrentAddressLocation,
2118
+ ),
2119
+ );
2120
+ }
2121
+
2122
+ /** @internal */
2123
+ export type StartJourneyIdentityCurrentAddress$Outbound = {
2124
+ lines?: Array<string> | undefined;
2125
+ addressString?: string | undefined;
2126
+ premise?: string | undefined;
2127
+ building?: string | undefined;
2128
+ subBuilding?: string | undefined;
2129
+ thoroughfare?: string | undefined;
2130
+ dependentThoroughfare?: string | undefined;
2131
+ locality?: string | undefined;
2132
+ dependentLocality?: string | undefined;
2133
+ doubleDependentLocality?: string | undefined;
2134
+ postalCode?: string | undefined;
2135
+ postBox?: string | undefined;
2136
+ country?: string | undefined;
2137
+ superAdministrativeArea?: string | undefined;
2138
+ administrativeArea?: string | undefined;
2139
+ subAdministrativeArea?: string | undefined;
2140
+ organization?: string | undefined;
2141
+ location?: StartJourneyIdentityCurrentAddressLocation$Outbound | undefined;
1132
2142
  };
1133
2143
 
1134
- export type StartJourneyModel = {
1135
- identifier: string;
1136
- name: string;
2144
+ /** @internal */
2145
+ export const StartJourneyIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
2146
+ StartJourneyIdentityCurrentAddress$Outbound,
2147
+ StartJourneyIdentityCurrentAddress
2148
+ > = z.object({
2149
+ lines: z.optional(z.array(z.string())),
2150
+ addressString: z.optional(z.string()),
2151
+ premise: z.optional(z.string()),
2152
+ building: z.optional(z.string()),
2153
+ subBuilding: z.optional(z.string()),
2154
+ thoroughfare: z.optional(z.string()),
2155
+ dependentThoroughfare: z.optional(z.string()),
2156
+ locality: z.optional(z.string()),
2157
+ dependentLocality: z.optional(z.string()),
2158
+ doubleDependentLocality: z.optional(z.string()),
2159
+ postalCode: z.optional(z.string()),
2160
+ postBox: z.optional(z.string()),
2161
+ country: z.optional(z.string()),
2162
+ superAdministrativeArea: z.optional(z.string()),
2163
+ administrativeArea: z.optional(z.string()),
2164
+ subAdministrativeArea: z.optional(z.string()),
2165
+ organization: z.optional(z.string()),
2166
+ location: z.optional(
2167
+ z.lazy(() => StartJourneyIdentityCurrentAddressLocation$outboundSchema),
2168
+ ),
2169
+ });
2170
+
2171
+ export function startJourneyIdentityCurrentAddressToJSON(
2172
+ startJourneyIdentityCurrentAddress: StartJourneyIdentityCurrentAddress,
2173
+ ): string {
2174
+ return JSON.stringify(
2175
+ StartJourneyIdentityCurrentAddress$outboundSchema.parse(
2176
+ startJourneyIdentityCurrentAddress,
2177
+ ),
2178
+ );
2179
+ }
2180
+
2181
+ /** @internal */
2182
+ export type StartJourneyIdentityPreviousAddressLocation$Outbound = {
2183
+ latitude?: string | undefined;
2184
+ longitude?: string | undefined;
2185
+ geoAccuracy?: string | undefined;
2186
+ what3words?: string | undefined;
1137
2187
  };
1138
2188
 
1139
- export type StartJourneySessionDevice = {
1140
- id: string;
1141
- manufacturer: string;
1142
- model: StartJourneyModel;
2189
+ /** @internal */
2190
+ export const StartJourneyIdentityPreviousAddressLocation$outboundSchema:
2191
+ z.ZodMiniType<
2192
+ StartJourneyIdentityPreviousAddressLocation$Outbound,
2193
+ StartJourneyIdentityPreviousAddressLocation
2194
+ > = z.object({
2195
+ latitude: z.optional(z.string()),
2196
+ longitude: z.optional(z.string()),
2197
+ geoAccuracy: z.optional(z.string()),
2198
+ what3words: z.optional(z.string()),
2199
+ });
2200
+
2201
+ export function startJourneyIdentityPreviousAddressLocationToJSON(
2202
+ startJourneyIdentityPreviousAddressLocation:
2203
+ StartJourneyIdentityPreviousAddressLocation,
2204
+ ): string {
2205
+ return JSON.stringify(
2206
+ StartJourneyIdentityPreviousAddressLocation$outboundSchema.parse(
2207
+ startJourneyIdentityPreviousAddressLocation,
2208
+ ),
2209
+ );
2210
+ }
2211
+
2212
+ /** @internal */
2213
+ export type StartJourneyIdentityPreviousAddress$Outbound = {
2214
+ lines?: Array<string> | undefined;
2215
+ addressString?: string | undefined;
2216
+ premise?: string | undefined;
2217
+ building?: string | undefined;
2218
+ subBuilding?: string | undefined;
2219
+ thoroughfare?: string | undefined;
2220
+ dependentThoroughfare?: string | undefined;
2221
+ locality?: string | undefined;
2222
+ dependentLocality?: string | undefined;
2223
+ doubleDependentLocality?: string | undefined;
2224
+ postalCode?: string | undefined;
2225
+ postBox?: string | undefined;
2226
+ country?: string | undefined;
2227
+ superAdministrativeArea?: string | undefined;
2228
+ administrativeArea?: string | undefined;
2229
+ subAdministrativeArea?: string | undefined;
2230
+ organization?: string | undefined;
2231
+ location?: StartJourneyIdentityPreviousAddressLocation$Outbound | undefined;
2232
+ fromDate?: string | undefined;
2233
+ toDate?: string | undefined;
1143
2234
  };
1144
2235
 
1145
- export type StartJourneyTrace = {
1146
- id: string;
1147
- };
2236
+ /** @internal */
2237
+ export const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
2238
+ StartJourneyIdentityPreviousAddress$Outbound,
2239
+ StartJourneyIdentityPreviousAddress
2240
+ > = z.object({
2241
+ lines: z.optional(z.array(z.string())),
2242
+ addressString: z.optional(z.string()),
2243
+ premise: z.optional(z.string()),
2244
+ building: z.optional(z.string()),
2245
+ subBuilding: z.optional(z.string()),
2246
+ thoroughfare: z.optional(z.string()),
2247
+ dependentThoroughfare: z.optional(z.string()),
2248
+ locality: z.optional(z.string()),
2249
+ dependentLocality: z.optional(z.string()),
2250
+ doubleDependentLocality: z.optional(z.string()),
2251
+ postalCode: z.optional(z.string()),
2252
+ postBox: z.optional(z.string()),
2253
+ country: z.optional(z.string()),
2254
+ superAdministrativeArea: z.optional(z.string()),
2255
+ administrativeArea: z.optional(z.string()),
2256
+ subAdministrativeArea: z.optional(z.string()),
2257
+ organization: z.optional(z.string()),
2258
+ location: z.optional(
2259
+ z.lazy(() => StartJourneyIdentityPreviousAddressLocation$outboundSchema),
2260
+ ),
2261
+ fromDate: z.optional(z.string()),
2262
+ toDate: z.optional(z.string()),
2263
+ });
2264
+
2265
+ export function startJourneyIdentityPreviousAddressToJSON(
2266
+ startJourneyIdentityPreviousAddress: StartJourneyIdentityPreviousAddress,
2267
+ ): string {
2268
+ return JSON.stringify(
2269
+ StartJourneyIdentityPreviousAddress$outboundSchema.parse(
2270
+ startJourneyIdentityPreviousAddress,
2271
+ ),
2272
+ );
2273
+ }
1148
2274
 
1149
- export type StartJourneySpan = {
1150
- id: string;
2275
+ /** @internal */
2276
+ export type StartJourneyIdentityPlaceOfBirthLocation$Outbound = {
2277
+ latitude?: string | undefined;
2278
+ longitude?: string | undefined;
2279
+ geoAccuracy?: string | undefined;
2280
+ what3words?: string | undefined;
1151
2281
  };
1152
2282
 
1153
- export type StartJourneyTransaction = {
1154
- id: string;
1155
- };
2283
+ /** @internal */
2284
+ export const StartJourneyIdentityPlaceOfBirthLocation$outboundSchema:
2285
+ z.ZodMiniType<
2286
+ StartJourneyIdentityPlaceOfBirthLocation$Outbound,
2287
+ StartJourneyIdentityPlaceOfBirthLocation
2288
+ > = z.object({
2289
+ latitude: z.optional(z.string()),
2290
+ longitude: z.optional(z.string()),
2291
+ geoAccuracy: z.optional(z.string()),
2292
+ what3words: z.optional(z.string()),
2293
+ });
1156
2294
 
1157
- export type StartJourneySessionAuth = {
1158
- id: string;
1159
- scope?: string | undefined;
1160
- codeVerifier?: string | undefined;
1161
- code?: string | undefined;
1162
- state?: string | undefined;
1163
- redirectUri?: string | undefined;
1164
- responseType?: string | undefined;
1165
- clientId?: string | undefined;
1166
- clientSecret?: string | undefined;
1167
- };
2295
+ export function startJourneyIdentityPlaceOfBirthLocationToJSON(
2296
+ startJourneyIdentityPlaceOfBirthLocation:
2297
+ StartJourneyIdentityPlaceOfBirthLocation,
2298
+ ): string {
2299
+ return JSON.stringify(
2300
+ StartJourneyIdentityPlaceOfBirthLocation$outboundSchema.parse(
2301
+ startJourneyIdentityPlaceOfBirthLocation,
2302
+ ),
2303
+ );
2304
+ }
1168
2305
 
1169
- export type StartJourneySession = {
1170
- user?: StartJourneyUser | undefined;
1171
- client?: StartJourneyClient | undefined;
1172
- device?: StartJourneySessionDevice | undefined;
1173
- trace?: StartJourneyTrace | undefined;
1174
- span?: StartJourneySpan | undefined;
1175
- transaction?: StartJourneyTransaction | undefined;
1176
- auth?: Array<StartJourneySessionAuth> | undefined;
2306
+ /** @internal */
2307
+ export type StartJourneyIdentityPlaceOfBirth$Outbound = {
2308
+ lines?: Array<string> | undefined;
2309
+ addressString?: string | undefined;
2310
+ premise?: string | undefined;
2311
+ building?: string | undefined;
2312
+ subBuilding?: string | undefined;
2313
+ thoroughfare?: string | undefined;
2314
+ dependentThoroughfare?: string | undefined;
2315
+ locality?: string | undefined;
2316
+ dependentLocality?: string | undefined;
2317
+ doubleDependentLocality?: string | undefined;
2318
+ postalCode?: string | undefined;
2319
+ postBox?: string | undefined;
2320
+ country?: string | undefined;
2321
+ superAdministrativeArea?: string | undefined;
2322
+ administrativeArea?: string | undefined;
2323
+ subAdministrativeArea?: string | undefined;
2324
+ organization?: string | undefined;
2325
+ location?: StartJourneyIdentityPlaceOfBirthLocation$Outbound | undefined;
1177
2326
  };
1178
2327
 
1179
- export const StartJourneyConsentType = {
1180
- Rollup: "rollup",
1181
- Explicit: "explicit",
1182
- Implicit: "implicit",
1183
- } as const;
1184
- export type StartJourneyConsentType = ClosedEnum<
1185
- typeof StartJourneyConsentType
1186
- >;
2328
+ /** @internal */
2329
+ export const StartJourneyIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
2330
+ StartJourneyIdentityPlaceOfBirth$Outbound,
2331
+ StartJourneyIdentityPlaceOfBirth
2332
+ > = z.object({
2333
+ lines: z.optional(z.array(z.string())),
2334
+ addressString: z.optional(z.string()),
2335
+ premise: z.optional(z.string()),
2336
+ building: z.optional(z.string()),
2337
+ subBuilding: z.optional(z.string()),
2338
+ thoroughfare: z.optional(z.string()),
2339
+ dependentThoroughfare: z.optional(z.string()),
2340
+ locality: z.optional(z.string()),
2341
+ dependentLocality: z.optional(z.string()),
2342
+ doubleDependentLocality: z.optional(z.string()),
2343
+ postalCode: z.optional(z.string()),
2344
+ postBox: z.optional(z.string()),
2345
+ country: z.optional(z.string()),
2346
+ superAdministrativeArea: z.optional(z.string()),
2347
+ administrativeArea: z.optional(z.string()),
2348
+ subAdministrativeArea: z.optional(z.string()),
2349
+ organization: z.optional(z.string()),
2350
+ location: z.optional(
2351
+ z.lazy(() => StartJourneyIdentityPlaceOfBirthLocation$outboundSchema),
2352
+ ),
2353
+ });
1187
2354
 
1188
- export type StartJourneyConsent = {
1189
- type?: StartJourneyConsentType | undefined;
1190
- id?: string | undefined;
1191
- version?: string | undefined;
1192
- url: string;
1193
- effectiveDate?: string | undefined;
1194
- expiryDate?: string | undefined;
1195
- terms?: string | undefined;
1196
- purpose?: string | undefined;
1197
- legalBasis?: string | undefined;
1198
- jurisdiction?: string | undefined;
1199
- subject?: string | undefined;
1200
- signatory?: string | undefined;
1201
- };
2355
+ export function startJourneyIdentityPlaceOfBirthToJSON(
2356
+ startJourneyIdentityPlaceOfBirth: StartJourneyIdentityPlaceOfBirth,
2357
+ ): string {
2358
+ return JSON.stringify(
2359
+ StartJourneyIdentityPlaceOfBirth$outboundSchema.parse(
2360
+ startJourneyIdentityPlaceOfBirth,
2361
+ ),
2362
+ );
2363
+ }
1202
2364
 
1203
- export type StartJourneyAccount = {
1204
- /**
1205
- * The type of account, e.g. Bank Account, Building Society
1206
- */
2365
+ /** @internal */
2366
+ export type StartJourneyIdentityIdNumber$Outbound = {
1207
2367
  type: string;
1208
- /**
1209
- * Account number
1210
- */
1211
- accountNumber: string;
1212
- /**
1213
- * UK sort code
1214
- */
1215
- sortCode?: string | undefined;
1216
- /**
1217
- * US ABA routing number
1218
- */
1219
- routingNumber?: string | undefined;
1220
- /**
1221
- * International Bank Account Number
1222
- */
1223
- iban?: string | undefined;
1224
- /**
1225
- * BIC/SWIFT code
1226
- */
1227
- bic?: string | undefined;
1228
- /**
1229
- * Name on the account
1230
- */
1231
- accountHolderName?: string | undefined;
1232
- /**
1233
- * Name of the financial institution
1234
- */
1235
- bankName?: string | undefined;
1236
- /**
1237
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1238
- */
2368
+ idNumber: string;
1239
2369
  country?: string | undefined;
1240
- /**
1241
- * Account classification, e.g. current, savings
1242
- */
1243
- accountType?: string | undefined;
1244
2370
  };
1245
2371
 
1246
- export type StartJourneySubject = {
1247
- identity?: StartJourneyIdentity | undefined;
1248
- documents?: Array<StartJourneyDocument> | undefined;
1249
- biometrics?:
1250
- | Array<
1251
- | StartJourneyBiometric1
1252
- | StartJourneyBiometric2
1253
- | StartJourneyBiometric3
1254
- | StartJourneyBiometric4
1255
- >
1256
- | undefined;
1257
- sessions?: Array<StartJourneySession> | undefined;
1258
- consent?: Array<StartJourneyConsent> | undefined;
1259
- accounts?: Array<StartJourneyAccount> | undefined;
1260
- uid?: string | undefined;
1261
- };
2372
+ /** @internal */
2373
+ export const StartJourneyIdentityIdNumber$outboundSchema: z.ZodMiniType<
2374
+ StartJourneyIdentityIdNumber$Outbound,
2375
+ StartJourneyIdentityIdNumber
2376
+ > = z.object({
2377
+ type: z.string(),
2378
+ idNumber: z.string(),
2379
+ country: z.optional(z.string()),
2380
+ });
1262
2381
 
1263
- export type StartJourneyContext = {
1264
- config: Config;
1265
- subject: StartJourneySubject;
1266
- };
2382
+ export function startJourneyIdentityIdNumberToJSON(
2383
+ startJourneyIdentityIdNumber: StartJourneyIdentityIdNumber,
2384
+ ): string {
2385
+ return JSON.stringify(
2386
+ StartJourneyIdentityIdNumber$outboundSchema.parse(
2387
+ startJourneyIdentityIdNumber,
2388
+ ),
2389
+ );
2390
+ }
1267
2391
 
1268
- export type StartJourneyRequest = {
1269
- /**
1270
- * Resource Id, a unique identifier for a resource, such as a journey or instance.
1271
- */
1272
- resourceId: string;
1273
- context?: StartJourneyContext | undefined;
1274
- data?: { [k: string]: any } | undefined;
2392
+ /** @internal */
2393
+ export type StartJourneyIdentityPhone$Outbound = {
2394
+ type: string;
2395
+ number: string;
1275
2396
  };
1276
2397
 
1277
- /**
1278
- * Start Response contains the Journey Instance Id
1279
- */
1280
- export type StartJourneyResponseBody2 = {
1281
- /**
1282
- * Journey Instance Id, a unique identifier for a started journey instance.
1283
- */
1284
- instanceId: string;
1285
- [additionalProperties: string]: unknown;
1286
- };
2398
+ /** @internal */
2399
+ export const StartJourneyIdentityPhone$outboundSchema: z.ZodMiniType<
2400
+ StartJourneyIdentityPhone$Outbound,
2401
+ StartJourneyIdentityPhone
2402
+ > = z.object({
2403
+ type: z.string(),
2404
+ number: z.string(),
2405
+ });
2406
+
2407
+ export function startJourneyIdentityPhoneToJSON(
2408
+ startJourneyIdentityPhone: StartJourneyIdentityPhone,
2409
+ ): string {
2410
+ return JSON.stringify(
2411
+ StartJourneyIdentityPhone$outboundSchema.parse(startJourneyIdentityPhone),
2412
+ );
2413
+ }
1287
2414
 
1288
- /**
1289
- * Start Response contains the Journey Instance Id
1290
- */
1291
- export type StartJourneyResponseBody1 = {
1292
- /**
1293
- * Journey Instance Id, a unique identifier for a started journey instance.
1294
- */
1295
- instanceId: string;
1296
- [additionalProperties: string]: unknown;
2415
+ /** @internal */
2416
+ export type StartJourneyIdentityEmail$Outbound = {
2417
+ type: string;
2418
+ email: string;
1297
2419
  };
1298
2420
 
1299
- export type StartJourneyResponse =
1300
- | StartJourneyResponseBody1
1301
- | StartJourneyResponseBody2;
1302
-
1303
2421
  /** @internal */
1304
- export const Delivery$outboundSchema: z.ZodMiniEnum<typeof Delivery> = z.enum(
1305
- Delivery,
1306
- );
2422
+ export const StartJourneyIdentityEmail$outboundSchema: z.ZodMiniType<
2423
+ StartJourneyIdentityEmail$Outbound,
2424
+ StartJourneyIdentityEmail
2425
+ > = z.object({
2426
+ type: z.string(),
2427
+ email: z.string(),
2428
+ });
2429
+
2430
+ export function startJourneyIdentityEmailToJSON(
2431
+ startJourneyIdentityEmail: StartJourneyIdentityEmail,
2432
+ ): string {
2433
+ return JSON.stringify(
2434
+ StartJourneyIdentityEmail$outboundSchema.parse(startJourneyIdentityEmail),
2435
+ );
2436
+ }
1307
2437
 
1308
2438
  /** @internal */
1309
- export type Config$Outbound = {
1310
- delivery: string;
2439
+ export type StartJourneyIdentitySocial$Outbound = {
2440
+ type: string;
2441
+ identity: string;
1311
2442
  };
1312
2443
 
1313
2444
  /** @internal */
1314
- export const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config> = z
1315
- .object({
1316
- delivery: Delivery$outboundSchema,
1317
- });
2445
+ export const StartJourneyIdentitySocial$outboundSchema: z.ZodMiniType<
2446
+ StartJourneyIdentitySocial$Outbound,
2447
+ StartJourneyIdentitySocial
2448
+ > = z.object({
2449
+ type: z.string(),
2450
+ identity: z.string(),
2451
+ });
1318
2452
 
1319
- export function configToJSON(config: Config): string {
1320
- return JSON.stringify(Config$outboundSchema.parse(config));
2453
+ export function startJourneyIdentitySocialToJSON(
2454
+ startJourneyIdentitySocial: StartJourneyIdentitySocial,
2455
+ ): string {
2456
+ return JSON.stringify(
2457
+ StartJourneyIdentitySocial$outboundSchema.parse(startJourneyIdentitySocial),
2458
+ );
1321
2459
  }
1322
2460
 
1323
2461
  /** @internal */
1324
- export type StartJourneyIdentityAlias$Outbound = {
2462
+ export type StartJourneyIdentity$Outbound = {
1325
2463
  title?: string | undefined;
1326
2464
  firstName?: string | undefined;
1327
2465
  middleNames?: Array<string> | undefined;
1328
2466
  lastNames?: Array<string> | undefined;
1329
2467
  lastNamesAtBirth?: Array<string> | undefined;
2468
+ aliases?: Array<StartJourneyIdentityAlias$Outbound> | undefined;
2469
+ relatedPersons?:
2470
+ | Array<StartJourneyIdentityRelatedPerson$Outbound>
2471
+ | undefined;
2472
+ dateOfBirth?: string | undefined;
2473
+ gender?: string | undefined;
2474
+ currentAddress?: StartJourneyIdentityCurrentAddress$Outbound | undefined;
2475
+ previousAddresses?:
2476
+ | Array<StartJourneyIdentityPreviousAddress$Outbound>
2477
+ | undefined;
2478
+ placeOfBirth?: StartJourneyIdentityPlaceOfBirth$Outbound | undefined;
2479
+ idNumbers?: Array<StartJourneyIdentityIdNumber$Outbound> | undefined;
2480
+ phones?: Array<StartJourneyIdentityPhone$Outbound> | undefined;
2481
+ emails?: Array<StartJourneyIdentityEmail$Outbound> | undefined;
2482
+ socials?: Array<StartJourneyIdentitySocial$Outbound> | undefined;
2483
+ mothersMaidenName?: string | undefined;
2484
+ nationality?: string | undefined;
1330
2485
  };
1331
2486
 
1332
2487
  /** @internal */
1333
- export const StartJourneyIdentityAlias$outboundSchema: z.ZodMiniType<
1334
- StartJourneyIdentityAlias$Outbound,
1335
- StartJourneyIdentityAlias
2488
+ export const StartJourneyIdentity$outboundSchema: z.ZodMiniType<
2489
+ StartJourneyIdentity$Outbound,
2490
+ StartJourneyIdentity
1336
2491
  > = z.object({
1337
2492
  title: z.optional(z.string()),
1338
2493
  firstName: z.optional(z.string()),
1339
2494
  middleNames: z.optional(z.array(z.string())),
1340
2495
  lastNames: z.optional(z.array(z.string())),
1341
2496
  lastNamesAtBirth: z.optional(z.array(z.string())),
2497
+ aliases: z.optional(
2498
+ z.array(z.lazy(() => StartJourneyIdentityAlias$outboundSchema)),
2499
+ ),
2500
+ relatedPersons: z.optional(
2501
+ z.array(z.lazy(() => StartJourneyIdentityRelatedPerson$outboundSchema)),
2502
+ ),
2503
+ dateOfBirth: z.optional(z.string()),
2504
+ gender: z.optional(z.string()),
2505
+ currentAddress: z.optional(
2506
+ z.lazy(() => StartJourneyIdentityCurrentAddress$outboundSchema),
2507
+ ),
2508
+ previousAddresses: z.optional(
2509
+ z.array(z.lazy(() => StartJourneyIdentityPreviousAddress$outboundSchema)),
2510
+ ),
2511
+ placeOfBirth: z.optional(
2512
+ z.lazy(() => StartJourneyIdentityPlaceOfBirth$outboundSchema),
2513
+ ),
2514
+ idNumbers: z.optional(
2515
+ z.array(z.lazy(() => StartJourneyIdentityIdNumber$outboundSchema)),
2516
+ ),
2517
+ phones: z.optional(
2518
+ z.array(z.lazy(() => StartJourneyIdentityPhone$outboundSchema)),
2519
+ ),
2520
+ emails: z.optional(
2521
+ z.array(z.lazy(() => StartJourneyIdentityEmail$outboundSchema)),
2522
+ ),
2523
+ socials: z.optional(
2524
+ z.array(z.lazy(() => StartJourneyIdentitySocial$outboundSchema)),
2525
+ ),
2526
+ mothersMaidenName: z.optional(z.string()),
2527
+ nationality: z.optional(z.string()),
1342
2528
  });
1343
2529
 
1344
- export function startJourneyIdentityAliasToJSON(
1345
- startJourneyIdentityAlias: StartJourneyIdentityAlias,
2530
+ export function startJourneyIdentityToJSON(
2531
+ startJourneyIdentity: StartJourneyIdentity,
1346
2532
  ): string {
1347
2533
  return JSON.stringify(
1348
- StartJourneyIdentityAlias$outboundSchema.parse(startJourneyIdentityAlias),
2534
+ StartJourneyIdentity$outboundSchema.parse(startJourneyIdentity),
1349
2535
  );
1350
2536
  }
1351
2537
 
1352
2538
  /** @internal */
1353
- export const StartJourneyIdentityRelationship$outboundSchema: z.ZodMiniEnum<
1354
- typeof StartJourneyIdentityRelationship
1355
- > = z.enum(StartJourneyIdentityRelationship);
2539
+ export const StartJourneyTypePrimary1$outboundSchema: z.ZodMiniEnum<
2540
+ typeof StartJourneyTypePrimary1
2541
+ > = z.enum(StartJourneyTypePrimary1);
1356
2542
 
1357
2543
  /** @internal */
1358
- export type StartJourneyIdentityRelatedPerson$Outbound = {
1359
- title?: string | undefined;
1360
- firstName?: string | undefined;
1361
- middleNames?: Array<string> | undefined;
1362
- lastNames?: Array<string> | undefined;
1363
- lastNamesAtBirth?: Array<string> | undefined;
1364
- relationship: string;
2544
+ export const StartJourneyStatus$outboundSchema: z.ZodMiniEnum<
2545
+ typeof StartJourneyStatus
2546
+ > = z.enum(StartJourneyStatus);
2547
+
2548
+ /** @internal */
2549
+ export type StartJourneyAddressLocation$Outbound = {
2550
+ latitude?: string | undefined;
2551
+ longitude?: string | undefined;
2552
+ geoAccuracy?: string | undefined;
2553
+ what3words?: string | undefined;
1365
2554
  };
1366
2555
 
1367
2556
  /** @internal */
1368
- export const StartJourneyIdentityRelatedPerson$outboundSchema: z.ZodMiniType<
1369
- StartJourneyIdentityRelatedPerson$Outbound,
1370
- StartJourneyIdentityRelatedPerson
2557
+ export const StartJourneyAddressLocation$outboundSchema: z.ZodMiniType<
2558
+ StartJourneyAddressLocation$Outbound,
2559
+ StartJourneyAddressLocation
1371
2560
  > = z.object({
1372
- title: z.optional(z.string()),
1373
- firstName: z.optional(z.string()),
1374
- middleNames: z.optional(z.array(z.string())),
1375
- lastNames: z.optional(z.array(z.string())),
1376
- lastNamesAtBirth: z.optional(z.array(z.string())),
1377
- relationship: StartJourneyIdentityRelationship$outboundSchema,
2561
+ latitude: z.optional(z.string()),
2562
+ longitude: z.optional(z.string()),
2563
+ geoAccuracy: z.optional(z.string()),
2564
+ what3words: z.optional(z.string()),
1378
2565
  });
1379
2566
 
1380
- export function startJourneyIdentityRelatedPersonToJSON(
1381
- startJourneyIdentityRelatedPerson: StartJourneyIdentityRelatedPerson,
2567
+ export function startJourneyAddressLocationToJSON(
2568
+ startJourneyAddressLocation: StartJourneyAddressLocation,
1382
2569
  ): string {
1383
2570
  return JSON.stringify(
1384
- StartJourneyIdentityRelatedPerson$outboundSchema.parse(
1385
- startJourneyIdentityRelatedPerson,
2571
+ StartJourneyAddressLocation$outboundSchema.parse(
2572
+ startJourneyAddressLocation,
1386
2573
  ),
1387
2574
  );
1388
2575
  }
1389
2576
 
1390
2577
  /** @internal */
1391
- export type StartJourneyIdentityCurrentAddressLocation$Outbound = {
2578
+ export const StartJourneyPurpose$outboundSchema: z.ZodMiniEnum<
2579
+ typeof StartJourneyPurpose
2580
+ > = z.enum(StartJourneyPurpose);
2581
+
2582
+ /** @internal */
2583
+ export type StartJourneyAddressPrimary$Outbound = {
2584
+ lines?: Array<string> | undefined;
2585
+ addressString?: string | undefined;
2586
+ premise?: string | undefined;
2587
+ building?: string | undefined;
2588
+ subBuilding?: string | undefined;
2589
+ thoroughfare?: string | undefined;
2590
+ dependentThoroughfare?: string | undefined;
2591
+ locality?: string | undefined;
2592
+ dependentLocality?: string | undefined;
2593
+ doubleDependentLocality?: string | undefined;
2594
+ postalCode?: string | undefined;
2595
+ postBox?: string | undefined;
2596
+ country?: string | undefined;
2597
+ superAdministrativeArea?: string | undefined;
2598
+ administrativeArea?: string | undefined;
2599
+ subAdministrativeArea?: string | undefined;
2600
+ organization?: string | undefined;
2601
+ location?: StartJourneyAddressLocation$Outbound | undefined;
2602
+ purpose?: string | undefined;
2603
+ };
2604
+
2605
+ /** @internal */
2606
+ export const StartJourneyAddressPrimary$outboundSchema: z.ZodMiniType<
2607
+ StartJourneyAddressPrimary$Outbound,
2608
+ StartJourneyAddressPrimary
2609
+ > = z.object({
2610
+ lines: z.optional(z.array(z.string())),
2611
+ addressString: z.optional(z.string()),
2612
+ premise: z.optional(z.string()),
2613
+ building: z.optional(z.string()),
2614
+ subBuilding: z.optional(z.string()),
2615
+ thoroughfare: z.optional(z.string()),
2616
+ dependentThoroughfare: z.optional(z.string()),
2617
+ locality: z.optional(z.string()),
2618
+ dependentLocality: z.optional(z.string()),
2619
+ doubleDependentLocality: z.optional(z.string()),
2620
+ postalCode: z.optional(z.string()),
2621
+ postBox: z.optional(z.string()),
2622
+ country: z.optional(z.string()),
2623
+ superAdministrativeArea: z.optional(z.string()),
2624
+ administrativeArea: z.optional(z.string()),
2625
+ subAdministrativeArea: z.optional(z.string()),
2626
+ organization: z.optional(z.string()),
2627
+ location: z.optional(
2628
+ z.lazy(() => StartJourneyAddressLocation$outboundSchema),
2629
+ ),
2630
+ purpose: z.optional(StartJourneyPurpose$outboundSchema),
2631
+ });
2632
+
2633
+ export function startJourneyAddressPrimaryToJSON(
2634
+ startJourneyAddressPrimary: StartJourneyAddressPrimary,
2635
+ ): string {
2636
+ return JSON.stringify(
2637
+ StartJourneyAddressPrimary$outboundSchema.parse(startJourneyAddressPrimary),
2638
+ );
2639
+ }
2640
+
2641
+ /** @internal */
2642
+ export const StartJourneyTaxIdentifierType$outboundSchema: z.ZodMiniEnum<
2643
+ typeof StartJourneyTaxIdentifierType
2644
+ > = z.enum(StartJourneyTaxIdentifierType);
2645
+
2646
+ /** @internal */
2647
+ export type StartJourneyTaxIdentifier$Outbound = {
2648
+ type: string;
2649
+ value: string;
2650
+ country?: string | undefined;
2651
+ };
2652
+
2653
+ /** @internal */
2654
+ export const StartJourneyTaxIdentifier$outboundSchema: z.ZodMiniType<
2655
+ StartJourneyTaxIdentifier$Outbound,
2656
+ StartJourneyTaxIdentifier
2657
+ > = z.object({
2658
+ type: StartJourneyTaxIdentifierType$outboundSchema,
2659
+ value: z.string(),
2660
+ country: z.optional(z.string()),
2661
+ });
2662
+
2663
+ export function startJourneyTaxIdentifierToJSON(
2664
+ startJourneyTaxIdentifier: StartJourneyTaxIdentifier,
2665
+ ): string {
2666
+ return JSON.stringify(
2667
+ StartJourneyTaxIdentifier$outboundSchema.parse(startJourneyTaxIdentifier),
2668
+ );
2669
+ }
2670
+
2671
+ /** @internal */
2672
+ export const StartJourneySystem$outboundSchema: z.ZodMiniEnum<
2673
+ typeof StartJourneySystem
2674
+ > = z.enum(StartJourneySystem);
2675
+
2676
+ /** @internal */
2677
+ export type StartJourneyIndustryClassification$Outbound = {
2678
+ system: string;
2679
+ code: string;
2680
+ description?: string | undefined;
2681
+ };
2682
+
2683
+ /** @internal */
2684
+ export const StartJourneyIndustryClassification$outboundSchema: z.ZodMiniType<
2685
+ StartJourneyIndustryClassification$Outbound,
2686
+ StartJourneyIndustryClassification
2687
+ > = z.object({
2688
+ system: StartJourneySystem$outboundSchema,
2689
+ code: z.string(),
2690
+ description: z.optional(z.string()),
2691
+ });
2692
+
2693
+ export function startJourneyIndustryClassificationToJSON(
2694
+ startJourneyIndustryClassification: StartJourneyIndustryClassification,
2695
+ ): string {
2696
+ return JSON.stringify(
2697
+ StartJourneyIndustryClassification$outboundSchema.parse(
2698
+ startJourneyIndustryClassification,
2699
+ ),
2700
+ );
2701
+ }
2702
+
2703
+ /** @internal */
2704
+ export const StartJourneyRegistrationType$outboundSchema: z.ZodMiniEnum<
2705
+ typeof StartJourneyRegistrationType
2706
+ > = z.enum(StartJourneyRegistrationType);
2707
+
2708
+ /** @internal */
2709
+ export type StartJourneyRegisteredAddressLocation$Outbound = {
1392
2710
  latitude?: string | undefined;
1393
2711
  longitude?: string | undefined;
1394
2712
  geoAccuracy?: string | undefined;
@@ -1396,10 +2714,10 @@ export type StartJourneyIdentityCurrentAddressLocation$Outbound = {
1396
2714
  };
1397
2715
 
1398
2716
  /** @internal */
1399
- export const StartJourneyIdentityCurrentAddressLocation$outboundSchema:
2717
+ export const StartJourneyRegisteredAddressLocation$outboundSchema:
1400
2718
  z.ZodMiniType<
1401
- StartJourneyIdentityCurrentAddressLocation$Outbound,
1402
- StartJourneyIdentityCurrentAddressLocation
2719
+ StartJourneyRegisteredAddressLocation$Outbound,
2720
+ StartJourneyRegisteredAddressLocation
1403
2721
  > = z.object({
1404
2722
  latitude: z.optional(z.string()),
1405
2723
  longitude: z.optional(z.string()),
@@ -1407,19 +2725,18 @@ export const StartJourneyIdentityCurrentAddressLocation$outboundSchema:
1407
2725
  what3words: z.optional(z.string()),
1408
2726
  });
1409
2727
 
1410
- export function startJourneyIdentityCurrentAddressLocationToJSON(
1411
- startJourneyIdentityCurrentAddressLocation:
1412
- StartJourneyIdentityCurrentAddressLocation,
2728
+ export function startJourneyRegisteredAddressLocationToJSON(
2729
+ startJourneyRegisteredAddressLocation: StartJourneyRegisteredAddressLocation,
1413
2730
  ): string {
1414
2731
  return JSON.stringify(
1415
- StartJourneyIdentityCurrentAddressLocation$outboundSchema.parse(
1416
- startJourneyIdentityCurrentAddressLocation,
2732
+ StartJourneyRegisteredAddressLocation$outboundSchema.parse(
2733
+ startJourneyRegisteredAddressLocation,
1417
2734
  ),
1418
2735
  );
1419
2736
  }
1420
2737
 
1421
2738
  /** @internal */
1422
- export type StartJourneyIdentityCurrentAddress$Outbound = {
2739
+ export type StartJourneyRegisteredAddress$Outbound = {
1423
2740
  lines?: Array<string> | undefined;
1424
2741
  addressString?: string | undefined;
1425
2742
  premise?: string | undefined;
@@ -1437,13 +2754,13 @@ export type StartJourneyIdentityCurrentAddress$Outbound = {
1437
2754
  administrativeArea?: string | undefined;
1438
2755
  subAdministrativeArea?: string | undefined;
1439
2756
  organization?: string | undefined;
1440
- location?: StartJourneyIdentityCurrentAddressLocation$Outbound | undefined;
2757
+ location?: StartJourneyRegisteredAddressLocation$Outbound | undefined;
1441
2758
  };
1442
2759
 
1443
2760
  /** @internal */
1444
- export const StartJourneyIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
1445
- StartJourneyIdentityCurrentAddress$Outbound,
1446
- StartJourneyIdentityCurrentAddress
2761
+ export const StartJourneyRegisteredAddress$outboundSchema: z.ZodMiniType<
2762
+ StartJourneyRegisteredAddress$Outbound,
2763
+ StartJourneyRegisteredAddress
1447
2764
  > = z.object({
1448
2765
  lines: z.optional(z.array(z.string())),
1449
2766
  addressString: z.optional(z.string()),
@@ -1463,53 +2780,51 @@ export const StartJourneyIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
1463
2780
  subAdministrativeArea: z.optional(z.string()),
1464
2781
  organization: z.optional(z.string()),
1465
2782
  location: z.optional(
1466
- z.lazy(() => StartJourneyIdentityCurrentAddressLocation$outboundSchema),
2783
+ z.lazy(() => StartJourneyRegisteredAddressLocation$outboundSchema),
1467
2784
  ),
1468
2785
  });
1469
2786
 
1470
- export function startJourneyIdentityCurrentAddressToJSON(
1471
- startJourneyIdentityCurrentAddress: StartJourneyIdentityCurrentAddress,
2787
+ export function startJourneyRegisteredAddressToJSON(
2788
+ startJourneyRegisteredAddress: StartJourneyRegisteredAddress,
1472
2789
  ): string {
1473
2790
  return JSON.stringify(
1474
- StartJourneyIdentityCurrentAddress$outboundSchema.parse(
1475
- startJourneyIdentityCurrentAddress,
2791
+ StartJourneyRegisteredAddress$outboundSchema.parse(
2792
+ startJourneyRegisteredAddress,
1476
2793
  ),
1477
2794
  );
1478
2795
  }
1479
2796
 
1480
2797
  /** @internal */
1481
- export type StartJourneyIdentityPreviousAddressLocation$Outbound = {
2798
+ export type StartJourneyAgentAddressLocation$Outbound = {
1482
2799
  latitude?: string | undefined;
1483
2800
  longitude?: string | undefined;
1484
2801
  geoAccuracy?: string | undefined;
1485
2802
  what3words?: string | undefined;
1486
2803
  };
1487
2804
 
1488
- /** @internal */
1489
- export const StartJourneyIdentityPreviousAddressLocation$outboundSchema:
1490
- z.ZodMiniType<
1491
- StartJourneyIdentityPreviousAddressLocation$Outbound,
1492
- StartJourneyIdentityPreviousAddressLocation
1493
- > = z.object({
1494
- latitude: z.optional(z.string()),
1495
- longitude: z.optional(z.string()),
1496
- geoAccuracy: z.optional(z.string()),
1497
- what3words: z.optional(z.string()),
1498
- });
2805
+ /** @internal */
2806
+ export const StartJourneyAgentAddressLocation$outboundSchema: z.ZodMiniType<
2807
+ StartJourneyAgentAddressLocation$Outbound,
2808
+ StartJourneyAgentAddressLocation
2809
+ > = z.object({
2810
+ latitude: z.optional(z.string()),
2811
+ longitude: z.optional(z.string()),
2812
+ geoAccuracy: z.optional(z.string()),
2813
+ what3words: z.optional(z.string()),
2814
+ });
1499
2815
 
1500
- export function startJourneyIdentityPreviousAddressLocationToJSON(
1501
- startJourneyIdentityPreviousAddressLocation:
1502
- StartJourneyIdentityPreviousAddressLocation,
2816
+ export function startJourneyAgentAddressLocationToJSON(
2817
+ startJourneyAgentAddressLocation: StartJourneyAgentAddressLocation,
1503
2818
  ): string {
1504
2819
  return JSON.stringify(
1505
- StartJourneyIdentityPreviousAddressLocation$outboundSchema.parse(
1506
- startJourneyIdentityPreviousAddressLocation,
2820
+ StartJourneyAgentAddressLocation$outboundSchema.parse(
2821
+ startJourneyAgentAddressLocation,
1507
2822
  ),
1508
2823
  );
1509
2824
  }
1510
2825
 
1511
2826
  /** @internal */
1512
- export type StartJourneyIdentityPreviousAddress$Outbound = {
2827
+ export type StartJourneyAgentAddress$Outbound = {
1513
2828
  lines?: Array<string> | undefined;
1514
2829
  addressString?: string | undefined;
1515
2830
  premise?: string | undefined;
@@ -1527,15 +2842,13 @@ export type StartJourneyIdentityPreviousAddress$Outbound = {
1527
2842
  administrativeArea?: string | undefined;
1528
2843
  subAdministrativeArea?: string | undefined;
1529
2844
  organization?: string | undefined;
1530
- location?: StartJourneyIdentityPreviousAddressLocation$Outbound | undefined;
1531
- fromDate: string;
1532
- toDate: string;
2845
+ location?: StartJourneyAgentAddressLocation$Outbound | undefined;
1533
2846
  };
1534
2847
 
1535
2848
  /** @internal */
1536
- export const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
1537
- StartJourneyIdentityPreviousAddress$Outbound,
1538
- StartJourneyIdentityPreviousAddress
2849
+ export const StartJourneyAgentAddress$outboundSchema: z.ZodMiniType<
2850
+ StartJourneyAgentAddress$Outbound,
2851
+ StartJourneyAgentAddress
1539
2852
  > = z.object({
1540
2853
  lines: z.optional(z.array(z.string())),
1541
2854
  addressString: z.optional(z.string()),
@@ -1555,24 +2868,67 @@ export const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
1555
2868
  subAdministrativeArea: z.optional(z.string()),
1556
2869
  organization: z.optional(z.string()),
1557
2870
  location: z.optional(
1558
- z.lazy(() => StartJourneyIdentityPreviousAddressLocation$outboundSchema),
2871
+ z.lazy(() => StartJourneyAgentAddressLocation$outboundSchema),
1559
2872
  ),
1560
- fromDate: z.string(),
1561
- toDate: z.string(),
1562
2873
  });
1563
2874
 
1564
- export function startJourneyIdentityPreviousAddressToJSON(
1565
- startJourneyIdentityPreviousAddress: StartJourneyIdentityPreviousAddress,
2875
+ export function startJourneyAgentAddressToJSON(
2876
+ startJourneyAgentAddress: StartJourneyAgentAddress,
1566
2877
  ): string {
1567
2878
  return JSON.stringify(
1568
- StartJourneyIdentityPreviousAddress$outboundSchema.parse(
1569
- startJourneyIdentityPreviousAddress,
1570
- ),
2879
+ StartJourneyAgentAddress$outboundSchema.parse(startJourneyAgentAddress),
1571
2880
  );
1572
2881
  }
1573
2882
 
1574
2883
  /** @internal */
1575
- export type StartJourneyIdentityPlaceOfBirthLocation$Outbound = {
2884
+ export type StartJourneyRegistration$Outbound = {
2885
+ jurisdiction?: string | undefined;
2886
+ registrationType?: string | undefined;
2887
+ fileNumber?: string | undefined;
2888
+ issueDate?: string | undefined;
2889
+ registeredAddress?: StartJourneyRegisteredAddress$Outbound | undefined;
2890
+ agentName?: string | undefined;
2891
+ agentAddress?: StartJourneyAgentAddress$Outbound | undefined;
2892
+ };
2893
+
2894
+ /** @internal */
2895
+ export const StartJourneyRegistration$outboundSchema: z.ZodMiniType<
2896
+ StartJourneyRegistration$Outbound,
2897
+ StartJourneyRegistration
2898
+ > = z.object({
2899
+ jurisdiction: z.optional(z.string()),
2900
+ registrationType: z.optional(StartJourneyRegistrationType$outboundSchema),
2901
+ fileNumber: z.optional(z.string()),
2902
+ issueDate: z.optional(z.string()),
2903
+ registeredAddress: z.optional(
2904
+ z.lazy(() => StartJourneyRegisteredAddress$outboundSchema),
2905
+ ),
2906
+ agentName: z.optional(z.string()),
2907
+ agentAddress: z.optional(
2908
+ z.lazy(() => StartJourneyAgentAddress$outboundSchema),
2909
+ ),
2910
+ });
2911
+
2912
+ export function startJourneyRegistrationToJSON(
2913
+ startJourneyRegistration: StartJourneyRegistration,
2914
+ ): string {
2915
+ return JSON.stringify(
2916
+ StartJourneyRegistration$outboundSchema.parse(startJourneyRegistration),
2917
+ );
2918
+ }
2919
+
2920
+ /** @internal */
2921
+ export const StartJourneyTypePrimary2$outboundSchema: z.ZodMiniEnum<
2922
+ typeof StartJourneyTypePrimary2
2923
+ > = z.enum(StartJourneyTypePrimary2);
2924
+
2925
+ /** @internal */
2926
+ export const StartJourneyRole$outboundSchema: z.ZodMiniEnum<
2927
+ typeof StartJourneyRole
2928
+ > = z.enum(StartJourneyRole);
2929
+
2930
+ /** @internal */
2931
+ export type StartJourneyCurrentAddressLocationPrimary$Outbound = {
1576
2932
  latitude?: string | undefined;
1577
2933
  longitude?: string | undefined;
1578
2934
  geoAccuracy?: string | undefined;
@@ -1580,10 +2936,10 @@ export type StartJourneyIdentityPlaceOfBirthLocation$Outbound = {
1580
2936
  };
1581
2937
 
1582
2938
  /** @internal */
1583
- export const StartJourneyIdentityPlaceOfBirthLocation$outboundSchema:
2939
+ export const StartJourneyCurrentAddressLocationPrimary$outboundSchema:
1584
2940
  z.ZodMiniType<
1585
- StartJourneyIdentityPlaceOfBirthLocation$Outbound,
1586
- StartJourneyIdentityPlaceOfBirthLocation
2941
+ StartJourneyCurrentAddressLocationPrimary$Outbound,
2942
+ StartJourneyCurrentAddressLocationPrimary
1587
2943
  > = z.object({
1588
2944
  latitude: z.optional(z.string()),
1589
2945
  longitude: z.optional(z.string()),
@@ -1591,19 +2947,19 @@ export const StartJourneyIdentityPlaceOfBirthLocation$outboundSchema:
1591
2947
  what3words: z.optional(z.string()),
1592
2948
  });
1593
2949
 
1594
- export function startJourneyIdentityPlaceOfBirthLocationToJSON(
1595
- startJourneyIdentityPlaceOfBirthLocation:
1596
- StartJourneyIdentityPlaceOfBirthLocation,
2950
+ export function startJourneyCurrentAddressLocationPrimaryToJSON(
2951
+ startJourneyCurrentAddressLocationPrimary:
2952
+ StartJourneyCurrentAddressLocationPrimary,
1597
2953
  ): string {
1598
2954
  return JSON.stringify(
1599
- StartJourneyIdentityPlaceOfBirthLocation$outboundSchema.parse(
1600
- startJourneyIdentityPlaceOfBirthLocation,
2955
+ StartJourneyCurrentAddressLocationPrimary$outboundSchema.parse(
2956
+ startJourneyCurrentAddressLocationPrimary,
1601
2957
  ),
1602
2958
  );
1603
2959
  }
1604
2960
 
1605
2961
  /** @internal */
1606
- export type StartJourneyIdentityPlaceOfBirth$Outbound = {
2962
+ export type StartJourneyCurrentAddressPrimary$Outbound = {
1607
2963
  lines?: Array<string> | undefined;
1608
2964
  addressString?: string | undefined;
1609
2965
  premise?: string | undefined;
@@ -1621,13 +2977,13 @@ export type StartJourneyIdentityPlaceOfBirth$Outbound = {
1621
2977
  administrativeArea?: string | undefined;
1622
2978
  subAdministrativeArea?: string | undefined;
1623
2979
  organization?: string | undefined;
1624
- location?: StartJourneyIdentityPlaceOfBirthLocation$Outbound | undefined;
2980
+ location?: StartJourneyCurrentAddressLocationPrimary$Outbound | undefined;
1625
2981
  };
1626
2982
 
1627
2983
  /** @internal */
1628
- export const StartJourneyIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
1629
- StartJourneyIdentityPlaceOfBirth$Outbound,
1630
- StartJourneyIdentityPlaceOfBirth
2984
+ export const StartJourneyCurrentAddressPrimary$outboundSchema: z.ZodMiniType<
2985
+ StartJourneyCurrentAddressPrimary$Outbound,
2986
+ StartJourneyCurrentAddressPrimary
1631
2987
  > = z.object({
1632
2988
  lines: z.optional(z.array(z.string())),
1633
2989
  addressString: z.optional(z.string()),
@@ -1647,193 +3003,167 @@ export const StartJourneyIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
1647
3003
  subAdministrativeArea: z.optional(z.string()),
1648
3004
  organization: z.optional(z.string()),
1649
3005
  location: z.optional(
1650
- z.lazy(() => StartJourneyIdentityPlaceOfBirthLocation$outboundSchema),
3006
+ z.lazy(() => StartJourneyCurrentAddressLocationPrimary$outboundSchema),
1651
3007
  ),
1652
3008
  });
1653
3009
 
1654
- export function startJourneyIdentityPlaceOfBirthToJSON(
1655
- startJourneyIdentityPlaceOfBirth: StartJourneyIdentityPlaceOfBirth,
3010
+ export function startJourneyCurrentAddressPrimaryToJSON(
3011
+ startJourneyCurrentAddressPrimary: StartJourneyCurrentAddressPrimary,
1656
3012
  ): string {
1657
3013
  return JSON.stringify(
1658
- StartJourneyIdentityPlaceOfBirth$outboundSchema.parse(
1659
- startJourneyIdentityPlaceOfBirth,
3014
+ StartJourneyCurrentAddressPrimary$outboundSchema.parse(
3015
+ startJourneyCurrentAddressPrimary,
1660
3016
  ),
1661
3017
  );
1662
3018
  }
1663
3019
 
1664
3020
  /** @internal */
1665
- export type StartJourneyIdentityIdNumber$Outbound = {
1666
- type: string;
1667
- idNumber: string;
1668
- country?: string | undefined;
3021
+ export type StartJourneyPerson$Outbound = {
3022
+ title?: string | undefined;
3023
+ firstName?: string | undefined;
3024
+ middleNames?: Array<string> | undefined;
3025
+ lastNames?: Array<string> | undefined;
3026
+ lastNamesAtBirth?: Array<string> | undefined;
3027
+ id?: string | undefined;
3028
+ type?: string | undefined;
3029
+ role?: string | undefined;
3030
+ position?: string | undefined;
3031
+ ownershipPercentage?: number | undefined;
3032
+ nationality?: string | undefined;
3033
+ dateOfBirth?: string | undefined;
3034
+ startDate?: string | undefined;
3035
+ endDate?: string | undefined;
3036
+ currentAddress?: StartJourneyCurrentAddressPrimary$Outbound | undefined;
1669
3037
  };
1670
3038
 
1671
3039
  /** @internal */
1672
- export const StartJourneyIdentityIdNumber$outboundSchema: z.ZodMiniType<
1673
- StartJourneyIdentityIdNumber$Outbound,
1674
- StartJourneyIdentityIdNumber
3040
+ export const StartJourneyPerson$outboundSchema: z.ZodMiniType<
3041
+ StartJourneyPerson$Outbound,
3042
+ StartJourneyPerson
1675
3043
  > = z.object({
1676
- type: z.string(),
1677
- idNumber: z.string(),
1678
- country: z.optional(z.string()),
3044
+ title: z.optional(z.string()),
3045
+ firstName: z.optional(z.string()),
3046
+ middleNames: z.optional(z.array(z.string())),
3047
+ lastNames: z.optional(z.array(z.string())),
3048
+ lastNamesAtBirth: z.optional(z.array(z.string())),
3049
+ id: z.optional(z.string()),
3050
+ type: z.optional(StartJourneyTypePrimary2$outboundSchema),
3051
+ role: z.optional(StartJourneyRole$outboundSchema),
3052
+ position: z.optional(z.string()),
3053
+ ownershipPercentage: z.optional(z.number()),
3054
+ nationality: z.optional(z.string()),
3055
+ dateOfBirth: z.optional(z.string()),
3056
+ startDate: z.optional(z.string()),
3057
+ endDate: z.optional(z.string()),
3058
+ currentAddress: z.optional(
3059
+ z.lazy(() => StartJourneyCurrentAddressPrimary$outboundSchema),
3060
+ ),
1679
3061
  });
1680
3062
 
1681
- export function startJourneyIdentityIdNumberToJSON(
1682
- startJourneyIdentityIdNumber: StartJourneyIdentityIdNumber,
3063
+ export function startJourneyPersonToJSON(
3064
+ startJourneyPerson: StartJourneyPerson,
1683
3065
  ): string {
1684
3066
  return JSON.stringify(
1685
- StartJourneyIdentityIdNumber$outboundSchema.parse(
1686
- startJourneyIdentityIdNumber,
1687
- ),
3067
+ StartJourneyPerson$outboundSchema.parse(startJourneyPerson),
1688
3068
  );
1689
3069
  }
1690
3070
 
1691
3071
  /** @internal */
1692
- export type StartJourneyIdentityPhone$Outbound = {
3072
+ export type StartJourneyPhonePrimary$Outbound = {
1693
3073
  type: string;
1694
3074
  number: string;
1695
3075
  };
1696
3076
 
1697
3077
  /** @internal */
1698
- export const StartJourneyIdentityPhone$outboundSchema: z.ZodMiniType<
1699
- StartJourneyIdentityPhone$Outbound,
1700
- StartJourneyIdentityPhone
3078
+ export const StartJourneyPhonePrimary$outboundSchema: z.ZodMiniType<
3079
+ StartJourneyPhonePrimary$Outbound,
3080
+ StartJourneyPhonePrimary
1701
3081
  > = z.object({
1702
3082
  type: z.string(),
1703
3083
  number: z.string(),
1704
3084
  });
1705
3085
 
1706
- export function startJourneyIdentityPhoneToJSON(
1707
- startJourneyIdentityPhone: StartJourneyIdentityPhone,
1708
- ): string {
1709
- return JSON.stringify(
1710
- StartJourneyIdentityPhone$outboundSchema.parse(startJourneyIdentityPhone),
1711
- );
1712
- }
1713
-
1714
- /** @internal */
1715
- export type StartJourneyIdentityEmail$Outbound = {
1716
- type: string;
1717
- email: string;
1718
- };
1719
-
1720
- /** @internal */
1721
- export const StartJourneyIdentityEmail$outboundSchema: z.ZodMiniType<
1722
- StartJourneyIdentityEmail$Outbound,
1723
- StartJourneyIdentityEmail
1724
- > = z.object({
1725
- type: z.string(),
1726
- email: z.string(),
1727
- });
1728
-
1729
- export function startJourneyIdentityEmailToJSON(
1730
- startJourneyIdentityEmail: StartJourneyIdentityEmail,
1731
- ): string {
1732
- return JSON.stringify(
1733
- StartJourneyIdentityEmail$outboundSchema.parse(startJourneyIdentityEmail),
1734
- );
1735
- }
1736
-
1737
- /** @internal */
1738
- export type StartJourneyIdentitySocial$Outbound = {
1739
- type: string;
1740
- identity: string;
1741
- };
1742
-
1743
- /** @internal */
1744
- export const StartJourneyIdentitySocial$outboundSchema: z.ZodMiniType<
1745
- StartJourneyIdentitySocial$Outbound,
1746
- StartJourneyIdentitySocial
1747
- > = z.object({
1748
- type: z.string(),
1749
- identity: z.string(),
1750
- });
1751
-
1752
- export function startJourneyIdentitySocialToJSON(
1753
- startJourneyIdentitySocial: StartJourneyIdentitySocial,
3086
+ export function startJourneyPhonePrimaryToJSON(
3087
+ startJourneyPhonePrimary: StartJourneyPhonePrimary,
1754
3088
  ): string {
1755
3089
  return JSON.stringify(
1756
- StartJourneyIdentitySocial$outboundSchema.parse(startJourneyIdentitySocial),
3090
+ StartJourneyPhonePrimary$outboundSchema.parse(startJourneyPhonePrimary),
1757
3091
  );
1758
3092
  }
1759
3093
 
1760
3094
  /** @internal */
1761
- export type StartJourneyIdentity$Outbound = {
1762
- title?: string | undefined;
1763
- firstName?: string | undefined;
1764
- middleNames?: Array<string> | undefined;
1765
- lastNames?: Array<string> | undefined;
1766
- lastNamesAtBirth?: Array<string> | undefined;
1767
- aliases?: Array<StartJourneyIdentityAlias$Outbound> | undefined;
1768
- relatedPersons?:
1769
- | Array<StartJourneyIdentityRelatedPerson$Outbound>
1770
- | undefined;
1771
- dateOfBirth?: string | undefined;
1772
- gender?: string | undefined;
1773
- currentAddress?: StartJourneyIdentityCurrentAddress$Outbound | undefined;
1774
- previousAddresses?:
1775
- | Array<StartJourneyIdentityPreviousAddress$Outbound>
3095
+ export type StartJourneyEntity$Outbound = {
3096
+ id?: string | undefined;
3097
+ type?: string | undefined;
3098
+ name?: string | undefined;
3099
+ aliases?: Array<string> | undefined;
3100
+ businessType?: string | undefined;
3101
+ status?: string | undefined;
3102
+ description?: string | undefined;
3103
+ addresses?: Array<StartJourneyAddressPrimary$Outbound> | undefined;
3104
+ taxIdentifiers?: Array<StartJourneyTaxIdentifier$Outbound> | undefined;
3105
+ companyNumber?: string | undefined;
3106
+ industryClassifications?:
3107
+ | Array<StartJourneyIndustryClassification$Outbound>
1776
3108
  | undefined;
1777
- placeOfBirth?: StartJourneyIdentityPlaceOfBirth$Outbound | undefined;
1778
- idNumbers?: Array<StartJourneyIdentityIdNumber$Outbound> | undefined;
1779
- phones?: Array<StartJourneyIdentityPhone$Outbound> | undefined;
1780
- emails?: Array<StartJourneyIdentityEmail$Outbound> | undefined;
1781
- socials?: Array<StartJourneyIdentitySocial$Outbound> | undefined;
1782
- mothersMaidenName?: string | undefined;
3109
+ registrations?: Array<StartJourneyRegistration$Outbound> | undefined;
3110
+ corporateStructure?: string | undefined;
3111
+ persons?: Array<StartJourneyPerson$Outbound> | undefined;
3112
+ incorporationDate?: string | undefined;
3113
+ dissolutionDate?: string | undefined;
3114
+ phones?: Array<StartJourneyPhonePrimary$Outbound> | undefined;
3115
+ websites?: Array<string> | undefined;
3116
+ headcount?: number | undefined;
3117
+ isNonProfit?: boolean | undefined;
1783
3118
  };
1784
3119
 
1785
3120
  /** @internal */
1786
- export const StartJourneyIdentity$outboundSchema: z.ZodMiniType<
1787
- StartJourneyIdentity$Outbound,
1788
- StartJourneyIdentity
3121
+ export const StartJourneyEntity$outboundSchema: z.ZodMiniType<
3122
+ StartJourneyEntity$Outbound,
3123
+ StartJourneyEntity
1789
3124
  > = z.object({
1790
- title: z.optional(z.string()),
1791
- firstName: z.optional(z.string()),
1792
- middleNames: z.optional(z.array(z.string())),
1793
- lastNames: z.optional(z.array(z.string())),
1794
- lastNamesAtBirth: z.optional(z.array(z.string())),
1795
- aliases: z.optional(
1796
- z.array(z.lazy(() => StartJourneyIdentityAlias$outboundSchema)),
1797
- ),
1798
- relatedPersons: z.optional(
1799
- z.array(z.lazy(() => StartJourneyIdentityRelatedPerson$outboundSchema)),
1800
- ),
1801
- dateOfBirth: z.optional(z.string()),
1802
- gender: z.optional(z.string()),
1803
- currentAddress: z.optional(
1804
- z.lazy(() => StartJourneyIdentityCurrentAddress$outboundSchema),
3125
+ id: z.optional(z.string()),
3126
+ type: z.optional(StartJourneyTypePrimary1$outboundSchema),
3127
+ name: z.optional(z.string()),
3128
+ aliases: z.optional(z.array(z.string())),
3129
+ businessType: z.optional(z.string()),
3130
+ status: z.optional(StartJourneyStatus$outboundSchema),
3131
+ description: z.optional(z.string()),
3132
+ addresses: z.optional(
3133
+ z.array(z.lazy(() => StartJourneyAddressPrimary$outboundSchema)),
1805
3134
  ),
1806
- previousAddresses: z.optional(
1807
- z.array(z.lazy(() => StartJourneyIdentityPreviousAddress$outboundSchema)),
3135
+ taxIdentifiers: z.optional(
3136
+ z.array(z.lazy(() => StartJourneyTaxIdentifier$outboundSchema)),
1808
3137
  ),
1809
- placeOfBirth: z.optional(
1810
- z.lazy(() => StartJourneyIdentityPlaceOfBirth$outboundSchema),
3138
+ companyNumber: z.optional(z.string()),
3139
+ industryClassifications: z.optional(
3140
+ z.array(z.lazy(() => StartJourneyIndustryClassification$outboundSchema)),
1811
3141
  ),
1812
- idNumbers: z.optional(
1813
- z.array(z.lazy(() => StartJourneyIdentityIdNumber$outboundSchema)),
3142
+ registrations: z.optional(
3143
+ z.array(z.lazy(() => StartJourneyRegistration$outboundSchema)),
1814
3144
  ),
3145
+ corporateStructure: z.optional(z.string()),
3146
+ persons: z.optional(z.array(z.lazy(() => StartJourneyPerson$outboundSchema))),
3147
+ incorporationDate: z.optional(z.string()),
3148
+ dissolutionDate: z.optional(z.string()),
1815
3149
  phones: z.optional(
1816
- z.array(z.lazy(() => StartJourneyIdentityPhone$outboundSchema)),
1817
- ),
1818
- emails: z.optional(
1819
- z.array(z.lazy(() => StartJourneyIdentityEmail$outboundSchema)),
1820
- ),
1821
- socials: z.optional(
1822
- z.array(z.lazy(() => StartJourneyIdentitySocial$outboundSchema)),
3150
+ z.array(z.lazy(() => StartJourneyPhonePrimary$outboundSchema)),
1823
3151
  ),
1824
- mothersMaidenName: z.optional(z.string()),
3152
+ websites: z.optional(z.array(z.string())),
3153
+ headcount: z.optional(z.int()),
3154
+ isNonProfit: z.optional(z.boolean()),
1825
3155
  });
1826
3156
 
1827
- export function startJourneyIdentityToJSON(
1828
- startJourneyIdentity: StartJourneyIdentity,
3157
+ export function startJourneyEntityToJSON(
3158
+ startJourneyEntity: StartJourneyEntity,
1829
3159
  ): string {
1830
3160
  return JSON.stringify(
1831
- StartJourneyIdentity$outboundSchema.parse(startJourneyIdentity),
3161
+ StartJourneyEntity$outboundSchema.parse(startJourneyEntity),
1832
3162
  );
1833
3163
  }
1834
3164
 
1835
3165
  /** @internal */
1836
- export type StartJourneyAddress$Outbound = {
3166
+ export type StartJourneyDocumentAddress$Outbound = {
1837
3167
  addressString?: string | undefined;
1838
3168
  extractedAddressString?: string | undefined;
1839
3169
  addressLine1?: string | undefined;
@@ -1844,9 +3174,9 @@ export type StartJourneyAddress$Outbound = {
1844
3174
  };
1845
3175
 
1846
3176
  /** @internal */
1847
- export const StartJourneyAddress$outboundSchema: z.ZodMiniType<
1848
- StartJourneyAddress$Outbound,
1849
- StartJourneyAddress
3177
+ export const StartJourneyDocumentAddress$outboundSchema: z.ZodMiniType<
3178
+ StartJourneyDocumentAddress$Outbound,
3179
+ StartJourneyDocumentAddress
1850
3180
  > = z.object({
1851
3181
  addressString: z.optional(z.string()),
1852
3182
  extractedAddressString: z.optional(z.string()),
@@ -1857,16 +3187,84 @@ export const StartJourneyAddress$outboundSchema: z.ZodMiniType<
1857
3187
  postalCode: z.optional(z.string()),
1858
3188
  });
1859
3189
 
1860
- export function startJourneyAddressToJSON(
1861
- startJourneyAddress: StartJourneyAddress,
3190
+ export function startJourneyDocumentAddressToJSON(
3191
+ startJourneyDocumentAddress: StartJourneyDocumentAddress,
3192
+ ): string {
3193
+ return JSON.stringify(
3194
+ StartJourneyDocumentAddress$outboundSchema.parse(
3195
+ startJourneyDocumentAddress,
3196
+ ),
3197
+ );
3198
+ }
3199
+
3200
+ /** @internal */
3201
+ export type StartJourneyDocumentDevice$Outbound = {
3202
+ type?: string | undefined;
3203
+ model?: string | undefined;
3204
+ hasContactlessReader?: boolean | undefined;
3205
+ hasMagneticStripeReader?: boolean | undefined;
3206
+ hasCamera?: boolean | undefined;
3207
+ serialNumber?: string | undefined;
3208
+ manufacturer?: string | undefined;
3209
+ };
3210
+
3211
+ /** @internal */
3212
+ export const StartJourneyDocumentDevice$outboundSchema: z.ZodMiniType<
3213
+ StartJourneyDocumentDevice$Outbound,
3214
+ StartJourneyDocumentDevice
3215
+ > = z.object({
3216
+ type: z.optional(z.string()),
3217
+ model: z.optional(z.string()),
3218
+ hasContactlessReader: z.optional(z.boolean()),
3219
+ hasMagneticStripeReader: z.optional(z.boolean()),
3220
+ hasCamera: z.optional(z.boolean()),
3221
+ serialNumber: z.optional(z.string()),
3222
+ manufacturer: z.optional(z.string()),
3223
+ });
3224
+
3225
+ export function startJourneyDocumentDeviceToJSON(
3226
+ startJourneyDocumentDevice: StartJourneyDocumentDevice,
3227
+ ): string {
3228
+ return JSON.stringify(
3229
+ StartJourneyDocumentDevice$outboundSchema.parse(startJourneyDocumentDevice),
3230
+ );
3231
+ }
3232
+
3233
+ /** @internal */
3234
+ export type StartJourneySide1Device$Outbound = {
3235
+ type?: string | undefined;
3236
+ model?: string | undefined;
3237
+ hasContactlessReader?: boolean | undefined;
3238
+ hasMagneticStripeReader?: boolean | undefined;
3239
+ hasCamera?: boolean | undefined;
3240
+ serialNumber?: string | undefined;
3241
+ manufacturer?: string | undefined;
3242
+ };
3243
+
3244
+ /** @internal */
3245
+ export const StartJourneySide1Device$outboundSchema: z.ZodMiniType<
3246
+ StartJourneySide1Device$Outbound,
3247
+ StartJourneySide1Device
3248
+ > = z.object({
3249
+ type: z.optional(z.string()),
3250
+ model: z.optional(z.string()),
3251
+ hasContactlessReader: z.optional(z.boolean()),
3252
+ hasMagneticStripeReader: z.optional(z.boolean()),
3253
+ hasCamera: z.optional(z.boolean()),
3254
+ serialNumber: z.optional(z.string()),
3255
+ manufacturer: z.optional(z.string()),
3256
+ });
3257
+
3258
+ export function startJourneySide1DeviceToJSON(
3259
+ startJourneySide1Device: StartJourneySide1Device,
1862
3260
  ): string {
1863
3261
  return JSON.stringify(
1864
- StartJourneyAddress$outboundSchema.parse(startJourneyAddress),
3262
+ StartJourneySide1Device$outboundSchema.parse(startJourneySide1Device),
1865
3263
  );
1866
3264
  }
1867
3265
 
1868
3266
  /** @internal */
1869
- export type StartJourneyDocumentDevice$Outbound = {
3267
+ export type StartJourneySide2Device$Outbound = {
1870
3268
  type?: string | undefined;
1871
3269
  model?: string | undefined;
1872
3270
  hasContactlessReader?: boolean | undefined;
@@ -1877,9 +3275,9 @@ export type StartJourneyDocumentDevice$Outbound = {
1877
3275
  };
1878
3276
 
1879
3277
  /** @internal */
1880
- export const StartJourneyDocumentDevice$outboundSchema: z.ZodMiniType<
1881
- StartJourneyDocumentDevice$Outbound,
1882
- StartJourneyDocumentDevice
3278
+ export const StartJourneySide2Device$outboundSchema: z.ZodMiniType<
3279
+ StartJourneySide2Device$Outbound,
3280
+ StartJourneySide2Device
1883
3281
  > = z.object({
1884
3282
  type: z.optional(z.string()),
1885
3283
  model: z.optional(z.string()),
@@ -1890,11 +3288,11 @@ export const StartJourneyDocumentDevice$outboundSchema: z.ZodMiniType<
1890
3288
  manufacturer: z.optional(z.string()),
1891
3289
  });
1892
3290
 
1893
- export function startJourneyDocumentDeviceToJSON(
1894
- startJourneyDocumentDevice: StartJourneyDocumentDevice,
3291
+ export function startJourneySide2DeviceToJSON(
3292
+ startJourneySide2Device: StartJourneySide2Device,
1895
3293
  ): string {
1896
3294
  return JSON.stringify(
1897
- StartJourneyDocumentDevice$outboundSchema.parse(startJourneyDocumentDevice),
3295
+ StartJourneySide2Device$outboundSchema.parse(startJourneySide2Device),
1898
3296
  );
1899
3297
  }
1900
3298
 
@@ -2584,6 +3982,7 @@ export type StartJourneyDocumentAlias$Outbound = {
2584
3982
  middleNames?: Array<string> | undefined;
2585
3983
  lastNames?: Array<string> | undefined;
2586
3984
  lastNamesAtBirth?: Array<string> | undefined;
3985
+ fullName?: string | undefined;
2587
3986
  };
2588
3987
 
2589
3988
  /** @internal */
@@ -2596,6 +3995,7 @@ export const StartJourneyDocumentAlias$outboundSchema: z.ZodMiniType<
2596
3995
  middleNames: z.optional(z.array(z.string())),
2597
3996
  lastNames: z.optional(z.array(z.string())),
2598
3997
  lastNamesAtBirth: z.optional(z.array(z.string())),
3998
+ fullName: z.optional(z.string()),
2599
3999
  });
2600
4000
 
2601
4001
  export function startJourneyDocumentAliasToJSON(
@@ -2785,8 +4185,8 @@ export type StartJourneyDocumentPreviousAddress$Outbound = {
2785
4185
  subAdministrativeArea?: string | undefined;
2786
4186
  organization?: string | undefined;
2787
4187
  location?: StartJourneyDocumentPreviousAddressLocation$Outbound | undefined;
2788
- fromDate: string;
2789
- toDate: string;
4188
+ fromDate?: string | undefined;
4189
+ toDate?: string | undefined;
2790
4190
  };
2791
4191
 
2792
4192
  /** @internal */
@@ -2814,8 +4214,8 @@ export const StartJourneyDocumentPreviousAddress$outboundSchema: z.ZodMiniType<
2814
4214
  location: z.optional(
2815
4215
  z.lazy(() => StartJourneyDocumentPreviousAddressLocation$outboundSchema),
2816
4216
  ),
2817
- fromDate: z.string(),
2818
- toDate: z.string(),
4217
+ fromDate: z.optional(z.string()),
4218
+ toDate: z.optional(z.string()),
2819
4219
  });
2820
4220
 
2821
4221
  export function startJourneyDocumentPreviousAddressToJSON(
@@ -3037,6 +4437,7 @@ export type StartJourneyDocumentSubject$Outbound = {
3037
4437
  emails?: Array<StartJourneyDocumentEmail$Outbound> | undefined;
3038
4438
  socials?: Array<StartJourneyDocumentSocial$Outbound> | undefined;
3039
4439
  mothersMaidenName?: string | undefined;
4440
+ nationality?: string | undefined;
3040
4441
  };
3041
4442
 
3042
4443
  /** @internal */
@@ -3079,6 +4480,7 @@ export const StartJourneyDocumentSubject$outboundSchema: z.ZodMiniType<
3079
4480
  z.array(z.lazy(() => StartJourneyDocumentSocial$outboundSchema)),
3080
4481
  ),
3081
4482
  mothersMaidenName: z.optional(z.string()),
4483
+ nationality: z.optional(z.string()),
3082
4484
  });
3083
4485
 
3084
4486
  export function startJourneyDocumentSubjectToJSON(
@@ -3094,7 +4496,7 @@ export function startJourneyDocumentSubjectToJSON(
3094
4496
  /** @internal */
3095
4497
  export type StartJourneyDocument$Outbound = {
3096
4498
  oneDBarcode?: string | undefined;
3097
- address?: StartJourneyAddress$Outbound | undefined;
4499
+ address?: StartJourneyDocumentAddress$Outbound | undefined;
3098
4500
  applicationDate?: string | undefined;
3099
4501
  applicationNumber?: string | undefined;
3100
4502
  dateOfBirth?: string | undefined;
@@ -3166,13 +4568,15 @@ export type StartJourneyDocument$Outbound = {
3166
4568
  cardNumber?: string | undefined;
3167
4569
  issuerCountryCode?: string | undefined;
3168
4570
  id?: string | undefined;
3169
- type?: string | undefined;
4571
+ type: string;
3170
4572
  category?: string | undefined;
3171
4573
  subtype?: string | undefined;
3172
4574
  format?: string | undefined;
3173
4575
  device?: StartJourneyDocumentDevice$Outbound | undefined;
3174
4576
  side1Image?: string | undefined;
3175
4577
  side2Image?: string | undefined;
4578
+ side1Device?: StartJourneySide1Device$Outbound | undefined;
4579
+ side2Device?: StartJourneySide2Device$Outbound | undefined;
3176
4580
  chip?: StartJourneyChip$Outbound | undefined;
3177
4581
  classification?: StartJourneyClassification$Outbound | undefined;
3178
4582
  extraction?: StartJourneyExtraction$Outbound | undefined;
@@ -3180,8 +4584,27 @@ export type StartJourneyDocument$Outbound = {
3180
4584
  subType?: string | undefined;
3181
4585
  number?: string | undefined;
3182
4586
  expiryDate?: string | undefined;
4587
+ cardType?: string | undefined;
4588
+ expiryMonth?: string | undefined;
4589
+ cardColour?: string | undefined;
4590
+ cardStatus?: string | undefined;
3183
4591
  subject?: StartJourneyDocumentSubject$Outbound | undefined;
3184
4592
  country?: string | undefined;
4593
+ certificateFormat?: string | undefined;
4594
+ registrationNumber?: string | undefined;
4595
+ registrationDate?: string | undefined;
4596
+ registrationYear?: string | undefined;
4597
+ partyRole?: string | undefined;
4598
+ dateOfEvent?: string | undefined;
4599
+ acquisitionDate?: string | undefined;
4600
+ previousFirstName?: string | undefined;
4601
+ previousMiddleName?: string | undefined;
4602
+ previousSurname?: string | undefined;
4603
+ individualReferenceNumber?: string | undefined;
4604
+ nameLine1?: string | undefined;
4605
+ nameLine2?: string | undefined;
4606
+ nameLine3?: string | undefined;
4607
+ nameLine4?: string | undefined;
3185
4608
  };
3186
4609
 
3187
4610
  /** @internal */
@@ -3190,7 +4613,7 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
3190
4613
  StartJourneyDocument
3191
4614
  > = z.object({
3192
4615
  oneDBarcode: z.optional(z.string()),
3193
- address: z.optional(z.lazy(() => StartJourneyAddress$outboundSchema)),
4616
+ address: z.optional(z.lazy(() => StartJourneyDocumentAddress$outboundSchema)),
3194
4617
  applicationDate: z.optional(z.string()),
3195
4618
  applicationNumber: z.optional(z.string()),
3196
4619
  dateOfBirth: z.optional(z.string()),
@@ -3262,13 +4685,15 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
3262
4685
  cardNumber: z.optional(z.string()),
3263
4686
  issuerCountryCode: z.optional(z.string()),
3264
4687
  id: z.optional(z.string()),
3265
- type: z.optional(z.string()),
4688
+ type: z.string(),
3266
4689
  category: z.optional(z.string()),
3267
4690
  subtype: z.optional(z.string()),
3268
4691
  format: z.optional(z.string()),
3269
4692
  device: z.optional(z.lazy(() => StartJourneyDocumentDevice$outboundSchema)),
3270
4693
  side1Image: z.optional(z.string()),
3271
4694
  side2Image: z.optional(z.string()),
4695
+ side1Device: z.optional(z.lazy(() => StartJourneySide1Device$outboundSchema)),
4696
+ side2Device: z.optional(z.lazy(() => StartJourneySide2Device$outboundSchema)),
3272
4697
  chip: z.optional(z.lazy(() => StartJourneyChip$outboundSchema)),
3273
4698
  classification: z.optional(
3274
4699
  z.lazy(() => StartJourneyClassification$outboundSchema),
@@ -3278,8 +4703,27 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
3278
4703
  subType: z.optional(z.string()),
3279
4704
  number: z.optional(z.string()),
3280
4705
  expiryDate: z.optional(z.string()),
4706
+ cardType: z.optional(z.string()),
4707
+ expiryMonth: z.optional(z.string()),
4708
+ cardColour: z.optional(z.string()),
4709
+ cardStatus: z.optional(z.string()),
3281
4710
  subject: z.optional(z.lazy(() => StartJourneyDocumentSubject$outboundSchema)),
3282
4711
  country: z.optional(z.string()),
4712
+ certificateFormat: z.optional(z.string()),
4713
+ registrationNumber: z.optional(z.string()),
4714
+ registrationDate: z.optional(z.string()),
4715
+ registrationYear: z.optional(z.string()),
4716
+ partyRole: z.optional(z.string()),
4717
+ dateOfEvent: z.optional(z.string()),
4718
+ acquisitionDate: z.optional(z.string()),
4719
+ previousFirstName: z.optional(z.string()),
4720
+ previousMiddleName: z.optional(z.string()),
4721
+ previousSurname: z.optional(z.string()),
4722
+ individualReferenceNumber: z.optional(z.string()),
4723
+ nameLine1: z.optional(z.string()),
4724
+ nameLine2: z.optional(z.string()),
4725
+ nameLine3: z.optional(z.string()),
4726
+ nameLine4: z.optional(z.string()),
3283
4727
  });
3284
4728
 
3285
4729
  export function startJourneyDocumentToJSON(
@@ -3290,6 +4734,101 @@ export function startJourneyDocumentToJSON(
3290
4734
  );
3291
4735
  }
3292
4736
 
4737
+ /** @internal */
4738
+ export const StartJourneyTypeOrphanedStoredFace$outboundSchema: z.ZodMiniEnum<
4739
+ typeof StartJourneyTypeOrphanedStoredFace
4740
+ > = z.enum(StartJourneyTypeOrphanedStoredFace);
4741
+
4742
+ /** @internal */
4743
+ export type StartJourneyBiometricOrphanedStoredFace$Outbound = {
4744
+ id?: string | undefined;
4745
+ type: string;
4746
+ templateReference: string;
4747
+ collectionReference?: string | undefined;
4748
+ };
4749
+
4750
+ /** @internal */
4751
+ export const StartJourneyBiometricOrphanedStoredFace$outboundSchema:
4752
+ z.ZodMiniType<
4753
+ StartJourneyBiometricOrphanedStoredFace$Outbound,
4754
+ StartJourneyBiometricOrphanedStoredFace
4755
+ > = z.object({
4756
+ id: z.optional(z.string()),
4757
+ type: StartJourneyTypeOrphanedStoredFace$outboundSchema,
4758
+ templateReference: z.string(),
4759
+ collectionReference: z.optional(z.string()),
4760
+ });
4761
+
4762
+ export function startJourneyBiometricOrphanedStoredFaceToJSON(
4763
+ startJourneyBiometricOrphanedStoredFace:
4764
+ StartJourneyBiometricOrphanedStoredFace,
4765
+ ): string {
4766
+ return JSON.stringify(
4767
+ StartJourneyBiometricOrphanedStoredFace$outboundSchema.parse(
4768
+ startJourneyBiometricOrphanedStoredFace,
4769
+ ),
4770
+ );
4771
+ }
4772
+
4773
+ /** @internal */
4774
+ export const StartJourneyTypeStoredFace$outboundSchema: z.ZodMiniEnum<
4775
+ typeof StartJourneyTypeStoredFace
4776
+ > = z.enum(StartJourneyTypeStoredFace);
4777
+
4778
+ /** @internal */
4779
+ export type StartJourneyBiometricStoredFace$Outbound = {
4780
+ id?: string | undefined;
4781
+ type: string;
4782
+ templateReference: string;
4783
+ collectionReference?: string | undefined;
4784
+ };
4785
+
4786
+ /** @internal */
4787
+ export const StartJourneyBiometricStoredFace$outboundSchema: z.ZodMiniType<
4788
+ StartJourneyBiometricStoredFace$Outbound,
4789
+ StartJourneyBiometricStoredFace
4790
+ > = z.object({
4791
+ id: z.optional(z.string()),
4792
+ type: StartJourneyTypeStoredFace$outboundSchema,
4793
+ templateReference: z.string(),
4794
+ collectionReference: z.optional(z.string()),
4795
+ });
4796
+
4797
+ export function startJourneyBiometricStoredFaceToJSON(
4798
+ startJourneyBiometricStoredFace: StartJourneyBiometricStoredFace,
4799
+ ): string {
4800
+ return JSON.stringify(
4801
+ StartJourneyBiometricStoredFace$outboundSchema.parse(
4802
+ startJourneyBiometricStoredFace,
4803
+ ),
4804
+ );
4805
+ }
4806
+
4807
+ /** @internal */
4808
+ export type StartJourneyBiometric5$Outbound = {
4809
+ id?: string | undefined;
4810
+ type?: string | undefined;
4811
+ anchorImage: string;
4812
+ };
4813
+
4814
+ /** @internal */
4815
+ export const StartJourneyBiometric5$outboundSchema: z.ZodMiniType<
4816
+ StartJourneyBiometric5$Outbound,
4817
+ StartJourneyBiometric5
4818
+ > = z.object({
4819
+ id: z.optional(z.string()),
4820
+ type: z.optional(z.string()),
4821
+ anchorImage: z.string(),
4822
+ });
4823
+
4824
+ export function startJourneyBiometric5ToJSON(
4825
+ startJourneyBiometric5: StartJourneyBiometric5,
4826
+ ): string {
4827
+ return JSON.stringify(
4828
+ StartJourneyBiometric5$outboundSchema.parse(startJourneyBiometric5),
4829
+ );
4830
+ }
4831
+
3293
4832
  /** @internal */
3294
4833
  export type StartJourneyBiometric4$Outbound = {
3295
4834
  id?: string | undefined;
@@ -3400,8 +4939,11 @@ export function startJourneyBiometric1ToJSON(
3400
4939
  export type StartJourneyBiometricUnion$Outbound =
3401
4940
  | StartJourneyBiometric1$Outbound
3402
4941
  | StartJourneyBiometric2$Outbound
4942
+ | StartJourneyBiometricStoredFace$Outbound
4943
+ | StartJourneyBiometricOrphanedStoredFace$Outbound
3403
4944
  | StartJourneyBiometric3$Outbound
3404
- | StartJourneyBiometric4$Outbound;
4945
+ | StartJourneyBiometric4$Outbound
4946
+ | StartJourneyBiometric5$Outbound;
3405
4947
 
3406
4948
  /** @internal */
3407
4949
  export const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<
@@ -3410,8 +4952,11 @@ export const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<
3410
4952
  > = smartUnion([
3411
4953
  z.lazy(() => StartJourneyBiometric1$outboundSchema),
3412
4954
  z.lazy(() => StartJourneyBiometric2$outboundSchema),
4955
+ z.lazy(() => StartJourneyBiometricStoredFace$outboundSchema),
4956
+ z.lazy(() => StartJourneyBiometricOrphanedStoredFace$outboundSchema),
3413
4957
  z.lazy(() => StartJourneyBiometric3$outboundSchema),
3414
4958
  z.lazy(() => StartJourneyBiometric4$outboundSchema),
4959
+ z.lazy(() => StartJourneyBiometric5$outboundSchema),
3415
4960
  ]);
3416
4961
 
3417
4962
  export function startJourneyBiometricUnionToJSON(
@@ -3425,8 +4970,8 @@ export function startJourneyBiometricUnionToJSON(
3425
4970
  /** @internal */
3426
4971
  export type StartJourneyUser$Outbound = {
3427
4972
  id: string;
3428
- email: string;
3429
- domain: string;
4973
+ email?: string | undefined;
4974
+ domain?: string | undefined;
3430
4975
  };
3431
4976
 
3432
4977
  /** @internal */
@@ -3435,8 +4980,8 @@ export const StartJourneyUser$outboundSchema: z.ZodMiniType<
3435
4980
  StartJourneyUser
3436
4981
  > = z.object({
3437
4982
  id: z.string(),
3438
- email: z.string(),
3439
- domain: z.string(),
4983
+ email: z.optional(z.string()),
4984
+ domain: z.optional(z.string()),
3440
4985
  });
3441
4986
 
3442
4987
  export function startJourneyUserToJSON(
@@ -3622,6 +5167,9 @@ export function startJourneySessionAuthToJSON(
3622
5167
 
3623
5168
  /** @internal */
3624
5169
  export type StartJourneySession$Outbound = {
5170
+ id?: string | undefined;
5171
+ type?: string | undefined;
5172
+ provider?: string | undefined;
3625
5173
  user?: StartJourneyUser$Outbound | undefined;
3626
5174
  client?: StartJourneyClient$Outbound | undefined;
3627
5175
  device?: StartJourneySessionDevice$Outbound | undefined;
@@ -3636,6 +5184,9 @@ export const StartJourneySession$outboundSchema: z.ZodMiniType<
3636
5184
  StartJourneySession$Outbound,
3637
5185
  StartJourneySession
3638
5186
  > = z.object({
5187
+ id: z.optional(z.string()),
5188
+ type: z.optional(z.string()),
5189
+ provider: z.optional(z.string()),
3639
5190
  user: z.optional(z.lazy(() => StartJourneyUser$outboundSchema)),
3640
5191
  client: z.optional(z.lazy(() => StartJourneyClient$outboundSchema)),
3641
5192
  device: z.optional(z.lazy(() => StartJourneySessionDevice$outboundSchema)),
@@ -3706,7 +5257,7 @@ export function startJourneyConsentToJSON(
3706
5257
  /** @internal */
3707
5258
  export type StartJourneyAccount$Outbound = {
3708
5259
  type: string;
3709
- accountNumber: string;
5260
+ accountNumber?: string | undefined;
3710
5261
  sortCode?: string | undefined;
3711
5262
  routingNumber?: string | undefined;
3712
5263
  iban?: string | undefined;
@@ -3723,7 +5274,7 @@ export const StartJourneyAccount$outboundSchema: z.ZodMiniType<
3723
5274
  StartJourneyAccount
3724
5275
  > = z.object({
3725
5276
  type: z.string(),
3726
- accountNumber: z.string(),
5277
+ accountNumber: z.optional(z.string()),
3727
5278
  sortCode: z.optional(z.string()),
3728
5279
  routingNumber: z.optional(z.string()),
3729
5280
  iban: z.optional(z.string()),
@@ -3743,29 +5294,169 @@ export function startJourneyAccountToJSON(
3743
5294
  }
3744
5295
 
3745
5296
  /** @internal */
3746
- export type StartJourneySubject$Outbound = {
5297
+ export type StartJourneyChoice$Outbound = {
5298
+ label: string;
5299
+ text: string;
5300
+ };
5301
+
5302
+ /** @internal */
5303
+ export const StartJourneyChoice$outboundSchema: z.ZodMiniType<
5304
+ StartJourneyChoice$Outbound,
5305
+ StartJourneyChoice
5306
+ > = z.object({
5307
+ label: z.string(),
5308
+ text: z.string(),
5309
+ });
5310
+
5311
+ export function startJourneyChoiceToJSON(
5312
+ startJourneyChoice: StartJourneyChoice,
5313
+ ): string {
5314
+ return JSON.stringify(
5315
+ StartJourneyChoice$outboundSchema.parse(startJourneyChoice),
5316
+ );
5317
+ }
5318
+
5319
+ /** @internal */
5320
+ export type StartJourneyQuestion$Outbound = {
5321
+ id: number;
5322
+ questionText: string;
5323
+ helpText?: string | undefined;
5324
+ choices: Array<StartJourneyChoice$Outbound>;
5325
+ };
5326
+
5327
+ /** @internal */
5328
+ export const StartJourneyQuestion$outboundSchema: z.ZodMiniType<
5329
+ StartJourneyQuestion$Outbound,
5330
+ StartJourneyQuestion
5331
+ > = z.object({
5332
+ id: z.int(),
5333
+ questionText: z.string(),
5334
+ helpText: z.optional(z.string()),
5335
+ choices: z.array(z.lazy(() => StartJourneyChoice$outboundSchema)),
5336
+ });
5337
+
5338
+ export function startJourneyQuestionToJSON(
5339
+ startJourneyQuestion: StartJourneyQuestion,
5340
+ ): string {
5341
+ return JSON.stringify(
5342
+ StartJourneyQuestion$outboundSchema.parse(startJourneyQuestion),
5343
+ );
5344
+ }
5345
+
5346
+ /** @internal */
5347
+ export type StartJourneyAnswer$Outbound = {
5348
+ id: number;
5349
+ choices: Array<string>;
5350
+ };
5351
+
5352
+ /** @internal */
5353
+ export const StartJourneyAnswer$outboundSchema: z.ZodMiniType<
5354
+ StartJourneyAnswer$Outbound,
5355
+ StartJourneyAnswer
5356
+ > = z.object({
5357
+ id: z.int(),
5358
+ choices: z.array(z.string()),
5359
+ });
5360
+
5361
+ export function startJourneyAnswerToJSON(
5362
+ startJourneyAnswer: StartJourneyAnswer,
5363
+ ): string {
5364
+ return JSON.stringify(
5365
+ StartJourneyAnswer$outboundSchema.parse(startJourneyAnswer),
5366
+ );
5367
+ }
5368
+
5369
+ /** @internal */
5370
+ export type StartJourneyKba$Outbound = {
5371
+ questions: Array<StartJourneyQuestion$Outbound>;
5372
+ answers: Array<StartJourneyAnswer$Outbound>;
5373
+ };
5374
+
5375
+ /** @internal */
5376
+ export const StartJourneyKba$outboundSchema: z.ZodMiniType<
5377
+ StartJourneyKba$Outbound,
5378
+ StartJourneyKba
5379
+ > = z.object({
5380
+ questions: z.array(z.lazy(() => StartJourneyQuestion$outboundSchema)),
5381
+ answers: z.array(z.lazy(() => StartJourneyAnswer$outboundSchema)),
5382
+ });
5383
+
5384
+ export function startJourneyKbaToJSON(
5385
+ startJourneyKba: StartJourneyKba,
5386
+ ): string {
5387
+ return JSON.stringify(StartJourneyKba$outboundSchema.parse(startJourneyKba));
5388
+ }
5389
+
5390
+ /** @internal */
5391
+ export const StartJourneyOffered$outboundSchema: z.ZodMiniEnum<
5392
+ typeof StartJourneyOffered
5393
+ > = z.enum(StartJourneyOffered);
5394
+
5395
+ /** @internal */
5396
+ export const StartJourneySelected$outboundSchema: z.ZodMiniEnum<
5397
+ typeof StartJourneySelected
5398
+ > = z.enum(StartJourneySelected);
5399
+
5400
+ /** @internal */
5401
+ export type StartJourneyDocumentTypeSelection$Outbound = {
5402
+ offered?: Array<string> | undefined;
5403
+ selected?: string | undefined;
5404
+ };
5405
+
5406
+ /** @internal */
5407
+ export const StartJourneyDocumentTypeSelection$outboundSchema: z.ZodMiniType<
5408
+ StartJourneyDocumentTypeSelection$Outbound,
5409
+ StartJourneyDocumentTypeSelection
5410
+ > = z.object({
5411
+ offered: z.optional(z.array(StartJourneyOffered$outboundSchema)),
5412
+ selected: z.optional(StartJourneySelected$outboundSchema),
5413
+ });
5414
+
5415
+ export function startJourneyDocumentTypeSelectionToJSON(
5416
+ startJourneyDocumentTypeSelection: StartJourneyDocumentTypeSelection,
5417
+ ): string {
5418
+ return JSON.stringify(
5419
+ StartJourneyDocumentTypeSelection$outboundSchema.parse(
5420
+ startJourneyDocumentTypeSelection,
5421
+ ),
5422
+ );
5423
+ }
5424
+
5425
+ /** @internal */
5426
+ export type StartJourneyContextSubject$Outbound = {
3747
5427
  identity?: StartJourneyIdentity$Outbound | undefined;
5428
+ entities?: Array<StartJourneyEntity$Outbound> | undefined;
3748
5429
  documents?: Array<StartJourneyDocument$Outbound> | undefined;
3749
5430
  biometrics?:
3750
5431
  | Array<
3751
5432
  | StartJourneyBiometric1$Outbound
3752
5433
  | StartJourneyBiometric2$Outbound
5434
+ | StartJourneyBiometricStoredFace$Outbound
5435
+ | StartJourneyBiometricOrphanedStoredFace$Outbound
3753
5436
  | StartJourneyBiometric3$Outbound
3754
5437
  | StartJourneyBiometric4$Outbound
5438
+ | StartJourneyBiometric5$Outbound
3755
5439
  >
3756
5440
  | undefined;
3757
5441
  sessions?: Array<StartJourneySession$Outbound> | undefined;
3758
5442
  consent?: Array<StartJourneyConsent$Outbound> | undefined;
3759
5443
  accounts?: Array<StartJourneyAccount$Outbound> | undefined;
5444
+ kba?: StartJourneyKba$Outbound | undefined;
5445
+ documentTypeSelection?:
5446
+ | StartJourneyDocumentTypeSelection$Outbound
5447
+ | undefined;
3760
5448
  uid?: string | undefined;
3761
5449
  };
3762
5450
 
3763
5451
  /** @internal */
3764
- export const StartJourneySubject$outboundSchema: z.ZodMiniType<
3765
- StartJourneySubject$Outbound,
3766
- StartJourneySubject
5452
+ export const StartJourneyContextSubject$outboundSchema: z.ZodMiniType<
5453
+ StartJourneyContextSubject$Outbound,
5454
+ StartJourneyContextSubject
3767
5455
  > = z.object({
3768
5456
  identity: z.optional(z.lazy(() => StartJourneyIdentity$outboundSchema)),
5457
+ entities: z.optional(
5458
+ z.array(z.lazy(() => StartJourneyEntity$outboundSchema)),
5459
+ ),
3769
5460
  documents: z.optional(
3770
5461
  z.array(z.lazy(() => StartJourneyDocument$outboundSchema)),
3771
5462
  ),
@@ -3775,8 +5466,11 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
3775
5466
  z.lazy(() =>
3776
5467
  StartJourneyBiometric2$outboundSchema
3777
5468
  ),
5469
+ z.lazy(() => StartJourneyBiometricStoredFace$outboundSchema),
5470
+ z.lazy(() => StartJourneyBiometricOrphanedStoredFace$outboundSchema),
3778
5471
  z.lazy(() => StartJourneyBiometric3$outboundSchema),
3779
5472
  z.lazy(() => StartJourneyBiometric4$outboundSchema),
5473
+ z.lazy(() => StartJourneyBiometric5$outboundSchema),
3780
5474
  ])),
3781
5475
  ),
3782
5476
  sessions: z.optional(
@@ -3788,122 +5482,241 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
3788
5482
  accounts: z.optional(
3789
5483
  z.array(z.lazy(() => StartJourneyAccount$outboundSchema)),
3790
5484
  ),
5485
+ kba: z.optional(z.lazy(() => StartJourneyKba$outboundSchema)),
5486
+ documentTypeSelection: z.optional(
5487
+ z.lazy(() => StartJourneyDocumentTypeSelection$outboundSchema),
5488
+ ),
3791
5489
  uid: z.optional(z.string()),
3792
5490
  });
3793
5491
 
3794
- export function startJourneySubjectToJSON(
3795
- startJourneySubject: StartJourneySubject,
5492
+ export function startJourneyContextSubjectToJSON(
5493
+ startJourneyContextSubject: StartJourneyContextSubject,
3796
5494
  ): string {
3797
5495
  return JSON.stringify(
3798
- StartJourneySubject$outboundSchema.parse(startJourneySubject),
5496
+ StartJourneyContextSubject$outboundSchema.parse(startJourneyContextSubject),
3799
5497
  );
3800
5498
  }
3801
5499
 
3802
5500
  /** @internal */
3803
- export type StartJourneyContext$Outbound = {
3804
- config: Config$Outbound;
3805
- subject: StartJourneySubject$Outbound;
5501
+ export const ResumeMode$outboundSchema: z.ZodMiniEnum<typeof ResumeMode> = z
5502
+ .enum(ResumeMode);
5503
+
5504
+ /** @internal */
5505
+ export type Reminders$Outbound = {
5506
+ intervalMinutes: number;
5507
+ maxReminders: number;
3806
5508
  };
3807
5509
 
3808
5510
  /** @internal */
3809
- export const StartJourneyContext$outboundSchema: z.ZodMiniType<
3810
- StartJourneyContext$Outbound,
3811
- StartJourneyContext
5511
+ export const Reminders$outboundSchema: z.ZodMiniType<
5512
+ Reminders$Outbound,
5513
+ Reminders
3812
5514
  > = z.object({
3813
- config: z.lazy(() => Config$outboundSchema),
3814
- subject: z.lazy(() => StartJourneySubject$outboundSchema),
5515
+ intervalMinutes: z.int(),
5516
+ maxReminders: z.int(),
3815
5517
  });
3816
5518
 
3817
- export function startJourneyContextToJSON(
3818
- startJourneyContext: StartJourneyContext,
3819
- ): string {
3820
- return JSON.stringify(
3821
- StartJourneyContext$outboundSchema.parse(startJourneyContext),
3822
- );
5519
+ export function remindersToJSON(reminders: Reminders): string {
5520
+ return JSON.stringify(Reminders$outboundSchema.parse(reminders));
3823
5521
  }
3824
5522
 
3825
5523
  /** @internal */
3826
- export type StartJourneyRequest$Outbound = {
3827
- resourceId: string;
3828
- context?: StartJourneyContext$Outbound | undefined;
3829
- data?: { [k: string]: any } | undefined;
5524
+ export type LinkConfig$Outbound = {
5525
+ ttlMinutes?: number | undefined;
5526
+ resumeMode?: string | undefined;
5527
+ resumeExpiryMinutes?: number | undefined;
5528
+ reminders?: Reminders$Outbound | undefined;
3830
5529
  };
3831
5530
 
3832
5531
  /** @internal */
3833
- export const StartJourneyRequest$outboundSchema: z.ZodMiniType<
3834
- StartJourneyRequest$Outbound,
3835
- StartJourneyRequest
5532
+ export const LinkConfig$outboundSchema: z.ZodMiniType<
5533
+ LinkConfig$Outbound,
5534
+ LinkConfig
3836
5535
  > = z.object({
3837
- resourceId: z.string(),
3838
- context: z.optional(z.lazy(() => StartJourneyContext$outboundSchema)),
3839
- data: z.optional(z.record(z.string(), z.any())),
5536
+ ttlMinutes: z.optional(z.int()),
5537
+ resumeMode: z.optional(ResumeMode$outboundSchema),
5538
+ resumeExpiryMinutes: z.optional(z.int()),
5539
+ reminders: z.optional(z.lazy(() => Reminders$outboundSchema)),
3840
5540
  });
3841
5541
 
3842
- export function startJourneyRequestToJSON(
3843
- startJourneyRequest: StartJourneyRequest,
3844
- ): string {
3845
- return JSON.stringify(
3846
- StartJourneyRequest$outboundSchema.parse(startJourneyRequest),
5542
+ export function linkConfigToJSON(linkConfig: LinkConfig): string {
5543
+ return JSON.stringify(LinkConfig$outboundSchema.parse(linkConfig));
5544
+ }
5545
+
5546
+ /** @internal */
5547
+ export type Overlay$Outbound = {
5548
+ version: string;
5549
+ };
5550
+
5551
+ /** @internal */
5552
+ export const Overlay$outboundSchema: z.ZodMiniType<Overlay$Outbound, Overlay> =
5553
+ z.object({
5554
+ version: z.string(),
5555
+ });
5556
+
5557
+ export function overlayToJSON(overlay: Overlay): string {
5558
+ return JSON.stringify(Overlay$outboundSchema.parse(overlay));
5559
+ }
5560
+
5561
+ /** @internal */
5562
+ export type Config$Outbound = {
5563
+ delivery: string;
5564
+ branding?: any | undefined;
5565
+ assisted?: boolean | undefined;
5566
+ inlineResult?: boolean | undefined;
5567
+ syncWaitSeconds?: number | undefined;
5568
+ linkConfig?: LinkConfig$Outbound | undefined;
5569
+ overlay?: Overlay$Outbound | undefined;
5570
+ [additionalProperties: string]: unknown;
5571
+ };
5572
+
5573
+ /** @internal */
5574
+ export const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config> = z
5575
+ .catchall(
5576
+ z.object({
5577
+ delivery: z.string(),
5578
+ branding: z.optional(z.any()),
5579
+ assisted: z.optional(z.boolean()),
5580
+ inlineResult: z.optional(z.boolean()),
5581
+ syncWaitSeconds: z.optional(z.int()),
5582
+ linkConfig: z.optional(z.lazy(() => LinkConfig$outboundSchema)),
5583
+ overlay: z.optional(z.lazy(() => Overlay$outboundSchema)),
5584
+ }),
5585
+ z.any(),
3847
5586
  );
5587
+
5588
+ export function configToJSON(config: Config): string {
5589
+ return JSON.stringify(Config$outboundSchema.parse(config));
3848
5590
  }
3849
5591
 
3850
5592
  /** @internal */
3851
- export const StartJourneyResponseBody2$inboundSchema: z.ZodMiniType<
3852
- StartJourneyResponseBody2,
3853
- unknown
5593
+ export type StartJourneyContext$Outbound = {
5594
+ subject?: StartJourneyContextSubject$Outbound | undefined;
5595
+ config: Config$Outbound;
5596
+ [additionalProperties: string]: unknown;
5597
+ };
5598
+
5599
+ /** @internal */
5600
+ export const StartJourneyContext$outboundSchema: z.ZodMiniType<
5601
+ StartJourneyContext$Outbound,
5602
+ StartJourneyContext
3854
5603
  > = z.catchall(
3855
5604
  z.object({
3856
- instanceId: types.string(),
5605
+ subject: z.optional(
5606
+ z.lazy(() => StartJourneyContextSubject$outboundSchema),
5607
+ ),
5608
+ config: z.lazy(() => Config$outboundSchema),
3857
5609
  }),
3858
5610
  z.any(),
3859
5611
  );
3860
5612
 
3861
- export function startJourneyResponseBody2FromJSON(
3862
- jsonString: string,
3863
- ): SafeParseResult<StartJourneyResponseBody2, SDKValidationError> {
3864
- return safeParse(
3865
- jsonString,
3866
- (x) => StartJourneyResponseBody2$inboundSchema.parse(JSON.parse(x)),
3867
- `Failed to parse 'StartJourneyResponseBody2' from JSON`,
5613
+ export function startJourneyContextToJSON(
5614
+ startJourneyContext: StartJourneyContext,
5615
+ ): string {
5616
+ return JSON.stringify(
5617
+ StartJourneyContext$outboundSchema.parse(startJourneyContext),
5618
+ );
5619
+ }
5620
+
5621
+ /** @internal */
5622
+ export type ModulesSubject$Outbound = {};
5623
+
5624
+ /** @internal */
5625
+ export const ModulesSubject$outboundSchema: z.ZodMiniType<
5626
+ ModulesSubject$Outbound,
5627
+ ModulesSubject
5628
+ > = z.object({});
5629
+
5630
+ export function modulesSubjectToJSON(modulesSubject: ModulesSubject): string {
5631
+ return JSON.stringify(ModulesSubject$outboundSchema.parse(modulesSubject));
5632
+ }
5633
+
5634
+ /** @internal */
5635
+ export type Modules$Outbound = {
5636
+ outcome: string;
5637
+ advice?: { [k: string]: any } | undefined;
5638
+ subject?: ModulesSubject$Outbound | undefined;
5639
+ [additionalProperties: string]: unknown;
5640
+ };
5641
+
5642
+ /** @internal */
5643
+ export const Modules$outboundSchema: z.ZodMiniType<Modules$Outbound, Modules> =
5644
+ z.catchall(
5645
+ z.object({
5646
+ outcome: z.string(),
5647
+ advice: z.optional(z.record(z.string(), z.any())),
5648
+ subject: z.optional(z.lazy(() => ModulesSubject$outboundSchema)),
5649
+ }),
5650
+ z.any(),
3868
5651
  );
5652
+
5653
+ export function modulesToJSON(modules: Modules): string {
5654
+ return JSON.stringify(Modules$outboundSchema.parse(modules));
5655
+ }
5656
+
5657
+ /** @internal */
5658
+ export type DefaultSubject$Outbound = {};
5659
+
5660
+ /** @internal */
5661
+ export const DefaultSubject$outboundSchema: z.ZodMiniType<
5662
+ DefaultSubject$Outbound,
5663
+ DefaultSubject
5664
+ > = z.object({});
5665
+
5666
+ export function defaultSubjectToJSON(defaultSubject: DefaultSubject): string {
5667
+ return JSON.stringify(DefaultSubject$outboundSchema.parse(defaultSubject));
3869
5668
  }
3870
5669
 
3871
5670
  /** @internal */
3872
- export const StartJourneyResponseBody1$inboundSchema: z.ZodMiniType<
3873
- StartJourneyResponseBody1,
3874
- unknown
5671
+ export type Scenario$Outbound = {
5672
+ modules: { [k: string]: Modules$Outbound };
5673
+ defaultOutcome?: string | undefined;
5674
+ defaultAdvice?: { [k: string]: any } | undefined;
5675
+ defaultSubject?: DefaultSubject$Outbound | undefined;
5676
+ description?: string | undefined;
5677
+ [additionalProperties: string]: unknown;
5678
+ };
5679
+
5680
+ /** @internal */
5681
+ export const Scenario$outboundSchema: z.ZodMiniType<
5682
+ Scenario$Outbound,
5683
+ Scenario
3875
5684
  > = z.catchall(
3876
5685
  z.object({
3877
- instanceId: types.string(),
5686
+ modules: z.record(z.string(), z.lazy(() => Modules$outboundSchema)),
5687
+ defaultOutcome: z.optional(z.string()),
5688
+ defaultAdvice: z.optional(z.record(z.string(), z.any())),
5689
+ defaultSubject: z.optional(z.lazy(() => DefaultSubject$outboundSchema)),
5690
+ description: z.optional(z.string()),
3878
5691
  }),
3879
5692
  z.any(),
3880
5693
  );
3881
5694
 
3882
- export function startJourneyResponseBody1FromJSON(
3883
- jsonString: string,
3884
- ): SafeParseResult<StartJourneyResponseBody1, SDKValidationError> {
3885
- return safeParse(
3886
- jsonString,
3887
- (x) => StartJourneyResponseBody1$inboundSchema.parse(JSON.parse(x)),
3888
- `Failed to parse 'StartJourneyResponseBody1' from JSON`,
3889
- );
5695
+ export function scenarioToJSON(scenario: Scenario): string {
5696
+ return JSON.stringify(Scenario$outboundSchema.parse(scenario));
3890
5697
  }
3891
5698
 
3892
5699
  /** @internal */
3893
- export const StartJourneyResponse$inboundSchema: z.ZodMiniType<
3894
- StartJourneyResponse,
3895
- unknown
3896
- > = smartUnion([
3897
- z.lazy(() => StartJourneyResponseBody1$inboundSchema),
3898
- z.lazy(() => StartJourneyResponseBody2$inboundSchema),
3899
- ]);
5700
+ export type StartJourneyRequest$Outbound = {
5701
+ resourceId: string;
5702
+ context: StartJourneyContext$Outbound;
5703
+ scenario?: Scenario$Outbound | undefined;
5704
+ };
5705
+
5706
+ /** @internal */
5707
+ export const StartJourneyRequest$outboundSchema: z.ZodMiniType<
5708
+ StartJourneyRequest$Outbound,
5709
+ StartJourneyRequest
5710
+ > = z.object({
5711
+ resourceId: z.string(),
5712
+ context: z.lazy(() => StartJourneyContext$outboundSchema),
5713
+ scenario: z.optional(z.lazy(() => Scenario$outboundSchema)),
5714
+ });
3900
5715
 
3901
- export function startJourneyResponseFromJSON(
3902
- jsonString: string,
3903
- ): SafeParseResult<StartJourneyResponse, SDKValidationError> {
3904
- return safeParse(
3905
- jsonString,
3906
- (x) => StartJourneyResponse$inboundSchema.parse(JSON.parse(x)),
3907
- `Failed to parse 'StartJourneyResponse' from JSON`,
5716
+ export function startJourneyRequestToJSON(
5717
+ startJourneyRequest: StartJourneyRequest,
5718
+ ): string {
5719
+ return JSON.stringify(
5720
+ StartJourneyRequest$outboundSchema.parse(startJourneyRequest),
3908
5721
  );
3909
5722
  }