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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (918) hide show
  1. package/FUNCTIONS.md +6 -4
  2. package/README.md +159 -59
  3. package/dist/commonjs/funcs/addresses-retrieve.d.ts +19 -0
  4. package/dist/commonjs/funcs/addresses-retrieve.d.ts.map +1 -0
  5. package/dist/commonjs/funcs/{tasks-list.js → addresses-retrieve.js} +21 -10
  6. package/dist/commonjs/funcs/addresses-retrieve.js.map +1 -0
  7. package/dist/{esm/funcs/tasks-list-schema.d.ts → commonjs/funcs/addresses-search.d.ts} +6 -6
  8. package/dist/commonjs/funcs/addresses-search.d.ts.map +1 -0
  9. package/dist/commonjs/funcs/{tasks-update.js → addresses-search.js} +21 -10
  10. package/dist/commonjs/funcs/addresses-search.js.map +1 -0
  11. package/dist/commonjs/funcs/devices-add.d.ts +5 -3
  12. package/dist/commonjs/funcs/devices-add.d.ts.map +1 -1
  13. package/dist/commonjs/funcs/devices-add.js +8 -3
  14. package/dist/commonjs/funcs/devices-add.js.map +1 -1
  15. package/dist/commonjs/funcs/devices-connect.d.ts +5 -3
  16. package/dist/commonjs/funcs/devices-connect.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/devices-connect.js +9 -5
  18. package/dist/commonjs/funcs/devices-connect.js.map +1 -1
  19. package/dist/{esm/funcs/health-get.d.ts → commonjs/funcs/devices-refresh.d.ts} +6 -5
  20. package/dist/commonjs/funcs/devices-refresh.d.ts.map +1 -0
  21. package/dist/commonjs/funcs/{health-get.js → devices-refresh.js} +16 -17
  22. package/dist/commonjs/funcs/devices-refresh.js.map +1 -0
  23. package/dist/commonjs/funcs/{health-get.d.ts → devices-validate.d.ts} +6 -4
  24. package/dist/commonjs/funcs/devices-validate.d.ts.map +1 -0
  25. package/dist/commonjs/funcs/devices-validate.js +113 -0
  26. package/dist/commonjs/funcs/devices-validate.js.map +1 -0
  27. package/dist/commonjs/funcs/instances-delete.d.ts +5 -3
  28. package/dist/commonjs/funcs/instances-delete.d.ts.map +1 -1
  29. package/dist/commonjs/funcs/instances-delete.js +8 -3
  30. package/dist/commonjs/funcs/instances-delete.js.map +1 -1
  31. package/dist/commonjs/funcs/instances-handoff-token.d.ts +19 -0
  32. package/dist/commonjs/funcs/instances-handoff-token.d.ts.map +1 -0
  33. package/dist/commonjs/funcs/instances-handoff-token.js +130 -0
  34. package/dist/commonjs/funcs/instances-handoff-token.js.map +1 -0
  35. package/dist/commonjs/funcs/interactions-fetch.d.ts +4 -3
  36. package/dist/commonjs/funcs/interactions-fetch.d.ts.map +1 -1
  37. package/dist/commonjs/funcs/interactions-fetch.js +18 -6
  38. package/dist/commonjs/funcs/interactions-fetch.js.map +1 -1
  39. package/dist/commonjs/funcs/interactions-submit.d.ts +5 -3
  40. package/dist/commonjs/funcs/interactions-submit.d.ts.map +1 -1
  41. package/dist/commonjs/funcs/interactions-submit.js +14 -3
  42. package/dist/commonjs/funcs/interactions-submit.js.map +1 -1
  43. package/dist/commonjs/funcs/interactions-upload-asset.d.ts +18 -0
  44. package/dist/commonjs/funcs/interactions-upload-asset.d.ts.map +1 -0
  45. package/dist/commonjs/funcs/interactions-upload-asset.js +119 -0
  46. package/dist/commonjs/funcs/interactions-upload-asset.js.map +1 -0
  47. package/dist/commonjs/funcs/journeys-get-schemas.d.ts +46 -0
  48. package/dist/commonjs/funcs/journeys-get-schemas.d.ts.map +1 -0
  49. package/dist/commonjs/funcs/journeys-get-schemas.js +150 -0
  50. package/dist/commonjs/funcs/journeys-get-schemas.js.map +1 -0
  51. package/dist/commonjs/funcs/journeys-get-state.d.ts +4 -3
  52. package/dist/commonjs/funcs/journeys-get-state.d.ts.map +1 -1
  53. package/dist/commonjs/funcs/journeys-get-state.js +12 -6
  54. package/dist/commonjs/funcs/journeys-get-state.js.map +1 -1
  55. package/dist/commonjs/funcs/journeys-start.d.ts +5 -3
  56. package/dist/commonjs/funcs/journeys-start.d.ts.map +1 -1
  57. package/dist/commonjs/funcs/journeys-start.js +8 -3
  58. package/dist/commonjs/funcs/journeys-start.js.map +1 -1
  59. package/dist/commonjs/funcs/journeys-terminate.d.ts +21 -0
  60. package/dist/commonjs/funcs/journeys-terminate.d.ts.map +1 -0
  61. package/dist/commonjs/funcs/{tasks-list-schema.js → journeys-terminate.js} +14 -9
  62. package/dist/commonjs/funcs/journeys-terminate.js.map +1 -0
  63. package/dist/commonjs/funcs/tasks-get-schema.d.ts +8 -3
  64. package/dist/commonjs/funcs/tasks-get-schema.d.ts.map +1 -1
  65. package/dist/commonjs/funcs/tasks-get-schema.js +9 -3
  66. package/dist/commonjs/funcs/tasks-get-schema.js.map +1 -1
  67. package/dist/commonjs/funcs/test-scenarios-create.d.ts +21 -0
  68. package/dist/commonjs/funcs/test-scenarios-create.d.ts.map +1 -0
  69. package/dist/commonjs/funcs/test-scenarios-create.js +129 -0
  70. package/dist/commonjs/funcs/test-scenarios-create.js.map +1 -0
  71. package/dist/commonjs/funcs/test-scenarios-delete.d.ts +20 -0
  72. package/dist/commonjs/funcs/test-scenarios-delete.d.ts.map +1 -0
  73. package/dist/commonjs/funcs/test-scenarios-delete.js +131 -0
  74. package/dist/commonjs/funcs/test-scenarios-delete.js.map +1 -0
  75. package/dist/commonjs/funcs/test-scenarios-get.d.ts +21 -0
  76. package/dist/commonjs/funcs/test-scenarios-get.d.ts.map +1 -0
  77. package/dist/commonjs/funcs/test-scenarios-get.js +136 -0
  78. package/dist/commonjs/funcs/test-scenarios-get.js.map +1 -0
  79. package/dist/commonjs/funcs/test-scenarios-list.d.ts +21 -0
  80. package/dist/commonjs/funcs/test-scenarios-list.d.ts.map +1 -0
  81. package/dist/commonjs/funcs/test-scenarios-list.js +132 -0
  82. package/dist/commonjs/funcs/test-scenarios-list.js.map +1 -0
  83. package/dist/commonjs/funcs/test-scenarios-put.d.ts +21 -0
  84. package/dist/commonjs/funcs/test-scenarios-put.d.ts.map +1 -0
  85. package/dist/commonjs/funcs/test-scenarios-put.js +133 -0
  86. package/dist/commonjs/funcs/test-scenarios-put.js.map +1 -0
  87. package/dist/commonjs/funcs/tokens-generate.d.ts +2 -1
  88. package/dist/commonjs/funcs/tokens-generate.d.ts.map +1 -1
  89. package/dist/commonjs/funcs/tokens-generate.js +6 -2
  90. package/dist/commonjs/funcs/tokens-generate.js.map +1 -1
  91. package/dist/commonjs/lib/config.d.ts +4 -4
  92. package/dist/commonjs/lib/config.d.ts.map +1 -1
  93. package/dist/commonjs/lib/config.js +13 -4
  94. package/dist/commonjs/lib/config.js.map +1 -1
  95. package/dist/commonjs/models/create-test-scenario-request.d.ts +29 -0
  96. package/dist/commonjs/models/create-test-scenario-request.d.ts.map +1 -0
  97. package/dist/commonjs/models/create-test-scenario-request.js +56 -0
  98. package/dist/commonjs/models/create-test-scenario-request.js.map +1 -0
  99. package/dist/commonjs/models/delete-response.d.ts +19 -0
  100. package/dist/commonjs/models/delete-response.d.ts.map +1 -0
  101. package/dist/commonjs/models/delete-response.js +57 -0
  102. package/dist/commonjs/models/delete-response.js.map +1 -0
  103. package/dist/commonjs/models/device-connect-request.d.ts +29 -0
  104. package/dist/commonjs/models/device-connect-request.d.ts.map +1 -0
  105. package/dist/commonjs/models/device-connect-request.js +59 -0
  106. package/dist/commonjs/models/device-connect-request.js.map +1 -0
  107. package/dist/commonjs/models/device-connect-response.d.ts +25 -0
  108. package/dist/commonjs/models/device-connect-response.d.ts.map +1 -0
  109. package/dist/commonjs/models/device-connect-response.js +63 -0
  110. package/dist/commonjs/models/device-connect-response.js.map +1 -0
  111. package/dist/commonjs/models/device-refresh-response.d.ts +16 -0
  112. package/dist/commonjs/models/device-refresh-response.d.ts.map +1 -0
  113. package/dist/commonjs/models/device-refresh-response.js +56 -0
  114. package/dist/commonjs/models/device-refresh-response.js.map +1 -0
  115. package/dist/commonjs/models/device-start-response.d.ts +20 -0
  116. package/dist/commonjs/models/device-start-response.d.ts.map +1 -0
  117. package/dist/commonjs/models/device-start-response.js +58 -0
  118. package/dist/commonjs/models/device-start-response.js.map +1 -0
  119. package/dist/commonjs/models/device-validate-response.d.ts +14 -0
  120. package/dist/commonjs/models/device-validate-response.d.ts.map +1 -0
  121. package/dist/commonjs/models/device-validate-response.js +54 -0
  122. package/dist/commonjs/models/device-validate-response.js.map +1 -0
  123. package/dist/commonjs/models/errors/error-response.d.ts +19 -0
  124. package/dist/commonjs/models/errors/error-response.d.ts.map +1 -0
  125. package/dist/commonjs/models/errors/error-response.js +68 -0
  126. package/dist/commonjs/models/errors/error-response.js.map +1 -0
  127. package/dist/commonjs/models/errors/index.d.ts +2 -0
  128. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  129. package/dist/commonjs/models/errors/index.js +2 -0
  130. package/dist/commonjs/models/errors/index.js.map +1 -1
  131. package/dist/commonjs/models/errors/o-auth-error-response.d.ts +32 -0
  132. package/dist/commonjs/models/errors/o-auth-error-response.d.ts.map +1 -0
  133. package/dist/commonjs/models/errors/o-auth-error-response.js +75 -0
  134. package/dist/commonjs/models/errors/o-auth-error-response.js.map +1 -0
  135. package/dist/commonjs/models/gbg-error.d.ts +28 -0
  136. package/dist/commonjs/models/gbg-error.d.ts.map +1 -0
  137. package/dist/commonjs/models/gbg-error.js +68 -0
  138. package/dist/commonjs/models/gbg-error.js.map +1 -0
  139. package/dist/commonjs/models/handoff-token-response.d.ts +20 -0
  140. package/dist/commonjs/models/handoff-token-response.d.ts.map +1 -0
  141. package/dist/commonjs/models/handoff-token-response.js +59 -0
  142. package/dist/commonjs/models/handoff-token-response.js.map +1 -0
  143. package/dist/commonjs/models/index.d.ts +33 -0
  144. package/dist/commonjs/models/index.d.ts.map +1 -1
  145. package/dist/commonjs/models/index.js +33 -0
  146. package/dist/commonjs/models/index.js.map +1 -1
  147. package/dist/commonjs/models/interaction-fetch-response.d.ts +40 -0
  148. package/dist/commonjs/models/interaction-fetch-response.d.ts.map +1 -0
  149. package/dist/commonjs/models/interaction-fetch-response.js +78 -0
  150. package/dist/commonjs/models/interaction-fetch-response.js.map +1 -0
  151. package/dist/commonjs/models/interaction-submit-response.d.ts +17 -0
  152. package/dist/commonjs/models/interaction-submit-response.d.ts.map +1 -0
  153. package/dist/commonjs/models/interaction-submit-response.js +55 -0
  154. package/dist/commonjs/models/interaction-submit-response.js.map +1 -0
  155. package/dist/commonjs/models/journey-start-response.d.ts +34 -0
  156. package/dist/commonjs/models/journey-start-response.d.ts.map +1 -0
  157. package/dist/commonjs/models/journey-start-response.js +67 -0
  158. package/dist/commonjs/models/journey-start-response.js.map +1 -0
  159. package/dist/commonjs/models/loqate-retrieve-response.d.ts +12 -0
  160. package/dist/commonjs/models/loqate-retrieve-response.d.ts.map +1 -0
  161. package/dist/commonjs/models/loqate-retrieve-response.js +55 -0
  162. package/dist/commonjs/models/loqate-retrieve-response.js.map +1 -0
  163. package/dist/commonjs/models/loqate-search-response.d.ts +12 -0
  164. package/dist/commonjs/models/loqate-search-response.d.ts.map +1 -0
  165. package/dist/commonjs/models/loqate-search-response.js +55 -0
  166. package/dist/commonjs/models/loqate-search-response.js.map +1 -0
  167. package/dist/commonjs/models/operations/add-device.d.ts +8 -92
  168. package/dist/commonjs/models/operations/add-device.d.ts.map +1 -1
  169. package/dist/commonjs/models/operations/add-device.js +6 -76
  170. package/dist/commonjs/models/operations/add-device.js.map +1 -1
  171. package/dist/commonjs/models/operations/create-handoff-token.d.ts +22 -0
  172. package/dist/commonjs/models/operations/create-handoff-token.d.ts.map +1 -0
  173. package/dist/commonjs/models/operations/create-handoff-token.js +62 -0
  174. package/dist/commonjs/models/operations/create-handoff-token.js.map +1 -0
  175. package/dist/commonjs/models/operations/create-test-scenario.d.ts +18 -0
  176. package/dist/commonjs/models/operations/create-test-scenario.d.ts.map +1 -0
  177. package/dist/commonjs/models/operations/create-test-scenario.js +51 -0
  178. package/dist/commonjs/models/operations/create-test-scenario.js.map +1 -0
  179. package/dist/commonjs/models/operations/delete-instance.d.ts +1 -14
  180. package/dist/commonjs/models/operations/delete-instance.d.ts.map +1 -1
  181. package/dist/commonjs/models/operations/delete-instance.js +3 -13
  182. package/dist/commonjs/models/operations/delete-instance.js.map +1 -1
  183. package/dist/commonjs/models/operations/delete-test-scenario.d.ts +20 -0
  184. package/dist/commonjs/models/operations/delete-test-scenario.d.ts.map +1 -0
  185. package/dist/commonjs/models/operations/delete-test-scenario.js +50 -0
  186. package/dist/commonjs/models/operations/delete-test-scenario.js.map +1 -0
  187. package/dist/commonjs/models/operations/device-connect.d.ts +0 -91
  188. package/dist/commonjs/models/operations/device-connect.d.ts.map +1 -1
  189. package/dist/commonjs/models/operations/device-connect.js +1 -69
  190. package/dist/commonjs/models/operations/device-connect.js.map +1 -1
  191. package/dist/commonjs/models/operations/device-validate.d.ts +12 -0
  192. package/dist/commonjs/models/operations/device-validate.d.ts.map +1 -0
  193. package/dist/commonjs/models/operations/device-validate.js +54 -0
  194. package/dist/commonjs/models/operations/device-validate.js.map +1 -0
  195. package/dist/commonjs/models/operations/fetch-interaction.d.ts +35 -1621
  196. package/dist/commonjs/models/operations/fetch-interaction.d.ts.map +1 -1
  197. package/dist/commonjs/models/operations/fetch-interaction.js +24 -1336
  198. package/dist/commonjs/models/operations/fetch-interaction.js.map +1 -1
  199. package/dist/commonjs/models/operations/get-journey-schemas.d.ts +16 -0
  200. package/dist/commonjs/models/operations/get-journey-schemas.d.ts.map +1 -0
  201. package/dist/commonjs/models/operations/get-journey-schemas.js +51 -0
  202. package/dist/commonjs/models/operations/get-journey-schemas.js.map +1 -0
  203. package/dist/commonjs/models/operations/get-journey-state.d.ts +19 -1383
  204. package/dist/commonjs/models/operations/get-journey-state.d.ts.map +1 -1
  205. package/dist/commonjs/models/operations/get-journey-state.js +15 -1068
  206. package/dist/commonjs/models/operations/get-journey-state.js.map +1 -1
  207. package/dist/commonjs/models/operations/get-task-schema.d.ts +1 -17
  208. package/dist/commonjs/models/operations/get-task-schema.d.ts.map +1 -1
  209. package/dist/commonjs/models/operations/get-task-schema.js +1 -19
  210. package/dist/commonjs/models/operations/get-task-schema.js.map +1 -1
  211. package/dist/commonjs/models/operations/get-test-scenario.d.ts +39 -0
  212. package/dist/commonjs/models/operations/get-test-scenario.d.ts.map +1 -0
  213. package/dist/commonjs/models/operations/get-test-scenario.js +60 -0
  214. package/dist/commonjs/models/operations/get-test-scenario.js.map +1 -0
  215. package/dist/commonjs/models/operations/index.d.ts +12 -4
  216. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  217. package/dist/commonjs/models/operations/index.js +12 -4
  218. package/dist/commonjs/models/operations/index.js.map +1 -1
  219. package/dist/commonjs/models/operations/list-test-scenarios.d.ts +34 -0
  220. package/dist/commonjs/models/operations/list-test-scenarios.d.ts.map +1 -0
  221. package/dist/commonjs/models/operations/list-test-scenarios.js +59 -0
  222. package/dist/commonjs/models/operations/list-test-scenarios.js.map +1 -0
  223. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts +2 -2
  224. package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  225. package/dist/commonjs/models/operations/post-as-token-oauth2.js +4 -5
  226. package/dist/commonjs/models/operations/post-as-token-oauth2.js.map +1 -1
  227. package/dist/commonjs/models/operations/put-test-scenario.d.ts +23 -0
  228. package/dist/commonjs/models/operations/put-test-scenario.d.ts.map +1 -0
  229. package/dist/commonjs/models/operations/put-test-scenario.js +52 -0
  230. package/dist/commonjs/models/operations/put-test-scenario.js.map +1 -0
  231. package/dist/commonjs/models/operations/retrieve-address.d.ts +29 -0
  232. package/dist/commonjs/models/operations/retrieve-address.d.ts.map +1 -0
  233. package/dist/commonjs/models/operations/retrieve-address.js +65 -0
  234. package/dist/commonjs/models/operations/retrieve-address.js.map +1 -0
  235. package/dist/commonjs/models/operations/search-addresses.d.ts +33 -0
  236. package/dist/commonjs/models/operations/search-addresses.d.ts.map +1 -0
  237. package/dist/commonjs/models/operations/search-addresses.js +67 -0
  238. package/dist/commonjs/models/operations/search-addresses.js.map +1 -0
  239. package/dist/commonjs/models/operations/start-journey.d.ts +1214 -112
  240. package/dist/commonjs/models/operations/start-journey.d.ts.map +1 -1
  241. package/dist/commonjs/models/operations/start-journey.js +602 -66
  242. package/dist/commonjs/models/operations/start-journey.js.map +1 -1
  243. package/dist/commonjs/models/operations/submit-interaction.d.ts +1074 -92
  244. package/dist/commonjs/models/operations/submit-interaction.d.ts.map +1 -1
  245. package/dist/commonjs/models/operations/submit-interaction.js +535 -51
  246. package/dist/commonjs/models/operations/submit-interaction.js.map +1 -1
  247. package/dist/commonjs/models/operations/terminate-journey.d.ts +19 -0
  248. package/dist/commonjs/models/operations/terminate-journey.d.ts.map +1 -0
  249. package/dist/commonjs/models/operations/terminate-journey.js +50 -0
  250. package/dist/commonjs/models/operations/terminate-journey.js.map +1 -0
  251. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts +26 -0
  252. package/dist/commonjs/models/operations/upload-interaction-asset.d.ts.map +1 -0
  253. package/dist/commonjs/models/operations/upload-interaction-asset.js +66 -0
  254. package/dist/commonjs/models/operations/upload-interaction-asset.js.map +1 -0
  255. package/dist/commonjs/models/outstanding-group.d.ts +15 -0
  256. package/dist/commonjs/models/outstanding-group.d.ts.map +1 -0
  257. package/dist/commonjs/models/{operations/health.js → outstanding-group.js} +11 -10
  258. package/dist/commonjs/models/outstanding-group.js.map +1 -0
  259. package/dist/commonjs/models/schema-fetch-response.d.ts +22 -0
  260. package/dist/commonjs/models/schema-fetch-response.d.ts.map +1 -0
  261. package/dist/commonjs/models/schema-fetch-response.js +62 -0
  262. package/dist/commonjs/models/schema-fetch-response.js.map +1 -0
  263. package/dist/commonjs/models/slim-document.d.ts +57 -0
  264. package/dist/commonjs/models/slim-document.d.ts.map +1 -0
  265. package/dist/commonjs/models/slim-document.js +92 -0
  266. package/dist/commonjs/models/slim-document.js.map +1 -0
  267. package/dist/commonjs/models/slim-extraction.d.ts +74 -0
  268. package/dist/commonjs/models/slim-extraction.d.ts.map +1 -0
  269. package/dist/commonjs/models/slim-extraction.js +128 -0
  270. package/dist/commonjs/models/slim-extraction.js.map +1 -0
  271. package/dist/commonjs/models/slim-identity.d.ts +202 -0
  272. package/dist/commonjs/models/slim-identity.d.ts.map +1 -0
  273. package/dist/commonjs/models/slim-identity.js +142 -0
  274. package/dist/commonjs/models/slim-identity.js.map +1 -0
  275. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts +46 -0
  276. package/dist/commonjs/models/slim-interaction-fetch-response.d.ts.map +1 -0
  277. package/dist/commonjs/models/slim-interaction-fetch-response.js +87 -0
  278. package/dist/commonjs/models/slim-interaction-fetch-response.js.map +1 -0
  279. package/dist/commonjs/models/slim-journey.d.ts +14 -0
  280. package/dist/commonjs/models/slim-journey.d.ts.map +1 -0
  281. package/dist/commonjs/models/slim-journey.js +55 -0
  282. package/dist/commonjs/models/slim-journey.js.map +1 -0
  283. package/dist/commonjs/models/slim-module-step-error.d.ts +50 -0
  284. package/dist/commonjs/models/slim-module-step-error.d.ts.map +1 -0
  285. package/dist/commonjs/models/slim-module-step-error.js +79 -0
  286. package/dist/commonjs/models/slim-module-step-error.js.map +1 -0
  287. package/dist/commonjs/models/slim-result.d.ts +49 -0
  288. package/dist/commonjs/models/slim-result.d.ts.map +1 -0
  289. package/dist/commonjs/models/slim-result.js +76 -0
  290. package/dist/commonjs/models/slim-result.js.map +1 -0
  291. package/dist/commonjs/models/slim-state-fetch-response.d.ts +27 -0
  292. package/dist/commonjs/models/slim-state-fetch-response.d.ts.map +1 -0
  293. package/dist/commonjs/models/slim-state-fetch-response.js +66 -0
  294. package/dist/commonjs/models/slim-state-fetch-response.js.map +1 -0
  295. package/dist/commonjs/models/slim-step.d.ts +40 -0
  296. package/dist/commonjs/models/slim-step.d.ts.map +1 -0
  297. package/dist/commonjs/models/slim-step.js +73 -0
  298. package/dist/commonjs/models/slim-step.js.map +1 -0
  299. package/dist/commonjs/models/slim-validation.d.ts +69 -0
  300. package/dist/commonjs/models/slim-validation.d.ts.map +1 -0
  301. package/dist/commonjs/models/slim-validation.js +121 -0
  302. package/dist/commonjs/models/slim-validation.js.map +1 -0
  303. package/dist/commonjs/models/slim-verified-data.d.ts +16 -0
  304. package/dist/commonjs/models/slim-verified-data.d.ts.map +1 -0
  305. package/dist/commonjs/models/slim-verified-data.js +53 -0
  306. package/dist/commonjs/models/slim-verified-data.js.map +1 -0
  307. package/dist/commonjs/models/state-fetch-response.d.ts +25 -0
  308. package/dist/commonjs/models/state-fetch-response.d.ts.map +1 -0
  309. package/dist/commonjs/models/state-fetch-response.js +59 -0
  310. package/dist/commonjs/models/state-fetch-response.js.map +1 -0
  311. package/dist/commonjs/models/terminate-response.d.ts +10 -0
  312. package/dist/commonjs/models/terminate-response.d.ts.map +1 -0
  313. package/dist/commonjs/models/terminate-response.js +50 -0
  314. package/dist/commonjs/models/terminate-response.js.map +1 -0
  315. package/dist/commonjs/models/test-scenario-summary.d.ts +29 -0
  316. package/dist/commonjs/models/test-scenario-summary.d.ts.map +1 -0
  317. package/dist/commonjs/models/test-scenario-summary.js +62 -0
  318. package/dist/commonjs/models/test-scenario-summary.js.map +1 -0
  319. package/dist/commonjs/models/test-scenario-written.d.ts +19 -0
  320. package/dist/commonjs/models/test-scenario-written.d.ts.map +1 -0
  321. package/dist/commonjs/models/test-scenario-written.js +57 -0
  322. package/dist/commonjs/models/test-scenario-written.js.map +1 -0
  323. package/dist/commonjs/models/test-scenario.d.ts +31 -0
  324. package/dist/commonjs/models/test-scenario.d.ts.map +1 -0
  325. package/dist/commonjs/models/test-scenario.js +62 -0
  326. package/dist/commonjs/models/test-scenario.js.map +1 -0
  327. package/dist/commonjs/models/update-test-scenario-request.d.ts +24 -0
  328. package/dist/commonjs/models/update-test-scenario-request.d.ts.map +1 -0
  329. package/dist/commonjs/models/update-test-scenario-request.js +55 -0
  330. package/dist/commonjs/models/update-test-scenario-request.js.map +1 -0
  331. package/dist/commonjs/sdk/addresses.d.ts +20 -0
  332. package/dist/commonjs/sdk/addresses.d.ts.map +1 -0
  333. package/dist/commonjs/sdk/addresses.js +32 -0
  334. package/dist/commonjs/sdk/addresses.js.map +1 -0
  335. package/dist/commonjs/sdk/devices.d.ts +21 -6
  336. package/dist/commonjs/sdk/devices.d.ts.map +1 -1
  337. package/dist/commonjs/sdk/devices.js +26 -6
  338. package/dist/commonjs/sdk/devices.js.map +1 -1
  339. package/dist/commonjs/sdk/instances.d.ts +11 -3
  340. package/dist/commonjs/sdk/instances.d.ts.map +1 -1
  341. package/dist/commonjs/sdk/instances.js +12 -2
  342. package/dist/commonjs/sdk/instances.js.map +1 -1
  343. package/dist/commonjs/sdk/interactions.d.ts +14 -6
  344. package/dist/commonjs/sdk/interactions.d.ts.map +1 -1
  345. package/dist/commonjs/sdk/interactions.js +16 -6
  346. package/dist/commonjs/sdk/interactions.js.map +1 -1
  347. package/dist/commonjs/sdk/journeys.d.ts +45 -5
  348. package/dist/commonjs/sdk/journeys.d.ts.map +1 -1
  349. package/dist/commonjs/sdk/journeys.js +49 -4
  350. package/dist/commonjs/sdk/journeys.js.map +1 -1
  351. package/dist/commonjs/sdk/sdk.d.ts +14 -11
  352. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  353. package/dist/commonjs/sdk/sdk.js +17 -13
  354. package/dist/commonjs/sdk/sdk.js.map +1 -1
  355. package/dist/commonjs/sdk/tasks.d.ts +6 -23
  356. package/dist/commonjs/sdk/tasks.d.ts.map +1 -1
  357. package/dist/commonjs/sdk/tasks.js +3 -31
  358. package/dist/commonjs/sdk/tasks.js.map +1 -1
  359. package/dist/commonjs/sdk/test-scenarios.d.ts +41 -0
  360. package/dist/commonjs/sdk/test-scenarios.d.ts.map +1 -0
  361. package/dist/commonjs/sdk/test-scenarios.js +62 -0
  362. package/dist/commonjs/sdk/test-scenarios.js.map +1 -0
  363. package/dist/commonjs/types/discriminated-union.d.ts.map +1 -1
  364. package/dist/commonjs/types/discriminated-union.js +0 -4
  365. package/dist/commonjs/types/discriminated-union.js.map +1 -1
  366. package/dist/commonjs/types/index.d.ts +0 -2
  367. package/dist/commonjs/types/index.d.ts.map +1 -1
  368. package/dist/commonjs/types/index.js +0 -2
  369. package/dist/commonjs/types/index.js.map +1 -1
  370. package/dist/commonjs/types/smart-union.d.ts.map +1 -1
  371. package/dist/commonjs/types/smart-union.js +14 -14
  372. package/dist/commonjs/types/smart-union.js.map +1 -1
  373. package/dist/esm/funcs/addresses-retrieve.d.ts +19 -0
  374. package/dist/esm/funcs/addresses-retrieve.d.ts.map +1 -0
  375. package/dist/esm/funcs/{tasks-update.js → addresses-retrieve.js} +20 -9
  376. package/dist/esm/funcs/addresses-retrieve.js.map +1 -0
  377. package/dist/{commonjs/funcs/tasks-list-schema.d.ts → esm/funcs/addresses-search.d.ts} +6 -6
  378. package/dist/esm/funcs/addresses-search.d.ts.map +1 -0
  379. package/dist/esm/funcs/{tasks-list.js → addresses-search.js} +20 -9
  380. package/dist/esm/funcs/addresses-search.js.map +1 -0
  381. package/dist/esm/funcs/devices-add.d.ts +5 -3
  382. package/dist/esm/funcs/devices-add.d.ts.map +1 -1
  383. package/dist/esm/funcs/devices-add.js +8 -3
  384. package/dist/esm/funcs/devices-add.js.map +1 -1
  385. package/dist/esm/funcs/devices-connect.d.ts +5 -3
  386. package/dist/esm/funcs/devices-connect.d.ts.map +1 -1
  387. package/dist/esm/funcs/devices-connect.js +9 -5
  388. package/dist/esm/funcs/devices-connect.js.map +1 -1
  389. package/dist/{commonjs/funcs/tasks-update.d.ts → esm/funcs/devices-refresh.d.ts} +6 -5
  390. package/dist/esm/funcs/devices-refresh.d.ts.map +1 -0
  391. package/dist/esm/funcs/{health-get.js → devices-refresh.js} +15 -16
  392. package/dist/esm/funcs/devices-refresh.js.map +1 -0
  393. package/dist/{commonjs/funcs/tasks-list.d.ts → esm/funcs/devices-validate.d.ts} +6 -4
  394. package/dist/esm/funcs/devices-validate.d.ts.map +1 -0
  395. package/dist/esm/funcs/devices-validate.js +77 -0
  396. package/dist/esm/funcs/devices-validate.js.map +1 -0
  397. package/dist/esm/funcs/instances-delete.d.ts +5 -3
  398. package/dist/esm/funcs/instances-delete.d.ts.map +1 -1
  399. package/dist/esm/funcs/instances-delete.js +8 -3
  400. package/dist/esm/funcs/instances-delete.js.map +1 -1
  401. package/dist/esm/funcs/instances-handoff-token.d.ts +19 -0
  402. package/dist/esm/funcs/instances-handoff-token.d.ts.map +1 -0
  403. package/dist/esm/funcs/instances-handoff-token.js +94 -0
  404. package/dist/esm/funcs/instances-handoff-token.js.map +1 -0
  405. package/dist/esm/funcs/interactions-fetch.d.ts +4 -3
  406. package/dist/esm/funcs/interactions-fetch.d.ts.map +1 -1
  407. package/dist/esm/funcs/interactions-fetch.js +19 -7
  408. package/dist/esm/funcs/interactions-fetch.js.map +1 -1
  409. package/dist/esm/funcs/interactions-submit.d.ts +5 -3
  410. package/dist/esm/funcs/interactions-submit.d.ts.map +1 -1
  411. package/dist/esm/funcs/interactions-submit.js +14 -3
  412. package/dist/esm/funcs/interactions-submit.js.map +1 -1
  413. package/dist/esm/funcs/interactions-upload-asset.d.ts +18 -0
  414. package/dist/esm/funcs/interactions-upload-asset.d.ts.map +1 -0
  415. package/dist/esm/funcs/interactions-upload-asset.js +83 -0
  416. package/dist/esm/funcs/interactions-upload-asset.js.map +1 -0
  417. package/dist/esm/funcs/journeys-get-schemas.d.ts +46 -0
  418. package/dist/esm/funcs/journeys-get-schemas.d.ts.map +1 -0
  419. package/dist/esm/funcs/journeys-get-schemas.js +114 -0
  420. package/dist/esm/funcs/journeys-get-schemas.js.map +1 -0
  421. package/dist/esm/funcs/journeys-get-state.d.ts +4 -3
  422. package/dist/esm/funcs/journeys-get-state.d.ts.map +1 -1
  423. package/dist/esm/funcs/journeys-get-state.js +13 -7
  424. package/dist/esm/funcs/journeys-get-state.js.map +1 -1
  425. package/dist/esm/funcs/journeys-start.d.ts +5 -3
  426. package/dist/esm/funcs/journeys-start.d.ts.map +1 -1
  427. package/dist/esm/funcs/journeys-start.js +8 -3
  428. package/dist/esm/funcs/journeys-start.js.map +1 -1
  429. package/dist/esm/funcs/journeys-terminate.d.ts +21 -0
  430. package/dist/esm/funcs/journeys-terminate.d.ts.map +1 -0
  431. package/dist/esm/funcs/{tasks-list-schema.js → journeys-terminate.js} +13 -8
  432. package/dist/esm/funcs/journeys-terminate.js.map +1 -0
  433. package/dist/esm/funcs/tasks-get-schema.d.ts +8 -3
  434. package/dist/esm/funcs/tasks-get-schema.d.ts.map +1 -1
  435. package/dist/esm/funcs/tasks-get-schema.js +9 -3
  436. package/dist/esm/funcs/tasks-get-schema.js.map +1 -1
  437. package/dist/esm/funcs/test-scenarios-create.d.ts +21 -0
  438. package/dist/esm/funcs/test-scenarios-create.d.ts.map +1 -0
  439. package/dist/esm/funcs/test-scenarios-create.js +93 -0
  440. package/dist/esm/funcs/test-scenarios-create.js.map +1 -0
  441. package/dist/esm/funcs/test-scenarios-delete.d.ts +20 -0
  442. package/dist/esm/funcs/test-scenarios-delete.d.ts.map +1 -0
  443. package/dist/esm/funcs/test-scenarios-delete.js +95 -0
  444. package/dist/esm/funcs/test-scenarios-delete.js.map +1 -0
  445. package/dist/esm/funcs/test-scenarios-get.d.ts +21 -0
  446. package/dist/esm/funcs/test-scenarios-get.d.ts.map +1 -0
  447. package/dist/esm/funcs/test-scenarios-get.js +100 -0
  448. package/dist/esm/funcs/test-scenarios-get.js.map +1 -0
  449. package/dist/esm/funcs/test-scenarios-list.d.ts +21 -0
  450. package/dist/esm/funcs/test-scenarios-list.d.ts.map +1 -0
  451. package/dist/esm/funcs/test-scenarios-list.js +96 -0
  452. package/dist/esm/funcs/test-scenarios-list.js.map +1 -0
  453. package/dist/esm/funcs/test-scenarios-put.d.ts +21 -0
  454. package/dist/esm/funcs/test-scenarios-put.d.ts.map +1 -0
  455. package/dist/esm/funcs/test-scenarios-put.js +97 -0
  456. package/dist/esm/funcs/test-scenarios-put.js.map +1 -0
  457. package/dist/esm/funcs/tokens-generate.d.ts +2 -1
  458. package/dist/esm/funcs/tokens-generate.d.ts.map +1 -1
  459. package/dist/esm/funcs/tokens-generate.js +6 -2
  460. package/dist/esm/funcs/tokens-generate.js.map +1 -1
  461. package/dist/esm/lib/config.d.ts +4 -4
  462. package/dist/esm/lib/config.d.ts.map +1 -1
  463. package/dist/esm/lib/config.js +13 -4
  464. package/dist/esm/lib/config.js.map +1 -1
  465. package/dist/esm/models/create-test-scenario-request.d.ts +29 -0
  466. package/dist/esm/models/create-test-scenario-request.d.ts.map +1 -0
  467. package/dist/esm/models/create-test-scenario-request.js +18 -0
  468. package/dist/esm/models/create-test-scenario-request.js.map +1 -0
  469. package/dist/esm/models/delete-response.d.ts +19 -0
  470. package/dist/esm/models/delete-response.d.ts.map +1 -0
  471. package/dist/esm/models/delete-response.js +20 -0
  472. package/dist/esm/models/delete-response.js.map +1 -0
  473. package/dist/esm/models/device-connect-request.d.ts +29 -0
  474. package/dist/esm/models/device-connect-request.d.ts.map +1 -0
  475. package/dist/esm/models/device-connect-request.js +21 -0
  476. package/dist/esm/models/device-connect-request.js.map +1 -0
  477. package/dist/esm/models/device-connect-response.d.ts +25 -0
  478. package/dist/esm/models/device-connect-response.d.ts.map +1 -0
  479. package/dist/esm/models/device-connect-response.js +26 -0
  480. package/dist/esm/models/device-connect-response.js.map +1 -0
  481. package/dist/esm/models/device-refresh-response.d.ts +16 -0
  482. package/dist/esm/models/device-refresh-response.d.ts.map +1 -0
  483. package/dist/esm/models/device-refresh-response.js +19 -0
  484. package/dist/esm/models/device-refresh-response.js.map +1 -0
  485. package/dist/esm/models/device-start-response.d.ts +20 -0
  486. package/dist/esm/models/device-start-response.d.ts.map +1 -0
  487. package/dist/esm/models/device-start-response.js +21 -0
  488. package/dist/esm/models/device-start-response.js.map +1 -0
  489. package/dist/esm/models/device-validate-response.d.ts +14 -0
  490. package/dist/esm/models/device-validate-response.d.ts.map +1 -0
  491. package/dist/esm/models/device-validate-response.js +17 -0
  492. package/dist/esm/models/device-validate-response.js.map +1 -0
  493. package/dist/esm/models/errors/error-response.d.ts +19 -0
  494. package/dist/esm/models/errors/error-response.d.ts.map +1 -0
  495. package/dist/esm/models/errors/error-response.js +31 -0
  496. package/dist/esm/models/errors/error-response.js.map +1 -0
  497. package/dist/esm/models/errors/index.d.ts +2 -0
  498. package/dist/esm/models/errors/index.d.ts.map +1 -1
  499. package/dist/esm/models/errors/index.js +2 -0
  500. package/dist/esm/models/errors/index.js.map +1 -1
  501. package/dist/esm/models/errors/o-auth-error-response.d.ts +32 -0
  502. package/dist/esm/models/errors/o-auth-error-response.d.ts.map +1 -0
  503. package/dist/esm/models/errors/o-auth-error-response.js +38 -0
  504. package/dist/esm/models/errors/o-auth-error-response.js.map +1 -0
  505. package/dist/esm/models/gbg-error.d.ts +28 -0
  506. package/dist/esm/models/gbg-error.d.ts.map +1 -0
  507. package/dist/esm/models/gbg-error.js +31 -0
  508. package/dist/esm/models/gbg-error.js.map +1 -0
  509. package/dist/esm/models/handoff-token-response.d.ts +20 -0
  510. package/dist/esm/models/handoff-token-response.d.ts.map +1 -0
  511. package/dist/esm/models/handoff-token-response.js +22 -0
  512. package/dist/esm/models/handoff-token-response.js.map +1 -0
  513. package/dist/esm/models/index.d.ts +33 -0
  514. package/dist/esm/models/index.d.ts.map +1 -1
  515. package/dist/esm/models/index.js +33 -0
  516. package/dist/esm/models/index.js.map +1 -1
  517. package/dist/esm/models/interaction-fetch-response.d.ts +40 -0
  518. package/dist/esm/models/interaction-fetch-response.d.ts.map +1 -0
  519. package/dist/esm/models/interaction-fetch-response.js +39 -0
  520. package/dist/esm/models/interaction-fetch-response.js.map +1 -0
  521. package/dist/esm/models/interaction-submit-response.d.ts +17 -0
  522. package/dist/esm/models/interaction-submit-response.d.ts.map +1 -0
  523. package/dist/esm/models/interaction-submit-response.js +18 -0
  524. package/dist/esm/models/interaction-submit-response.js.map +1 -0
  525. package/dist/esm/models/journey-start-response.d.ts +34 -0
  526. package/dist/esm/models/journey-start-response.d.ts.map +1 -0
  527. package/dist/esm/models/journey-start-response.js +30 -0
  528. package/dist/esm/models/journey-start-response.js.map +1 -0
  529. package/dist/esm/models/loqate-retrieve-response.d.ts +12 -0
  530. package/dist/esm/models/loqate-retrieve-response.d.ts.map +1 -0
  531. package/dist/esm/models/loqate-retrieve-response.js +18 -0
  532. package/dist/esm/models/loqate-retrieve-response.js.map +1 -0
  533. package/dist/esm/models/loqate-search-response.d.ts +12 -0
  534. package/dist/esm/models/loqate-search-response.d.ts.map +1 -0
  535. package/dist/esm/models/loqate-search-response.js +18 -0
  536. package/dist/esm/models/loqate-search-response.js.map +1 -0
  537. package/dist/esm/models/operations/add-device.d.ts +8 -92
  538. package/dist/esm/models/operations/add-device.d.ts.map +1 -1
  539. package/dist/esm/models/operations/add-device.js +5 -72
  540. package/dist/esm/models/operations/add-device.js.map +1 -1
  541. package/dist/esm/models/operations/create-handoff-token.d.ts +22 -0
  542. package/dist/esm/models/operations/create-handoff-token.d.ts.map +1 -0
  543. package/dist/esm/models/operations/create-handoff-token.js +24 -0
  544. package/dist/esm/models/operations/create-handoff-token.js.map +1 -0
  545. package/dist/esm/models/operations/create-test-scenario.d.ts +18 -0
  546. package/dist/esm/models/operations/create-test-scenario.d.ts.map +1 -0
  547. package/dist/esm/models/operations/create-test-scenario.js +14 -0
  548. package/dist/esm/models/operations/create-test-scenario.js.map +1 -0
  549. package/dist/esm/models/operations/delete-instance.d.ts +1 -14
  550. package/dist/esm/models/operations/delete-instance.d.ts.map +1 -1
  551. package/dist/esm/models/operations/delete-instance.js +2 -11
  552. package/dist/esm/models/operations/delete-instance.js.map +1 -1
  553. package/dist/esm/models/operations/delete-test-scenario.d.ts +20 -0
  554. package/dist/esm/models/operations/delete-test-scenario.d.ts.map +1 -0
  555. package/dist/esm/models/operations/delete-test-scenario.js +13 -0
  556. package/dist/esm/models/operations/delete-test-scenario.js.map +1 -0
  557. package/dist/esm/models/operations/device-connect.d.ts +0 -91
  558. package/dist/esm/models/operations/device-connect.d.ts.map +1 -1
  559. package/dist/esm/models/operations/device-connect.js +0 -63
  560. package/dist/esm/models/operations/device-connect.js.map +1 -1
  561. package/dist/esm/models/operations/device-validate.d.ts +12 -0
  562. package/dist/esm/models/operations/device-validate.d.ts.map +1 -0
  563. package/dist/esm/models/operations/device-validate.js +17 -0
  564. package/dist/esm/models/operations/device-validate.js.map +1 -0
  565. package/dist/esm/models/operations/fetch-interaction.d.ts +35 -1621
  566. package/dist/esm/models/operations/fetch-interaction.d.ts.map +1 -1
  567. package/dist/esm/models/operations/fetch-interaction.js +22 -1247
  568. package/dist/esm/models/operations/fetch-interaction.js.map +1 -1
  569. package/dist/esm/models/operations/get-journey-schemas.d.ts +16 -0
  570. package/dist/esm/models/operations/get-journey-schemas.d.ts.map +1 -0
  571. package/dist/esm/models/operations/get-journey-schemas.js +14 -0
  572. package/dist/esm/models/operations/get-journey-schemas.js.map +1 -0
  573. package/dist/esm/models/operations/get-journey-state.d.ts +19 -1383
  574. package/dist/esm/models/operations/get-journey-state.d.ts.map +1 -1
  575. package/dist/esm/models/operations/get-journey-state.js +13 -997
  576. package/dist/esm/models/operations/get-journey-state.js.map +1 -1
  577. package/dist/esm/models/operations/get-task-schema.d.ts +1 -17
  578. package/dist/esm/models/operations/get-task-schema.d.ts.map +1 -1
  579. package/dist/esm/models/operations/get-task-schema.js +0 -17
  580. package/dist/esm/models/operations/get-task-schema.js.map +1 -1
  581. package/dist/esm/models/operations/get-test-scenario.d.ts +39 -0
  582. package/dist/esm/models/operations/get-test-scenario.d.ts.map +1 -0
  583. package/dist/esm/models/operations/get-test-scenario.js +23 -0
  584. package/dist/esm/models/operations/get-test-scenario.js.map +1 -0
  585. package/dist/esm/models/operations/index.d.ts +12 -4
  586. package/dist/esm/models/operations/index.d.ts.map +1 -1
  587. package/dist/esm/models/operations/index.js +12 -4
  588. package/dist/esm/models/operations/index.js.map +1 -1
  589. package/dist/esm/models/operations/list-test-scenarios.d.ts +34 -0
  590. package/dist/esm/models/operations/list-test-scenarios.d.ts.map +1 -0
  591. package/dist/esm/models/operations/list-test-scenarios.js +22 -0
  592. package/dist/esm/models/operations/list-test-scenarios.js.map +1 -0
  593. package/dist/esm/models/operations/post-as-token-oauth2.d.ts +2 -2
  594. package/dist/esm/models/operations/post-as-token-oauth2.d.ts.map +1 -1
  595. package/dist/esm/models/operations/post-as-token-oauth2.js +4 -5
  596. package/dist/esm/models/operations/post-as-token-oauth2.js.map +1 -1
  597. package/dist/esm/models/operations/put-test-scenario.d.ts +23 -0
  598. package/dist/esm/models/operations/put-test-scenario.d.ts.map +1 -0
  599. package/dist/esm/models/operations/put-test-scenario.js +15 -0
  600. package/dist/esm/models/operations/put-test-scenario.js.map +1 -0
  601. package/dist/esm/models/operations/retrieve-address.d.ts +29 -0
  602. package/dist/esm/models/operations/retrieve-address.d.ts.map +1 -0
  603. package/dist/esm/models/operations/retrieve-address.js +27 -0
  604. package/dist/esm/models/operations/retrieve-address.js.map +1 -0
  605. package/dist/esm/models/operations/search-addresses.d.ts +33 -0
  606. package/dist/esm/models/operations/search-addresses.d.ts.map +1 -0
  607. package/dist/esm/models/operations/search-addresses.js +29 -0
  608. package/dist/esm/models/operations/search-addresses.js.map +1 -0
  609. package/dist/esm/models/operations/start-journey.d.ts +1214 -112
  610. package/dist/esm/models/operations/start-journey.d.ts.map +1 -1
  611. package/dist/esm/models/operations/start-journey.js +565 -58
  612. package/dist/esm/models/operations/start-journey.js.map +1 -1
  613. package/dist/esm/models/operations/submit-interaction.d.ts +1074 -92
  614. package/dist/esm/models/operations/submit-interaction.d.ts.map +1 -1
  615. package/dist/esm/models/operations/submit-interaction.js +505 -45
  616. package/dist/esm/models/operations/submit-interaction.js.map +1 -1
  617. package/dist/esm/models/operations/terminate-journey.d.ts +19 -0
  618. package/dist/esm/models/operations/terminate-journey.d.ts.map +1 -0
  619. package/dist/esm/models/operations/terminate-journey.js +13 -0
  620. package/dist/esm/models/operations/terminate-journey.js.map +1 -0
  621. package/dist/esm/models/operations/upload-interaction-asset.d.ts +26 -0
  622. package/dist/esm/models/operations/upload-interaction-asset.d.ts.map +1 -0
  623. package/dist/esm/models/operations/upload-interaction-asset.js +28 -0
  624. package/dist/esm/models/operations/upload-interaction-asset.js.map +1 -0
  625. package/dist/esm/models/outstanding-group.d.ts +15 -0
  626. package/dist/esm/models/outstanding-group.d.ts.map +1 -0
  627. package/dist/esm/models/outstanding-group.js +15 -0
  628. package/dist/esm/models/outstanding-group.js.map +1 -0
  629. package/dist/esm/models/schema-fetch-response.d.ts +22 -0
  630. package/dist/esm/models/schema-fetch-response.d.ts.map +1 -0
  631. package/dist/esm/models/schema-fetch-response.js +24 -0
  632. package/dist/esm/models/schema-fetch-response.js.map +1 -0
  633. package/dist/esm/models/slim-document.d.ts +57 -0
  634. package/dist/esm/models/slim-document.d.ts.map +1 -0
  635. package/dist/esm/models/slim-document.js +53 -0
  636. package/dist/esm/models/slim-document.js.map +1 -0
  637. package/dist/esm/models/slim-extraction.d.ts +74 -0
  638. package/dist/esm/models/slim-extraction.d.ts.map +1 -0
  639. package/dist/esm/models/slim-extraction.js +84 -0
  640. package/dist/esm/models/slim-extraction.js.map +1 -0
  641. package/dist/esm/models/slim-identity.d.ts +202 -0
  642. package/dist/esm/models/slim-identity.d.ts.map +1 -0
  643. package/dist/esm/models/slim-identity.js +100 -0
  644. package/dist/esm/models/slim-identity.js.map +1 -0
  645. package/dist/esm/models/slim-interaction-fetch-response.d.ts +46 -0
  646. package/dist/esm/models/slim-interaction-fetch-response.d.ts.map +1 -0
  647. package/dist/esm/models/slim-interaction-fetch-response.js +48 -0
  648. package/dist/esm/models/slim-interaction-fetch-response.js.map +1 -0
  649. package/dist/esm/models/slim-journey.d.ts +14 -0
  650. package/dist/esm/models/slim-journey.d.ts.map +1 -0
  651. package/dist/esm/models/slim-journey.js +18 -0
  652. package/dist/esm/models/slim-journey.js.map +1 -0
  653. package/dist/esm/models/slim-module-step-error.d.ts +50 -0
  654. package/dist/esm/models/slim-module-step-error.d.ts.map +1 -0
  655. package/dist/esm/models/slim-module-step-error.js +41 -0
  656. package/dist/esm/models/slim-module-step-error.js.map +1 -0
  657. package/dist/esm/models/slim-result.d.ts +49 -0
  658. package/dist/esm/models/slim-result.d.ts.map +1 -0
  659. package/dist/esm/models/slim-result.js +39 -0
  660. package/dist/esm/models/slim-result.js.map +1 -0
  661. package/dist/esm/models/slim-state-fetch-response.d.ts +27 -0
  662. package/dist/esm/models/slim-state-fetch-response.d.ts.map +1 -0
  663. package/dist/esm/models/slim-state-fetch-response.js +29 -0
  664. package/dist/esm/models/slim-state-fetch-response.js.map +1 -0
  665. package/dist/esm/models/slim-step.d.ts +40 -0
  666. package/dist/esm/models/slim-step.d.ts.map +1 -0
  667. package/dist/esm/models/slim-step.js +36 -0
  668. package/dist/esm/models/slim-step.js.map +1 -0
  669. package/dist/esm/models/slim-validation.d.ts +69 -0
  670. package/dist/esm/models/slim-validation.d.ts.map +1 -0
  671. package/dist/esm/models/slim-validation.js +78 -0
  672. package/dist/esm/models/slim-validation.js.map +1 -0
  673. package/dist/esm/models/slim-verified-data.d.ts +16 -0
  674. package/dist/esm/models/slim-verified-data.d.ts.map +1 -0
  675. package/dist/esm/models/slim-verified-data.js +16 -0
  676. package/dist/esm/models/slim-verified-data.js.map +1 -0
  677. package/dist/esm/models/state-fetch-response.d.ts +25 -0
  678. package/dist/esm/models/state-fetch-response.d.ts.map +1 -0
  679. package/dist/esm/models/state-fetch-response.js +22 -0
  680. package/dist/esm/models/state-fetch-response.js.map +1 -0
  681. package/dist/esm/models/terminate-response.d.ts +10 -0
  682. package/dist/esm/models/terminate-response.d.ts.map +1 -0
  683. package/dist/esm/models/terminate-response.js +13 -0
  684. package/dist/esm/models/terminate-response.js.map +1 -0
  685. package/dist/esm/models/test-scenario-summary.d.ts +29 -0
  686. package/dist/esm/models/test-scenario-summary.d.ts.map +1 -0
  687. package/dist/esm/models/test-scenario-summary.js +25 -0
  688. package/dist/esm/models/test-scenario-summary.js.map +1 -0
  689. package/dist/esm/models/test-scenario-written.d.ts +19 -0
  690. package/dist/esm/models/test-scenario-written.d.ts.map +1 -0
  691. package/dist/esm/models/test-scenario-written.js +20 -0
  692. package/dist/esm/models/test-scenario-written.js.map +1 -0
  693. package/dist/esm/models/test-scenario.d.ts +31 -0
  694. package/dist/esm/models/test-scenario.d.ts.map +1 -0
  695. package/dist/esm/models/test-scenario.js +25 -0
  696. package/dist/esm/models/test-scenario.js.map +1 -0
  697. package/dist/esm/models/update-test-scenario-request.d.ts +24 -0
  698. package/dist/esm/models/update-test-scenario-request.d.ts.map +1 -0
  699. package/dist/esm/models/update-test-scenario-request.js +17 -0
  700. package/dist/esm/models/update-test-scenario-request.js.map +1 -0
  701. package/dist/esm/sdk/addresses.d.ts +20 -0
  702. package/dist/esm/sdk/addresses.d.ts.map +1 -0
  703. package/dist/esm/sdk/addresses.js +28 -0
  704. package/dist/esm/sdk/addresses.js.map +1 -0
  705. package/dist/esm/sdk/devices.d.ts +21 -6
  706. package/dist/esm/sdk/devices.d.ts.map +1 -1
  707. package/dist/esm/sdk/devices.js +26 -6
  708. package/dist/esm/sdk/devices.js.map +1 -1
  709. package/dist/esm/sdk/instances.d.ts +11 -3
  710. package/dist/esm/sdk/instances.d.ts.map +1 -1
  711. package/dist/esm/sdk/instances.js +12 -2
  712. package/dist/esm/sdk/instances.js.map +1 -1
  713. package/dist/esm/sdk/interactions.d.ts +14 -6
  714. package/dist/esm/sdk/interactions.d.ts.map +1 -1
  715. package/dist/esm/sdk/interactions.js +16 -6
  716. package/dist/esm/sdk/interactions.js.map +1 -1
  717. package/dist/esm/sdk/journeys.d.ts +45 -5
  718. package/dist/esm/sdk/journeys.d.ts.map +1 -1
  719. package/dist/esm/sdk/journeys.js +49 -4
  720. package/dist/esm/sdk/journeys.js.map +1 -1
  721. package/dist/esm/sdk/sdk.d.ts +14 -11
  722. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  723. package/dist/esm/sdk/sdk.js +17 -13
  724. package/dist/esm/sdk/sdk.js.map +1 -1
  725. package/dist/esm/sdk/tasks.d.ts +6 -23
  726. package/dist/esm/sdk/tasks.d.ts.map +1 -1
  727. package/dist/esm/sdk/tasks.js +3 -31
  728. package/dist/esm/sdk/tasks.js.map +1 -1
  729. package/dist/esm/sdk/test-scenarios.d.ts +41 -0
  730. package/dist/esm/sdk/test-scenarios.d.ts.map +1 -0
  731. package/dist/esm/sdk/test-scenarios.js +58 -0
  732. package/dist/esm/sdk/test-scenarios.js.map +1 -0
  733. package/dist/esm/types/discriminated-union.d.ts.map +1 -1
  734. package/dist/esm/types/discriminated-union.js +0 -4
  735. package/dist/esm/types/discriminated-union.js.map +1 -1
  736. package/dist/esm/types/index.d.ts +0 -2
  737. package/dist/esm/types/index.d.ts.map +1 -1
  738. package/dist/esm/types/index.js +0 -2
  739. package/dist/esm/types/index.js.map +1 -1
  740. package/dist/esm/types/smart-union.d.ts.map +1 -1
  741. package/dist/esm/types/smart-union.js +14 -14
  742. package/dist/esm/types/smart-union.js.map +1 -1
  743. package/examples/{tokensGenerate.example.ts → journeysStart.example.ts} +5 -3
  744. package/jsr.json +1 -1
  745. package/package.json +1 -1
  746. package/src/funcs/{tasks-update.ts → addresses-retrieve.ts} +39 -18
  747. package/src/funcs/addresses-search.ts +196 -0
  748. package/src/funcs/devices-add.ts +20 -10
  749. package/src/funcs/devices-connect.ts +23 -16
  750. package/src/funcs/{health-get.ts → devices-refresh.ts} +26 -22
  751. package/src/funcs/{tasks-list.ts → devices-validate.ts} +26 -37
  752. package/src/funcs/instances-delete.ts +20 -9
  753. package/src/funcs/instances-handoff-token.ts +191 -0
  754. package/src/funcs/interactions-fetch.ts +29 -9
  755. package/src/funcs/interactions-submit.ts +27 -9
  756. package/src/funcs/interactions-upload-asset.ts +173 -0
  757. package/src/funcs/journeys-get-schemas.ts +207 -0
  758. package/src/funcs/journeys-get-state.ts +22 -9
  759. package/src/funcs/journeys-start.ts +23 -10
  760. package/src/funcs/{tasks-list-schema.ts → journeys-terminate.ts} +26 -15
  761. package/src/funcs/tasks-get-schema.ts +21 -9
  762. package/src/funcs/test-scenarios-create.ts +183 -0
  763. package/src/funcs/test-scenarios-delete.ts +187 -0
  764. package/src/funcs/test-scenarios-get.ts +192 -0
  765. package/src/funcs/test-scenarios-list.ts +187 -0
  766. package/src/funcs/test-scenarios-put.ts +188 -0
  767. package/src/funcs/tokens-generate.ts +12 -3
  768. package/src/lib/config.ts +13 -4
  769. package/src/models/create-test-scenario-request.ts +63 -0
  770. package/src/models/delete-response.ts +45 -0
  771. package/src/models/device-connect-request.ts +60 -0
  772. package/src/models/device-connect-response.ts +59 -0
  773. package/src/models/device-refresh-response.ts +42 -0
  774. package/src/models/device-start-response.ts +49 -0
  775. package/src/models/device-validate-response.ts +38 -0
  776. package/src/models/errors/error-response.ts +52 -0
  777. package/src/models/errors/index.ts +2 -0
  778. package/src/models/errors/o-auth-error-response.ts +74 -0
  779. package/src/models/gbg-error.ts +56 -0
  780. package/src/models/handoff-token-response.ts +48 -0
  781. package/src/models/index.ts +33 -0
  782. package/src/models/interaction-fetch-response.ts +103 -0
  783. package/src/models/interaction-submit-response.ts +43 -0
  784. package/src/models/journey-start-response.ts +71 -0
  785. package/src/models/loqate-retrieve-response.ts +38 -0
  786. package/src/models/loqate-search-response.ts +38 -0
  787. package/src/models/operations/add-device.ts +17 -176
  788. package/src/models/operations/create-handoff-token.ts +63 -0
  789. package/src/models/operations/create-test-scenario.ts +37 -0
  790. package/src/models/operations/delete-instance.ts +7 -38
  791. package/src/models/operations/delete-test-scenario.ts +39 -0
  792. package/src/models/operations/device-connect.ts +0 -189
  793. package/src/models/operations/device-validate.ts +38 -0
  794. package/src/models/operations/fetch-interaction.ts +100 -3798
  795. package/src/models/operations/get-journey-schemas.ts +36 -0
  796. package/src/models/operations/get-journey-state.ts +62 -3183
  797. package/src/models/operations/get-task-schema.ts +1 -44
  798. package/src/models/operations/get-test-scenario.ts +65 -0
  799. package/src/models/operations/index.ts +12 -4
  800. package/src/models/operations/list-test-scenarios.ts +59 -0
  801. package/src/models/operations/post-as-token-oauth2.ts +8 -9
  802. package/src/models/operations/put-test-scenario.ts +43 -0
  803. package/src/models/operations/retrieve-address.ts +73 -0
  804. package/src/models/operations/search-addresses.ts +79 -0
  805. package/src/models/operations/start-journey.ts +2838 -1025
  806. package/src/models/operations/submit-interaction.ts +2787 -1092
  807. package/src/models/operations/terminate-journey.ts +41 -0
  808. package/src/models/operations/upload-interaction-asset.ts +74 -0
  809. package/src/models/outstanding-group.ts +37 -0
  810. package/src/models/schema-fetch-response.ts +57 -0
  811. package/src/models/slim-document.ts +134 -0
  812. package/src/models/slim-extraction.ts +235 -0
  813. package/src/models/slim-identity.ts +347 -0
  814. package/src/models/slim-interaction-fetch-response.ts +124 -0
  815. package/src/models/slim-journey.ts +36 -0
  816. package/src/models/slim-module-step-error.ts +99 -0
  817. package/src/models/slim-result.ts +92 -0
  818. package/src/models/slim-state-fetch-response.ts +60 -0
  819. package/src/models/slim-step.ts +80 -0
  820. package/src/models/slim-validation.ts +229 -0
  821. package/src/models/slim-verified-data.ts +37 -0
  822. package/src/models/state-fetch-response.ts +49 -0
  823. package/src/models/terminate-response.ts +30 -0
  824. package/src/models/test-scenario-summary.ts +62 -0
  825. package/src/models/test-scenario-written.ts +47 -0
  826. package/src/models/test-scenario.ts +60 -0
  827. package/src/models/update-test-scenario-request.ts +57 -0
  828. package/src/sdk/addresses.ts +50 -0
  829. package/src/sdk/devices.ts +46 -11
  830. package/src/sdk/instances.ts +24 -3
  831. package/src/sdk/interactions.ts +30 -11
  832. package/src/sdk/journeys.ts +67 -5
  833. package/src/sdk/sdk.ts +25 -19
  834. package/src/sdk/tasks.ts +4 -60
  835. package/src/sdk/test-scenarios.ts +100 -0
  836. package/src/types/discriminated-union.ts +1 -4
  837. package/src/types/index.ts +0 -2
  838. package/src/types/smart-union.ts +19 -14
  839. package/dist/commonjs/funcs/health-get.d.ts.map +0 -1
  840. package/dist/commonjs/funcs/health-get.js.map +0 -1
  841. package/dist/commonjs/funcs/tasks-list-schema.d.ts.map +0 -1
  842. package/dist/commonjs/funcs/tasks-list-schema.js.map +0 -1
  843. package/dist/commonjs/funcs/tasks-list.d.ts.map +0 -1
  844. package/dist/commonjs/funcs/tasks-list.js.map +0 -1
  845. package/dist/commonjs/funcs/tasks-update.d.ts.map +0 -1
  846. package/dist/commonjs/funcs/tasks-update.js.map +0 -1
  847. package/dist/commonjs/models/operations/get-tasks-schema.d.ts +0 -71
  848. package/dist/commonjs/models/operations/get-tasks-schema.d.ts.map +0 -1
  849. package/dist/commonjs/models/operations/get-tasks-schema.js +0 -108
  850. package/dist/commonjs/models/operations/get-tasks-schema.js.map +0 -1
  851. package/dist/commonjs/models/operations/get-tasks.d.ts +0 -62
  852. package/dist/commonjs/models/operations/get-tasks.d.ts.map +0 -1
  853. package/dist/commonjs/models/operations/get-tasks.js +0 -91
  854. package/dist/commonjs/models/operations/get-tasks.js.map +0 -1
  855. package/dist/commonjs/models/operations/health.d.ts +0 -14
  856. package/dist/commonjs/models/operations/health.d.ts.map +0 -1
  857. package/dist/commonjs/models/operations/health.js.map +0 -1
  858. package/dist/commonjs/models/operations/update-task.d.ts +0 -2105
  859. package/dist/commonjs/models/operations/update-task.d.ts.map +0 -1
  860. package/dist/commonjs/models/operations/update-task.js +0 -1115
  861. package/dist/commonjs/models/operations/update-task.js.map +0 -1
  862. package/dist/commonjs/sdk/health.d.ts +0 -12
  863. package/dist/commonjs/sdk/health.d.ts.map +0 -1
  864. package/dist/commonjs/sdk/health.js +0 -22
  865. package/dist/commonjs/sdk/health.js.map +0 -1
  866. package/dist/commonjs/types/default-to-zero-value.d.ts +0 -12
  867. package/dist/commonjs/types/default-to-zero-value.d.ts.map +0 -1
  868. package/dist/commonjs/types/default-to-zero-value.js +0 -35
  869. package/dist/commonjs/types/default-to-zero-value.js.map +0 -1
  870. package/dist/commonjs/types/primitives.d.ts +0 -9
  871. package/dist/commonjs/types/primitives.d.ts.map +0 -1
  872. package/dist/commonjs/types/primitives.js +0 -151
  873. package/dist/commonjs/types/primitives.js.map +0 -1
  874. package/dist/esm/funcs/health-get.d.ts.map +0 -1
  875. package/dist/esm/funcs/health-get.js.map +0 -1
  876. package/dist/esm/funcs/tasks-list-schema.d.ts.map +0 -1
  877. package/dist/esm/funcs/tasks-list-schema.js.map +0 -1
  878. package/dist/esm/funcs/tasks-list.d.ts +0 -17
  879. package/dist/esm/funcs/tasks-list.d.ts.map +0 -1
  880. package/dist/esm/funcs/tasks-list.js.map +0 -1
  881. package/dist/esm/funcs/tasks-update.d.ts +0 -17
  882. package/dist/esm/funcs/tasks-update.d.ts.map +0 -1
  883. package/dist/esm/funcs/tasks-update.js.map +0 -1
  884. package/dist/esm/models/operations/get-tasks-schema.d.ts +0 -71
  885. package/dist/esm/models/operations/get-tasks-schema.d.ts.map +0 -1
  886. package/dist/esm/models/operations/get-tasks-schema.js +0 -67
  887. package/dist/esm/models/operations/get-tasks-schema.js.map +0 -1
  888. package/dist/esm/models/operations/get-tasks.d.ts +0 -62
  889. package/dist/esm/models/operations/get-tasks.d.ts.map +0 -1
  890. package/dist/esm/models/operations/get-tasks.js +0 -51
  891. package/dist/esm/models/operations/get-tasks.js.map +0 -1
  892. package/dist/esm/models/operations/health.d.ts +0 -14
  893. package/dist/esm/models/operations/health.d.ts.map +0 -1
  894. package/dist/esm/models/operations/health.js +0 -14
  895. package/dist/esm/models/operations/health.js.map +0 -1
  896. package/dist/esm/models/operations/update-task.d.ts +0 -2105
  897. package/dist/esm/models/operations/update-task.d.ts.map +0 -1
  898. package/dist/esm/models/operations/update-task.js +0 -1007
  899. package/dist/esm/models/operations/update-task.js.map +0 -1
  900. package/dist/esm/sdk/health.d.ts +0 -12
  901. package/dist/esm/sdk/health.d.ts.map +0 -1
  902. package/dist/esm/sdk/health.js +0 -18
  903. package/dist/esm/sdk/health.js.map +0 -1
  904. package/dist/esm/types/default-to-zero-value.d.ts +0 -12
  905. package/dist/esm/types/default-to-zero-value.d.ts.map +0 -1
  906. package/dist/esm/types/default-to-zero-value.js +0 -31
  907. package/dist/esm/types/default-to-zero-value.js.map +0 -1
  908. package/dist/esm/types/primitives.d.ts +0 -9
  909. package/dist/esm/types/primitives.d.ts.map +0 -1
  910. package/dist/esm/types/primitives.js +0 -109
  911. package/dist/esm/types/primitives.js.map +0 -1
  912. package/src/models/operations/get-tasks-schema.ts +0 -173
  913. package/src/models/operations/get-tasks.ts +0 -144
  914. package/src/models/operations/health.ts +0 -38
  915. package/src/models/operations/update-task.ts +0 -3818
  916. package/src/sdk/health.ts +0 -25
  917. package/src/types/default-to-zero-value.ts +0 -33
  918. package/src/types/primitives.ts +0 -140
@@ -1,3818 +0,0 @@
1
- /*
2
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
- */
4
-
5
- import * as z from "zod/v4-mini";
6
- import { remap as remap$ } from "../../lib/primitives.js";
7
- import { safeParse } from "../../lib/schemas.js";
8
- import { ClosedEnum } from "../../types/enums.js";
9
- import { Result as SafeParseResult } from "../../types/fp.js";
10
- import * as types from "../../types/primitives.js";
11
- import { smartUnion } from "../../types/smart-union.js";
12
- import { SDKValidationError } from "../errors/sdk-validation-error.js";
13
-
14
- export type UpdateTaskSecurity = {
15
- pingID: string;
16
- };
17
-
18
- export const Intent = {
19
- Save: "Save",
20
- Complete: "Complete",
21
- Validate: "Validate",
22
- } as const;
23
- export type Intent = ClosedEnum<typeof Intent>;
24
-
25
- export type UpdateTaskIdentityAlias = {
26
- /**
27
- * Title of an individual such as Mr, Mrs, Dr, Sir
28
- */
29
- title?: string | undefined;
30
- /**
31
- * A person's name used by their collegues and friends to address them
32
- */
33
- firstName?: string | undefined;
34
- /**
35
- * Any other registered names used by the individual, not aliases
36
- */
37
- middleNames?: Array<string> | undefined;
38
- /**
39
- * Any family names for the individual
40
- */
41
- lastNames?: Array<string> | undefined;
42
- /**
43
- * Any family names for the individual
44
- */
45
- lastNamesAtBirth?: Array<string> | undefined;
46
- };
47
-
48
- export const UpdateTaskIdentityRelationship = {
49
- Mother: "mother",
50
- Father: "father",
51
- MaternalGrandFather: "maternalGrandFather",
52
- MaternalGrandMother: "maternalGrandMother",
53
- PaternalGrandFather: "paternalGrandFather",
54
- PaternalGrandMother: "paternalGrandMother",
55
- } as const;
56
- export type UpdateTaskIdentityRelationship = ClosedEnum<
57
- typeof UpdateTaskIdentityRelationship
58
- >;
59
-
60
- export type UpdateTaskIdentityRelatedPerson = {
61
- /**
62
- * Title of an individual such as Mr, Mrs, Dr, Sir
63
- */
64
- title?: string | undefined;
65
- /**
66
- * A person's name used by their collegues and friends to address them
67
- */
68
- firstName?: string | undefined;
69
- /**
70
- * Any other registered names used by the individual, not aliases
71
- */
72
- middleNames?: Array<string> | undefined;
73
- /**
74
- * Any family names for the individual
75
- */
76
- lastNames?: Array<string> | undefined;
77
- /**
78
- * Any family names for the individual
79
- */
80
- lastNamesAtBirth?: Array<string> | undefined;
81
- relationship: UpdateTaskIdentityRelationship;
82
- };
83
-
84
- export type UpdateTaskIdentityCurrentAddressLocation = {
85
- latitude?: string | undefined;
86
- longitude?: string | undefined;
87
- geoAccuracy?: string | undefined;
88
- /**
89
- * A What3words designation associated with this location with '.' separator.
90
- */
91
- what3words?: string | undefined;
92
- };
93
-
94
- export type UpdateTaskIdentityCurrentAddress = {
95
- /**
96
- * Unformatted line based address
97
- */
98
- lines?: Array<string> | undefined;
99
- /**
100
- * The address as a single line
101
- */
102
- addressString?: string | undefined;
103
- /**
104
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
105
- */
106
- premise?: string | undefined;
107
- /**
108
- * The name of a building or a building complex. In the US, this is the street number.
109
- */
110
- building?: string | undefined;
111
- /**
112
- * The name of a sub-building, such as a flat or apartment number.
113
- */
114
- subBuilding?: string | undefined;
115
- /**
116
- * This field holds the most common street or block data element within a country. For instance, USA Street
117
- */
118
- thoroughfare?: string | undefined;
119
- /**
120
- * The name of a dependent street or block, such as a street within a complex.
121
- */
122
- dependentThoroughfare?: string | undefined;
123
- /**
124
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
125
- */
126
- locality?: string | undefined;
127
- /**
128
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
129
- */
130
- dependentLocality?: string | undefined;
131
- /**
132
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
133
- */
134
- doubleDependentLocality?: string | undefined;
135
- /**
136
- * 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
137
- */
138
- postalCode?: string | undefined;
139
- /**
140
- * This field contains the post box number associated with a particular delivery point, should one exist.
141
- */
142
- postBox?: string | undefined;
143
- /**
144
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
145
- */
146
- country?: string | undefined;
147
- superAdministrativeArea?: string | undefined;
148
- administrativeArea?: string | undefined;
149
- subAdministrativeArea?: string | undefined;
150
- organization?: string | undefined;
151
- location?: UpdateTaskIdentityCurrentAddressLocation | undefined;
152
- };
153
-
154
- export type UpdateTaskIdentityPreviousAddressLocation = {
155
- latitude?: string | undefined;
156
- longitude?: string | undefined;
157
- geoAccuracy?: string | undefined;
158
- /**
159
- * A What3words designation associated with this location with '.' separator.
160
- */
161
- what3words?: string | undefined;
162
- };
163
-
164
- export type UpdateTaskIdentityPreviousAddress = {
165
- /**
166
- * Unformatted line based address
167
- */
168
- lines?: Array<string> | undefined;
169
- /**
170
- * The address as a single line
171
- */
172
- addressString?: string | undefined;
173
- /**
174
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
175
- */
176
- premise?: string | undefined;
177
- /**
178
- * The name of a building or a building complex. In the US, this is the street number.
179
- */
180
- building?: string | undefined;
181
- /**
182
- * The name of a sub-building, such as a flat or apartment number.
183
- */
184
- subBuilding?: string | undefined;
185
- /**
186
- * This field holds the most common street or block data element within a country. For instance, USA Street
187
- */
188
- thoroughfare?: string | undefined;
189
- /**
190
- * The name of a dependent street or block, such as a street within a complex.
191
- */
192
- dependentThoroughfare?: string | undefined;
193
- /**
194
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
195
- */
196
- locality?: string | undefined;
197
- /**
198
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
199
- */
200
- dependentLocality?: string | undefined;
201
- /**
202
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
203
- */
204
- doubleDependentLocality?: string | undefined;
205
- /**
206
- * 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
207
- */
208
- postalCode?: string | undefined;
209
- /**
210
- * This field contains the post box number associated with a particular delivery point, should one exist.
211
- */
212
- postBox?: string | undefined;
213
- /**
214
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
215
- */
216
- country?: string | undefined;
217
- superAdministrativeArea?: string | undefined;
218
- administrativeArea?: string | undefined;
219
- subAdministrativeArea?: string | undefined;
220
- organization?: string | undefined;
221
- location?: UpdateTaskIdentityPreviousAddressLocation | undefined;
222
- /**
223
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
224
- */
225
- fromDate: string;
226
- /**
227
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
228
- */
229
- toDate: string;
230
- };
231
-
232
- export type UpdateTaskIdentityPlaceOfBirthLocation = {
233
- latitude?: string | undefined;
234
- longitude?: string | undefined;
235
- geoAccuracy?: string | undefined;
236
- /**
237
- * A What3words designation associated with this location with '.' separator.
238
- */
239
- what3words?: string | undefined;
240
- };
241
-
242
- export type UpdateTaskIdentityPlaceOfBirth = {
243
- /**
244
- * Unformatted line based address
245
- */
246
- lines?: Array<string> | undefined;
247
- /**
248
- * The address as a single line
249
- */
250
- addressString?: string | undefined;
251
- /**
252
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
253
- */
254
- premise?: string | undefined;
255
- /**
256
- * The name of a building or a building complex. In the US, this is the street number.
257
- */
258
- building?: string | undefined;
259
- /**
260
- * The name of a sub-building, such as a flat or apartment number.
261
- */
262
- subBuilding?: string | undefined;
263
- /**
264
- * This field holds the most common street or block data element within a country. For instance, USA Street
265
- */
266
- thoroughfare?: string | undefined;
267
- /**
268
- * The name of a dependent street or block, such as a street within a complex.
269
- */
270
- dependentThoroughfare?: string | undefined;
271
- /**
272
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
273
- */
274
- locality?: string | undefined;
275
- /**
276
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
277
- */
278
- dependentLocality?: string | undefined;
279
- /**
280
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
281
- */
282
- doubleDependentLocality?: string | undefined;
283
- /**
284
- * 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
285
- */
286
- postalCode?: string | undefined;
287
- /**
288
- * This field contains the post box number associated with a particular delivery point, should one exist.
289
- */
290
- postBox?: string | undefined;
291
- /**
292
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
293
- */
294
- country?: string | undefined;
295
- superAdministrativeArea?: string | undefined;
296
- administrativeArea?: string | undefined;
297
- subAdministrativeArea?: string | undefined;
298
- organization?: string | undefined;
299
- location?: UpdateTaskIdentityPlaceOfBirthLocation | undefined;
300
- };
301
-
302
- export type UpdateTaskIdentityIdNumber = {
303
- /**
304
- * The type of phone number, such as landline, mobile, fax, unknown etc
305
- */
306
- type: string;
307
- /**
308
- * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
309
- */
310
- idNumber: string;
311
- /**
312
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
313
- */
314
- country?: string | undefined;
315
- };
316
-
317
- export type UpdateTaskIdentityPhone = {
318
- /**
319
- * The type of phone number, such as landline, mobile, fax, unknown etc
320
- */
321
- type: string;
322
- /**
323
- * Phone number, ideally in international format with +(Country Code)
324
- */
325
- number: string;
326
- };
327
-
328
- export type UpdateTaskIdentityEmail = {
329
- /**
330
- * The type of email, such as home, work, unknown etc
331
- */
332
- type: string;
333
- /**
334
- * Email address
335
- */
336
- email: string;
337
- };
338
-
339
- export type UpdateTaskIdentitySocial = {
340
- /**
341
- * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
342
- */
343
- type: string;
344
- /**
345
- * the identity used on this platform
346
- */
347
- identity: string;
348
- };
349
-
350
- export type UpdateTaskIdentity = {
351
- /**
352
- * Title of an individual such as Mr, Mrs, Dr, Sir
353
- */
354
- title?: string | undefined;
355
- /**
356
- * A person's name used by their collegues and friends to address them
357
- */
358
- firstName?: string | undefined;
359
- /**
360
- * Any other registered names used by the individual, not aliases
361
- */
362
- middleNames?: Array<string> | undefined;
363
- /**
364
- * Any family names for the individual
365
- */
366
- lastNames?: Array<string> | undefined;
367
- /**
368
- * Any family names for the individual
369
- */
370
- lastNamesAtBirth?: Array<string> | undefined;
371
- aliases?: Array<UpdateTaskIdentityAlias> | undefined;
372
- relatedPersons?: Array<UpdateTaskIdentityRelatedPerson> | undefined;
373
- /**
374
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
375
- */
376
- dateOfBirth?: string | undefined;
377
- gender?: string | undefined;
378
- currentAddress?: UpdateTaskIdentityCurrentAddress | undefined;
379
- previousAddresses?: Array<UpdateTaskIdentityPreviousAddress> | undefined;
380
- placeOfBirth?: UpdateTaskIdentityPlaceOfBirth | undefined;
381
- idNumbers?: Array<UpdateTaskIdentityIdNumber> | undefined;
382
- phones?: Array<UpdateTaskIdentityPhone> | undefined;
383
- emails?: Array<UpdateTaskIdentityEmail> | undefined;
384
- socials?: Array<UpdateTaskIdentitySocial> | undefined;
385
- /**
386
- * The subject's mother's maiden name, used for identity verification
387
- */
388
- mothersMaidenName?: string | undefined;
389
- };
390
-
391
- export type UpdateTaskAddress = {
392
- addressString?: string | undefined;
393
- extractedAddressString?: string | undefined;
394
- addressLine1?: string | undefined;
395
- addressLine2?: string | undefined;
396
- locality?: string | undefined;
397
- administrativeArea?: string | undefined;
398
- postalCode?: string | undefined;
399
- };
400
-
401
- export type UpdateTaskDocumentDevice = {
402
- type?: string | undefined;
403
- model?: string | undefined;
404
- hasContactlessReader?: boolean | undefined;
405
- hasMagneticStripeReader?: boolean | undefined;
406
- hasCamera?: boolean | undefined;
407
- serialNumber?: string | undefined;
408
- manufacturer?: string | undefined;
409
- };
410
-
411
- export const UpdateTaskName = {
412
- Com: "COM",
413
- Sod: "SOD",
414
- Dg1: "DG1",
415
- Dg2: "DG2",
416
- Dg3: "DG3",
417
- Dg4: "DG4",
418
- Dg5: "DG5",
419
- Dg6: "DG6",
420
- Dg7: "DG7",
421
- Dg8: "DG8",
422
- Dg9: "DG9",
423
- Dg10: "DG10",
424
- Dg11: "DG11",
425
- Dg12: "DG12",
426
- Dg13: "DG13",
427
- Dg14: "DG14",
428
- Dg15: "DG15",
429
- } as const;
430
- export type UpdateTaskName = ClosedEnum<typeof UpdateTaskName>;
431
-
432
- export type UpdateTaskLd = {
433
- name: UpdateTaskName;
434
- data: string;
435
- [additionalProperties: string]: unknown;
436
- };
437
-
438
- export const UpdateTaskAuthType = {
439
- ActiveAuthentication: "ActiveAuthentication",
440
- BasicAccessControl: "BasicAccessControl",
441
- ChipAuthentication: "ChipAuthentication",
442
- PassiveAuthentication: "PassiveAuthentication",
443
- SupplementalAccessControl: "SupplementalAccessControl",
444
- ExtendedAccessControl: "ExtendedAccessControl",
445
- TerminalAuthentication: "TerminalAuthentication",
446
- } as const;
447
- export type UpdateTaskAuthType = ClosedEnum<typeof UpdateTaskAuthType>;
448
-
449
- export const UpdateTaskResult = {
450
- Success: "Success",
451
- Failure: "Failure",
452
- Skipped: "Skipped",
453
- } as const;
454
- export type UpdateTaskResult = ClosedEnum<typeof UpdateTaskResult>;
455
-
456
- export type UpdateTaskChipAuth = {
457
- type: UpdateTaskAuthType;
458
- result: UpdateTaskResult;
459
- [additionalProperties: string]: unknown;
460
- };
461
-
462
- export type UpdateTaskChip = {
463
- lds: Array<UpdateTaskLd>;
464
- auth: Array<UpdateTaskChipAuth>;
465
- [additionalProperties: string]: unknown;
466
- };
467
-
468
- export type UpdateTaskSide = {
469
- side: string;
470
- id: string;
471
- documentQuality: string;
472
- documentQualityScore: number;
473
- };
474
-
475
- export type UpdateTaskClassification = {
476
- ids?: Array<string> | undefined;
477
- category?: string | undefined;
478
- type?: string | undefined;
479
- subtype?: string | undefined;
480
- isDoubleSided?: boolean | undefined;
481
- hasNFC?: boolean | undefined;
482
- year?: string | undefined;
483
- countryCode?: string | undefined;
484
- countryName?: string | undefined;
485
- stateCode?: string | undefined;
486
- stateName?: string | undefined;
487
- sides?: Array<UpdateTaskSide> | undefined;
488
- };
489
-
490
- export type UpdateTaskAggregatedFieldBoundingBox = {
491
- x: number;
492
- y: number;
493
- width: number;
494
- height: number;
495
- };
496
-
497
- export type UpdateTaskAggregatedFieldRegionOfInterest = {
498
- boundingBox?: UpdateTaskAggregatedFieldBoundingBox | undefined;
499
- side: string;
500
- spectrum?: string | undefined;
501
- imageId?: string | undefined;
502
- };
503
-
504
- export type UpdateTaskAggregatedField = {
505
- label: string;
506
- value: string;
507
- source: string;
508
- isNonLatin: boolean;
509
- regionOfInterest?: UpdateTaskAggregatedFieldRegionOfInterest | undefined;
510
- };
511
-
512
- export type UpdateTaskDetailBoundingBox = {
513
- x: number;
514
- y: number;
515
- width: number;
516
- height: number;
517
- };
518
-
519
- export type UpdateTaskDetailRegionOfInterest = {
520
- boundingBox?: UpdateTaskDetailBoundingBox | undefined;
521
- side: string;
522
- spectrum?: string | undefined;
523
- imageId?: string | undefined;
524
- };
525
-
526
- export type UpdateTaskDetail = {
527
- label: string;
528
- value: string;
529
- source: string;
530
- isNonLatin: boolean;
531
- regionOfInterest?: UpdateTaskDetailRegionOfInterest | undefined;
532
- };
533
-
534
- export type UpdateTaskExtractedField = {
535
- label: string;
536
- details: Array<UpdateTaskDetail>;
537
- };
538
-
539
- export type UpdateTaskExtractedImage = {
540
- label: string;
541
- side: string;
542
- imageID: string;
543
- };
544
-
545
- export type UpdateTaskExtraction = {
546
- aggregatedFields?: Array<UpdateTaskAggregatedField> | undefined;
547
- extractedFields?: Array<UpdateTaskExtractedField> | undefined;
548
- extractedImages?: Array<UpdateTaskExtractedImage> | undefined;
549
- };
550
-
551
- export type UpdateTaskValidationCheckBoundingBox = {
552
- x: number;
553
- y: number;
554
- width: number;
555
- height: number;
556
- };
557
-
558
- export type UpdateTaskValidationCheckRegionOfInterest = {
559
- boundingBox?: UpdateTaskValidationCheckBoundingBox | undefined;
560
- side: string;
561
- spectrum?: string | undefined;
562
- imageId?: string | undefined;
563
- };
564
-
565
- export type UpdateTaskValidationCheck = {
566
- name: string;
567
- title: string;
568
- info: string;
569
- validationResult: string;
570
- resultInfo: string;
571
- weight: string;
572
- regionOfInterests?:
573
- | Array<UpdateTaskValidationCheckRegionOfInterest>
574
- | undefined;
575
- type: string;
576
- };
577
-
578
- export type UpdateTaskAggregatedValidationCheckBoundingBox = {
579
- x: number;
580
- y: number;
581
- width: number;
582
- height: number;
583
- };
584
-
585
- export type UpdateTaskAggregatedValidationCheckRegionOfInterest = {
586
- boundingBox?: UpdateTaskAggregatedValidationCheckBoundingBox | undefined;
587
- side: string;
588
- spectrum?: string | undefined;
589
- imageId?: string | undefined;
590
- };
591
-
592
- export type UpdateTaskAggregatedValidationCheck = {
593
- name: string;
594
- title: string;
595
- info: string;
596
- validationResult: string;
597
- resultInfo: string;
598
- weight: string;
599
- regionOfInterests?:
600
- | Array<UpdateTaskAggregatedValidationCheckRegionOfInterest>
601
- | undefined;
602
- type: string;
603
- };
604
-
605
- export type UpdateTaskValidation = {
606
- validationChecks?: Array<UpdateTaskValidationCheck> | undefined;
607
- aggregatedValidationChecks?:
608
- | Array<UpdateTaskAggregatedValidationCheck>
609
- | undefined;
610
- };
611
-
612
- export type UpdateTaskDocumentAlias = {
613
- /**
614
- * Title of an individual such as Mr, Mrs, Dr, Sir
615
- */
616
- title?: string | undefined;
617
- /**
618
- * A person's name used by their collegues and friends to address them
619
- */
620
- firstName?: string | undefined;
621
- /**
622
- * Any other registered names used by the individual, not aliases
623
- */
624
- middleNames?: Array<string> | undefined;
625
- /**
626
- * Any family names for the individual
627
- */
628
- lastNames?: Array<string> | undefined;
629
- /**
630
- * Any family names for the individual
631
- */
632
- lastNamesAtBirth?: Array<string> | undefined;
633
- };
634
-
635
- export const UpdateTaskDocumentRelationship = {
636
- Mother: "mother",
637
- Father: "father",
638
- MaternalGrandFather: "maternalGrandFather",
639
- MaternalGrandMother: "maternalGrandMother",
640
- PaternalGrandFather: "paternalGrandFather",
641
- PaternalGrandMother: "paternalGrandMother",
642
- } as const;
643
- export type UpdateTaskDocumentRelationship = ClosedEnum<
644
- typeof UpdateTaskDocumentRelationship
645
- >;
646
-
647
- export type UpdateTaskDocumentRelatedPerson = {
648
- /**
649
- * Title of an individual such as Mr, Mrs, Dr, Sir
650
- */
651
- title?: string | undefined;
652
- /**
653
- * A person's name used by their collegues and friends to address them
654
- */
655
- firstName?: string | undefined;
656
- /**
657
- * Any other registered names used by the individual, not aliases
658
- */
659
- middleNames?: Array<string> | undefined;
660
- /**
661
- * Any family names for the individual
662
- */
663
- lastNames?: Array<string> | undefined;
664
- /**
665
- * Any family names for the individual
666
- */
667
- lastNamesAtBirth?: Array<string> | undefined;
668
- relationship: UpdateTaskDocumentRelationship;
669
- };
670
-
671
- export type UpdateTaskDocumentCurrentAddressLocation = {
672
- latitude?: string | undefined;
673
- longitude?: string | undefined;
674
- geoAccuracy?: string | undefined;
675
- /**
676
- * A What3words designation associated with this location with '.' separator.
677
- */
678
- what3words?: string | undefined;
679
- };
680
-
681
- export type UpdateTaskDocumentCurrentAddress = {
682
- /**
683
- * Unformatted line based address
684
- */
685
- lines?: Array<string> | undefined;
686
- /**
687
- * The address as a single line
688
- */
689
- addressString?: string | undefined;
690
- /**
691
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
692
- */
693
- premise?: string | undefined;
694
- /**
695
- * The name of a building or a building complex. In the US, this is the street number.
696
- */
697
- building?: string | undefined;
698
- /**
699
- * The name of a sub-building, such as a flat or apartment number.
700
- */
701
- subBuilding?: string | undefined;
702
- /**
703
- * This field holds the most common street or block data element within a country. For instance, USA Street
704
- */
705
- thoroughfare?: string | undefined;
706
- /**
707
- * The name of a dependent street or block, such as a street within a complex.
708
- */
709
- dependentThoroughfare?: string | undefined;
710
- /**
711
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
712
- */
713
- locality?: string | undefined;
714
- /**
715
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
716
- */
717
- dependentLocality?: string | undefined;
718
- /**
719
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
720
- */
721
- doubleDependentLocality?: string | undefined;
722
- /**
723
- * 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
724
- */
725
- postalCode?: string | undefined;
726
- /**
727
- * This field contains the post box number associated with a particular delivery point, should one exist.
728
- */
729
- postBox?: string | undefined;
730
- /**
731
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
732
- */
733
- country?: string | undefined;
734
- superAdministrativeArea?: string | undefined;
735
- administrativeArea?: string | undefined;
736
- subAdministrativeArea?: string | undefined;
737
- organization?: string | undefined;
738
- location?: UpdateTaskDocumentCurrentAddressLocation | undefined;
739
- };
740
-
741
- export type UpdateTaskDocumentPreviousAddressLocation = {
742
- latitude?: string | undefined;
743
- longitude?: string | undefined;
744
- geoAccuracy?: string | undefined;
745
- /**
746
- * A What3words designation associated with this location with '.' separator.
747
- */
748
- what3words?: string | undefined;
749
- };
750
-
751
- export type UpdateTaskDocumentPreviousAddress = {
752
- /**
753
- * Unformatted line based address
754
- */
755
- lines?: Array<string> | undefined;
756
- /**
757
- * The address as a single line
758
- */
759
- addressString?: string | undefined;
760
- /**
761
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
762
- */
763
- premise?: string | undefined;
764
- /**
765
- * The name of a building or a building complex. In the US, this is the street number.
766
- */
767
- building?: string | undefined;
768
- /**
769
- * The name of a sub-building, such as a flat or apartment number.
770
- */
771
- subBuilding?: string | undefined;
772
- /**
773
- * This field holds the most common street or block data element within a country. For instance, USA Street
774
- */
775
- thoroughfare?: string | undefined;
776
- /**
777
- * The name of a dependent street or block, such as a street within a complex.
778
- */
779
- dependentThoroughfare?: string | undefined;
780
- /**
781
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
782
- */
783
- locality?: string | undefined;
784
- /**
785
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
786
- */
787
- dependentLocality?: string | undefined;
788
- /**
789
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
790
- */
791
- doubleDependentLocality?: string | undefined;
792
- /**
793
- * 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
794
- */
795
- postalCode?: string | undefined;
796
- /**
797
- * This field contains the post box number associated with a particular delivery point, should one exist.
798
- */
799
- postBox?: string | undefined;
800
- /**
801
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
802
- */
803
- country?: string | undefined;
804
- superAdministrativeArea?: string | undefined;
805
- administrativeArea?: string | undefined;
806
- subAdministrativeArea?: string | undefined;
807
- organization?: string | undefined;
808
- location?: UpdateTaskDocumentPreviousAddressLocation | undefined;
809
- /**
810
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
811
- */
812
- fromDate: string;
813
- /**
814
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
815
- */
816
- toDate: string;
817
- };
818
-
819
- export type UpdateTaskDocumentPlaceOfBirthLocation = {
820
- latitude?: string | undefined;
821
- longitude?: string | undefined;
822
- geoAccuracy?: string | undefined;
823
- /**
824
- * A What3words designation associated with this location with '.' separator.
825
- */
826
- what3words?: string | undefined;
827
- };
828
-
829
- export type UpdateTaskDocumentPlaceOfBirth = {
830
- /**
831
- * Unformatted line based address
832
- */
833
- lines?: Array<string> | undefined;
834
- /**
835
- * The address as a single line
836
- */
837
- addressString?: string | undefined;
838
- /**
839
- * The primary delivery point for a premise or building. This could be a house number, a building name, etc.
840
- */
841
- premise?: string | undefined;
842
- /**
843
- * The name of a building or a building complex. In the US, this is the street number.
844
- */
845
- building?: string | undefined;
846
- /**
847
- * The name of a sub-building, such as a flat or apartment number.
848
- */
849
- subBuilding?: string | undefined;
850
- /**
851
- * This field holds the most common street or block data element within a country. For instance, USA Street
852
- */
853
- thoroughfare?: string | undefined;
854
- /**
855
- * The name of a dependent street or block, such as a street within a complex.
856
- */
857
- dependentThoroughfare?: string | undefined;
858
- /**
859
- * This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
860
- */
861
- locality?: string | undefined;
862
- /**
863
- * This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
864
- */
865
- dependentLocality?: string | undefined;
866
- /**
867
- * This is an even smaller area within a dependent locality, often used in very detailed addresses.
868
- */
869
- doubleDependentLocality?: string | undefined;
870
- /**
871
- * 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
872
- */
873
- postalCode?: string | undefined;
874
- /**
875
- * This field contains the post box number associated with a particular delivery point, should one exist.
876
- */
877
- postBox?: string | undefined;
878
- /**
879
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
880
- */
881
- country?: string | undefined;
882
- superAdministrativeArea?: string | undefined;
883
- administrativeArea?: string | undefined;
884
- subAdministrativeArea?: string | undefined;
885
- organization?: string | undefined;
886
- location?: UpdateTaskDocumentPlaceOfBirthLocation | undefined;
887
- };
888
-
889
- export type UpdateTaskDocumentIdNumber = {
890
- /**
891
- * The type of phone number, such as landline, mobile, fax, unknown etc
892
- */
893
- type: string;
894
- /**
895
- * ID number eg, National Insurance Number in UK, Social Securtiy Number in US
896
- */
897
- idNumber: string;
898
- /**
899
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
900
- */
901
- country?: string | undefined;
902
- };
903
-
904
- export type UpdateTaskDocumentPhone = {
905
- /**
906
- * The type of phone number, such as landline, mobile, fax, unknown etc
907
- */
908
- type: string;
909
- /**
910
- * Phone number, ideally in international format with +(Country Code)
911
- */
912
- number: string;
913
- };
914
-
915
- export type UpdateTaskDocumentEmail = {
916
- /**
917
- * The type of email, such as home, work, unknown etc
918
- */
919
- type: string;
920
- /**
921
- * Email address
922
- */
923
- email: string;
924
- };
925
-
926
- export type UpdateTaskDocumentSocial = {
927
- /**
928
- * An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
929
- */
930
- type: string;
931
- /**
932
- * the identity used on this platform
933
- */
934
- identity: string;
935
- };
936
-
937
- export type UpdateTaskDocumentSubject = {
938
- /**
939
- * Title of an individual such as Mr, Mrs, Dr, Sir
940
- */
941
- title?: string | undefined;
942
- /**
943
- * A person's name used by their collegues and friends to address them
944
- */
945
- firstName?: string | undefined;
946
- /**
947
- * Any other registered names used by the individual, not aliases
948
- */
949
- middleNames?: Array<string> | undefined;
950
- /**
951
- * Any family names for the individual
952
- */
953
- lastNames?: Array<string> | undefined;
954
- /**
955
- * Any family names for the individual
956
- */
957
- lastNamesAtBirth?: Array<string> | undefined;
958
- aliases?: Array<UpdateTaskDocumentAlias> | undefined;
959
- relatedPersons?: Array<UpdateTaskDocumentRelatedPerson> | undefined;
960
- /**
961
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
962
- */
963
- dateOfBirth?: string | undefined;
964
- gender?: string | undefined;
965
- currentAddress?: UpdateTaskDocumentCurrentAddress | undefined;
966
- previousAddresses?: Array<UpdateTaskDocumentPreviousAddress> | undefined;
967
- placeOfBirth?: UpdateTaskDocumentPlaceOfBirth | undefined;
968
- idNumbers?: Array<UpdateTaskDocumentIdNumber> | undefined;
969
- phones?: Array<UpdateTaskDocumentPhone> | undefined;
970
- emails?: Array<UpdateTaskDocumentEmail> | undefined;
971
- socials?: Array<UpdateTaskDocumentSocial> | undefined;
972
- /**
973
- * The subject's mother's maiden name, used for identity verification
974
- */
975
- mothersMaidenName?: string | undefined;
976
- };
977
-
978
- export type UpdateTaskDocument = {
979
- oneDBarcode?: string | undefined;
980
- address?: UpdateTaskAddress | undefined;
981
- applicationDate?: string | undefined;
982
- applicationNumber?: string | undefined;
983
- dateOfBirth?: string | undefined;
984
- placeOfBirth?: string | undefined;
985
- placeOfBirthNative?: string | undefined;
986
- bloodType?: string | undefined;
987
- controlNumber?: string | undefined;
988
- countryCode?: string | undefined;
989
- countryName?: string | undefined;
990
- documentClassCode?: string | undefined;
991
- documentClassName?: string | undefined;
992
- documentNumber?: string | undefined;
993
- documentSignerCertificate?: string | undefined;
994
- employer?: string | undefined;
995
- employerAddress?: string | undefined;
996
- entries?: string | undefined;
997
- expirationDate?: string | undefined;
998
- eyeColor?: string | undefined;
999
- fathersName?: string | undefined;
1000
- fathersNameNative?: string | undefined;
1001
- fathersSurname?: string | undefined;
1002
- firstName?: string | undefined;
1003
- fullName?: string | undefined;
1004
- fullNameNative?: string | undefined;
1005
- givenName?: string | undefined;
1006
- givenNameNative?: string | undefined;
1007
- hairColor?: string | undefined;
1008
- height?: string | undefined;
1009
- /**
1010
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1011
- */
1012
- issueDate?: string | undefined;
1013
- issuingAuthority?: string | undefined;
1014
- issuingAuthorityNative?: string | undefined;
1015
- issuingStateCode?: string | undefined;
1016
- issuingStateName?: string | undefined;
1017
- licenseClass?: string | undefined;
1018
- licenseEndorsements?: string | undefined;
1019
- licenseRestrictions?: string | undefined;
1020
- mrz?: string | undefined;
1021
- mrz1?: string | undefined;
1022
- mrz2?: string | undefined;
1023
- mrz3?: string | undefined;
1024
- middleName?: string | undefined;
1025
- mothersName?: string | undefined;
1026
- mothersNameNative?: string | undefined;
1027
- mothersSurname?: string | undefined;
1028
- nameSuffix?: string | undefined;
1029
- nationalityCode?: string | undefined;
1030
- nationalityName?: string | undefined;
1031
- nationalityNameNative?: string | undefined;
1032
- occupation?: string | undefined;
1033
- organDonor?: boolean | undefined;
1034
- passportNumber?: string | undefined;
1035
- permitNumber?: string | undefined;
1036
- personalNumber?: string | undefined;
1037
- photo?: string | undefined;
1038
- photoCompressed?: string | undefined;
1039
- photoEncoding?: string | undefined;
1040
- sex?: string | undefined;
1041
- sexNative?: string | undefined;
1042
- signature?: string | undefined;
1043
- signatureCompressed?: string | undefined;
1044
- signatureEncoding?: string | undefined;
1045
- socialSecurityNumber?: string | undefined;
1046
- startDate?: string | undefined;
1047
- surname?: string | undefined;
1048
- surnameNative?: string | undefined;
1049
- visaClass?: string | undefined;
1050
- visaNumber?: string | undefined;
1051
- weight?: string | undefined;
1052
- cardNumber?: string | undefined;
1053
- /**
1054
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1055
- */
1056
- issuerCountryCode?: string | undefined;
1057
- id?: string | undefined;
1058
- type?: string | undefined;
1059
- category?: string | undefined;
1060
- subtype?: string | undefined;
1061
- format?: string | undefined;
1062
- device?: UpdateTaskDocumentDevice | undefined;
1063
- side1Image?: string | undefined;
1064
- side2Image?: string | undefined;
1065
- chip?: UpdateTaskChip | undefined;
1066
- classification?: UpdateTaskClassification | undefined;
1067
- extraction?: UpdateTaskExtraction | undefined;
1068
- validation?: UpdateTaskValidation | undefined;
1069
- subType?: string | undefined;
1070
- number?: string | undefined;
1071
- /**
1072
- * Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
1073
- */
1074
- expiryDate?: string | undefined;
1075
- subject?: UpdateTaskDocumentSubject | undefined;
1076
- /**
1077
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1078
- */
1079
- country?: string | undefined;
1080
- };
1081
-
1082
- export type UpdateTaskBiometric4 = {
1083
- id?: string | undefined;
1084
- type?: string | undefined;
1085
- selfieImage: string;
1086
- selfieImageEncryption?: boolean | undefined;
1087
- };
1088
-
1089
- export type UpdateTaskBiometric3 = {
1090
- id?: string | undefined;
1091
- type?: string | undefined;
1092
- faceImage: string;
1093
- };
1094
-
1095
- export type UpdateTaskBiometric2 = {
1096
- id?: string | undefined;
1097
- type?: string | undefined;
1098
- selfieImage: string;
1099
- anchorImage: string;
1100
- };
1101
-
1102
- export type UpdateTaskBiometric1 = {
1103
- id?: string | undefined;
1104
- type?: string | undefined;
1105
- face1Image: string;
1106
- face2Image: string;
1107
- };
1108
-
1109
- export type UpdateTaskBiometricUnion =
1110
- | UpdateTaskBiometric1
1111
- | UpdateTaskBiometric2
1112
- | UpdateTaskBiometric3
1113
- | UpdateTaskBiometric4;
1114
-
1115
- export type UpdateTaskUser = {
1116
- id: string;
1117
- email: string;
1118
- domain: string;
1119
- };
1120
-
1121
- export type UpdateTaskClient = {
1122
- id: string;
1123
- ip: string;
1124
- address: string;
1125
- };
1126
-
1127
- export type UpdateTaskModel = {
1128
- identifier: string;
1129
- name: string;
1130
- };
1131
-
1132
- export type UpdateTaskSessionDevice = {
1133
- id: string;
1134
- manufacturer: string;
1135
- model: UpdateTaskModel;
1136
- };
1137
-
1138
- export type UpdateTaskTrace = {
1139
- id: string;
1140
- };
1141
-
1142
- export type UpdateTaskSpan = {
1143
- id: string;
1144
- };
1145
-
1146
- export type UpdateTaskTransaction = {
1147
- id: string;
1148
- };
1149
-
1150
- export type UpdateTaskSessionAuth = {
1151
- id: string;
1152
- scope?: string | undefined;
1153
- codeVerifier?: string | undefined;
1154
- code?: string | undefined;
1155
- state?: string | undefined;
1156
- redirectUri?: string | undefined;
1157
- responseType?: string | undefined;
1158
- clientId?: string | undefined;
1159
- clientSecret?: string | undefined;
1160
- };
1161
-
1162
- export type UpdateTaskSession = {
1163
- user?: UpdateTaskUser | undefined;
1164
- client?: UpdateTaskClient | undefined;
1165
- device?: UpdateTaskSessionDevice | undefined;
1166
- trace?: UpdateTaskTrace | undefined;
1167
- span?: UpdateTaskSpan | undefined;
1168
- transaction?: UpdateTaskTransaction | undefined;
1169
- auth?: Array<UpdateTaskSessionAuth> | undefined;
1170
- };
1171
-
1172
- export const UpdateTaskConsentType = {
1173
- Rollup: "rollup",
1174
- Explicit: "explicit",
1175
- Implicit: "implicit",
1176
- } as const;
1177
- export type UpdateTaskConsentType = ClosedEnum<typeof UpdateTaskConsentType>;
1178
-
1179
- export type UpdateTaskConsent = {
1180
- type?: UpdateTaskConsentType | undefined;
1181
- id?: string | undefined;
1182
- version?: string | undefined;
1183
- url: string;
1184
- effectiveDate?: string | undefined;
1185
- expiryDate?: string | undefined;
1186
- terms?: string | undefined;
1187
- purpose?: string | undefined;
1188
- legalBasis?: string | undefined;
1189
- jurisdiction?: string | undefined;
1190
- subject?: string | undefined;
1191
- signatory?: string | undefined;
1192
- };
1193
-
1194
- export type UpdateTaskAccount = {
1195
- /**
1196
- * The type of account, e.g. Bank Account, Building Society
1197
- */
1198
- type: string;
1199
- /**
1200
- * Account number
1201
- */
1202
- accountNumber: string;
1203
- /**
1204
- * UK sort code
1205
- */
1206
- sortCode?: string | undefined;
1207
- /**
1208
- * US ABA routing number
1209
- */
1210
- routingNumber?: string | undefined;
1211
- /**
1212
- * International Bank Account Number
1213
- */
1214
- iban?: string | undefined;
1215
- /**
1216
- * BIC/SWIFT code
1217
- */
1218
- bic?: string | undefined;
1219
- /**
1220
- * Name on the account
1221
- */
1222
- accountHolderName?: string | undefined;
1223
- /**
1224
- * Name of the financial institution
1225
- */
1226
- bankName?: string | undefined;
1227
- /**
1228
- * Country the address is in. It must be a valid ISO2 or ISO3 country code
1229
- */
1230
- country?: string | undefined;
1231
- /**
1232
- * Account classification, e.g. current, savings
1233
- */
1234
- accountType?: string | undefined;
1235
- };
1236
-
1237
- export type UpdateTaskSubject = {
1238
- identity?: UpdateTaskIdentity | undefined;
1239
- documents?: Array<UpdateTaskDocument> | undefined;
1240
- biometrics?:
1241
- | Array<
1242
- | UpdateTaskBiometric1
1243
- | UpdateTaskBiometric2
1244
- | UpdateTaskBiometric3
1245
- | UpdateTaskBiometric4
1246
- >
1247
- | undefined;
1248
- sessions?: Array<UpdateTaskSession> | undefined;
1249
- consent?: Array<UpdateTaskConsent> | undefined;
1250
- accounts?: Array<UpdateTaskAccount> | undefined;
1251
- uid?: string | undefined;
1252
- };
1253
-
1254
- export type UpdateTaskContext = {
1255
- subject: UpdateTaskSubject;
1256
- };
1257
-
1258
- export type UpdateTaskRequest = {
1259
- /**
1260
- * Journey Instance Id, a unique identifier for a started journey instance.
1261
- */
1262
- instanceId: string;
1263
- /**
1264
- * Task Id, a unique identifier for a task assigned to an End User during a Journey.
1265
- */
1266
- taskId: string;
1267
- intent: Intent;
1268
- context?: UpdateTaskContext | undefined;
1269
- data?: { [k: string]: any } | undefined;
1270
- };
1271
-
1272
- /**
1273
- * Success
1274
- */
1275
- export type UpdateTaskResponse = {
1276
- /**
1277
- * Journey Instance Id, a unique identifier for a started journey instance.
1278
- */
1279
- instanceId: string;
1280
- /**
1281
- * Task Id, a unique identifier for a task assigned to an End User during a Journey.
1282
- */
1283
- taskId: string;
1284
- };
1285
-
1286
- /** @internal */
1287
- export type UpdateTaskSecurity$Outbound = {
1288
- PingID: string;
1289
- };
1290
-
1291
- /** @internal */
1292
- export const UpdateTaskSecurity$outboundSchema: z.ZodMiniType<
1293
- UpdateTaskSecurity$Outbound,
1294
- UpdateTaskSecurity
1295
- > = z.pipe(
1296
- z.object({
1297
- pingID: z.string(),
1298
- }),
1299
- z.transform((v) => {
1300
- return remap$(v, {
1301
- pingID: "PingID",
1302
- });
1303
- }),
1304
- );
1305
-
1306
- export function updateTaskSecurityToJSON(
1307
- updateTaskSecurity: UpdateTaskSecurity,
1308
- ): string {
1309
- return JSON.stringify(
1310
- UpdateTaskSecurity$outboundSchema.parse(updateTaskSecurity),
1311
- );
1312
- }
1313
-
1314
- /** @internal */
1315
- export const Intent$outboundSchema: z.ZodMiniEnum<typeof Intent> = z.enum(
1316
- Intent,
1317
- );
1318
-
1319
- /** @internal */
1320
- export type UpdateTaskIdentityAlias$Outbound = {
1321
- title?: string | undefined;
1322
- firstName?: string | undefined;
1323
- middleNames?: Array<string> | undefined;
1324
- lastNames?: Array<string> | undefined;
1325
- lastNamesAtBirth?: Array<string> | undefined;
1326
- };
1327
-
1328
- /** @internal */
1329
- export const UpdateTaskIdentityAlias$outboundSchema: z.ZodMiniType<
1330
- UpdateTaskIdentityAlias$Outbound,
1331
- UpdateTaskIdentityAlias
1332
- > = z.object({
1333
- title: z.optional(z.string()),
1334
- firstName: z.optional(z.string()),
1335
- middleNames: z.optional(z.array(z.string())),
1336
- lastNames: z.optional(z.array(z.string())),
1337
- lastNamesAtBirth: z.optional(z.array(z.string())),
1338
- });
1339
-
1340
- export function updateTaskIdentityAliasToJSON(
1341
- updateTaskIdentityAlias: UpdateTaskIdentityAlias,
1342
- ): string {
1343
- return JSON.stringify(
1344
- UpdateTaskIdentityAlias$outboundSchema.parse(updateTaskIdentityAlias),
1345
- );
1346
- }
1347
-
1348
- /** @internal */
1349
- export const UpdateTaskIdentityRelationship$outboundSchema: z.ZodMiniEnum<
1350
- typeof UpdateTaskIdentityRelationship
1351
- > = z.enum(UpdateTaskIdentityRelationship);
1352
-
1353
- /** @internal */
1354
- export type UpdateTaskIdentityRelatedPerson$Outbound = {
1355
- title?: string | undefined;
1356
- firstName?: string | undefined;
1357
- middleNames?: Array<string> | undefined;
1358
- lastNames?: Array<string> | undefined;
1359
- lastNamesAtBirth?: Array<string> | undefined;
1360
- relationship: string;
1361
- };
1362
-
1363
- /** @internal */
1364
- export const UpdateTaskIdentityRelatedPerson$outboundSchema: z.ZodMiniType<
1365
- UpdateTaskIdentityRelatedPerson$Outbound,
1366
- UpdateTaskIdentityRelatedPerson
1367
- > = z.object({
1368
- title: z.optional(z.string()),
1369
- firstName: z.optional(z.string()),
1370
- middleNames: z.optional(z.array(z.string())),
1371
- lastNames: z.optional(z.array(z.string())),
1372
- lastNamesAtBirth: z.optional(z.array(z.string())),
1373
- relationship: UpdateTaskIdentityRelationship$outboundSchema,
1374
- });
1375
-
1376
- export function updateTaskIdentityRelatedPersonToJSON(
1377
- updateTaskIdentityRelatedPerson: UpdateTaskIdentityRelatedPerson,
1378
- ): string {
1379
- return JSON.stringify(
1380
- UpdateTaskIdentityRelatedPerson$outboundSchema.parse(
1381
- updateTaskIdentityRelatedPerson,
1382
- ),
1383
- );
1384
- }
1385
-
1386
- /** @internal */
1387
- export type UpdateTaskIdentityCurrentAddressLocation$Outbound = {
1388
- latitude?: string | undefined;
1389
- longitude?: string | undefined;
1390
- geoAccuracy?: string | undefined;
1391
- what3words?: string | undefined;
1392
- };
1393
-
1394
- /** @internal */
1395
- export const UpdateTaskIdentityCurrentAddressLocation$outboundSchema:
1396
- z.ZodMiniType<
1397
- UpdateTaskIdentityCurrentAddressLocation$Outbound,
1398
- UpdateTaskIdentityCurrentAddressLocation
1399
- > = z.object({
1400
- latitude: z.optional(z.string()),
1401
- longitude: z.optional(z.string()),
1402
- geoAccuracy: z.optional(z.string()),
1403
- what3words: z.optional(z.string()),
1404
- });
1405
-
1406
- export function updateTaskIdentityCurrentAddressLocationToJSON(
1407
- updateTaskIdentityCurrentAddressLocation:
1408
- UpdateTaskIdentityCurrentAddressLocation,
1409
- ): string {
1410
- return JSON.stringify(
1411
- UpdateTaskIdentityCurrentAddressLocation$outboundSchema.parse(
1412
- updateTaskIdentityCurrentAddressLocation,
1413
- ),
1414
- );
1415
- }
1416
-
1417
- /** @internal */
1418
- export type UpdateTaskIdentityCurrentAddress$Outbound = {
1419
- lines?: Array<string> | undefined;
1420
- addressString?: string | undefined;
1421
- premise?: string | undefined;
1422
- building?: string | undefined;
1423
- subBuilding?: string | undefined;
1424
- thoroughfare?: string | undefined;
1425
- dependentThoroughfare?: string | undefined;
1426
- locality?: string | undefined;
1427
- dependentLocality?: string | undefined;
1428
- doubleDependentLocality?: string | undefined;
1429
- postalCode?: string | undefined;
1430
- postBox?: string | undefined;
1431
- country?: string | undefined;
1432
- superAdministrativeArea?: string | undefined;
1433
- administrativeArea?: string | undefined;
1434
- subAdministrativeArea?: string | undefined;
1435
- organization?: string | undefined;
1436
- location?: UpdateTaskIdentityCurrentAddressLocation$Outbound | undefined;
1437
- };
1438
-
1439
- /** @internal */
1440
- export const UpdateTaskIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
1441
- UpdateTaskIdentityCurrentAddress$Outbound,
1442
- UpdateTaskIdentityCurrentAddress
1443
- > = z.object({
1444
- lines: z.optional(z.array(z.string())),
1445
- addressString: z.optional(z.string()),
1446
- premise: z.optional(z.string()),
1447
- building: z.optional(z.string()),
1448
- subBuilding: z.optional(z.string()),
1449
- thoroughfare: z.optional(z.string()),
1450
- dependentThoroughfare: z.optional(z.string()),
1451
- locality: z.optional(z.string()),
1452
- dependentLocality: z.optional(z.string()),
1453
- doubleDependentLocality: z.optional(z.string()),
1454
- postalCode: z.optional(z.string()),
1455
- postBox: z.optional(z.string()),
1456
- country: z.optional(z.string()),
1457
- superAdministrativeArea: z.optional(z.string()),
1458
- administrativeArea: z.optional(z.string()),
1459
- subAdministrativeArea: z.optional(z.string()),
1460
- organization: z.optional(z.string()),
1461
- location: z.optional(
1462
- z.lazy(() => UpdateTaskIdentityCurrentAddressLocation$outboundSchema),
1463
- ),
1464
- });
1465
-
1466
- export function updateTaskIdentityCurrentAddressToJSON(
1467
- updateTaskIdentityCurrentAddress: UpdateTaskIdentityCurrentAddress,
1468
- ): string {
1469
- return JSON.stringify(
1470
- UpdateTaskIdentityCurrentAddress$outboundSchema.parse(
1471
- updateTaskIdentityCurrentAddress,
1472
- ),
1473
- );
1474
- }
1475
-
1476
- /** @internal */
1477
- export type UpdateTaskIdentityPreviousAddressLocation$Outbound = {
1478
- latitude?: string | undefined;
1479
- longitude?: string | undefined;
1480
- geoAccuracy?: string | undefined;
1481
- what3words?: string | undefined;
1482
- };
1483
-
1484
- /** @internal */
1485
- export const UpdateTaskIdentityPreviousAddressLocation$outboundSchema:
1486
- z.ZodMiniType<
1487
- UpdateTaskIdentityPreviousAddressLocation$Outbound,
1488
- UpdateTaskIdentityPreviousAddressLocation
1489
- > = z.object({
1490
- latitude: z.optional(z.string()),
1491
- longitude: z.optional(z.string()),
1492
- geoAccuracy: z.optional(z.string()),
1493
- what3words: z.optional(z.string()),
1494
- });
1495
-
1496
- export function updateTaskIdentityPreviousAddressLocationToJSON(
1497
- updateTaskIdentityPreviousAddressLocation:
1498
- UpdateTaskIdentityPreviousAddressLocation,
1499
- ): string {
1500
- return JSON.stringify(
1501
- UpdateTaskIdentityPreviousAddressLocation$outboundSchema.parse(
1502
- updateTaskIdentityPreviousAddressLocation,
1503
- ),
1504
- );
1505
- }
1506
-
1507
- /** @internal */
1508
- export type UpdateTaskIdentityPreviousAddress$Outbound = {
1509
- lines?: Array<string> | undefined;
1510
- addressString?: string | undefined;
1511
- premise?: string | undefined;
1512
- building?: string | undefined;
1513
- subBuilding?: string | undefined;
1514
- thoroughfare?: string | undefined;
1515
- dependentThoroughfare?: string | undefined;
1516
- locality?: string | undefined;
1517
- dependentLocality?: string | undefined;
1518
- doubleDependentLocality?: string | undefined;
1519
- postalCode?: string | undefined;
1520
- postBox?: string | undefined;
1521
- country?: string | undefined;
1522
- superAdministrativeArea?: string | undefined;
1523
- administrativeArea?: string | undefined;
1524
- subAdministrativeArea?: string | undefined;
1525
- organization?: string | undefined;
1526
- location?: UpdateTaskIdentityPreviousAddressLocation$Outbound | undefined;
1527
- fromDate: string;
1528
- toDate: string;
1529
- };
1530
-
1531
- /** @internal */
1532
- export const UpdateTaskIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
1533
- UpdateTaskIdentityPreviousAddress$Outbound,
1534
- UpdateTaskIdentityPreviousAddress
1535
- > = z.object({
1536
- lines: z.optional(z.array(z.string())),
1537
- addressString: z.optional(z.string()),
1538
- premise: z.optional(z.string()),
1539
- building: z.optional(z.string()),
1540
- subBuilding: z.optional(z.string()),
1541
- thoroughfare: z.optional(z.string()),
1542
- dependentThoroughfare: z.optional(z.string()),
1543
- locality: z.optional(z.string()),
1544
- dependentLocality: z.optional(z.string()),
1545
- doubleDependentLocality: z.optional(z.string()),
1546
- postalCode: z.optional(z.string()),
1547
- postBox: z.optional(z.string()),
1548
- country: z.optional(z.string()),
1549
- superAdministrativeArea: z.optional(z.string()),
1550
- administrativeArea: z.optional(z.string()),
1551
- subAdministrativeArea: z.optional(z.string()),
1552
- organization: z.optional(z.string()),
1553
- location: z.optional(
1554
- z.lazy(() => UpdateTaskIdentityPreviousAddressLocation$outboundSchema),
1555
- ),
1556
- fromDate: z.string(),
1557
- toDate: z.string(),
1558
- });
1559
-
1560
- export function updateTaskIdentityPreviousAddressToJSON(
1561
- updateTaskIdentityPreviousAddress: UpdateTaskIdentityPreviousAddress,
1562
- ): string {
1563
- return JSON.stringify(
1564
- UpdateTaskIdentityPreviousAddress$outboundSchema.parse(
1565
- updateTaskIdentityPreviousAddress,
1566
- ),
1567
- );
1568
- }
1569
-
1570
- /** @internal */
1571
- export type UpdateTaskIdentityPlaceOfBirthLocation$Outbound = {
1572
- latitude?: string | undefined;
1573
- longitude?: string | undefined;
1574
- geoAccuracy?: string | undefined;
1575
- what3words?: string | undefined;
1576
- };
1577
-
1578
- /** @internal */
1579
- export const UpdateTaskIdentityPlaceOfBirthLocation$outboundSchema:
1580
- z.ZodMiniType<
1581
- UpdateTaskIdentityPlaceOfBirthLocation$Outbound,
1582
- UpdateTaskIdentityPlaceOfBirthLocation
1583
- > = z.object({
1584
- latitude: z.optional(z.string()),
1585
- longitude: z.optional(z.string()),
1586
- geoAccuracy: z.optional(z.string()),
1587
- what3words: z.optional(z.string()),
1588
- });
1589
-
1590
- export function updateTaskIdentityPlaceOfBirthLocationToJSON(
1591
- updateTaskIdentityPlaceOfBirthLocation:
1592
- UpdateTaskIdentityPlaceOfBirthLocation,
1593
- ): string {
1594
- return JSON.stringify(
1595
- UpdateTaskIdentityPlaceOfBirthLocation$outboundSchema.parse(
1596
- updateTaskIdentityPlaceOfBirthLocation,
1597
- ),
1598
- );
1599
- }
1600
-
1601
- /** @internal */
1602
- export type UpdateTaskIdentityPlaceOfBirth$Outbound = {
1603
- lines?: Array<string> | undefined;
1604
- addressString?: string | undefined;
1605
- premise?: string | undefined;
1606
- building?: string | undefined;
1607
- subBuilding?: string | undefined;
1608
- thoroughfare?: string | undefined;
1609
- dependentThoroughfare?: string | undefined;
1610
- locality?: string | undefined;
1611
- dependentLocality?: string | undefined;
1612
- doubleDependentLocality?: string | undefined;
1613
- postalCode?: string | undefined;
1614
- postBox?: string | undefined;
1615
- country?: string | undefined;
1616
- superAdministrativeArea?: string | undefined;
1617
- administrativeArea?: string | undefined;
1618
- subAdministrativeArea?: string | undefined;
1619
- organization?: string | undefined;
1620
- location?: UpdateTaskIdentityPlaceOfBirthLocation$Outbound | undefined;
1621
- };
1622
-
1623
- /** @internal */
1624
- export const UpdateTaskIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
1625
- UpdateTaskIdentityPlaceOfBirth$Outbound,
1626
- UpdateTaskIdentityPlaceOfBirth
1627
- > = z.object({
1628
- lines: z.optional(z.array(z.string())),
1629
- addressString: z.optional(z.string()),
1630
- premise: z.optional(z.string()),
1631
- building: z.optional(z.string()),
1632
- subBuilding: z.optional(z.string()),
1633
- thoroughfare: z.optional(z.string()),
1634
- dependentThoroughfare: z.optional(z.string()),
1635
- locality: z.optional(z.string()),
1636
- dependentLocality: z.optional(z.string()),
1637
- doubleDependentLocality: z.optional(z.string()),
1638
- postalCode: z.optional(z.string()),
1639
- postBox: z.optional(z.string()),
1640
- country: z.optional(z.string()),
1641
- superAdministrativeArea: z.optional(z.string()),
1642
- administrativeArea: z.optional(z.string()),
1643
- subAdministrativeArea: z.optional(z.string()),
1644
- organization: z.optional(z.string()),
1645
- location: z.optional(
1646
- z.lazy(() => UpdateTaskIdentityPlaceOfBirthLocation$outboundSchema),
1647
- ),
1648
- });
1649
-
1650
- export function updateTaskIdentityPlaceOfBirthToJSON(
1651
- updateTaskIdentityPlaceOfBirth: UpdateTaskIdentityPlaceOfBirth,
1652
- ): string {
1653
- return JSON.stringify(
1654
- UpdateTaskIdentityPlaceOfBirth$outboundSchema.parse(
1655
- updateTaskIdentityPlaceOfBirth,
1656
- ),
1657
- );
1658
- }
1659
-
1660
- /** @internal */
1661
- export type UpdateTaskIdentityIdNumber$Outbound = {
1662
- type: string;
1663
- idNumber: string;
1664
- country?: string | undefined;
1665
- };
1666
-
1667
- /** @internal */
1668
- export const UpdateTaskIdentityIdNumber$outboundSchema: z.ZodMiniType<
1669
- UpdateTaskIdentityIdNumber$Outbound,
1670
- UpdateTaskIdentityIdNumber
1671
- > = z.object({
1672
- type: z.string(),
1673
- idNumber: z.string(),
1674
- country: z.optional(z.string()),
1675
- });
1676
-
1677
- export function updateTaskIdentityIdNumberToJSON(
1678
- updateTaskIdentityIdNumber: UpdateTaskIdentityIdNumber,
1679
- ): string {
1680
- return JSON.stringify(
1681
- UpdateTaskIdentityIdNumber$outboundSchema.parse(updateTaskIdentityIdNumber),
1682
- );
1683
- }
1684
-
1685
- /** @internal */
1686
- export type UpdateTaskIdentityPhone$Outbound = {
1687
- type: string;
1688
- number: string;
1689
- };
1690
-
1691
- /** @internal */
1692
- export const UpdateTaskIdentityPhone$outboundSchema: z.ZodMiniType<
1693
- UpdateTaskIdentityPhone$Outbound,
1694
- UpdateTaskIdentityPhone
1695
- > = z.object({
1696
- type: z.string(),
1697
- number: z.string(),
1698
- });
1699
-
1700
- export function updateTaskIdentityPhoneToJSON(
1701
- updateTaskIdentityPhone: UpdateTaskIdentityPhone,
1702
- ): string {
1703
- return JSON.stringify(
1704
- UpdateTaskIdentityPhone$outboundSchema.parse(updateTaskIdentityPhone),
1705
- );
1706
- }
1707
-
1708
- /** @internal */
1709
- export type UpdateTaskIdentityEmail$Outbound = {
1710
- type: string;
1711
- email: string;
1712
- };
1713
-
1714
- /** @internal */
1715
- export const UpdateTaskIdentityEmail$outboundSchema: z.ZodMiniType<
1716
- UpdateTaskIdentityEmail$Outbound,
1717
- UpdateTaskIdentityEmail
1718
- > = z.object({
1719
- type: z.string(),
1720
- email: z.string(),
1721
- });
1722
-
1723
- export function updateTaskIdentityEmailToJSON(
1724
- updateTaskIdentityEmail: UpdateTaskIdentityEmail,
1725
- ): string {
1726
- return JSON.stringify(
1727
- UpdateTaskIdentityEmail$outboundSchema.parse(updateTaskIdentityEmail),
1728
- );
1729
- }
1730
-
1731
- /** @internal */
1732
- export type UpdateTaskIdentitySocial$Outbound = {
1733
- type: string;
1734
- identity: string;
1735
- };
1736
-
1737
- /** @internal */
1738
- export const UpdateTaskIdentitySocial$outboundSchema: z.ZodMiniType<
1739
- UpdateTaskIdentitySocial$Outbound,
1740
- UpdateTaskIdentitySocial
1741
- > = z.object({
1742
- type: z.string(),
1743
- identity: z.string(),
1744
- });
1745
-
1746
- export function updateTaskIdentitySocialToJSON(
1747
- updateTaskIdentitySocial: UpdateTaskIdentitySocial,
1748
- ): string {
1749
- return JSON.stringify(
1750
- UpdateTaskIdentitySocial$outboundSchema.parse(updateTaskIdentitySocial),
1751
- );
1752
- }
1753
-
1754
- /** @internal */
1755
- export type UpdateTaskIdentity$Outbound = {
1756
- title?: string | undefined;
1757
- firstName?: string | undefined;
1758
- middleNames?: Array<string> | undefined;
1759
- lastNames?: Array<string> | undefined;
1760
- lastNamesAtBirth?: Array<string> | undefined;
1761
- aliases?: Array<UpdateTaskIdentityAlias$Outbound> | undefined;
1762
- relatedPersons?: Array<UpdateTaskIdentityRelatedPerson$Outbound> | undefined;
1763
- dateOfBirth?: string | undefined;
1764
- gender?: string | undefined;
1765
- currentAddress?: UpdateTaskIdentityCurrentAddress$Outbound | undefined;
1766
- previousAddresses?:
1767
- | Array<UpdateTaskIdentityPreviousAddress$Outbound>
1768
- | undefined;
1769
- placeOfBirth?: UpdateTaskIdentityPlaceOfBirth$Outbound | undefined;
1770
- idNumbers?: Array<UpdateTaskIdentityIdNumber$Outbound> | undefined;
1771
- phones?: Array<UpdateTaskIdentityPhone$Outbound> | undefined;
1772
- emails?: Array<UpdateTaskIdentityEmail$Outbound> | undefined;
1773
- socials?: Array<UpdateTaskIdentitySocial$Outbound> | undefined;
1774
- mothersMaidenName?: string | undefined;
1775
- };
1776
-
1777
- /** @internal */
1778
- export const UpdateTaskIdentity$outboundSchema: z.ZodMiniType<
1779
- UpdateTaskIdentity$Outbound,
1780
- UpdateTaskIdentity
1781
- > = z.object({
1782
- title: z.optional(z.string()),
1783
- firstName: z.optional(z.string()),
1784
- middleNames: z.optional(z.array(z.string())),
1785
- lastNames: z.optional(z.array(z.string())),
1786
- lastNamesAtBirth: z.optional(z.array(z.string())),
1787
- aliases: z.optional(
1788
- z.array(z.lazy(() => UpdateTaskIdentityAlias$outboundSchema)),
1789
- ),
1790
- relatedPersons: z.optional(
1791
- z.array(z.lazy(() => UpdateTaskIdentityRelatedPerson$outboundSchema)),
1792
- ),
1793
- dateOfBirth: z.optional(z.string()),
1794
- gender: z.optional(z.string()),
1795
- currentAddress: z.optional(
1796
- z.lazy(() => UpdateTaskIdentityCurrentAddress$outboundSchema),
1797
- ),
1798
- previousAddresses: z.optional(
1799
- z.array(z.lazy(() => UpdateTaskIdentityPreviousAddress$outboundSchema)),
1800
- ),
1801
- placeOfBirth: z.optional(
1802
- z.lazy(() => UpdateTaskIdentityPlaceOfBirth$outboundSchema),
1803
- ),
1804
- idNumbers: z.optional(
1805
- z.array(z.lazy(() => UpdateTaskIdentityIdNumber$outboundSchema)),
1806
- ),
1807
- phones: z.optional(
1808
- z.array(z.lazy(() => UpdateTaskIdentityPhone$outboundSchema)),
1809
- ),
1810
- emails: z.optional(
1811
- z.array(z.lazy(() => UpdateTaskIdentityEmail$outboundSchema)),
1812
- ),
1813
- socials: z.optional(
1814
- z.array(z.lazy(() => UpdateTaskIdentitySocial$outboundSchema)),
1815
- ),
1816
- mothersMaidenName: z.optional(z.string()),
1817
- });
1818
-
1819
- export function updateTaskIdentityToJSON(
1820
- updateTaskIdentity: UpdateTaskIdentity,
1821
- ): string {
1822
- return JSON.stringify(
1823
- UpdateTaskIdentity$outboundSchema.parse(updateTaskIdentity),
1824
- );
1825
- }
1826
-
1827
- /** @internal */
1828
- export type UpdateTaskAddress$Outbound = {
1829
- addressString?: string | undefined;
1830
- extractedAddressString?: string | undefined;
1831
- addressLine1?: string | undefined;
1832
- addressLine2?: string | undefined;
1833
- locality?: string | undefined;
1834
- administrativeArea?: string | undefined;
1835
- postalCode?: string | undefined;
1836
- };
1837
-
1838
- /** @internal */
1839
- export const UpdateTaskAddress$outboundSchema: z.ZodMiniType<
1840
- UpdateTaskAddress$Outbound,
1841
- UpdateTaskAddress
1842
- > = z.object({
1843
- addressString: z.optional(z.string()),
1844
- extractedAddressString: z.optional(z.string()),
1845
- addressLine1: z.optional(z.string()),
1846
- addressLine2: z.optional(z.string()),
1847
- locality: z.optional(z.string()),
1848
- administrativeArea: z.optional(z.string()),
1849
- postalCode: z.optional(z.string()),
1850
- });
1851
-
1852
- export function updateTaskAddressToJSON(
1853
- updateTaskAddress: UpdateTaskAddress,
1854
- ): string {
1855
- return JSON.stringify(
1856
- UpdateTaskAddress$outboundSchema.parse(updateTaskAddress),
1857
- );
1858
- }
1859
-
1860
- /** @internal */
1861
- export type UpdateTaskDocumentDevice$Outbound = {
1862
- type?: string | undefined;
1863
- model?: string | undefined;
1864
- hasContactlessReader?: boolean | undefined;
1865
- hasMagneticStripeReader?: boolean | undefined;
1866
- hasCamera?: boolean | undefined;
1867
- serialNumber?: string | undefined;
1868
- manufacturer?: string | undefined;
1869
- };
1870
-
1871
- /** @internal */
1872
- export const UpdateTaskDocumentDevice$outboundSchema: z.ZodMiniType<
1873
- UpdateTaskDocumentDevice$Outbound,
1874
- UpdateTaskDocumentDevice
1875
- > = z.object({
1876
- type: z.optional(z.string()),
1877
- model: z.optional(z.string()),
1878
- hasContactlessReader: z.optional(z.boolean()),
1879
- hasMagneticStripeReader: z.optional(z.boolean()),
1880
- hasCamera: z.optional(z.boolean()),
1881
- serialNumber: z.optional(z.string()),
1882
- manufacturer: z.optional(z.string()),
1883
- });
1884
-
1885
- export function updateTaskDocumentDeviceToJSON(
1886
- updateTaskDocumentDevice: UpdateTaskDocumentDevice,
1887
- ): string {
1888
- return JSON.stringify(
1889
- UpdateTaskDocumentDevice$outboundSchema.parse(updateTaskDocumentDevice),
1890
- );
1891
- }
1892
-
1893
- /** @internal */
1894
- export const UpdateTaskName$outboundSchema: z.ZodMiniEnum<
1895
- typeof UpdateTaskName
1896
- > = z.enum(UpdateTaskName);
1897
-
1898
- /** @internal */
1899
- export type UpdateTaskLd$Outbound = {
1900
- name: string;
1901
- data: string;
1902
- [additionalProperties: string]: unknown;
1903
- };
1904
-
1905
- /** @internal */
1906
- export const UpdateTaskLd$outboundSchema: z.ZodMiniType<
1907
- UpdateTaskLd$Outbound,
1908
- UpdateTaskLd
1909
- > = z.catchall(
1910
- z.object({
1911
- name: UpdateTaskName$outboundSchema,
1912
- data: z.string(),
1913
- }),
1914
- z.any(),
1915
- );
1916
-
1917
- export function updateTaskLdToJSON(updateTaskLd: UpdateTaskLd): string {
1918
- return JSON.stringify(UpdateTaskLd$outboundSchema.parse(updateTaskLd));
1919
- }
1920
-
1921
- /** @internal */
1922
- export const UpdateTaskAuthType$outboundSchema: z.ZodMiniEnum<
1923
- typeof UpdateTaskAuthType
1924
- > = z.enum(UpdateTaskAuthType);
1925
-
1926
- /** @internal */
1927
- export const UpdateTaskResult$outboundSchema: z.ZodMiniEnum<
1928
- typeof UpdateTaskResult
1929
- > = z.enum(UpdateTaskResult);
1930
-
1931
- /** @internal */
1932
- export type UpdateTaskChipAuth$Outbound = {
1933
- type: string;
1934
- result: string;
1935
- [additionalProperties: string]: unknown;
1936
- };
1937
-
1938
- /** @internal */
1939
- export const UpdateTaskChipAuth$outboundSchema: z.ZodMiniType<
1940
- UpdateTaskChipAuth$Outbound,
1941
- UpdateTaskChipAuth
1942
- > = z.catchall(
1943
- z.object({
1944
- type: UpdateTaskAuthType$outboundSchema,
1945
- result: UpdateTaskResult$outboundSchema,
1946
- }),
1947
- z.any(),
1948
- );
1949
-
1950
- export function updateTaskChipAuthToJSON(
1951
- updateTaskChipAuth: UpdateTaskChipAuth,
1952
- ): string {
1953
- return JSON.stringify(
1954
- UpdateTaskChipAuth$outboundSchema.parse(updateTaskChipAuth),
1955
- );
1956
- }
1957
-
1958
- /** @internal */
1959
- export type UpdateTaskChip$Outbound = {
1960
- lds: Array<UpdateTaskLd$Outbound>;
1961
- auth: Array<UpdateTaskChipAuth$Outbound>;
1962
- [additionalProperties: string]: unknown;
1963
- };
1964
-
1965
- /** @internal */
1966
- export const UpdateTaskChip$outboundSchema: z.ZodMiniType<
1967
- UpdateTaskChip$Outbound,
1968
- UpdateTaskChip
1969
- > = z.catchall(
1970
- z.object({
1971
- lds: z.array(z.lazy(() => UpdateTaskLd$outboundSchema)),
1972
- auth: z.array(z.lazy(() => UpdateTaskChipAuth$outboundSchema)),
1973
- }),
1974
- z.any(),
1975
- );
1976
-
1977
- export function updateTaskChipToJSON(updateTaskChip: UpdateTaskChip): string {
1978
- return JSON.stringify(UpdateTaskChip$outboundSchema.parse(updateTaskChip));
1979
- }
1980
-
1981
- /** @internal */
1982
- export type UpdateTaskSide$Outbound = {
1983
- side: string;
1984
- id: string;
1985
- documentQuality: string;
1986
- documentQualityScore: number;
1987
- };
1988
-
1989
- /** @internal */
1990
- export const UpdateTaskSide$outboundSchema: z.ZodMiniType<
1991
- UpdateTaskSide$Outbound,
1992
- UpdateTaskSide
1993
- > = z.object({
1994
- side: z.string(),
1995
- id: z.string(),
1996
- documentQuality: z.string(),
1997
- documentQualityScore: z.number(),
1998
- });
1999
-
2000
- export function updateTaskSideToJSON(updateTaskSide: UpdateTaskSide): string {
2001
- return JSON.stringify(UpdateTaskSide$outboundSchema.parse(updateTaskSide));
2002
- }
2003
-
2004
- /** @internal */
2005
- export type UpdateTaskClassification$Outbound = {
2006
- ids?: Array<string> | undefined;
2007
- category?: string | undefined;
2008
- type?: string | undefined;
2009
- subtype?: string | undefined;
2010
- isDoubleSided?: boolean | undefined;
2011
- hasNFC?: boolean | undefined;
2012
- year?: string | undefined;
2013
- countryCode?: string | undefined;
2014
- countryName?: string | undefined;
2015
- stateCode?: string | undefined;
2016
- stateName?: string | undefined;
2017
- sides?: Array<UpdateTaskSide$Outbound> | undefined;
2018
- };
2019
-
2020
- /** @internal */
2021
- export const UpdateTaskClassification$outboundSchema: z.ZodMiniType<
2022
- UpdateTaskClassification$Outbound,
2023
- UpdateTaskClassification
2024
- > = z.object({
2025
- ids: z.optional(z.array(z.string())),
2026
- category: z.optional(z.string()),
2027
- type: z.optional(z.string()),
2028
- subtype: z.optional(z.string()),
2029
- isDoubleSided: z.optional(z.boolean()),
2030
- hasNFC: z.optional(z.boolean()),
2031
- year: z.optional(z.string()),
2032
- countryCode: z.optional(z.string()),
2033
- countryName: z.optional(z.string()),
2034
- stateCode: z.optional(z.string()),
2035
- stateName: z.optional(z.string()),
2036
- sides: z.optional(z.array(z.lazy(() => UpdateTaskSide$outboundSchema))),
2037
- });
2038
-
2039
- export function updateTaskClassificationToJSON(
2040
- updateTaskClassification: UpdateTaskClassification,
2041
- ): string {
2042
- return JSON.stringify(
2043
- UpdateTaskClassification$outboundSchema.parse(updateTaskClassification),
2044
- );
2045
- }
2046
-
2047
- /** @internal */
2048
- export type UpdateTaskAggregatedFieldBoundingBox$Outbound = {
2049
- x: number;
2050
- y: number;
2051
- width: number;
2052
- height: number;
2053
- };
2054
-
2055
- /** @internal */
2056
- export const UpdateTaskAggregatedFieldBoundingBox$outboundSchema: z.ZodMiniType<
2057
- UpdateTaskAggregatedFieldBoundingBox$Outbound,
2058
- UpdateTaskAggregatedFieldBoundingBox
2059
- > = z.object({
2060
- x: z.number(),
2061
- y: z.number(),
2062
- width: z.number(),
2063
- height: z.number(),
2064
- });
2065
-
2066
- export function updateTaskAggregatedFieldBoundingBoxToJSON(
2067
- updateTaskAggregatedFieldBoundingBox: UpdateTaskAggregatedFieldBoundingBox,
2068
- ): string {
2069
- return JSON.stringify(
2070
- UpdateTaskAggregatedFieldBoundingBox$outboundSchema.parse(
2071
- updateTaskAggregatedFieldBoundingBox,
2072
- ),
2073
- );
2074
- }
2075
-
2076
- /** @internal */
2077
- export type UpdateTaskAggregatedFieldRegionOfInterest$Outbound = {
2078
- boundingBox?: UpdateTaskAggregatedFieldBoundingBox$Outbound | undefined;
2079
- side: string;
2080
- spectrum?: string | undefined;
2081
- imageId?: string | undefined;
2082
- };
2083
-
2084
- /** @internal */
2085
- export const UpdateTaskAggregatedFieldRegionOfInterest$outboundSchema:
2086
- z.ZodMiniType<
2087
- UpdateTaskAggregatedFieldRegionOfInterest$Outbound,
2088
- UpdateTaskAggregatedFieldRegionOfInterest
2089
- > = z.object({
2090
- boundingBox: z.optional(
2091
- z.lazy(() => UpdateTaskAggregatedFieldBoundingBox$outboundSchema),
2092
- ),
2093
- side: z.string(),
2094
- spectrum: z.optional(z.string()),
2095
- imageId: z.optional(z.string()),
2096
- });
2097
-
2098
- export function updateTaskAggregatedFieldRegionOfInterestToJSON(
2099
- updateTaskAggregatedFieldRegionOfInterest:
2100
- UpdateTaskAggregatedFieldRegionOfInterest,
2101
- ): string {
2102
- return JSON.stringify(
2103
- UpdateTaskAggregatedFieldRegionOfInterest$outboundSchema.parse(
2104
- updateTaskAggregatedFieldRegionOfInterest,
2105
- ),
2106
- );
2107
- }
2108
-
2109
- /** @internal */
2110
- export type UpdateTaskAggregatedField$Outbound = {
2111
- label: string;
2112
- value: string;
2113
- source: string;
2114
- isNonLatin: boolean;
2115
- regionOfInterest?:
2116
- | UpdateTaskAggregatedFieldRegionOfInterest$Outbound
2117
- | undefined;
2118
- };
2119
-
2120
- /** @internal */
2121
- export const UpdateTaskAggregatedField$outboundSchema: z.ZodMiniType<
2122
- UpdateTaskAggregatedField$Outbound,
2123
- UpdateTaskAggregatedField
2124
- > = z.object({
2125
- label: z.string(),
2126
- value: z.string(),
2127
- source: z.string(),
2128
- isNonLatin: z.boolean(),
2129
- regionOfInterest: z.optional(
2130
- z.lazy(() => UpdateTaskAggregatedFieldRegionOfInterest$outboundSchema),
2131
- ),
2132
- });
2133
-
2134
- export function updateTaskAggregatedFieldToJSON(
2135
- updateTaskAggregatedField: UpdateTaskAggregatedField,
2136
- ): string {
2137
- return JSON.stringify(
2138
- UpdateTaskAggregatedField$outboundSchema.parse(updateTaskAggregatedField),
2139
- );
2140
- }
2141
-
2142
- /** @internal */
2143
- export type UpdateTaskDetailBoundingBox$Outbound = {
2144
- x: number;
2145
- y: number;
2146
- width: number;
2147
- height: number;
2148
- };
2149
-
2150
- /** @internal */
2151
- export const UpdateTaskDetailBoundingBox$outboundSchema: z.ZodMiniType<
2152
- UpdateTaskDetailBoundingBox$Outbound,
2153
- UpdateTaskDetailBoundingBox
2154
- > = z.object({
2155
- x: z.number(),
2156
- y: z.number(),
2157
- width: z.number(),
2158
- height: z.number(),
2159
- });
2160
-
2161
- export function updateTaskDetailBoundingBoxToJSON(
2162
- updateTaskDetailBoundingBox: UpdateTaskDetailBoundingBox,
2163
- ): string {
2164
- return JSON.stringify(
2165
- UpdateTaskDetailBoundingBox$outboundSchema.parse(
2166
- updateTaskDetailBoundingBox,
2167
- ),
2168
- );
2169
- }
2170
-
2171
- /** @internal */
2172
- export type UpdateTaskDetailRegionOfInterest$Outbound = {
2173
- boundingBox?: UpdateTaskDetailBoundingBox$Outbound | undefined;
2174
- side: string;
2175
- spectrum?: string | undefined;
2176
- imageId?: string | undefined;
2177
- };
2178
-
2179
- /** @internal */
2180
- export const UpdateTaskDetailRegionOfInterest$outboundSchema: z.ZodMiniType<
2181
- UpdateTaskDetailRegionOfInterest$Outbound,
2182
- UpdateTaskDetailRegionOfInterest
2183
- > = z.object({
2184
- boundingBox: z.optional(
2185
- z.lazy(() => UpdateTaskDetailBoundingBox$outboundSchema),
2186
- ),
2187
- side: z.string(),
2188
- spectrum: z.optional(z.string()),
2189
- imageId: z.optional(z.string()),
2190
- });
2191
-
2192
- export function updateTaskDetailRegionOfInterestToJSON(
2193
- updateTaskDetailRegionOfInterest: UpdateTaskDetailRegionOfInterest,
2194
- ): string {
2195
- return JSON.stringify(
2196
- UpdateTaskDetailRegionOfInterest$outboundSchema.parse(
2197
- updateTaskDetailRegionOfInterest,
2198
- ),
2199
- );
2200
- }
2201
-
2202
- /** @internal */
2203
- export type UpdateTaskDetail$Outbound = {
2204
- label: string;
2205
- value: string;
2206
- source: string;
2207
- isNonLatin: boolean;
2208
- regionOfInterest?: UpdateTaskDetailRegionOfInterest$Outbound | undefined;
2209
- };
2210
-
2211
- /** @internal */
2212
- export const UpdateTaskDetail$outboundSchema: z.ZodMiniType<
2213
- UpdateTaskDetail$Outbound,
2214
- UpdateTaskDetail
2215
- > = z.object({
2216
- label: z.string(),
2217
- value: z.string(),
2218
- source: z.string(),
2219
- isNonLatin: z.boolean(),
2220
- regionOfInterest: z.optional(
2221
- z.lazy(() => UpdateTaskDetailRegionOfInterest$outboundSchema),
2222
- ),
2223
- });
2224
-
2225
- export function updateTaskDetailToJSON(
2226
- updateTaskDetail: UpdateTaskDetail,
2227
- ): string {
2228
- return JSON.stringify(
2229
- UpdateTaskDetail$outboundSchema.parse(updateTaskDetail),
2230
- );
2231
- }
2232
-
2233
- /** @internal */
2234
- export type UpdateTaskExtractedField$Outbound = {
2235
- label: string;
2236
- details: Array<UpdateTaskDetail$Outbound>;
2237
- };
2238
-
2239
- /** @internal */
2240
- export const UpdateTaskExtractedField$outboundSchema: z.ZodMiniType<
2241
- UpdateTaskExtractedField$Outbound,
2242
- UpdateTaskExtractedField
2243
- > = z.object({
2244
- label: z.string(),
2245
- details: z.array(z.lazy(() => UpdateTaskDetail$outboundSchema)),
2246
- });
2247
-
2248
- export function updateTaskExtractedFieldToJSON(
2249
- updateTaskExtractedField: UpdateTaskExtractedField,
2250
- ): string {
2251
- return JSON.stringify(
2252
- UpdateTaskExtractedField$outboundSchema.parse(updateTaskExtractedField),
2253
- );
2254
- }
2255
-
2256
- /** @internal */
2257
- export type UpdateTaskExtractedImage$Outbound = {
2258
- label: string;
2259
- side: string;
2260
- imageID: string;
2261
- };
2262
-
2263
- /** @internal */
2264
- export const UpdateTaskExtractedImage$outboundSchema: z.ZodMiniType<
2265
- UpdateTaskExtractedImage$Outbound,
2266
- UpdateTaskExtractedImage
2267
- > = z.object({
2268
- label: z.string(),
2269
- side: z.string(),
2270
- imageID: z.string(),
2271
- });
2272
-
2273
- export function updateTaskExtractedImageToJSON(
2274
- updateTaskExtractedImage: UpdateTaskExtractedImage,
2275
- ): string {
2276
- return JSON.stringify(
2277
- UpdateTaskExtractedImage$outboundSchema.parse(updateTaskExtractedImage),
2278
- );
2279
- }
2280
-
2281
- /** @internal */
2282
- export type UpdateTaskExtraction$Outbound = {
2283
- aggregatedFields?: Array<UpdateTaskAggregatedField$Outbound> | undefined;
2284
- extractedFields?: Array<UpdateTaskExtractedField$Outbound> | undefined;
2285
- extractedImages?: Array<UpdateTaskExtractedImage$Outbound> | undefined;
2286
- };
2287
-
2288
- /** @internal */
2289
- export const UpdateTaskExtraction$outboundSchema: z.ZodMiniType<
2290
- UpdateTaskExtraction$Outbound,
2291
- UpdateTaskExtraction
2292
- > = z.object({
2293
- aggregatedFields: z.optional(
2294
- z.array(z.lazy(() => UpdateTaskAggregatedField$outboundSchema)),
2295
- ),
2296
- extractedFields: z.optional(
2297
- z.array(z.lazy(() => UpdateTaskExtractedField$outboundSchema)),
2298
- ),
2299
- extractedImages: z.optional(
2300
- z.array(z.lazy(() => UpdateTaskExtractedImage$outboundSchema)),
2301
- ),
2302
- });
2303
-
2304
- export function updateTaskExtractionToJSON(
2305
- updateTaskExtraction: UpdateTaskExtraction,
2306
- ): string {
2307
- return JSON.stringify(
2308
- UpdateTaskExtraction$outboundSchema.parse(updateTaskExtraction),
2309
- );
2310
- }
2311
-
2312
- /** @internal */
2313
- export type UpdateTaskValidationCheckBoundingBox$Outbound = {
2314
- x: number;
2315
- y: number;
2316
- width: number;
2317
- height: number;
2318
- };
2319
-
2320
- /** @internal */
2321
- export const UpdateTaskValidationCheckBoundingBox$outboundSchema: z.ZodMiniType<
2322
- UpdateTaskValidationCheckBoundingBox$Outbound,
2323
- UpdateTaskValidationCheckBoundingBox
2324
- > = z.object({
2325
- x: z.number(),
2326
- y: z.number(),
2327
- width: z.number(),
2328
- height: z.number(),
2329
- });
2330
-
2331
- export function updateTaskValidationCheckBoundingBoxToJSON(
2332
- updateTaskValidationCheckBoundingBox: UpdateTaskValidationCheckBoundingBox,
2333
- ): string {
2334
- return JSON.stringify(
2335
- UpdateTaskValidationCheckBoundingBox$outboundSchema.parse(
2336
- updateTaskValidationCheckBoundingBox,
2337
- ),
2338
- );
2339
- }
2340
-
2341
- /** @internal */
2342
- export type UpdateTaskValidationCheckRegionOfInterest$Outbound = {
2343
- boundingBox?: UpdateTaskValidationCheckBoundingBox$Outbound | undefined;
2344
- side: string;
2345
- spectrum?: string | undefined;
2346
- imageId?: string | undefined;
2347
- };
2348
-
2349
- /** @internal */
2350
- export const UpdateTaskValidationCheckRegionOfInterest$outboundSchema:
2351
- z.ZodMiniType<
2352
- UpdateTaskValidationCheckRegionOfInterest$Outbound,
2353
- UpdateTaskValidationCheckRegionOfInterest
2354
- > = z.object({
2355
- boundingBox: z.optional(
2356
- z.lazy(() => UpdateTaskValidationCheckBoundingBox$outboundSchema),
2357
- ),
2358
- side: z.string(),
2359
- spectrum: z.optional(z.string()),
2360
- imageId: z.optional(z.string()),
2361
- });
2362
-
2363
- export function updateTaskValidationCheckRegionOfInterestToJSON(
2364
- updateTaskValidationCheckRegionOfInterest:
2365
- UpdateTaskValidationCheckRegionOfInterest,
2366
- ): string {
2367
- return JSON.stringify(
2368
- UpdateTaskValidationCheckRegionOfInterest$outboundSchema.parse(
2369
- updateTaskValidationCheckRegionOfInterest,
2370
- ),
2371
- );
2372
- }
2373
-
2374
- /** @internal */
2375
- export type UpdateTaskValidationCheck$Outbound = {
2376
- name: string;
2377
- title: string;
2378
- info: string;
2379
- validationResult: string;
2380
- resultInfo: string;
2381
- weight: string;
2382
- regionOfInterests?:
2383
- | Array<UpdateTaskValidationCheckRegionOfInterest$Outbound>
2384
- | undefined;
2385
- type: string;
2386
- };
2387
-
2388
- /** @internal */
2389
- export const UpdateTaskValidationCheck$outboundSchema: z.ZodMiniType<
2390
- UpdateTaskValidationCheck$Outbound,
2391
- UpdateTaskValidationCheck
2392
- > = z.object({
2393
- name: z.string(),
2394
- title: z.string(),
2395
- info: z.string(),
2396
- validationResult: z.string(),
2397
- resultInfo: z.string(),
2398
- weight: z.string(),
2399
- regionOfInterests: z.optional(
2400
- z.array(z.lazy(() =>
2401
- UpdateTaskValidationCheckRegionOfInterest$outboundSchema
2402
- )),
2403
- ),
2404
- type: z.string(),
2405
- });
2406
-
2407
- export function updateTaskValidationCheckToJSON(
2408
- updateTaskValidationCheck: UpdateTaskValidationCheck,
2409
- ): string {
2410
- return JSON.stringify(
2411
- UpdateTaskValidationCheck$outboundSchema.parse(updateTaskValidationCheck),
2412
- );
2413
- }
2414
-
2415
- /** @internal */
2416
- export type UpdateTaskAggregatedValidationCheckBoundingBox$Outbound = {
2417
- x: number;
2418
- y: number;
2419
- width: number;
2420
- height: number;
2421
- };
2422
-
2423
- /** @internal */
2424
- export const UpdateTaskAggregatedValidationCheckBoundingBox$outboundSchema:
2425
- z.ZodMiniType<
2426
- UpdateTaskAggregatedValidationCheckBoundingBox$Outbound,
2427
- UpdateTaskAggregatedValidationCheckBoundingBox
2428
- > = z.object({
2429
- x: z.number(),
2430
- y: z.number(),
2431
- width: z.number(),
2432
- height: z.number(),
2433
- });
2434
-
2435
- export function updateTaskAggregatedValidationCheckBoundingBoxToJSON(
2436
- updateTaskAggregatedValidationCheckBoundingBox:
2437
- UpdateTaskAggregatedValidationCheckBoundingBox,
2438
- ): string {
2439
- return JSON.stringify(
2440
- UpdateTaskAggregatedValidationCheckBoundingBox$outboundSchema.parse(
2441
- updateTaskAggregatedValidationCheckBoundingBox,
2442
- ),
2443
- );
2444
- }
2445
-
2446
- /** @internal */
2447
- export type UpdateTaskAggregatedValidationCheckRegionOfInterest$Outbound = {
2448
- boundingBox?:
2449
- | UpdateTaskAggregatedValidationCheckBoundingBox$Outbound
2450
- | undefined;
2451
- side: string;
2452
- spectrum?: string | undefined;
2453
- imageId?: string | undefined;
2454
- };
2455
-
2456
- /** @internal */
2457
- export const UpdateTaskAggregatedValidationCheckRegionOfInterest$outboundSchema:
2458
- z.ZodMiniType<
2459
- UpdateTaskAggregatedValidationCheckRegionOfInterest$Outbound,
2460
- UpdateTaskAggregatedValidationCheckRegionOfInterest
2461
- > = z.object({
2462
- boundingBox: z.optional(
2463
- z.lazy(() =>
2464
- UpdateTaskAggregatedValidationCheckBoundingBox$outboundSchema
2465
- ),
2466
- ),
2467
- side: z.string(),
2468
- spectrum: z.optional(z.string()),
2469
- imageId: z.optional(z.string()),
2470
- });
2471
-
2472
- export function updateTaskAggregatedValidationCheckRegionOfInterestToJSON(
2473
- updateTaskAggregatedValidationCheckRegionOfInterest:
2474
- UpdateTaskAggregatedValidationCheckRegionOfInterest,
2475
- ): string {
2476
- return JSON.stringify(
2477
- UpdateTaskAggregatedValidationCheckRegionOfInterest$outboundSchema.parse(
2478
- updateTaskAggregatedValidationCheckRegionOfInterest,
2479
- ),
2480
- );
2481
- }
2482
-
2483
- /** @internal */
2484
- export type UpdateTaskAggregatedValidationCheck$Outbound = {
2485
- name: string;
2486
- title: string;
2487
- info: string;
2488
- validationResult: string;
2489
- resultInfo: string;
2490
- weight: string;
2491
- regionOfInterests?:
2492
- | Array<UpdateTaskAggregatedValidationCheckRegionOfInterest$Outbound>
2493
- | undefined;
2494
- type: string;
2495
- };
2496
-
2497
- /** @internal */
2498
- export const UpdateTaskAggregatedValidationCheck$outboundSchema: z.ZodMiniType<
2499
- UpdateTaskAggregatedValidationCheck$Outbound,
2500
- UpdateTaskAggregatedValidationCheck
2501
- > = z.object({
2502
- name: z.string(),
2503
- title: z.string(),
2504
- info: z.string(),
2505
- validationResult: z.string(),
2506
- resultInfo: z.string(),
2507
- weight: z.string(),
2508
- regionOfInterests: z.optional(
2509
- z.array(z.lazy(() =>
2510
- UpdateTaskAggregatedValidationCheckRegionOfInterest$outboundSchema
2511
- )),
2512
- ),
2513
- type: z.string(),
2514
- });
2515
-
2516
- export function updateTaskAggregatedValidationCheckToJSON(
2517
- updateTaskAggregatedValidationCheck: UpdateTaskAggregatedValidationCheck,
2518
- ): string {
2519
- return JSON.stringify(
2520
- UpdateTaskAggregatedValidationCheck$outboundSchema.parse(
2521
- updateTaskAggregatedValidationCheck,
2522
- ),
2523
- );
2524
- }
2525
-
2526
- /** @internal */
2527
- export type UpdateTaskValidation$Outbound = {
2528
- validationChecks?: Array<UpdateTaskValidationCheck$Outbound> | undefined;
2529
- aggregatedValidationChecks?:
2530
- | Array<UpdateTaskAggregatedValidationCheck$Outbound>
2531
- | undefined;
2532
- };
2533
-
2534
- /** @internal */
2535
- export const UpdateTaskValidation$outboundSchema: z.ZodMiniType<
2536
- UpdateTaskValidation$Outbound,
2537
- UpdateTaskValidation
2538
- > = z.object({
2539
- validationChecks: z.optional(
2540
- z.array(z.lazy(() => UpdateTaskValidationCheck$outboundSchema)),
2541
- ),
2542
- aggregatedValidationChecks: z.optional(
2543
- z.array(z.lazy(() => UpdateTaskAggregatedValidationCheck$outboundSchema)),
2544
- ),
2545
- });
2546
-
2547
- export function updateTaskValidationToJSON(
2548
- updateTaskValidation: UpdateTaskValidation,
2549
- ): string {
2550
- return JSON.stringify(
2551
- UpdateTaskValidation$outboundSchema.parse(updateTaskValidation),
2552
- );
2553
- }
2554
-
2555
- /** @internal */
2556
- export type UpdateTaskDocumentAlias$Outbound = {
2557
- title?: string | undefined;
2558
- firstName?: string | undefined;
2559
- middleNames?: Array<string> | undefined;
2560
- lastNames?: Array<string> | undefined;
2561
- lastNamesAtBirth?: Array<string> | undefined;
2562
- };
2563
-
2564
- /** @internal */
2565
- export const UpdateTaskDocumentAlias$outboundSchema: z.ZodMiniType<
2566
- UpdateTaskDocumentAlias$Outbound,
2567
- UpdateTaskDocumentAlias
2568
- > = z.object({
2569
- title: z.optional(z.string()),
2570
- firstName: z.optional(z.string()),
2571
- middleNames: z.optional(z.array(z.string())),
2572
- lastNames: z.optional(z.array(z.string())),
2573
- lastNamesAtBirth: z.optional(z.array(z.string())),
2574
- });
2575
-
2576
- export function updateTaskDocumentAliasToJSON(
2577
- updateTaskDocumentAlias: UpdateTaskDocumentAlias,
2578
- ): string {
2579
- return JSON.stringify(
2580
- UpdateTaskDocumentAlias$outboundSchema.parse(updateTaskDocumentAlias),
2581
- );
2582
- }
2583
-
2584
- /** @internal */
2585
- export const UpdateTaskDocumentRelationship$outboundSchema: z.ZodMiniEnum<
2586
- typeof UpdateTaskDocumentRelationship
2587
- > = z.enum(UpdateTaskDocumentRelationship);
2588
-
2589
- /** @internal */
2590
- export type UpdateTaskDocumentRelatedPerson$Outbound = {
2591
- title?: string | undefined;
2592
- firstName?: string | undefined;
2593
- middleNames?: Array<string> | undefined;
2594
- lastNames?: Array<string> | undefined;
2595
- lastNamesAtBirth?: Array<string> | undefined;
2596
- relationship: string;
2597
- };
2598
-
2599
- /** @internal */
2600
- export const UpdateTaskDocumentRelatedPerson$outboundSchema: z.ZodMiniType<
2601
- UpdateTaskDocumentRelatedPerson$Outbound,
2602
- UpdateTaskDocumentRelatedPerson
2603
- > = z.object({
2604
- title: z.optional(z.string()),
2605
- firstName: z.optional(z.string()),
2606
- middleNames: z.optional(z.array(z.string())),
2607
- lastNames: z.optional(z.array(z.string())),
2608
- lastNamesAtBirth: z.optional(z.array(z.string())),
2609
- relationship: UpdateTaskDocumentRelationship$outboundSchema,
2610
- });
2611
-
2612
- export function updateTaskDocumentRelatedPersonToJSON(
2613
- updateTaskDocumentRelatedPerson: UpdateTaskDocumentRelatedPerson,
2614
- ): string {
2615
- return JSON.stringify(
2616
- UpdateTaskDocumentRelatedPerson$outboundSchema.parse(
2617
- updateTaskDocumentRelatedPerson,
2618
- ),
2619
- );
2620
- }
2621
-
2622
- /** @internal */
2623
- export type UpdateTaskDocumentCurrentAddressLocation$Outbound = {
2624
- latitude?: string | undefined;
2625
- longitude?: string | undefined;
2626
- geoAccuracy?: string | undefined;
2627
- what3words?: string | undefined;
2628
- };
2629
-
2630
- /** @internal */
2631
- export const UpdateTaskDocumentCurrentAddressLocation$outboundSchema:
2632
- z.ZodMiniType<
2633
- UpdateTaskDocumentCurrentAddressLocation$Outbound,
2634
- UpdateTaskDocumentCurrentAddressLocation
2635
- > = z.object({
2636
- latitude: z.optional(z.string()),
2637
- longitude: z.optional(z.string()),
2638
- geoAccuracy: z.optional(z.string()),
2639
- what3words: z.optional(z.string()),
2640
- });
2641
-
2642
- export function updateTaskDocumentCurrentAddressLocationToJSON(
2643
- updateTaskDocumentCurrentAddressLocation:
2644
- UpdateTaskDocumentCurrentAddressLocation,
2645
- ): string {
2646
- return JSON.stringify(
2647
- UpdateTaskDocumentCurrentAddressLocation$outboundSchema.parse(
2648
- updateTaskDocumentCurrentAddressLocation,
2649
- ),
2650
- );
2651
- }
2652
-
2653
- /** @internal */
2654
- export type UpdateTaskDocumentCurrentAddress$Outbound = {
2655
- lines?: Array<string> | undefined;
2656
- addressString?: string | undefined;
2657
- premise?: string | undefined;
2658
- building?: string | undefined;
2659
- subBuilding?: string | undefined;
2660
- thoroughfare?: string | undefined;
2661
- dependentThoroughfare?: string | undefined;
2662
- locality?: string | undefined;
2663
- dependentLocality?: string | undefined;
2664
- doubleDependentLocality?: string | undefined;
2665
- postalCode?: string | undefined;
2666
- postBox?: string | undefined;
2667
- country?: string | undefined;
2668
- superAdministrativeArea?: string | undefined;
2669
- administrativeArea?: string | undefined;
2670
- subAdministrativeArea?: string | undefined;
2671
- organization?: string | undefined;
2672
- location?: UpdateTaskDocumentCurrentAddressLocation$Outbound | undefined;
2673
- };
2674
-
2675
- /** @internal */
2676
- export const UpdateTaskDocumentCurrentAddress$outboundSchema: z.ZodMiniType<
2677
- UpdateTaskDocumentCurrentAddress$Outbound,
2678
- UpdateTaskDocumentCurrentAddress
2679
- > = z.object({
2680
- lines: z.optional(z.array(z.string())),
2681
- addressString: z.optional(z.string()),
2682
- premise: z.optional(z.string()),
2683
- building: z.optional(z.string()),
2684
- subBuilding: z.optional(z.string()),
2685
- thoroughfare: z.optional(z.string()),
2686
- dependentThoroughfare: z.optional(z.string()),
2687
- locality: z.optional(z.string()),
2688
- dependentLocality: z.optional(z.string()),
2689
- doubleDependentLocality: z.optional(z.string()),
2690
- postalCode: z.optional(z.string()),
2691
- postBox: z.optional(z.string()),
2692
- country: z.optional(z.string()),
2693
- superAdministrativeArea: z.optional(z.string()),
2694
- administrativeArea: z.optional(z.string()),
2695
- subAdministrativeArea: z.optional(z.string()),
2696
- organization: z.optional(z.string()),
2697
- location: z.optional(
2698
- z.lazy(() => UpdateTaskDocumentCurrentAddressLocation$outboundSchema),
2699
- ),
2700
- });
2701
-
2702
- export function updateTaskDocumentCurrentAddressToJSON(
2703
- updateTaskDocumentCurrentAddress: UpdateTaskDocumentCurrentAddress,
2704
- ): string {
2705
- return JSON.stringify(
2706
- UpdateTaskDocumentCurrentAddress$outboundSchema.parse(
2707
- updateTaskDocumentCurrentAddress,
2708
- ),
2709
- );
2710
- }
2711
-
2712
- /** @internal */
2713
- export type UpdateTaskDocumentPreviousAddressLocation$Outbound = {
2714
- latitude?: string | undefined;
2715
- longitude?: string | undefined;
2716
- geoAccuracy?: string | undefined;
2717
- what3words?: string | undefined;
2718
- };
2719
-
2720
- /** @internal */
2721
- export const UpdateTaskDocumentPreviousAddressLocation$outboundSchema:
2722
- z.ZodMiniType<
2723
- UpdateTaskDocumentPreviousAddressLocation$Outbound,
2724
- UpdateTaskDocumentPreviousAddressLocation
2725
- > = z.object({
2726
- latitude: z.optional(z.string()),
2727
- longitude: z.optional(z.string()),
2728
- geoAccuracy: z.optional(z.string()),
2729
- what3words: z.optional(z.string()),
2730
- });
2731
-
2732
- export function updateTaskDocumentPreviousAddressLocationToJSON(
2733
- updateTaskDocumentPreviousAddressLocation:
2734
- UpdateTaskDocumentPreviousAddressLocation,
2735
- ): string {
2736
- return JSON.stringify(
2737
- UpdateTaskDocumentPreviousAddressLocation$outboundSchema.parse(
2738
- updateTaskDocumentPreviousAddressLocation,
2739
- ),
2740
- );
2741
- }
2742
-
2743
- /** @internal */
2744
- export type UpdateTaskDocumentPreviousAddress$Outbound = {
2745
- lines?: Array<string> | undefined;
2746
- addressString?: string | undefined;
2747
- premise?: string | undefined;
2748
- building?: string | undefined;
2749
- subBuilding?: string | undefined;
2750
- thoroughfare?: string | undefined;
2751
- dependentThoroughfare?: string | undefined;
2752
- locality?: string | undefined;
2753
- dependentLocality?: string | undefined;
2754
- doubleDependentLocality?: string | undefined;
2755
- postalCode?: string | undefined;
2756
- postBox?: string | undefined;
2757
- country?: string | undefined;
2758
- superAdministrativeArea?: string | undefined;
2759
- administrativeArea?: string | undefined;
2760
- subAdministrativeArea?: string | undefined;
2761
- organization?: string | undefined;
2762
- location?: UpdateTaskDocumentPreviousAddressLocation$Outbound | undefined;
2763
- fromDate: string;
2764
- toDate: string;
2765
- };
2766
-
2767
- /** @internal */
2768
- export const UpdateTaskDocumentPreviousAddress$outboundSchema: z.ZodMiniType<
2769
- UpdateTaskDocumentPreviousAddress$Outbound,
2770
- UpdateTaskDocumentPreviousAddress
2771
- > = z.object({
2772
- lines: z.optional(z.array(z.string())),
2773
- addressString: z.optional(z.string()),
2774
- premise: z.optional(z.string()),
2775
- building: z.optional(z.string()),
2776
- subBuilding: z.optional(z.string()),
2777
- thoroughfare: z.optional(z.string()),
2778
- dependentThoroughfare: z.optional(z.string()),
2779
- locality: z.optional(z.string()),
2780
- dependentLocality: z.optional(z.string()),
2781
- doubleDependentLocality: z.optional(z.string()),
2782
- postalCode: z.optional(z.string()),
2783
- postBox: z.optional(z.string()),
2784
- country: z.optional(z.string()),
2785
- superAdministrativeArea: z.optional(z.string()),
2786
- administrativeArea: z.optional(z.string()),
2787
- subAdministrativeArea: z.optional(z.string()),
2788
- organization: z.optional(z.string()),
2789
- location: z.optional(
2790
- z.lazy(() => UpdateTaskDocumentPreviousAddressLocation$outboundSchema),
2791
- ),
2792
- fromDate: z.string(),
2793
- toDate: z.string(),
2794
- });
2795
-
2796
- export function updateTaskDocumentPreviousAddressToJSON(
2797
- updateTaskDocumentPreviousAddress: UpdateTaskDocumentPreviousAddress,
2798
- ): string {
2799
- return JSON.stringify(
2800
- UpdateTaskDocumentPreviousAddress$outboundSchema.parse(
2801
- updateTaskDocumentPreviousAddress,
2802
- ),
2803
- );
2804
- }
2805
-
2806
- /** @internal */
2807
- export type UpdateTaskDocumentPlaceOfBirthLocation$Outbound = {
2808
- latitude?: string | undefined;
2809
- longitude?: string | undefined;
2810
- geoAccuracy?: string | undefined;
2811
- what3words?: string | undefined;
2812
- };
2813
-
2814
- /** @internal */
2815
- export const UpdateTaskDocumentPlaceOfBirthLocation$outboundSchema:
2816
- z.ZodMiniType<
2817
- UpdateTaskDocumentPlaceOfBirthLocation$Outbound,
2818
- UpdateTaskDocumentPlaceOfBirthLocation
2819
- > = z.object({
2820
- latitude: z.optional(z.string()),
2821
- longitude: z.optional(z.string()),
2822
- geoAccuracy: z.optional(z.string()),
2823
- what3words: z.optional(z.string()),
2824
- });
2825
-
2826
- export function updateTaskDocumentPlaceOfBirthLocationToJSON(
2827
- updateTaskDocumentPlaceOfBirthLocation:
2828
- UpdateTaskDocumentPlaceOfBirthLocation,
2829
- ): string {
2830
- return JSON.stringify(
2831
- UpdateTaskDocumentPlaceOfBirthLocation$outboundSchema.parse(
2832
- updateTaskDocumentPlaceOfBirthLocation,
2833
- ),
2834
- );
2835
- }
2836
-
2837
- /** @internal */
2838
- export type UpdateTaskDocumentPlaceOfBirth$Outbound = {
2839
- lines?: Array<string> | undefined;
2840
- addressString?: string | undefined;
2841
- premise?: string | undefined;
2842
- building?: string | undefined;
2843
- subBuilding?: string | undefined;
2844
- thoroughfare?: string | undefined;
2845
- dependentThoroughfare?: string | undefined;
2846
- locality?: string | undefined;
2847
- dependentLocality?: string | undefined;
2848
- doubleDependentLocality?: string | undefined;
2849
- postalCode?: string | undefined;
2850
- postBox?: string | undefined;
2851
- country?: string | undefined;
2852
- superAdministrativeArea?: string | undefined;
2853
- administrativeArea?: string | undefined;
2854
- subAdministrativeArea?: string | undefined;
2855
- organization?: string | undefined;
2856
- location?: UpdateTaskDocumentPlaceOfBirthLocation$Outbound | undefined;
2857
- };
2858
-
2859
- /** @internal */
2860
- export const UpdateTaskDocumentPlaceOfBirth$outboundSchema: z.ZodMiniType<
2861
- UpdateTaskDocumentPlaceOfBirth$Outbound,
2862
- UpdateTaskDocumentPlaceOfBirth
2863
- > = z.object({
2864
- lines: z.optional(z.array(z.string())),
2865
- addressString: z.optional(z.string()),
2866
- premise: z.optional(z.string()),
2867
- building: z.optional(z.string()),
2868
- subBuilding: z.optional(z.string()),
2869
- thoroughfare: z.optional(z.string()),
2870
- dependentThoroughfare: z.optional(z.string()),
2871
- locality: z.optional(z.string()),
2872
- dependentLocality: z.optional(z.string()),
2873
- doubleDependentLocality: z.optional(z.string()),
2874
- postalCode: z.optional(z.string()),
2875
- postBox: z.optional(z.string()),
2876
- country: z.optional(z.string()),
2877
- superAdministrativeArea: z.optional(z.string()),
2878
- administrativeArea: z.optional(z.string()),
2879
- subAdministrativeArea: z.optional(z.string()),
2880
- organization: z.optional(z.string()),
2881
- location: z.optional(
2882
- z.lazy(() => UpdateTaskDocumentPlaceOfBirthLocation$outboundSchema),
2883
- ),
2884
- });
2885
-
2886
- export function updateTaskDocumentPlaceOfBirthToJSON(
2887
- updateTaskDocumentPlaceOfBirth: UpdateTaskDocumentPlaceOfBirth,
2888
- ): string {
2889
- return JSON.stringify(
2890
- UpdateTaskDocumentPlaceOfBirth$outboundSchema.parse(
2891
- updateTaskDocumentPlaceOfBirth,
2892
- ),
2893
- );
2894
- }
2895
-
2896
- /** @internal */
2897
- export type UpdateTaskDocumentIdNumber$Outbound = {
2898
- type: string;
2899
- idNumber: string;
2900
- country?: string | undefined;
2901
- };
2902
-
2903
- /** @internal */
2904
- export const UpdateTaskDocumentIdNumber$outboundSchema: z.ZodMiniType<
2905
- UpdateTaskDocumentIdNumber$Outbound,
2906
- UpdateTaskDocumentIdNumber
2907
- > = z.object({
2908
- type: z.string(),
2909
- idNumber: z.string(),
2910
- country: z.optional(z.string()),
2911
- });
2912
-
2913
- export function updateTaskDocumentIdNumberToJSON(
2914
- updateTaskDocumentIdNumber: UpdateTaskDocumentIdNumber,
2915
- ): string {
2916
- return JSON.stringify(
2917
- UpdateTaskDocumentIdNumber$outboundSchema.parse(updateTaskDocumentIdNumber),
2918
- );
2919
- }
2920
-
2921
- /** @internal */
2922
- export type UpdateTaskDocumentPhone$Outbound = {
2923
- type: string;
2924
- number: string;
2925
- };
2926
-
2927
- /** @internal */
2928
- export const UpdateTaskDocumentPhone$outboundSchema: z.ZodMiniType<
2929
- UpdateTaskDocumentPhone$Outbound,
2930
- UpdateTaskDocumentPhone
2931
- > = z.object({
2932
- type: z.string(),
2933
- number: z.string(),
2934
- });
2935
-
2936
- export function updateTaskDocumentPhoneToJSON(
2937
- updateTaskDocumentPhone: UpdateTaskDocumentPhone,
2938
- ): string {
2939
- return JSON.stringify(
2940
- UpdateTaskDocumentPhone$outboundSchema.parse(updateTaskDocumentPhone),
2941
- );
2942
- }
2943
-
2944
- /** @internal */
2945
- export type UpdateTaskDocumentEmail$Outbound = {
2946
- type: string;
2947
- email: string;
2948
- };
2949
-
2950
- /** @internal */
2951
- export const UpdateTaskDocumentEmail$outboundSchema: z.ZodMiniType<
2952
- UpdateTaskDocumentEmail$Outbound,
2953
- UpdateTaskDocumentEmail
2954
- > = z.object({
2955
- type: z.string(),
2956
- email: z.string(),
2957
- });
2958
-
2959
- export function updateTaskDocumentEmailToJSON(
2960
- updateTaskDocumentEmail: UpdateTaskDocumentEmail,
2961
- ): string {
2962
- return JSON.stringify(
2963
- UpdateTaskDocumentEmail$outboundSchema.parse(updateTaskDocumentEmail),
2964
- );
2965
- }
2966
-
2967
- /** @internal */
2968
- export type UpdateTaskDocumentSocial$Outbound = {
2969
- type: string;
2970
- identity: string;
2971
- };
2972
-
2973
- /** @internal */
2974
- export const UpdateTaskDocumentSocial$outboundSchema: z.ZodMiniType<
2975
- UpdateTaskDocumentSocial$Outbound,
2976
- UpdateTaskDocumentSocial
2977
- > = z.object({
2978
- type: z.string(),
2979
- identity: z.string(),
2980
- });
2981
-
2982
- export function updateTaskDocumentSocialToJSON(
2983
- updateTaskDocumentSocial: UpdateTaskDocumentSocial,
2984
- ): string {
2985
- return JSON.stringify(
2986
- UpdateTaskDocumentSocial$outboundSchema.parse(updateTaskDocumentSocial),
2987
- );
2988
- }
2989
-
2990
- /** @internal */
2991
- export type UpdateTaskDocumentSubject$Outbound = {
2992
- title?: string | undefined;
2993
- firstName?: string | undefined;
2994
- middleNames?: Array<string> | undefined;
2995
- lastNames?: Array<string> | undefined;
2996
- lastNamesAtBirth?: Array<string> | undefined;
2997
- aliases?: Array<UpdateTaskDocumentAlias$Outbound> | undefined;
2998
- relatedPersons?: Array<UpdateTaskDocumentRelatedPerson$Outbound> | undefined;
2999
- dateOfBirth?: string | undefined;
3000
- gender?: string | undefined;
3001
- currentAddress?: UpdateTaskDocumentCurrentAddress$Outbound | undefined;
3002
- previousAddresses?:
3003
- | Array<UpdateTaskDocumentPreviousAddress$Outbound>
3004
- | undefined;
3005
- placeOfBirth?: UpdateTaskDocumentPlaceOfBirth$Outbound | undefined;
3006
- idNumbers?: Array<UpdateTaskDocumentIdNumber$Outbound> | undefined;
3007
- phones?: Array<UpdateTaskDocumentPhone$Outbound> | undefined;
3008
- emails?: Array<UpdateTaskDocumentEmail$Outbound> | undefined;
3009
- socials?: Array<UpdateTaskDocumentSocial$Outbound> | undefined;
3010
- mothersMaidenName?: string | undefined;
3011
- };
3012
-
3013
- /** @internal */
3014
- export const UpdateTaskDocumentSubject$outboundSchema: z.ZodMiniType<
3015
- UpdateTaskDocumentSubject$Outbound,
3016
- UpdateTaskDocumentSubject
3017
- > = z.object({
3018
- title: z.optional(z.string()),
3019
- firstName: z.optional(z.string()),
3020
- middleNames: z.optional(z.array(z.string())),
3021
- lastNames: z.optional(z.array(z.string())),
3022
- lastNamesAtBirth: z.optional(z.array(z.string())),
3023
- aliases: z.optional(
3024
- z.array(z.lazy(() => UpdateTaskDocumentAlias$outboundSchema)),
3025
- ),
3026
- relatedPersons: z.optional(
3027
- z.array(z.lazy(() => UpdateTaskDocumentRelatedPerson$outboundSchema)),
3028
- ),
3029
- dateOfBirth: z.optional(z.string()),
3030
- gender: z.optional(z.string()),
3031
- currentAddress: z.optional(
3032
- z.lazy(() => UpdateTaskDocumentCurrentAddress$outboundSchema),
3033
- ),
3034
- previousAddresses: z.optional(
3035
- z.array(z.lazy(() => UpdateTaskDocumentPreviousAddress$outboundSchema)),
3036
- ),
3037
- placeOfBirth: z.optional(
3038
- z.lazy(() => UpdateTaskDocumentPlaceOfBirth$outboundSchema),
3039
- ),
3040
- idNumbers: z.optional(
3041
- z.array(z.lazy(() => UpdateTaskDocumentIdNumber$outboundSchema)),
3042
- ),
3043
- phones: z.optional(
3044
- z.array(z.lazy(() => UpdateTaskDocumentPhone$outboundSchema)),
3045
- ),
3046
- emails: z.optional(
3047
- z.array(z.lazy(() => UpdateTaskDocumentEmail$outboundSchema)),
3048
- ),
3049
- socials: z.optional(
3050
- z.array(z.lazy(() => UpdateTaskDocumentSocial$outboundSchema)),
3051
- ),
3052
- mothersMaidenName: z.optional(z.string()),
3053
- });
3054
-
3055
- export function updateTaskDocumentSubjectToJSON(
3056
- updateTaskDocumentSubject: UpdateTaskDocumentSubject,
3057
- ): string {
3058
- return JSON.stringify(
3059
- UpdateTaskDocumentSubject$outboundSchema.parse(updateTaskDocumentSubject),
3060
- );
3061
- }
3062
-
3063
- /** @internal */
3064
- export type UpdateTaskDocument$Outbound = {
3065
- oneDBarcode?: string | undefined;
3066
- address?: UpdateTaskAddress$Outbound | undefined;
3067
- applicationDate?: string | undefined;
3068
- applicationNumber?: string | undefined;
3069
- dateOfBirth?: string | undefined;
3070
- placeOfBirth?: string | undefined;
3071
- placeOfBirthNative?: string | undefined;
3072
- bloodType?: string | undefined;
3073
- controlNumber?: string | undefined;
3074
- countryCode?: string | undefined;
3075
- countryName?: string | undefined;
3076
- documentClassCode?: string | undefined;
3077
- documentClassName?: string | undefined;
3078
- documentNumber?: string | undefined;
3079
- documentSignerCertificate?: string | undefined;
3080
- employer?: string | undefined;
3081
- employerAddress?: string | undefined;
3082
- entries?: string | undefined;
3083
- expirationDate?: string | undefined;
3084
- eyeColor?: string | undefined;
3085
- fathersName?: string | undefined;
3086
- fathersNameNative?: string | undefined;
3087
- fathersSurname?: string | undefined;
3088
- firstName?: string | undefined;
3089
- fullName?: string | undefined;
3090
- fullNameNative?: string | undefined;
3091
- givenName?: string | undefined;
3092
- givenNameNative?: string | undefined;
3093
- hairColor?: string | undefined;
3094
- height?: string | undefined;
3095
- issueDate?: string | undefined;
3096
- issuingAuthority?: string | undefined;
3097
- issuingAuthorityNative?: string | undefined;
3098
- issuingStateCode?: string | undefined;
3099
- issuingStateName?: string | undefined;
3100
- licenseClass?: string | undefined;
3101
- licenseEndorsements?: string | undefined;
3102
- licenseRestrictions?: string | undefined;
3103
- mrz?: string | undefined;
3104
- mrz1?: string | undefined;
3105
- mrz2?: string | undefined;
3106
- mrz3?: string | undefined;
3107
- middleName?: string | undefined;
3108
- mothersName?: string | undefined;
3109
- mothersNameNative?: string | undefined;
3110
- mothersSurname?: string | undefined;
3111
- nameSuffix?: string | undefined;
3112
- nationalityCode?: string | undefined;
3113
- nationalityName?: string | undefined;
3114
- nationalityNameNative?: string | undefined;
3115
- occupation?: string | undefined;
3116
- organDonor?: boolean | undefined;
3117
- passportNumber?: string | undefined;
3118
- permitNumber?: string | undefined;
3119
- personalNumber?: string | undefined;
3120
- photo?: string | undefined;
3121
- photoCompressed?: string | undefined;
3122
- photoEncoding?: string | undefined;
3123
- sex?: string | undefined;
3124
- sexNative?: string | undefined;
3125
- signature?: string | undefined;
3126
- signatureCompressed?: string | undefined;
3127
- signatureEncoding?: string | undefined;
3128
- socialSecurityNumber?: string | undefined;
3129
- startDate?: string | undefined;
3130
- surname?: string | undefined;
3131
- surnameNative?: string | undefined;
3132
- visaClass?: string | undefined;
3133
- visaNumber?: string | undefined;
3134
- weight?: string | undefined;
3135
- cardNumber?: string | undefined;
3136
- issuerCountryCode?: string | undefined;
3137
- id?: string | undefined;
3138
- type?: string | undefined;
3139
- category?: string | undefined;
3140
- subtype?: string | undefined;
3141
- format?: string | undefined;
3142
- device?: UpdateTaskDocumentDevice$Outbound | undefined;
3143
- side1Image?: string | undefined;
3144
- side2Image?: string | undefined;
3145
- chip?: UpdateTaskChip$Outbound | undefined;
3146
- classification?: UpdateTaskClassification$Outbound | undefined;
3147
- extraction?: UpdateTaskExtraction$Outbound | undefined;
3148
- validation?: UpdateTaskValidation$Outbound | undefined;
3149
- subType?: string | undefined;
3150
- number?: string | undefined;
3151
- expiryDate?: string | undefined;
3152
- subject?: UpdateTaskDocumentSubject$Outbound | undefined;
3153
- country?: string | undefined;
3154
- };
3155
-
3156
- /** @internal */
3157
- export const UpdateTaskDocument$outboundSchema: z.ZodMiniType<
3158
- UpdateTaskDocument$Outbound,
3159
- UpdateTaskDocument
3160
- > = z.object({
3161
- oneDBarcode: z.optional(z.string()),
3162
- address: z.optional(z.lazy(() => UpdateTaskAddress$outboundSchema)),
3163
- applicationDate: z.optional(z.string()),
3164
- applicationNumber: z.optional(z.string()),
3165
- dateOfBirth: z.optional(z.string()),
3166
- placeOfBirth: z.optional(z.string()),
3167
- placeOfBirthNative: z.optional(z.string()),
3168
- bloodType: z.optional(z.string()),
3169
- controlNumber: z.optional(z.string()),
3170
- countryCode: z.optional(z.string()),
3171
- countryName: z.optional(z.string()),
3172
- documentClassCode: z.optional(z.string()),
3173
- documentClassName: z.optional(z.string()),
3174
- documentNumber: z.optional(z.string()),
3175
- documentSignerCertificate: z.optional(z.string()),
3176
- employer: z.optional(z.string()),
3177
- employerAddress: z.optional(z.string()),
3178
- entries: z.optional(z.string()),
3179
- expirationDate: z.optional(z.string()),
3180
- eyeColor: z.optional(z.string()),
3181
- fathersName: z.optional(z.string()),
3182
- fathersNameNative: z.optional(z.string()),
3183
- fathersSurname: z.optional(z.string()),
3184
- firstName: z.optional(z.string()),
3185
- fullName: z.optional(z.string()),
3186
- fullNameNative: z.optional(z.string()),
3187
- givenName: z.optional(z.string()),
3188
- givenNameNative: z.optional(z.string()),
3189
- hairColor: z.optional(z.string()),
3190
- height: z.optional(z.string()),
3191
- issueDate: z.optional(z.string()),
3192
- issuingAuthority: z.optional(z.string()),
3193
- issuingAuthorityNative: z.optional(z.string()),
3194
- issuingStateCode: z.optional(z.string()),
3195
- issuingStateName: z.optional(z.string()),
3196
- licenseClass: z.optional(z.string()),
3197
- licenseEndorsements: z.optional(z.string()),
3198
- licenseRestrictions: z.optional(z.string()),
3199
- mrz: z.optional(z.string()),
3200
- mrz1: z.optional(z.string()),
3201
- mrz2: z.optional(z.string()),
3202
- mrz3: z.optional(z.string()),
3203
- middleName: z.optional(z.string()),
3204
- mothersName: z.optional(z.string()),
3205
- mothersNameNative: z.optional(z.string()),
3206
- mothersSurname: z.optional(z.string()),
3207
- nameSuffix: z.optional(z.string()),
3208
- nationalityCode: z.optional(z.string()),
3209
- nationalityName: z.optional(z.string()),
3210
- nationalityNameNative: z.optional(z.string()),
3211
- occupation: z.optional(z.string()),
3212
- organDonor: z.optional(z.boolean()),
3213
- passportNumber: z.optional(z.string()),
3214
- permitNumber: z.optional(z.string()),
3215
- personalNumber: z.optional(z.string()),
3216
- photo: z.optional(z.string()),
3217
- photoCompressed: z.optional(z.string()),
3218
- photoEncoding: z.optional(z.string()),
3219
- sex: z.optional(z.string()),
3220
- sexNative: z.optional(z.string()),
3221
- signature: z.optional(z.string()),
3222
- signatureCompressed: z.optional(z.string()),
3223
- signatureEncoding: z.optional(z.string()),
3224
- socialSecurityNumber: z.optional(z.string()),
3225
- startDate: z.optional(z.string()),
3226
- surname: z.optional(z.string()),
3227
- surnameNative: z.optional(z.string()),
3228
- visaClass: z.optional(z.string()),
3229
- visaNumber: z.optional(z.string()),
3230
- weight: z.optional(z.string()),
3231
- cardNumber: z.optional(z.string()),
3232
- issuerCountryCode: z.optional(z.string()),
3233
- id: z.optional(z.string()),
3234
- type: z.optional(z.string()),
3235
- category: z.optional(z.string()),
3236
- subtype: z.optional(z.string()),
3237
- format: z.optional(z.string()),
3238
- device: z.optional(z.lazy(() => UpdateTaskDocumentDevice$outboundSchema)),
3239
- side1Image: z.optional(z.string()),
3240
- side2Image: z.optional(z.string()),
3241
- chip: z.optional(z.lazy(() => UpdateTaskChip$outboundSchema)),
3242
- classification: z.optional(
3243
- z.lazy(() => UpdateTaskClassification$outboundSchema),
3244
- ),
3245
- extraction: z.optional(z.lazy(() => UpdateTaskExtraction$outboundSchema)),
3246
- validation: z.optional(z.lazy(() => UpdateTaskValidation$outboundSchema)),
3247
- subType: z.optional(z.string()),
3248
- number: z.optional(z.string()),
3249
- expiryDate: z.optional(z.string()),
3250
- subject: z.optional(z.lazy(() => UpdateTaskDocumentSubject$outboundSchema)),
3251
- country: z.optional(z.string()),
3252
- });
3253
-
3254
- export function updateTaskDocumentToJSON(
3255
- updateTaskDocument: UpdateTaskDocument,
3256
- ): string {
3257
- return JSON.stringify(
3258
- UpdateTaskDocument$outboundSchema.parse(updateTaskDocument),
3259
- );
3260
- }
3261
-
3262
- /** @internal */
3263
- export type UpdateTaskBiometric4$Outbound = {
3264
- id?: string | undefined;
3265
- type?: string | undefined;
3266
- selfieImage: string;
3267
- selfieImageEncryption?: boolean | undefined;
3268
- };
3269
-
3270
- /** @internal */
3271
- export const UpdateTaskBiometric4$outboundSchema: z.ZodMiniType<
3272
- UpdateTaskBiometric4$Outbound,
3273
- UpdateTaskBiometric4
3274
- > = z.object({
3275
- id: z.optional(z.string()),
3276
- type: z.optional(z.string()),
3277
- selfieImage: z.string(),
3278
- selfieImageEncryption: z.optional(z.boolean()),
3279
- });
3280
-
3281
- export function updateTaskBiometric4ToJSON(
3282
- updateTaskBiometric4: UpdateTaskBiometric4,
3283
- ): string {
3284
- return JSON.stringify(
3285
- UpdateTaskBiometric4$outboundSchema.parse(updateTaskBiometric4),
3286
- );
3287
- }
3288
-
3289
- /** @internal */
3290
- export type UpdateTaskBiometric3$Outbound = {
3291
- id?: string | undefined;
3292
- type?: string | undefined;
3293
- faceImage: string;
3294
- };
3295
-
3296
- /** @internal */
3297
- export const UpdateTaskBiometric3$outboundSchema: z.ZodMiniType<
3298
- UpdateTaskBiometric3$Outbound,
3299
- UpdateTaskBiometric3
3300
- > = z.object({
3301
- id: z.optional(z.string()),
3302
- type: z.optional(z.string()),
3303
- faceImage: z.string(),
3304
- });
3305
-
3306
- export function updateTaskBiometric3ToJSON(
3307
- updateTaskBiometric3: UpdateTaskBiometric3,
3308
- ): string {
3309
- return JSON.stringify(
3310
- UpdateTaskBiometric3$outboundSchema.parse(updateTaskBiometric3),
3311
- );
3312
- }
3313
-
3314
- /** @internal */
3315
- export type UpdateTaskBiometric2$Outbound = {
3316
- id?: string | undefined;
3317
- type?: string | undefined;
3318
- selfieImage: string;
3319
- anchorImage: string;
3320
- };
3321
-
3322
- /** @internal */
3323
- export const UpdateTaskBiometric2$outboundSchema: z.ZodMiniType<
3324
- UpdateTaskBiometric2$Outbound,
3325
- UpdateTaskBiometric2
3326
- > = z.object({
3327
- id: z.optional(z.string()),
3328
- type: z.optional(z.string()),
3329
- selfieImage: z.string(),
3330
- anchorImage: z.string(),
3331
- });
3332
-
3333
- export function updateTaskBiometric2ToJSON(
3334
- updateTaskBiometric2: UpdateTaskBiometric2,
3335
- ): string {
3336
- return JSON.stringify(
3337
- UpdateTaskBiometric2$outboundSchema.parse(updateTaskBiometric2),
3338
- );
3339
- }
3340
-
3341
- /** @internal */
3342
- export type UpdateTaskBiometric1$Outbound = {
3343
- id?: string | undefined;
3344
- type?: string | undefined;
3345
- face1Image: string;
3346
- face2Image: string;
3347
- };
3348
-
3349
- /** @internal */
3350
- export const UpdateTaskBiometric1$outboundSchema: z.ZodMiniType<
3351
- UpdateTaskBiometric1$Outbound,
3352
- UpdateTaskBiometric1
3353
- > = z.object({
3354
- id: z.optional(z.string()),
3355
- type: z.optional(z.string()),
3356
- face1Image: z.string(),
3357
- face2Image: z.string(),
3358
- });
3359
-
3360
- export function updateTaskBiometric1ToJSON(
3361
- updateTaskBiometric1: UpdateTaskBiometric1,
3362
- ): string {
3363
- return JSON.stringify(
3364
- UpdateTaskBiometric1$outboundSchema.parse(updateTaskBiometric1),
3365
- );
3366
- }
3367
-
3368
- /** @internal */
3369
- export type UpdateTaskBiometricUnion$Outbound =
3370
- | UpdateTaskBiometric1$Outbound
3371
- | UpdateTaskBiometric2$Outbound
3372
- | UpdateTaskBiometric3$Outbound
3373
- | UpdateTaskBiometric4$Outbound;
3374
-
3375
- /** @internal */
3376
- export const UpdateTaskBiometricUnion$outboundSchema: z.ZodMiniType<
3377
- UpdateTaskBiometricUnion$Outbound,
3378
- UpdateTaskBiometricUnion
3379
- > = smartUnion([
3380
- z.lazy(() => UpdateTaskBiometric1$outboundSchema),
3381
- z.lazy(() => UpdateTaskBiometric2$outboundSchema),
3382
- z.lazy(() => UpdateTaskBiometric3$outboundSchema),
3383
- z.lazy(() => UpdateTaskBiometric4$outboundSchema),
3384
- ]);
3385
-
3386
- export function updateTaskBiometricUnionToJSON(
3387
- updateTaskBiometricUnion: UpdateTaskBiometricUnion,
3388
- ): string {
3389
- return JSON.stringify(
3390
- UpdateTaskBiometricUnion$outboundSchema.parse(updateTaskBiometricUnion),
3391
- );
3392
- }
3393
-
3394
- /** @internal */
3395
- export type UpdateTaskUser$Outbound = {
3396
- id: string;
3397
- email: string;
3398
- domain: string;
3399
- };
3400
-
3401
- /** @internal */
3402
- export const UpdateTaskUser$outboundSchema: z.ZodMiniType<
3403
- UpdateTaskUser$Outbound,
3404
- UpdateTaskUser
3405
- > = z.object({
3406
- id: z.string(),
3407
- email: z.string(),
3408
- domain: z.string(),
3409
- });
3410
-
3411
- export function updateTaskUserToJSON(updateTaskUser: UpdateTaskUser): string {
3412
- return JSON.stringify(UpdateTaskUser$outboundSchema.parse(updateTaskUser));
3413
- }
3414
-
3415
- /** @internal */
3416
- export type UpdateTaskClient$Outbound = {
3417
- id: string;
3418
- ip: string;
3419
- address: string;
3420
- };
3421
-
3422
- /** @internal */
3423
- export const UpdateTaskClient$outboundSchema: z.ZodMiniType<
3424
- UpdateTaskClient$Outbound,
3425
- UpdateTaskClient
3426
- > = z.object({
3427
- id: z.string(),
3428
- ip: z.string(),
3429
- address: z.string(),
3430
- });
3431
-
3432
- export function updateTaskClientToJSON(
3433
- updateTaskClient: UpdateTaskClient,
3434
- ): string {
3435
- return JSON.stringify(
3436
- UpdateTaskClient$outboundSchema.parse(updateTaskClient),
3437
- );
3438
- }
3439
-
3440
- /** @internal */
3441
- export type UpdateTaskModel$Outbound = {
3442
- identifier: string;
3443
- name: string;
3444
- };
3445
-
3446
- /** @internal */
3447
- export const UpdateTaskModel$outboundSchema: z.ZodMiniType<
3448
- UpdateTaskModel$Outbound,
3449
- UpdateTaskModel
3450
- > = z.object({
3451
- identifier: z.string(),
3452
- name: z.string(),
3453
- });
3454
-
3455
- export function updateTaskModelToJSON(
3456
- updateTaskModel: UpdateTaskModel,
3457
- ): string {
3458
- return JSON.stringify(UpdateTaskModel$outboundSchema.parse(updateTaskModel));
3459
- }
3460
-
3461
- /** @internal */
3462
- export type UpdateTaskSessionDevice$Outbound = {
3463
- id: string;
3464
- manufacturer: string;
3465
- model: UpdateTaskModel$Outbound;
3466
- };
3467
-
3468
- /** @internal */
3469
- export const UpdateTaskSessionDevice$outboundSchema: z.ZodMiniType<
3470
- UpdateTaskSessionDevice$Outbound,
3471
- UpdateTaskSessionDevice
3472
- > = z.object({
3473
- id: z.string(),
3474
- manufacturer: z.string(),
3475
- model: z.lazy(() => UpdateTaskModel$outboundSchema),
3476
- });
3477
-
3478
- export function updateTaskSessionDeviceToJSON(
3479
- updateTaskSessionDevice: UpdateTaskSessionDevice,
3480
- ): string {
3481
- return JSON.stringify(
3482
- UpdateTaskSessionDevice$outboundSchema.parse(updateTaskSessionDevice),
3483
- );
3484
- }
3485
-
3486
- /** @internal */
3487
- export type UpdateTaskTrace$Outbound = {
3488
- id: string;
3489
- };
3490
-
3491
- /** @internal */
3492
- export const UpdateTaskTrace$outboundSchema: z.ZodMiniType<
3493
- UpdateTaskTrace$Outbound,
3494
- UpdateTaskTrace
3495
- > = z.object({
3496
- id: z.string(),
3497
- });
3498
-
3499
- export function updateTaskTraceToJSON(
3500
- updateTaskTrace: UpdateTaskTrace,
3501
- ): string {
3502
- return JSON.stringify(UpdateTaskTrace$outboundSchema.parse(updateTaskTrace));
3503
- }
3504
-
3505
- /** @internal */
3506
- export type UpdateTaskSpan$Outbound = {
3507
- id: string;
3508
- };
3509
-
3510
- /** @internal */
3511
- export const UpdateTaskSpan$outboundSchema: z.ZodMiniType<
3512
- UpdateTaskSpan$Outbound,
3513
- UpdateTaskSpan
3514
- > = z.object({
3515
- id: z.string(),
3516
- });
3517
-
3518
- export function updateTaskSpanToJSON(updateTaskSpan: UpdateTaskSpan): string {
3519
- return JSON.stringify(UpdateTaskSpan$outboundSchema.parse(updateTaskSpan));
3520
- }
3521
-
3522
- /** @internal */
3523
- export type UpdateTaskTransaction$Outbound = {
3524
- id: string;
3525
- };
3526
-
3527
- /** @internal */
3528
- export const UpdateTaskTransaction$outboundSchema: z.ZodMiniType<
3529
- UpdateTaskTransaction$Outbound,
3530
- UpdateTaskTransaction
3531
- > = z.object({
3532
- id: z.string(),
3533
- });
3534
-
3535
- export function updateTaskTransactionToJSON(
3536
- updateTaskTransaction: UpdateTaskTransaction,
3537
- ): string {
3538
- return JSON.stringify(
3539
- UpdateTaskTransaction$outboundSchema.parse(updateTaskTransaction),
3540
- );
3541
- }
3542
-
3543
- /** @internal */
3544
- export type UpdateTaskSessionAuth$Outbound = {
3545
- id: string;
3546
- scope?: string | undefined;
3547
- codeVerifier?: string | undefined;
3548
- code?: string | undefined;
3549
- state?: string | undefined;
3550
- redirectUri?: string | undefined;
3551
- responseType?: string | undefined;
3552
- clientId?: string | undefined;
3553
- clientSecret?: string | undefined;
3554
- };
3555
-
3556
- /** @internal */
3557
- export const UpdateTaskSessionAuth$outboundSchema: z.ZodMiniType<
3558
- UpdateTaskSessionAuth$Outbound,
3559
- UpdateTaskSessionAuth
3560
- > = z.object({
3561
- id: z.string(),
3562
- scope: z.optional(z.string()),
3563
- codeVerifier: z.optional(z.string()),
3564
- code: z.optional(z.string()),
3565
- state: z.optional(z.string()),
3566
- redirectUri: z.optional(z.string()),
3567
- responseType: z.optional(z.string()),
3568
- clientId: z.optional(z.string()),
3569
- clientSecret: z.optional(z.string()),
3570
- });
3571
-
3572
- export function updateTaskSessionAuthToJSON(
3573
- updateTaskSessionAuth: UpdateTaskSessionAuth,
3574
- ): string {
3575
- return JSON.stringify(
3576
- UpdateTaskSessionAuth$outboundSchema.parse(updateTaskSessionAuth),
3577
- );
3578
- }
3579
-
3580
- /** @internal */
3581
- export type UpdateTaskSession$Outbound = {
3582
- user?: UpdateTaskUser$Outbound | undefined;
3583
- client?: UpdateTaskClient$Outbound | undefined;
3584
- device?: UpdateTaskSessionDevice$Outbound | undefined;
3585
- trace?: UpdateTaskTrace$Outbound | undefined;
3586
- span?: UpdateTaskSpan$Outbound | undefined;
3587
- transaction?: UpdateTaskTransaction$Outbound | undefined;
3588
- auth?: Array<UpdateTaskSessionAuth$Outbound> | undefined;
3589
- };
3590
-
3591
- /** @internal */
3592
- export const UpdateTaskSession$outboundSchema: z.ZodMiniType<
3593
- UpdateTaskSession$Outbound,
3594
- UpdateTaskSession
3595
- > = z.object({
3596
- user: z.optional(z.lazy(() => UpdateTaskUser$outboundSchema)),
3597
- client: z.optional(z.lazy(() => UpdateTaskClient$outboundSchema)),
3598
- device: z.optional(z.lazy(() => UpdateTaskSessionDevice$outboundSchema)),
3599
- trace: z.optional(z.lazy(() => UpdateTaskTrace$outboundSchema)),
3600
- span: z.optional(z.lazy(() => UpdateTaskSpan$outboundSchema)),
3601
- transaction: z.optional(z.lazy(() => UpdateTaskTransaction$outboundSchema)),
3602
- auth: z.optional(z.array(z.lazy(() => UpdateTaskSessionAuth$outboundSchema))),
3603
- });
3604
-
3605
- export function updateTaskSessionToJSON(
3606
- updateTaskSession: UpdateTaskSession,
3607
- ): string {
3608
- return JSON.stringify(
3609
- UpdateTaskSession$outboundSchema.parse(updateTaskSession),
3610
- );
3611
- }
3612
-
3613
- /** @internal */
3614
- export const UpdateTaskConsentType$outboundSchema: z.ZodMiniEnum<
3615
- typeof UpdateTaskConsentType
3616
- > = z.enum(UpdateTaskConsentType);
3617
-
3618
- /** @internal */
3619
- export type UpdateTaskConsent$Outbound = {
3620
- type?: string | undefined;
3621
- id?: string | undefined;
3622
- version?: string | undefined;
3623
- url: string;
3624
- effectiveDate?: string | undefined;
3625
- expiryDate?: string | undefined;
3626
- terms?: string | undefined;
3627
- purpose?: string | undefined;
3628
- legalBasis?: string | undefined;
3629
- jurisdiction?: string | undefined;
3630
- subject?: string | undefined;
3631
- signatory?: string | undefined;
3632
- };
3633
-
3634
- /** @internal */
3635
- export const UpdateTaskConsent$outboundSchema: z.ZodMiniType<
3636
- UpdateTaskConsent$Outbound,
3637
- UpdateTaskConsent
3638
- > = z.object({
3639
- type: z.optional(UpdateTaskConsentType$outboundSchema),
3640
- id: z.optional(z.string()),
3641
- version: z.optional(z.string()),
3642
- url: z.string(),
3643
- effectiveDate: z.optional(z.string()),
3644
- expiryDate: z.optional(z.string()),
3645
- terms: z.optional(z.string()),
3646
- purpose: z.optional(z.string()),
3647
- legalBasis: z.optional(z.string()),
3648
- jurisdiction: z.optional(z.string()),
3649
- subject: z.optional(z.string()),
3650
- signatory: z.optional(z.string()),
3651
- });
3652
-
3653
- export function updateTaskConsentToJSON(
3654
- updateTaskConsent: UpdateTaskConsent,
3655
- ): string {
3656
- return JSON.stringify(
3657
- UpdateTaskConsent$outboundSchema.parse(updateTaskConsent),
3658
- );
3659
- }
3660
-
3661
- /** @internal */
3662
- export type UpdateTaskAccount$Outbound = {
3663
- type: string;
3664
- accountNumber: string;
3665
- sortCode?: string | undefined;
3666
- routingNumber?: string | undefined;
3667
- iban?: string | undefined;
3668
- bic?: string | undefined;
3669
- accountHolderName?: string | undefined;
3670
- bankName?: string | undefined;
3671
- country?: string | undefined;
3672
- accountType?: string | undefined;
3673
- };
3674
-
3675
- /** @internal */
3676
- export const UpdateTaskAccount$outboundSchema: z.ZodMiniType<
3677
- UpdateTaskAccount$Outbound,
3678
- UpdateTaskAccount
3679
- > = z.object({
3680
- type: z.string(),
3681
- accountNumber: z.string(),
3682
- sortCode: z.optional(z.string()),
3683
- routingNumber: z.optional(z.string()),
3684
- iban: z.optional(z.string()),
3685
- bic: z.optional(z.string()),
3686
- accountHolderName: z.optional(z.string()),
3687
- bankName: z.optional(z.string()),
3688
- country: z.optional(z.string()),
3689
- accountType: z.optional(z.string()),
3690
- });
3691
-
3692
- export function updateTaskAccountToJSON(
3693
- updateTaskAccount: UpdateTaskAccount,
3694
- ): string {
3695
- return JSON.stringify(
3696
- UpdateTaskAccount$outboundSchema.parse(updateTaskAccount),
3697
- );
3698
- }
3699
-
3700
- /** @internal */
3701
- export type UpdateTaskSubject$Outbound = {
3702
- identity?: UpdateTaskIdentity$Outbound | undefined;
3703
- documents?: Array<UpdateTaskDocument$Outbound> | undefined;
3704
- biometrics?:
3705
- | Array<
3706
- | UpdateTaskBiometric1$Outbound
3707
- | UpdateTaskBiometric2$Outbound
3708
- | UpdateTaskBiometric3$Outbound
3709
- | UpdateTaskBiometric4$Outbound
3710
- >
3711
- | undefined;
3712
- sessions?: Array<UpdateTaskSession$Outbound> | undefined;
3713
- consent?: Array<UpdateTaskConsent$Outbound> | undefined;
3714
- accounts?: Array<UpdateTaskAccount$Outbound> | undefined;
3715
- uid?: string | undefined;
3716
- };
3717
-
3718
- /** @internal */
3719
- export const UpdateTaskSubject$outboundSchema: z.ZodMiniType<
3720
- UpdateTaskSubject$Outbound,
3721
- UpdateTaskSubject
3722
- > = z.object({
3723
- identity: z.optional(z.lazy(() => UpdateTaskIdentity$outboundSchema)),
3724
- documents: z.optional(
3725
- z.array(z.lazy(() => UpdateTaskDocument$outboundSchema)),
3726
- ),
3727
- biometrics: z.optional(
3728
- z.array(smartUnion([
3729
- z.lazy(() => UpdateTaskBiometric1$outboundSchema),
3730
- z.lazy(() =>
3731
- UpdateTaskBiometric2$outboundSchema
3732
- ),
3733
- z.lazy(() => UpdateTaskBiometric3$outboundSchema),
3734
- z.lazy(() => UpdateTaskBiometric4$outboundSchema),
3735
- ])),
3736
- ),
3737
- sessions: z.optional(z.array(z.lazy(() => UpdateTaskSession$outboundSchema))),
3738
- consent: z.optional(z.array(z.lazy(() => UpdateTaskConsent$outboundSchema))),
3739
- accounts: z.optional(z.array(z.lazy(() => UpdateTaskAccount$outboundSchema))),
3740
- uid: z.optional(z.string()),
3741
- });
3742
-
3743
- export function updateTaskSubjectToJSON(
3744
- updateTaskSubject: UpdateTaskSubject,
3745
- ): string {
3746
- return JSON.stringify(
3747
- UpdateTaskSubject$outboundSchema.parse(updateTaskSubject),
3748
- );
3749
- }
3750
-
3751
- /** @internal */
3752
- export type UpdateTaskContext$Outbound = {
3753
- subject: UpdateTaskSubject$Outbound;
3754
- };
3755
-
3756
- /** @internal */
3757
- export const UpdateTaskContext$outboundSchema: z.ZodMiniType<
3758
- UpdateTaskContext$Outbound,
3759
- UpdateTaskContext
3760
- > = z.object({
3761
- subject: z.lazy(() => UpdateTaskSubject$outboundSchema),
3762
- });
3763
-
3764
- export function updateTaskContextToJSON(
3765
- updateTaskContext: UpdateTaskContext,
3766
- ): string {
3767
- return JSON.stringify(
3768
- UpdateTaskContext$outboundSchema.parse(updateTaskContext),
3769
- );
3770
- }
3771
-
3772
- /** @internal */
3773
- export type UpdateTaskRequest$Outbound = {
3774
- instanceId: string;
3775
- taskId: string;
3776
- intent: string;
3777
- context?: UpdateTaskContext$Outbound | undefined;
3778
- data?: { [k: string]: any } | undefined;
3779
- };
3780
-
3781
- /** @internal */
3782
- export const UpdateTaskRequest$outboundSchema: z.ZodMiniType<
3783
- UpdateTaskRequest$Outbound,
3784
- UpdateTaskRequest
3785
- > = z.object({
3786
- instanceId: z.string(),
3787
- taskId: z.string(),
3788
- intent: Intent$outboundSchema,
3789
- context: z.optional(z.lazy(() => UpdateTaskContext$outboundSchema)),
3790
- data: z.optional(z.record(z.string(), z.any())),
3791
- });
3792
-
3793
- export function updateTaskRequestToJSON(
3794
- updateTaskRequest: UpdateTaskRequest,
3795
- ): string {
3796
- return JSON.stringify(
3797
- UpdateTaskRequest$outboundSchema.parse(updateTaskRequest),
3798
- );
3799
- }
3800
-
3801
- /** @internal */
3802
- export const UpdateTaskResponse$inboundSchema: z.ZodMiniType<
3803
- UpdateTaskResponse,
3804
- unknown
3805
- > = z.object({
3806
- instanceId: types.string(),
3807
- taskId: types.string(),
3808
- });
3809
-
3810
- export function updateTaskResponseFromJSON(
3811
- jsonString: string,
3812
- ): SafeParseResult<UpdateTaskResponse, SDKValidationError> {
3813
- return safeParse(
3814
- jsonString,
3815
- (x) => UpdateTaskResponse$inboundSchema.parse(JSON.parse(x)),
3816
- `Failed to parse 'UpdateTaskResponse' from JSON`,
3817
- );
3818
- }