@gbg/go-core 0.1.2 → 0.2.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (853) hide show
  1. package/FUNCTIONS.md +6 -4
  2. package/README.md +92 -61
  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 +9 -4
  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 +11 -8
  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 +9 -4
  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 +19 -7
  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 +15 -4
  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 +13 -7
  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 +9 -4
  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/sandbox-create-scenario.d.ts +21 -0
  64. package/dist/commonjs/funcs/sandbox-create-scenario.d.ts.map +1 -0
  65. package/dist/commonjs/funcs/sandbox-create-scenario.js +129 -0
  66. package/dist/commonjs/funcs/sandbox-create-scenario.js.map +1 -0
  67. package/dist/commonjs/funcs/sandbox-delete-scenario.d.ts +20 -0
  68. package/dist/commonjs/funcs/sandbox-delete-scenario.d.ts.map +1 -0
  69. package/dist/commonjs/funcs/sandbox-delete-scenario.js +131 -0
  70. package/dist/commonjs/funcs/sandbox-delete-scenario.js.map +1 -0
  71. package/dist/commonjs/funcs/sandbox-get-scenario.d.ts +21 -0
  72. package/dist/commonjs/funcs/sandbox-get-scenario.d.ts.map +1 -0
  73. package/dist/commonjs/funcs/sandbox-get-scenario.js +136 -0
  74. package/dist/commonjs/funcs/sandbox-get-scenario.js.map +1 -0
  75. package/dist/commonjs/funcs/sandbox-list-scenarios.d.ts +21 -0
  76. package/dist/commonjs/funcs/sandbox-list-scenarios.d.ts.map +1 -0
  77. package/dist/commonjs/funcs/sandbox-list-scenarios.js +132 -0
  78. package/dist/commonjs/funcs/sandbox-list-scenarios.js.map +1 -0
  79. package/dist/commonjs/funcs/sandbox-put-scenario.d.ts +21 -0
  80. package/dist/commonjs/funcs/sandbox-put-scenario.d.ts.map +1 -0
  81. package/dist/commonjs/funcs/sandbox-put-scenario.js +133 -0
  82. package/dist/commonjs/funcs/sandbox-put-scenario.js.map +1 -0
  83. package/dist/commonjs/funcs/tasks-get-schema.d.ts +8 -3
  84. package/dist/commonjs/funcs/tasks-get-schema.d.ts.map +1 -1
  85. package/dist/commonjs/funcs/tasks-get-schema.js +10 -4
  86. package/dist/commonjs/funcs/tasks-get-schema.js.map +1 -1
  87. package/dist/commonjs/funcs/tokens-generate.js +1 -1
  88. package/dist/commonjs/funcs/tokens-generate.js.map +1 -1
  89. package/dist/commonjs/lib/config.d.ts +5 -5
  90. package/dist/commonjs/lib/config.d.ts.map +1 -1
  91. package/dist/commonjs/lib/config.js +16 -7
  92. package/dist/commonjs/lib/config.js.map +1 -1
  93. package/dist/commonjs/models/create-sandbox-scenario-request.d.ts +29 -0
  94. package/dist/commonjs/models/create-sandbox-scenario-request.d.ts.map +1 -0
  95. package/dist/commonjs/models/create-sandbox-scenario-request.js +56 -0
  96. package/dist/commonjs/models/create-sandbox-scenario-request.js.map +1 -0
  97. package/dist/commonjs/models/delete-response.d.ts +19 -0
  98. package/dist/commonjs/models/delete-response.d.ts.map +1 -0
  99. package/dist/commonjs/models/delete-response.js +58 -0
  100. package/dist/commonjs/models/delete-response.js.map +1 -0
  101. package/dist/commonjs/models/device-connect-response.d.ts +23 -0
  102. package/dist/commonjs/models/device-connect-response.d.ts.map +1 -0
  103. package/dist/commonjs/models/device-connect-response.js +62 -0
  104. package/dist/commonjs/models/device-connect-response.js.map +1 -0
  105. package/dist/commonjs/models/device-refresh-response.d.ts +16 -0
  106. package/dist/commonjs/models/device-refresh-response.d.ts.map +1 -0
  107. package/dist/commonjs/models/device-refresh-response.js +57 -0
  108. package/dist/commonjs/models/device-refresh-response.js.map +1 -0
  109. package/dist/commonjs/models/device-start-response.d.ts +20 -0
  110. package/dist/commonjs/models/device-start-response.d.ts.map +1 -0
  111. package/dist/commonjs/models/device-start-response.js +59 -0
  112. package/dist/commonjs/models/device-start-response.js.map +1 -0
  113. package/dist/commonjs/models/device-validate-response.d.ts +14 -0
  114. package/dist/commonjs/models/device-validate-response.d.ts.map +1 -0
  115. package/dist/commonjs/models/device-validate-response.js +55 -0
  116. package/dist/commonjs/models/device-validate-response.js.map +1 -0
  117. package/dist/commonjs/models/errors/error-response.d.ts +19 -0
  118. package/dist/commonjs/models/errors/error-response.d.ts.map +1 -0
  119. package/dist/commonjs/models/errors/error-response.js +68 -0
  120. package/dist/commonjs/models/errors/error-response.js.map +1 -0
  121. package/dist/commonjs/models/errors/index.d.ts +1 -0
  122. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  123. package/dist/commonjs/models/errors/index.js +1 -0
  124. package/dist/commonjs/models/errors/index.js.map +1 -1
  125. package/dist/commonjs/models/gbg-error.d.ts +28 -0
  126. package/dist/commonjs/models/gbg-error.d.ts.map +1 -0
  127. package/dist/commonjs/models/gbg-error.js +69 -0
  128. package/dist/commonjs/models/gbg-error.js.map +1 -0
  129. package/dist/commonjs/models/handoff-token-response.d.ts +20 -0
  130. package/dist/commonjs/models/handoff-token-response.d.ts.map +1 -0
  131. package/dist/commonjs/models/handoff-token-response.js +60 -0
  132. package/dist/commonjs/models/handoff-token-response.js.map +1 -0
  133. package/dist/commonjs/models/index.d.ts +30 -0
  134. package/dist/commonjs/models/index.d.ts.map +1 -1
  135. package/dist/commonjs/models/index.js +30 -0
  136. package/dist/commonjs/models/index.js.map +1 -1
  137. package/dist/commonjs/models/interaction-fetch-response.d.ts +53 -0
  138. package/dist/commonjs/models/interaction-fetch-response.d.ts.map +1 -0
  139. package/dist/commonjs/models/interaction-fetch-response.js +92 -0
  140. package/dist/commonjs/models/interaction-fetch-response.js.map +1 -0
  141. package/dist/commonjs/models/interaction-submit-response.d.ts +17 -0
  142. package/dist/commonjs/models/interaction-submit-response.d.ts.map +1 -0
  143. package/dist/commonjs/models/interaction-submit-response.js +55 -0
  144. package/dist/commonjs/models/interaction-submit-response.js.map +1 -0
  145. package/dist/commonjs/models/journey-start-response.d.ts +27 -0
  146. package/dist/commonjs/models/journey-start-response.d.ts.map +1 -0
  147. package/dist/commonjs/models/journey-start-response.js +67 -0
  148. package/dist/commonjs/models/journey-start-response.js.map +1 -0
  149. package/dist/commonjs/models/loqate-retrieve-response.d.ts +12 -0
  150. package/dist/commonjs/models/loqate-retrieve-response.d.ts.map +1 -0
  151. package/dist/commonjs/models/loqate-retrieve-response.js +55 -0
  152. package/dist/commonjs/models/loqate-retrieve-response.js.map +1 -0
  153. package/dist/commonjs/models/loqate-search-response.d.ts +12 -0
  154. package/dist/commonjs/models/loqate-search-response.d.ts.map +1 -0
  155. package/dist/commonjs/models/loqate-search-response.js +55 -0
  156. package/dist/commonjs/models/loqate-search-response.js.map +1 -0
  157. package/dist/commonjs/models/operations/add-device.d.ts +8 -92
  158. package/dist/commonjs/models/operations/add-device.d.ts.map +1 -1
  159. package/dist/commonjs/models/operations/add-device.js +6 -76
  160. package/dist/commonjs/models/operations/add-device.js.map +1 -1
  161. package/dist/commonjs/models/operations/create-handoff-token.d.ts +22 -0
  162. package/dist/commonjs/models/operations/create-handoff-token.d.ts.map +1 -0
  163. package/dist/commonjs/models/operations/create-handoff-token.js +62 -0
  164. package/dist/commonjs/models/operations/create-handoff-token.js.map +1 -0
  165. package/dist/commonjs/models/operations/create-sandbox-scenario.d.ts +18 -0
  166. package/dist/commonjs/models/operations/create-sandbox-scenario.d.ts.map +1 -0
  167. package/dist/commonjs/models/operations/create-sandbox-scenario.js +51 -0
  168. package/dist/commonjs/models/operations/create-sandbox-scenario.js.map +1 -0
  169. package/dist/commonjs/models/operations/delete-instance.d.ts +1 -14
  170. package/dist/commonjs/models/operations/delete-instance.d.ts.map +1 -1
  171. package/dist/commonjs/models/operations/delete-instance.js +3 -13
  172. package/dist/commonjs/models/operations/delete-instance.js.map +1 -1
  173. package/dist/commonjs/models/operations/delete-sandbox-scenario.d.ts +20 -0
  174. package/dist/commonjs/models/operations/delete-sandbox-scenario.d.ts.map +1 -0
  175. package/dist/commonjs/models/operations/delete-sandbox-scenario.js +50 -0
  176. package/dist/commonjs/models/operations/delete-sandbox-scenario.js.map +1 -0
  177. package/dist/commonjs/models/operations/device-connect.d.ts +0 -59
  178. package/dist/commonjs/models/operations/device-connect.d.ts.map +1 -1
  179. package/dist/commonjs/models/operations/device-connect.js +1 -50
  180. package/dist/commonjs/models/operations/device-connect.js.map +1 -1
  181. package/dist/commonjs/models/operations/device-validate.d.ts +12 -0
  182. package/dist/commonjs/models/operations/device-validate.d.ts.map +1 -0
  183. package/dist/commonjs/models/operations/device-validate.js +54 -0
  184. package/dist/commonjs/models/operations/device-validate.js.map +1 -0
  185. package/dist/commonjs/models/operations/fetch-interaction.d.ts +34 -1621
  186. package/dist/commonjs/models/operations/fetch-interaction.d.ts.map +1 -1
  187. package/dist/commonjs/models/operations/fetch-interaction.js +22 -1334
  188. package/dist/commonjs/models/operations/fetch-interaction.js.map +1 -1
  189. package/dist/commonjs/models/operations/get-journey-schemas.d.ts +16 -0
  190. package/dist/commonjs/models/operations/get-journey-schemas.d.ts.map +1 -0
  191. package/dist/commonjs/models/operations/get-journey-schemas.js +51 -0
  192. package/dist/commonjs/models/operations/get-journey-schemas.js.map +1 -0
  193. package/dist/commonjs/models/operations/get-journey-state.d.ts +16 -1383
  194. package/dist/commonjs/models/operations/get-journey-state.d.ts.map +1 -1
  195. package/dist/commonjs/models/operations/get-journey-state.js +14 -1067
  196. package/dist/commonjs/models/operations/get-journey-state.js.map +1 -1
  197. package/dist/commonjs/models/operations/get-sandbox-scenario.d.ts +39 -0
  198. package/dist/commonjs/models/operations/get-sandbox-scenario.d.ts.map +1 -0
  199. package/dist/commonjs/models/operations/get-sandbox-scenario.js +60 -0
  200. package/dist/commonjs/models/operations/get-sandbox-scenario.js.map +1 -0
  201. package/dist/commonjs/models/operations/get-task-schema.d.ts +1 -17
  202. package/dist/commonjs/models/operations/get-task-schema.d.ts.map +1 -1
  203. package/dist/commonjs/models/operations/get-task-schema.js +1 -19
  204. package/dist/commonjs/models/operations/get-task-schema.js.map +1 -1
  205. package/dist/commonjs/models/operations/index.d.ts +12 -4
  206. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  207. package/dist/commonjs/models/operations/index.js +12 -4
  208. package/dist/commonjs/models/operations/index.js.map +1 -1
  209. package/dist/commonjs/models/operations/list-sandbox-scenarios.d.ts +34 -0
  210. package/dist/commonjs/models/operations/list-sandbox-scenarios.d.ts.map +1 -0
  211. package/dist/commonjs/models/operations/list-sandbox-scenarios.js +59 -0
  212. package/dist/commonjs/models/operations/list-sandbox-scenarios.js.map +1 -0
  213. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts +2 -2
  214. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  215. package/dist/commonjs/models/operations/post-as-token-oauth2.js +1 -1
  216. package/dist/commonjs/models/operations/post-as-token-oauth2.js.map +1 -1
  217. package/dist/commonjs/models/operations/put-sandbox-scenario.d.ts +23 -0
  218. package/dist/commonjs/models/operations/put-sandbox-scenario.d.ts.map +1 -0
  219. package/dist/commonjs/models/operations/put-sandbox-scenario.js +52 -0
  220. package/dist/commonjs/models/operations/put-sandbox-scenario.js.map +1 -0
  221. package/dist/commonjs/models/operations/retrieve-address.d.ts +29 -0
  222. package/dist/commonjs/models/operations/retrieve-address.d.ts.map +1 -0
  223. package/dist/commonjs/models/operations/retrieve-address.js +65 -0
  224. package/dist/commonjs/models/operations/retrieve-address.js.map +1 -0
  225. package/dist/commonjs/models/operations/search-addresses.d.ts +33 -0
  226. package/dist/commonjs/models/operations/search-addresses.d.ts.map +1 -0
  227. package/dist/commonjs/models/operations/search-addresses.js +67 -0
  228. package/dist/commonjs/models/operations/search-addresses.js.map +1 -0
  229. package/dist/commonjs/models/operations/start-journey.d.ts +1071 -108
  230. package/dist/commonjs/models/operations/start-journey.d.ts.map +1 -1
  231. package/dist/commonjs/models/operations/start-journey.js +504 -62
  232. package/dist/commonjs/models/operations/start-journey.js.map +1 -1
  233. package/dist/commonjs/models/operations/submit-interaction.d.ts +989 -92
  234. package/dist/commonjs/models/operations/submit-interaction.d.ts.map +1 -1
  235. package/dist/commonjs/models/operations/submit-interaction.js +464 -50
  236. package/dist/commonjs/models/operations/submit-interaction.js.map +1 -1
  237. package/dist/commonjs/models/operations/terminate-journey.d.ts +19 -0
  238. package/dist/commonjs/models/operations/terminate-journey.d.ts.map +1 -0
  239. package/dist/commonjs/models/operations/terminate-journey.js +50 -0
  240. package/dist/commonjs/models/operations/terminate-journey.js.map +1 -0
  241. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts +26 -0
  242. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts.map +1 -0
  243. package/dist/commonjs/models/operations/upload-interaction-asset.js +67 -0
  244. package/dist/commonjs/models/operations/upload-interaction-asset.js.map +1 -0
  245. package/dist/commonjs/models/sandbox-scenario-summary.d.ts +29 -0
  246. package/dist/commonjs/models/sandbox-scenario-summary.d.ts.map +1 -0
  247. package/dist/commonjs/models/sandbox-scenario-summary.js +63 -0
  248. package/dist/commonjs/models/sandbox-scenario-summary.js.map +1 -0
  249. package/dist/commonjs/models/sandbox-scenario-written.d.ts +19 -0
  250. package/dist/commonjs/models/sandbox-scenario-written.d.ts.map +1 -0
  251. package/dist/commonjs/models/sandbox-scenario-written.js +58 -0
  252. package/dist/commonjs/models/sandbox-scenario-written.js.map +1 -0
  253. package/dist/commonjs/models/sandbox-scenario.d.ts +31 -0
  254. package/dist/commonjs/models/sandbox-scenario.d.ts.map +1 -0
  255. package/dist/commonjs/models/sandbox-scenario.js +63 -0
  256. package/dist/commonjs/models/sandbox-scenario.js.map +1 -0
  257. package/dist/commonjs/models/schema-fetch-response.d.ts +22 -0
  258. package/dist/commonjs/models/schema-fetch-response.d.ts.map +1 -0
  259. package/dist/commonjs/models/schema-fetch-response.js +63 -0
  260. package/dist/commonjs/models/schema-fetch-response.js.map +1 -0
  261. package/dist/commonjs/models/slim-document.d.ts +57 -0
  262. package/dist/commonjs/models/slim-document.d.ts.map +1 -0
  263. package/dist/commonjs/models/slim-document.js +93 -0
  264. package/dist/commonjs/models/slim-document.js.map +1 -0
  265. package/dist/commonjs/models/slim-extraction.d.ts +74 -0
  266. package/dist/commonjs/models/slim-extraction.d.ts.map +1 -0
  267. package/dist/commonjs/models/slim-extraction.js +129 -0
  268. package/dist/commonjs/models/slim-extraction.js.map +1 -0
  269. package/dist/commonjs/models/slim-identity.d.ts +202 -0
  270. package/dist/commonjs/models/slim-identity.d.ts.map +1 -0
  271. package/dist/commonjs/models/slim-identity.js +143 -0
  272. package/dist/commonjs/models/slim-identity.js.map +1 -0
  273. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts +58 -0
  274. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts.map +1 -0
  275. package/dist/commonjs/models/slim-interaction-fetch-response.js +102 -0
  276. package/dist/commonjs/models/slim-interaction-fetch-response.js.map +1 -0
  277. package/dist/commonjs/models/slim-journey.d.ts +14 -0
  278. package/dist/commonjs/models/slim-journey.d.ts.map +1 -0
  279. package/dist/commonjs/models/slim-journey.js +56 -0
  280. package/dist/commonjs/models/slim-journey.js.map +1 -0
  281. package/dist/commonjs/models/slim-result.d.ts +46 -0
  282. package/dist/commonjs/models/slim-result.d.ts.map +1 -0
  283. package/dist/commonjs/models/slim-result.js +77 -0
  284. package/dist/commonjs/models/slim-result.js.map +1 -0
  285. package/dist/commonjs/models/slim-state-fetch-response.d.ts +26 -0
  286. package/dist/commonjs/models/slim-state-fetch-response.d.ts.map +1 -0
  287. package/dist/commonjs/models/slim-state-fetch-response.js +66 -0
  288. package/dist/commonjs/models/slim-state-fetch-response.js.map +1 -0
  289. package/dist/commonjs/models/slim-step.d.ts +22 -0
  290. package/dist/commonjs/models/slim-step.d.ts.map +1 -0
  291. package/dist/commonjs/models/slim-step.js +63 -0
  292. package/dist/commonjs/models/slim-step.js.map +1 -0
  293. package/dist/commonjs/models/slim-validation.d.ts +69 -0
  294. package/dist/commonjs/models/slim-validation.d.ts.map +1 -0
  295. package/dist/commonjs/models/slim-validation.js +122 -0
  296. package/dist/commonjs/models/slim-validation.js.map +1 -0
  297. package/dist/commonjs/models/slim-verified-data.d.ts +16 -0
  298. package/dist/commonjs/models/slim-verified-data.d.ts.map +1 -0
  299. package/dist/commonjs/models/slim-verified-data.js +54 -0
  300. package/dist/commonjs/models/slim-verified-data.js.map +1 -0
  301. package/dist/commonjs/models/state-fetch-response.d.ts +17 -0
  302. package/dist/commonjs/models/state-fetch-response.d.ts.map +1 -0
  303. package/dist/commonjs/models/state-fetch-response.js +54 -0
  304. package/dist/commonjs/models/state-fetch-response.js.map +1 -0
  305. package/dist/commonjs/models/terminate-response.d.ts +10 -0
  306. package/dist/commonjs/models/terminate-response.d.ts.map +1 -0
  307. package/dist/commonjs/models/{operations/health.js → terminate-response.js} +10 -10
  308. package/dist/commonjs/models/terminate-response.js.map +1 -0
  309. package/dist/commonjs/models/update-sandbox-scenario-request.d.ts +24 -0
  310. package/dist/commonjs/models/update-sandbox-scenario-request.d.ts.map +1 -0
  311. package/dist/commonjs/models/update-sandbox-scenario-request.js +55 -0
  312. package/dist/commonjs/models/update-sandbox-scenario-request.js.map +1 -0
  313. package/dist/commonjs/sdk/addresses.d.ts +20 -0
  314. package/dist/commonjs/sdk/addresses.d.ts.map +1 -0
  315. package/dist/commonjs/sdk/addresses.js +32 -0
  316. package/dist/commonjs/sdk/addresses.js.map +1 -0
  317. package/dist/commonjs/sdk/devices.d.ts +21 -6
  318. package/dist/commonjs/sdk/devices.d.ts.map +1 -1
  319. package/dist/commonjs/sdk/devices.js +26 -6
  320. package/dist/commonjs/sdk/devices.js.map +1 -1
  321. package/dist/commonjs/sdk/instances.d.ts +11 -3
  322. package/dist/commonjs/sdk/instances.d.ts.map +1 -1
  323. package/dist/commonjs/sdk/instances.js +12 -2
  324. package/dist/commonjs/sdk/instances.js.map +1 -1
  325. package/dist/commonjs/sdk/interactions.d.ts +14 -6
  326. package/dist/commonjs/sdk/interactions.d.ts.map +1 -1
  327. package/dist/commonjs/sdk/interactions.js +16 -6
  328. package/dist/commonjs/sdk/interactions.js.map +1 -1
  329. package/dist/commonjs/sdk/journeys.d.ts +45 -5
  330. package/dist/commonjs/sdk/journeys.d.ts.map +1 -1
  331. package/dist/commonjs/sdk/journeys.js +49 -4
  332. package/dist/commonjs/sdk/journeys.js.map +1 -1
  333. package/dist/commonjs/sdk/sandbox.d.ts +41 -0
  334. package/dist/commonjs/sdk/sandbox.d.ts.map +1 -0
  335. package/dist/commonjs/sdk/sandbox.js +62 -0
  336. package/dist/commonjs/sdk/sandbox.js.map +1 -0
  337. package/dist/commonjs/sdk/sdk.d.ts +14 -11
  338. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  339. package/dist/commonjs/sdk/sdk.js +17 -13
  340. package/dist/commonjs/sdk/sdk.js.map +1 -1
  341. package/dist/commonjs/sdk/tasks.d.ts +6 -23
  342. package/dist/commonjs/sdk/tasks.d.ts.map +1 -1
  343. package/dist/commonjs/sdk/tasks.js +3 -31
  344. package/dist/commonjs/sdk/tasks.js.map +1 -1
  345. package/dist/commonjs/types/smart-union.d.ts.map +1 -1
  346. package/dist/commonjs/types/smart-union.js +14 -10
  347. package/dist/commonjs/types/smart-union.js.map +1 -1
  348. package/dist/esm/funcs/addresses-retrieve.d.ts +19 -0
  349. package/dist/esm/funcs/addresses-retrieve.d.ts.map +1 -0
  350. package/dist/esm/funcs/{tasks-update.js → addresses-retrieve.js} +20 -9
  351. package/dist/esm/funcs/addresses-retrieve.js.map +1 -0
  352. package/dist/{commonjs/funcs/tasks-list-schema.d.ts → esm/funcs/addresses-search.d.ts} +6 -6
  353. package/dist/esm/funcs/addresses-search.d.ts.map +1 -0
  354. package/dist/esm/funcs/{tasks-list.js → addresses-search.js} +20 -9
  355. package/dist/esm/funcs/addresses-search.js.map +1 -0
  356. package/dist/esm/funcs/devices-add.d.ts +5 -3
  357. package/dist/esm/funcs/devices-add.d.ts.map +1 -1
  358. package/dist/esm/funcs/devices-add.js +9 -4
  359. package/dist/esm/funcs/devices-add.js.map +1 -1
  360. package/dist/esm/funcs/devices-connect.d.ts +5 -3
  361. package/dist/esm/funcs/devices-connect.d.ts.map +1 -1
  362. package/dist/esm/funcs/devices-connect.js +11 -8
  363. package/dist/esm/funcs/devices-connect.js.map +1 -1
  364. package/dist/{commonjs/funcs/tasks-update.d.ts → esm/funcs/devices-refresh.d.ts} +6 -5
  365. package/dist/esm/funcs/devices-refresh.d.ts.map +1 -0
  366. package/dist/esm/funcs/{health-get.js → devices-refresh.js} +15 -16
  367. package/dist/esm/funcs/devices-refresh.js.map +1 -0
  368. package/dist/{commonjs/funcs/tasks-list.d.ts → esm/funcs/devices-validate.d.ts} +6 -4
  369. package/dist/esm/funcs/devices-validate.d.ts.map +1 -0
  370. package/dist/esm/funcs/devices-validate.js +77 -0
  371. package/dist/esm/funcs/devices-validate.js.map +1 -0
  372. package/dist/esm/funcs/instances-delete.d.ts +5 -3
  373. package/dist/esm/funcs/instances-delete.d.ts.map +1 -1
  374. package/dist/esm/funcs/instances-delete.js +9 -4
  375. package/dist/esm/funcs/instances-delete.js.map +1 -1
  376. package/dist/esm/funcs/instances-handoff-token.d.ts +19 -0
  377. package/dist/esm/funcs/instances-handoff-token.d.ts.map +1 -0
  378. package/dist/esm/funcs/instances-handoff-token.js +94 -0
  379. package/dist/esm/funcs/instances-handoff-token.js.map +1 -0
  380. package/dist/esm/funcs/interactions-fetch.d.ts +4 -3
  381. package/dist/esm/funcs/interactions-fetch.d.ts.map +1 -1
  382. package/dist/esm/funcs/interactions-fetch.js +20 -8
  383. package/dist/esm/funcs/interactions-fetch.js.map +1 -1
  384. package/dist/esm/funcs/interactions-submit.d.ts +5 -3
  385. package/dist/esm/funcs/interactions-submit.d.ts.map +1 -1
  386. package/dist/esm/funcs/interactions-submit.js +15 -4
  387. package/dist/esm/funcs/interactions-submit.js.map +1 -1
  388. package/dist/esm/funcs/interactions-upload-asset.d.ts +18 -0
  389. package/dist/esm/funcs/interactions-upload-asset.d.ts.map +1 -0
  390. package/dist/esm/funcs/interactions-upload-asset.js +83 -0
  391. package/dist/esm/funcs/interactions-upload-asset.js.map +1 -0
  392. package/dist/esm/funcs/journeys-get-schemas.d.ts +46 -0
  393. package/dist/esm/funcs/journeys-get-schemas.d.ts.map +1 -0
  394. package/dist/esm/funcs/journeys-get-schemas.js +114 -0
  395. package/dist/esm/funcs/journeys-get-schemas.js.map +1 -0
  396. package/dist/esm/funcs/journeys-get-state.d.ts +4 -3
  397. package/dist/esm/funcs/journeys-get-state.d.ts.map +1 -1
  398. package/dist/esm/funcs/journeys-get-state.js +14 -8
  399. package/dist/esm/funcs/journeys-get-state.js.map +1 -1
  400. package/dist/esm/funcs/journeys-start.d.ts +5 -3
  401. package/dist/esm/funcs/journeys-start.d.ts.map +1 -1
  402. package/dist/esm/funcs/journeys-start.js +9 -4
  403. package/dist/esm/funcs/journeys-start.js.map +1 -1
  404. package/dist/esm/funcs/journeys-terminate.d.ts +21 -0
  405. package/dist/esm/funcs/journeys-terminate.d.ts.map +1 -0
  406. package/dist/esm/funcs/{tasks-list-schema.js → journeys-terminate.js} +13 -8
  407. package/dist/esm/funcs/journeys-terminate.js.map +1 -0
  408. package/dist/esm/funcs/sandbox-create-scenario.d.ts +21 -0
  409. package/dist/esm/funcs/sandbox-create-scenario.d.ts.map +1 -0
  410. package/dist/esm/funcs/sandbox-create-scenario.js +93 -0
  411. package/dist/esm/funcs/sandbox-create-scenario.js.map +1 -0
  412. package/dist/esm/funcs/sandbox-delete-scenario.d.ts +20 -0
  413. package/dist/esm/funcs/sandbox-delete-scenario.d.ts.map +1 -0
  414. package/dist/esm/funcs/sandbox-delete-scenario.js +95 -0
  415. package/dist/esm/funcs/sandbox-delete-scenario.js.map +1 -0
  416. package/dist/esm/funcs/sandbox-get-scenario.d.ts +21 -0
  417. package/dist/esm/funcs/sandbox-get-scenario.d.ts.map +1 -0
  418. package/dist/esm/funcs/sandbox-get-scenario.js +100 -0
  419. package/dist/esm/funcs/sandbox-get-scenario.js.map +1 -0
  420. package/dist/esm/funcs/sandbox-list-scenarios.d.ts +21 -0
  421. package/dist/esm/funcs/sandbox-list-scenarios.d.ts.map +1 -0
  422. package/dist/esm/funcs/sandbox-list-scenarios.js +96 -0
  423. package/dist/esm/funcs/sandbox-list-scenarios.js.map +1 -0
  424. package/dist/esm/funcs/sandbox-put-scenario.d.ts +21 -0
  425. package/dist/esm/funcs/sandbox-put-scenario.d.ts.map +1 -0
  426. package/dist/esm/funcs/sandbox-put-scenario.js +97 -0
  427. package/dist/esm/funcs/sandbox-put-scenario.js.map +1 -0
  428. package/dist/esm/funcs/tasks-get-schema.d.ts +8 -3
  429. package/dist/esm/funcs/tasks-get-schema.d.ts.map +1 -1
  430. package/dist/esm/funcs/tasks-get-schema.js +10 -4
  431. package/dist/esm/funcs/tasks-get-schema.js.map +1 -1
  432. package/dist/esm/funcs/tokens-generate.js +1 -1
  433. package/dist/esm/funcs/tokens-generate.js.map +1 -1
  434. package/dist/esm/lib/config.d.ts +5 -5
  435. package/dist/esm/lib/config.d.ts.map +1 -1
  436. package/dist/esm/lib/config.js +16 -7
  437. package/dist/esm/lib/config.js.map +1 -1
  438. package/dist/esm/models/create-sandbox-scenario-request.d.ts +29 -0
  439. package/dist/esm/models/create-sandbox-scenario-request.d.ts.map +1 -0
  440. package/dist/esm/models/create-sandbox-scenario-request.js +18 -0
  441. package/dist/esm/models/create-sandbox-scenario-request.js.map +1 -0
  442. package/dist/esm/models/delete-response.d.ts +19 -0
  443. package/dist/esm/models/delete-response.d.ts.map +1 -0
  444. package/dist/esm/models/delete-response.js +21 -0
  445. package/dist/esm/models/delete-response.js.map +1 -0
  446. package/dist/esm/models/device-connect-response.d.ts +23 -0
  447. package/dist/esm/models/device-connect-response.d.ts.map +1 -0
  448. package/dist/esm/models/device-connect-response.js +25 -0
  449. package/dist/esm/models/device-connect-response.js.map +1 -0
  450. package/dist/esm/models/device-refresh-response.d.ts +16 -0
  451. package/dist/esm/models/device-refresh-response.d.ts.map +1 -0
  452. package/dist/esm/models/device-refresh-response.js +20 -0
  453. package/dist/esm/models/device-refresh-response.js.map +1 -0
  454. package/dist/esm/models/device-start-response.d.ts +20 -0
  455. package/dist/esm/models/device-start-response.d.ts.map +1 -0
  456. package/dist/esm/models/device-start-response.js +22 -0
  457. package/dist/esm/models/device-start-response.js.map +1 -0
  458. package/dist/esm/models/device-validate-response.d.ts +14 -0
  459. package/dist/esm/models/device-validate-response.d.ts.map +1 -0
  460. package/dist/esm/models/device-validate-response.js +18 -0
  461. package/dist/esm/models/device-validate-response.js.map +1 -0
  462. package/dist/esm/models/errors/error-response.d.ts +19 -0
  463. package/dist/esm/models/errors/error-response.d.ts.map +1 -0
  464. package/dist/esm/models/errors/error-response.js +31 -0
  465. package/dist/esm/models/errors/error-response.js.map +1 -0
  466. package/dist/esm/models/errors/index.d.ts +1 -0
  467. package/dist/esm/models/errors/index.d.ts.map +1 -1
  468. package/dist/esm/models/errors/index.js +1 -0
  469. package/dist/esm/models/errors/index.js.map +1 -1
  470. package/dist/esm/models/gbg-error.d.ts +28 -0
  471. package/dist/esm/models/gbg-error.d.ts.map +1 -0
  472. package/dist/esm/models/gbg-error.js +32 -0
  473. package/dist/esm/models/gbg-error.js.map +1 -0
  474. package/dist/esm/models/handoff-token-response.d.ts +20 -0
  475. package/dist/esm/models/handoff-token-response.d.ts.map +1 -0
  476. package/dist/esm/models/handoff-token-response.js +23 -0
  477. package/dist/esm/models/handoff-token-response.js.map +1 -0
  478. package/dist/esm/models/index.d.ts +30 -0
  479. package/dist/esm/models/index.d.ts.map +1 -1
  480. package/dist/esm/models/index.js +30 -0
  481. package/dist/esm/models/index.js.map +1 -1
  482. package/dist/esm/models/interaction-fetch-response.d.ts +53 -0
  483. package/dist/esm/models/interaction-fetch-response.d.ts.map +1 -0
  484. package/dist/esm/models/interaction-fetch-response.js +52 -0
  485. package/dist/esm/models/interaction-fetch-response.js.map +1 -0
  486. package/dist/esm/models/interaction-submit-response.d.ts +17 -0
  487. package/dist/esm/models/interaction-submit-response.d.ts.map +1 -0
  488. package/dist/esm/models/interaction-submit-response.js +18 -0
  489. package/dist/esm/models/interaction-submit-response.js.map +1 -0
  490. package/dist/esm/models/journey-start-response.d.ts +27 -0
  491. package/dist/esm/models/journey-start-response.d.ts.map +1 -0
  492. package/dist/esm/models/journey-start-response.js +30 -0
  493. package/dist/esm/models/journey-start-response.js.map +1 -0
  494. package/dist/esm/models/loqate-retrieve-response.d.ts +12 -0
  495. package/dist/esm/models/loqate-retrieve-response.d.ts.map +1 -0
  496. package/dist/esm/models/loqate-retrieve-response.js +18 -0
  497. package/dist/esm/models/loqate-retrieve-response.js.map +1 -0
  498. package/dist/esm/models/loqate-search-response.d.ts +12 -0
  499. package/dist/esm/models/loqate-search-response.d.ts.map +1 -0
  500. package/dist/esm/models/loqate-search-response.js +18 -0
  501. package/dist/esm/models/loqate-search-response.js.map +1 -0
  502. package/dist/esm/models/operations/add-device.d.ts +8 -92
  503. package/dist/esm/models/operations/add-device.d.ts.map +1 -1
  504. package/dist/esm/models/operations/add-device.js +5 -72
  505. package/dist/esm/models/operations/add-device.js.map +1 -1
  506. package/dist/esm/models/operations/create-handoff-token.d.ts +22 -0
  507. package/dist/esm/models/operations/create-handoff-token.d.ts.map +1 -0
  508. package/dist/esm/models/operations/create-handoff-token.js +24 -0
  509. package/dist/esm/models/operations/create-handoff-token.js.map +1 -0
  510. package/dist/esm/models/operations/create-sandbox-scenario.d.ts +18 -0
  511. package/dist/esm/models/operations/create-sandbox-scenario.d.ts.map +1 -0
  512. package/dist/esm/models/operations/create-sandbox-scenario.js +14 -0
  513. package/dist/esm/models/operations/create-sandbox-scenario.js.map +1 -0
  514. package/dist/esm/models/operations/delete-instance.d.ts +1 -14
  515. package/dist/esm/models/operations/delete-instance.d.ts.map +1 -1
  516. package/dist/esm/models/operations/delete-instance.js +2 -11
  517. package/dist/esm/models/operations/delete-instance.js.map +1 -1
  518. package/dist/esm/models/operations/delete-sandbox-scenario.d.ts +20 -0
  519. package/dist/esm/models/operations/delete-sandbox-scenario.d.ts.map +1 -0
  520. package/dist/esm/models/operations/delete-sandbox-scenario.js +13 -0
  521. package/dist/esm/models/operations/delete-sandbox-scenario.js.map +1 -0
  522. package/dist/esm/models/operations/device-connect.d.ts +0 -59
  523. package/dist/esm/models/operations/device-connect.d.ts.map +1 -1
  524. package/dist/esm/models/operations/device-connect.js +0 -46
  525. package/dist/esm/models/operations/device-connect.js.map +1 -1
  526. package/dist/esm/models/operations/device-validate.d.ts +12 -0
  527. package/dist/esm/models/operations/device-validate.d.ts.map +1 -0
  528. package/dist/esm/models/operations/device-validate.js +17 -0
  529. package/dist/esm/models/operations/device-validate.js.map +1 -0
  530. package/dist/esm/models/operations/fetch-interaction.d.ts +34 -1621
  531. package/dist/esm/models/operations/fetch-interaction.d.ts.map +1 -1
  532. package/dist/esm/models/operations/fetch-interaction.js +20 -1245
  533. package/dist/esm/models/operations/fetch-interaction.js.map +1 -1
  534. package/dist/esm/models/operations/get-journey-schemas.d.ts +16 -0
  535. package/dist/esm/models/operations/get-journey-schemas.d.ts.map +1 -0
  536. package/dist/esm/models/operations/get-journey-schemas.js +14 -0
  537. package/dist/esm/models/operations/get-journey-schemas.js.map +1 -0
  538. package/dist/esm/models/operations/get-journey-state.d.ts +16 -1383
  539. package/dist/esm/models/operations/get-journey-state.d.ts.map +1 -1
  540. package/dist/esm/models/operations/get-journey-state.js +12 -996
  541. package/dist/esm/models/operations/get-journey-state.js.map +1 -1
  542. package/dist/esm/models/operations/get-sandbox-scenario.d.ts +39 -0
  543. package/dist/esm/models/operations/get-sandbox-scenario.d.ts.map +1 -0
  544. package/dist/esm/models/operations/get-sandbox-scenario.js +23 -0
  545. package/dist/esm/models/operations/get-sandbox-scenario.js.map +1 -0
  546. package/dist/esm/models/operations/get-task-schema.d.ts +1 -17
  547. package/dist/esm/models/operations/get-task-schema.d.ts.map +1 -1
  548. package/dist/esm/models/operations/get-task-schema.js +0 -17
  549. package/dist/esm/models/operations/get-task-schema.js.map +1 -1
  550. package/dist/esm/models/operations/index.d.ts +12 -4
  551. package/dist/esm/models/operations/index.d.ts.map +1 -1
  552. package/dist/esm/models/operations/index.js +12 -4
  553. package/dist/esm/models/operations/index.js.map +1 -1
  554. package/dist/esm/models/operations/list-sandbox-scenarios.d.ts +34 -0
  555. package/dist/esm/models/operations/list-sandbox-scenarios.d.ts.map +1 -0
  556. package/dist/esm/models/operations/list-sandbox-scenarios.js +22 -0
  557. package/dist/esm/models/operations/list-sandbox-scenarios.js.map +1 -0
  558. package/dist/esm/models/operations/post-as-token-oauth2.d.ts +2 -2
  559. package/dist/esm/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  560. package/dist/esm/models/operations/post-as-token-oauth2.js +1 -1
  561. package/dist/esm/models/operations/post-as-token-oauth2.js.map +1 -1
  562. package/dist/esm/models/operations/put-sandbox-scenario.d.ts +23 -0
  563. package/dist/esm/models/operations/put-sandbox-scenario.d.ts.map +1 -0
  564. package/dist/esm/models/operations/put-sandbox-scenario.js +15 -0
  565. package/dist/esm/models/operations/put-sandbox-scenario.js.map +1 -0
  566. package/dist/esm/models/operations/retrieve-address.d.ts +29 -0
  567. package/dist/esm/models/operations/retrieve-address.d.ts.map +1 -0
  568. package/dist/esm/models/operations/retrieve-address.js +27 -0
  569. package/dist/esm/models/operations/retrieve-address.js.map +1 -0
  570. package/dist/esm/models/operations/search-addresses.d.ts +33 -0
  571. package/dist/esm/models/operations/search-addresses.d.ts.map +1 -0
  572. package/dist/esm/models/operations/search-addresses.js +29 -0
  573. package/dist/esm/models/operations/search-addresses.js.map +1 -0
  574. package/dist/esm/models/operations/start-journey.d.ts +1071 -108
  575. package/dist/esm/models/operations/start-journey.d.ts.map +1 -1
  576. package/dist/esm/models/operations/start-journey.js +473 -55
  577. package/dist/esm/models/operations/start-journey.js.map +1 -1
  578. package/dist/esm/models/operations/submit-interaction.d.ts +989 -92
  579. package/dist/esm/models/operations/submit-interaction.d.ts.map +1 -1
  580. package/dist/esm/models/operations/submit-interaction.js +436 -44
  581. package/dist/esm/models/operations/submit-interaction.js.map +1 -1
  582. package/dist/esm/models/operations/terminate-journey.d.ts +19 -0
  583. package/dist/esm/models/operations/terminate-journey.d.ts.map +1 -0
  584. package/dist/esm/models/operations/terminate-journey.js +13 -0
  585. package/dist/esm/models/operations/terminate-journey.js.map +1 -0
  586. package/dist/esm/models/operations/upload-interaction-asset.d.ts +26 -0
  587. package/dist/esm/models/operations/upload-interaction-asset.d.ts.map +1 -0
  588. package/dist/esm/models/operations/upload-interaction-asset.js +29 -0
  589. package/dist/esm/models/operations/upload-interaction-asset.js.map +1 -0
  590. package/dist/esm/models/sandbox-scenario-summary.d.ts +29 -0
  591. package/dist/esm/models/sandbox-scenario-summary.d.ts.map +1 -0
  592. package/dist/esm/models/sandbox-scenario-summary.js +26 -0
  593. package/dist/esm/models/sandbox-scenario-summary.js.map +1 -0
  594. package/dist/esm/models/sandbox-scenario-written.d.ts +19 -0
  595. package/dist/esm/models/sandbox-scenario-written.d.ts.map +1 -0
  596. package/dist/esm/models/sandbox-scenario-written.js +21 -0
  597. package/dist/esm/models/sandbox-scenario-written.js.map +1 -0
  598. package/dist/esm/models/sandbox-scenario.d.ts +31 -0
  599. package/dist/esm/models/sandbox-scenario.d.ts.map +1 -0
  600. package/dist/esm/models/sandbox-scenario.js +26 -0
  601. package/dist/esm/models/sandbox-scenario.js.map +1 -0
  602. package/dist/esm/models/schema-fetch-response.d.ts +22 -0
  603. package/dist/esm/models/schema-fetch-response.d.ts.map +1 -0
  604. package/dist/esm/models/schema-fetch-response.js +25 -0
  605. package/dist/esm/models/schema-fetch-response.js.map +1 -0
  606. package/dist/esm/models/slim-document.d.ts +57 -0
  607. package/dist/esm/models/slim-document.d.ts.map +1 -0
  608. package/dist/esm/models/slim-document.js +54 -0
  609. package/dist/esm/models/slim-document.js.map +1 -0
  610. package/dist/esm/models/slim-extraction.d.ts +74 -0
  611. package/dist/esm/models/slim-extraction.d.ts.map +1 -0
  612. package/dist/esm/models/slim-extraction.js +85 -0
  613. package/dist/esm/models/slim-extraction.js.map +1 -0
  614. package/dist/esm/models/slim-identity.d.ts +202 -0
  615. package/dist/esm/models/slim-identity.d.ts.map +1 -0
  616. package/dist/esm/models/slim-identity.js +101 -0
  617. package/dist/esm/models/slim-identity.js.map +1 -0
  618. package/dist/esm/models/slim-interaction-fetch-response.d.ts +58 -0
  619. package/dist/esm/models/slim-interaction-fetch-response.d.ts.map +1 -0
  620. package/dist/esm/models/slim-interaction-fetch-response.js +62 -0
  621. package/dist/esm/models/slim-interaction-fetch-response.js.map +1 -0
  622. package/dist/esm/models/slim-journey.d.ts +14 -0
  623. package/dist/esm/models/slim-journey.d.ts.map +1 -0
  624. package/dist/esm/models/slim-journey.js +19 -0
  625. package/dist/esm/models/slim-journey.js.map +1 -0
  626. package/dist/esm/models/slim-result.d.ts +46 -0
  627. package/dist/esm/models/slim-result.d.ts.map +1 -0
  628. package/dist/esm/models/slim-result.js +40 -0
  629. package/dist/esm/models/slim-result.js.map +1 -0
  630. package/dist/esm/models/slim-state-fetch-response.d.ts +26 -0
  631. package/dist/esm/models/slim-state-fetch-response.d.ts.map +1 -0
  632. package/dist/esm/models/slim-state-fetch-response.js +29 -0
  633. package/dist/esm/models/slim-state-fetch-response.js.map +1 -0
  634. package/dist/esm/models/slim-step.d.ts +22 -0
  635. package/dist/esm/models/slim-step.d.ts.map +1 -0
  636. package/dist/esm/models/slim-step.js +26 -0
  637. package/dist/esm/models/slim-step.js.map +1 -0
  638. package/dist/esm/models/slim-validation.d.ts +69 -0
  639. package/dist/esm/models/slim-validation.d.ts.map +1 -0
  640. package/dist/esm/models/slim-validation.js +79 -0
  641. package/dist/esm/models/slim-validation.js.map +1 -0
  642. package/dist/esm/models/slim-verified-data.d.ts +16 -0
  643. package/dist/esm/models/slim-verified-data.d.ts.map +1 -0
  644. package/dist/esm/models/slim-verified-data.js +17 -0
  645. package/dist/esm/models/slim-verified-data.js.map +1 -0
  646. package/dist/esm/models/state-fetch-response.d.ts +17 -0
  647. package/dist/esm/models/state-fetch-response.d.ts.map +1 -0
  648. package/dist/esm/models/state-fetch-response.js +17 -0
  649. package/dist/esm/models/state-fetch-response.js.map +1 -0
  650. package/dist/esm/models/terminate-response.d.ts +10 -0
  651. package/dist/esm/models/terminate-response.d.ts.map +1 -0
  652. package/dist/esm/models/terminate-response.js +14 -0
  653. package/dist/esm/models/terminate-response.js.map +1 -0
  654. package/dist/esm/models/update-sandbox-scenario-request.d.ts +24 -0
  655. package/dist/esm/models/update-sandbox-scenario-request.d.ts.map +1 -0
  656. package/dist/esm/models/update-sandbox-scenario-request.js +17 -0
  657. package/dist/esm/models/update-sandbox-scenario-request.js.map +1 -0
  658. package/dist/esm/sdk/addresses.d.ts +20 -0
  659. package/dist/esm/sdk/addresses.d.ts.map +1 -0
  660. package/dist/esm/sdk/addresses.js +28 -0
  661. package/dist/esm/sdk/addresses.js.map +1 -0
  662. package/dist/esm/sdk/devices.d.ts +21 -6
  663. package/dist/esm/sdk/devices.d.ts.map +1 -1
  664. package/dist/esm/sdk/devices.js +26 -6
  665. package/dist/esm/sdk/devices.js.map +1 -1
  666. package/dist/esm/sdk/instances.d.ts +11 -3
  667. package/dist/esm/sdk/instances.d.ts.map +1 -1
  668. package/dist/esm/sdk/instances.js +12 -2
  669. package/dist/esm/sdk/instances.js.map +1 -1
  670. package/dist/esm/sdk/interactions.d.ts +14 -6
  671. package/dist/esm/sdk/interactions.d.ts.map +1 -1
  672. package/dist/esm/sdk/interactions.js +16 -6
  673. package/dist/esm/sdk/interactions.js.map +1 -1
  674. package/dist/esm/sdk/journeys.d.ts +45 -5
  675. package/dist/esm/sdk/journeys.d.ts.map +1 -1
  676. package/dist/esm/sdk/journeys.js +49 -4
  677. package/dist/esm/sdk/journeys.js.map +1 -1
  678. package/dist/esm/sdk/sandbox.d.ts +41 -0
  679. package/dist/esm/sdk/sandbox.d.ts.map +1 -0
  680. package/dist/esm/sdk/sandbox.js +58 -0
  681. package/dist/esm/sdk/sandbox.js.map +1 -0
  682. package/dist/esm/sdk/sdk.d.ts +14 -11
  683. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  684. package/dist/esm/sdk/sdk.js +17 -13
  685. package/dist/esm/sdk/sdk.js.map +1 -1
  686. package/dist/esm/sdk/tasks.d.ts +6 -23
  687. package/dist/esm/sdk/tasks.d.ts.map +1 -1
  688. package/dist/esm/sdk/tasks.js +3 -31
  689. package/dist/esm/sdk/tasks.js.map +1 -1
  690. package/dist/esm/types/smart-union.d.ts.map +1 -1
  691. package/dist/esm/types/smart-union.js +14 -10
  692. package/dist/esm/types/smart-union.js.map +1 -1
  693. package/examples/{tokensGenerate.example.ts → journeysStart.example.ts} +5 -3
  694. package/jsr.json +1 -1
  695. package/package.json +1 -1
  696. package/src/funcs/{tasks-update.ts → addresses-retrieve.ts} +39 -18
  697. package/src/funcs/addresses-search.ts +196 -0
  698. package/src/funcs/devices-add.ts +21 -11
  699. package/src/funcs/devices-connect.ts +25 -21
  700. package/src/funcs/{health-get.ts → devices-refresh.ts} +26 -22
  701. package/src/funcs/{tasks-list.ts → devices-validate.ts} +26 -37
  702. package/src/funcs/instances-delete.ts +21 -10
  703. package/src/funcs/instances-handoff-token.ts +191 -0
  704. package/src/funcs/interactions-fetch.ts +30 -10
  705. package/src/funcs/interactions-submit.ts +28 -10
  706. package/src/funcs/interactions-upload-asset.ts +173 -0
  707. package/src/funcs/journeys-get-schemas.ts +207 -0
  708. package/src/funcs/journeys-get-state.ts +23 -10
  709. package/src/funcs/journeys-start.ts +21 -11
  710. package/src/funcs/{tasks-list-schema.ts → journeys-terminate.ts} +26 -15
  711. package/src/funcs/sandbox-create-scenario.ts +185 -0
  712. package/src/funcs/sandbox-delete-scenario.ts +187 -0
  713. package/src/funcs/sandbox-get-scenario.ts +193 -0
  714. package/src/funcs/sandbox-list-scenarios.ts +189 -0
  715. package/src/funcs/sandbox-put-scenario.ts +189 -0
  716. package/src/funcs/tasks-get-schema.ts +22 -10
  717. package/src/funcs/tokens-generate.ts +1 -1
  718. package/src/lib/config.ts +16 -7
  719. package/src/models/create-sandbox-scenario-request.ts +65 -0
  720. package/src/models/delete-response.ts +46 -0
  721. package/src/models/device-connect-response.ts +56 -0
  722. package/src/models/device-refresh-response.ts +43 -0
  723. package/src/models/device-start-response.ts +50 -0
  724. package/src/models/device-validate-response.ts +39 -0
  725. package/src/models/errors/error-response.ts +52 -0
  726. package/src/models/errors/index.ts +1 -0
  727. package/src/models/gbg-error.ts +55 -0
  728. package/src/models/handoff-token-response.ts +49 -0
  729. package/src/models/index.ts +30 -0
  730. package/src/models/interaction-fetch-response.ts +147 -0
  731. package/src/models/interaction-submit-response.ts +43 -0
  732. package/src/models/journey-start-response.ts +64 -0
  733. package/src/models/loqate-retrieve-response.ts +38 -0
  734. package/src/models/loqate-search-response.ts +38 -0
  735. package/src/models/operations/add-device.ts +17 -176
  736. package/src/models/operations/create-handoff-token.ts +63 -0
  737. package/src/models/operations/create-sandbox-scenario.ts +39 -0
  738. package/src/models/operations/delete-instance.ts +7 -38
  739. package/src/models/operations/delete-sandbox-scenario.ts +41 -0
  740. package/src/models/operations/device-connect.ts +0 -128
  741. package/src/models/operations/device-validate.ts +38 -0
  742. package/src/models/operations/fetch-interaction.ts +95 -3795
  743. package/src/models/operations/get-journey-schemas.ts +36 -0
  744. package/src/models/operations/get-journey-state.ts +57 -3183
  745. package/src/models/operations/get-sandbox-scenario.ts +65 -0
  746. package/src/models/operations/get-task-schema.ts +1 -44
  747. package/src/models/operations/index.ts +12 -4
  748. package/src/models/operations/list-sandbox-scenarios.ts +63 -0
  749. package/src/models/operations/post-as-token-oauth2.ts +5 -5
  750. package/src/models/operations/put-sandbox-scenario.ts +43 -0
  751. package/src/models/operations/retrieve-address.ts +73 -0
  752. package/src/models/operations/search-addresses.ts +79 -0
  753. package/src/models/operations/start-journey.ts +2624 -1052
  754. package/src/models/operations/submit-interaction.ts +2648 -1114
  755. package/src/models/operations/terminate-journey.ts +41 -0
  756. package/src/models/operations/upload-interaction-asset.ts +75 -0
  757. package/src/models/sandbox-scenario-summary.ts +63 -0
  758. package/src/models/sandbox-scenario-written.ts +48 -0
  759. package/src/models/sandbox-scenario.ts +61 -0
  760. package/src/models/schema-fetch-response.ts +58 -0
  761. package/src/models/slim-document.ts +135 -0
  762. package/src/models/slim-extraction.ts +236 -0
  763. package/src/models/slim-identity.ts +348 -0
  764. package/src/models/slim-interaction-fetch-response.ts +169 -0
  765. package/src/models/slim-journey.ts +37 -0
  766. package/src/models/slim-result.ts +87 -0
  767. package/src/models/slim-state-fetch-response.ts +59 -0
  768. package/src/models/slim-step.ts +54 -0
  769. package/src/models/slim-validation.ts +230 -0
  770. package/src/models/slim-verified-data.ts +38 -0
  771. package/src/models/state-fetch-response.ts +37 -0
  772. package/src/models/terminate-response.ts +31 -0
  773. package/src/models/update-sandbox-scenario-request.ts +59 -0
  774. package/src/sdk/addresses.ts +50 -0
  775. package/src/sdk/devices.ts +46 -11
  776. package/src/sdk/instances.ts +24 -3
  777. package/src/sdk/interactions.ts +30 -11
  778. package/src/sdk/journeys.ts +67 -5
  779. package/src/sdk/sandbox.ts +100 -0
  780. package/src/sdk/sdk.ts +25 -19
  781. package/src/sdk/tasks.ts +4 -60
  782. package/src/types/smart-union.ts +18 -10
  783. package/dist/commonjs/funcs/health-get.d.ts.map +0 -1
  784. package/dist/commonjs/funcs/health-get.js.map +0 -1
  785. package/dist/commonjs/funcs/tasks-list-schema.d.ts.map +0 -1
  786. package/dist/commonjs/funcs/tasks-list-schema.js.map +0 -1
  787. package/dist/commonjs/funcs/tasks-list.d.ts.map +0 -1
  788. package/dist/commonjs/funcs/tasks-list.js.map +0 -1
  789. package/dist/commonjs/funcs/tasks-update.d.ts.map +0 -1
  790. package/dist/commonjs/funcs/tasks-update.js.map +0 -1
  791. package/dist/commonjs/models/operations/get-tasks-schema.d.ts +0 -71
  792. package/dist/commonjs/models/operations/get-tasks-schema.d.ts.map +0 -1
  793. package/dist/commonjs/models/operations/get-tasks-schema.js +0 -108
  794. package/dist/commonjs/models/operations/get-tasks-schema.js.map +0 -1
  795. package/dist/commonjs/models/operations/get-tasks.d.ts +0 -62
  796. package/dist/commonjs/models/operations/get-tasks.d.ts.map +0 -1
  797. package/dist/commonjs/models/operations/get-tasks.js +0 -91
  798. package/dist/commonjs/models/operations/get-tasks.js.map +0 -1
  799. package/dist/commonjs/models/operations/health.d.ts +0 -14
  800. package/dist/commonjs/models/operations/health.d.ts.map +0 -1
  801. package/dist/commonjs/models/operations/health.js.map +0 -1
  802. package/dist/commonjs/models/operations/update-task.d.ts +0 -2105
  803. package/dist/commonjs/models/operations/update-task.d.ts.map +0 -1
  804. package/dist/commonjs/models/operations/update-task.js +0 -1115
  805. package/dist/commonjs/models/operations/update-task.js.map +0 -1
  806. package/dist/commonjs/sdk/health.d.ts +0 -12
  807. package/dist/commonjs/sdk/health.d.ts.map +0 -1
  808. package/dist/commonjs/sdk/health.js +0 -22
  809. package/dist/commonjs/sdk/health.js.map +0 -1
  810. package/dist/commonjs/types/discriminated-union.d.ts +0 -25
  811. package/dist/commonjs/types/discriminated-union.d.ts.map +0 -1
  812. package/dist/commonjs/types/discriminated-union.js +0 -98
  813. package/dist/commonjs/types/discriminated-union.js.map +0 -1
  814. package/dist/esm/funcs/health-get.d.ts.map +0 -1
  815. package/dist/esm/funcs/health-get.js.map +0 -1
  816. package/dist/esm/funcs/tasks-list-schema.d.ts.map +0 -1
  817. package/dist/esm/funcs/tasks-list-schema.js.map +0 -1
  818. package/dist/esm/funcs/tasks-list.d.ts +0 -17
  819. package/dist/esm/funcs/tasks-list.d.ts.map +0 -1
  820. package/dist/esm/funcs/tasks-list.js.map +0 -1
  821. package/dist/esm/funcs/tasks-update.d.ts +0 -17
  822. package/dist/esm/funcs/tasks-update.d.ts.map +0 -1
  823. package/dist/esm/funcs/tasks-update.js.map +0 -1
  824. package/dist/esm/models/operations/get-tasks-schema.d.ts +0 -71
  825. package/dist/esm/models/operations/get-tasks-schema.d.ts.map +0 -1
  826. package/dist/esm/models/operations/get-tasks-schema.js +0 -67
  827. package/dist/esm/models/operations/get-tasks-schema.js.map +0 -1
  828. package/dist/esm/models/operations/get-tasks.d.ts +0 -62
  829. package/dist/esm/models/operations/get-tasks.d.ts.map +0 -1
  830. package/dist/esm/models/operations/get-tasks.js +0 -51
  831. package/dist/esm/models/operations/get-tasks.js.map +0 -1
  832. package/dist/esm/models/operations/health.d.ts +0 -14
  833. package/dist/esm/models/operations/health.d.ts.map +0 -1
  834. package/dist/esm/models/operations/health.js +0 -14
  835. package/dist/esm/models/operations/health.js.map +0 -1
  836. package/dist/esm/models/operations/update-task.d.ts +0 -2105
  837. package/dist/esm/models/operations/update-task.d.ts.map +0 -1
  838. package/dist/esm/models/operations/update-task.js +0 -1007
  839. package/dist/esm/models/operations/update-task.js.map +0 -1
  840. package/dist/esm/sdk/health.d.ts +0 -12
  841. package/dist/esm/sdk/health.d.ts.map +0 -1
  842. package/dist/esm/sdk/health.js +0 -18
  843. package/dist/esm/sdk/health.js.map +0 -1
  844. package/dist/esm/types/discriminated-union.d.ts +0 -25
  845. package/dist/esm/types/discriminated-union.d.ts.map +0 -1
  846. package/dist/esm/types/discriminated-union.js +0 -61
  847. package/dist/esm/types/discriminated-union.js.map +0 -1
  848. package/src/models/operations/get-tasks-schema.ts +0 -173
  849. package/src/models/operations/get-tasks.ts +0 -144
  850. package/src/models/operations/health.ts +0 -38
  851. package/src/models/operations/update-task.ts +0 -3818
  852. package/src/sdk/health.ts +0 -25
  853. package/src/types/discriminated-union.ts +0 -101
@@ -4,3202 +4,79 @@
4
4
 
5
5
  import * as z from "zod/v4-mini";
6
6
  import { safeParse } from "../../lib/schemas.js";
7
- import * as openEnums from "../../types/enums.js";
8
- import { OpenEnum } from "../../types/enums.js";
9
7
  import { Result as SafeParseResult } from "../../types/fp.js";
10
- import * as types from "../../types/primitives.js";
11
8
  import { smartUnion } from "../../types/smart-union.js";
12
9
  import { SDKValidationError } from "../errors/sdk-validation-error.js";
10
+ import * as models from "../index.js";
13
11
 
14
- export type GetJourneyStateRequest = {
15
- /**
16
- * Journey Instance Id, a unique identifier for a started journey instance.
17
- */
18
- instanceId: string;
19
- filterKeys?: Array<string> | undefined;
20
- };
21
-
22
- export const GetJourneyStateStatus = {
23
- Completed: "Completed",
24
- InProgress: "InProgress",
25
- Failed: "Failed",
26
- Paused: "Paused",
27
- } as const;
28
- export type GetJourneyStateStatus = OpenEnum<typeof GetJourneyStateStatus>;
29
-
30
- export type MetaData = {
31
- createdTime?: string | undefined;
32
- completedTime?: string | undefined;
33
- [additionalProperties: string]: unknown;
34
- };
35
-
36
- export type GetJourneyStateIdentityAlias = {
37
- /**
38
- * Title of an individual such as Mr, Mrs, Dr, Sir
39
- */
40
- title?: string | undefined;
41
- /**
42
- * A person's name used by their collegues and friends to address them
43
- */
44
- firstName?: string | undefined;
45
- /**
46
- * Any other registered names used by the individual, not aliases
47
- */
48
- middleNames?: Array<string> | undefined;
49
- /**
50
- * Any family names for the individual
51
- */
52
- lastNames?: Array<string> | undefined;
53
- /**
54
- * Any family names for the individual
55
- */
56
- lastNamesAtBirth?: Array<string> | undefined;
57
- };
58
-
59
- export const GetJourneyStateIdentityRelationship = {
60
- Mother: "mother",
61
- Father: "father",
62
- MaternalGrandFather: "maternalGrandFather",
63
- MaternalGrandMother: "maternalGrandMother",
64
- PaternalGrandFather: "paternalGrandFather",
65
- PaternalGrandMother: "paternalGrandMother",
66
- } as const;
67
- export type GetJourneyStateIdentityRelationship = OpenEnum<
68
- typeof GetJourneyStateIdentityRelationship
69
- >;
70
-
71
- export type GetJourneyStateIdentityRelatedPerson = {
72
- /**
73
- * Title of an individual such as Mr, Mrs, Dr, Sir
74
- */
75
- title?: string | undefined;
76
- /**
77
- * A person's name used by their collegues and friends to address them
78
- */
79
- firstName?: string | undefined;
80
- /**
81
- * Any other registered names used by the individual, not aliases
82
- */
83
- middleNames?: Array<string> | undefined;
84
- /**
85
- * Any family names for the individual
86
- */
87
- lastNames?: Array<string> | undefined;
88
- /**
89
- * Any family names for the individual
90
- */
91
- lastNamesAtBirth?: Array<string> | undefined;
92
- relationship: GetJourneyStateIdentityRelationship;
93
- };
94
-
95
- export type GetJourneyStateIdentityCurrentAddressLocation = {
96
- latitude?: string | undefined;
97
- longitude?: string | undefined;
98
- geoAccuracy?: string | undefined;
99
- /**
100
- * A What3words designation associated with this location with '.' separator.
101
- */
102
- what3words?: string | undefined;
103
- };
104
-
105
- export type GetJourneyStateIdentityCurrentAddress = {
106
- /**
107
- * Unformatted line based address
108
- */
109
- lines?: Array<string> | undefined;
110
- /**
111
- * The address as a single line
112
- */
113
- addressString?: string | undefined;
114
- /**
115
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
116
- */
117
- premise?: string | undefined;
118
- /**
119
- * The name of a building or a building complex. In the US, this is the street number.
120
- */
121
- building?: string | undefined;
122
- /**
123
- * The name of a sub-building, such as a flat or apartment number.
124
- */
125
- subBuilding?: string | undefined;
126
- /**
127
- * This field holds the most common street or block data element within a country. For instance, USA Street
128
- */
129
- thoroughfare?: string | undefined;
130
- /**
131
- * The name of a dependent street or block, such as a street within a complex.
132
- */
133
- dependentThoroughfare?: string | undefined;
134
- /**
135
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
136
- */
137
- locality?: string | undefined;
138
- /**
139
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
140
- */
141
- dependentLocality?: string | undefined;
142
- /**
143
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
144
- */
145
- doubleDependentLocality?: string | undefined;
146
- /**
147
- * 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
148
- */
149
- postalCode?: string | undefined;
150
- /**
151
- * This field contains the post box number associated with a particular delivery point, should one exist.
152
- */
153
- postBox?: string | undefined;
154
- /**
155
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
156
- */
157
- country?: string | undefined;
158
- superAdministrativeArea?: string | undefined;
159
- administrativeArea?: string | undefined;
160
- subAdministrativeArea?: string | undefined;
161
- organization?: string | undefined;
162
- location?: GetJourneyStateIdentityCurrentAddressLocation | undefined;
163
- };
164
-
165
- export type GetJourneyStateIdentityPreviousAddressLocation = {
166
- latitude?: string | undefined;
167
- longitude?: string | undefined;
168
- geoAccuracy?: string | undefined;
169
- /**
170
- * A What3words designation associated with this location with '.' separator.
171
- */
172
- what3words?: string | undefined;
173
- };
174
-
175
- export type GetJourneyStateIdentityPreviousAddress = {
176
- /**
177
- * Unformatted line based address
178
- */
179
- lines?: Array<string> | undefined;
180
- /**
181
- * The address as a single line
182
- */
183
- addressString?: string | undefined;
184
- /**
185
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
186
- */
187
- premise?: string | undefined;
188
- /**
189
- * The name of a building or a building complex. In the US, this is the street number.
190
- */
191
- building?: string | undefined;
192
- /**
193
- * The name of a sub-building, such as a flat or apartment number.
194
- */
195
- subBuilding?: string | undefined;
196
- /**
197
- * This field holds the most common street or block data element within a country. For instance, USA Street
198
- */
199
- thoroughfare?: string | undefined;
200
- /**
201
- * The name of a dependent street or block, such as a street within a complex.
202
- */
203
- dependentThoroughfare?: string | undefined;
204
- /**
205
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
206
- */
207
- locality?: string | undefined;
208
- /**
209
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
210
- */
211
- dependentLocality?: string | undefined;
212
- /**
213
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
214
- */
215
- doubleDependentLocality?: string | undefined;
216
- /**
217
- * 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
218
- */
219
- postalCode?: string | undefined;
220
- /**
221
- * This field contains the post box number associated with a particular delivery point, should one exist.
222
- */
223
- postBox?: string | undefined;
224
- /**
225
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
226
- */
227
- country?: string | undefined;
228
- superAdministrativeArea?: string | undefined;
229
- administrativeArea?: string | undefined;
230
- subAdministrativeArea?: string | undefined;
231
- organization?: string | undefined;
232
- location?: GetJourneyStateIdentityPreviousAddressLocation | undefined;
233
- /**
234
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
235
- */
236
- fromDate: string;
237
- /**
238
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
239
- */
240
- toDate: string;
241
- };
242
-
243
- export type GetJourneyStateIdentityPlaceOfBirthLocation = {
244
- latitude?: string | undefined;
245
- longitude?: string | undefined;
246
- geoAccuracy?: string | undefined;
247
- /**
248
- * A What3words designation associated with this location with '.' separator.
249
- */
250
- what3words?: string | undefined;
251
- };
252
-
253
- export type GetJourneyStateIdentityPlaceOfBirth = {
254
- /**
255
- * Unformatted line based address
256
- */
257
- lines?: Array<string> | undefined;
258
- /**
259
- * The address as a single line
260
- */
261
- addressString?: string | undefined;
262
- /**
263
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
264
- */
265
- premise?: string | undefined;
266
- /**
267
- * The name of a building or a building complex. In the US, this is the street number.
268
- */
269
- building?: string | undefined;
270
- /**
271
- * The name of a sub-building, such as a flat or apartment number.
272
- */
273
- subBuilding?: string | undefined;
274
- /**
275
- * This field holds the most common street or block data element within a country. For instance, USA Street
276
- */
277
- thoroughfare?: string | undefined;
278
- /**
279
- * The name of a dependent street or block, such as a street within a complex.
280
- */
281
- dependentThoroughfare?: string | undefined;
282
- /**
283
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
284
- */
285
- locality?: string | undefined;
286
- /**
287
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
288
- */
289
- dependentLocality?: string | undefined;
290
- /**
291
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
292
- */
293
- doubleDependentLocality?: string | undefined;
294
- /**
295
- * 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
296
- */
297
- postalCode?: string | undefined;
298
- /**
299
- * This field contains the post box number associated with a particular delivery point, should one exist.
300
- */
301
- postBox?: string | undefined;
302
- /**
303
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
304
- */
305
- country?: string | undefined;
306
- superAdministrativeArea?: string | undefined;
307
- administrativeArea?: string | undefined;
308
- subAdministrativeArea?: string | undefined;
309
- organization?: string | undefined;
310
- location?: GetJourneyStateIdentityPlaceOfBirthLocation | undefined;
311
- };
312
-
313
- export type GetJourneyStateIdentityIdNumber = {
314
- /**
315
- * The type of phone number, such as landline, mobile, fax, unknown etc
316
- */
317
- type: string;
318
- /**
319
- * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
320
- */
321
- idNumber: string;
322
- /**
323
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
324
- */
325
- country?: string | undefined;
326
- };
327
-
328
- export type GetJourneyStateIdentityPhone = {
329
- /**
330
- * The type of phone number, such as landline, mobile, fax, unknown etc
331
- */
332
- type: string;
333
- /**
334
- * Phone number, ideally in international format with +(Country Code)
335
- */
336
- number: string;
337
- };
338
-
339
- export type GetJourneyStateIdentityEmail = {
340
- /**
341
- * The type of email, such as home, work, unknown etc
342
- */
343
- type: string;
344
- /**
345
- * Email address
346
- */
347
- email: string;
348
- };
349
-
350
- export type GetJourneyStateIdentitySocial = {
351
- /**
352
- * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
353
- */
354
- type: string;
355
- /**
356
- * the identity used on this platform
357
- */
358
- identity: string;
359
- };
360
-
361
- export type GetJourneyStateIdentity = {
362
- /**
363
- * Title of an individual such as Mr, Mrs, Dr, Sir
364
- */
365
- title?: string | undefined;
366
- /**
367
- * A person's name used by their collegues and friends to address them
368
- */
369
- firstName?: string | undefined;
370
- /**
371
- * Any other registered names used by the individual, not aliases
372
- */
373
- middleNames?: Array<string> | undefined;
374
- /**
375
- * Any family names for the individual
376
- */
377
- lastNames?: Array<string> | undefined;
378
- /**
379
- * Any family names for the individual
380
- */
381
- lastNamesAtBirth?: Array<string> | undefined;
382
- aliases?: Array<GetJourneyStateIdentityAlias> | undefined;
383
- relatedPersons?: Array<GetJourneyStateIdentityRelatedPerson> | undefined;
384
- /**
385
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
386
- */
387
- dateOfBirth?: string | undefined;
388
- gender?: string | undefined;
389
- currentAddress?: GetJourneyStateIdentityCurrentAddress | undefined;
390
- previousAddresses?: Array<GetJourneyStateIdentityPreviousAddress> | undefined;
391
- placeOfBirth?: GetJourneyStateIdentityPlaceOfBirth | undefined;
392
- idNumbers?: Array<GetJourneyStateIdentityIdNumber> | undefined;
393
- phones?: Array<GetJourneyStateIdentityPhone> | undefined;
394
- emails?: Array<GetJourneyStateIdentityEmail> | undefined;
395
- socials?: Array<GetJourneyStateIdentitySocial> | undefined;
396
- /**
397
- * The subject's mother's maiden name, used for identity verification
398
- */
399
- mothersMaidenName?: string | undefined;
400
- };
401
-
402
- export type GetJourneyStateAddress = {
403
- addressString?: string | undefined;
404
- extractedAddressString?: string | undefined;
405
- addressLine1?: string | undefined;
406
- addressLine2?: string | undefined;
407
- locality?: string | undefined;
408
- administrativeArea?: string | undefined;
409
- postalCode?: string | undefined;
410
- };
411
-
412
- export type GetJourneyStateDocumentDevice = {
413
- type?: string | undefined;
414
- model?: string | undefined;
415
- hasContactlessReader?: boolean | undefined;
416
- hasMagneticStripeReader?: boolean | undefined;
417
- hasCamera?: boolean | undefined;
418
- serialNumber?: string | undefined;
419
- manufacturer?: string | undefined;
420
- };
421
-
422
- export const GetJourneyStateName = {
423
- Com: "COM",
424
- Sod: "SOD",
425
- Dg1: "DG1",
426
- Dg2: "DG2",
427
- Dg3: "DG3",
428
- Dg4: "DG4",
429
- Dg5: "DG5",
430
- Dg6: "DG6",
431
- Dg7: "DG7",
432
- Dg8: "DG8",
433
- Dg9: "DG9",
434
- Dg10: "DG10",
435
- Dg11: "DG11",
436
- Dg12: "DG12",
437
- Dg13: "DG13",
438
- Dg14: "DG14",
439
- Dg15: "DG15",
440
- } as const;
441
- export type GetJourneyStateName = OpenEnum<typeof GetJourneyStateName>;
442
-
443
- export type GetJourneyStateLd = {
444
- name: GetJourneyStateName;
445
- data: string;
446
- [additionalProperties: string]: unknown;
447
- };
448
-
449
- export const GetJourneyStateAuthType = {
450
- ActiveAuthentication: "ActiveAuthentication",
451
- BasicAccessControl: "BasicAccessControl",
452
- ChipAuthentication: "ChipAuthentication",
453
- PassiveAuthentication: "PassiveAuthentication",
454
- SupplementalAccessControl: "SupplementalAccessControl",
455
- ExtendedAccessControl: "ExtendedAccessControl",
456
- TerminalAuthentication: "TerminalAuthentication",
457
- } as const;
458
- export type GetJourneyStateAuthType = OpenEnum<typeof GetJourneyStateAuthType>;
459
-
460
- export const GetJourneyStateResult = {
461
- Success: "Success",
462
- Failure: "Failure",
463
- Skipped: "Skipped",
464
- } as const;
465
- export type GetJourneyStateResult = OpenEnum<typeof GetJourneyStateResult>;
466
-
467
- export type GetJourneyStateChipAuth = {
468
- type: GetJourneyStateAuthType;
469
- result: GetJourneyStateResult;
470
- [additionalProperties: string]: unknown;
471
- };
472
-
473
- export type GetJourneyStateChip = {
474
- lds: Array<GetJourneyStateLd>;
475
- auth: Array<GetJourneyStateChipAuth>;
476
- [additionalProperties: string]: unknown;
477
- };
478
-
479
- export type GetJourneyStateSide = {
480
- side: string;
481
- id: string;
482
- documentQuality: string;
483
- documentQualityScore: number;
484
- };
485
-
486
- export type GetJourneyStateClassification = {
487
- ids?: Array<string> | undefined;
488
- category?: string | undefined;
489
- type?: string | undefined;
490
- subtype?: string | undefined;
491
- isDoubleSided?: boolean | undefined;
492
- hasNFC?: boolean | undefined;
493
- year?: string | undefined;
494
- countryCode?: string | undefined;
495
- countryName?: string | undefined;
496
- stateCode?: string | undefined;
497
- stateName?: string | undefined;
498
- sides?: Array<GetJourneyStateSide> | undefined;
499
- };
500
-
501
- export type GetJourneyStateAggregatedFieldBoundingBox = {
502
- x: number;
503
- y: number;
504
- width: number;
505
- height: number;
506
- };
507
-
508
- export type GetJourneyStateAggregatedFieldRegionOfInterest = {
509
- boundingBox?: GetJourneyStateAggregatedFieldBoundingBox | undefined;
510
- side: string;
511
- spectrum?: string | undefined;
512
- imageId?: string | undefined;
513
- };
514
-
515
- export type GetJourneyStateAggregatedField = {
516
- label: string;
517
- value: string;
518
- source: string;
519
- isNonLatin: boolean;
520
- regionOfInterest?: GetJourneyStateAggregatedFieldRegionOfInterest | undefined;
521
- };
522
-
523
- export type GetJourneyStateDetailBoundingBox = {
524
- x: number;
525
- y: number;
526
- width: number;
527
- height: number;
528
- };
529
-
530
- export type GetJourneyStateDetailRegionOfInterest = {
531
- boundingBox?: GetJourneyStateDetailBoundingBox | undefined;
532
- side: string;
533
- spectrum?: string | undefined;
534
- imageId?: string | undefined;
535
- };
536
-
537
- export type GetJourneyStateDetail = {
538
- label: string;
539
- value: string;
540
- source: string;
541
- isNonLatin: boolean;
542
- regionOfInterest?: GetJourneyStateDetailRegionOfInterest | undefined;
543
- };
544
-
545
- export type GetJourneyStateExtractedField = {
546
- label: string;
547
- details: Array<GetJourneyStateDetail>;
548
- };
549
-
550
- export type GetJourneyStateExtractedImage = {
551
- label: string;
552
- side: string;
553
- imageID: string;
554
- };
555
-
556
- export type GetJourneyStateExtraction = {
557
- aggregatedFields?: Array<GetJourneyStateAggregatedField> | undefined;
558
- extractedFields?: Array<GetJourneyStateExtractedField> | undefined;
559
- extractedImages?: Array<GetJourneyStateExtractedImage> | undefined;
560
- };
561
-
562
- export type GetJourneyStateValidationCheckBoundingBox = {
563
- x: number;
564
- y: number;
565
- width: number;
566
- height: number;
567
- };
568
-
569
- export type GetJourneyStateValidationCheckRegionOfInterest = {
570
- boundingBox?: GetJourneyStateValidationCheckBoundingBox | undefined;
571
- side: string;
572
- spectrum?: string | undefined;
573
- imageId?: string | undefined;
574
- };
575
-
576
- export type GetJourneyStateValidationCheck = {
577
- name: string;
578
- title: string;
579
- info: string;
580
- validationResult: string;
581
- resultInfo: string;
582
- weight: string;
583
- regionOfInterests?:
584
- | Array<GetJourneyStateValidationCheckRegionOfInterest>
585
- | undefined;
586
- type: string;
587
- };
588
-
589
- export type GetJourneyStateAggregatedValidationCheckBoundingBox = {
590
- x: number;
591
- y: number;
592
- width: number;
593
- height: number;
594
- };
595
-
596
- export type GetJourneyStateAggregatedValidationCheckRegionOfInterest = {
597
- boundingBox?: GetJourneyStateAggregatedValidationCheckBoundingBox | undefined;
598
- side: string;
599
- spectrum?: string | undefined;
600
- imageId?: string | undefined;
601
- };
602
-
603
- export type GetJourneyStateAggregatedValidationCheck = {
604
- name: string;
605
- title: string;
606
- info: string;
607
- validationResult: string;
608
- resultInfo: string;
609
- weight: string;
610
- regionOfInterests?:
611
- | Array<GetJourneyStateAggregatedValidationCheckRegionOfInterest>
612
- | undefined;
613
- type: string;
614
- };
615
-
616
- export type GetJourneyStateValidation = {
617
- validationChecks?: Array<GetJourneyStateValidationCheck> | undefined;
618
- aggregatedValidationChecks?:
619
- | Array<GetJourneyStateAggregatedValidationCheck>
620
- | undefined;
621
- };
622
-
623
- export type GetJourneyStateDocumentAlias = {
624
- /**
625
- * Title of an individual such as Mr, Mrs, Dr, Sir
626
- */
627
- title?: string | undefined;
628
- /**
629
- * A person's name used by their collegues and friends to address them
630
- */
631
- firstName?: string | undefined;
632
- /**
633
- * Any other registered names used by the individual, not aliases
634
- */
635
- middleNames?: Array<string> | undefined;
636
- /**
637
- * Any family names for the individual
638
- */
639
- lastNames?: Array<string> | undefined;
640
- /**
641
- * Any family names for the individual
642
- */
643
- lastNamesAtBirth?: Array<string> | undefined;
644
- };
645
-
646
- export const GetJourneyStateDocumentRelationship = {
647
- Mother: "mother",
648
- Father: "father",
649
- MaternalGrandFather: "maternalGrandFather",
650
- MaternalGrandMother: "maternalGrandMother",
651
- PaternalGrandFather: "paternalGrandFather",
652
- PaternalGrandMother: "paternalGrandMother",
653
- } as const;
654
- export type GetJourneyStateDocumentRelationship = OpenEnum<
655
- typeof GetJourneyStateDocumentRelationship
656
- >;
657
-
658
- export type GetJourneyStateDocumentRelatedPerson = {
659
- /**
660
- * Title of an individual such as Mr, Mrs, Dr, Sir
661
- */
662
- title?: string | undefined;
663
- /**
664
- * A person's name used by their collegues and friends to address them
665
- */
666
- firstName?: string | undefined;
667
- /**
668
- * Any other registered names used by the individual, not aliases
669
- */
670
- middleNames?: Array<string> | undefined;
671
- /**
672
- * Any family names for the individual
673
- */
674
- lastNames?: Array<string> | undefined;
675
- /**
676
- * Any family names for the individual
677
- */
678
- lastNamesAtBirth?: Array<string> | undefined;
679
- relationship: GetJourneyStateDocumentRelationship;
680
- };
681
-
682
- export type GetJourneyStateDocumentCurrentAddressLocation = {
683
- latitude?: string | undefined;
684
- longitude?: string | undefined;
685
- geoAccuracy?: string | undefined;
686
- /**
687
- * A What3words designation associated with this location with '.' separator.
688
- */
689
- what3words?: string | undefined;
690
- };
691
-
692
- export type GetJourneyStateDocumentCurrentAddress = {
693
- /**
694
- * Unformatted line based address
695
- */
696
- lines?: Array<string> | undefined;
697
- /**
698
- * The address as a single line
699
- */
700
- addressString?: string | undefined;
701
- /**
702
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
703
- */
704
- premise?: string | undefined;
705
- /**
706
- * The name of a building or a building complex. In the US, this is the street number.
707
- */
708
- building?: string | undefined;
709
- /**
710
- * The name of a sub-building, such as a flat or apartment number.
711
- */
712
- subBuilding?: string | undefined;
713
- /**
714
- * This field holds the most common street or block data element within a country. For instance, USA Street
715
- */
716
- thoroughfare?: string | undefined;
717
- /**
718
- * The name of a dependent street or block, such as a street within a complex.
719
- */
720
- dependentThoroughfare?: string | undefined;
721
- /**
722
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
723
- */
724
- locality?: string | undefined;
725
- /**
726
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
727
- */
728
- dependentLocality?: string | undefined;
729
- /**
730
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
731
- */
732
- doubleDependentLocality?: string | undefined;
733
- /**
734
- * 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
735
- */
736
- postalCode?: string | undefined;
737
- /**
738
- * This field contains the post box number associated with a particular delivery point, should one exist.
739
- */
740
- postBox?: string | undefined;
741
- /**
742
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
743
- */
744
- country?: string | undefined;
745
- superAdministrativeArea?: string | undefined;
746
- administrativeArea?: string | undefined;
747
- subAdministrativeArea?: string | undefined;
748
- organization?: string | undefined;
749
- location?: GetJourneyStateDocumentCurrentAddressLocation | undefined;
750
- };
751
-
752
- export type GetJourneyStateDocumentPreviousAddressLocation = {
753
- latitude?: string | undefined;
754
- longitude?: string | undefined;
755
- geoAccuracy?: string | undefined;
756
- /**
757
- * A What3words designation associated with this location with '.' separator.
758
- */
759
- what3words?: string | undefined;
760
- };
761
-
762
- export type GetJourneyStateDocumentPreviousAddress = {
763
- /**
764
- * Unformatted line based address
765
- */
766
- lines?: Array<string> | undefined;
767
- /**
768
- * The address as a single line
769
- */
770
- addressString?: string | undefined;
771
- /**
772
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
773
- */
774
- premise?: string | undefined;
775
- /**
776
- * The name of a building or a building complex. In the US, this is the street number.
777
- */
778
- building?: string | undefined;
779
- /**
780
- * The name of a sub-building, such as a flat or apartment number.
781
- */
782
- subBuilding?: string | undefined;
783
- /**
784
- * This field holds the most common street or block data element within a country. For instance, USA Street
785
- */
786
- thoroughfare?: string | undefined;
787
- /**
788
- * The name of a dependent street or block, such as a street within a complex.
789
- */
790
- dependentThoroughfare?: string | undefined;
791
- /**
792
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
793
- */
794
- locality?: string | undefined;
795
- /**
796
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
797
- */
798
- dependentLocality?: string | undefined;
799
- /**
800
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
801
- */
802
- doubleDependentLocality?: string | undefined;
803
- /**
804
- * 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
805
- */
806
- postalCode?: string | undefined;
807
- /**
808
- * This field contains the post box number associated with a particular delivery point, should one exist.
809
- */
810
- postBox?: string | undefined;
811
- /**
812
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
813
- */
814
- country?: string | undefined;
815
- superAdministrativeArea?: string | undefined;
816
- administrativeArea?: string | undefined;
817
- subAdministrativeArea?: string | undefined;
818
- organization?: string | undefined;
819
- location?: GetJourneyStateDocumentPreviousAddressLocation | undefined;
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
- fromDate: string;
824
- /**
825
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
826
- */
827
- toDate: string;
828
- };
829
-
830
- export type GetJourneyStateDocumentPlaceOfBirthLocation = {
831
- latitude?: string | undefined;
832
- longitude?: string | undefined;
833
- geoAccuracy?: string | undefined;
834
- /**
835
- * A What3words designation associated with this location with '.' separator.
836
- */
837
- what3words?: string | undefined;
838
- };
839
-
840
- export type GetJourneyStateDocumentPlaceOfBirth = {
841
- /**
842
- * Unformatted line based address
843
- */
844
- lines?: Array<string> | undefined;
845
- /**
846
- * The address as a single line
847
- */
848
- addressString?: string | undefined;
849
- /**
850
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
851
- */
852
- premise?: string | undefined;
853
- /**
854
- * The name of a building or a building complex. In the US, this is the street number.
855
- */
856
- building?: string | undefined;
857
- /**
858
- * The name of a sub-building, such as a flat or apartment number.
859
- */
860
- subBuilding?: string | undefined;
861
- /**
862
- * This field holds the most common street or block data element within a country. For instance, USA Street
863
- */
864
- thoroughfare?: string | undefined;
865
- /**
866
- * The name of a dependent street or block, such as a street within a complex.
867
- */
868
- dependentThoroughfare?: string | undefined;
869
- /**
870
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
871
- */
872
- locality?: string | undefined;
873
- /**
874
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
875
- */
876
- dependentLocality?: string | undefined;
877
- /**
878
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
879
- */
880
- doubleDependentLocality?: string | undefined;
881
- /**
882
- * 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
883
- */
884
- postalCode?: string | undefined;
885
- /**
886
- * This field contains the post box number associated with a particular delivery point, should one exist.
887
- */
888
- postBox?: string | undefined;
889
- /**
890
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
891
- */
892
- country?: string | undefined;
893
- superAdministrativeArea?: string | undefined;
894
- administrativeArea?: string | undefined;
895
- subAdministrativeArea?: string | undefined;
896
- organization?: string | undefined;
897
- location?: GetJourneyStateDocumentPlaceOfBirthLocation | undefined;
898
- };
899
-
900
- export type GetJourneyStateDocumentIdNumber = {
901
- /**
902
- * The type of phone number, such as landline, mobile, fax, unknown etc
903
- */
904
- type: string;
905
- /**
906
- * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
907
- */
908
- idNumber: string;
909
- /**
910
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
911
- */
912
- country?: string | undefined;
913
- };
914
-
915
- export type GetJourneyStateDocumentPhone = {
916
- /**
917
- * The type of phone number, such as landline, mobile, fax, unknown etc
918
- */
919
- type: string;
920
- /**
921
- * Phone number, ideally in international format with +(Country Code)
922
- */
923
- number: string;
924
- };
925
-
926
- export type GetJourneyStateDocumentEmail = {
927
- /**
928
- * The type of email, such as home, work, unknown etc
929
- */
930
- type: string;
931
- /**
932
- * Email address
933
- */
934
- email: string;
935
- };
936
-
937
- export type GetJourneyStateDocumentSocial = {
938
- /**
939
- * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
940
- */
941
- type: string;
942
- /**
943
- * the identity used on this platform
944
- */
945
- identity: string;
946
- };
947
-
948
- export type GetJourneyStateDocumentSubject = {
949
- /**
950
- * Title of an individual such as Mr, Mrs, Dr, Sir
951
- */
952
- title?: string | undefined;
953
- /**
954
- * A person's name used by their collegues and friends to address them
955
- */
956
- firstName?: string | undefined;
957
- /**
958
- * Any other registered names used by the individual, not aliases
959
- */
960
- middleNames?: Array<string> | undefined;
961
- /**
962
- * Any family names for the individual
963
- */
964
- lastNames?: Array<string> | undefined;
965
- /**
966
- * Any family names for the individual
967
- */
968
- lastNamesAtBirth?: Array<string> | undefined;
969
- aliases?: Array<GetJourneyStateDocumentAlias> | undefined;
970
- relatedPersons?: Array<GetJourneyStateDocumentRelatedPerson> | undefined;
971
- /**
972
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
973
- */
974
- dateOfBirth?: string | undefined;
975
- gender?: string | undefined;
976
- currentAddress?: GetJourneyStateDocumentCurrentAddress | undefined;
977
- previousAddresses?: Array<GetJourneyStateDocumentPreviousAddress> | undefined;
978
- placeOfBirth?: GetJourneyStateDocumentPlaceOfBirth | undefined;
979
- idNumbers?: Array<GetJourneyStateDocumentIdNumber> | undefined;
980
- phones?: Array<GetJourneyStateDocumentPhone> | undefined;
981
- emails?: Array<GetJourneyStateDocumentEmail> | undefined;
982
- socials?: Array<GetJourneyStateDocumentSocial> | undefined;
983
- /**
984
- * The subject's mother's maiden name, used for identity verification
985
- */
986
- mothersMaidenName?: string | undefined;
987
- };
988
-
989
- export type GetJourneyStateDocument = {
990
- oneDBarcode?: string | undefined;
991
- address?: GetJourneyStateAddress | undefined;
992
- applicationDate?: string | undefined;
993
- applicationNumber?: string | undefined;
994
- dateOfBirth?: string | undefined;
995
- placeOfBirth?: string | undefined;
996
- placeOfBirthNative?: string | undefined;
997
- bloodType?: string | undefined;
998
- controlNumber?: string | undefined;
999
- countryCode?: string | undefined;
1000
- countryName?: string | undefined;
1001
- documentClassCode?: string | undefined;
1002
- documentClassName?: string | undefined;
1003
- documentNumber?: string | undefined;
1004
- documentSignerCertificate?: string | undefined;
1005
- employer?: string | undefined;
1006
- employerAddress?: string | undefined;
1007
- entries?: string | undefined;
1008
- expirationDate?: string | undefined;
1009
- eyeColor?: string | undefined;
1010
- fathersName?: string | undefined;
1011
- fathersNameNative?: string | undefined;
1012
- fathersSurname?: string | undefined;
1013
- firstName?: string | undefined;
1014
- fullName?: string | undefined;
1015
- fullNameNative?: string | undefined;
1016
- givenName?: string | undefined;
1017
- givenNameNative?: string | undefined;
1018
- hairColor?: string | undefined;
1019
- height?: string | undefined;
1020
- /**
1021
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1022
- */
1023
- issueDate?: string | undefined;
1024
- issuingAuthority?: string | undefined;
1025
- issuingAuthorityNative?: string | undefined;
1026
- issuingStateCode?: string | undefined;
1027
- issuingStateName?: string | undefined;
1028
- licenseClass?: string | undefined;
1029
- licenseEndorsements?: string | undefined;
1030
- licenseRestrictions?: string | undefined;
1031
- mrz?: string | undefined;
1032
- mrz1?: string | undefined;
1033
- mrz2?: string | undefined;
1034
- mrz3?: string | undefined;
1035
- middleName?: string | undefined;
1036
- mothersName?: string | undefined;
1037
- mothersNameNative?: string | undefined;
1038
- mothersSurname?: string | undefined;
1039
- nameSuffix?: string | undefined;
1040
- nationalityCode?: string | undefined;
1041
- nationalityName?: string | undefined;
1042
- nationalityNameNative?: string | undefined;
1043
- occupation?: string | undefined;
1044
- organDonor?: boolean | undefined;
1045
- passportNumber?: string | undefined;
1046
- permitNumber?: string | undefined;
1047
- personalNumber?: string | undefined;
1048
- photo?: string | undefined;
1049
- photoCompressed?: string | undefined;
1050
- photoEncoding?: string | undefined;
1051
- sex?: string | undefined;
1052
- sexNative?: string | undefined;
1053
- signature?: string | undefined;
1054
- signatureCompressed?: string | undefined;
1055
- signatureEncoding?: string | undefined;
1056
- socialSecurityNumber?: string | undefined;
1057
- startDate?: string | undefined;
1058
- surname?: string | undefined;
1059
- surnameNative?: string | undefined;
1060
- visaClass?: string | undefined;
1061
- visaNumber?: string | undefined;
1062
- weight?: string | undefined;
1063
- cardNumber?: string | undefined;
1064
- /**
1065
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1066
- */
1067
- issuerCountryCode?: string | undefined;
1068
- id?: string | undefined;
1069
- type?: string | undefined;
1070
- category?: string | undefined;
1071
- subtype?: string | undefined;
1072
- format?: string | undefined;
1073
- device?: GetJourneyStateDocumentDevice | undefined;
1074
- side1Image?: string | undefined;
1075
- side2Image?: string | undefined;
1076
- chip?: GetJourneyStateChip | undefined;
1077
- classification?: GetJourneyStateClassification | undefined;
1078
- extraction?: GetJourneyStateExtraction | undefined;
1079
- validation?: GetJourneyStateValidation | undefined;
1080
- subType?: string | undefined;
1081
- number?: string | undefined;
1082
- /**
1083
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1084
- */
1085
- expiryDate?: string | undefined;
1086
- subject?: GetJourneyStateDocumentSubject | undefined;
1087
- /**
1088
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1089
- */
1090
- country?: string | undefined;
1091
- };
1092
-
1093
- export type GetJourneyStateBiometric4 = {
1094
- id?: string | undefined;
1095
- type?: string | undefined;
1096
- selfieImage: string;
1097
- selfieImageEncryption?: boolean | undefined;
1098
- };
1099
-
1100
- export type GetJourneyStateBiometric3 = {
1101
- id?: string | undefined;
1102
- type?: string | undefined;
1103
- faceImage: string;
1104
- };
1105
-
1106
- export type GetJourneyStateBiometric2 = {
1107
- id?: string | undefined;
1108
- type?: string | undefined;
1109
- selfieImage: string;
1110
- anchorImage: string;
1111
- };
1112
-
1113
- export type GetJourneyStateBiometric1 = {
1114
- id?: string | undefined;
1115
- type?: string | undefined;
1116
- face1Image: string;
1117
- face2Image: string;
1118
- };
1119
-
1120
- export type GetJourneyStateBiometricUnion =
1121
- | GetJourneyStateBiometric1
1122
- | GetJourneyStateBiometric2
1123
- | GetJourneyStateBiometric3
1124
- | GetJourneyStateBiometric4;
1125
-
1126
- export type GetJourneyStateUser = {
1127
- id: string;
1128
- email: string;
1129
- domain: string;
1130
- };
1131
-
1132
- export type GetJourneyStateClient = {
1133
- id: string;
1134
- ip: string;
1135
- address: string;
1136
- };
1137
-
1138
- export type GetJourneyStateModel = {
1139
- identifier: string;
1140
- name: string;
1141
- };
1142
-
1143
- export type GetJourneyStateSessionDevice = {
1144
- id: string;
1145
- manufacturer: string;
1146
- model: GetJourneyStateModel;
1147
- };
1148
-
1149
- export type GetJourneyStateTrace = {
1150
- id: string;
1151
- };
1152
-
1153
- export type GetJourneyStateSpan = {
1154
- id: string;
1155
- };
1156
-
1157
- export type GetJourneyStateTransaction = {
1158
- id: string;
1159
- };
1160
-
1161
- export type GetJourneyStateSessionAuth = {
1162
- id: string;
1163
- scope?: string | undefined;
1164
- codeVerifier?: string | undefined;
1165
- code?: string | undefined;
1166
- state?: string | undefined;
1167
- redirectUri?: string | undefined;
1168
- responseType?: string | undefined;
1169
- clientId?: string | undefined;
1170
- clientSecret?: string | undefined;
1171
- };
1172
-
1173
- export type GetJourneyStateSession = {
1174
- user?: GetJourneyStateUser | undefined;
1175
- client?: GetJourneyStateClient | undefined;
1176
- device?: GetJourneyStateSessionDevice | undefined;
1177
- trace?: GetJourneyStateTrace | undefined;
1178
- span?: GetJourneyStateSpan | undefined;
1179
- transaction?: GetJourneyStateTransaction | undefined;
1180
- auth?: Array<GetJourneyStateSessionAuth> | undefined;
1181
- };
1182
-
1183
- export const GetJourneyStateConsentType = {
1184
- Rollup: "rollup",
1185
- Explicit: "explicit",
1186
- Implicit: "implicit",
1187
- } as const;
1188
- export type GetJourneyStateConsentType = OpenEnum<
1189
- typeof GetJourneyStateConsentType
1190
- >;
1191
-
1192
- export type GetJourneyStateConsent = {
1193
- type?: GetJourneyStateConsentType | undefined;
1194
- id?: string | undefined;
1195
- version?: string | undefined;
1196
- url: string;
1197
- effectiveDate?: string | undefined;
1198
- expiryDate?: string | undefined;
1199
- terms?: string | undefined;
1200
- purpose?: string | undefined;
1201
- legalBasis?: string | undefined;
1202
- jurisdiction?: string | undefined;
1203
- subject?: string | undefined;
1204
- signatory?: string | undefined;
1205
- };
1206
-
1207
- export type GetJourneyStateAccount = {
1208
- /**
1209
- * The type of account, e.g. Bank Account, Building Society
1210
- */
1211
- type: string;
1212
- /**
1213
- * Account number
1214
- */
1215
- accountNumber: string;
1216
- /**
1217
- * UK sort code
1218
- */
1219
- sortCode?: string | undefined;
1220
- /**
1221
- * US ABA routing number
1222
- */
1223
- routingNumber?: string | undefined;
1224
- /**
1225
- * International Bank Account Number
1226
- */
1227
- iban?: string | undefined;
1228
- /**
1229
- * BIC/SWIFT code
1230
- */
1231
- bic?: string | undefined;
1232
- /**
1233
- * Name on the account
1234
- */
1235
- accountHolderName?: string | undefined;
1236
- /**
1237
- * Name of the financial institution
1238
- */
1239
- bankName?: string | undefined;
1240
- /**
1241
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1242
- */
1243
- country?: string | undefined;
1244
- /**
1245
- * Account classification, e.g. current, savings
1246
- */
1247
- accountType?: string | undefined;
1248
- };
1249
-
1250
- export type GetJourneyStateSubject = {
1251
- identity?: GetJourneyStateIdentity | undefined;
1252
- documents?: Array<GetJourneyStateDocument> | undefined;
1253
- biometrics?:
1254
- | Array<
1255
- | GetJourneyStateBiometric1
1256
- | GetJourneyStateBiometric2
1257
- | GetJourneyStateBiometric3
1258
- | GetJourneyStateBiometric4
1259
- >
1260
- | undefined;
1261
- sessions?: Array<GetJourneyStateSession> | undefined;
1262
- consent?: Array<GetJourneyStateConsent> | undefined;
1263
- accounts?: Array<GetJourneyStateAccount> | undefined;
1264
- uid?: string | undefined;
1265
- };
1266
-
1267
- export type GetJourneyStateContext = {
1268
- subject: GetJourneyStateSubject;
1269
- };
1270
-
1271
- /**
1272
- * Success
1273
- */
1274
- export type GetJourneyStateResponse = {
1275
- /**
1276
- * Journey Instance Id, a unique identifier for a started journey instance.
1277
- */
1278
- instanceId: string;
1279
- status: GetJourneyStateStatus;
1280
- metaData?: MetaData | undefined;
1281
- context?: GetJourneyStateContext | undefined;
1282
- data?: { [k: string]: any } | undefined;
1283
- };
1284
-
1285
- /** @internal */
1286
- export type GetJourneyStateRequest$Outbound = {
1287
- instanceId: string;
1288
- filterKeys?: Array<string> | undefined;
1289
- };
1290
-
1291
- /** @internal */
1292
- export const GetJourneyStateRequest$outboundSchema: z.ZodMiniType<
1293
- GetJourneyStateRequest$Outbound,
1294
- GetJourneyStateRequest
1295
- > = z.object({
1296
- instanceId: z.string(),
1297
- filterKeys: z.optional(z.array(z.string())),
1298
- });
1299
-
1300
- export function getJourneyStateRequestToJSON(
1301
- getJourneyStateRequest: GetJourneyStateRequest,
1302
- ): string {
1303
- return JSON.stringify(
1304
- GetJourneyStateRequest$outboundSchema.parse(getJourneyStateRequest),
1305
- );
1306
- }
1307
-
1308
- /** @internal */
1309
- export const GetJourneyStateStatus$inboundSchema: z.ZodMiniType<
1310
- GetJourneyStateStatus,
1311
- unknown
1312
- > = openEnums.inboundSchema(GetJourneyStateStatus);
1313
-
1314
- /** @internal */
1315
- export const MetaData$inboundSchema: z.ZodMiniType<MetaData, unknown> = z
1316
- .catchall(
1317
- z.object({
1318
- createdTime: types.optional(types.string()),
1319
- completedTime: types.optional(types.string()),
1320
- }),
1321
- z.any(),
1322
- );
1323
-
1324
- export function metaDataFromJSON(
1325
- jsonString: string,
1326
- ): SafeParseResult<MetaData, SDKValidationError> {
1327
- return safeParse(
1328
- jsonString,
1329
- (x) => MetaData$inboundSchema.parse(JSON.parse(x)),
1330
- `Failed to parse 'MetaData' from JSON`,
1331
- );
1332
- }
1333
-
1334
- /** @internal */
1335
- export const GetJourneyStateIdentityAlias$inboundSchema: z.ZodMiniType<
1336
- GetJourneyStateIdentityAlias,
1337
- unknown
1338
- > = z.object({
1339
- title: types.optional(types.string()),
1340
- firstName: types.optional(types.string()),
1341
- middleNames: types.optional(z.array(types.string())),
1342
- lastNames: types.optional(z.array(types.string())),
1343
- lastNamesAtBirth: types.optional(z.array(types.string())),
1344
- });
1345
-
1346
- export function getJourneyStateIdentityAliasFromJSON(
1347
- jsonString: string,
1348
- ): SafeParseResult<GetJourneyStateIdentityAlias, SDKValidationError> {
1349
- return safeParse(
1350
- jsonString,
1351
- (x) => GetJourneyStateIdentityAlias$inboundSchema.parse(JSON.parse(x)),
1352
- `Failed to parse 'GetJourneyStateIdentityAlias' from JSON`,
1353
- );
1354
- }
1355
-
1356
- /** @internal */
1357
- export const GetJourneyStateIdentityRelationship$inboundSchema: z.ZodMiniType<
1358
- GetJourneyStateIdentityRelationship,
1359
- unknown
1360
- > = openEnums.inboundSchema(GetJourneyStateIdentityRelationship);
1361
-
1362
- /** @internal */
1363
- export const GetJourneyStateIdentityRelatedPerson$inboundSchema: z.ZodMiniType<
1364
- GetJourneyStateIdentityRelatedPerson,
1365
- unknown
1366
- > = z.object({
1367
- title: types.optional(types.string()),
1368
- firstName: types.optional(types.string()),
1369
- middleNames: types.optional(z.array(types.string())),
1370
- lastNames: types.optional(z.array(types.string())),
1371
- lastNamesAtBirth: types.optional(z.array(types.string())),
1372
- relationship: GetJourneyStateIdentityRelationship$inboundSchema,
1373
- });
1374
-
1375
- export function getJourneyStateIdentityRelatedPersonFromJSON(
1376
- jsonString: string,
1377
- ): SafeParseResult<GetJourneyStateIdentityRelatedPerson, SDKValidationError> {
1378
- return safeParse(
1379
- jsonString,
1380
- (x) =>
1381
- GetJourneyStateIdentityRelatedPerson$inboundSchema.parse(JSON.parse(x)),
1382
- `Failed to parse 'GetJourneyStateIdentityRelatedPerson' from JSON`,
1383
- );
1384
- }
1385
-
1386
- /** @internal */
1387
- export const GetJourneyStateIdentityCurrentAddressLocation$inboundSchema:
1388
- z.ZodMiniType<GetJourneyStateIdentityCurrentAddressLocation, unknown> = z
1389
- .object({
1390
- latitude: types.optional(types.string()),
1391
- longitude: types.optional(types.string()),
1392
- geoAccuracy: types.optional(types.string()),
1393
- what3words: types.optional(types.string()),
1394
- });
1395
-
1396
- export function getJourneyStateIdentityCurrentAddressLocationFromJSON(
1397
- jsonString: string,
1398
- ): SafeParseResult<
1399
- GetJourneyStateIdentityCurrentAddressLocation,
1400
- SDKValidationError
1401
- > {
1402
- return safeParse(
1403
- jsonString,
1404
- (x) =>
1405
- GetJourneyStateIdentityCurrentAddressLocation$inboundSchema.parse(
1406
- JSON.parse(x),
1407
- ),
1408
- `Failed to parse 'GetJourneyStateIdentityCurrentAddressLocation' from JSON`,
1409
- );
1410
- }
1411
-
1412
- /** @internal */
1413
- export const GetJourneyStateIdentityCurrentAddress$inboundSchema: z.ZodMiniType<
1414
- GetJourneyStateIdentityCurrentAddress,
1415
- unknown
1416
- > = z.object({
1417
- lines: types.optional(z.array(types.string())),
1418
- addressString: types.optional(types.string()),
1419
- premise: types.optional(types.string()),
1420
- building: types.optional(types.string()),
1421
- subBuilding: types.optional(types.string()),
1422
- thoroughfare: types.optional(types.string()),
1423
- dependentThoroughfare: types.optional(types.string()),
1424
- locality: types.optional(types.string()),
1425
- dependentLocality: types.optional(types.string()),
1426
- doubleDependentLocality: types.optional(types.string()),
1427
- postalCode: types.optional(types.string()),
1428
- postBox: types.optional(types.string()),
1429
- country: types.optional(types.string()),
1430
- superAdministrativeArea: types.optional(types.string()),
1431
- administrativeArea: types.optional(types.string()),
1432
- subAdministrativeArea: types.optional(types.string()),
1433
- organization: types.optional(types.string()),
1434
- location: types.optional(
1435
- z.lazy(() => GetJourneyStateIdentityCurrentAddressLocation$inboundSchema),
1436
- ),
1437
- });
1438
-
1439
- export function getJourneyStateIdentityCurrentAddressFromJSON(
1440
- jsonString: string,
1441
- ): SafeParseResult<GetJourneyStateIdentityCurrentAddress, SDKValidationError> {
1442
- return safeParse(
1443
- jsonString,
1444
- (x) =>
1445
- GetJourneyStateIdentityCurrentAddress$inboundSchema.parse(JSON.parse(x)),
1446
- `Failed to parse 'GetJourneyStateIdentityCurrentAddress' from JSON`,
1447
- );
1448
- }
1449
-
1450
- /** @internal */
1451
- export const GetJourneyStateIdentityPreviousAddressLocation$inboundSchema:
1452
- z.ZodMiniType<GetJourneyStateIdentityPreviousAddressLocation, unknown> = z
1453
- .object({
1454
- latitude: types.optional(types.string()),
1455
- longitude: types.optional(types.string()),
1456
- geoAccuracy: types.optional(types.string()),
1457
- what3words: types.optional(types.string()),
1458
- });
1459
-
1460
- export function getJourneyStateIdentityPreviousAddressLocationFromJSON(
1461
- jsonString: string,
1462
- ): SafeParseResult<
1463
- GetJourneyStateIdentityPreviousAddressLocation,
1464
- SDKValidationError
1465
- > {
1466
- return safeParse(
1467
- jsonString,
1468
- (x) =>
1469
- GetJourneyStateIdentityPreviousAddressLocation$inboundSchema.parse(
1470
- JSON.parse(x),
1471
- ),
1472
- `Failed to parse 'GetJourneyStateIdentityPreviousAddressLocation' from JSON`,
1473
- );
1474
- }
1475
-
1476
- /** @internal */
1477
- export const GetJourneyStateIdentityPreviousAddress$inboundSchema:
1478
- z.ZodMiniType<GetJourneyStateIdentityPreviousAddress, unknown> = z.object({
1479
- lines: types.optional(z.array(types.string())),
1480
- addressString: types.optional(types.string()),
1481
- premise: types.optional(types.string()),
1482
- building: types.optional(types.string()),
1483
- subBuilding: types.optional(types.string()),
1484
- thoroughfare: types.optional(types.string()),
1485
- dependentThoroughfare: types.optional(types.string()),
1486
- locality: types.optional(types.string()),
1487
- dependentLocality: types.optional(types.string()),
1488
- doubleDependentLocality: types.optional(types.string()),
1489
- postalCode: types.optional(types.string()),
1490
- postBox: types.optional(types.string()),
1491
- country: types.optional(types.string()),
1492
- superAdministrativeArea: types.optional(types.string()),
1493
- administrativeArea: types.optional(types.string()),
1494
- subAdministrativeArea: types.optional(types.string()),
1495
- organization: types.optional(types.string()),
1496
- location: types.optional(
1497
- z.lazy(() =>
1498
- GetJourneyStateIdentityPreviousAddressLocation$inboundSchema
1499
- ),
1500
- ),
1501
- fromDate: types.string(),
1502
- toDate: types.string(),
1503
- });
1504
-
1505
- export function getJourneyStateIdentityPreviousAddressFromJSON(
1506
- jsonString: string,
1507
- ): SafeParseResult<GetJourneyStateIdentityPreviousAddress, SDKValidationError> {
1508
- return safeParse(
1509
- jsonString,
1510
- (x) =>
1511
- GetJourneyStateIdentityPreviousAddress$inboundSchema.parse(JSON.parse(x)),
1512
- `Failed to parse 'GetJourneyStateIdentityPreviousAddress' from JSON`,
1513
- );
1514
- }
1515
-
1516
- /** @internal */
1517
- export const GetJourneyStateIdentityPlaceOfBirthLocation$inboundSchema:
1518
- z.ZodMiniType<GetJourneyStateIdentityPlaceOfBirthLocation, unknown> = z
1519
- .object({
1520
- latitude: types.optional(types.string()),
1521
- longitude: types.optional(types.string()),
1522
- geoAccuracy: types.optional(types.string()),
1523
- what3words: types.optional(types.string()),
1524
- });
1525
-
1526
- export function getJourneyStateIdentityPlaceOfBirthLocationFromJSON(
1527
- jsonString: string,
1528
- ): SafeParseResult<
1529
- GetJourneyStateIdentityPlaceOfBirthLocation,
1530
- SDKValidationError
1531
- > {
1532
- return safeParse(
1533
- jsonString,
1534
- (x) =>
1535
- GetJourneyStateIdentityPlaceOfBirthLocation$inboundSchema.parse(
1536
- JSON.parse(x),
1537
- ),
1538
- `Failed to parse 'GetJourneyStateIdentityPlaceOfBirthLocation' from JSON`,
1539
- );
1540
- }
1541
-
1542
- /** @internal */
1543
- export const GetJourneyStateIdentityPlaceOfBirth$inboundSchema: z.ZodMiniType<
1544
- GetJourneyStateIdentityPlaceOfBirth,
1545
- unknown
1546
- > = z.object({
1547
- lines: types.optional(z.array(types.string())),
1548
- addressString: types.optional(types.string()),
1549
- premise: types.optional(types.string()),
1550
- building: types.optional(types.string()),
1551
- subBuilding: types.optional(types.string()),
1552
- thoroughfare: types.optional(types.string()),
1553
- dependentThoroughfare: types.optional(types.string()),
1554
- locality: types.optional(types.string()),
1555
- dependentLocality: types.optional(types.string()),
1556
- doubleDependentLocality: types.optional(types.string()),
1557
- postalCode: types.optional(types.string()),
1558
- postBox: types.optional(types.string()),
1559
- country: types.optional(types.string()),
1560
- superAdministrativeArea: types.optional(types.string()),
1561
- administrativeArea: types.optional(types.string()),
1562
- subAdministrativeArea: types.optional(types.string()),
1563
- organization: types.optional(types.string()),
1564
- location: types.optional(
1565
- z.lazy(() => GetJourneyStateIdentityPlaceOfBirthLocation$inboundSchema),
1566
- ),
1567
- });
1568
-
1569
- export function getJourneyStateIdentityPlaceOfBirthFromJSON(
1570
- jsonString: string,
1571
- ): SafeParseResult<GetJourneyStateIdentityPlaceOfBirth, SDKValidationError> {
1572
- return safeParse(
1573
- jsonString,
1574
- (x) =>
1575
- GetJourneyStateIdentityPlaceOfBirth$inboundSchema.parse(JSON.parse(x)),
1576
- `Failed to parse 'GetJourneyStateIdentityPlaceOfBirth' from JSON`,
1577
- );
1578
- }
1579
-
1580
- /** @internal */
1581
- export const GetJourneyStateIdentityIdNumber$inboundSchema: z.ZodMiniType<
1582
- GetJourneyStateIdentityIdNumber,
1583
- unknown
1584
- > = z.object({
1585
- type: types.string(),
1586
- idNumber: types.string(),
1587
- country: types.optional(types.string()),
1588
- });
1589
-
1590
- export function getJourneyStateIdentityIdNumberFromJSON(
1591
- jsonString: string,
1592
- ): SafeParseResult<GetJourneyStateIdentityIdNumber, SDKValidationError> {
1593
- return safeParse(
1594
- jsonString,
1595
- (x) => GetJourneyStateIdentityIdNumber$inboundSchema.parse(JSON.parse(x)),
1596
- `Failed to parse 'GetJourneyStateIdentityIdNumber' from JSON`,
1597
- );
1598
- }
1599
-
1600
- /** @internal */
1601
- export const GetJourneyStateIdentityPhone$inboundSchema: z.ZodMiniType<
1602
- GetJourneyStateIdentityPhone,
1603
- unknown
1604
- > = z.object({
1605
- type: types.string(),
1606
- number: types.string(),
1607
- });
1608
-
1609
- export function getJourneyStateIdentityPhoneFromJSON(
1610
- jsonString: string,
1611
- ): SafeParseResult<GetJourneyStateIdentityPhone, SDKValidationError> {
1612
- return safeParse(
1613
- jsonString,
1614
- (x) => GetJourneyStateIdentityPhone$inboundSchema.parse(JSON.parse(x)),
1615
- `Failed to parse 'GetJourneyStateIdentityPhone' from JSON`,
1616
- );
1617
- }
1618
-
1619
- /** @internal */
1620
- export const GetJourneyStateIdentityEmail$inboundSchema: z.ZodMiniType<
1621
- GetJourneyStateIdentityEmail,
1622
- unknown
1623
- > = z.object({
1624
- type: types.string(),
1625
- email: types.string(),
1626
- });
1627
-
1628
- export function getJourneyStateIdentityEmailFromJSON(
1629
- jsonString: string,
1630
- ): SafeParseResult<GetJourneyStateIdentityEmail, SDKValidationError> {
1631
- return safeParse(
1632
- jsonString,
1633
- (x) => GetJourneyStateIdentityEmail$inboundSchema.parse(JSON.parse(x)),
1634
- `Failed to parse 'GetJourneyStateIdentityEmail' from JSON`,
1635
- );
1636
- }
1637
-
1638
- /** @internal */
1639
- export const GetJourneyStateIdentitySocial$inboundSchema: z.ZodMiniType<
1640
- GetJourneyStateIdentitySocial,
1641
- unknown
1642
- > = z.object({
1643
- type: types.string(),
1644
- identity: types.string(),
1645
- });
1646
-
1647
- export function getJourneyStateIdentitySocialFromJSON(
1648
- jsonString: string,
1649
- ): SafeParseResult<GetJourneyStateIdentitySocial, SDKValidationError> {
1650
- return safeParse(
1651
- jsonString,
1652
- (x) => GetJourneyStateIdentitySocial$inboundSchema.parse(JSON.parse(x)),
1653
- `Failed to parse 'GetJourneyStateIdentitySocial' from JSON`,
1654
- );
1655
- }
1656
-
1657
- /** @internal */
1658
- export const GetJourneyStateIdentity$inboundSchema: z.ZodMiniType<
1659
- GetJourneyStateIdentity,
1660
- unknown
1661
- > = z.object({
1662
- title: types.optional(types.string()),
1663
- firstName: types.optional(types.string()),
1664
- middleNames: types.optional(z.array(types.string())),
1665
- lastNames: types.optional(z.array(types.string())),
1666
- lastNamesAtBirth: types.optional(z.array(types.string())),
1667
- aliases: types.optional(
1668
- z.array(z.lazy(() => GetJourneyStateIdentityAlias$inboundSchema)),
1669
- ),
1670
- relatedPersons: types.optional(
1671
- z.array(z.lazy(() => GetJourneyStateIdentityRelatedPerson$inboundSchema)),
1672
- ),
1673
- dateOfBirth: types.optional(types.string()),
1674
- gender: types.optional(types.string()),
1675
- currentAddress: types.optional(
1676
- z.lazy(() => GetJourneyStateIdentityCurrentAddress$inboundSchema),
1677
- ),
1678
- previousAddresses: types.optional(
1679
- z.array(z.lazy(() => GetJourneyStateIdentityPreviousAddress$inboundSchema)),
1680
- ),
1681
- placeOfBirth: types.optional(
1682
- z.lazy(() => GetJourneyStateIdentityPlaceOfBirth$inboundSchema),
1683
- ),
1684
- idNumbers: types.optional(
1685
- z.array(z.lazy(() => GetJourneyStateIdentityIdNumber$inboundSchema)),
1686
- ),
1687
- phones: types.optional(
1688
- z.array(z.lazy(() => GetJourneyStateIdentityPhone$inboundSchema)),
1689
- ),
1690
- emails: types.optional(
1691
- z.array(z.lazy(() => GetJourneyStateIdentityEmail$inboundSchema)),
1692
- ),
1693
- socials: types.optional(
1694
- z.array(z.lazy(() => GetJourneyStateIdentitySocial$inboundSchema)),
1695
- ),
1696
- mothersMaidenName: types.optional(types.string()),
1697
- });
1698
-
1699
- export function getJourneyStateIdentityFromJSON(
1700
- jsonString: string,
1701
- ): SafeParseResult<GetJourneyStateIdentity, SDKValidationError> {
1702
- return safeParse(
1703
- jsonString,
1704
- (x) => GetJourneyStateIdentity$inboundSchema.parse(JSON.parse(x)),
1705
- `Failed to parse 'GetJourneyStateIdentity' from JSON`,
1706
- );
1707
- }
1708
-
1709
- /** @internal */
1710
- export const GetJourneyStateAddress$inboundSchema: z.ZodMiniType<
1711
- GetJourneyStateAddress,
1712
- unknown
1713
- > = z.object({
1714
- addressString: types.optional(types.string()),
1715
- extractedAddressString: types.optional(types.string()),
1716
- addressLine1: types.optional(types.string()),
1717
- addressLine2: types.optional(types.string()),
1718
- locality: types.optional(types.string()),
1719
- administrativeArea: types.optional(types.string()),
1720
- postalCode: types.optional(types.string()),
1721
- });
1722
-
1723
- export function getJourneyStateAddressFromJSON(
1724
- jsonString: string,
1725
- ): SafeParseResult<GetJourneyStateAddress, SDKValidationError> {
1726
- return safeParse(
1727
- jsonString,
1728
- (x) => GetJourneyStateAddress$inboundSchema.parse(JSON.parse(x)),
1729
- `Failed to parse 'GetJourneyStateAddress' from JSON`,
1730
- );
1731
- }
1732
-
1733
- /** @internal */
1734
- export const GetJourneyStateDocumentDevice$inboundSchema: z.ZodMiniType<
1735
- GetJourneyStateDocumentDevice,
1736
- unknown
1737
- > = z.object({
1738
- type: types.optional(types.string()),
1739
- model: types.optional(types.string()),
1740
- hasContactlessReader: types.optional(types.boolean()),
1741
- hasMagneticStripeReader: types.optional(types.boolean()),
1742
- hasCamera: types.optional(types.boolean()),
1743
- serialNumber: types.optional(types.string()),
1744
- manufacturer: types.optional(types.string()),
1745
- });
1746
-
1747
- export function getJourneyStateDocumentDeviceFromJSON(
1748
- jsonString: string,
1749
- ): SafeParseResult<GetJourneyStateDocumentDevice, SDKValidationError> {
1750
- return safeParse(
1751
- jsonString,
1752
- (x) => GetJourneyStateDocumentDevice$inboundSchema.parse(JSON.parse(x)),
1753
- `Failed to parse 'GetJourneyStateDocumentDevice' from JSON`,
1754
- );
1755
- }
1756
-
1757
- /** @internal */
1758
- export const GetJourneyStateName$inboundSchema: z.ZodMiniType<
1759
- GetJourneyStateName,
1760
- unknown
1761
- > = openEnums.inboundSchema(GetJourneyStateName);
1762
-
1763
- /** @internal */
1764
- export const GetJourneyStateLd$inboundSchema: z.ZodMiniType<
1765
- GetJourneyStateLd,
1766
- unknown
1767
- > = z.catchall(
1768
- z.object({
1769
- name: GetJourneyStateName$inboundSchema,
1770
- data: types.string(),
1771
- }),
1772
- z.any(),
1773
- );
1774
-
1775
- export function getJourneyStateLdFromJSON(
1776
- jsonString: string,
1777
- ): SafeParseResult<GetJourneyStateLd, SDKValidationError> {
1778
- return safeParse(
1779
- jsonString,
1780
- (x) => GetJourneyStateLd$inboundSchema.parse(JSON.parse(x)),
1781
- `Failed to parse 'GetJourneyStateLd' from JSON`,
1782
- );
1783
- }
1784
-
1785
- /** @internal */
1786
- export const GetJourneyStateAuthType$inboundSchema: z.ZodMiniType<
1787
- GetJourneyStateAuthType,
1788
- unknown
1789
- > = openEnums.inboundSchema(GetJourneyStateAuthType);
1790
-
1791
- /** @internal */
1792
- export const GetJourneyStateResult$inboundSchema: z.ZodMiniType<
1793
- GetJourneyStateResult,
1794
- unknown
1795
- > = openEnums.inboundSchema(GetJourneyStateResult);
1796
-
1797
- /** @internal */
1798
- export const GetJourneyStateChipAuth$inboundSchema: z.ZodMiniType<
1799
- GetJourneyStateChipAuth,
1800
- unknown
1801
- > = z.catchall(
1802
- z.object({
1803
- type: GetJourneyStateAuthType$inboundSchema,
1804
- result: GetJourneyStateResult$inboundSchema,
1805
- }),
1806
- z.any(),
1807
- );
1808
-
1809
- export function getJourneyStateChipAuthFromJSON(
1810
- jsonString: string,
1811
- ): SafeParseResult<GetJourneyStateChipAuth, SDKValidationError> {
1812
- return safeParse(
1813
- jsonString,
1814
- (x) => GetJourneyStateChipAuth$inboundSchema.parse(JSON.parse(x)),
1815
- `Failed to parse 'GetJourneyStateChipAuth' from JSON`,
1816
- );
1817
- }
1818
-
1819
- /** @internal */
1820
- export const GetJourneyStateChip$inboundSchema: z.ZodMiniType<
1821
- GetJourneyStateChip,
1822
- unknown
1823
- > = z.catchall(
1824
- z.object({
1825
- lds: z.array(z.lazy(() => GetJourneyStateLd$inboundSchema)),
1826
- auth: z.array(z.lazy(() => GetJourneyStateChipAuth$inboundSchema)),
1827
- }),
1828
- z.any(),
1829
- );
1830
-
1831
- export function getJourneyStateChipFromJSON(
1832
- jsonString: string,
1833
- ): SafeParseResult<GetJourneyStateChip, SDKValidationError> {
1834
- return safeParse(
1835
- jsonString,
1836
- (x) => GetJourneyStateChip$inboundSchema.parse(JSON.parse(x)),
1837
- `Failed to parse 'GetJourneyStateChip' from JSON`,
1838
- );
1839
- }
1840
-
1841
- /** @internal */
1842
- export const GetJourneyStateSide$inboundSchema: z.ZodMiniType<
1843
- GetJourneyStateSide,
1844
- unknown
1845
- > = z.object({
1846
- side: types.string(),
1847
- id: types.string(),
1848
- documentQuality: types.string(),
1849
- documentQualityScore: types.number(),
1850
- });
1851
-
1852
- export function getJourneyStateSideFromJSON(
1853
- jsonString: string,
1854
- ): SafeParseResult<GetJourneyStateSide, SDKValidationError> {
1855
- return safeParse(
1856
- jsonString,
1857
- (x) => GetJourneyStateSide$inboundSchema.parse(JSON.parse(x)),
1858
- `Failed to parse 'GetJourneyStateSide' from JSON`,
1859
- );
1860
- }
1861
-
1862
- /** @internal */
1863
- export const GetJourneyStateClassification$inboundSchema: z.ZodMiniType<
1864
- GetJourneyStateClassification,
1865
- unknown
1866
- > = z.object({
1867
- ids: types.optional(z.array(types.string())),
1868
- category: types.optional(types.string()),
1869
- type: types.optional(types.string()),
1870
- subtype: types.optional(types.string()),
1871
- isDoubleSided: types.optional(types.boolean()),
1872
- hasNFC: types.optional(types.boolean()),
1873
- year: types.optional(types.string()),
1874
- countryCode: types.optional(types.string()),
1875
- countryName: types.optional(types.string()),
1876
- stateCode: types.optional(types.string()),
1877
- stateName: types.optional(types.string()),
1878
- sides: types.optional(
1879
- z.array(z.lazy(() => GetJourneyStateSide$inboundSchema)),
1880
- ),
1881
- });
1882
-
1883
- export function getJourneyStateClassificationFromJSON(
1884
- jsonString: string,
1885
- ): SafeParseResult<GetJourneyStateClassification, SDKValidationError> {
1886
- return safeParse(
1887
- jsonString,
1888
- (x) => GetJourneyStateClassification$inboundSchema.parse(JSON.parse(x)),
1889
- `Failed to parse 'GetJourneyStateClassification' from JSON`,
1890
- );
1891
- }
1892
-
1893
- /** @internal */
1894
- export const GetJourneyStateAggregatedFieldBoundingBox$inboundSchema:
1895
- z.ZodMiniType<GetJourneyStateAggregatedFieldBoundingBox, unknown> = z.object({
1896
- x: types.number(),
1897
- y: types.number(),
1898
- width: types.number(),
1899
- height: types.number(),
1900
- });
1901
-
1902
- export function getJourneyStateAggregatedFieldBoundingBoxFromJSON(
1903
- jsonString: string,
1904
- ): SafeParseResult<
1905
- GetJourneyStateAggregatedFieldBoundingBox,
1906
- SDKValidationError
1907
- > {
1908
- return safeParse(
1909
- jsonString,
1910
- (x) =>
1911
- GetJourneyStateAggregatedFieldBoundingBox$inboundSchema.parse(
1912
- JSON.parse(x),
1913
- ),
1914
- `Failed to parse 'GetJourneyStateAggregatedFieldBoundingBox' from JSON`,
1915
- );
1916
- }
1917
-
1918
- /** @internal */
1919
- export const GetJourneyStateAggregatedFieldRegionOfInterest$inboundSchema:
1920
- z.ZodMiniType<GetJourneyStateAggregatedFieldRegionOfInterest, unknown> = z
1921
- .object({
1922
- boundingBox: types.optional(
1923
- z.lazy(() => GetJourneyStateAggregatedFieldBoundingBox$inboundSchema),
1924
- ),
1925
- side: types.string(),
1926
- spectrum: types.optional(types.string()),
1927
- imageId: types.optional(types.string()),
1928
- });
1929
-
1930
- export function getJourneyStateAggregatedFieldRegionOfInterestFromJSON(
1931
- jsonString: string,
1932
- ): SafeParseResult<
1933
- GetJourneyStateAggregatedFieldRegionOfInterest,
1934
- SDKValidationError
1935
- > {
1936
- return safeParse(
1937
- jsonString,
1938
- (x) =>
1939
- GetJourneyStateAggregatedFieldRegionOfInterest$inboundSchema.parse(
1940
- JSON.parse(x),
1941
- ),
1942
- `Failed to parse 'GetJourneyStateAggregatedFieldRegionOfInterest' from JSON`,
1943
- );
1944
- }
1945
-
1946
- /** @internal */
1947
- export const GetJourneyStateAggregatedField$inboundSchema: z.ZodMiniType<
1948
- GetJourneyStateAggregatedField,
1949
- unknown
1950
- > = z.object({
1951
- label: types.string(),
1952
- value: types.string(),
1953
- source: types.string(),
1954
- isNonLatin: types.boolean(),
1955
- regionOfInterest: types.optional(
1956
- z.lazy(() => GetJourneyStateAggregatedFieldRegionOfInterest$inboundSchema),
1957
- ),
1958
- });
1959
-
1960
- export function getJourneyStateAggregatedFieldFromJSON(
1961
- jsonString: string,
1962
- ): SafeParseResult<GetJourneyStateAggregatedField, SDKValidationError> {
1963
- return safeParse(
1964
- jsonString,
1965
- (x) => GetJourneyStateAggregatedField$inboundSchema.parse(JSON.parse(x)),
1966
- `Failed to parse 'GetJourneyStateAggregatedField' from JSON`,
1967
- );
1968
- }
1969
-
1970
- /** @internal */
1971
- export const GetJourneyStateDetailBoundingBox$inboundSchema: z.ZodMiniType<
1972
- GetJourneyStateDetailBoundingBox,
1973
- unknown
1974
- > = z.object({
1975
- x: types.number(),
1976
- y: types.number(),
1977
- width: types.number(),
1978
- height: types.number(),
1979
- });
1980
-
1981
- export function getJourneyStateDetailBoundingBoxFromJSON(
1982
- jsonString: string,
1983
- ): SafeParseResult<GetJourneyStateDetailBoundingBox, SDKValidationError> {
1984
- return safeParse(
1985
- jsonString,
1986
- (x) => GetJourneyStateDetailBoundingBox$inboundSchema.parse(JSON.parse(x)),
1987
- `Failed to parse 'GetJourneyStateDetailBoundingBox' from JSON`,
1988
- );
1989
- }
1990
-
1991
- /** @internal */
1992
- export const GetJourneyStateDetailRegionOfInterest$inboundSchema: z.ZodMiniType<
1993
- GetJourneyStateDetailRegionOfInterest,
1994
- unknown
1995
- > = z.object({
1996
- boundingBox: types.optional(
1997
- z.lazy(() => GetJourneyStateDetailBoundingBox$inboundSchema),
1998
- ),
1999
- side: types.string(),
2000
- spectrum: types.optional(types.string()),
2001
- imageId: types.optional(types.string()),
2002
- });
2003
-
2004
- export function getJourneyStateDetailRegionOfInterestFromJSON(
2005
- jsonString: string,
2006
- ): SafeParseResult<GetJourneyStateDetailRegionOfInterest, SDKValidationError> {
2007
- return safeParse(
2008
- jsonString,
2009
- (x) =>
2010
- GetJourneyStateDetailRegionOfInterest$inboundSchema.parse(JSON.parse(x)),
2011
- `Failed to parse 'GetJourneyStateDetailRegionOfInterest' from JSON`,
2012
- );
2013
- }
2014
-
2015
- /** @internal */
2016
- export const GetJourneyStateDetail$inboundSchema: z.ZodMiniType<
2017
- GetJourneyStateDetail,
2018
- unknown
2019
- > = z.object({
2020
- label: types.string(),
2021
- value: types.string(),
2022
- source: types.string(),
2023
- isNonLatin: types.boolean(),
2024
- regionOfInterest: types.optional(
2025
- z.lazy(() => GetJourneyStateDetailRegionOfInterest$inboundSchema),
2026
- ),
2027
- });
2028
-
2029
- export function getJourneyStateDetailFromJSON(
2030
- jsonString: string,
2031
- ): SafeParseResult<GetJourneyStateDetail, SDKValidationError> {
2032
- return safeParse(
2033
- jsonString,
2034
- (x) => GetJourneyStateDetail$inboundSchema.parse(JSON.parse(x)),
2035
- `Failed to parse 'GetJourneyStateDetail' from JSON`,
2036
- );
2037
- }
2038
-
2039
- /** @internal */
2040
- export const GetJourneyStateExtractedField$inboundSchema: z.ZodMiniType<
2041
- GetJourneyStateExtractedField,
2042
- unknown
2043
- > = z.object({
2044
- label: types.string(),
2045
- details: z.array(z.lazy(() => GetJourneyStateDetail$inboundSchema)),
2046
- });
2047
-
2048
- export function getJourneyStateExtractedFieldFromJSON(
2049
- jsonString: string,
2050
- ): SafeParseResult<GetJourneyStateExtractedField, SDKValidationError> {
2051
- return safeParse(
2052
- jsonString,
2053
- (x) => GetJourneyStateExtractedField$inboundSchema.parse(JSON.parse(x)),
2054
- `Failed to parse 'GetJourneyStateExtractedField' from JSON`,
2055
- );
2056
- }
2057
-
2058
- /** @internal */
2059
- export const GetJourneyStateExtractedImage$inboundSchema: z.ZodMiniType<
2060
- GetJourneyStateExtractedImage,
2061
- unknown
2062
- > = z.object({
2063
- label: types.string(),
2064
- side: types.string(),
2065
- imageID: types.string(),
2066
- });
2067
-
2068
- export function getJourneyStateExtractedImageFromJSON(
2069
- jsonString: string,
2070
- ): SafeParseResult<GetJourneyStateExtractedImage, SDKValidationError> {
2071
- return safeParse(
2072
- jsonString,
2073
- (x) => GetJourneyStateExtractedImage$inboundSchema.parse(JSON.parse(x)),
2074
- `Failed to parse 'GetJourneyStateExtractedImage' from JSON`,
2075
- );
2076
- }
2077
-
2078
- /** @internal */
2079
- export const GetJourneyStateExtraction$inboundSchema: z.ZodMiniType<
2080
- GetJourneyStateExtraction,
2081
- unknown
2082
- > = z.object({
2083
- aggregatedFields: types.optional(
2084
- z.array(z.lazy(() => GetJourneyStateAggregatedField$inboundSchema)),
2085
- ),
2086
- extractedFields: types.optional(
2087
- z.array(z.lazy(() => GetJourneyStateExtractedField$inboundSchema)),
2088
- ),
2089
- extractedImages: types.optional(
2090
- z.array(z.lazy(() => GetJourneyStateExtractedImage$inboundSchema)),
2091
- ),
2092
- });
2093
-
2094
- export function getJourneyStateExtractionFromJSON(
2095
- jsonString: string,
2096
- ): SafeParseResult<GetJourneyStateExtraction, SDKValidationError> {
2097
- return safeParse(
2098
- jsonString,
2099
- (x) => GetJourneyStateExtraction$inboundSchema.parse(JSON.parse(x)),
2100
- `Failed to parse 'GetJourneyStateExtraction' from JSON`,
2101
- );
2102
- }
2103
-
2104
- /** @internal */
2105
- export const GetJourneyStateValidationCheckBoundingBox$inboundSchema:
2106
- z.ZodMiniType<GetJourneyStateValidationCheckBoundingBox, unknown> = z.object({
2107
- x: types.number(),
2108
- y: types.number(),
2109
- width: types.number(),
2110
- height: types.number(),
2111
- });
2112
-
2113
- export function getJourneyStateValidationCheckBoundingBoxFromJSON(
2114
- jsonString: string,
2115
- ): SafeParseResult<
2116
- GetJourneyStateValidationCheckBoundingBox,
2117
- SDKValidationError
2118
- > {
2119
- return safeParse(
2120
- jsonString,
2121
- (x) =>
2122
- GetJourneyStateValidationCheckBoundingBox$inboundSchema.parse(
2123
- JSON.parse(x),
2124
- ),
2125
- `Failed to parse 'GetJourneyStateValidationCheckBoundingBox' from JSON`,
2126
- );
2127
- }
2128
-
2129
- /** @internal */
2130
- export const GetJourneyStateValidationCheckRegionOfInterest$inboundSchema:
2131
- z.ZodMiniType<GetJourneyStateValidationCheckRegionOfInterest, unknown> = z
2132
- .object({
2133
- boundingBox: types.optional(
2134
- z.lazy(() => GetJourneyStateValidationCheckBoundingBox$inboundSchema),
2135
- ),
2136
- side: types.string(),
2137
- spectrum: types.optional(types.string()),
2138
- imageId: types.optional(types.string()),
2139
- });
2140
-
2141
- export function getJourneyStateValidationCheckRegionOfInterestFromJSON(
2142
- jsonString: string,
2143
- ): SafeParseResult<
2144
- GetJourneyStateValidationCheckRegionOfInterest,
2145
- SDKValidationError
2146
- > {
2147
- return safeParse(
2148
- jsonString,
2149
- (x) =>
2150
- GetJourneyStateValidationCheckRegionOfInterest$inboundSchema.parse(
2151
- JSON.parse(x),
2152
- ),
2153
- `Failed to parse 'GetJourneyStateValidationCheckRegionOfInterest' from JSON`,
2154
- );
2155
- }
2156
-
2157
- /** @internal */
2158
- export const GetJourneyStateValidationCheck$inboundSchema: z.ZodMiniType<
2159
- GetJourneyStateValidationCheck,
2160
- unknown
2161
- > = z.object({
2162
- name: types.string(),
2163
- title: types.string(),
2164
- info: types.string(),
2165
- validationResult: types.string(),
2166
- resultInfo: types.string(),
2167
- weight: types.string(),
2168
- regionOfInterests: types.optional(
2169
- z.array(z.lazy(() =>
2170
- GetJourneyStateValidationCheckRegionOfInterest$inboundSchema
2171
- )),
2172
- ),
2173
- type: types.string(),
2174
- });
2175
-
2176
- export function getJourneyStateValidationCheckFromJSON(
2177
- jsonString: string,
2178
- ): SafeParseResult<GetJourneyStateValidationCheck, SDKValidationError> {
2179
- return safeParse(
2180
- jsonString,
2181
- (x) => GetJourneyStateValidationCheck$inboundSchema.parse(JSON.parse(x)),
2182
- `Failed to parse 'GetJourneyStateValidationCheck' from JSON`,
2183
- );
2184
- }
2185
-
2186
- /** @internal */
2187
- export const GetJourneyStateAggregatedValidationCheckBoundingBox$inboundSchema:
2188
- z.ZodMiniType<GetJourneyStateAggregatedValidationCheckBoundingBox, unknown> =
2189
- z.object({
2190
- x: types.number(),
2191
- y: types.number(),
2192
- width: types.number(),
2193
- height: types.number(),
2194
- });
2195
-
2196
- export function getJourneyStateAggregatedValidationCheckBoundingBoxFromJSON(
2197
- jsonString: string,
2198
- ): SafeParseResult<
2199
- GetJourneyStateAggregatedValidationCheckBoundingBox,
2200
- SDKValidationError
2201
- > {
2202
- return safeParse(
2203
- jsonString,
2204
- (x) =>
2205
- GetJourneyStateAggregatedValidationCheckBoundingBox$inboundSchema.parse(
2206
- JSON.parse(x),
2207
- ),
2208
- `Failed to parse 'GetJourneyStateAggregatedValidationCheckBoundingBox' from JSON`,
2209
- );
2210
- }
2211
-
2212
- /** @internal */
2213
- export const GetJourneyStateAggregatedValidationCheckRegionOfInterest$inboundSchema:
2214
- z.ZodMiniType<
2215
- GetJourneyStateAggregatedValidationCheckRegionOfInterest,
2216
- unknown
2217
- > = z.object({
2218
- boundingBox: types.optional(
2219
- z.lazy(() =>
2220
- GetJourneyStateAggregatedValidationCheckBoundingBox$inboundSchema
2221
- ),
2222
- ),
2223
- side: types.string(),
2224
- spectrum: types.optional(types.string()),
2225
- imageId: types.optional(types.string()),
2226
- });
2227
-
2228
- export function getJourneyStateAggregatedValidationCheckRegionOfInterestFromJSON(
2229
- jsonString: string,
2230
- ): SafeParseResult<
2231
- GetJourneyStateAggregatedValidationCheckRegionOfInterest,
2232
- SDKValidationError
2233
- > {
2234
- return safeParse(
2235
- jsonString,
2236
- (x) =>
2237
- GetJourneyStateAggregatedValidationCheckRegionOfInterest$inboundSchema
2238
- .parse(JSON.parse(x)),
2239
- `Failed to parse 'GetJourneyStateAggregatedValidationCheckRegionOfInterest' from JSON`,
2240
- );
2241
- }
2242
-
2243
- /** @internal */
2244
- export const GetJourneyStateAggregatedValidationCheck$inboundSchema:
2245
- z.ZodMiniType<GetJourneyStateAggregatedValidationCheck, unknown> = z.object({
2246
- name: types.string(),
2247
- title: types.string(),
2248
- info: types.string(),
2249
- validationResult: types.string(),
2250
- resultInfo: types.string(),
2251
- weight: types.string(),
2252
- regionOfInterests: types.optional(
2253
- z.array(z.lazy(() =>
2254
- GetJourneyStateAggregatedValidationCheckRegionOfInterest$inboundSchema
2255
- )),
2256
- ),
2257
- type: types.string(),
2258
- });
2259
-
2260
- export function getJourneyStateAggregatedValidationCheckFromJSON(
2261
- jsonString: string,
2262
- ): SafeParseResult<
2263
- GetJourneyStateAggregatedValidationCheck,
2264
- SDKValidationError
2265
- > {
2266
- return safeParse(
2267
- jsonString,
2268
- (x) =>
2269
- GetJourneyStateAggregatedValidationCheck$inboundSchema.parse(
2270
- JSON.parse(x),
2271
- ),
2272
- `Failed to parse 'GetJourneyStateAggregatedValidationCheck' from JSON`,
2273
- );
2274
- }
2275
-
2276
- /** @internal */
2277
- export const GetJourneyStateValidation$inboundSchema: z.ZodMiniType<
2278
- GetJourneyStateValidation,
2279
- unknown
2280
- > = z.object({
2281
- validationChecks: types.optional(
2282
- z.array(z.lazy(() => GetJourneyStateValidationCheck$inboundSchema)),
2283
- ),
2284
- aggregatedValidationChecks: types.optional(
2285
- z.array(
2286
- z.lazy(() => GetJourneyStateAggregatedValidationCheck$inboundSchema),
2287
- ),
2288
- ),
2289
- });
2290
-
2291
- export function getJourneyStateValidationFromJSON(
2292
- jsonString: string,
2293
- ): SafeParseResult<GetJourneyStateValidation, SDKValidationError> {
2294
- return safeParse(
2295
- jsonString,
2296
- (x) => GetJourneyStateValidation$inboundSchema.parse(JSON.parse(x)),
2297
- `Failed to parse 'GetJourneyStateValidation' from JSON`,
2298
- );
2299
- }
2300
-
2301
- /** @internal */
2302
- export const GetJourneyStateDocumentAlias$inboundSchema: z.ZodMiniType<
2303
- GetJourneyStateDocumentAlias,
2304
- unknown
2305
- > = z.object({
2306
- title: types.optional(types.string()),
2307
- firstName: types.optional(types.string()),
2308
- middleNames: types.optional(z.array(types.string())),
2309
- lastNames: types.optional(z.array(types.string())),
2310
- lastNamesAtBirth: types.optional(z.array(types.string())),
2311
- });
2312
-
2313
- export function getJourneyStateDocumentAliasFromJSON(
2314
- jsonString: string,
2315
- ): SafeParseResult<GetJourneyStateDocumentAlias, SDKValidationError> {
2316
- return safeParse(
2317
- jsonString,
2318
- (x) => GetJourneyStateDocumentAlias$inboundSchema.parse(JSON.parse(x)),
2319
- `Failed to parse 'GetJourneyStateDocumentAlias' from JSON`,
2320
- );
2321
- }
2322
-
2323
- /** @internal */
2324
- export const GetJourneyStateDocumentRelationship$inboundSchema: z.ZodMiniType<
2325
- GetJourneyStateDocumentRelationship,
2326
- unknown
2327
- > = openEnums.inboundSchema(GetJourneyStateDocumentRelationship);
2328
-
2329
- /** @internal */
2330
- export const GetJourneyStateDocumentRelatedPerson$inboundSchema: z.ZodMiniType<
2331
- GetJourneyStateDocumentRelatedPerson,
2332
- unknown
2333
- > = z.object({
2334
- title: types.optional(types.string()),
2335
- firstName: types.optional(types.string()),
2336
- middleNames: types.optional(z.array(types.string())),
2337
- lastNames: types.optional(z.array(types.string())),
2338
- lastNamesAtBirth: types.optional(z.array(types.string())),
2339
- relationship: GetJourneyStateDocumentRelationship$inboundSchema,
2340
- });
2341
-
2342
- export function getJourneyStateDocumentRelatedPersonFromJSON(
2343
- jsonString: string,
2344
- ): SafeParseResult<GetJourneyStateDocumentRelatedPerson, SDKValidationError> {
2345
- return safeParse(
2346
- jsonString,
2347
- (x) =>
2348
- GetJourneyStateDocumentRelatedPerson$inboundSchema.parse(JSON.parse(x)),
2349
- `Failed to parse 'GetJourneyStateDocumentRelatedPerson' from JSON`,
2350
- );
2351
- }
2352
-
2353
- /** @internal */
2354
- export const GetJourneyStateDocumentCurrentAddressLocation$inboundSchema:
2355
- z.ZodMiniType<GetJourneyStateDocumentCurrentAddressLocation, unknown> = z
2356
- .object({
2357
- latitude: types.optional(types.string()),
2358
- longitude: types.optional(types.string()),
2359
- geoAccuracy: types.optional(types.string()),
2360
- what3words: types.optional(types.string()),
2361
- });
2362
-
2363
- export function getJourneyStateDocumentCurrentAddressLocationFromJSON(
2364
- jsonString: string,
2365
- ): SafeParseResult<
2366
- GetJourneyStateDocumentCurrentAddressLocation,
2367
- SDKValidationError
2368
- > {
2369
- return safeParse(
2370
- jsonString,
2371
- (x) =>
2372
- GetJourneyStateDocumentCurrentAddressLocation$inboundSchema.parse(
2373
- JSON.parse(x),
2374
- ),
2375
- `Failed to parse 'GetJourneyStateDocumentCurrentAddressLocation' from JSON`,
2376
- );
2377
- }
2378
-
2379
- /** @internal */
2380
- export const GetJourneyStateDocumentCurrentAddress$inboundSchema: z.ZodMiniType<
2381
- GetJourneyStateDocumentCurrentAddress,
2382
- unknown
2383
- > = z.object({
2384
- lines: types.optional(z.array(types.string())),
2385
- addressString: types.optional(types.string()),
2386
- premise: types.optional(types.string()),
2387
- building: types.optional(types.string()),
2388
- subBuilding: types.optional(types.string()),
2389
- thoroughfare: types.optional(types.string()),
2390
- dependentThoroughfare: types.optional(types.string()),
2391
- locality: types.optional(types.string()),
2392
- dependentLocality: types.optional(types.string()),
2393
- doubleDependentLocality: types.optional(types.string()),
2394
- postalCode: types.optional(types.string()),
2395
- postBox: types.optional(types.string()),
2396
- country: types.optional(types.string()),
2397
- superAdministrativeArea: types.optional(types.string()),
2398
- administrativeArea: types.optional(types.string()),
2399
- subAdministrativeArea: types.optional(types.string()),
2400
- organization: types.optional(types.string()),
2401
- location: types.optional(
2402
- z.lazy(() => GetJourneyStateDocumentCurrentAddressLocation$inboundSchema),
2403
- ),
2404
- });
2405
-
2406
- export function getJourneyStateDocumentCurrentAddressFromJSON(
2407
- jsonString: string,
2408
- ): SafeParseResult<GetJourneyStateDocumentCurrentAddress, SDKValidationError> {
2409
- return safeParse(
2410
- jsonString,
2411
- (x) =>
2412
- GetJourneyStateDocumentCurrentAddress$inboundSchema.parse(JSON.parse(x)),
2413
- `Failed to parse 'GetJourneyStateDocumentCurrentAddress' from JSON`,
2414
- );
2415
- }
2416
-
2417
- /** @internal */
2418
- export const GetJourneyStateDocumentPreviousAddressLocation$inboundSchema:
2419
- z.ZodMiniType<GetJourneyStateDocumentPreviousAddressLocation, unknown> = z
2420
- .object({
2421
- latitude: types.optional(types.string()),
2422
- longitude: types.optional(types.string()),
2423
- geoAccuracy: types.optional(types.string()),
2424
- what3words: types.optional(types.string()),
2425
- });
2426
-
2427
- export function getJourneyStateDocumentPreviousAddressLocationFromJSON(
2428
- jsonString: string,
2429
- ): SafeParseResult<
2430
- GetJourneyStateDocumentPreviousAddressLocation,
2431
- SDKValidationError
2432
- > {
2433
- return safeParse(
2434
- jsonString,
2435
- (x) =>
2436
- GetJourneyStateDocumentPreviousAddressLocation$inboundSchema.parse(
2437
- JSON.parse(x),
2438
- ),
2439
- `Failed to parse 'GetJourneyStateDocumentPreviousAddressLocation' from JSON`,
2440
- );
2441
- }
2442
-
2443
- /** @internal */
2444
- export const GetJourneyStateDocumentPreviousAddress$inboundSchema:
2445
- z.ZodMiniType<GetJourneyStateDocumentPreviousAddress, unknown> = z.object({
2446
- lines: types.optional(z.array(types.string())),
2447
- addressString: types.optional(types.string()),
2448
- premise: types.optional(types.string()),
2449
- building: types.optional(types.string()),
2450
- subBuilding: types.optional(types.string()),
2451
- thoroughfare: types.optional(types.string()),
2452
- dependentThoroughfare: types.optional(types.string()),
2453
- locality: types.optional(types.string()),
2454
- dependentLocality: types.optional(types.string()),
2455
- doubleDependentLocality: types.optional(types.string()),
2456
- postalCode: types.optional(types.string()),
2457
- postBox: types.optional(types.string()),
2458
- country: types.optional(types.string()),
2459
- superAdministrativeArea: types.optional(types.string()),
2460
- administrativeArea: types.optional(types.string()),
2461
- subAdministrativeArea: types.optional(types.string()),
2462
- organization: types.optional(types.string()),
2463
- location: types.optional(
2464
- z.lazy(() =>
2465
- GetJourneyStateDocumentPreviousAddressLocation$inboundSchema
2466
- ),
2467
- ),
2468
- fromDate: types.string(),
2469
- toDate: types.string(),
2470
- });
2471
-
2472
- export function getJourneyStateDocumentPreviousAddressFromJSON(
2473
- jsonString: string,
2474
- ): SafeParseResult<GetJourneyStateDocumentPreviousAddress, SDKValidationError> {
2475
- return safeParse(
2476
- jsonString,
2477
- (x) =>
2478
- GetJourneyStateDocumentPreviousAddress$inboundSchema.parse(JSON.parse(x)),
2479
- `Failed to parse 'GetJourneyStateDocumentPreviousAddress' from JSON`,
2480
- );
2481
- }
2482
-
2483
- /** @internal */
2484
- export const GetJourneyStateDocumentPlaceOfBirthLocation$inboundSchema:
2485
- z.ZodMiniType<GetJourneyStateDocumentPlaceOfBirthLocation, unknown> = z
2486
- .object({
2487
- latitude: types.optional(types.string()),
2488
- longitude: types.optional(types.string()),
2489
- geoAccuracy: types.optional(types.string()),
2490
- what3words: types.optional(types.string()),
2491
- });
2492
-
2493
- export function getJourneyStateDocumentPlaceOfBirthLocationFromJSON(
2494
- jsonString: string,
2495
- ): SafeParseResult<
2496
- GetJourneyStateDocumentPlaceOfBirthLocation,
2497
- SDKValidationError
2498
- > {
2499
- return safeParse(
2500
- jsonString,
2501
- (x) =>
2502
- GetJourneyStateDocumentPlaceOfBirthLocation$inboundSchema.parse(
2503
- JSON.parse(x),
2504
- ),
2505
- `Failed to parse 'GetJourneyStateDocumentPlaceOfBirthLocation' from JSON`,
2506
- );
2507
- }
2508
-
2509
- /** @internal */
2510
- export const GetJourneyStateDocumentPlaceOfBirth$inboundSchema: z.ZodMiniType<
2511
- GetJourneyStateDocumentPlaceOfBirth,
2512
- unknown
2513
- > = z.object({
2514
- lines: types.optional(z.array(types.string())),
2515
- addressString: types.optional(types.string()),
2516
- premise: types.optional(types.string()),
2517
- building: types.optional(types.string()),
2518
- subBuilding: types.optional(types.string()),
2519
- thoroughfare: types.optional(types.string()),
2520
- dependentThoroughfare: types.optional(types.string()),
2521
- locality: types.optional(types.string()),
2522
- dependentLocality: types.optional(types.string()),
2523
- doubleDependentLocality: types.optional(types.string()),
2524
- postalCode: types.optional(types.string()),
2525
- postBox: types.optional(types.string()),
2526
- country: types.optional(types.string()),
2527
- superAdministrativeArea: types.optional(types.string()),
2528
- administrativeArea: types.optional(types.string()),
2529
- subAdministrativeArea: types.optional(types.string()),
2530
- organization: types.optional(types.string()),
2531
- location: types.optional(
2532
- z.lazy(() => GetJourneyStateDocumentPlaceOfBirthLocation$inboundSchema),
2533
- ),
2534
- });
2535
-
2536
- export function getJourneyStateDocumentPlaceOfBirthFromJSON(
2537
- jsonString: string,
2538
- ): SafeParseResult<GetJourneyStateDocumentPlaceOfBirth, SDKValidationError> {
2539
- return safeParse(
2540
- jsonString,
2541
- (x) =>
2542
- GetJourneyStateDocumentPlaceOfBirth$inboundSchema.parse(JSON.parse(x)),
2543
- `Failed to parse 'GetJourneyStateDocumentPlaceOfBirth' from JSON`,
2544
- );
2545
- }
2546
-
2547
- /** @internal */
2548
- export const GetJourneyStateDocumentIdNumber$inboundSchema: z.ZodMiniType<
2549
- GetJourneyStateDocumentIdNumber,
2550
- unknown
2551
- > = z.object({
2552
- type: types.string(),
2553
- idNumber: types.string(),
2554
- country: types.optional(types.string()),
2555
- });
2556
-
2557
- export function getJourneyStateDocumentIdNumberFromJSON(
2558
- jsonString: string,
2559
- ): SafeParseResult<GetJourneyStateDocumentIdNumber, SDKValidationError> {
2560
- return safeParse(
2561
- jsonString,
2562
- (x) => GetJourneyStateDocumentIdNumber$inboundSchema.parse(JSON.parse(x)),
2563
- `Failed to parse 'GetJourneyStateDocumentIdNumber' from JSON`,
2564
- );
2565
- }
2566
-
2567
- /** @internal */
2568
- export const GetJourneyStateDocumentPhone$inboundSchema: z.ZodMiniType<
2569
- GetJourneyStateDocumentPhone,
2570
- unknown
2571
- > = z.object({
2572
- type: types.string(),
2573
- number: types.string(),
2574
- });
2575
-
2576
- export function getJourneyStateDocumentPhoneFromJSON(
2577
- jsonString: string,
2578
- ): SafeParseResult<GetJourneyStateDocumentPhone, SDKValidationError> {
2579
- return safeParse(
2580
- jsonString,
2581
- (x) => GetJourneyStateDocumentPhone$inboundSchema.parse(JSON.parse(x)),
2582
- `Failed to parse 'GetJourneyStateDocumentPhone' from JSON`,
2583
- );
2584
- }
2585
-
2586
- /** @internal */
2587
- export const GetJourneyStateDocumentEmail$inboundSchema: z.ZodMiniType<
2588
- GetJourneyStateDocumentEmail,
2589
- unknown
2590
- > = z.object({
2591
- type: types.string(),
2592
- email: types.string(),
2593
- });
2594
-
2595
- export function getJourneyStateDocumentEmailFromJSON(
2596
- jsonString: string,
2597
- ): SafeParseResult<GetJourneyStateDocumentEmail, SDKValidationError> {
2598
- return safeParse(
2599
- jsonString,
2600
- (x) => GetJourneyStateDocumentEmail$inboundSchema.parse(JSON.parse(x)),
2601
- `Failed to parse 'GetJourneyStateDocumentEmail' from JSON`,
2602
- );
2603
- }
2604
-
2605
- /** @internal */
2606
- export const GetJourneyStateDocumentSocial$inboundSchema: z.ZodMiniType<
2607
- GetJourneyStateDocumentSocial,
2608
- unknown
2609
- > = z.object({
2610
- type: types.string(),
2611
- identity: types.string(),
2612
- });
2613
-
2614
- export function getJourneyStateDocumentSocialFromJSON(
2615
- jsonString: string,
2616
- ): SafeParseResult<GetJourneyStateDocumentSocial, SDKValidationError> {
2617
- return safeParse(
2618
- jsonString,
2619
- (x) => GetJourneyStateDocumentSocial$inboundSchema.parse(JSON.parse(x)),
2620
- `Failed to parse 'GetJourneyStateDocumentSocial' from JSON`,
2621
- );
2622
- }
2623
-
2624
- /** @internal */
2625
- export const GetJourneyStateDocumentSubject$inboundSchema: z.ZodMiniType<
2626
- GetJourneyStateDocumentSubject,
2627
- unknown
2628
- > = z.object({
2629
- title: types.optional(types.string()),
2630
- firstName: types.optional(types.string()),
2631
- middleNames: types.optional(z.array(types.string())),
2632
- lastNames: types.optional(z.array(types.string())),
2633
- lastNamesAtBirth: types.optional(z.array(types.string())),
2634
- aliases: types.optional(
2635
- z.array(z.lazy(() => GetJourneyStateDocumentAlias$inboundSchema)),
2636
- ),
2637
- relatedPersons: types.optional(
2638
- z.array(z.lazy(() => GetJourneyStateDocumentRelatedPerson$inboundSchema)),
2639
- ),
2640
- dateOfBirth: types.optional(types.string()),
2641
- gender: types.optional(types.string()),
2642
- currentAddress: types.optional(
2643
- z.lazy(() => GetJourneyStateDocumentCurrentAddress$inboundSchema),
2644
- ),
2645
- previousAddresses: types.optional(
2646
- z.array(z.lazy(() => GetJourneyStateDocumentPreviousAddress$inboundSchema)),
2647
- ),
2648
- placeOfBirth: types.optional(
2649
- z.lazy(() => GetJourneyStateDocumentPlaceOfBirth$inboundSchema),
2650
- ),
2651
- idNumbers: types.optional(
2652
- z.array(z.lazy(() => GetJourneyStateDocumentIdNumber$inboundSchema)),
2653
- ),
2654
- phones: types.optional(
2655
- z.array(z.lazy(() => GetJourneyStateDocumentPhone$inboundSchema)),
2656
- ),
2657
- emails: types.optional(
2658
- z.array(z.lazy(() => GetJourneyStateDocumentEmail$inboundSchema)),
2659
- ),
2660
- socials: types.optional(
2661
- z.array(z.lazy(() => GetJourneyStateDocumentSocial$inboundSchema)),
2662
- ),
2663
- mothersMaidenName: types.optional(types.string()),
2664
- });
2665
-
2666
- export function getJourneyStateDocumentSubjectFromJSON(
2667
- jsonString: string,
2668
- ): SafeParseResult<GetJourneyStateDocumentSubject, SDKValidationError> {
2669
- return safeParse(
2670
- jsonString,
2671
- (x) => GetJourneyStateDocumentSubject$inboundSchema.parse(JSON.parse(x)),
2672
- `Failed to parse 'GetJourneyStateDocumentSubject' from JSON`,
2673
- );
2674
- }
2675
-
2676
- /** @internal */
2677
- export const GetJourneyStateDocument$inboundSchema: z.ZodMiniType<
2678
- GetJourneyStateDocument,
2679
- unknown
2680
- > = z.object({
2681
- oneDBarcode: types.optional(types.string()),
2682
- address: types.optional(z.lazy(() => GetJourneyStateAddress$inboundSchema)),
2683
- applicationDate: types.optional(types.string()),
2684
- applicationNumber: types.optional(types.string()),
2685
- dateOfBirth: types.optional(types.string()),
2686
- placeOfBirth: types.optional(types.string()),
2687
- placeOfBirthNative: types.optional(types.string()),
2688
- bloodType: types.optional(types.string()),
2689
- controlNumber: types.optional(types.string()),
2690
- countryCode: types.optional(types.string()),
2691
- countryName: types.optional(types.string()),
2692
- documentClassCode: types.optional(types.string()),
2693
- documentClassName: types.optional(types.string()),
2694
- documentNumber: types.optional(types.string()),
2695
- documentSignerCertificate: types.optional(types.string()),
2696
- employer: types.optional(types.string()),
2697
- employerAddress: types.optional(types.string()),
2698
- entries: types.optional(types.string()),
2699
- expirationDate: types.optional(types.string()),
2700
- eyeColor: types.optional(types.string()),
2701
- fathersName: types.optional(types.string()),
2702
- fathersNameNative: types.optional(types.string()),
2703
- fathersSurname: types.optional(types.string()),
2704
- firstName: types.optional(types.string()),
2705
- fullName: types.optional(types.string()),
2706
- fullNameNative: types.optional(types.string()),
2707
- givenName: types.optional(types.string()),
2708
- givenNameNative: types.optional(types.string()),
2709
- hairColor: types.optional(types.string()),
2710
- height: types.optional(types.string()),
2711
- issueDate: types.optional(types.string()),
2712
- issuingAuthority: types.optional(types.string()),
2713
- issuingAuthorityNative: types.optional(types.string()),
2714
- issuingStateCode: types.optional(types.string()),
2715
- issuingStateName: types.optional(types.string()),
2716
- licenseClass: types.optional(types.string()),
2717
- licenseEndorsements: types.optional(types.string()),
2718
- licenseRestrictions: types.optional(types.string()),
2719
- mrz: types.optional(types.string()),
2720
- mrz1: types.optional(types.string()),
2721
- mrz2: types.optional(types.string()),
2722
- mrz3: types.optional(types.string()),
2723
- middleName: types.optional(types.string()),
2724
- mothersName: types.optional(types.string()),
2725
- mothersNameNative: types.optional(types.string()),
2726
- mothersSurname: types.optional(types.string()),
2727
- nameSuffix: types.optional(types.string()),
2728
- nationalityCode: types.optional(types.string()),
2729
- nationalityName: types.optional(types.string()),
2730
- nationalityNameNative: types.optional(types.string()),
2731
- occupation: types.optional(types.string()),
2732
- organDonor: types.optional(types.boolean()),
2733
- passportNumber: types.optional(types.string()),
2734
- permitNumber: types.optional(types.string()),
2735
- personalNumber: types.optional(types.string()),
2736
- photo: types.optional(types.string()),
2737
- photoCompressed: types.optional(types.string()),
2738
- photoEncoding: types.optional(types.string()),
2739
- sex: types.optional(types.string()),
2740
- sexNative: types.optional(types.string()),
2741
- signature: types.optional(types.string()),
2742
- signatureCompressed: types.optional(types.string()),
2743
- signatureEncoding: types.optional(types.string()),
2744
- socialSecurityNumber: types.optional(types.string()),
2745
- startDate: types.optional(types.string()),
2746
- surname: types.optional(types.string()),
2747
- surnameNative: types.optional(types.string()),
2748
- visaClass: types.optional(types.string()),
2749
- visaNumber: types.optional(types.string()),
2750
- weight: types.optional(types.string()),
2751
- cardNumber: types.optional(types.string()),
2752
- issuerCountryCode: types.optional(types.string()),
2753
- id: types.optional(types.string()),
2754
- type: types.optional(types.string()),
2755
- category: types.optional(types.string()),
2756
- subtype: types.optional(types.string()),
2757
- format: types.optional(types.string()),
2758
- device: types.optional(
2759
- z.lazy(() => GetJourneyStateDocumentDevice$inboundSchema),
2760
- ),
2761
- side1Image: types.optional(types.string()),
2762
- side2Image: types.optional(types.string()),
2763
- chip: types.optional(z.lazy(() => GetJourneyStateChip$inboundSchema)),
2764
- classification: types.optional(
2765
- z.lazy(() => GetJourneyStateClassification$inboundSchema),
2766
- ),
2767
- extraction: types.optional(
2768
- z.lazy(() => GetJourneyStateExtraction$inboundSchema),
2769
- ),
2770
- validation: types.optional(
2771
- z.lazy(() => GetJourneyStateValidation$inboundSchema),
2772
- ),
2773
- subType: types.optional(types.string()),
2774
- number: types.optional(types.string()),
2775
- expiryDate: types.optional(types.string()),
2776
- subject: types.optional(
2777
- z.lazy(() => GetJourneyStateDocumentSubject$inboundSchema),
2778
- ),
2779
- country: types.optional(types.string()),
2780
- });
2781
-
2782
- export function getJourneyStateDocumentFromJSON(
2783
- jsonString: string,
2784
- ): SafeParseResult<GetJourneyStateDocument, SDKValidationError> {
2785
- return safeParse(
2786
- jsonString,
2787
- (x) => GetJourneyStateDocument$inboundSchema.parse(JSON.parse(x)),
2788
- `Failed to parse 'GetJourneyStateDocument' from JSON`,
2789
- );
2790
- }
2791
-
2792
- /** @internal */
2793
- export const GetJourneyStateBiometric4$inboundSchema: z.ZodMiniType<
2794
- GetJourneyStateBiometric4,
2795
- unknown
2796
- > = z.object({
2797
- id: types.optional(types.string()),
2798
- type: types.optional(types.string()),
2799
- selfieImage: types.string(),
2800
- selfieImageEncryption: types.optional(types.boolean()),
2801
- });
2802
-
2803
- export function getJourneyStateBiometric4FromJSON(
2804
- jsonString: string,
2805
- ): SafeParseResult<GetJourneyStateBiometric4, SDKValidationError> {
2806
- return safeParse(
2807
- jsonString,
2808
- (x) => GetJourneyStateBiometric4$inboundSchema.parse(JSON.parse(x)),
2809
- `Failed to parse 'GetJourneyStateBiometric4' from JSON`,
2810
- );
2811
- }
2812
-
2813
- /** @internal */
2814
- export const GetJourneyStateBiometric3$inboundSchema: z.ZodMiniType<
2815
- GetJourneyStateBiometric3,
2816
- unknown
2817
- > = z.object({
2818
- id: types.optional(types.string()),
2819
- type: types.optional(types.string()),
2820
- faceImage: types.string(),
2821
- });
2822
-
2823
- export function getJourneyStateBiometric3FromJSON(
2824
- jsonString: string,
2825
- ): SafeParseResult<GetJourneyStateBiometric3, SDKValidationError> {
2826
- return safeParse(
2827
- jsonString,
2828
- (x) => GetJourneyStateBiometric3$inboundSchema.parse(JSON.parse(x)),
2829
- `Failed to parse 'GetJourneyStateBiometric3' from JSON`,
2830
- );
2831
- }
2832
-
2833
- /** @internal */
2834
- export const GetJourneyStateBiometric2$inboundSchema: z.ZodMiniType<
2835
- GetJourneyStateBiometric2,
2836
- unknown
2837
- > = z.object({
2838
- id: types.optional(types.string()),
2839
- type: types.optional(types.string()),
2840
- selfieImage: types.string(),
2841
- anchorImage: types.string(),
2842
- });
2843
-
2844
- export function getJourneyStateBiometric2FromJSON(
2845
- jsonString: string,
2846
- ): SafeParseResult<GetJourneyStateBiometric2, SDKValidationError> {
2847
- return safeParse(
2848
- jsonString,
2849
- (x) => GetJourneyStateBiometric2$inboundSchema.parse(JSON.parse(x)),
2850
- `Failed to parse 'GetJourneyStateBiometric2' from JSON`,
2851
- );
2852
- }
2853
-
2854
- /** @internal */
2855
- export const GetJourneyStateBiometric1$inboundSchema: z.ZodMiniType<
2856
- GetJourneyStateBiometric1,
2857
- unknown
2858
- > = z.object({
2859
- id: types.optional(types.string()),
2860
- type: types.optional(types.string()),
2861
- face1Image: types.string(),
2862
- face2Image: types.string(),
2863
- });
2864
-
2865
- export function getJourneyStateBiometric1FromJSON(
2866
- jsonString: string,
2867
- ): SafeParseResult<GetJourneyStateBiometric1, SDKValidationError> {
2868
- return safeParse(
2869
- jsonString,
2870
- (x) => GetJourneyStateBiometric1$inboundSchema.parse(JSON.parse(x)),
2871
- `Failed to parse 'GetJourneyStateBiometric1' from JSON`,
2872
- );
2873
- }
2874
-
2875
- /** @internal */
2876
- export const GetJourneyStateBiometricUnion$inboundSchema: z.ZodMiniType<
2877
- GetJourneyStateBiometricUnion,
2878
- unknown
2879
- > = smartUnion([
2880
- z.lazy(() => GetJourneyStateBiometric1$inboundSchema),
2881
- z.lazy(() => GetJourneyStateBiometric2$inboundSchema),
2882
- z.lazy(() => GetJourneyStateBiometric3$inboundSchema),
2883
- z.lazy(() => GetJourneyStateBiometric4$inboundSchema),
2884
- ]);
2885
-
2886
- export function getJourneyStateBiometricUnionFromJSON(
2887
- jsonString: string,
2888
- ): SafeParseResult<GetJourneyStateBiometricUnion, SDKValidationError> {
2889
- return safeParse(
2890
- jsonString,
2891
- (x) => GetJourneyStateBiometricUnion$inboundSchema.parse(JSON.parse(x)),
2892
- `Failed to parse 'GetJourneyStateBiometricUnion' from JSON`,
2893
- );
2894
- }
2895
-
2896
- /** @internal */
2897
- export const GetJourneyStateUser$inboundSchema: z.ZodMiniType<
2898
- GetJourneyStateUser,
2899
- unknown
2900
- > = z.object({
2901
- id: types.string(),
2902
- email: types.string(),
2903
- domain: types.string(),
2904
- });
2905
-
2906
- export function getJourneyStateUserFromJSON(
2907
- jsonString: string,
2908
- ): SafeParseResult<GetJourneyStateUser, SDKValidationError> {
2909
- return safeParse(
2910
- jsonString,
2911
- (x) => GetJourneyStateUser$inboundSchema.parse(JSON.parse(x)),
2912
- `Failed to parse 'GetJourneyStateUser' from JSON`,
2913
- );
2914
- }
2915
-
2916
- /** @internal */
2917
- export const GetJourneyStateClient$inboundSchema: z.ZodMiniType<
2918
- GetJourneyStateClient,
2919
- unknown
2920
- > = z.object({
2921
- id: types.string(),
2922
- ip: types.string(),
2923
- address: types.string(),
2924
- });
2925
-
2926
- export function getJourneyStateClientFromJSON(
2927
- jsonString: string,
2928
- ): SafeParseResult<GetJourneyStateClient, SDKValidationError> {
2929
- return safeParse(
2930
- jsonString,
2931
- (x) => GetJourneyStateClient$inboundSchema.parse(JSON.parse(x)),
2932
- `Failed to parse 'GetJourneyStateClient' from JSON`,
2933
- );
2934
- }
2935
-
2936
- /** @internal */
2937
- export const GetJourneyStateModel$inboundSchema: z.ZodMiniType<
2938
- GetJourneyStateModel,
2939
- unknown
2940
- > = z.object({
2941
- identifier: types.string(),
2942
- name: types.string(),
2943
- });
2944
-
2945
- export function getJourneyStateModelFromJSON(
2946
- jsonString: string,
2947
- ): SafeParseResult<GetJourneyStateModel, SDKValidationError> {
2948
- return safeParse(
2949
- jsonString,
2950
- (x) => GetJourneyStateModel$inboundSchema.parse(JSON.parse(x)),
2951
- `Failed to parse 'GetJourneyStateModel' from JSON`,
2952
- );
2953
- }
2954
-
2955
- /** @internal */
2956
- export const GetJourneyStateSessionDevice$inboundSchema: z.ZodMiniType<
2957
- GetJourneyStateSessionDevice,
2958
- unknown
2959
- > = z.object({
2960
- id: types.string(),
2961
- manufacturer: types.string(),
2962
- model: z.lazy(() => GetJourneyStateModel$inboundSchema),
2963
- });
2964
-
2965
- export function getJourneyStateSessionDeviceFromJSON(
2966
- jsonString: string,
2967
- ): SafeParseResult<GetJourneyStateSessionDevice, SDKValidationError> {
2968
- return safeParse(
2969
- jsonString,
2970
- (x) => GetJourneyStateSessionDevice$inboundSchema.parse(JSON.parse(x)),
2971
- `Failed to parse 'GetJourneyStateSessionDevice' from JSON`,
2972
- );
2973
- }
2974
-
2975
- /** @internal */
2976
- export const GetJourneyStateTrace$inboundSchema: z.ZodMiniType<
2977
- GetJourneyStateTrace,
2978
- unknown
2979
- > = z.object({
2980
- id: types.string(),
2981
- });
2982
-
2983
- export function getJourneyStateTraceFromJSON(
2984
- jsonString: string,
2985
- ): SafeParseResult<GetJourneyStateTrace, SDKValidationError> {
2986
- return safeParse(
2987
- jsonString,
2988
- (x) => GetJourneyStateTrace$inboundSchema.parse(JSON.parse(x)),
2989
- `Failed to parse 'GetJourneyStateTrace' from JSON`,
2990
- );
2991
- }
2992
-
2993
- /** @internal */
2994
- export const GetJourneyStateSpan$inboundSchema: z.ZodMiniType<
2995
- GetJourneyStateSpan,
2996
- unknown
2997
- > = z.object({
2998
- id: types.string(),
2999
- });
3000
-
3001
- export function getJourneyStateSpanFromJSON(
3002
- jsonString: string,
3003
- ): SafeParseResult<GetJourneyStateSpan, SDKValidationError> {
3004
- return safeParse(
3005
- jsonString,
3006
- (x) => GetJourneyStateSpan$inboundSchema.parse(JSON.parse(x)),
3007
- `Failed to parse 'GetJourneyStateSpan' from JSON`,
3008
- );
3009
- }
3010
-
3011
- /** @internal */
3012
- export const GetJourneyStateTransaction$inboundSchema: z.ZodMiniType<
3013
- GetJourneyStateTransaction,
3014
- unknown
3015
- > = z.object({
3016
- id: types.string(),
3017
- });
3018
-
3019
- export function getJourneyStateTransactionFromJSON(
3020
- jsonString: string,
3021
- ): SafeParseResult<GetJourneyStateTransaction, SDKValidationError> {
3022
- return safeParse(
3023
- jsonString,
3024
- (x) => GetJourneyStateTransaction$inboundSchema.parse(JSON.parse(x)),
3025
- `Failed to parse 'GetJourneyStateTransaction' from JSON`,
3026
- );
3027
- }
3028
-
3029
- /** @internal */
3030
- export const GetJourneyStateSessionAuth$inboundSchema: z.ZodMiniType<
3031
- GetJourneyStateSessionAuth,
3032
- unknown
3033
- > = z.object({
3034
- id: types.string(),
3035
- scope: types.optional(types.string()),
3036
- codeVerifier: types.optional(types.string()),
3037
- code: types.optional(types.string()),
3038
- state: types.optional(types.string()),
3039
- redirectUri: types.optional(types.string()),
3040
- responseType: types.optional(types.string()),
3041
- clientId: types.optional(types.string()),
3042
- clientSecret: types.optional(types.string()),
3043
- });
3044
-
3045
- export function getJourneyStateSessionAuthFromJSON(
3046
- jsonString: string,
3047
- ): SafeParseResult<GetJourneyStateSessionAuth, SDKValidationError> {
3048
- return safeParse(
3049
- jsonString,
3050
- (x) => GetJourneyStateSessionAuth$inboundSchema.parse(JSON.parse(x)),
3051
- `Failed to parse 'GetJourneyStateSessionAuth' from JSON`,
3052
- );
3053
- }
3054
-
3055
- /** @internal */
3056
- export const GetJourneyStateSession$inboundSchema: z.ZodMiniType<
3057
- GetJourneyStateSession,
3058
- unknown
3059
- > = z.object({
3060
- user: types.optional(z.lazy(() => GetJourneyStateUser$inboundSchema)),
3061
- client: types.optional(z.lazy(() => GetJourneyStateClient$inboundSchema)),
3062
- device: types.optional(
3063
- z.lazy(() => GetJourneyStateSessionDevice$inboundSchema),
3064
- ),
3065
- trace: types.optional(z.lazy(() => GetJourneyStateTrace$inboundSchema)),
3066
- span: types.optional(z.lazy(() => GetJourneyStateSpan$inboundSchema)),
3067
- transaction: types.optional(
3068
- z.lazy(() => GetJourneyStateTransaction$inboundSchema),
3069
- ),
3070
- auth: types.optional(
3071
- z.array(z.lazy(() => GetJourneyStateSessionAuth$inboundSchema)),
3072
- ),
3073
- });
12
+ export type GetJourneyStateRequestBody = {
13
+ /**
14
+ * Journey Instance Id, a unique identifier for a started journey instance.
15
+ */
16
+ instanceId: string;
17
+ [additionalProperties: string]: unknown;
18
+ };
3074
19
 
3075
- export function getJourneyStateSessionFromJSON(
3076
- jsonString: string,
3077
- ): SafeParseResult<GetJourneyStateSession, SDKValidationError> {
3078
- return safeParse(
3079
- jsonString,
3080
- (x) => GetJourneyStateSession$inboundSchema.parse(JSON.parse(x)),
3081
- `Failed to parse 'GetJourneyStateSession' from JSON`,
3082
- );
3083
- }
20
+ export type GetJourneyStateRequest = {
21
+ /**
22
+ * Response profile. Omit or 'full' for the full response (default, unchanged). 'slim' returns the compact, typed customer-facing shape. Any other value returns 400.
23
+ */
24
+ view?: string | undefined;
25
+ body?: GetJourneyStateRequestBody | undefined;
26
+ };
3084
27
 
3085
- /** @internal */
3086
- export const GetJourneyStateConsentType$inboundSchema: z.ZodMiniType<
3087
- GetJourneyStateConsentType,
3088
- unknown
3089
- > = openEnums.inboundSchema(GetJourneyStateConsentType);
28
+ /**
29
+ * Journey state (full by default; slim with ?view=slim)
30
+ */
31
+ export type GetJourneyStateResponse =
32
+ | models.StateFetchResponse
33
+ | models.SlimStateFetchResponse;
3090
34
 
3091
35
  /** @internal */
3092
- export const GetJourneyStateConsent$inboundSchema: z.ZodMiniType<
3093
- GetJourneyStateConsent,
3094
- unknown
3095
- > = z.object({
3096
- type: types.optional(GetJourneyStateConsentType$inboundSchema),
3097
- id: types.optional(types.string()),
3098
- version: types.optional(types.string()),
3099
- url: types.string(),
3100
- effectiveDate: types.optional(types.string()),
3101
- expiryDate: types.optional(types.string()),
3102
- terms: types.optional(types.string()),
3103
- purpose: types.optional(types.string()),
3104
- legalBasis: types.optional(types.string()),
3105
- jurisdiction: types.optional(types.string()),
3106
- subject: types.optional(types.string()),
3107
- signatory: types.optional(types.string()),
3108
- });
3109
-
3110
- export function getJourneyStateConsentFromJSON(
3111
- jsonString: string,
3112
- ): SafeParseResult<GetJourneyStateConsent, SDKValidationError> {
3113
- return safeParse(
3114
- jsonString,
3115
- (x) => GetJourneyStateConsent$inboundSchema.parse(JSON.parse(x)),
3116
- `Failed to parse 'GetJourneyStateConsent' from JSON`,
3117
- );
3118
- }
36
+ export type GetJourneyStateRequestBody$Outbound = {
37
+ instanceId: string;
38
+ [additionalProperties: string]: unknown;
39
+ };
3119
40
 
3120
41
  /** @internal */
3121
- export const GetJourneyStateAccount$inboundSchema: z.ZodMiniType<
3122
- GetJourneyStateAccount,
3123
- unknown
3124
- > = z.object({
3125
- type: types.string(),
3126
- accountNumber: types.string(),
3127
- sortCode: types.optional(types.string()),
3128
- routingNumber: types.optional(types.string()),
3129
- iban: types.optional(types.string()),
3130
- bic: types.optional(types.string()),
3131
- accountHolderName: types.optional(types.string()),
3132
- bankName: types.optional(types.string()),
3133
- country: types.optional(types.string()),
3134
- accountType: types.optional(types.string()),
3135
- });
42
+ export const GetJourneyStateRequestBody$outboundSchema: z.ZodMiniType<
43
+ GetJourneyStateRequestBody$Outbound,
44
+ GetJourneyStateRequestBody
45
+ > = z.catchall(
46
+ z.object({
47
+ instanceId: z.string(),
48
+ }),
49
+ z.any(),
50
+ );
3136
51
 
3137
- export function getJourneyStateAccountFromJSON(
3138
- jsonString: string,
3139
- ): SafeParseResult<GetJourneyStateAccount, SDKValidationError> {
3140
- return safeParse(
3141
- jsonString,
3142
- (x) => GetJourneyStateAccount$inboundSchema.parse(JSON.parse(x)),
3143
- `Failed to parse 'GetJourneyStateAccount' from JSON`,
52
+ export function getJourneyStateRequestBodyToJSON(
53
+ getJourneyStateRequestBody: GetJourneyStateRequestBody,
54
+ ): string {
55
+ return JSON.stringify(
56
+ GetJourneyStateRequestBody$outboundSchema.parse(getJourneyStateRequestBody),
3144
57
  );
3145
58
  }
3146
59
 
3147
60
  /** @internal */
3148
- export const GetJourneyStateSubject$inboundSchema: z.ZodMiniType<
3149
- GetJourneyStateSubject,
3150
- unknown
3151
- > = z.object({
3152
- identity: types.optional(z.lazy(() => GetJourneyStateIdentity$inboundSchema)),
3153
- documents: types.optional(
3154
- z.array(z.lazy(() => GetJourneyStateDocument$inboundSchema)),
3155
- ),
3156
- biometrics: types.optional(
3157
- z.array(smartUnion([
3158
- z.lazy(() => GetJourneyStateBiometric1$inboundSchema),
3159
- z.lazy(() =>
3160
- GetJourneyStateBiometric2$inboundSchema
3161
- ),
3162
- z.lazy(() => GetJourneyStateBiometric3$inboundSchema),
3163
- z.lazy(() => GetJourneyStateBiometric4$inboundSchema),
3164
- ])),
3165
- ),
3166
- sessions: types.optional(
3167
- z.array(z.lazy(() => GetJourneyStateSession$inboundSchema)),
3168
- ),
3169
- consent: types.optional(
3170
- z.array(z.lazy(() => GetJourneyStateConsent$inboundSchema)),
3171
- ),
3172
- accounts: types.optional(
3173
- z.array(z.lazy(() => GetJourneyStateAccount$inboundSchema)),
3174
- ),
3175
- uid: types.optional(types.string()),
3176
- });
3177
-
3178
- export function getJourneyStateSubjectFromJSON(
3179
- jsonString: string,
3180
- ): SafeParseResult<GetJourneyStateSubject, SDKValidationError> {
3181
- return safeParse(
3182
- jsonString,
3183
- (x) => GetJourneyStateSubject$inboundSchema.parse(JSON.parse(x)),
3184
- `Failed to parse 'GetJourneyStateSubject' from JSON`,
3185
- );
3186
- }
61
+ export type GetJourneyStateRequest$Outbound = {
62
+ view?: string | undefined;
63
+ body?: GetJourneyStateRequestBody$Outbound | undefined;
64
+ };
3187
65
 
3188
66
  /** @internal */
3189
- export const GetJourneyStateContext$inboundSchema: z.ZodMiniType<
3190
- GetJourneyStateContext,
3191
- unknown
67
+ export const GetJourneyStateRequest$outboundSchema: z.ZodMiniType<
68
+ GetJourneyStateRequest$Outbound,
69
+ GetJourneyStateRequest
3192
70
  > = z.object({
3193
- subject: z.lazy(() => GetJourneyStateSubject$inboundSchema),
71
+ view: z.optional(z.string()),
72
+ body: z.optional(z.lazy(() => GetJourneyStateRequestBody$outboundSchema)),
3194
73
  });
3195
74
 
3196
- export function getJourneyStateContextFromJSON(
3197
- jsonString: string,
3198
- ): SafeParseResult<GetJourneyStateContext, SDKValidationError> {
3199
- return safeParse(
3200
- jsonString,
3201
- (x) => GetJourneyStateContext$inboundSchema.parse(JSON.parse(x)),
3202
- `Failed to parse 'GetJourneyStateContext' from JSON`,
75
+ export function getJourneyStateRequestToJSON(
76
+ getJourneyStateRequest: GetJourneyStateRequest,
77
+ ): string {
78
+ return JSON.stringify(
79
+ GetJourneyStateRequest$outboundSchema.parse(getJourneyStateRequest),
3203
80
  );
3204
81
  }
3205
82
 
@@ -3207,13 +84,10 @@ export function getJourneyStateContextFromJSON(
3207
84
  export const GetJourneyStateResponse$inboundSchema: z.ZodMiniType<
3208
85
  GetJourneyStateResponse,
3209
86
  unknown
3210
- > = z.object({
3211
- instanceId: types.string(),
3212
- status: GetJourneyStateStatus$inboundSchema,
3213
- metaData: types.optional(z.lazy(() => MetaData$inboundSchema)),
3214
- context: types.optional(z.lazy(() => GetJourneyStateContext$inboundSchema)),
3215
- data: types.optional(z.record(z.string(), z.any())),
3216
- });
87
+ > = smartUnion([
88
+ models.StateFetchResponse$inboundSchema,
89
+ models.SlimStateFetchResponse$inboundSchema,
90
+ ]);
3217
91
 
3218
92
  export function getJourneyStateResponseFromJSON(
3219
93
  jsonString: string,