@gbg/go-core 0.1.2 → 0.2.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/FUNCTIONS.md +6 -4
- package/README.md +92 -61
- package/dist/commonjs/funcs/addresses-retrieve.d.ts +19 -0
- package/dist/commonjs/funcs/addresses-retrieve.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tasks-list.js → addresses-retrieve.js} +21 -10
- package/dist/commonjs/funcs/addresses-retrieve.js.map +1 -0
- package/dist/{esm/funcs/tasks-list-schema.d.ts → commonjs/funcs/addresses-search.d.ts} +6 -6
- package/dist/commonjs/funcs/addresses-search.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tasks-update.js → addresses-search.js} +21 -10
- package/dist/commonjs/funcs/addresses-search.js.map +1 -0
- package/dist/commonjs/funcs/devices-add.d.ts +5 -3
- package/dist/commonjs/funcs/devices-add.d.ts.map +1 -1
- package/dist/commonjs/funcs/devices-add.js +9 -4
- package/dist/commonjs/funcs/devices-add.js.map +1 -1
- package/dist/commonjs/funcs/devices-connect.d.ts +5 -3
- package/dist/commonjs/funcs/devices-connect.d.ts.map +1 -1
- package/dist/commonjs/funcs/devices-connect.js +11 -8
- package/dist/commonjs/funcs/devices-connect.js.map +1 -1
- package/dist/{esm/funcs/health-get.d.ts → commonjs/funcs/devices-refresh.d.ts} +6 -5
- package/dist/commonjs/funcs/devices-refresh.d.ts.map +1 -0
- package/dist/commonjs/funcs/{health-get.js → devices-refresh.js} +16 -17
- package/dist/commonjs/funcs/devices-refresh.js.map +1 -0
- package/dist/commonjs/funcs/{health-get.d.ts → devices-validate.d.ts} +6 -4
- package/dist/commonjs/funcs/devices-validate.d.ts.map +1 -0
- package/dist/commonjs/funcs/devices-validate.js +113 -0
- package/dist/commonjs/funcs/devices-validate.js.map +1 -0
- package/dist/commonjs/funcs/instances-delete.d.ts +5 -3
- package/dist/commonjs/funcs/instances-delete.d.ts.map +1 -1
- package/dist/commonjs/funcs/instances-delete.js +9 -4
- package/dist/commonjs/funcs/instances-delete.js.map +1 -1
- package/dist/commonjs/funcs/instances-handoff-token.d.ts +19 -0
- package/dist/commonjs/funcs/instances-handoff-token.d.ts.map +1 -0
- package/dist/commonjs/funcs/instances-handoff-token.js +130 -0
- package/dist/commonjs/funcs/instances-handoff-token.js.map +1 -0
- package/dist/commonjs/funcs/interactions-fetch.d.ts +4 -3
- package/dist/commonjs/funcs/interactions-fetch.d.ts.map +1 -1
- package/dist/commonjs/funcs/interactions-fetch.js +19 -7
- package/dist/commonjs/funcs/interactions-fetch.js.map +1 -1
- package/dist/commonjs/funcs/interactions-submit.d.ts +5 -3
- package/dist/commonjs/funcs/interactions-submit.d.ts.map +1 -1
- package/dist/commonjs/funcs/interactions-submit.js +15 -4
- package/dist/commonjs/funcs/interactions-submit.js.map +1 -1
- package/dist/commonjs/funcs/interactions-upload-asset.d.ts +18 -0
- package/dist/commonjs/funcs/interactions-upload-asset.d.ts.map +1 -0
- package/dist/commonjs/funcs/interactions-upload-asset.js +119 -0
- package/dist/commonjs/funcs/interactions-upload-asset.js.map +1 -0
- package/dist/commonjs/funcs/journeys-get-schemas.d.ts +46 -0
- package/dist/commonjs/funcs/journeys-get-schemas.d.ts.map +1 -0
- package/dist/commonjs/funcs/journeys-get-schemas.js +150 -0
- package/dist/commonjs/funcs/journeys-get-schemas.js.map +1 -0
- package/dist/commonjs/funcs/journeys-get-state.d.ts +4 -3
- package/dist/commonjs/funcs/journeys-get-state.d.ts.map +1 -1
- package/dist/commonjs/funcs/journeys-get-state.js +13 -7
- package/dist/commonjs/funcs/journeys-get-state.js.map +1 -1
- package/dist/commonjs/funcs/journeys-start.d.ts +5 -3
- package/dist/commonjs/funcs/journeys-start.d.ts.map +1 -1
- package/dist/commonjs/funcs/journeys-start.js +9 -4
- package/dist/commonjs/funcs/journeys-start.js.map +1 -1
- package/dist/commonjs/funcs/journeys-terminate.d.ts +21 -0
- package/dist/commonjs/funcs/journeys-terminate.d.ts.map +1 -0
- package/dist/commonjs/funcs/{tasks-list-schema.js → journeys-terminate.js} +14 -9
- package/dist/commonjs/funcs/journeys-terminate.js.map +1 -0
- package/dist/commonjs/funcs/sandbox-create-scenario.d.ts +21 -0
- package/dist/commonjs/funcs/sandbox-create-scenario.d.ts.map +1 -0
- package/dist/commonjs/funcs/sandbox-create-scenario.js +129 -0
- package/dist/commonjs/funcs/sandbox-create-scenario.js.map +1 -0
- package/dist/commonjs/funcs/sandbox-delete-scenario.d.ts +20 -0
- package/dist/commonjs/funcs/sandbox-delete-scenario.d.ts.map +1 -0
- package/dist/commonjs/funcs/sandbox-delete-scenario.js +131 -0
- package/dist/commonjs/funcs/sandbox-delete-scenario.js.map +1 -0
- package/dist/commonjs/funcs/sandbox-get-scenario.d.ts +21 -0
- package/dist/commonjs/funcs/sandbox-get-scenario.d.ts.map +1 -0
- package/dist/commonjs/funcs/sandbox-get-scenario.js +136 -0
- package/dist/commonjs/funcs/sandbox-get-scenario.js.map +1 -0
- package/dist/commonjs/funcs/sandbox-list-scenarios.d.ts +21 -0
- package/dist/commonjs/funcs/sandbox-list-scenarios.d.ts.map +1 -0
- package/dist/commonjs/funcs/sandbox-list-scenarios.js +132 -0
- package/dist/commonjs/funcs/sandbox-list-scenarios.js.map +1 -0
- package/dist/commonjs/funcs/sandbox-put-scenario.d.ts +21 -0
- package/dist/commonjs/funcs/sandbox-put-scenario.d.ts.map +1 -0
- package/dist/commonjs/funcs/sandbox-put-scenario.js +133 -0
- package/dist/commonjs/funcs/sandbox-put-scenario.js.map +1 -0
- package/dist/commonjs/funcs/tasks-get-schema.d.ts +8 -3
- package/dist/commonjs/funcs/tasks-get-schema.d.ts.map +1 -1
- package/dist/commonjs/funcs/tasks-get-schema.js +10 -4
- package/dist/commonjs/funcs/tasks-get-schema.js.map +1 -1
- package/dist/commonjs/funcs/tokens-generate.js +1 -1
- package/dist/commonjs/funcs/tokens-generate.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +5 -5
- package/dist/commonjs/lib/config.d.ts.map +1 -1
- package/dist/commonjs/lib/config.js +16 -7
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/models/create-sandbox-scenario-request.d.ts +29 -0
- package/dist/commonjs/models/create-sandbox-scenario-request.d.ts.map +1 -0
- package/dist/commonjs/models/create-sandbox-scenario-request.js +56 -0
- package/dist/commonjs/models/create-sandbox-scenario-request.js.map +1 -0
- package/dist/commonjs/models/delete-response.d.ts +19 -0
- package/dist/commonjs/models/delete-response.d.ts.map +1 -0
- package/dist/commonjs/models/delete-response.js +58 -0
- package/dist/commonjs/models/delete-response.js.map +1 -0
- package/dist/commonjs/models/device-connect-response.d.ts +23 -0
- package/dist/commonjs/models/device-connect-response.d.ts.map +1 -0
- package/dist/commonjs/models/device-connect-response.js +62 -0
- package/dist/commonjs/models/device-connect-response.js.map +1 -0
- package/dist/commonjs/models/device-refresh-response.d.ts +16 -0
- package/dist/commonjs/models/device-refresh-response.d.ts.map +1 -0
- package/dist/commonjs/models/device-refresh-response.js +57 -0
- package/dist/commonjs/models/device-refresh-response.js.map +1 -0
- package/dist/commonjs/models/device-start-response.d.ts +20 -0
- package/dist/commonjs/models/device-start-response.d.ts.map +1 -0
- package/dist/commonjs/models/device-start-response.js +59 -0
- package/dist/commonjs/models/device-start-response.js.map +1 -0
- package/dist/commonjs/models/device-validate-response.d.ts +14 -0
- package/dist/commonjs/models/device-validate-response.d.ts.map +1 -0
- package/dist/commonjs/models/device-validate-response.js +55 -0
- package/dist/commonjs/models/device-validate-response.js.map +1 -0
- package/dist/commonjs/models/errors/error-response.d.ts +19 -0
- package/dist/commonjs/models/errors/error-response.d.ts.map +1 -0
- package/dist/commonjs/models/errors/error-response.js +68 -0
- package/dist/commonjs/models/errors/error-response.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +1 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/models/errors/index.js +1 -0
- package/dist/commonjs/models/errors/index.js.map +1 -1
- package/dist/commonjs/models/gbg-error.d.ts +28 -0
- package/dist/commonjs/models/gbg-error.d.ts.map +1 -0
- package/dist/commonjs/models/gbg-error.js +69 -0
- package/dist/commonjs/models/gbg-error.js.map +1 -0
- package/dist/commonjs/models/handoff-token-response.d.ts +20 -0
- package/dist/commonjs/models/handoff-token-response.d.ts.map +1 -0
- package/dist/commonjs/models/handoff-token-response.js +60 -0
- package/dist/commonjs/models/handoff-token-response.js.map +1 -0
- package/dist/commonjs/models/index.d.ts +30 -0
- package/dist/commonjs/models/index.d.ts.map +1 -1
- package/dist/commonjs/models/index.js +30 -0
- package/dist/commonjs/models/index.js.map +1 -1
- package/dist/commonjs/models/interaction-fetch-response.d.ts +53 -0
- package/dist/commonjs/models/interaction-fetch-response.d.ts.map +1 -0
- package/dist/commonjs/models/interaction-fetch-response.js +92 -0
- package/dist/commonjs/models/interaction-fetch-response.js.map +1 -0
- package/dist/commonjs/models/interaction-submit-response.d.ts +17 -0
- package/dist/commonjs/models/interaction-submit-response.d.ts.map +1 -0
- package/dist/commonjs/models/interaction-submit-response.js +55 -0
- package/dist/commonjs/models/interaction-submit-response.js.map +1 -0
- package/dist/commonjs/models/journey-start-response.d.ts +27 -0
- package/dist/commonjs/models/journey-start-response.d.ts.map +1 -0
- package/dist/commonjs/models/journey-start-response.js +67 -0
- package/dist/commonjs/models/journey-start-response.js.map +1 -0
- package/dist/commonjs/models/loqate-retrieve-response.d.ts +12 -0
- package/dist/commonjs/models/loqate-retrieve-response.d.ts.map +1 -0
- package/dist/commonjs/models/loqate-retrieve-response.js +55 -0
- package/dist/commonjs/models/loqate-retrieve-response.js.map +1 -0
- package/dist/commonjs/models/loqate-search-response.d.ts +12 -0
- package/dist/commonjs/models/loqate-search-response.d.ts.map +1 -0
- package/dist/commonjs/models/loqate-search-response.js +55 -0
- package/dist/commonjs/models/loqate-search-response.js.map +1 -0
- package/dist/commonjs/models/operations/add-device.d.ts +8 -92
- package/dist/commonjs/models/operations/add-device.d.ts.map +1 -1
- package/dist/commonjs/models/operations/add-device.js +6 -76
- package/dist/commonjs/models/operations/add-device.js.map +1 -1
- package/dist/commonjs/models/operations/create-handoff-token.d.ts +22 -0
- package/dist/commonjs/models/operations/create-handoff-token.d.ts.map +1 -0
- package/dist/commonjs/models/operations/create-handoff-token.js +62 -0
- package/dist/commonjs/models/operations/create-handoff-token.js.map +1 -0
- package/dist/commonjs/models/operations/create-sandbox-scenario.d.ts +18 -0
- package/dist/commonjs/models/operations/create-sandbox-scenario.d.ts.map +1 -0
- package/dist/commonjs/models/operations/create-sandbox-scenario.js +51 -0
- package/dist/commonjs/models/operations/create-sandbox-scenario.js.map +1 -0
- package/dist/commonjs/models/operations/delete-instance.d.ts +1 -14
- package/dist/commonjs/models/operations/delete-instance.d.ts.map +1 -1
- package/dist/commonjs/models/operations/delete-instance.js +3 -13
- package/dist/commonjs/models/operations/delete-instance.js.map +1 -1
- package/dist/commonjs/models/operations/delete-sandbox-scenario.d.ts +20 -0
- package/dist/commonjs/models/operations/delete-sandbox-scenario.d.ts.map +1 -0
- package/dist/commonjs/models/operations/delete-sandbox-scenario.js +50 -0
- package/dist/commonjs/models/operations/delete-sandbox-scenario.js.map +1 -0
- package/dist/commonjs/models/operations/device-connect.d.ts +0 -59
- package/dist/commonjs/models/operations/device-connect.d.ts.map +1 -1
- package/dist/commonjs/models/operations/device-connect.js +1 -50
- package/dist/commonjs/models/operations/device-connect.js.map +1 -1
- package/dist/commonjs/models/operations/device-validate.d.ts +12 -0
- package/dist/commonjs/models/operations/device-validate.d.ts.map +1 -0
- package/dist/commonjs/models/operations/device-validate.js +54 -0
- package/dist/commonjs/models/operations/device-validate.js.map +1 -0
- package/dist/commonjs/models/operations/fetch-interaction.d.ts +34 -1621
- package/dist/commonjs/models/operations/fetch-interaction.d.ts.map +1 -1
- package/dist/commonjs/models/operations/fetch-interaction.js +22 -1334
- package/dist/commonjs/models/operations/fetch-interaction.js.map +1 -1
- package/dist/commonjs/models/operations/get-journey-schemas.d.ts +16 -0
- package/dist/commonjs/models/operations/get-journey-schemas.d.ts.map +1 -0
- package/dist/commonjs/models/operations/get-journey-schemas.js +51 -0
- package/dist/commonjs/models/operations/get-journey-schemas.js.map +1 -0
- package/dist/commonjs/models/operations/get-journey-state.d.ts +16 -1383
- package/dist/commonjs/models/operations/get-journey-state.d.ts.map +1 -1
- package/dist/commonjs/models/operations/get-journey-state.js +14 -1067
- package/dist/commonjs/models/operations/get-journey-state.js.map +1 -1
- package/dist/commonjs/models/operations/get-sandbox-scenario.d.ts +39 -0
- package/dist/commonjs/models/operations/get-sandbox-scenario.d.ts.map +1 -0
- package/dist/commonjs/models/operations/get-sandbox-scenario.js +60 -0
- package/dist/commonjs/models/operations/get-sandbox-scenario.js.map +1 -0
- package/dist/commonjs/models/operations/get-task-schema.d.ts +1 -17
- package/dist/commonjs/models/operations/get-task-schema.d.ts.map +1 -1
- package/dist/commonjs/models/operations/get-task-schema.js +1 -19
- package/dist/commonjs/models/operations/get-task-schema.js.map +1 -1
- package/dist/commonjs/models/operations/index.d.ts +12 -4
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +12 -4
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/list-sandbox-scenarios.d.ts +34 -0
- package/dist/commonjs/models/operations/list-sandbox-scenarios.d.ts.map +1 -0
- package/dist/commonjs/models/operations/list-sandbox-scenarios.js +59 -0
- package/dist/commonjs/models/operations/list-sandbox-scenarios.js.map +1 -0
- package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts +2 -2
- package/dist/commonjs/models/operations/post-as-token-oauth2.d.ts.map +1 -1
- package/dist/commonjs/models/operations/post-as-token-oauth2.js +1 -1
- package/dist/commonjs/models/operations/post-as-token-oauth2.js.map +1 -1
- package/dist/commonjs/models/operations/put-sandbox-scenario.d.ts +23 -0
- package/dist/commonjs/models/operations/put-sandbox-scenario.d.ts.map +1 -0
- package/dist/commonjs/models/operations/put-sandbox-scenario.js +52 -0
- package/dist/commonjs/models/operations/put-sandbox-scenario.js.map +1 -0
- package/dist/commonjs/models/operations/retrieve-address.d.ts +29 -0
- package/dist/commonjs/models/operations/retrieve-address.d.ts.map +1 -0
- package/dist/commonjs/models/operations/retrieve-address.js +65 -0
- package/dist/commonjs/models/operations/retrieve-address.js.map +1 -0
- package/dist/commonjs/models/operations/search-addresses.d.ts +33 -0
- package/dist/commonjs/models/operations/search-addresses.d.ts.map +1 -0
- package/dist/commonjs/models/operations/search-addresses.js +67 -0
- package/dist/commonjs/models/operations/search-addresses.js.map +1 -0
- package/dist/commonjs/models/operations/start-journey.d.ts +1071 -108
- package/dist/commonjs/models/operations/start-journey.d.ts.map +1 -1
- package/dist/commonjs/models/operations/start-journey.js +504 -62
- package/dist/commonjs/models/operations/start-journey.js.map +1 -1
- package/dist/commonjs/models/operations/submit-interaction.d.ts +989 -92
- package/dist/commonjs/models/operations/submit-interaction.d.ts.map +1 -1
- package/dist/commonjs/models/operations/submit-interaction.js +464 -50
- package/dist/commonjs/models/operations/submit-interaction.js.map +1 -1
- package/dist/commonjs/models/operations/terminate-journey.d.ts +19 -0
- package/dist/commonjs/models/operations/terminate-journey.d.ts.map +1 -0
- package/dist/commonjs/models/operations/terminate-journey.js +50 -0
- package/dist/commonjs/models/operations/terminate-journey.js.map +1 -0
- package/dist/commonjs/models/operations/upload-interaction-asset.d.ts +26 -0
- package/dist/commonjs/models/operations/upload-interaction-asset.d.ts.map +1 -0
- package/dist/commonjs/models/operations/upload-interaction-asset.js +67 -0
- package/dist/commonjs/models/operations/upload-interaction-asset.js.map +1 -0
- package/dist/commonjs/models/sandbox-scenario-summary.d.ts +29 -0
- package/dist/commonjs/models/sandbox-scenario-summary.d.ts.map +1 -0
- package/dist/commonjs/models/sandbox-scenario-summary.js +63 -0
- package/dist/commonjs/models/sandbox-scenario-summary.js.map +1 -0
- package/dist/commonjs/models/sandbox-scenario-written.d.ts +19 -0
- package/dist/commonjs/models/sandbox-scenario-written.d.ts.map +1 -0
- package/dist/commonjs/models/sandbox-scenario-written.js +58 -0
- package/dist/commonjs/models/sandbox-scenario-written.js.map +1 -0
- package/dist/commonjs/models/sandbox-scenario.d.ts +31 -0
- package/dist/commonjs/models/sandbox-scenario.d.ts.map +1 -0
- package/dist/commonjs/models/sandbox-scenario.js +63 -0
- package/dist/commonjs/models/sandbox-scenario.js.map +1 -0
- package/dist/commonjs/models/schema-fetch-response.d.ts +22 -0
- package/dist/commonjs/models/schema-fetch-response.d.ts.map +1 -0
- package/dist/commonjs/models/schema-fetch-response.js +63 -0
- package/dist/commonjs/models/schema-fetch-response.js.map +1 -0
- package/dist/commonjs/models/slim-document.d.ts +57 -0
- package/dist/commonjs/models/slim-document.d.ts.map +1 -0
- package/dist/commonjs/models/slim-document.js +93 -0
- package/dist/commonjs/models/slim-document.js.map +1 -0
- package/dist/commonjs/models/slim-extraction.d.ts +74 -0
- package/dist/commonjs/models/slim-extraction.d.ts.map +1 -0
- package/dist/commonjs/models/slim-extraction.js +129 -0
- package/dist/commonjs/models/slim-extraction.js.map +1 -0
- package/dist/commonjs/models/slim-identity.d.ts +202 -0
- package/dist/commonjs/models/slim-identity.d.ts.map +1 -0
- package/dist/commonjs/models/slim-identity.js +143 -0
- package/dist/commonjs/models/slim-identity.js.map +1 -0
- package/dist/commonjs/models/slim-interaction-fetch-response.d.ts +58 -0
- package/dist/commonjs/models/slim-interaction-fetch-response.d.ts.map +1 -0
- package/dist/commonjs/models/slim-interaction-fetch-response.js +102 -0
- package/dist/commonjs/models/slim-interaction-fetch-response.js.map +1 -0
- package/dist/commonjs/models/slim-journey.d.ts +14 -0
- package/dist/commonjs/models/slim-journey.d.ts.map +1 -0
- package/dist/commonjs/models/slim-journey.js +56 -0
- package/dist/commonjs/models/slim-journey.js.map +1 -0
- package/dist/commonjs/models/slim-result.d.ts +46 -0
- package/dist/commonjs/models/slim-result.d.ts.map +1 -0
- package/dist/commonjs/models/slim-result.js +77 -0
- package/dist/commonjs/models/slim-result.js.map +1 -0
- package/dist/commonjs/models/slim-state-fetch-response.d.ts +26 -0
- package/dist/commonjs/models/slim-state-fetch-response.d.ts.map +1 -0
- package/dist/commonjs/models/slim-state-fetch-response.js +66 -0
- package/dist/commonjs/models/slim-state-fetch-response.js.map +1 -0
- package/dist/commonjs/models/slim-step.d.ts +22 -0
- package/dist/commonjs/models/slim-step.d.ts.map +1 -0
- package/dist/commonjs/models/slim-step.js +63 -0
- package/dist/commonjs/models/slim-step.js.map +1 -0
- package/dist/commonjs/models/slim-validation.d.ts +69 -0
- package/dist/commonjs/models/slim-validation.d.ts.map +1 -0
- package/dist/commonjs/models/slim-validation.js +122 -0
- package/dist/commonjs/models/slim-validation.js.map +1 -0
- package/dist/commonjs/models/slim-verified-data.d.ts +16 -0
- package/dist/commonjs/models/slim-verified-data.d.ts.map +1 -0
- package/dist/commonjs/models/slim-verified-data.js +54 -0
- package/dist/commonjs/models/slim-verified-data.js.map +1 -0
- package/dist/commonjs/models/state-fetch-response.d.ts +17 -0
- package/dist/commonjs/models/state-fetch-response.d.ts.map +1 -0
- package/dist/commonjs/models/state-fetch-response.js +54 -0
- package/dist/commonjs/models/state-fetch-response.js.map +1 -0
- package/dist/commonjs/models/terminate-response.d.ts +10 -0
- package/dist/commonjs/models/terminate-response.d.ts.map +1 -0
- package/dist/commonjs/models/{operations/health.js → terminate-response.js} +10 -10
- package/dist/commonjs/models/terminate-response.js.map +1 -0
- package/dist/commonjs/models/update-sandbox-scenario-request.d.ts +24 -0
- package/dist/commonjs/models/update-sandbox-scenario-request.d.ts.map +1 -0
- package/dist/commonjs/models/update-sandbox-scenario-request.js +55 -0
- package/dist/commonjs/models/update-sandbox-scenario-request.js.map +1 -0
- package/dist/commonjs/sdk/addresses.d.ts +20 -0
- package/dist/commonjs/sdk/addresses.d.ts.map +1 -0
- package/dist/commonjs/sdk/addresses.js +32 -0
- package/dist/commonjs/sdk/addresses.js.map +1 -0
- package/dist/commonjs/sdk/devices.d.ts +21 -6
- package/dist/commonjs/sdk/devices.d.ts.map +1 -1
- package/dist/commonjs/sdk/devices.js +26 -6
- package/dist/commonjs/sdk/devices.js.map +1 -1
- package/dist/commonjs/sdk/instances.d.ts +11 -3
- package/dist/commonjs/sdk/instances.d.ts.map +1 -1
- package/dist/commonjs/sdk/instances.js +12 -2
- package/dist/commonjs/sdk/instances.js.map +1 -1
- package/dist/commonjs/sdk/interactions.d.ts +14 -6
- package/dist/commonjs/sdk/interactions.d.ts.map +1 -1
- package/dist/commonjs/sdk/interactions.js +16 -6
- package/dist/commonjs/sdk/interactions.js.map +1 -1
- package/dist/commonjs/sdk/journeys.d.ts +45 -5
- package/dist/commonjs/sdk/journeys.d.ts.map +1 -1
- package/dist/commonjs/sdk/journeys.js +49 -4
- package/dist/commonjs/sdk/journeys.js.map +1 -1
- package/dist/commonjs/sdk/sandbox.d.ts +41 -0
- package/dist/commonjs/sdk/sandbox.d.ts.map +1 -0
- package/dist/commonjs/sdk/sandbox.js +62 -0
- package/dist/commonjs/sdk/sandbox.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +14 -11
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +17 -13
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/tasks.d.ts +6 -23
- package/dist/commonjs/sdk/tasks.d.ts.map +1 -1
- package/dist/commonjs/sdk/tasks.js +3 -31
- package/dist/commonjs/sdk/tasks.js.map +1 -1
- package/dist/commonjs/types/smart-union.d.ts.map +1 -1
- package/dist/commonjs/types/smart-union.js +14 -10
- package/dist/commonjs/types/smart-union.js.map +1 -1
- package/dist/esm/funcs/addresses-retrieve.d.ts +19 -0
- package/dist/esm/funcs/addresses-retrieve.d.ts.map +1 -0
- package/dist/esm/funcs/{tasks-update.js → addresses-retrieve.js} +20 -9
- package/dist/esm/funcs/addresses-retrieve.js.map +1 -0
- package/dist/{commonjs/funcs/tasks-list-schema.d.ts → esm/funcs/addresses-search.d.ts} +6 -6
- package/dist/esm/funcs/addresses-search.d.ts.map +1 -0
- package/dist/esm/funcs/{tasks-list.js → addresses-search.js} +20 -9
- package/dist/esm/funcs/addresses-search.js.map +1 -0
- package/dist/esm/funcs/devices-add.d.ts +5 -3
- package/dist/esm/funcs/devices-add.d.ts.map +1 -1
- package/dist/esm/funcs/devices-add.js +9 -4
- package/dist/esm/funcs/devices-add.js.map +1 -1
- package/dist/esm/funcs/devices-connect.d.ts +5 -3
- package/dist/esm/funcs/devices-connect.d.ts.map +1 -1
- package/dist/esm/funcs/devices-connect.js +11 -8
- package/dist/esm/funcs/devices-connect.js.map +1 -1
- package/dist/{commonjs/funcs/tasks-update.d.ts → esm/funcs/devices-refresh.d.ts} +6 -5
- package/dist/esm/funcs/devices-refresh.d.ts.map +1 -0
- package/dist/esm/funcs/{health-get.js → devices-refresh.js} +15 -16
- package/dist/esm/funcs/devices-refresh.js.map +1 -0
- package/dist/{commonjs/funcs/tasks-list.d.ts → esm/funcs/devices-validate.d.ts} +6 -4
- package/dist/esm/funcs/devices-validate.d.ts.map +1 -0
- package/dist/esm/funcs/devices-validate.js +77 -0
- package/dist/esm/funcs/devices-validate.js.map +1 -0
- package/dist/esm/funcs/instances-delete.d.ts +5 -3
- package/dist/esm/funcs/instances-delete.d.ts.map +1 -1
- package/dist/esm/funcs/instances-delete.js +9 -4
- package/dist/esm/funcs/instances-delete.js.map +1 -1
- package/dist/esm/funcs/instances-handoff-token.d.ts +19 -0
- package/dist/esm/funcs/instances-handoff-token.d.ts.map +1 -0
- package/dist/esm/funcs/instances-handoff-token.js +94 -0
- package/dist/esm/funcs/instances-handoff-token.js.map +1 -0
- package/dist/esm/funcs/interactions-fetch.d.ts +4 -3
- package/dist/esm/funcs/interactions-fetch.d.ts.map +1 -1
- package/dist/esm/funcs/interactions-fetch.js +20 -8
- package/dist/esm/funcs/interactions-fetch.js.map +1 -1
- package/dist/esm/funcs/interactions-submit.d.ts +5 -3
- package/dist/esm/funcs/interactions-submit.d.ts.map +1 -1
- package/dist/esm/funcs/interactions-submit.js +15 -4
- package/dist/esm/funcs/interactions-submit.js.map +1 -1
- package/dist/esm/funcs/interactions-upload-asset.d.ts +18 -0
- package/dist/esm/funcs/interactions-upload-asset.d.ts.map +1 -0
- package/dist/esm/funcs/interactions-upload-asset.js +83 -0
- package/dist/esm/funcs/interactions-upload-asset.js.map +1 -0
- package/dist/esm/funcs/journeys-get-schemas.d.ts +46 -0
- package/dist/esm/funcs/journeys-get-schemas.d.ts.map +1 -0
- package/dist/esm/funcs/journeys-get-schemas.js +114 -0
- package/dist/esm/funcs/journeys-get-schemas.js.map +1 -0
- package/dist/esm/funcs/journeys-get-state.d.ts +4 -3
- package/dist/esm/funcs/journeys-get-state.d.ts.map +1 -1
- package/dist/esm/funcs/journeys-get-state.js +14 -8
- package/dist/esm/funcs/journeys-get-state.js.map +1 -1
- package/dist/esm/funcs/journeys-start.d.ts +5 -3
- package/dist/esm/funcs/journeys-start.d.ts.map +1 -1
- package/dist/esm/funcs/journeys-start.js +9 -4
- package/dist/esm/funcs/journeys-start.js.map +1 -1
- package/dist/esm/funcs/journeys-terminate.d.ts +21 -0
- package/dist/esm/funcs/journeys-terminate.d.ts.map +1 -0
- package/dist/esm/funcs/{tasks-list-schema.js → journeys-terminate.js} +13 -8
- package/dist/esm/funcs/journeys-terminate.js.map +1 -0
- package/dist/esm/funcs/sandbox-create-scenario.d.ts +21 -0
- package/dist/esm/funcs/sandbox-create-scenario.d.ts.map +1 -0
- package/dist/esm/funcs/sandbox-create-scenario.js +93 -0
- package/dist/esm/funcs/sandbox-create-scenario.js.map +1 -0
- package/dist/esm/funcs/sandbox-delete-scenario.d.ts +20 -0
- package/dist/esm/funcs/sandbox-delete-scenario.d.ts.map +1 -0
- package/dist/esm/funcs/sandbox-delete-scenario.js +95 -0
- package/dist/esm/funcs/sandbox-delete-scenario.js.map +1 -0
- package/dist/esm/funcs/sandbox-get-scenario.d.ts +21 -0
- package/dist/esm/funcs/sandbox-get-scenario.d.ts.map +1 -0
- package/dist/esm/funcs/sandbox-get-scenario.js +100 -0
- package/dist/esm/funcs/sandbox-get-scenario.js.map +1 -0
- package/dist/esm/funcs/sandbox-list-scenarios.d.ts +21 -0
- package/dist/esm/funcs/sandbox-list-scenarios.d.ts.map +1 -0
- package/dist/esm/funcs/sandbox-list-scenarios.js +96 -0
- package/dist/esm/funcs/sandbox-list-scenarios.js.map +1 -0
- package/dist/esm/funcs/sandbox-put-scenario.d.ts +21 -0
- package/dist/esm/funcs/sandbox-put-scenario.d.ts.map +1 -0
- package/dist/esm/funcs/sandbox-put-scenario.js +97 -0
- package/dist/esm/funcs/sandbox-put-scenario.js.map +1 -0
- package/dist/esm/funcs/tasks-get-schema.d.ts +8 -3
- package/dist/esm/funcs/tasks-get-schema.d.ts.map +1 -1
- package/dist/esm/funcs/tasks-get-schema.js +10 -4
- package/dist/esm/funcs/tasks-get-schema.js.map +1 -1
- package/dist/esm/funcs/tokens-generate.js +1 -1
- package/dist/esm/funcs/tokens-generate.js.map +1 -1
- package/dist/esm/lib/config.d.ts +5 -5
- package/dist/esm/lib/config.d.ts.map +1 -1
- package/dist/esm/lib/config.js +16 -7
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/models/create-sandbox-scenario-request.d.ts +29 -0
- package/dist/esm/models/create-sandbox-scenario-request.d.ts.map +1 -0
- package/dist/esm/models/create-sandbox-scenario-request.js +18 -0
- package/dist/esm/models/create-sandbox-scenario-request.js.map +1 -0
- package/dist/esm/models/delete-response.d.ts +19 -0
- package/dist/esm/models/delete-response.d.ts.map +1 -0
- package/dist/esm/models/delete-response.js +21 -0
- package/dist/esm/models/delete-response.js.map +1 -0
- package/dist/esm/models/device-connect-response.d.ts +23 -0
- package/dist/esm/models/device-connect-response.d.ts.map +1 -0
- package/dist/esm/models/device-connect-response.js +25 -0
- package/dist/esm/models/device-connect-response.js.map +1 -0
- package/dist/esm/models/device-refresh-response.d.ts +16 -0
- package/dist/esm/models/device-refresh-response.d.ts.map +1 -0
- package/dist/esm/models/device-refresh-response.js +20 -0
- package/dist/esm/models/device-refresh-response.js.map +1 -0
- package/dist/esm/models/device-start-response.d.ts +20 -0
- package/dist/esm/models/device-start-response.d.ts.map +1 -0
- package/dist/esm/models/device-start-response.js +22 -0
- package/dist/esm/models/device-start-response.js.map +1 -0
- package/dist/esm/models/device-validate-response.d.ts +14 -0
- package/dist/esm/models/device-validate-response.d.ts.map +1 -0
- package/dist/esm/models/device-validate-response.js +18 -0
- package/dist/esm/models/device-validate-response.js.map +1 -0
- package/dist/esm/models/errors/error-response.d.ts +19 -0
- package/dist/esm/models/errors/error-response.d.ts.map +1 -0
- package/dist/esm/models/errors/error-response.js +31 -0
- package/dist/esm/models/errors/error-response.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +1 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -1
- package/dist/esm/models/errors/index.js +1 -0
- package/dist/esm/models/errors/index.js.map +1 -1
- package/dist/esm/models/gbg-error.d.ts +28 -0
- package/dist/esm/models/gbg-error.d.ts.map +1 -0
- package/dist/esm/models/gbg-error.js +32 -0
- package/dist/esm/models/gbg-error.js.map +1 -0
- package/dist/esm/models/handoff-token-response.d.ts +20 -0
- package/dist/esm/models/handoff-token-response.d.ts.map +1 -0
- package/dist/esm/models/handoff-token-response.js +23 -0
- package/dist/esm/models/handoff-token-response.js.map +1 -0
- package/dist/esm/models/index.d.ts +30 -0
- package/dist/esm/models/index.d.ts.map +1 -1
- package/dist/esm/models/index.js +30 -0
- package/dist/esm/models/index.js.map +1 -1
- package/dist/esm/models/interaction-fetch-response.d.ts +53 -0
- package/dist/esm/models/interaction-fetch-response.d.ts.map +1 -0
- package/dist/esm/models/interaction-fetch-response.js +52 -0
- package/dist/esm/models/interaction-fetch-response.js.map +1 -0
- package/dist/esm/models/interaction-submit-response.d.ts +17 -0
- package/dist/esm/models/interaction-submit-response.d.ts.map +1 -0
- package/dist/esm/models/interaction-submit-response.js +18 -0
- package/dist/esm/models/interaction-submit-response.js.map +1 -0
- package/dist/esm/models/journey-start-response.d.ts +27 -0
- package/dist/esm/models/journey-start-response.d.ts.map +1 -0
- package/dist/esm/models/journey-start-response.js +30 -0
- package/dist/esm/models/journey-start-response.js.map +1 -0
- package/dist/esm/models/loqate-retrieve-response.d.ts +12 -0
- package/dist/esm/models/loqate-retrieve-response.d.ts.map +1 -0
- package/dist/esm/models/loqate-retrieve-response.js +18 -0
- package/dist/esm/models/loqate-retrieve-response.js.map +1 -0
- package/dist/esm/models/loqate-search-response.d.ts +12 -0
- package/dist/esm/models/loqate-search-response.d.ts.map +1 -0
- package/dist/esm/models/loqate-search-response.js +18 -0
- package/dist/esm/models/loqate-search-response.js.map +1 -0
- package/dist/esm/models/operations/add-device.d.ts +8 -92
- package/dist/esm/models/operations/add-device.d.ts.map +1 -1
- package/dist/esm/models/operations/add-device.js +5 -72
- package/dist/esm/models/operations/add-device.js.map +1 -1
- package/dist/esm/models/operations/create-handoff-token.d.ts +22 -0
- package/dist/esm/models/operations/create-handoff-token.d.ts.map +1 -0
- package/dist/esm/models/operations/create-handoff-token.js +24 -0
- package/dist/esm/models/operations/create-handoff-token.js.map +1 -0
- package/dist/esm/models/operations/create-sandbox-scenario.d.ts +18 -0
- package/dist/esm/models/operations/create-sandbox-scenario.d.ts.map +1 -0
- package/dist/esm/models/operations/create-sandbox-scenario.js +14 -0
- package/dist/esm/models/operations/create-sandbox-scenario.js.map +1 -0
- package/dist/esm/models/operations/delete-instance.d.ts +1 -14
- package/dist/esm/models/operations/delete-instance.d.ts.map +1 -1
- package/dist/esm/models/operations/delete-instance.js +2 -11
- package/dist/esm/models/operations/delete-instance.js.map +1 -1
- package/dist/esm/models/operations/delete-sandbox-scenario.d.ts +20 -0
- package/dist/esm/models/operations/delete-sandbox-scenario.d.ts.map +1 -0
- package/dist/esm/models/operations/delete-sandbox-scenario.js +13 -0
- package/dist/esm/models/operations/delete-sandbox-scenario.js.map +1 -0
- package/dist/esm/models/operations/device-connect.d.ts +0 -59
- package/dist/esm/models/operations/device-connect.d.ts.map +1 -1
- package/dist/esm/models/operations/device-connect.js +0 -46
- package/dist/esm/models/operations/device-connect.js.map +1 -1
- package/dist/esm/models/operations/device-validate.d.ts +12 -0
- package/dist/esm/models/operations/device-validate.d.ts.map +1 -0
- package/dist/esm/models/operations/device-validate.js +17 -0
- package/dist/esm/models/operations/device-validate.js.map +1 -0
- package/dist/esm/models/operations/fetch-interaction.d.ts +34 -1621
- package/dist/esm/models/operations/fetch-interaction.d.ts.map +1 -1
- package/dist/esm/models/operations/fetch-interaction.js +20 -1245
- package/dist/esm/models/operations/fetch-interaction.js.map +1 -1
- package/dist/esm/models/operations/get-journey-schemas.d.ts +16 -0
- package/dist/esm/models/operations/get-journey-schemas.d.ts.map +1 -0
- package/dist/esm/models/operations/get-journey-schemas.js +14 -0
- package/dist/esm/models/operations/get-journey-schemas.js.map +1 -0
- package/dist/esm/models/operations/get-journey-state.d.ts +16 -1383
- package/dist/esm/models/operations/get-journey-state.d.ts.map +1 -1
- package/dist/esm/models/operations/get-journey-state.js +12 -996
- package/dist/esm/models/operations/get-journey-state.js.map +1 -1
- package/dist/esm/models/operations/get-sandbox-scenario.d.ts +39 -0
- package/dist/esm/models/operations/get-sandbox-scenario.d.ts.map +1 -0
- package/dist/esm/models/operations/get-sandbox-scenario.js +23 -0
- package/dist/esm/models/operations/get-sandbox-scenario.js.map +1 -0
- package/dist/esm/models/operations/get-task-schema.d.ts +1 -17
- package/dist/esm/models/operations/get-task-schema.d.ts.map +1 -1
- package/dist/esm/models/operations/get-task-schema.js +0 -17
- package/dist/esm/models/operations/get-task-schema.js.map +1 -1
- package/dist/esm/models/operations/index.d.ts +12 -4
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +12 -4
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/list-sandbox-scenarios.d.ts +34 -0
- package/dist/esm/models/operations/list-sandbox-scenarios.d.ts.map +1 -0
- package/dist/esm/models/operations/list-sandbox-scenarios.js +22 -0
- package/dist/esm/models/operations/list-sandbox-scenarios.js.map +1 -0
- package/dist/esm/models/operations/post-as-token-oauth2.d.ts +2 -2
- package/dist/esm/models/operations/post-as-token-oauth2.d.ts.map +1 -1
- package/dist/esm/models/operations/post-as-token-oauth2.js +1 -1
- package/dist/esm/models/operations/post-as-token-oauth2.js.map +1 -1
- package/dist/esm/models/operations/put-sandbox-scenario.d.ts +23 -0
- package/dist/esm/models/operations/put-sandbox-scenario.d.ts.map +1 -0
- package/dist/esm/models/operations/put-sandbox-scenario.js +15 -0
- package/dist/esm/models/operations/put-sandbox-scenario.js.map +1 -0
- package/dist/esm/models/operations/retrieve-address.d.ts +29 -0
- package/dist/esm/models/operations/retrieve-address.d.ts.map +1 -0
- package/dist/esm/models/operations/retrieve-address.js +27 -0
- package/dist/esm/models/operations/retrieve-address.js.map +1 -0
- package/dist/esm/models/operations/search-addresses.d.ts +33 -0
- package/dist/esm/models/operations/search-addresses.d.ts.map +1 -0
- package/dist/esm/models/operations/search-addresses.js +29 -0
- package/dist/esm/models/operations/search-addresses.js.map +1 -0
- package/dist/esm/models/operations/start-journey.d.ts +1071 -108
- package/dist/esm/models/operations/start-journey.d.ts.map +1 -1
- package/dist/esm/models/operations/start-journey.js +473 -55
- package/dist/esm/models/operations/start-journey.js.map +1 -1
- package/dist/esm/models/operations/submit-interaction.d.ts +989 -92
- package/dist/esm/models/operations/submit-interaction.d.ts.map +1 -1
- package/dist/esm/models/operations/submit-interaction.js +436 -44
- package/dist/esm/models/operations/submit-interaction.js.map +1 -1
- package/dist/esm/models/operations/terminate-journey.d.ts +19 -0
- package/dist/esm/models/operations/terminate-journey.d.ts.map +1 -0
- package/dist/esm/models/operations/terminate-journey.js +13 -0
- package/dist/esm/models/operations/terminate-journey.js.map +1 -0
- package/dist/esm/models/operations/upload-interaction-asset.d.ts +26 -0
- package/dist/esm/models/operations/upload-interaction-asset.d.ts.map +1 -0
- package/dist/esm/models/operations/upload-interaction-asset.js +29 -0
- package/dist/esm/models/operations/upload-interaction-asset.js.map +1 -0
- package/dist/esm/models/sandbox-scenario-summary.d.ts +29 -0
- package/dist/esm/models/sandbox-scenario-summary.d.ts.map +1 -0
- package/dist/esm/models/sandbox-scenario-summary.js +26 -0
- package/dist/esm/models/sandbox-scenario-summary.js.map +1 -0
- package/dist/esm/models/sandbox-scenario-written.d.ts +19 -0
- package/dist/esm/models/sandbox-scenario-written.d.ts.map +1 -0
- package/dist/esm/models/sandbox-scenario-written.js +21 -0
- package/dist/esm/models/sandbox-scenario-written.js.map +1 -0
- package/dist/esm/models/sandbox-scenario.d.ts +31 -0
- package/dist/esm/models/sandbox-scenario.d.ts.map +1 -0
- package/dist/esm/models/sandbox-scenario.js +26 -0
- package/dist/esm/models/sandbox-scenario.js.map +1 -0
- package/dist/esm/models/schema-fetch-response.d.ts +22 -0
- package/dist/esm/models/schema-fetch-response.d.ts.map +1 -0
- package/dist/esm/models/schema-fetch-response.js +25 -0
- package/dist/esm/models/schema-fetch-response.js.map +1 -0
- package/dist/esm/models/slim-document.d.ts +57 -0
- package/dist/esm/models/slim-document.d.ts.map +1 -0
- package/dist/esm/models/slim-document.js +54 -0
- package/dist/esm/models/slim-document.js.map +1 -0
- package/dist/esm/models/slim-extraction.d.ts +74 -0
- package/dist/esm/models/slim-extraction.d.ts.map +1 -0
- package/dist/esm/models/slim-extraction.js +85 -0
- package/dist/esm/models/slim-extraction.js.map +1 -0
- package/dist/esm/models/slim-identity.d.ts +202 -0
- package/dist/esm/models/slim-identity.d.ts.map +1 -0
- package/dist/esm/models/slim-identity.js +101 -0
- package/dist/esm/models/slim-identity.js.map +1 -0
- package/dist/esm/models/slim-interaction-fetch-response.d.ts +58 -0
- package/dist/esm/models/slim-interaction-fetch-response.d.ts.map +1 -0
- package/dist/esm/models/slim-interaction-fetch-response.js +62 -0
- package/dist/esm/models/slim-interaction-fetch-response.js.map +1 -0
- package/dist/esm/models/slim-journey.d.ts +14 -0
- package/dist/esm/models/slim-journey.d.ts.map +1 -0
- package/dist/esm/models/slim-journey.js +19 -0
- package/dist/esm/models/slim-journey.js.map +1 -0
- package/dist/esm/models/slim-result.d.ts +46 -0
- package/dist/esm/models/slim-result.d.ts.map +1 -0
- package/dist/esm/models/slim-result.js +40 -0
- package/dist/esm/models/slim-result.js.map +1 -0
- package/dist/esm/models/slim-state-fetch-response.d.ts +26 -0
- package/dist/esm/models/slim-state-fetch-response.d.ts.map +1 -0
- package/dist/esm/models/slim-state-fetch-response.js +29 -0
- package/dist/esm/models/slim-state-fetch-response.js.map +1 -0
- package/dist/esm/models/slim-step.d.ts +22 -0
- package/dist/esm/models/slim-step.d.ts.map +1 -0
- package/dist/esm/models/slim-step.js +26 -0
- package/dist/esm/models/slim-step.js.map +1 -0
- package/dist/esm/models/slim-validation.d.ts +69 -0
- package/dist/esm/models/slim-validation.d.ts.map +1 -0
- package/dist/esm/models/slim-validation.js +79 -0
- package/dist/esm/models/slim-validation.js.map +1 -0
- package/dist/esm/models/slim-verified-data.d.ts +16 -0
- package/dist/esm/models/slim-verified-data.d.ts.map +1 -0
- package/dist/esm/models/slim-verified-data.js +17 -0
- package/dist/esm/models/slim-verified-data.js.map +1 -0
- package/dist/esm/models/state-fetch-response.d.ts +17 -0
- package/dist/esm/models/state-fetch-response.d.ts.map +1 -0
- package/dist/esm/models/state-fetch-response.js +17 -0
- package/dist/esm/models/state-fetch-response.js.map +1 -0
- package/dist/esm/models/terminate-response.d.ts +10 -0
- package/dist/esm/models/terminate-response.d.ts.map +1 -0
- package/dist/esm/models/terminate-response.js +14 -0
- package/dist/esm/models/terminate-response.js.map +1 -0
- package/dist/esm/models/update-sandbox-scenario-request.d.ts +24 -0
- package/dist/esm/models/update-sandbox-scenario-request.d.ts.map +1 -0
- package/dist/esm/models/update-sandbox-scenario-request.js +17 -0
- package/dist/esm/models/update-sandbox-scenario-request.js.map +1 -0
- package/dist/esm/sdk/addresses.d.ts +20 -0
- package/dist/esm/sdk/addresses.d.ts.map +1 -0
- package/dist/esm/sdk/addresses.js +28 -0
- package/dist/esm/sdk/addresses.js.map +1 -0
- package/dist/esm/sdk/devices.d.ts +21 -6
- package/dist/esm/sdk/devices.d.ts.map +1 -1
- package/dist/esm/sdk/devices.js +26 -6
- package/dist/esm/sdk/devices.js.map +1 -1
- package/dist/esm/sdk/instances.d.ts +11 -3
- package/dist/esm/sdk/instances.d.ts.map +1 -1
- package/dist/esm/sdk/instances.js +12 -2
- package/dist/esm/sdk/instances.js.map +1 -1
- package/dist/esm/sdk/interactions.d.ts +14 -6
- package/dist/esm/sdk/interactions.d.ts.map +1 -1
- package/dist/esm/sdk/interactions.js +16 -6
- package/dist/esm/sdk/interactions.js.map +1 -1
- package/dist/esm/sdk/journeys.d.ts +45 -5
- package/dist/esm/sdk/journeys.d.ts.map +1 -1
- package/dist/esm/sdk/journeys.js +49 -4
- package/dist/esm/sdk/journeys.js.map +1 -1
- package/dist/esm/sdk/sandbox.d.ts +41 -0
- package/dist/esm/sdk/sandbox.d.ts.map +1 -0
- package/dist/esm/sdk/sandbox.js +58 -0
- package/dist/esm/sdk/sandbox.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +14 -11
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +17 -13
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/tasks.d.ts +6 -23
- package/dist/esm/sdk/tasks.d.ts.map +1 -1
- package/dist/esm/sdk/tasks.js +3 -31
- package/dist/esm/sdk/tasks.js.map +1 -1
- package/dist/esm/types/smart-union.d.ts.map +1 -1
- package/dist/esm/types/smart-union.js +14 -10
- package/dist/esm/types/smart-union.js.map +1 -1
- package/examples/{tokensGenerate.example.ts → journeysStart.example.ts} +5 -3
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/{tasks-update.ts → addresses-retrieve.ts} +39 -18
- package/src/funcs/addresses-search.ts +196 -0
- package/src/funcs/devices-add.ts +21 -11
- package/src/funcs/devices-connect.ts +25 -21
- package/src/funcs/{health-get.ts → devices-refresh.ts} +26 -22
- package/src/funcs/{tasks-list.ts → devices-validate.ts} +26 -37
- package/src/funcs/instances-delete.ts +21 -10
- package/src/funcs/instances-handoff-token.ts +191 -0
- package/src/funcs/interactions-fetch.ts +30 -10
- package/src/funcs/interactions-submit.ts +28 -10
- package/src/funcs/interactions-upload-asset.ts +173 -0
- package/src/funcs/journeys-get-schemas.ts +207 -0
- package/src/funcs/journeys-get-state.ts +23 -10
- package/src/funcs/journeys-start.ts +21 -11
- package/src/funcs/{tasks-list-schema.ts → journeys-terminate.ts} +26 -15
- package/src/funcs/sandbox-create-scenario.ts +185 -0
- package/src/funcs/sandbox-delete-scenario.ts +187 -0
- package/src/funcs/sandbox-get-scenario.ts +193 -0
- package/src/funcs/sandbox-list-scenarios.ts +189 -0
- package/src/funcs/sandbox-put-scenario.ts +189 -0
- package/src/funcs/tasks-get-schema.ts +22 -10
- package/src/funcs/tokens-generate.ts +1 -1
- package/src/lib/config.ts +16 -7
- package/src/models/create-sandbox-scenario-request.ts +65 -0
- package/src/models/delete-response.ts +46 -0
- package/src/models/device-connect-response.ts +56 -0
- package/src/models/device-refresh-response.ts +43 -0
- package/src/models/device-start-response.ts +50 -0
- package/src/models/device-validate-response.ts +39 -0
- package/src/models/errors/error-response.ts +52 -0
- package/src/models/errors/index.ts +1 -0
- package/src/models/gbg-error.ts +55 -0
- package/src/models/handoff-token-response.ts +49 -0
- package/src/models/index.ts +30 -0
- package/src/models/interaction-fetch-response.ts +147 -0
- package/src/models/interaction-submit-response.ts +43 -0
- package/src/models/journey-start-response.ts +64 -0
- package/src/models/loqate-retrieve-response.ts +38 -0
- package/src/models/loqate-search-response.ts +38 -0
- package/src/models/operations/add-device.ts +17 -176
- package/src/models/operations/create-handoff-token.ts +63 -0
- package/src/models/operations/create-sandbox-scenario.ts +39 -0
- package/src/models/operations/delete-instance.ts +7 -38
- package/src/models/operations/delete-sandbox-scenario.ts +41 -0
- package/src/models/operations/device-connect.ts +0 -128
- package/src/models/operations/device-validate.ts +38 -0
- package/src/models/operations/fetch-interaction.ts +95 -3795
- package/src/models/operations/get-journey-schemas.ts +36 -0
- package/src/models/operations/get-journey-state.ts +57 -3183
- package/src/models/operations/get-sandbox-scenario.ts +65 -0
- package/src/models/operations/get-task-schema.ts +1 -44
- package/src/models/operations/index.ts +12 -4
- package/src/models/operations/list-sandbox-scenarios.ts +63 -0
- package/src/models/operations/post-as-token-oauth2.ts +5 -5
- package/src/models/operations/put-sandbox-scenario.ts +43 -0
- package/src/models/operations/retrieve-address.ts +73 -0
- package/src/models/operations/search-addresses.ts +79 -0
- package/src/models/operations/start-journey.ts +2624 -1052
- package/src/models/operations/submit-interaction.ts +2648 -1114
- package/src/models/operations/terminate-journey.ts +41 -0
- package/src/models/operations/upload-interaction-asset.ts +75 -0
- package/src/models/sandbox-scenario-summary.ts +63 -0
- package/src/models/sandbox-scenario-written.ts +48 -0
- package/src/models/sandbox-scenario.ts +61 -0
- package/src/models/schema-fetch-response.ts +58 -0
- package/src/models/slim-document.ts +135 -0
- package/src/models/slim-extraction.ts +236 -0
- package/src/models/slim-identity.ts +348 -0
- package/src/models/slim-interaction-fetch-response.ts +169 -0
- package/src/models/slim-journey.ts +37 -0
- package/src/models/slim-result.ts +87 -0
- package/src/models/slim-state-fetch-response.ts +59 -0
- package/src/models/slim-step.ts +54 -0
- package/src/models/slim-validation.ts +230 -0
- package/src/models/slim-verified-data.ts +38 -0
- package/src/models/state-fetch-response.ts +37 -0
- package/src/models/terminate-response.ts +31 -0
- package/src/models/update-sandbox-scenario-request.ts +59 -0
- package/src/sdk/addresses.ts +50 -0
- package/src/sdk/devices.ts +46 -11
- package/src/sdk/instances.ts +24 -3
- package/src/sdk/interactions.ts +30 -11
- package/src/sdk/journeys.ts +67 -5
- package/src/sdk/sandbox.ts +100 -0
- package/src/sdk/sdk.ts +25 -19
- package/src/sdk/tasks.ts +4 -60
- package/src/types/smart-union.ts +18 -10
- package/dist/commonjs/funcs/health-get.d.ts.map +0 -1
- package/dist/commonjs/funcs/health-get.js.map +0 -1
- package/dist/commonjs/funcs/tasks-list-schema.d.ts.map +0 -1
- package/dist/commonjs/funcs/tasks-list-schema.js.map +0 -1
- package/dist/commonjs/funcs/tasks-list.d.ts.map +0 -1
- package/dist/commonjs/funcs/tasks-list.js.map +0 -1
- package/dist/commonjs/funcs/tasks-update.d.ts.map +0 -1
- package/dist/commonjs/funcs/tasks-update.js.map +0 -1
- package/dist/commonjs/models/operations/get-tasks-schema.d.ts +0 -71
- package/dist/commonjs/models/operations/get-tasks-schema.d.ts.map +0 -1
- package/dist/commonjs/models/operations/get-tasks-schema.js +0 -108
- package/dist/commonjs/models/operations/get-tasks-schema.js.map +0 -1
- package/dist/commonjs/models/operations/get-tasks.d.ts +0 -62
- package/dist/commonjs/models/operations/get-tasks.d.ts.map +0 -1
- package/dist/commonjs/models/operations/get-tasks.js +0 -91
- package/dist/commonjs/models/operations/get-tasks.js.map +0 -1
- package/dist/commonjs/models/operations/health.d.ts +0 -14
- package/dist/commonjs/models/operations/health.d.ts.map +0 -1
- package/dist/commonjs/models/operations/health.js.map +0 -1
- package/dist/commonjs/models/operations/update-task.d.ts +0 -2105
- package/dist/commonjs/models/operations/update-task.d.ts.map +0 -1
- package/dist/commonjs/models/operations/update-task.js +0 -1115
- package/dist/commonjs/models/operations/update-task.js.map +0 -1
- package/dist/commonjs/sdk/health.d.ts +0 -12
- package/dist/commonjs/sdk/health.d.ts.map +0 -1
- package/dist/commonjs/sdk/health.js +0 -22
- package/dist/commonjs/sdk/health.js.map +0 -1
- package/dist/commonjs/types/discriminated-union.d.ts +0 -25
- package/dist/commonjs/types/discriminated-union.d.ts.map +0 -1
- package/dist/commonjs/types/discriminated-union.js +0 -98
- package/dist/commonjs/types/discriminated-union.js.map +0 -1
- package/dist/esm/funcs/health-get.d.ts.map +0 -1
- package/dist/esm/funcs/health-get.js.map +0 -1
- package/dist/esm/funcs/tasks-list-schema.d.ts.map +0 -1
- package/dist/esm/funcs/tasks-list-schema.js.map +0 -1
- package/dist/esm/funcs/tasks-list.d.ts +0 -17
- package/dist/esm/funcs/tasks-list.d.ts.map +0 -1
- package/dist/esm/funcs/tasks-list.js.map +0 -1
- package/dist/esm/funcs/tasks-update.d.ts +0 -17
- package/dist/esm/funcs/tasks-update.d.ts.map +0 -1
- package/dist/esm/funcs/tasks-update.js.map +0 -1
- package/dist/esm/models/operations/get-tasks-schema.d.ts +0 -71
- package/dist/esm/models/operations/get-tasks-schema.d.ts.map +0 -1
- package/dist/esm/models/operations/get-tasks-schema.js +0 -67
- package/dist/esm/models/operations/get-tasks-schema.js.map +0 -1
- package/dist/esm/models/operations/get-tasks.d.ts +0 -62
- package/dist/esm/models/operations/get-tasks.d.ts.map +0 -1
- package/dist/esm/models/operations/get-tasks.js +0 -51
- package/dist/esm/models/operations/get-tasks.js.map +0 -1
- package/dist/esm/models/operations/health.d.ts +0 -14
- package/dist/esm/models/operations/health.d.ts.map +0 -1
- package/dist/esm/models/operations/health.js +0 -14
- package/dist/esm/models/operations/health.js.map +0 -1
- package/dist/esm/models/operations/update-task.d.ts +0 -2105
- package/dist/esm/models/operations/update-task.d.ts.map +0 -1
- package/dist/esm/models/operations/update-task.js +0 -1007
- package/dist/esm/models/operations/update-task.js.map +0 -1
- package/dist/esm/sdk/health.d.ts +0 -12
- package/dist/esm/sdk/health.d.ts.map +0 -1
- package/dist/esm/sdk/health.js +0 -18
- package/dist/esm/sdk/health.js.map +0 -1
- package/dist/esm/types/discriminated-union.d.ts +0 -25
- package/dist/esm/types/discriminated-union.d.ts.map +0 -1
- package/dist/esm/types/discriminated-union.js +0 -61
- package/dist/esm/types/discriminated-union.js.map +0 -1
- package/src/models/operations/get-tasks-schema.ts +0 -173
- package/src/models/operations/get-tasks.ts +0 -144
- package/src/models/operations/health.ts +0 -38
- package/src/models/operations/update-task.ts +0 -3818
- package/src/sdk/health.ts +0 -25
- package/src/types/discriminated-union.ts +0 -101
|
@@ -3,31 +3,8 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
import * as z from "zod/v4-mini";
|
|
6
|
-
import { safeParse } from "../../lib/schemas.js";
|
|
7
6
|
import { ClosedEnum } from "../../types/enums.js";
|
|
8
|
-
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
9
|
-
import * as types from "../../types/primitives.js";
|
|
10
7
|
import { smartUnion } from "../../types/smart-union.js";
|
|
11
|
-
import { SDKValidationError } from "../errors/sdk-validation-error.js";
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* The method by which the End User will consume the journey.
|
|
15
|
-
*/
|
|
16
|
-
export const Delivery = {
|
|
17
|
-
Page: "page",
|
|
18
|
-
Api: "api",
|
|
19
|
-
} as const;
|
|
20
|
-
/**
|
|
21
|
-
* The method by which the End User will consume the journey.
|
|
22
|
-
*/
|
|
23
|
-
export type Delivery = ClosedEnum<typeof Delivery>;
|
|
24
|
-
|
|
25
|
-
export type Config = {
|
|
26
|
-
/**
|
|
27
|
-
* The method by which the End User will consume the journey.
|
|
28
|
-
*/
|
|
29
|
-
delivery: Delivery;
|
|
30
|
-
};
|
|
31
8
|
|
|
32
9
|
export type StartJourneyIdentityAlias = {
|
|
33
10
|
/**
|
|
@@ -50,11 +27,16 @@ export type StartJourneyIdentityAlias = {
|
|
|
50
27
|
* Any family names for the individual
|
|
51
28
|
*/
|
|
52
29
|
lastNamesAtBirth?: Array<string> | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
|
|
32
|
+
*/
|
|
33
|
+
fullName?: string | undefined;
|
|
53
34
|
};
|
|
54
35
|
|
|
55
36
|
export const StartJourneyIdentityRelationship = {
|
|
56
37
|
Mother: "mother",
|
|
57
38
|
Father: "father",
|
|
39
|
+
Spouse: "spouse",
|
|
58
40
|
MaternalGrandFather: "maternalGrandFather",
|
|
59
41
|
MaternalGrandMother: "maternalGrandMother",
|
|
60
42
|
PaternalGrandFather: "paternalGrandFather",
|
|
@@ -108,15 +90,15 @@ export type StartJourneyIdentityCurrentAddress = {
|
|
|
108
90
|
*/
|
|
109
91
|
addressString?: string | undefined;
|
|
110
92
|
/**
|
|
111
|
-
* The
|
|
93
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
112
94
|
*/
|
|
113
95
|
premise?: string | undefined;
|
|
114
96
|
/**
|
|
115
|
-
* The name of
|
|
97
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
116
98
|
*/
|
|
117
99
|
building?: string | undefined;
|
|
118
100
|
/**
|
|
119
|
-
* The
|
|
101
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
120
102
|
*/
|
|
121
103
|
subBuilding?: string | undefined;
|
|
122
104
|
/**
|
|
@@ -178,15 +160,15 @@ export type StartJourneyIdentityPreviousAddress = {
|
|
|
178
160
|
*/
|
|
179
161
|
addressString?: string | undefined;
|
|
180
162
|
/**
|
|
181
|
-
* The
|
|
163
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
182
164
|
*/
|
|
183
165
|
premise?: string | undefined;
|
|
184
166
|
/**
|
|
185
|
-
* The name of
|
|
167
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
186
168
|
*/
|
|
187
169
|
building?: string | undefined;
|
|
188
170
|
/**
|
|
189
|
-
* The
|
|
171
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
190
172
|
*/
|
|
191
173
|
subBuilding?: string | undefined;
|
|
192
174
|
/**
|
|
@@ -229,11 +211,11 @@ export type StartJourneyIdentityPreviousAddress = {
|
|
|
229
211
|
/**
|
|
230
212
|
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
231
213
|
*/
|
|
232
|
-
fromDate
|
|
214
|
+
fromDate?: string | undefined;
|
|
233
215
|
/**
|
|
234
216
|
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
235
217
|
*/
|
|
236
|
-
toDate
|
|
218
|
+
toDate?: string | undefined;
|
|
237
219
|
};
|
|
238
220
|
|
|
239
221
|
export type StartJourneyIdentityPlaceOfBirthLocation = {
|
|
@@ -256,15 +238,15 @@ export type StartJourneyIdentityPlaceOfBirth = {
|
|
|
256
238
|
*/
|
|
257
239
|
addressString?: string | undefined;
|
|
258
240
|
/**
|
|
259
|
-
* The
|
|
241
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
260
242
|
*/
|
|
261
243
|
premise?: string | undefined;
|
|
262
244
|
/**
|
|
263
|
-
* The name of
|
|
245
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
264
246
|
*/
|
|
265
247
|
building?: string | undefined;
|
|
266
248
|
/**
|
|
267
|
-
* The
|
|
249
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
268
250
|
*/
|
|
269
251
|
subBuilding?: string | undefined;
|
|
270
252
|
/**
|
|
@@ -334,7 +316,7 @@ export type StartJourneyIdentityPhone = {
|
|
|
334
316
|
|
|
335
317
|
export type StartJourneyIdentityEmail = {
|
|
336
318
|
/**
|
|
337
|
-
*
|
|
319
|
+
* Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other'. Three map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work' or 'other' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
|
|
338
320
|
*/
|
|
339
321
|
type: string;
|
|
340
322
|
/**
|
|
@@ -375,6 +357,9 @@ export type StartJourneyIdentity = {
|
|
|
375
357
|
* Any family names for the individual
|
|
376
358
|
*/
|
|
377
359
|
lastNamesAtBirth?: Array<string> | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
|
|
362
|
+
*/
|
|
378
363
|
aliases?: Array<StartJourneyIdentityAlias> | undefined;
|
|
379
364
|
relatedPersons?: Array<StartJourneyIdentityRelatedPerson> | undefined;
|
|
380
365
|
/**
|
|
@@ -393,299 +378,230 @@ export type StartJourneyIdentity = {
|
|
|
393
378
|
* The subject's mother's maiden name, used for identity verification
|
|
394
379
|
*/
|
|
395
380
|
mothersMaidenName?: string | undefined;
|
|
381
|
+
/**
|
|
382
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
383
|
+
*/
|
|
384
|
+
nationality?: string | undefined;
|
|
396
385
|
};
|
|
397
386
|
|
|
398
|
-
export
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
administrativeArea?: string | undefined;
|
|
405
|
-
postalCode?: string | undefined;
|
|
406
|
-
};
|
|
407
|
-
|
|
408
|
-
export type StartJourneyDocumentDevice = {
|
|
409
|
-
type?: string | undefined;
|
|
410
|
-
model?: string | undefined;
|
|
411
|
-
hasContactlessReader?: boolean | undefined;
|
|
412
|
-
hasMagneticStripeReader?: boolean | undefined;
|
|
413
|
-
hasCamera?: boolean | undefined;
|
|
414
|
-
serialNumber?: string | undefined;
|
|
415
|
-
manufacturer?: string | undefined;
|
|
416
|
-
};
|
|
387
|
+
export const StartJourneyTypePrimary1 = {
|
|
388
|
+
Primary: "primary",
|
|
389
|
+
} as const;
|
|
390
|
+
export type StartJourneyTypePrimary1 = ClosedEnum<
|
|
391
|
+
typeof StartJourneyTypePrimary1
|
|
392
|
+
>;
|
|
417
393
|
|
|
418
|
-
export const
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
Dg5: "DG5",
|
|
426
|
-
Dg6: "DG6",
|
|
427
|
-
Dg7: "DG7",
|
|
428
|
-
Dg8: "DG8",
|
|
429
|
-
Dg9: "DG9",
|
|
430
|
-
Dg10: "DG10",
|
|
431
|
-
Dg11: "DG11",
|
|
432
|
-
Dg12: "DG12",
|
|
433
|
-
Dg13: "DG13",
|
|
434
|
-
Dg14: "DG14",
|
|
435
|
-
Dg15: "DG15",
|
|
394
|
+
export const StartJourneyStatus = {
|
|
395
|
+
Active: "active",
|
|
396
|
+
Suspended: "suspended",
|
|
397
|
+
Dormant: "dormant",
|
|
398
|
+
Dissolved: "dissolved",
|
|
399
|
+
StruckOff: "struckOff",
|
|
400
|
+
Unknown: "unknown",
|
|
436
401
|
} as const;
|
|
437
|
-
export type
|
|
402
|
+
export type StartJourneyStatus = ClosedEnum<typeof StartJourneyStatus>;
|
|
438
403
|
|
|
439
|
-
export type
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
404
|
+
export type StartJourneyAddressLocation = {
|
|
405
|
+
latitude?: string | undefined;
|
|
406
|
+
longitude?: string | undefined;
|
|
407
|
+
geoAccuracy?: string | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* A What3words designation associated with this location with '.' separator.
|
|
410
|
+
*/
|
|
411
|
+
what3words?: string | undefined;
|
|
443
412
|
};
|
|
444
413
|
|
|
445
|
-
export const
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
ExtendedAccessControl: "ExtendedAccessControl",
|
|
452
|
-
TerminalAuthentication: "TerminalAuthentication",
|
|
414
|
+
export const StartJourneyPurpose = {
|
|
415
|
+
Registered: "registered",
|
|
416
|
+
Mailing: "mailing",
|
|
417
|
+
Site: "site",
|
|
418
|
+
Agent: "agent",
|
|
419
|
+
Headquarters: "headquarters",
|
|
453
420
|
} as const;
|
|
454
|
-
export type
|
|
421
|
+
export type StartJourneyPurpose = ClosedEnum<typeof StartJourneyPurpose>;
|
|
455
422
|
|
|
456
|
-
export
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
423
|
+
export type StartJourneyAddressPrimary = {
|
|
424
|
+
/**
|
|
425
|
+
* Unformatted line based address
|
|
426
|
+
*/
|
|
427
|
+
lines?: Array<string> | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* The address as a single line
|
|
430
|
+
*/
|
|
431
|
+
addressString?: string | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
434
|
+
*/
|
|
435
|
+
premise?: string | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
438
|
+
*/
|
|
439
|
+
building?: string | undefined;
|
|
440
|
+
/**
|
|
441
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
442
|
+
*/
|
|
443
|
+
subBuilding?: string | undefined;
|
|
444
|
+
/**
|
|
445
|
+
* This field holds the most common street or block data element within a country. For instance, USA Street
|
|
446
|
+
*/
|
|
447
|
+
thoroughfare?: string | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* The name of a dependent street or block, such as a street within a complex.
|
|
450
|
+
*/
|
|
451
|
+
dependentThoroughfare?: string | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
|
|
454
|
+
*/
|
|
455
|
+
locality?: string | undefined;
|
|
456
|
+
/**
|
|
457
|
+
* This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
|
|
458
|
+
*/
|
|
459
|
+
dependentLocality?: string | undefined;
|
|
460
|
+
/**
|
|
461
|
+
* This is an even smaller area within a dependent locality, often used in very detailed addresses.
|
|
462
|
+
*/
|
|
463
|
+
doubleDependentLocality?: string | undefined;
|
|
464
|
+
/**
|
|
465
|
+
* This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
|
|
466
|
+
*/
|
|
467
|
+
postalCode?: string | undefined;
|
|
468
|
+
/**
|
|
469
|
+
* This field contains the post box number associated with a particular delivery point, should one exist.
|
|
470
|
+
*/
|
|
471
|
+
postBox?: string | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
474
|
+
*/
|
|
475
|
+
country?: string | undefined;
|
|
476
|
+
superAdministrativeArea?: string | undefined;
|
|
477
|
+
administrativeArea?: string | undefined;
|
|
478
|
+
subAdministrativeArea?: string | undefined;
|
|
479
|
+
organization?: string | undefined;
|
|
480
|
+
location?: StartJourneyAddressLocation | undefined;
|
|
481
|
+
purpose?: StartJourneyPurpose | undefined;
|
|
482
|
+
};
|
|
483
|
+
|
|
484
|
+
export const StartJourneyTaxIdentifierType = {
|
|
485
|
+
Tin: "TIN",
|
|
486
|
+
Ein: "EIN",
|
|
460
487
|
} as const;
|
|
461
|
-
export type
|
|
488
|
+
export type StartJourneyTaxIdentifierType = ClosedEnum<
|
|
489
|
+
typeof StartJourneyTaxIdentifierType
|
|
490
|
+
>;
|
|
462
491
|
|
|
463
|
-
export type
|
|
464
|
-
type:
|
|
465
|
-
|
|
466
|
-
|
|
492
|
+
export type StartJourneyTaxIdentifier = {
|
|
493
|
+
type: StartJourneyTaxIdentifierType;
|
|
494
|
+
value: string;
|
|
495
|
+
/**
|
|
496
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
497
|
+
*/
|
|
498
|
+
country?: string | undefined;
|
|
467
499
|
};
|
|
468
500
|
|
|
469
|
-
export
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
501
|
+
export const StartJourneySystem = {
|
|
502
|
+
Naics2017: "naics2017",
|
|
503
|
+
Naics2022: "naics2022",
|
|
504
|
+
Sic: "sic",
|
|
505
|
+
Mcc: "mcc",
|
|
506
|
+
} as const;
|
|
507
|
+
export type StartJourneySystem = ClosedEnum<typeof StartJourneySystem>;
|
|
474
508
|
|
|
475
|
-
export type
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
documentQualityScore: number;
|
|
509
|
+
export type StartJourneyIndustryClassification = {
|
|
510
|
+
system: StartJourneySystem;
|
|
511
|
+
code: string;
|
|
512
|
+
description?: string | undefined;
|
|
480
513
|
};
|
|
481
514
|
|
|
482
|
-
export
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
515
|
+
export const StartJourneyRegistrationType = {
|
|
516
|
+
Domestic: "domestic",
|
|
517
|
+
Foreign: "foreign",
|
|
518
|
+
Unknown: "unknown",
|
|
519
|
+
} as const;
|
|
520
|
+
export type StartJourneyRegistrationType = ClosedEnum<
|
|
521
|
+
typeof StartJourneyRegistrationType
|
|
522
|
+
>;
|
|
523
|
+
|
|
524
|
+
export type StartJourneyRegisteredAddressLocation = {
|
|
525
|
+
latitude?: string | undefined;
|
|
526
|
+
longitude?: string | undefined;
|
|
527
|
+
geoAccuracy?: string | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* A What3words designation associated with this location with '.' separator.
|
|
530
|
+
*/
|
|
531
|
+
what3words?: string | undefined;
|
|
495
532
|
};
|
|
496
533
|
|
|
497
|
-
export type
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
534
|
+
export type StartJourneyRegisteredAddress = {
|
|
535
|
+
/**
|
|
536
|
+
* Unformatted line based address
|
|
537
|
+
*/
|
|
538
|
+
lines?: Array<string> | undefined;
|
|
539
|
+
/**
|
|
540
|
+
* The address as a single line
|
|
541
|
+
*/
|
|
542
|
+
addressString?: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
545
|
+
*/
|
|
546
|
+
premise?: string | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
549
|
+
*/
|
|
550
|
+
building?: string | undefined;
|
|
551
|
+
/**
|
|
552
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
553
|
+
*/
|
|
554
|
+
subBuilding?: string | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* This field holds the most common street or block data element within a country. For instance, USA Street
|
|
557
|
+
*/
|
|
558
|
+
thoroughfare?: string | undefined;
|
|
559
|
+
/**
|
|
560
|
+
* The name of a dependent street or block, such as a street within a complex.
|
|
561
|
+
*/
|
|
562
|
+
dependentThoroughfare?: string | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
|
|
565
|
+
*/
|
|
566
|
+
locality?: string | undefined;
|
|
567
|
+
/**
|
|
568
|
+
* This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
|
|
569
|
+
*/
|
|
570
|
+
dependentLocality?: string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* This is an even smaller area within a dependent locality, often used in very detailed addresses.
|
|
573
|
+
*/
|
|
574
|
+
doubleDependentLocality?: string | undefined;
|
|
575
|
+
/**
|
|
576
|
+
* This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
|
|
577
|
+
*/
|
|
578
|
+
postalCode?: string | undefined;
|
|
579
|
+
/**
|
|
580
|
+
* This field contains the post box number associated with a particular delivery point, should one exist.
|
|
581
|
+
*/
|
|
582
|
+
postBox?: string | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
585
|
+
*/
|
|
586
|
+
country?: string | undefined;
|
|
587
|
+
superAdministrativeArea?: string | undefined;
|
|
588
|
+
administrativeArea?: string | undefined;
|
|
589
|
+
subAdministrativeArea?: string | undefined;
|
|
590
|
+
organization?: string | undefined;
|
|
591
|
+
location?: StartJourneyRegisteredAddressLocation | undefined;
|
|
502
592
|
};
|
|
503
593
|
|
|
504
|
-
export type
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
594
|
+
export type StartJourneyAgentAddressLocation = {
|
|
595
|
+
latitude?: string | undefined;
|
|
596
|
+
longitude?: string | undefined;
|
|
597
|
+
geoAccuracy?: string | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* A What3words designation associated with this location with '.' separator.
|
|
600
|
+
*/
|
|
601
|
+
what3words?: string | undefined;
|
|
509
602
|
};
|
|
510
603
|
|
|
511
|
-
export type
|
|
512
|
-
label: string;
|
|
513
|
-
value: string;
|
|
514
|
-
source: string;
|
|
515
|
-
isNonLatin: boolean;
|
|
516
|
-
regionOfInterest?: StartJourneyAggregatedFieldRegionOfInterest | undefined;
|
|
517
|
-
};
|
|
518
|
-
|
|
519
|
-
export type StartJourneyDetailBoundingBox = {
|
|
520
|
-
x: number;
|
|
521
|
-
y: number;
|
|
522
|
-
width: number;
|
|
523
|
-
height: number;
|
|
524
|
-
};
|
|
525
|
-
|
|
526
|
-
export type StartJourneyDetailRegionOfInterest = {
|
|
527
|
-
boundingBox?: StartJourneyDetailBoundingBox | undefined;
|
|
528
|
-
side: string;
|
|
529
|
-
spectrum?: string | undefined;
|
|
530
|
-
imageId?: string | undefined;
|
|
531
|
-
};
|
|
532
|
-
|
|
533
|
-
export type StartJourneyDetail = {
|
|
534
|
-
label: string;
|
|
535
|
-
value: string;
|
|
536
|
-
source: string;
|
|
537
|
-
isNonLatin: boolean;
|
|
538
|
-
regionOfInterest?: StartJourneyDetailRegionOfInterest | undefined;
|
|
539
|
-
};
|
|
540
|
-
|
|
541
|
-
export type StartJourneyExtractedField = {
|
|
542
|
-
label: string;
|
|
543
|
-
details: Array<StartJourneyDetail>;
|
|
544
|
-
};
|
|
545
|
-
|
|
546
|
-
export type StartJourneyExtractedImage = {
|
|
547
|
-
label: string;
|
|
548
|
-
side: string;
|
|
549
|
-
imageID: string;
|
|
550
|
-
};
|
|
551
|
-
|
|
552
|
-
export type StartJourneyExtraction = {
|
|
553
|
-
aggregatedFields?: Array<StartJourneyAggregatedField> | undefined;
|
|
554
|
-
extractedFields?: Array<StartJourneyExtractedField> | undefined;
|
|
555
|
-
extractedImages?: Array<StartJourneyExtractedImage> | undefined;
|
|
556
|
-
};
|
|
557
|
-
|
|
558
|
-
export type StartJourneyValidationCheckBoundingBox = {
|
|
559
|
-
x: number;
|
|
560
|
-
y: number;
|
|
561
|
-
width: number;
|
|
562
|
-
height: number;
|
|
563
|
-
};
|
|
564
|
-
|
|
565
|
-
export type StartJourneyValidationCheckRegionOfInterest = {
|
|
566
|
-
boundingBox?: StartJourneyValidationCheckBoundingBox | undefined;
|
|
567
|
-
side: string;
|
|
568
|
-
spectrum?: string | undefined;
|
|
569
|
-
imageId?: string | undefined;
|
|
570
|
-
};
|
|
571
|
-
|
|
572
|
-
export type StartJourneyValidationCheck = {
|
|
573
|
-
name: string;
|
|
574
|
-
title: string;
|
|
575
|
-
info: string;
|
|
576
|
-
validationResult: string;
|
|
577
|
-
resultInfo: string;
|
|
578
|
-
weight: string;
|
|
579
|
-
regionOfInterests?:
|
|
580
|
-
| Array<StartJourneyValidationCheckRegionOfInterest>
|
|
581
|
-
| undefined;
|
|
582
|
-
type: string;
|
|
583
|
-
};
|
|
584
|
-
|
|
585
|
-
export type StartJourneyAggregatedValidationCheckBoundingBox = {
|
|
586
|
-
x: number;
|
|
587
|
-
y: number;
|
|
588
|
-
width: number;
|
|
589
|
-
height: number;
|
|
590
|
-
};
|
|
591
|
-
|
|
592
|
-
export type StartJourneyAggregatedValidationCheckRegionOfInterest = {
|
|
593
|
-
boundingBox?: StartJourneyAggregatedValidationCheckBoundingBox | undefined;
|
|
594
|
-
side: string;
|
|
595
|
-
spectrum?: string | undefined;
|
|
596
|
-
imageId?: string | undefined;
|
|
597
|
-
};
|
|
598
|
-
|
|
599
|
-
export type StartJourneyAggregatedValidationCheck = {
|
|
600
|
-
name: string;
|
|
601
|
-
title: string;
|
|
602
|
-
info: string;
|
|
603
|
-
validationResult: string;
|
|
604
|
-
resultInfo: string;
|
|
605
|
-
weight: string;
|
|
606
|
-
regionOfInterests?:
|
|
607
|
-
| Array<StartJourneyAggregatedValidationCheckRegionOfInterest>
|
|
608
|
-
| undefined;
|
|
609
|
-
type: string;
|
|
610
|
-
};
|
|
611
|
-
|
|
612
|
-
export type StartJourneyValidation = {
|
|
613
|
-
validationChecks?: Array<StartJourneyValidationCheck> | undefined;
|
|
614
|
-
aggregatedValidationChecks?:
|
|
615
|
-
| Array<StartJourneyAggregatedValidationCheck>
|
|
616
|
-
| undefined;
|
|
617
|
-
};
|
|
618
|
-
|
|
619
|
-
export type StartJourneyDocumentAlias = {
|
|
620
|
-
/**
|
|
621
|
-
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
622
|
-
*/
|
|
623
|
-
title?: string | undefined;
|
|
624
|
-
/**
|
|
625
|
-
* A person's name used by their collegues and friends to address them
|
|
626
|
-
*/
|
|
627
|
-
firstName?: string | undefined;
|
|
628
|
-
/**
|
|
629
|
-
* Any other registered names used by the individual, not aliases
|
|
630
|
-
*/
|
|
631
|
-
middleNames?: Array<string> | undefined;
|
|
632
|
-
/**
|
|
633
|
-
* Any family names for the individual
|
|
634
|
-
*/
|
|
635
|
-
lastNames?: Array<string> | undefined;
|
|
636
|
-
/**
|
|
637
|
-
* Any family names for the individual
|
|
638
|
-
*/
|
|
639
|
-
lastNamesAtBirth?: Array<string> | undefined;
|
|
640
|
-
};
|
|
641
|
-
|
|
642
|
-
export const StartJourneyDocumentRelationship = {
|
|
643
|
-
Mother: "mother",
|
|
644
|
-
Father: "father",
|
|
645
|
-
MaternalGrandFather: "maternalGrandFather",
|
|
646
|
-
MaternalGrandMother: "maternalGrandMother",
|
|
647
|
-
PaternalGrandFather: "paternalGrandFather",
|
|
648
|
-
PaternalGrandMother: "paternalGrandMother",
|
|
649
|
-
} as const;
|
|
650
|
-
export type StartJourneyDocumentRelationship = ClosedEnum<
|
|
651
|
-
typeof StartJourneyDocumentRelationship
|
|
652
|
-
>;
|
|
653
|
-
|
|
654
|
-
export type StartJourneyDocumentRelatedPerson = {
|
|
655
|
-
/**
|
|
656
|
-
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
657
|
-
*/
|
|
658
|
-
title?: string | undefined;
|
|
659
|
-
/**
|
|
660
|
-
* A person's name used by their collegues and friends to address them
|
|
661
|
-
*/
|
|
662
|
-
firstName?: string | undefined;
|
|
663
|
-
/**
|
|
664
|
-
* Any other registered names used by the individual, not aliases
|
|
665
|
-
*/
|
|
666
|
-
middleNames?: Array<string> | undefined;
|
|
667
|
-
/**
|
|
668
|
-
* Any family names for the individual
|
|
669
|
-
*/
|
|
670
|
-
lastNames?: Array<string> | undefined;
|
|
671
|
-
/**
|
|
672
|
-
* Any family names for the individual
|
|
673
|
-
*/
|
|
674
|
-
lastNamesAtBirth?: Array<string> | undefined;
|
|
675
|
-
relationship: StartJourneyDocumentRelationship;
|
|
676
|
-
};
|
|
677
|
-
|
|
678
|
-
export type StartJourneyDocumentCurrentAddressLocation = {
|
|
679
|
-
latitude?: string | undefined;
|
|
680
|
-
longitude?: string | undefined;
|
|
681
|
-
geoAccuracy?: string | undefined;
|
|
682
|
-
/**
|
|
683
|
-
* A What3words designation associated with this location with '.' separator.
|
|
684
|
-
*/
|
|
685
|
-
what3words?: string | undefined;
|
|
686
|
-
};
|
|
687
|
-
|
|
688
|
-
export type StartJourneyDocumentCurrentAddress = {
|
|
604
|
+
export type StartJourneyAgentAddress = {
|
|
689
605
|
/**
|
|
690
606
|
* Unformatted line based address
|
|
691
607
|
*/
|
|
@@ -695,15 +611,15 @@ export type StartJourneyDocumentCurrentAddress = {
|
|
|
695
611
|
*/
|
|
696
612
|
addressString?: string | undefined;
|
|
697
613
|
/**
|
|
698
|
-
* The
|
|
614
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
699
615
|
*/
|
|
700
616
|
premise?: string | undefined;
|
|
701
617
|
/**
|
|
702
|
-
* The name of
|
|
618
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
703
619
|
*/
|
|
704
620
|
building?: string | undefined;
|
|
705
621
|
/**
|
|
706
|
-
* The
|
|
622
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
707
623
|
*/
|
|
708
624
|
subBuilding?: string | undefined;
|
|
709
625
|
/**
|
|
@@ -742,10 +658,40 @@ export type StartJourneyDocumentCurrentAddress = {
|
|
|
742
658
|
administrativeArea?: string | undefined;
|
|
743
659
|
subAdministrativeArea?: string | undefined;
|
|
744
660
|
organization?: string | undefined;
|
|
745
|
-
location?:
|
|
661
|
+
location?: StartJourneyAgentAddressLocation | undefined;
|
|
746
662
|
};
|
|
747
663
|
|
|
748
|
-
export type
|
|
664
|
+
export type StartJourneyRegistration = {
|
|
665
|
+
jurisdiction?: string | undefined;
|
|
666
|
+
registrationType?: StartJourneyRegistrationType | undefined;
|
|
667
|
+
fileNumber?: string | undefined;
|
|
668
|
+
/**
|
|
669
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
670
|
+
*/
|
|
671
|
+
issueDate?: string | undefined;
|
|
672
|
+
registeredAddress?: StartJourneyRegisteredAddress | undefined;
|
|
673
|
+
agentName?: string | undefined;
|
|
674
|
+
agentAddress?: StartJourneyAgentAddress | undefined;
|
|
675
|
+
};
|
|
676
|
+
|
|
677
|
+
export const StartJourneyTypePrimary2 = {
|
|
678
|
+
Primary: "primary",
|
|
679
|
+
} as const;
|
|
680
|
+
export type StartJourneyTypePrimary2 = ClosedEnum<
|
|
681
|
+
typeof StartJourneyTypePrimary2
|
|
682
|
+
>;
|
|
683
|
+
|
|
684
|
+
export const StartJourneyRole = {
|
|
685
|
+
UltimateBeneficialOwner: "ultimateBeneficialOwner",
|
|
686
|
+
Director: "director",
|
|
687
|
+
Officer: "officer",
|
|
688
|
+
Secretary: "secretary",
|
|
689
|
+
Shareholder: "shareholder",
|
|
690
|
+
Partner: "partner",
|
|
691
|
+
} as const;
|
|
692
|
+
export type StartJourneyRole = ClosedEnum<typeof StartJourneyRole>;
|
|
693
|
+
|
|
694
|
+
export type StartJourneyCurrentAddressLocationPrimary = {
|
|
749
695
|
latitude?: string | undefined;
|
|
750
696
|
longitude?: string | undefined;
|
|
751
697
|
geoAccuracy?: string | undefined;
|
|
@@ -755,7 +701,7 @@ export type StartJourneyDocumentPreviousAddressLocation = {
|
|
|
755
701
|
what3words?: string | undefined;
|
|
756
702
|
};
|
|
757
703
|
|
|
758
|
-
export type
|
|
704
|
+
export type StartJourneyCurrentAddressPrimary = {
|
|
759
705
|
/**
|
|
760
706
|
* Unformatted line based address
|
|
761
707
|
*/
|
|
@@ -765,15 +711,15 @@ export type StartJourneyDocumentPreviousAddress = {
|
|
|
765
711
|
*/
|
|
766
712
|
addressString?: string | undefined;
|
|
767
713
|
/**
|
|
768
|
-
* The
|
|
714
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
769
715
|
*/
|
|
770
716
|
premise?: string | undefined;
|
|
771
717
|
/**
|
|
772
|
-
* The name of
|
|
718
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
773
719
|
*/
|
|
774
720
|
building?: string | undefined;
|
|
775
721
|
/**
|
|
776
|
-
* The
|
|
722
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
777
723
|
*/
|
|
778
724
|
subBuilding?: string | undefined;
|
|
779
725
|
/**
|
|
@@ -812,583 +758,1852 @@ export type StartJourneyDocumentPreviousAddress = {
|
|
|
812
758
|
administrativeArea?: string | undefined;
|
|
813
759
|
subAdministrativeArea?: string | undefined;
|
|
814
760
|
organization?: string | undefined;
|
|
815
|
-
location?:
|
|
816
|
-
/**
|
|
817
|
-
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
818
|
-
*/
|
|
819
|
-
fromDate: string;
|
|
820
|
-
/**
|
|
821
|
-
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
822
|
-
*/
|
|
823
|
-
toDate: string;
|
|
824
|
-
};
|
|
825
|
-
|
|
826
|
-
export type StartJourneyDocumentPlaceOfBirthLocation = {
|
|
827
|
-
latitude?: string | undefined;
|
|
828
|
-
longitude?: string | undefined;
|
|
829
|
-
geoAccuracy?: string | undefined;
|
|
830
|
-
/**
|
|
831
|
-
* A What3words designation associated with this location with '.' separator.
|
|
832
|
-
*/
|
|
833
|
-
what3words?: string | undefined;
|
|
761
|
+
location?: StartJourneyCurrentAddressLocationPrimary | undefined;
|
|
834
762
|
};
|
|
835
763
|
|
|
836
|
-
export type
|
|
764
|
+
export type StartJourneyPerson = {
|
|
837
765
|
/**
|
|
838
|
-
*
|
|
766
|
+
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
839
767
|
*/
|
|
840
|
-
|
|
768
|
+
title?: string | undefined;
|
|
841
769
|
/**
|
|
842
|
-
*
|
|
770
|
+
* A person's name used by their collegues and friends to address them
|
|
843
771
|
*/
|
|
844
|
-
|
|
772
|
+
firstName?: string | undefined;
|
|
845
773
|
/**
|
|
846
|
-
*
|
|
774
|
+
* Any other registered names used by the individual, not aliases
|
|
847
775
|
*/
|
|
848
|
-
|
|
776
|
+
middleNames?: Array<string> | undefined;
|
|
849
777
|
/**
|
|
850
|
-
*
|
|
778
|
+
* Any family names for the individual
|
|
851
779
|
*/
|
|
852
|
-
|
|
780
|
+
lastNames?: Array<string> | undefined;
|
|
853
781
|
/**
|
|
854
|
-
*
|
|
782
|
+
* Any family names for the individual
|
|
855
783
|
*/
|
|
856
|
-
|
|
784
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
785
|
+
id?: string | undefined;
|
|
786
|
+
type?: StartJourneyTypePrimary2 | undefined;
|
|
787
|
+
role?: StartJourneyRole | undefined;
|
|
788
|
+
position?: string | undefined;
|
|
789
|
+
ownershipPercentage?: number | undefined;
|
|
857
790
|
/**
|
|
858
|
-
*
|
|
791
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
859
792
|
*/
|
|
860
|
-
|
|
793
|
+
nationality?: string | undefined;
|
|
794
|
+
dateOfBirth?: string | undefined;
|
|
861
795
|
/**
|
|
862
|
-
*
|
|
796
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
863
797
|
*/
|
|
864
|
-
|
|
798
|
+
startDate?: string | undefined;
|
|
865
799
|
/**
|
|
866
|
-
*
|
|
800
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
867
801
|
*/
|
|
868
|
-
|
|
802
|
+
endDate?: string | undefined;
|
|
803
|
+
currentAddress?: StartJourneyCurrentAddressPrimary | undefined;
|
|
804
|
+
};
|
|
805
|
+
|
|
806
|
+
export type StartJourneyPhonePrimary = {
|
|
869
807
|
/**
|
|
870
|
-
*
|
|
808
|
+
* The type of phone number, such as landline, mobile, fax, unknown etc
|
|
871
809
|
*/
|
|
872
|
-
|
|
810
|
+
type: string;
|
|
873
811
|
/**
|
|
874
|
-
*
|
|
812
|
+
* Phone number, ideally in international format with +(Country Code)
|
|
875
813
|
*/
|
|
876
|
-
|
|
814
|
+
number: string;
|
|
815
|
+
};
|
|
816
|
+
|
|
817
|
+
export type StartJourneyEntity = {
|
|
818
|
+
id?: string | undefined;
|
|
819
|
+
type?: StartJourneyTypePrimary1 | undefined;
|
|
820
|
+
name?: string | undefined;
|
|
821
|
+
aliases?: Array<string> | undefined;
|
|
822
|
+
businessType?: string | undefined;
|
|
823
|
+
status?: StartJourneyStatus | undefined;
|
|
824
|
+
description?: string | undefined;
|
|
825
|
+
addresses?: Array<StartJourneyAddressPrimary> | undefined;
|
|
826
|
+
taxIdentifiers?: Array<StartJourneyTaxIdentifier> | undefined;
|
|
827
|
+
companyNumber?: string | undefined;
|
|
828
|
+
industryClassifications?:
|
|
829
|
+
| Array<StartJourneyIndustryClassification>
|
|
830
|
+
| undefined;
|
|
831
|
+
registrations?: Array<StartJourneyRegistration> | undefined;
|
|
832
|
+
corporateStructure?: string | undefined;
|
|
833
|
+
persons?: Array<StartJourneyPerson> | undefined;
|
|
877
834
|
/**
|
|
878
|
-
*
|
|
835
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
879
836
|
*/
|
|
880
|
-
|
|
837
|
+
incorporationDate?: string | undefined;
|
|
881
838
|
/**
|
|
882
|
-
*
|
|
839
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
883
840
|
*/
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
841
|
+
dissolutionDate?: string | undefined;
|
|
842
|
+
phones?: Array<StartJourneyPhonePrimary> | undefined;
|
|
843
|
+
websites?: Array<string> | undefined;
|
|
844
|
+
headcount?: number | undefined;
|
|
845
|
+
isNonProfit?: boolean | undefined;
|
|
846
|
+
};
|
|
847
|
+
|
|
848
|
+
export type StartJourneyDocumentAddress = {
|
|
849
|
+
addressString?: string | undefined;
|
|
850
|
+
extractedAddressString?: string | undefined;
|
|
851
|
+
addressLine1?: string | undefined;
|
|
852
|
+
addressLine2?: string | undefined;
|
|
853
|
+
locality?: string | undefined;
|
|
890
854
|
administrativeArea?: string | undefined;
|
|
891
|
-
|
|
892
|
-
organization?: string | undefined;
|
|
893
|
-
location?: StartJourneyDocumentPlaceOfBirthLocation | undefined;
|
|
855
|
+
postalCode?: string | undefined;
|
|
894
856
|
};
|
|
895
857
|
|
|
896
|
-
export type
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
idNumber: string;
|
|
905
|
-
/**
|
|
906
|
-
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
907
|
-
*/
|
|
908
|
-
country?: string | undefined;
|
|
858
|
+
export type StartJourneyDocumentDevice = {
|
|
859
|
+
type?: string | undefined;
|
|
860
|
+
model?: string | undefined;
|
|
861
|
+
hasContactlessReader?: boolean | undefined;
|
|
862
|
+
hasMagneticStripeReader?: boolean | undefined;
|
|
863
|
+
hasCamera?: boolean | undefined;
|
|
864
|
+
serialNumber?: string | undefined;
|
|
865
|
+
manufacturer?: string | undefined;
|
|
909
866
|
};
|
|
910
867
|
|
|
911
|
-
export type
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
number: string;
|
|
868
|
+
export type StartJourneySide1Device = {
|
|
869
|
+
type?: string | undefined;
|
|
870
|
+
model?: string | undefined;
|
|
871
|
+
hasContactlessReader?: boolean | undefined;
|
|
872
|
+
hasMagneticStripeReader?: boolean | undefined;
|
|
873
|
+
hasCamera?: boolean | undefined;
|
|
874
|
+
serialNumber?: string | undefined;
|
|
875
|
+
manufacturer?: string | undefined;
|
|
920
876
|
};
|
|
921
877
|
|
|
922
|
-
export type
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
email: string;
|
|
878
|
+
export type StartJourneySide2Device = {
|
|
879
|
+
type?: string | undefined;
|
|
880
|
+
model?: string | undefined;
|
|
881
|
+
hasContactlessReader?: boolean | undefined;
|
|
882
|
+
hasMagneticStripeReader?: boolean | undefined;
|
|
883
|
+
hasCamera?: boolean | undefined;
|
|
884
|
+
serialNumber?: string | undefined;
|
|
885
|
+
manufacturer?: string | undefined;
|
|
931
886
|
};
|
|
932
887
|
|
|
933
|
-
export
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
888
|
+
export const StartJourneyName = {
|
|
889
|
+
Com: "COM",
|
|
890
|
+
Sod: "SOD",
|
|
891
|
+
Dg1: "DG1",
|
|
892
|
+
Dg2: "DG2",
|
|
893
|
+
Dg3: "DG3",
|
|
894
|
+
Dg4: "DG4",
|
|
895
|
+
Dg5: "DG5",
|
|
896
|
+
Dg6: "DG6",
|
|
897
|
+
Dg7: "DG7",
|
|
898
|
+
Dg8: "DG8",
|
|
899
|
+
Dg9: "DG9",
|
|
900
|
+
Dg10: "DG10",
|
|
901
|
+
Dg11: "DG11",
|
|
902
|
+
Dg12: "DG12",
|
|
903
|
+
Dg13: "DG13",
|
|
904
|
+
Dg14: "DG14",
|
|
905
|
+
Dg15: "DG15",
|
|
906
|
+
} as const;
|
|
907
|
+
export type StartJourneyName = ClosedEnum<typeof StartJourneyName>;
|
|
908
|
+
|
|
909
|
+
export type StartJourneyLd = {
|
|
910
|
+
name: StartJourneyName;
|
|
911
|
+
data: string;
|
|
912
|
+
[additionalProperties: string]: unknown;
|
|
942
913
|
};
|
|
943
914
|
|
|
944
|
-
export
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
relatedPersons?: Array<StartJourneyDocumentRelatedPerson> | undefined;
|
|
967
|
-
/**
|
|
968
|
-
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
969
|
-
*/
|
|
970
|
-
dateOfBirth?: string | undefined;
|
|
971
|
-
gender?: string | undefined;
|
|
972
|
-
currentAddress?: StartJourneyDocumentCurrentAddress | undefined;
|
|
973
|
-
previousAddresses?: Array<StartJourneyDocumentPreviousAddress> | undefined;
|
|
974
|
-
placeOfBirth?: StartJourneyDocumentPlaceOfBirth | undefined;
|
|
975
|
-
idNumbers?: Array<StartJourneyDocumentIdNumber> | undefined;
|
|
976
|
-
phones?: Array<StartJourneyDocumentPhone> | undefined;
|
|
977
|
-
emails?: Array<StartJourneyDocumentEmail> | undefined;
|
|
978
|
-
socials?: Array<StartJourneyDocumentSocial> | undefined;
|
|
979
|
-
/**
|
|
980
|
-
* The subject's mother's maiden name, used for identity verification
|
|
981
|
-
*/
|
|
982
|
-
mothersMaidenName?: string | undefined;
|
|
915
|
+
export const StartJourneyAuthType = {
|
|
916
|
+
ActiveAuthentication: "ActiveAuthentication",
|
|
917
|
+
BasicAccessControl: "BasicAccessControl",
|
|
918
|
+
ChipAuthentication: "ChipAuthentication",
|
|
919
|
+
PassiveAuthentication: "PassiveAuthentication",
|
|
920
|
+
SupplementalAccessControl: "SupplementalAccessControl",
|
|
921
|
+
ExtendedAccessControl: "ExtendedAccessControl",
|
|
922
|
+
TerminalAuthentication: "TerminalAuthentication",
|
|
923
|
+
} as const;
|
|
924
|
+
export type StartJourneyAuthType = ClosedEnum<typeof StartJourneyAuthType>;
|
|
925
|
+
|
|
926
|
+
export const StartJourneyResult = {
|
|
927
|
+
Success: "Success",
|
|
928
|
+
Failure: "Failure",
|
|
929
|
+
Skipped: "Skipped",
|
|
930
|
+
} as const;
|
|
931
|
+
export type StartJourneyResult = ClosedEnum<typeof StartJourneyResult>;
|
|
932
|
+
|
|
933
|
+
export type StartJourneyChipAuth = {
|
|
934
|
+
type: StartJourneyAuthType;
|
|
935
|
+
result: StartJourneyResult;
|
|
936
|
+
[additionalProperties: string]: unknown;
|
|
983
937
|
};
|
|
984
938
|
|
|
985
|
-
export type
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
939
|
+
export type StartJourneyChip = {
|
|
940
|
+
lds: Array<StartJourneyLd>;
|
|
941
|
+
auth: Array<StartJourneyChipAuth>;
|
|
942
|
+
[additionalProperties: string]: unknown;
|
|
943
|
+
};
|
|
944
|
+
|
|
945
|
+
export type StartJourneySide = {
|
|
946
|
+
side: string;
|
|
947
|
+
id: string;
|
|
948
|
+
documentQuality: string;
|
|
949
|
+
documentQualityScore: number;
|
|
950
|
+
};
|
|
951
|
+
|
|
952
|
+
export type StartJourneyClassification = {
|
|
953
|
+
ids?: Array<string> | undefined;
|
|
954
|
+
category?: string | undefined;
|
|
955
|
+
type?: string | undefined;
|
|
956
|
+
subtype?: string | undefined;
|
|
957
|
+
isDoubleSided?: boolean | undefined;
|
|
958
|
+
hasNFC?: boolean | undefined;
|
|
959
|
+
year?: string | undefined;
|
|
995
960
|
countryCode?: string | undefined;
|
|
996
961
|
countryName?: string | undefined;
|
|
997
|
-
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
962
|
+
stateCode?: string | undefined;
|
|
963
|
+
stateName?: string | undefined;
|
|
964
|
+
sides?: Array<StartJourneySide> | undefined;
|
|
965
|
+
};
|
|
966
|
+
|
|
967
|
+
export type StartJourneyAggregatedFieldBoundingBox = {
|
|
968
|
+
x: number;
|
|
969
|
+
y: number;
|
|
970
|
+
width: number;
|
|
971
|
+
height: number;
|
|
972
|
+
};
|
|
973
|
+
|
|
974
|
+
export type StartJourneyAggregatedFieldRegionOfInterest = {
|
|
975
|
+
boundingBox?: StartJourneyAggregatedFieldBoundingBox | undefined;
|
|
976
|
+
side: string;
|
|
977
|
+
spectrum?: string | undefined;
|
|
978
|
+
imageId?: string | undefined;
|
|
979
|
+
};
|
|
980
|
+
|
|
981
|
+
export type StartJourneyAggregatedField = {
|
|
982
|
+
label: string;
|
|
983
|
+
value: string;
|
|
984
|
+
source: string;
|
|
985
|
+
isNonLatin: boolean;
|
|
986
|
+
regionOfInterest?: StartJourneyAggregatedFieldRegionOfInterest | undefined;
|
|
987
|
+
};
|
|
988
|
+
|
|
989
|
+
export type StartJourneyDetailBoundingBox = {
|
|
990
|
+
x: number;
|
|
991
|
+
y: number;
|
|
992
|
+
width: number;
|
|
993
|
+
height: number;
|
|
994
|
+
};
|
|
995
|
+
|
|
996
|
+
export type StartJourneyDetailRegionOfInterest = {
|
|
997
|
+
boundingBox?: StartJourneyDetailBoundingBox | undefined;
|
|
998
|
+
side: string;
|
|
999
|
+
spectrum?: string | undefined;
|
|
1000
|
+
imageId?: string | undefined;
|
|
1001
|
+
};
|
|
1002
|
+
|
|
1003
|
+
export type StartJourneyDetail = {
|
|
1004
|
+
label: string;
|
|
1005
|
+
value: string;
|
|
1006
|
+
source: string;
|
|
1007
|
+
isNonLatin: boolean;
|
|
1008
|
+
regionOfInterest?: StartJourneyDetailRegionOfInterest | undefined;
|
|
1009
|
+
};
|
|
1010
|
+
|
|
1011
|
+
export type StartJourneyExtractedField = {
|
|
1012
|
+
label: string;
|
|
1013
|
+
details: Array<StartJourneyDetail>;
|
|
1014
|
+
};
|
|
1015
|
+
|
|
1016
|
+
export type StartJourneyExtractedImage = {
|
|
1017
|
+
label: string;
|
|
1018
|
+
side: string;
|
|
1019
|
+
imageID: string;
|
|
1020
|
+
};
|
|
1021
|
+
|
|
1022
|
+
export type StartJourneyExtraction = {
|
|
1023
|
+
aggregatedFields?: Array<StartJourneyAggregatedField> | undefined;
|
|
1024
|
+
extractedFields?: Array<StartJourneyExtractedField> | undefined;
|
|
1025
|
+
extractedImages?: Array<StartJourneyExtractedImage> | undefined;
|
|
1026
|
+
};
|
|
1027
|
+
|
|
1028
|
+
export type StartJourneyValidationCheckBoundingBox = {
|
|
1029
|
+
x: number;
|
|
1030
|
+
y: number;
|
|
1031
|
+
width: number;
|
|
1032
|
+
height: number;
|
|
1033
|
+
};
|
|
1034
|
+
|
|
1035
|
+
export type StartJourneyValidationCheckRegionOfInterest = {
|
|
1036
|
+
boundingBox?: StartJourneyValidationCheckBoundingBox | undefined;
|
|
1037
|
+
side: string;
|
|
1038
|
+
spectrum?: string | undefined;
|
|
1039
|
+
imageId?: string | undefined;
|
|
1040
|
+
};
|
|
1041
|
+
|
|
1042
|
+
export type StartJourneyValidationCheck = {
|
|
1043
|
+
name: string;
|
|
1044
|
+
title: string;
|
|
1045
|
+
info: string;
|
|
1046
|
+
validationResult: string;
|
|
1047
|
+
resultInfo: string;
|
|
1048
|
+
weight: string;
|
|
1049
|
+
regionOfInterests?:
|
|
1050
|
+
| Array<StartJourneyValidationCheckRegionOfInterest>
|
|
1051
|
+
| undefined;
|
|
1052
|
+
type: string;
|
|
1053
|
+
};
|
|
1054
|
+
|
|
1055
|
+
export type StartJourneyAggregatedValidationCheckBoundingBox = {
|
|
1056
|
+
x: number;
|
|
1057
|
+
y: number;
|
|
1058
|
+
width: number;
|
|
1059
|
+
height: number;
|
|
1060
|
+
};
|
|
1061
|
+
|
|
1062
|
+
export type StartJourneyAggregatedValidationCheckRegionOfInterest = {
|
|
1063
|
+
boundingBox?: StartJourneyAggregatedValidationCheckBoundingBox | undefined;
|
|
1064
|
+
side: string;
|
|
1065
|
+
spectrum?: string | undefined;
|
|
1066
|
+
imageId?: string | undefined;
|
|
1067
|
+
};
|
|
1068
|
+
|
|
1069
|
+
export type StartJourneyAggregatedValidationCheck = {
|
|
1070
|
+
name: string;
|
|
1071
|
+
title: string;
|
|
1072
|
+
info: string;
|
|
1073
|
+
validationResult: string;
|
|
1074
|
+
resultInfo: string;
|
|
1075
|
+
weight: string;
|
|
1076
|
+
regionOfInterests?:
|
|
1077
|
+
| Array<StartJourneyAggregatedValidationCheckRegionOfInterest>
|
|
1078
|
+
| undefined;
|
|
1079
|
+
type: string;
|
|
1080
|
+
};
|
|
1081
|
+
|
|
1082
|
+
export type StartJourneyValidation = {
|
|
1083
|
+
validationChecks?: Array<StartJourneyValidationCheck> | undefined;
|
|
1084
|
+
aggregatedValidationChecks?:
|
|
1085
|
+
| Array<StartJourneyAggregatedValidationCheck>
|
|
1086
|
+
| undefined;
|
|
1087
|
+
};
|
|
1088
|
+
|
|
1089
|
+
export type StartJourneyDocumentAlias = {
|
|
1090
|
+
/**
|
|
1091
|
+
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
1092
|
+
*/
|
|
1093
|
+
title?: string | undefined;
|
|
1094
|
+
/**
|
|
1095
|
+
* A person's name used by their collegues and friends to address them
|
|
1096
|
+
*/
|
|
1097
|
+
firstName?: string | undefined;
|
|
1098
|
+
/**
|
|
1099
|
+
* Any other registered names used by the individual, not aliases
|
|
1100
|
+
*/
|
|
1101
|
+
middleNames?: Array<string> | undefined;
|
|
1102
|
+
/**
|
|
1103
|
+
* Any family names for the individual
|
|
1104
|
+
*/
|
|
1105
|
+
lastNames?: Array<string> | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* Any family names for the individual
|
|
1108
|
+
*/
|
|
1109
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
1110
|
+
/**
|
|
1111
|
+
* The whole name as stated, unsplit into parts — used when the alias has no meaningful name parts
|
|
1112
|
+
*/
|
|
1113
|
+
fullName?: string | undefined;
|
|
1114
|
+
};
|
|
1115
|
+
|
|
1116
|
+
export const StartJourneyDocumentRelationship = {
|
|
1117
|
+
Mother: "mother",
|
|
1118
|
+
Father: "father",
|
|
1119
|
+
Spouse: "spouse",
|
|
1120
|
+
MaternalGrandFather: "maternalGrandFather",
|
|
1121
|
+
MaternalGrandMother: "maternalGrandMother",
|
|
1122
|
+
PaternalGrandFather: "paternalGrandFather",
|
|
1123
|
+
PaternalGrandMother: "paternalGrandMother",
|
|
1124
|
+
} as const;
|
|
1125
|
+
export type StartJourneyDocumentRelationship = ClosedEnum<
|
|
1126
|
+
typeof StartJourneyDocumentRelationship
|
|
1127
|
+
>;
|
|
1128
|
+
|
|
1129
|
+
export type StartJourneyDocumentRelatedPerson = {
|
|
1130
|
+
/**
|
|
1131
|
+
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
1132
|
+
*/
|
|
1133
|
+
title?: string | undefined;
|
|
1134
|
+
/**
|
|
1135
|
+
* A person's name used by their collegues and friends to address them
|
|
1136
|
+
*/
|
|
1137
|
+
firstName?: string | undefined;
|
|
1138
|
+
/**
|
|
1139
|
+
* Any other registered names used by the individual, not aliases
|
|
1140
|
+
*/
|
|
1141
|
+
middleNames?: Array<string> | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* Any family names for the individual
|
|
1144
|
+
*/
|
|
1145
|
+
lastNames?: Array<string> | undefined;
|
|
1146
|
+
/**
|
|
1147
|
+
* Any family names for the individual
|
|
1148
|
+
*/
|
|
1149
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
1150
|
+
relationship: StartJourneyDocumentRelationship;
|
|
1151
|
+
};
|
|
1152
|
+
|
|
1153
|
+
export type StartJourneyDocumentCurrentAddressLocation = {
|
|
1154
|
+
latitude?: string | undefined;
|
|
1155
|
+
longitude?: string | undefined;
|
|
1156
|
+
geoAccuracy?: string | undefined;
|
|
1157
|
+
/**
|
|
1158
|
+
* A What3words designation associated with this location with '.' separator.
|
|
1159
|
+
*/
|
|
1160
|
+
what3words?: string | undefined;
|
|
1161
|
+
};
|
|
1162
|
+
|
|
1163
|
+
export type StartJourneyDocumentCurrentAddress = {
|
|
1164
|
+
/**
|
|
1165
|
+
* Unformatted line based address
|
|
1166
|
+
*/
|
|
1167
|
+
lines?: Array<string> | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* The address as a single line
|
|
1170
|
+
*/
|
|
1171
|
+
addressString?: string | undefined;
|
|
1172
|
+
/**
|
|
1173
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
1174
|
+
*/
|
|
1175
|
+
premise?: string | undefined;
|
|
1176
|
+
/**
|
|
1177
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
1178
|
+
*/
|
|
1179
|
+
building?: string | undefined;
|
|
1180
|
+
/**
|
|
1181
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
1182
|
+
*/
|
|
1183
|
+
subBuilding?: string | undefined;
|
|
1184
|
+
/**
|
|
1185
|
+
* This field holds the most common street or block data element within a country. For instance, USA Street
|
|
1186
|
+
*/
|
|
1187
|
+
thoroughfare?: string | undefined;
|
|
1188
|
+
/**
|
|
1189
|
+
* The name of a dependent street or block, such as a street within a complex.
|
|
1190
|
+
*/
|
|
1191
|
+
dependentThoroughfare?: string | undefined;
|
|
1192
|
+
/**
|
|
1193
|
+
* This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
|
|
1194
|
+
*/
|
|
1195
|
+
locality?: string | undefined;
|
|
1196
|
+
/**
|
|
1197
|
+
* This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
|
|
1198
|
+
*/
|
|
1199
|
+
dependentLocality?: string | undefined;
|
|
1200
|
+
/**
|
|
1201
|
+
* This is an even smaller area within a dependent locality, often used in very detailed addresses.
|
|
1202
|
+
*/
|
|
1203
|
+
doubleDependentLocality?: string | undefined;
|
|
1204
|
+
/**
|
|
1205
|
+
* This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
|
|
1206
|
+
*/
|
|
1207
|
+
postalCode?: string | undefined;
|
|
1208
|
+
/**
|
|
1209
|
+
* This field contains the post box number associated with a particular delivery point, should one exist.
|
|
1210
|
+
*/
|
|
1211
|
+
postBox?: string | undefined;
|
|
1212
|
+
/**
|
|
1213
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1214
|
+
*/
|
|
1215
|
+
country?: string | undefined;
|
|
1216
|
+
superAdministrativeArea?: string | undefined;
|
|
1217
|
+
administrativeArea?: string | undefined;
|
|
1218
|
+
subAdministrativeArea?: string | undefined;
|
|
1219
|
+
organization?: string | undefined;
|
|
1220
|
+
location?: StartJourneyDocumentCurrentAddressLocation | undefined;
|
|
1221
|
+
};
|
|
1222
|
+
|
|
1223
|
+
export type StartJourneyDocumentPreviousAddressLocation = {
|
|
1224
|
+
latitude?: string | undefined;
|
|
1225
|
+
longitude?: string | undefined;
|
|
1226
|
+
geoAccuracy?: string | undefined;
|
|
1227
|
+
/**
|
|
1228
|
+
* A What3words designation associated with this location with '.' separator.
|
|
1229
|
+
*/
|
|
1230
|
+
what3words?: string | undefined;
|
|
1231
|
+
};
|
|
1232
|
+
|
|
1233
|
+
export type StartJourneyDocumentPreviousAddress = {
|
|
1234
|
+
/**
|
|
1235
|
+
* Unformatted line based address
|
|
1236
|
+
*/
|
|
1237
|
+
lines?: Array<string> | undefined;
|
|
1238
|
+
/**
|
|
1239
|
+
* The address as a single line
|
|
1240
|
+
*/
|
|
1241
|
+
addressString?: string | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
1244
|
+
*/
|
|
1245
|
+
premise?: string | undefined;
|
|
1246
|
+
/**
|
|
1247
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
1248
|
+
*/
|
|
1249
|
+
building?: string | undefined;
|
|
1250
|
+
/**
|
|
1251
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
1252
|
+
*/
|
|
1253
|
+
subBuilding?: string | undefined;
|
|
1254
|
+
/**
|
|
1255
|
+
* This field holds the most common street or block data element within a country. For instance, USA Street
|
|
1256
|
+
*/
|
|
1257
|
+
thoroughfare?: string | undefined;
|
|
1258
|
+
/**
|
|
1259
|
+
* The name of a dependent street or block, such as a street within a complex.
|
|
1260
|
+
*/
|
|
1261
|
+
dependentThoroughfare?: string | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
|
|
1264
|
+
*/
|
|
1265
|
+
locality?: string | undefined;
|
|
1266
|
+
/**
|
|
1267
|
+
* This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
|
|
1268
|
+
*/
|
|
1269
|
+
dependentLocality?: string | undefined;
|
|
1270
|
+
/**
|
|
1271
|
+
* This is an even smaller area within a dependent locality, often used in very detailed addresses.
|
|
1272
|
+
*/
|
|
1273
|
+
doubleDependentLocality?: string | undefined;
|
|
1274
|
+
/**
|
|
1275
|
+
* This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
|
|
1276
|
+
*/
|
|
1277
|
+
postalCode?: string | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* This field contains the post box number associated with a particular delivery point, should one exist.
|
|
1280
|
+
*/
|
|
1281
|
+
postBox?: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1284
|
+
*/
|
|
1285
|
+
country?: string | undefined;
|
|
1286
|
+
superAdministrativeArea?: string | undefined;
|
|
1287
|
+
administrativeArea?: string | undefined;
|
|
1288
|
+
subAdministrativeArea?: string | undefined;
|
|
1289
|
+
organization?: string | undefined;
|
|
1290
|
+
location?: StartJourneyDocumentPreviousAddressLocation | undefined;
|
|
1291
|
+
/**
|
|
1292
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1293
|
+
*/
|
|
1294
|
+
fromDate?: string | undefined;
|
|
1295
|
+
/**
|
|
1296
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1297
|
+
*/
|
|
1298
|
+
toDate?: string | undefined;
|
|
1299
|
+
};
|
|
1300
|
+
|
|
1301
|
+
export type StartJourneyDocumentPlaceOfBirthLocation = {
|
|
1302
|
+
latitude?: string | undefined;
|
|
1303
|
+
longitude?: string | undefined;
|
|
1304
|
+
geoAccuracy?: string | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* A What3words designation associated with this location with '.' separator.
|
|
1307
|
+
*/
|
|
1308
|
+
what3words?: string | undefined;
|
|
1309
|
+
};
|
|
1310
|
+
|
|
1311
|
+
export type StartJourneyDocumentPlaceOfBirth = {
|
|
1312
|
+
/**
|
|
1313
|
+
* Unformatted line based address
|
|
1314
|
+
*/
|
|
1315
|
+
lines?: Array<string> | undefined;
|
|
1316
|
+
/**
|
|
1317
|
+
* The address as a single line
|
|
1318
|
+
*/
|
|
1319
|
+
addressString?: string | undefined;
|
|
1320
|
+
/**
|
|
1321
|
+
* The number identifying the property's delivery point on its street — "128", "30A", "8-12". Not the street name (thoroughfare), the unit (subBuilding), or a building or property name (building). Empty for a property identified only by a name.
|
|
1322
|
+
*/
|
|
1323
|
+
premise?: string | undefined;
|
|
1324
|
+
/**
|
|
1325
|
+
* The name of the building, complex, or named property — "Landmark House", "The Shard". Never the street number, in any country; that is premise. A property identified only by a name populates this field with premise left empty.
|
|
1326
|
+
*/
|
|
1327
|
+
building?: string | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* The unit within the property, such as a flat, apartment or suite number — "FLAT 1", "SUITE 212".
|
|
1330
|
+
*/
|
|
1331
|
+
subBuilding?: string | undefined;
|
|
1332
|
+
/**
|
|
1333
|
+
* This field holds the most common street or block data element within a country. For instance, USA Street
|
|
1334
|
+
*/
|
|
1335
|
+
thoroughfare?: string | undefined;
|
|
1336
|
+
/**
|
|
1337
|
+
* The name of a dependent street or block, such as a street within a complex.
|
|
1338
|
+
*/
|
|
1339
|
+
dependentThoroughfare?: string | undefined;
|
|
1340
|
+
/**
|
|
1341
|
+
* This field holds the most common population center data element within a country. For instance, USA City, Canadian Municipality
|
|
1342
|
+
*/
|
|
1343
|
+
locality?: string | undefined;
|
|
1344
|
+
/**
|
|
1345
|
+
* This is a smaller area within a locality, such as a neighborhood or district. Like Manhattan in New York City, or Soho in London.
|
|
1346
|
+
*/
|
|
1347
|
+
dependentLocality?: string | undefined;
|
|
1348
|
+
/**
|
|
1349
|
+
* This is an even smaller area within a dependent locality, often used in very detailed addresses.
|
|
1350
|
+
*/
|
|
1351
|
+
doubleDependentLocality?: string | undefined;
|
|
1352
|
+
/**
|
|
1353
|
+
* This field contains the complete postal code for a particular delivery point, should such detail be able to be determined. For example ZIP code in the US
|
|
1354
|
+
*/
|
|
1355
|
+
postalCode?: string | undefined;
|
|
1356
|
+
/**
|
|
1357
|
+
* This field contains the post box number associated with a particular delivery point, should one exist.
|
|
1358
|
+
*/
|
|
1359
|
+
postBox?: string | undefined;
|
|
1360
|
+
/**
|
|
1361
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1362
|
+
*/
|
|
1363
|
+
country?: string | undefined;
|
|
1364
|
+
superAdministrativeArea?: string | undefined;
|
|
1365
|
+
administrativeArea?: string | undefined;
|
|
1366
|
+
subAdministrativeArea?: string | undefined;
|
|
1367
|
+
organization?: string | undefined;
|
|
1368
|
+
location?: StartJourneyDocumentPlaceOfBirthLocation | undefined;
|
|
1369
|
+
};
|
|
1370
|
+
|
|
1371
|
+
export type StartJourneyDocumentIdNumber = {
|
|
1372
|
+
/**
|
|
1373
|
+
* The type of phone number, such as landline, mobile, fax, unknown etc
|
|
1374
|
+
*/
|
|
1375
|
+
type: string;
|
|
1376
|
+
/**
|
|
1377
|
+
* ID number eg, National Insurance Number in UK, Social Securtiy Number in US
|
|
1378
|
+
*/
|
|
1379
|
+
idNumber: string;
|
|
1380
|
+
/**
|
|
1381
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1382
|
+
*/
|
|
1383
|
+
country?: string | undefined;
|
|
1384
|
+
};
|
|
1385
|
+
|
|
1386
|
+
export type StartJourneyDocumentPhone = {
|
|
1387
|
+
/**
|
|
1388
|
+
* The type of phone number, such as landline, mobile, fax, unknown etc
|
|
1389
|
+
*/
|
|
1390
|
+
type: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* Phone number, ideally in international format with +(Country Code)
|
|
1393
|
+
*/
|
|
1394
|
+
number: string;
|
|
1395
|
+
};
|
|
1396
|
+
|
|
1397
|
+
export type StartJourneyDocumentEmail = {
|
|
1398
|
+
/**
|
|
1399
|
+
* Email type discriminator. Canonical values: 'personal', 'work', 'home', 'other'. Three map to a domain element by exact match: 'personal' -> PersonalEmail, 'work' -> WorkEmail, 'other' -> OtherEmails (the domainElementId used to collect them). 'home' is the only canonical value with no domain element: a 'home' email is accepted and stored but cannot be retrieved through any v2 read (it matches no getter); use 'personal', 'work' or 'other' to have the email surfaced. Legacy inputs normalize at the API boundary (e.g. 'email' -> 'personal').
|
|
1400
|
+
*/
|
|
1401
|
+
type: string;
|
|
1402
|
+
/**
|
|
1403
|
+
* Email address
|
|
1404
|
+
*/
|
|
1405
|
+
email: string;
|
|
1406
|
+
};
|
|
1407
|
+
|
|
1408
|
+
export type StartJourneyDocumentSocial = {
|
|
1409
|
+
/**
|
|
1410
|
+
* An agreed standardised name for the social media platform this identity relates to such as Facebook, Twitter, unknown etc
|
|
1411
|
+
*/
|
|
1412
|
+
type: string;
|
|
1413
|
+
/**
|
|
1414
|
+
* the identity used on this platform
|
|
1415
|
+
*/
|
|
1416
|
+
identity: string;
|
|
1417
|
+
};
|
|
1418
|
+
|
|
1419
|
+
export type StartJourneyDocumentSubject = {
|
|
1420
|
+
/**
|
|
1421
|
+
* Title of an individual such as Mr, Mrs, Dr, Sir
|
|
1422
|
+
*/
|
|
1423
|
+
title?: string | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* A person's name used by their collegues and friends to address them
|
|
1426
|
+
*/
|
|
1427
|
+
firstName?: string | undefined;
|
|
1428
|
+
/**
|
|
1429
|
+
* Any other registered names used by the individual, not aliases
|
|
1430
|
+
*/
|
|
1431
|
+
middleNames?: Array<string> | undefined;
|
|
1432
|
+
/**
|
|
1433
|
+
* Any family names for the individual
|
|
1434
|
+
*/
|
|
1435
|
+
lastNames?: Array<string> | undefined;
|
|
1436
|
+
/**
|
|
1437
|
+
* Any family names for the individual
|
|
1438
|
+
*/
|
|
1439
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
1440
|
+
/**
|
|
1441
|
+
* Names the subject is otherwise or was previously known by — applicant-declared, unordered, duplicates permitted
|
|
1442
|
+
*/
|
|
1443
|
+
aliases?: Array<StartJourneyDocumentAlias> | undefined;
|
|
1444
|
+
relatedPersons?: Array<StartJourneyDocumentRelatedPerson> | undefined;
|
|
1445
|
+
/**
|
|
1446
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1447
|
+
*/
|
|
1448
|
+
dateOfBirth?: string | undefined;
|
|
1449
|
+
gender?: string | undefined;
|
|
1450
|
+
currentAddress?: StartJourneyDocumentCurrentAddress | undefined;
|
|
1451
|
+
previousAddresses?: Array<StartJourneyDocumentPreviousAddress> | undefined;
|
|
1452
|
+
placeOfBirth?: StartJourneyDocumentPlaceOfBirth | undefined;
|
|
1453
|
+
idNumbers?: Array<StartJourneyDocumentIdNumber> | undefined;
|
|
1454
|
+
phones?: Array<StartJourneyDocumentPhone> | undefined;
|
|
1455
|
+
emails?: Array<StartJourneyDocumentEmail> | undefined;
|
|
1456
|
+
socials?: Array<StartJourneyDocumentSocial> | undefined;
|
|
1457
|
+
/**
|
|
1458
|
+
* The subject's mother's maiden name, used for identity verification
|
|
1459
|
+
*/
|
|
1460
|
+
mothersMaidenName?: string | undefined;
|
|
1461
|
+
/**
|
|
1462
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1463
|
+
*/
|
|
1464
|
+
nationality?: string | undefined;
|
|
1465
|
+
};
|
|
1466
|
+
|
|
1467
|
+
export type StartJourneyDocument = {
|
|
1468
|
+
oneDBarcode?: string | undefined;
|
|
1469
|
+
address?: StartJourneyDocumentAddress | undefined;
|
|
1470
|
+
applicationDate?: string | undefined;
|
|
1471
|
+
applicationNumber?: string | undefined;
|
|
1472
|
+
dateOfBirth?: string | undefined;
|
|
1473
|
+
placeOfBirth?: string | undefined;
|
|
1474
|
+
placeOfBirthNative?: string | undefined;
|
|
1475
|
+
bloodType?: string | undefined;
|
|
1476
|
+
controlNumber?: string | undefined;
|
|
1477
|
+
countryCode?: string | undefined;
|
|
1478
|
+
countryName?: string | undefined;
|
|
1479
|
+
documentClassCode?: string | undefined;
|
|
1480
|
+
documentClassName?: string | undefined;
|
|
1481
|
+
documentNumber?: string | undefined;
|
|
1482
|
+
documentSignerCertificate?: string | undefined;
|
|
1483
|
+
employer?: string | undefined;
|
|
1484
|
+
employerAddress?: string | undefined;
|
|
1485
|
+
entries?: string | undefined;
|
|
1486
|
+
expirationDate?: string | undefined;
|
|
1487
|
+
eyeColor?: string | undefined;
|
|
1488
|
+
fathersName?: string | undefined;
|
|
1489
|
+
fathersNameNative?: string | undefined;
|
|
1490
|
+
fathersSurname?: string | undefined;
|
|
1491
|
+
firstName?: string | undefined;
|
|
1492
|
+
fullName?: string | undefined;
|
|
1493
|
+
fullNameNative?: string | undefined;
|
|
1494
|
+
givenName?: string | undefined;
|
|
1495
|
+
givenNameNative?: string | undefined;
|
|
1496
|
+
hairColor?: string | undefined;
|
|
1497
|
+
height?: string | undefined;
|
|
1498
|
+
/**
|
|
1499
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1500
|
+
*/
|
|
1501
|
+
issueDate?: string | undefined;
|
|
1502
|
+
issuingAuthority?: string | undefined;
|
|
1503
|
+
issuingAuthorityNative?: string | undefined;
|
|
1504
|
+
issuingStateCode?: string | undefined;
|
|
1505
|
+
issuingStateName?: string | undefined;
|
|
1506
|
+
licenseClass?: string | undefined;
|
|
1507
|
+
licenseEndorsements?: string | undefined;
|
|
1508
|
+
licenseRestrictions?: string | undefined;
|
|
1509
|
+
mrz?: string | undefined;
|
|
1510
|
+
mrz1?: string | undefined;
|
|
1511
|
+
mrz2?: string | undefined;
|
|
1512
|
+
mrz3?: string | undefined;
|
|
1513
|
+
middleName?: string | undefined;
|
|
1514
|
+
mothersName?: string | undefined;
|
|
1515
|
+
mothersNameNative?: string | undefined;
|
|
1516
|
+
mothersSurname?: string | undefined;
|
|
1517
|
+
nameSuffix?: string | undefined;
|
|
1518
|
+
nationalityCode?: string | undefined;
|
|
1519
|
+
nationalityName?: string | undefined;
|
|
1520
|
+
nationalityNameNative?: string | undefined;
|
|
1521
|
+
occupation?: string | undefined;
|
|
1522
|
+
organDonor?: boolean | undefined;
|
|
1523
|
+
passportNumber?: string | undefined;
|
|
1524
|
+
permitNumber?: string | undefined;
|
|
1525
|
+
personalNumber?: string | undefined;
|
|
1526
|
+
photo?: string | undefined;
|
|
1527
|
+
photoCompressed?: string | undefined;
|
|
1528
|
+
photoEncoding?: string | undefined;
|
|
1529
|
+
sex?: string | undefined;
|
|
1530
|
+
sexNative?: string | undefined;
|
|
1531
|
+
signature?: string | undefined;
|
|
1532
|
+
signatureCompressed?: string | undefined;
|
|
1533
|
+
signatureEncoding?: string | undefined;
|
|
1534
|
+
socialSecurityNumber?: string | undefined;
|
|
1535
|
+
startDate?: string | undefined;
|
|
1536
|
+
surname?: string | undefined;
|
|
1537
|
+
surnameNative?: string | undefined;
|
|
1538
|
+
visaClass?: string | undefined;
|
|
1539
|
+
visaNumber?: string | undefined;
|
|
1540
|
+
weight?: string | undefined;
|
|
1541
|
+
cardNumber?: string | undefined;
|
|
1542
|
+
/**
|
|
1543
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1544
|
+
*/
|
|
1545
|
+
issuerCountryCode?: string | undefined;
|
|
1546
|
+
id?: string | undefined;
|
|
1547
|
+
type: string;
|
|
1548
|
+
category?: string | undefined;
|
|
1549
|
+
subtype?: string | undefined;
|
|
1550
|
+
format?: string | undefined;
|
|
1551
|
+
device?: StartJourneyDocumentDevice | undefined;
|
|
1552
|
+
side1Image?: string | undefined;
|
|
1553
|
+
side2Image?: string | undefined;
|
|
1554
|
+
side1Device?: StartJourneySide1Device | undefined;
|
|
1555
|
+
side2Device?: StartJourneySide2Device | undefined;
|
|
1556
|
+
chip?: StartJourneyChip | undefined;
|
|
1557
|
+
classification?: StartJourneyClassification | undefined;
|
|
1558
|
+
extraction?: StartJourneyExtraction | undefined;
|
|
1559
|
+
validation?: StartJourneyValidation | undefined;
|
|
1560
|
+
subType?: string | undefined;
|
|
1561
|
+
number?: string | undefined;
|
|
1562
|
+
/**
|
|
1563
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1564
|
+
*/
|
|
1565
|
+
expiryDate?: string | undefined;
|
|
1566
|
+
cardType?: string | undefined;
|
|
1567
|
+
/**
|
|
1568
|
+
* Year and month in ISO 8601 format: YYYY-MM
|
|
1569
|
+
*/
|
|
1570
|
+
expiryMonth?: string | undefined;
|
|
1571
|
+
cardColour?: string | undefined;
|
|
1572
|
+
cardStatus?: string | undefined;
|
|
1573
|
+
subject?: StartJourneyDocumentSubject | undefined;
|
|
1574
|
+
/**
|
|
1575
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1576
|
+
*/
|
|
1577
|
+
country?: string | undefined;
|
|
1578
|
+
certificateFormat?: string | undefined;
|
|
1579
|
+
registrationNumber?: string | undefined;
|
|
1580
|
+
/**
|
|
1581
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1582
|
+
*/
|
|
1583
|
+
registrationDate?: string | undefined;
|
|
1584
|
+
/**
|
|
1585
|
+
* Four-digit calendar year in ISO 8601 format: YYYY
|
|
1586
|
+
*/
|
|
1587
|
+
registrationYear?: string | undefined;
|
|
1588
|
+
partyRole?: string | undefined;
|
|
1589
|
+
/**
|
|
1590
|
+
* Specified in year, month and day separated by -. For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
|
|
1591
|
+
*/
|
|
1592
|
+
dateOfEvent?: string | undefined;
|
|
1593
|
+
previousFirstName?: string | undefined;
|
|
1594
|
+
previousMiddleName?: string | undefined;
|
|
1595
|
+
previousSurname?: string | undefined;
|
|
1596
|
+
individualReferenceNumber?: string | undefined;
|
|
1597
|
+
nameLine1?: string | undefined;
|
|
1598
|
+
nameLine2?: string | undefined;
|
|
1599
|
+
nameLine3?: string | undefined;
|
|
1600
|
+
nameLine4?: string | undefined;
|
|
1601
|
+
};
|
|
1602
|
+
|
|
1603
|
+
export const StartJourneyBiometricType = {
|
|
1604
|
+
StoredFace: "storedFace",
|
|
1605
|
+
} as const;
|
|
1606
|
+
export type StartJourneyBiometricType = ClosedEnum<
|
|
1607
|
+
typeof StartJourneyBiometricType
|
|
1608
|
+
>;
|
|
1609
|
+
|
|
1610
|
+
export type StartJourneyBiometricStoredFace = {
|
|
1611
|
+
id?: string | undefined;
|
|
1612
|
+
type: StartJourneyBiometricType;
|
|
1613
|
+
templateReference: string;
|
|
1614
|
+
};
|
|
1615
|
+
|
|
1616
|
+
export type StartJourneyBiometric5 = {
|
|
1617
|
+
id?: string | undefined;
|
|
1618
|
+
type?: string | undefined;
|
|
1619
|
+
anchorImage: string;
|
|
1620
|
+
};
|
|
1621
|
+
|
|
1622
|
+
export type StartJourneyBiometric4 = {
|
|
1623
|
+
id?: string | undefined;
|
|
1624
|
+
type?: string | undefined;
|
|
1625
|
+
selfieImage: string;
|
|
1626
|
+
selfieImageEncryption?: boolean | undefined;
|
|
1627
|
+
};
|
|
1628
|
+
|
|
1629
|
+
export type StartJourneyBiometric3 = {
|
|
1630
|
+
id?: string | undefined;
|
|
1631
|
+
type?: string | undefined;
|
|
1632
|
+
faceImage: string;
|
|
1633
|
+
};
|
|
1634
|
+
|
|
1635
|
+
export type StartJourneyBiometric2 = {
|
|
1636
|
+
id?: string | undefined;
|
|
1637
|
+
type?: string | undefined;
|
|
1638
|
+
selfieImage: string;
|
|
1639
|
+
anchorImage: string;
|
|
1640
|
+
};
|
|
1641
|
+
|
|
1642
|
+
export type StartJourneyBiometric1 = {
|
|
1643
|
+
id?: string | undefined;
|
|
1644
|
+
type?: string | undefined;
|
|
1645
|
+
face1Image: string;
|
|
1646
|
+
face2Image: string;
|
|
1647
|
+
};
|
|
1648
|
+
|
|
1649
|
+
export type StartJourneyBiometricUnion =
|
|
1650
|
+
| StartJourneyBiometric1
|
|
1651
|
+
| StartJourneyBiometric2
|
|
1652
|
+
| StartJourneyBiometricStoredFace
|
|
1653
|
+
| StartJourneyBiometric3
|
|
1654
|
+
| StartJourneyBiometric4
|
|
1655
|
+
| StartJourneyBiometric5;
|
|
1656
|
+
|
|
1657
|
+
export type StartJourneyUser = {
|
|
1658
|
+
id: string;
|
|
1659
|
+
email?: string | undefined;
|
|
1660
|
+
domain?: string | undefined;
|
|
1661
|
+
};
|
|
1662
|
+
|
|
1663
|
+
export type StartJourneyClient = {
|
|
1664
|
+
id: string;
|
|
1665
|
+
ip: string;
|
|
1666
|
+
address: string;
|
|
1667
|
+
};
|
|
1668
|
+
|
|
1669
|
+
export type StartJourneyModel = {
|
|
1670
|
+
identifier: string;
|
|
1671
|
+
name: string;
|
|
1672
|
+
};
|
|
1673
|
+
|
|
1674
|
+
export type StartJourneySessionDevice = {
|
|
1675
|
+
id: string;
|
|
1676
|
+
manufacturer: string;
|
|
1677
|
+
model: StartJourneyModel;
|
|
1678
|
+
};
|
|
1679
|
+
|
|
1680
|
+
export type StartJourneyTrace = {
|
|
1681
|
+
id: string;
|
|
1682
|
+
};
|
|
1683
|
+
|
|
1684
|
+
export type StartJourneySpan = {
|
|
1685
|
+
id: string;
|
|
1686
|
+
};
|
|
1687
|
+
|
|
1688
|
+
export type StartJourneyTransaction = {
|
|
1689
|
+
id: string;
|
|
1690
|
+
};
|
|
1691
|
+
|
|
1692
|
+
export type StartJourneySessionAuth = {
|
|
1693
|
+
id: string;
|
|
1694
|
+
scope?: string | undefined;
|
|
1695
|
+
codeVerifier?: string | undefined;
|
|
1696
|
+
code?: string | undefined;
|
|
1697
|
+
state?: string | undefined;
|
|
1698
|
+
redirectUri?: string | undefined;
|
|
1699
|
+
responseType?: string | undefined;
|
|
1700
|
+
clientId?: string | undefined;
|
|
1701
|
+
clientSecret?: string | undefined;
|
|
1702
|
+
};
|
|
1703
|
+
|
|
1704
|
+
export type StartJourneySession = {
|
|
1705
|
+
id?: string | undefined;
|
|
1706
|
+
type?: string | undefined;
|
|
1707
|
+
provider?: string | undefined;
|
|
1708
|
+
user?: StartJourneyUser | undefined;
|
|
1709
|
+
client?: StartJourneyClient | undefined;
|
|
1710
|
+
device?: StartJourneySessionDevice | undefined;
|
|
1711
|
+
trace?: StartJourneyTrace | undefined;
|
|
1712
|
+
span?: StartJourneySpan | undefined;
|
|
1713
|
+
transaction?: StartJourneyTransaction | undefined;
|
|
1714
|
+
auth?: Array<StartJourneySessionAuth> | undefined;
|
|
1715
|
+
};
|
|
1716
|
+
|
|
1717
|
+
export const StartJourneyConsentType = {
|
|
1718
|
+
Rollup: "rollup",
|
|
1719
|
+
Explicit: "explicit",
|
|
1720
|
+
Implicit: "implicit",
|
|
1721
|
+
} as const;
|
|
1722
|
+
export type StartJourneyConsentType = ClosedEnum<
|
|
1723
|
+
typeof StartJourneyConsentType
|
|
1724
|
+
>;
|
|
1725
|
+
|
|
1726
|
+
export type StartJourneyConsent = {
|
|
1727
|
+
type?: StartJourneyConsentType | undefined;
|
|
1728
|
+
id?: string | undefined;
|
|
1729
|
+
version?: string | undefined;
|
|
1730
|
+
url: string;
|
|
1731
|
+
effectiveDate?: string | undefined;
|
|
1732
|
+
expiryDate?: string | undefined;
|
|
1733
|
+
terms?: string | undefined;
|
|
1734
|
+
purpose?: string | undefined;
|
|
1735
|
+
legalBasis?: string | undefined;
|
|
1736
|
+
jurisdiction?: string | undefined;
|
|
1737
|
+
subject?: string | undefined;
|
|
1738
|
+
signatory?: string | undefined;
|
|
1739
|
+
};
|
|
1740
|
+
|
|
1741
|
+
export type StartJourneyAccount = {
|
|
1742
|
+
/**
|
|
1743
|
+
* The type of account (canonical camelCase, e.g. "bankAccount"). Legacy value "Bank Account" is still read but new writes emit the canonical form.
|
|
1744
|
+
*/
|
|
1745
|
+
type: string;
|
|
1746
|
+
/**
|
|
1747
|
+
* Account number
|
|
1748
|
+
*/
|
|
1749
|
+
accountNumber: string;
|
|
1750
|
+
/**
|
|
1751
|
+
* UK sort code
|
|
1752
|
+
*/
|
|
1753
|
+
sortCode?: string | undefined;
|
|
1754
|
+
/**
|
|
1755
|
+
* US ABA routing number
|
|
1756
|
+
*/
|
|
1757
|
+
routingNumber?: string | undefined;
|
|
1758
|
+
/**
|
|
1759
|
+
* International Bank Account Number
|
|
1760
|
+
*/
|
|
1761
|
+
iban?: string | undefined;
|
|
1762
|
+
/**
|
|
1763
|
+
* BIC/SWIFT code
|
|
1764
|
+
*/
|
|
1765
|
+
bic?: string | undefined;
|
|
1766
|
+
/**
|
|
1767
|
+
* Name on the account
|
|
1768
|
+
*/
|
|
1769
|
+
accountHolderName?: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* Name of the financial institution
|
|
1772
|
+
*/
|
|
1773
|
+
bankName?: string | undefined;
|
|
1774
|
+
/**
|
|
1775
|
+
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1776
|
+
*/
|
|
1777
|
+
country?: string | undefined;
|
|
1778
|
+
/**
|
|
1779
|
+
* Account classification, e.g. current, savings
|
|
1780
|
+
*/
|
|
1781
|
+
accountType?: string | undefined;
|
|
1782
|
+
};
|
|
1783
|
+
|
|
1784
|
+
export type StartJourneyChoice = {
|
|
1785
|
+
label: string;
|
|
1786
|
+
text: string;
|
|
1787
|
+
};
|
|
1788
|
+
|
|
1789
|
+
export type StartJourneyQuestion = {
|
|
1790
|
+
id: number;
|
|
1791
|
+
questionText: string;
|
|
1792
|
+
helpText?: string | undefined;
|
|
1793
|
+
choices: Array<StartJourneyChoice>;
|
|
1794
|
+
};
|
|
1795
|
+
|
|
1796
|
+
export type StartJourneyAnswer = {
|
|
1797
|
+
id: number;
|
|
1798
|
+
choices: Array<string>;
|
|
1799
|
+
};
|
|
1800
|
+
|
|
1801
|
+
export type StartJourneyKba = {
|
|
1802
|
+
questions: Array<StartJourneyQuestion>;
|
|
1803
|
+
answers: Array<StartJourneyAnswer>;
|
|
1804
|
+
};
|
|
1805
|
+
|
|
1806
|
+
export type StartJourneySubject = {
|
|
1807
|
+
identity?: StartJourneyIdentity | undefined;
|
|
1808
|
+
entities?: Array<StartJourneyEntity> | undefined;
|
|
1809
|
+
documents?: Array<StartJourneyDocument> | undefined;
|
|
1810
|
+
biometrics?:
|
|
1811
|
+
| Array<
|
|
1812
|
+
| StartJourneyBiometric1
|
|
1813
|
+
| StartJourneyBiometric2
|
|
1814
|
+
| StartJourneyBiometricStoredFace
|
|
1815
|
+
| StartJourneyBiometric3
|
|
1816
|
+
| StartJourneyBiometric4
|
|
1817
|
+
| StartJourneyBiometric5
|
|
1818
|
+
>
|
|
1819
|
+
| undefined;
|
|
1820
|
+
sessions?: Array<StartJourneySession> | undefined;
|
|
1821
|
+
consent?: Array<StartJourneyConsent> | undefined;
|
|
1822
|
+
accounts?: Array<StartJourneyAccount> | undefined;
|
|
1823
|
+
kba?: StartJourneyKba | undefined;
|
|
1824
|
+
uid?: string | undefined;
|
|
1825
|
+
};
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
|
|
1829
|
+
*/
|
|
1830
|
+
export const ResumeMode = {
|
|
1831
|
+
Off: "off",
|
|
1832
|
+
Resume: "resume",
|
|
1833
|
+
} as const;
|
|
1834
|
+
/**
|
|
1835
|
+
* How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
|
|
1836
|
+
*/
|
|
1837
|
+
export type ResumeMode = ClosedEnum<typeof ResumeMode>;
|
|
1838
|
+
|
|
1839
|
+
/**
|
|
1840
|
+
* Per-journey link lifetime and resume behavior. Every member is optional, and each is resolved independently across the per-journey, delivery, organization and system-default tiers, then clamped down to the operator bounds. All three members reach runtime behavior: ttlMinutes bounds how long the link stays startable, and the resolved resumeMode and resumeExpiryMinutes are frozen onto the delivery-token and connect-secret records, read at connect, and enforced when a resume credential is minted and exchanged. None of the resolved values is echoed on any response — the journey-start log line is where the resolved mode, its tier and any clamp are reported. An absent ttlMinutes falls back to the delivery resource's linkConfig, then to the organization's value, then to the deprecated flat deliveryUrlTtlMinutes, then to the system default.
|
|
1841
|
+
*/
|
|
1842
|
+
export type LinkConfig = {
|
|
1843
|
+
/**
|
|
1844
|
+
* Lifetime of the delivery link in minutes: the deadline for STARTING a journey, governing the connect secret and therefore how long an unopened link stays usable. It no longer bounds how long an applicant may come BACK — that is resumeExpiryMinutes, which is anchored at first connect and may outlast this. Replaces the deprecated flat deliveryUrlTtlMinutes. Bounded by the operator ceiling at runtime, not here: a value above the ceiling is clamped down to it. A shorter lifetime is always honored exactly as supplied — there is no lower bound, and nothing lengthens a link beyond what was requested.
|
|
1845
|
+
*/
|
|
1846
|
+
ttlMinutes?: number | undefined;
|
|
1847
|
+
/**
|
|
1848
|
+
* How resume behaves for this delivery: off (no credential minted — pre-resume behavior) or resume (the applicant may return until an absolute deadline). There is no park setting and no park behavior; what park expressed is the window resume already grants. resume uses resumeExpiryMinutes and off uses no lifetime member at all — supplying one under off is rejected. An operator bound can only cap this DOWN, never raise it.
|
|
1849
|
+
*/
|
|
1850
|
+
resumeMode?: ResumeMode | undefined;
|
|
1851
|
+
/**
|
|
1852
|
+
* Resume-credential lifetime in minutes, ABSOLUTE from the applicant first connecting — not from link issue, and not sliding from last use. Nothing renews it: returning many times neither extends nor shortens it. Valid only when resumeMode is resume; supplying it alongside off is rejected. Clamped downward only. It may fall AFTER the link expires, which is deliberate — the link bounds starting, this bounds coming back. Because nothing renews it, a small value is a total journey budget rather than an idle timeout, and will cut off an applicant who never stopped working.
|
|
1853
|
+
*/
|
|
1854
|
+
resumeExpiryMinutes?: number | undefined;
|
|
1855
|
+
};
|
|
1856
|
+
|
|
1857
|
+
/**
|
|
1858
|
+
* Selects which revision of this organisation configuration overlay this execution runs against. It participates in the delivery cache key, so naming a version guarantees the start is served a graph built from that exact overlay instead of a cached one. Omitting it is a no-op: the latest overlay applies and the request behaves as it did before this member existed.
|
|
1859
|
+
*/
|
|
1860
|
+
export type Overlay = {
|
|
1060
1861
|
/**
|
|
1061
|
-
*
|
|
1862
|
+
* The overlay revision to apply for this execution. Supply the version returned when the overlay was saved to have the change take effect on this start rather than after the delivery cache expires. Omit it to run the latest overlay, which is the behavior when this member is absent.
|
|
1062
1863
|
*/
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
device?: StartJourneyDocumentDevice | undefined;
|
|
1070
|
-
side1Image?: string | undefined;
|
|
1071
|
-
side2Image?: string | undefined;
|
|
1072
|
-
chip?: StartJourneyChip | undefined;
|
|
1073
|
-
classification?: StartJourneyClassification | undefined;
|
|
1074
|
-
extraction?: StartJourneyExtraction | undefined;
|
|
1075
|
-
validation?: StartJourneyValidation | undefined;
|
|
1076
|
-
subType?: string | undefined;
|
|
1077
|
-
number?: string | undefined;
|
|
1864
|
+
version: string;
|
|
1865
|
+
};
|
|
1866
|
+
|
|
1867
|
+
export type Config = {
|
|
1868
|
+
delivery: string;
|
|
1869
|
+
branding?: any | undefined;
|
|
1078
1870
|
/**
|
|
1079
|
-
*
|
|
1871
|
+
* Marks this start as operator-completed (assisted) rather than customer-completed, so the two populations can be told apart in downstream telemetry. Accepted and logged but not yet enforced: supplying it does not change validation, routing, execution or the response, and omitting it leaves the request byte-identical to an ordinary start. It is an attribution signal only, and whether anything ever reads it to change behavior is a separate decision that has not been taken.
|
|
1080
1872
|
*/
|
|
1081
|
-
|
|
1082
|
-
subject?: StartJourneyDocumentSubject | undefined;
|
|
1873
|
+
assisted?: boolean | undefined;
|
|
1083
1874
|
/**
|
|
1084
|
-
*
|
|
1875
|
+
* Opt-in synchronous execution: when true, the start call waits for the journey and returns its outcome inline (completed, failed, awaiting-input or pending) instead of returning immediately with just an instanceId. Requires delivery "api" and a durable engine; otherwise the request is rejected with 400 before any journey is created. false is accepted and means the same as omitting it. Same name as Captain V1, but the response shape differs: the journey state is nested under "state".
|
|
1876
|
+
*/
|
|
1877
|
+
inlineResult?: boolean | undefined;
|
|
1878
|
+
/**
|
|
1879
|
+
* How many seconds the caller is willing to wait; requires inlineResult: true. Optional: absent means wait up to the platform ceiling, which is the load balancer's idle timeout minus 5 seconds (55 today). Send a smaller value if your own HTTP client gives up sooner. A value above the ceiling is clamped, not rejected, and the clamp is logged; waitedSeconds in the response says how long the call waited.
|
|
1880
|
+
*/
|
|
1881
|
+
syncWaitSeconds?: number | undefined;
|
|
1882
|
+
/**
|
|
1883
|
+
* Per-journey link lifetime and resume behavior. Every member is optional, and each is resolved independently across the per-journey, delivery, organization and system-default tiers, then clamped down to the operator bounds. All three members reach runtime behavior: ttlMinutes bounds how long the link stays startable, and the resolved resumeMode and resumeExpiryMinutes are frozen onto the delivery-token and connect-secret records, read at connect, and enforced when a resume credential is minted and exchanged. None of the resolved values is echoed on any response — the journey-start log line is where the resolved mode, its tier and any clamp are reported. An absent ttlMinutes falls back to the delivery resource's linkConfig, then to the organization's value, then to the deprecated flat deliveryUrlTtlMinutes, then to the system default.
|
|
1085
1884
|
*/
|
|
1885
|
+
linkConfig?: LinkConfig | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* Selects which revision of this organisation configuration overlay this execution runs against. It participates in the delivery cache key, so naming a version guarantees the start is served a graph built from that exact overlay instead of a cached one. Omitting it is a no-op: the latest overlay applies and the request behaves as it did before this member existed.
|
|
1888
|
+
*/
|
|
1889
|
+
overlay?: Overlay | undefined;
|
|
1890
|
+
[additionalProperties: string]: unknown;
|
|
1891
|
+
};
|
|
1892
|
+
|
|
1893
|
+
export type StartJourneyContext = {
|
|
1894
|
+
subject?: StartJourneySubject | undefined;
|
|
1895
|
+
config: Config;
|
|
1896
|
+
[additionalProperties: string]: unknown;
|
|
1897
|
+
};
|
|
1898
|
+
|
|
1899
|
+
export type Modules = {
|
|
1900
|
+
outcome: string;
|
|
1901
|
+
advice?: { [k: string]: any } | undefined;
|
|
1902
|
+
[additionalProperties: string]: unknown;
|
|
1903
|
+
};
|
|
1904
|
+
|
|
1905
|
+
export type Scenario = {
|
|
1906
|
+
modules: { [k: string]: Modules };
|
|
1907
|
+
defaultOutcome?: string | undefined;
|
|
1908
|
+
defaultAdvice?: { [k: string]: any } | undefined;
|
|
1909
|
+
description?: string | undefined;
|
|
1910
|
+
[additionalProperties: string]: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
|
|
1913
|
+
export type StartJourneyRequest = {
|
|
1914
|
+
resourceId: string;
|
|
1915
|
+
context: StartJourneyContext;
|
|
1916
|
+
scenario?: Scenario | undefined;
|
|
1917
|
+
};
|
|
1918
|
+
|
|
1919
|
+
/** @internal */
|
|
1920
|
+
export type StartJourneyIdentityAlias$Outbound = {
|
|
1921
|
+
title?: string | undefined;
|
|
1922
|
+
firstName?: string | undefined;
|
|
1923
|
+
middleNames?: Array<string> | undefined;
|
|
1924
|
+
lastNames?: Array<string> | undefined;
|
|
1925
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
1926
|
+
fullName?: string | undefined;
|
|
1927
|
+
};
|
|
1928
|
+
|
|
1929
|
+
/** @internal */
|
|
1930
|
+
export const StartJourneyIdentityAlias$outboundSchema: z.ZodMiniType<
|
|
1931
|
+
StartJourneyIdentityAlias$Outbound,
|
|
1932
|
+
StartJourneyIdentityAlias
|
|
1933
|
+
> = z.object({
|
|
1934
|
+
title: z.optional(z.string()),
|
|
1935
|
+
firstName: z.optional(z.string()),
|
|
1936
|
+
middleNames: z.optional(z.array(z.string())),
|
|
1937
|
+
lastNames: z.optional(z.array(z.string())),
|
|
1938
|
+
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
1939
|
+
fullName: z.optional(z.string()),
|
|
1940
|
+
});
|
|
1941
|
+
|
|
1942
|
+
export function startJourneyIdentityAliasToJSON(
|
|
1943
|
+
startJourneyIdentityAlias: StartJourneyIdentityAlias,
|
|
1944
|
+
): string {
|
|
1945
|
+
return JSON.stringify(
|
|
1946
|
+
StartJourneyIdentityAlias$outboundSchema.parse(startJourneyIdentityAlias),
|
|
1947
|
+
);
|
|
1948
|
+
}
|
|
1949
|
+
|
|
1950
|
+
/** @internal */
|
|
1951
|
+
export const StartJourneyIdentityRelationship$outboundSchema: z.ZodMiniEnum<
|
|
1952
|
+
typeof StartJourneyIdentityRelationship
|
|
1953
|
+
> = z.enum(StartJourneyIdentityRelationship);
|
|
1954
|
+
|
|
1955
|
+
/** @internal */
|
|
1956
|
+
export type StartJourneyIdentityRelatedPerson$Outbound = {
|
|
1957
|
+
title?: string | undefined;
|
|
1958
|
+
firstName?: string | undefined;
|
|
1959
|
+
middleNames?: Array<string> | undefined;
|
|
1960
|
+
lastNames?: Array<string> | undefined;
|
|
1961
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
1962
|
+
relationship: string;
|
|
1963
|
+
};
|
|
1964
|
+
|
|
1965
|
+
/** @internal */
|
|
1966
|
+
export const StartJourneyIdentityRelatedPerson$outboundSchema: z.ZodMiniType<
|
|
1967
|
+
StartJourneyIdentityRelatedPerson$Outbound,
|
|
1968
|
+
StartJourneyIdentityRelatedPerson
|
|
1969
|
+
> = z.object({
|
|
1970
|
+
title: z.optional(z.string()),
|
|
1971
|
+
firstName: z.optional(z.string()),
|
|
1972
|
+
middleNames: z.optional(z.array(z.string())),
|
|
1973
|
+
lastNames: z.optional(z.array(z.string())),
|
|
1974
|
+
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
1975
|
+
relationship: StartJourneyIdentityRelationship$outboundSchema,
|
|
1976
|
+
});
|
|
1977
|
+
|
|
1978
|
+
export function startJourneyIdentityRelatedPersonToJSON(
|
|
1979
|
+
startJourneyIdentityRelatedPerson: StartJourneyIdentityRelatedPerson,
|
|
1980
|
+
): string {
|
|
1981
|
+
return JSON.stringify(
|
|
1982
|
+
StartJourneyIdentityRelatedPerson$outboundSchema.parse(
|
|
1983
|
+
startJourneyIdentityRelatedPerson,
|
|
1984
|
+
),
|
|
1985
|
+
);
|
|
1986
|
+
}
|
|
1987
|
+
|
|
1988
|
+
/** @internal */
|
|
1989
|
+
export type StartJourneyIdentityCurrentAddressLocation$Outbound = {
|
|
1990
|
+
latitude?: string | undefined;
|
|
1991
|
+
longitude?: string | undefined;
|
|
1992
|
+
geoAccuracy?: string | undefined;
|
|
1993
|
+
what3words?: string | undefined;
|
|
1994
|
+
};
|
|
1995
|
+
|
|
1996
|
+
/** @internal */
|
|
1997
|
+
export const StartJourneyIdentityCurrentAddressLocation$outboundSchema:
|
|
1998
|
+
z.ZodMiniType<
|
|
1999
|
+
StartJourneyIdentityCurrentAddressLocation$Outbound,
|
|
2000
|
+
StartJourneyIdentityCurrentAddressLocation
|
|
2001
|
+
> = z.object({
|
|
2002
|
+
latitude: z.optional(z.string()),
|
|
2003
|
+
longitude: z.optional(z.string()),
|
|
2004
|
+
geoAccuracy: z.optional(z.string()),
|
|
2005
|
+
what3words: z.optional(z.string()),
|
|
2006
|
+
});
|
|
2007
|
+
|
|
2008
|
+
export function startJourneyIdentityCurrentAddressLocationToJSON(
|
|
2009
|
+
startJourneyIdentityCurrentAddressLocation:
|
|
2010
|
+
StartJourneyIdentityCurrentAddressLocation,
|
|
2011
|
+
): string {
|
|
2012
|
+
return JSON.stringify(
|
|
2013
|
+
StartJourneyIdentityCurrentAddressLocation$outboundSchema.parse(
|
|
2014
|
+
startJourneyIdentityCurrentAddressLocation,
|
|
2015
|
+
),
|
|
2016
|
+
);
|
|
2017
|
+
}
|
|
2018
|
+
|
|
2019
|
+
/** @internal */
|
|
2020
|
+
export type StartJourneyIdentityCurrentAddress$Outbound = {
|
|
2021
|
+
lines?: Array<string> | undefined;
|
|
2022
|
+
addressString?: string | undefined;
|
|
2023
|
+
premise?: string | undefined;
|
|
2024
|
+
building?: string | undefined;
|
|
2025
|
+
subBuilding?: string | undefined;
|
|
2026
|
+
thoroughfare?: string | undefined;
|
|
2027
|
+
dependentThoroughfare?: string | undefined;
|
|
2028
|
+
locality?: string | undefined;
|
|
2029
|
+
dependentLocality?: string | undefined;
|
|
2030
|
+
doubleDependentLocality?: string | undefined;
|
|
2031
|
+
postalCode?: string | undefined;
|
|
2032
|
+
postBox?: string | undefined;
|
|
1086
2033
|
country?: string | undefined;
|
|
2034
|
+
superAdministrativeArea?: string | undefined;
|
|
2035
|
+
administrativeArea?: string | undefined;
|
|
2036
|
+
subAdministrativeArea?: string | undefined;
|
|
2037
|
+
organization?: string | undefined;
|
|
2038
|
+
location?: StartJourneyIdentityCurrentAddressLocation$Outbound | undefined;
|
|
1087
2039
|
};
|
|
1088
2040
|
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
|
|
2041
|
+
/** @internal */
|
|
2042
|
+
export const StartJourneyIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
|
|
2043
|
+
StartJourneyIdentityCurrentAddress$Outbound,
|
|
2044
|
+
StartJourneyIdentityCurrentAddress
|
|
2045
|
+
> = z.object({
|
|
2046
|
+
lines: z.optional(z.array(z.string())),
|
|
2047
|
+
addressString: z.optional(z.string()),
|
|
2048
|
+
premise: z.optional(z.string()),
|
|
2049
|
+
building: z.optional(z.string()),
|
|
2050
|
+
subBuilding: z.optional(z.string()),
|
|
2051
|
+
thoroughfare: z.optional(z.string()),
|
|
2052
|
+
dependentThoroughfare: z.optional(z.string()),
|
|
2053
|
+
locality: z.optional(z.string()),
|
|
2054
|
+
dependentLocality: z.optional(z.string()),
|
|
2055
|
+
doubleDependentLocality: z.optional(z.string()),
|
|
2056
|
+
postalCode: z.optional(z.string()),
|
|
2057
|
+
postBox: z.optional(z.string()),
|
|
2058
|
+
country: z.optional(z.string()),
|
|
2059
|
+
superAdministrativeArea: z.optional(z.string()),
|
|
2060
|
+
administrativeArea: z.optional(z.string()),
|
|
2061
|
+
subAdministrativeArea: z.optional(z.string()),
|
|
2062
|
+
organization: z.optional(z.string()),
|
|
2063
|
+
location: z.optional(
|
|
2064
|
+
z.lazy(() => StartJourneyIdentityCurrentAddressLocation$outboundSchema),
|
|
2065
|
+
),
|
|
2066
|
+
});
|
|
2067
|
+
|
|
2068
|
+
export function startJourneyIdentityCurrentAddressToJSON(
|
|
2069
|
+
startJourneyIdentityCurrentAddress: StartJourneyIdentityCurrentAddress,
|
|
2070
|
+
): string {
|
|
2071
|
+
return JSON.stringify(
|
|
2072
|
+
StartJourneyIdentityCurrentAddress$outboundSchema.parse(
|
|
2073
|
+
startJourneyIdentityCurrentAddress,
|
|
2074
|
+
),
|
|
2075
|
+
);
|
|
2076
|
+
}
|
|
2077
|
+
|
|
2078
|
+
/** @internal */
|
|
2079
|
+
export type StartJourneyIdentityPreviousAddressLocation$Outbound = {
|
|
2080
|
+
latitude?: string | undefined;
|
|
2081
|
+
longitude?: string | undefined;
|
|
2082
|
+
geoAccuracy?: string | undefined;
|
|
2083
|
+
what3words?: string | undefined;
|
|
2084
|
+
};
|
|
2085
|
+
|
|
2086
|
+
/** @internal */
|
|
2087
|
+
export const StartJourneyIdentityPreviousAddressLocation$outboundSchema:
|
|
2088
|
+
z.ZodMiniType<
|
|
2089
|
+
StartJourneyIdentityPreviousAddressLocation$Outbound,
|
|
2090
|
+
StartJourneyIdentityPreviousAddressLocation
|
|
2091
|
+
> = z.object({
|
|
2092
|
+
latitude: z.optional(z.string()),
|
|
2093
|
+
longitude: z.optional(z.string()),
|
|
2094
|
+
geoAccuracy: z.optional(z.string()),
|
|
2095
|
+
what3words: z.optional(z.string()),
|
|
2096
|
+
});
|
|
2097
|
+
|
|
2098
|
+
export function startJourneyIdentityPreviousAddressLocationToJSON(
|
|
2099
|
+
startJourneyIdentityPreviousAddressLocation:
|
|
2100
|
+
StartJourneyIdentityPreviousAddressLocation,
|
|
2101
|
+
): string {
|
|
2102
|
+
return JSON.stringify(
|
|
2103
|
+
StartJourneyIdentityPreviousAddressLocation$outboundSchema.parse(
|
|
2104
|
+
startJourneyIdentityPreviousAddressLocation,
|
|
2105
|
+
),
|
|
2106
|
+
);
|
|
2107
|
+
}
|
|
2108
|
+
|
|
2109
|
+
/** @internal */
|
|
2110
|
+
export type StartJourneyIdentityPreviousAddress$Outbound = {
|
|
2111
|
+
lines?: Array<string> | undefined;
|
|
2112
|
+
addressString?: string | undefined;
|
|
2113
|
+
premise?: string | undefined;
|
|
2114
|
+
building?: string | undefined;
|
|
2115
|
+
subBuilding?: string | undefined;
|
|
2116
|
+
thoroughfare?: string | undefined;
|
|
2117
|
+
dependentThoroughfare?: string | undefined;
|
|
2118
|
+
locality?: string | undefined;
|
|
2119
|
+
dependentLocality?: string | undefined;
|
|
2120
|
+
doubleDependentLocality?: string | undefined;
|
|
2121
|
+
postalCode?: string | undefined;
|
|
2122
|
+
postBox?: string | undefined;
|
|
2123
|
+
country?: string | undefined;
|
|
2124
|
+
superAdministrativeArea?: string | undefined;
|
|
2125
|
+
administrativeArea?: string | undefined;
|
|
2126
|
+
subAdministrativeArea?: string | undefined;
|
|
2127
|
+
organization?: string | undefined;
|
|
2128
|
+
location?: StartJourneyIdentityPreviousAddressLocation$Outbound | undefined;
|
|
2129
|
+
fromDate?: string | undefined;
|
|
2130
|
+
toDate?: string | undefined;
|
|
1094
2131
|
};
|
|
1095
2132
|
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
2133
|
+
/** @internal */
|
|
2134
|
+
export const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
|
|
2135
|
+
StartJourneyIdentityPreviousAddress$Outbound,
|
|
2136
|
+
StartJourneyIdentityPreviousAddress
|
|
2137
|
+
> = z.object({
|
|
2138
|
+
lines: z.optional(z.array(z.string())),
|
|
2139
|
+
addressString: z.optional(z.string()),
|
|
2140
|
+
premise: z.optional(z.string()),
|
|
2141
|
+
building: z.optional(z.string()),
|
|
2142
|
+
subBuilding: z.optional(z.string()),
|
|
2143
|
+
thoroughfare: z.optional(z.string()),
|
|
2144
|
+
dependentThoroughfare: z.optional(z.string()),
|
|
2145
|
+
locality: z.optional(z.string()),
|
|
2146
|
+
dependentLocality: z.optional(z.string()),
|
|
2147
|
+
doubleDependentLocality: z.optional(z.string()),
|
|
2148
|
+
postalCode: z.optional(z.string()),
|
|
2149
|
+
postBox: z.optional(z.string()),
|
|
2150
|
+
country: z.optional(z.string()),
|
|
2151
|
+
superAdministrativeArea: z.optional(z.string()),
|
|
2152
|
+
administrativeArea: z.optional(z.string()),
|
|
2153
|
+
subAdministrativeArea: z.optional(z.string()),
|
|
2154
|
+
organization: z.optional(z.string()),
|
|
2155
|
+
location: z.optional(
|
|
2156
|
+
z.lazy(() => StartJourneyIdentityPreviousAddressLocation$outboundSchema),
|
|
2157
|
+
),
|
|
2158
|
+
fromDate: z.optional(z.string()),
|
|
2159
|
+
toDate: z.optional(z.string()),
|
|
2160
|
+
});
|
|
1101
2161
|
|
|
1102
|
-
export
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
2162
|
+
export function startJourneyIdentityPreviousAddressToJSON(
|
|
2163
|
+
startJourneyIdentityPreviousAddress: StartJourneyIdentityPreviousAddress,
|
|
2164
|
+
): string {
|
|
2165
|
+
return JSON.stringify(
|
|
2166
|
+
StartJourneyIdentityPreviousAddress$outboundSchema.parse(
|
|
2167
|
+
startJourneyIdentityPreviousAddress,
|
|
2168
|
+
),
|
|
2169
|
+
);
|
|
2170
|
+
}
|
|
1108
2171
|
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
2172
|
+
/** @internal */
|
|
2173
|
+
export type StartJourneyIdentityPlaceOfBirthLocation$Outbound = {
|
|
2174
|
+
latitude?: string | undefined;
|
|
2175
|
+
longitude?: string | undefined;
|
|
2176
|
+
geoAccuracy?: string | undefined;
|
|
2177
|
+
what3words?: string | undefined;
|
|
1114
2178
|
};
|
|
1115
2179
|
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
2180
|
+
/** @internal */
|
|
2181
|
+
export const StartJourneyIdentityPlaceOfBirthLocation$outboundSchema:
|
|
2182
|
+
z.ZodMiniType<
|
|
2183
|
+
StartJourneyIdentityPlaceOfBirthLocation$Outbound,
|
|
2184
|
+
StartJourneyIdentityPlaceOfBirthLocation
|
|
2185
|
+
> = z.object({
|
|
2186
|
+
latitude: z.optional(z.string()),
|
|
2187
|
+
longitude: z.optional(z.string()),
|
|
2188
|
+
geoAccuracy: z.optional(z.string()),
|
|
2189
|
+
what3words: z.optional(z.string()),
|
|
2190
|
+
});
|
|
1121
2191
|
|
|
1122
|
-
export
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
2192
|
+
export function startJourneyIdentityPlaceOfBirthLocationToJSON(
|
|
2193
|
+
startJourneyIdentityPlaceOfBirthLocation:
|
|
2194
|
+
StartJourneyIdentityPlaceOfBirthLocation,
|
|
2195
|
+
): string {
|
|
2196
|
+
return JSON.stringify(
|
|
2197
|
+
StartJourneyIdentityPlaceOfBirthLocation$outboundSchema.parse(
|
|
2198
|
+
startJourneyIdentityPlaceOfBirthLocation,
|
|
2199
|
+
),
|
|
2200
|
+
);
|
|
2201
|
+
}
|
|
1127
2202
|
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
2203
|
+
/** @internal */
|
|
2204
|
+
export type StartJourneyIdentityPlaceOfBirth$Outbound = {
|
|
2205
|
+
lines?: Array<string> | undefined;
|
|
2206
|
+
addressString?: string | undefined;
|
|
2207
|
+
premise?: string | undefined;
|
|
2208
|
+
building?: string | undefined;
|
|
2209
|
+
subBuilding?: string | undefined;
|
|
2210
|
+
thoroughfare?: string | undefined;
|
|
2211
|
+
dependentThoroughfare?: string | undefined;
|
|
2212
|
+
locality?: string | undefined;
|
|
2213
|
+
dependentLocality?: string | undefined;
|
|
2214
|
+
doubleDependentLocality?: string | undefined;
|
|
2215
|
+
postalCode?: string | undefined;
|
|
2216
|
+
postBox?: string | undefined;
|
|
2217
|
+
country?: string | undefined;
|
|
2218
|
+
superAdministrativeArea?: string | undefined;
|
|
2219
|
+
administrativeArea?: string | undefined;
|
|
2220
|
+
subAdministrativeArea?: string | undefined;
|
|
2221
|
+
organization?: string | undefined;
|
|
2222
|
+
location?: StartJourneyIdentityPlaceOfBirthLocation$Outbound | undefined;
|
|
1132
2223
|
};
|
|
1133
2224
|
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
2225
|
+
/** @internal */
|
|
2226
|
+
export const StartJourneyIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
|
|
2227
|
+
StartJourneyIdentityPlaceOfBirth$Outbound,
|
|
2228
|
+
StartJourneyIdentityPlaceOfBirth
|
|
2229
|
+
> = z.object({
|
|
2230
|
+
lines: z.optional(z.array(z.string())),
|
|
2231
|
+
addressString: z.optional(z.string()),
|
|
2232
|
+
premise: z.optional(z.string()),
|
|
2233
|
+
building: z.optional(z.string()),
|
|
2234
|
+
subBuilding: z.optional(z.string()),
|
|
2235
|
+
thoroughfare: z.optional(z.string()),
|
|
2236
|
+
dependentThoroughfare: z.optional(z.string()),
|
|
2237
|
+
locality: z.optional(z.string()),
|
|
2238
|
+
dependentLocality: z.optional(z.string()),
|
|
2239
|
+
doubleDependentLocality: z.optional(z.string()),
|
|
2240
|
+
postalCode: z.optional(z.string()),
|
|
2241
|
+
postBox: z.optional(z.string()),
|
|
2242
|
+
country: z.optional(z.string()),
|
|
2243
|
+
superAdministrativeArea: z.optional(z.string()),
|
|
2244
|
+
administrativeArea: z.optional(z.string()),
|
|
2245
|
+
subAdministrativeArea: z.optional(z.string()),
|
|
2246
|
+
organization: z.optional(z.string()),
|
|
2247
|
+
location: z.optional(
|
|
2248
|
+
z.lazy(() => StartJourneyIdentityPlaceOfBirthLocation$outboundSchema),
|
|
2249
|
+
),
|
|
2250
|
+
});
|
|
1138
2251
|
|
|
1139
|
-
export
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
2252
|
+
export function startJourneyIdentityPlaceOfBirthToJSON(
|
|
2253
|
+
startJourneyIdentityPlaceOfBirth: StartJourneyIdentityPlaceOfBirth,
|
|
2254
|
+
): string {
|
|
2255
|
+
return JSON.stringify(
|
|
2256
|
+
StartJourneyIdentityPlaceOfBirth$outboundSchema.parse(
|
|
2257
|
+
startJourneyIdentityPlaceOfBirth,
|
|
2258
|
+
),
|
|
2259
|
+
);
|
|
2260
|
+
}
|
|
1144
2261
|
|
|
1145
|
-
|
|
1146
|
-
|
|
2262
|
+
/** @internal */
|
|
2263
|
+
export type StartJourneyIdentityIdNumber$Outbound = {
|
|
2264
|
+
type: string;
|
|
2265
|
+
idNumber: string;
|
|
2266
|
+
country?: string | undefined;
|
|
1147
2267
|
};
|
|
1148
2268
|
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
2269
|
+
/** @internal */
|
|
2270
|
+
export const StartJourneyIdentityIdNumber$outboundSchema: z.ZodMiniType<
|
|
2271
|
+
StartJourneyIdentityIdNumber$Outbound,
|
|
2272
|
+
StartJourneyIdentityIdNumber
|
|
2273
|
+
> = z.object({
|
|
2274
|
+
type: z.string(),
|
|
2275
|
+
idNumber: z.string(),
|
|
2276
|
+
country: z.optional(z.string()),
|
|
2277
|
+
});
|
|
1152
2278
|
|
|
1153
|
-
export
|
|
1154
|
-
|
|
1155
|
-
|
|
2279
|
+
export function startJourneyIdentityIdNumberToJSON(
|
|
2280
|
+
startJourneyIdentityIdNumber: StartJourneyIdentityIdNumber,
|
|
2281
|
+
): string {
|
|
2282
|
+
return JSON.stringify(
|
|
2283
|
+
StartJourneyIdentityIdNumber$outboundSchema.parse(
|
|
2284
|
+
startJourneyIdentityIdNumber,
|
|
2285
|
+
),
|
|
2286
|
+
);
|
|
2287
|
+
}
|
|
1156
2288
|
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
code?: string | undefined;
|
|
1162
|
-
state?: string | undefined;
|
|
1163
|
-
redirectUri?: string | undefined;
|
|
1164
|
-
responseType?: string | undefined;
|
|
1165
|
-
clientId?: string | undefined;
|
|
1166
|
-
clientSecret?: string | undefined;
|
|
2289
|
+
/** @internal */
|
|
2290
|
+
export type StartJourneyIdentityPhone$Outbound = {
|
|
2291
|
+
type: string;
|
|
2292
|
+
number: string;
|
|
1167
2293
|
};
|
|
1168
2294
|
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
};
|
|
2295
|
+
/** @internal */
|
|
2296
|
+
export const StartJourneyIdentityPhone$outboundSchema: z.ZodMiniType<
|
|
2297
|
+
StartJourneyIdentityPhone$Outbound,
|
|
2298
|
+
StartJourneyIdentityPhone
|
|
2299
|
+
> = z.object({
|
|
2300
|
+
type: z.string(),
|
|
2301
|
+
number: z.string(),
|
|
2302
|
+
});
|
|
1178
2303
|
|
|
1179
|
-
export
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
>;
|
|
2304
|
+
export function startJourneyIdentityPhoneToJSON(
|
|
2305
|
+
startJourneyIdentityPhone: StartJourneyIdentityPhone,
|
|
2306
|
+
): string {
|
|
2307
|
+
return JSON.stringify(
|
|
2308
|
+
StartJourneyIdentityPhone$outboundSchema.parse(startJourneyIdentityPhone),
|
|
2309
|
+
);
|
|
2310
|
+
}
|
|
1187
2311
|
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
url: string;
|
|
1193
|
-
effectiveDate?: string | undefined;
|
|
1194
|
-
expiryDate?: string | undefined;
|
|
1195
|
-
terms?: string | undefined;
|
|
1196
|
-
purpose?: string | undefined;
|
|
1197
|
-
legalBasis?: string | undefined;
|
|
1198
|
-
jurisdiction?: string | undefined;
|
|
1199
|
-
subject?: string | undefined;
|
|
1200
|
-
signatory?: string | undefined;
|
|
2312
|
+
/** @internal */
|
|
2313
|
+
export type StartJourneyIdentityEmail$Outbound = {
|
|
2314
|
+
type: string;
|
|
2315
|
+
email: string;
|
|
1201
2316
|
};
|
|
1202
2317
|
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
2318
|
+
/** @internal */
|
|
2319
|
+
export const StartJourneyIdentityEmail$outboundSchema: z.ZodMiniType<
|
|
2320
|
+
StartJourneyIdentityEmail$Outbound,
|
|
2321
|
+
StartJourneyIdentityEmail
|
|
2322
|
+
> = z.object({
|
|
2323
|
+
type: z.string(),
|
|
2324
|
+
email: z.string(),
|
|
2325
|
+
});
|
|
2326
|
+
|
|
2327
|
+
export function startJourneyIdentityEmailToJSON(
|
|
2328
|
+
startJourneyIdentityEmail: StartJourneyIdentityEmail,
|
|
2329
|
+
): string {
|
|
2330
|
+
return JSON.stringify(
|
|
2331
|
+
StartJourneyIdentityEmail$outboundSchema.parse(startJourneyIdentityEmail),
|
|
2332
|
+
);
|
|
2333
|
+
}
|
|
2334
|
+
|
|
2335
|
+
/** @internal */
|
|
2336
|
+
export type StartJourneyIdentitySocial$Outbound = {
|
|
1207
2337
|
type: string;
|
|
1208
|
-
|
|
1209
|
-
* Account number
|
|
1210
|
-
*/
|
|
1211
|
-
accountNumber: string;
|
|
1212
|
-
/**
|
|
1213
|
-
* UK sort code
|
|
1214
|
-
*/
|
|
1215
|
-
sortCode?: string | undefined;
|
|
1216
|
-
/**
|
|
1217
|
-
* US ABA routing number
|
|
1218
|
-
*/
|
|
1219
|
-
routingNumber?: string | undefined;
|
|
1220
|
-
/**
|
|
1221
|
-
* International Bank Account Number
|
|
1222
|
-
*/
|
|
1223
|
-
iban?: string | undefined;
|
|
1224
|
-
/**
|
|
1225
|
-
* BIC/SWIFT code
|
|
1226
|
-
*/
|
|
1227
|
-
bic?: string | undefined;
|
|
1228
|
-
/**
|
|
1229
|
-
* Name on the account
|
|
1230
|
-
*/
|
|
1231
|
-
accountHolderName?: string | undefined;
|
|
1232
|
-
/**
|
|
1233
|
-
* Name of the financial institution
|
|
1234
|
-
*/
|
|
1235
|
-
bankName?: string | undefined;
|
|
1236
|
-
/**
|
|
1237
|
-
* Country the address is in. It must be a valid ISO2 or ISO3 country code
|
|
1238
|
-
*/
|
|
1239
|
-
country?: string | undefined;
|
|
1240
|
-
/**
|
|
1241
|
-
* Account classification, e.g. current, savings
|
|
1242
|
-
*/
|
|
1243
|
-
accountType?: string | undefined;
|
|
2338
|
+
identity: string;
|
|
1244
2339
|
};
|
|
1245
2340
|
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
2341
|
+
/** @internal */
|
|
2342
|
+
export const StartJourneyIdentitySocial$outboundSchema: z.ZodMiniType<
|
|
2343
|
+
StartJourneyIdentitySocial$Outbound,
|
|
2344
|
+
StartJourneyIdentitySocial
|
|
2345
|
+
> = z.object({
|
|
2346
|
+
type: z.string(),
|
|
2347
|
+
identity: z.string(),
|
|
2348
|
+
});
|
|
2349
|
+
|
|
2350
|
+
export function startJourneyIdentitySocialToJSON(
|
|
2351
|
+
startJourneyIdentitySocial: StartJourneyIdentitySocial,
|
|
2352
|
+
): string {
|
|
2353
|
+
return JSON.stringify(
|
|
2354
|
+
StartJourneyIdentitySocial$outboundSchema.parse(startJourneyIdentitySocial),
|
|
2355
|
+
);
|
|
2356
|
+
}
|
|
2357
|
+
|
|
2358
|
+
/** @internal */
|
|
2359
|
+
export type StartJourneyIdentity$Outbound = {
|
|
2360
|
+
title?: string | undefined;
|
|
2361
|
+
firstName?: string | undefined;
|
|
2362
|
+
middleNames?: Array<string> | undefined;
|
|
2363
|
+
lastNames?: Array<string> | undefined;
|
|
2364
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
2365
|
+
aliases?: Array<StartJourneyIdentityAlias$Outbound> | undefined;
|
|
2366
|
+
relatedPersons?:
|
|
2367
|
+
| Array<StartJourneyIdentityRelatedPerson$Outbound>
|
|
1256
2368
|
| undefined;
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
2369
|
+
dateOfBirth?: string | undefined;
|
|
2370
|
+
gender?: string | undefined;
|
|
2371
|
+
currentAddress?: StartJourneyIdentityCurrentAddress$Outbound | undefined;
|
|
2372
|
+
previousAddresses?:
|
|
2373
|
+
| Array<StartJourneyIdentityPreviousAddress$Outbound>
|
|
2374
|
+
| undefined;
|
|
2375
|
+
placeOfBirth?: StartJourneyIdentityPlaceOfBirth$Outbound | undefined;
|
|
2376
|
+
idNumbers?: Array<StartJourneyIdentityIdNumber$Outbound> | undefined;
|
|
2377
|
+
phones?: Array<StartJourneyIdentityPhone$Outbound> | undefined;
|
|
2378
|
+
emails?: Array<StartJourneyIdentityEmail$Outbound> | undefined;
|
|
2379
|
+
socials?: Array<StartJourneyIdentitySocial$Outbound> | undefined;
|
|
2380
|
+
mothersMaidenName?: string | undefined;
|
|
2381
|
+
nationality?: string | undefined;
|
|
1261
2382
|
};
|
|
1262
2383
|
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
2384
|
+
/** @internal */
|
|
2385
|
+
export const StartJourneyIdentity$outboundSchema: z.ZodMiniType<
|
|
2386
|
+
StartJourneyIdentity$Outbound,
|
|
2387
|
+
StartJourneyIdentity
|
|
2388
|
+
> = z.object({
|
|
2389
|
+
title: z.optional(z.string()),
|
|
2390
|
+
firstName: z.optional(z.string()),
|
|
2391
|
+
middleNames: z.optional(z.array(z.string())),
|
|
2392
|
+
lastNames: z.optional(z.array(z.string())),
|
|
2393
|
+
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
2394
|
+
aliases: z.optional(
|
|
2395
|
+
z.array(z.lazy(() => StartJourneyIdentityAlias$outboundSchema)),
|
|
2396
|
+
),
|
|
2397
|
+
relatedPersons: z.optional(
|
|
2398
|
+
z.array(z.lazy(() => StartJourneyIdentityRelatedPerson$outboundSchema)),
|
|
2399
|
+
),
|
|
2400
|
+
dateOfBirth: z.optional(z.string()),
|
|
2401
|
+
gender: z.optional(z.string()),
|
|
2402
|
+
currentAddress: z.optional(
|
|
2403
|
+
z.lazy(() => StartJourneyIdentityCurrentAddress$outboundSchema),
|
|
2404
|
+
),
|
|
2405
|
+
previousAddresses: z.optional(
|
|
2406
|
+
z.array(z.lazy(() => StartJourneyIdentityPreviousAddress$outboundSchema)),
|
|
2407
|
+
),
|
|
2408
|
+
placeOfBirth: z.optional(
|
|
2409
|
+
z.lazy(() => StartJourneyIdentityPlaceOfBirth$outboundSchema),
|
|
2410
|
+
),
|
|
2411
|
+
idNumbers: z.optional(
|
|
2412
|
+
z.array(z.lazy(() => StartJourneyIdentityIdNumber$outboundSchema)),
|
|
2413
|
+
),
|
|
2414
|
+
phones: z.optional(
|
|
2415
|
+
z.array(z.lazy(() => StartJourneyIdentityPhone$outboundSchema)),
|
|
2416
|
+
),
|
|
2417
|
+
emails: z.optional(
|
|
2418
|
+
z.array(z.lazy(() => StartJourneyIdentityEmail$outboundSchema)),
|
|
2419
|
+
),
|
|
2420
|
+
socials: z.optional(
|
|
2421
|
+
z.array(z.lazy(() => StartJourneyIdentitySocial$outboundSchema)),
|
|
2422
|
+
),
|
|
2423
|
+
mothersMaidenName: z.optional(z.string()),
|
|
2424
|
+
nationality: z.optional(z.string()),
|
|
2425
|
+
});
|
|
1267
2426
|
|
|
1268
|
-
export
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
};
|
|
2427
|
+
export function startJourneyIdentityToJSON(
|
|
2428
|
+
startJourneyIdentity: StartJourneyIdentity,
|
|
2429
|
+
): string {
|
|
2430
|
+
return JSON.stringify(
|
|
2431
|
+
StartJourneyIdentity$outboundSchema.parse(startJourneyIdentity),
|
|
2432
|
+
);
|
|
2433
|
+
}
|
|
1276
2434
|
|
|
1277
|
-
/**
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
/**
|
|
1282
|
-
* Journey Instance Id, a unique identifier for a started journey instance.
|
|
1283
|
-
*/
|
|
1284
|
-
instanceId: string;
|
|
1285
|
-
[additionalProperties: string]: unknown;
|
|
1286
|
-
};
|
|
2435
|
+
/** @internal */
|
|
2436
|
+
export const StartJourneyTypePrimary1$outboundSchema: z.ZodMiniEnum<
|
|
2437
|
+
typeof StartJourneyTypePrimary1
|
|
2438
|
+
> = z.enum(StartJourneyTypePrimary1);
|
|
1287
2439
|
|
|
1288
|
-
/**
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
2440
|
+
/** @internal */
|
|
2441
|
+
export const StartJourneyStatus$outboundSchema: z.ZodMiniEnum<
|
|
2442
|
+
typeof StartJourneyStatus
|
|
2443
|
+
> = z.enum(StartJourneyStatus);
|
|
2444
|
+
|
|
2445
|
+
/** @internal */
|
|
2446
|
+
export type StartJourneyAddressLocation$Outbound = {
|
|
2447
|
+
latitude?: string | undefined;
|
|
2448
|
+
longitude?: string | undefined;
|
|
2449
|
+
geoAccuracy?: string | undefined;
|
|
2450
|
+
what3words?: string | undefined;
|
|
1297
2451
|
};
|
|
1298
2452
|
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
2453
|
+
/** @internal */
|
|
2454
|
+
export const StartJourneyAddressLocation$outboundSchema: z.ZodMiniType<
|
|
2455
|
+
StartJourneyAddressLocation$Outbound,
|
|
2456
|
+
StartJourneyAddressLocation
|
|
2457
|
+
> = z.object({
|
|
2458
|
+
latitude: z.optional(z.string()),
|
|
2459
|
+
longitude: z.optional(z.string()),
|
|
2460
|
+
geoAccuracy: z.optional(z.string()),
|
|
2461
|
+
what3words: z.optional(z.string()),
|
|
2462
|
+
});
|
|
2463
|
+
|
|
2464
|
+
export function startJourneyAddressLocationToJSON(
|
|
2465
|
+
startJourneyAddressLocation: StartJourneyAddressLocation,
|
|
2466
|
+
): string {
|
|
2467
|
+
return JSON.stringify(
|
|
2468
|
+
StartJourneyAddressLocation$outboundSchema.parse(
|
|
2469
|
+
startJourneyAddressLocation,
|
|
2470
|
+
),
|
|
2471
|
+
);
|
|
2472
|
+
}
|
|
1302
2473
|
|
|
1303
2474
|
/** @internal */
|
|
1304
|
-
export const
|
|
1305
|
-
|
|
1306
|
-
);
|
|
2475
|
+
export const StartJourneyPurpose$outboundSchema: z.ZodMiniEnum<
|
|
2476
|
+
typeof StartJourneyPurpose
|
|
2477
|
+
> = z.enum(StartJourneyPurpose);
|
|
1307
2478
|
|
|
1308
2479
|
/** @internal */
|
|
1309
|
-
export type
|
|
1310
|
-
|
|
2480
|
+
export type StartJourneyAddressPrimary$Outbound = {
|
|
2481
|
+
lines?: Array<string> | undefined;
|
|
2482
|
+
addressString?: string | undefined;
|
|
2483
|
+
premise?: string | undefined;
|
|
2484
|
+
building?: string | undefined;
|
|
2485
|
+
subBuilding?: string | undefined;
|
|
2486
|
+
thoroughfare?: string | undefined;
|
|
2487
|
+
dependentThoroughfare?: string | undefined;
|
|
2488
|
+
locality?: string | undefined;
|
|
2489
|
+
dependentLocality?: string | undefined;
|
|
2490
|
+
doubleDependentLocality?: string | undefined;
|
|
2491
|
+
postalCode?: string | undefined;
|
|
2492
|
+
postBox?: string | undefined;
|
|
2493
|
+
country?: string | undefined;
|
|
2494
|
+
superAdministrativeArea?: string | undefined;
|
|
2495
|
+
administrativeArea?: string | undefined;
|
|
2496
|
+
subAdministrativeArea?: string | undefined;
|
|
2497
|
+
organization?: string | undefined;
|
|
2498
|
+
location?: StartJourneyAddressLocation$Outbound | undefined;
|
|
2499
|
+
purpose?: string | undefined;
|
|
1311
2500
|
};
|
|
1312
2501
|
|
|
1313
2502
|
/** @internal */
|
|
1314
|
-
export const
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
2503
|
+
export const StartJourneyAddressPrimary$outboundSchema: z.ZodMiniType<
|
|
2504
|
+
StartJourneyAddressPrimary$Outbound,
|
|
2505
|
+
StartJourneyAddressPrimary
|
|
2506
|
+
> = z.object({
|
|
2507
|
+
lines: z.optional(z.array(z.string())),
|
|
2508
|
+
addressString: z.optional(z.string()),
|
|
2509
|
+
premise: z.optional(z.string()),
|
|
2510
|
+
building: z.optional(z.string()),
|
|
2511
|
+
subBuilding: z.optional(z.string()),
|
|
2512
|
+
thoroughfare: z.optional(z.string()),
|
|
2513
|
+
dependentThoroughfare: z.optional(z.string()),
|
|
2514
|
+
locality: z.optional(z.string()),
|
|
2515
|
+
dependentLocality: z.optional(z.string()),
|
|
2516
|
+
doubleDependentLocality: z.optional(z.string()),
|
|
2517
|
+
postalCode: z.optional(z.string()),
|
|
2518
|
+
postBox: z.optional(z.string()),
|
|
2519
|
+
country: z.optional(z.string()),
|
|
2520
|
+
superAdministrativeArea: z.optional(z.string()),
|
|
2521
|
+
administrativeArea: z.optional(z.string()),
|
|
2522
|
+
subAdministrativeArea: z.optional(z.string()),
|
|
2523
|
+
organization: z.optional(z.string()),
|
|
2524
|
+
location: z.optional(
|
|
2525
|
+
z.lazy(() => StartJourneyAddressLocation$outboundSchema),
|
|
2526
|
+
),
|
|
2527
|
+
purpose: z.optional(StartJourneyPurpose$outboundSchema),
|
|
2528
|
+
});
|
|
1318
2529
|
|
|
1319
|
-
export function
|
|
1320
|
-
|
|
2530
|
+
export function startJourneyAddressPrimaryToJSON(
|
|
2531
|
+
startJourneyAddressPrimary: StartJourneyAddressPrimary,
|
|
2532
|
+
): string {
|
|
2533
|
+
return JSON.stringify(
|
|
2534
|
+
StartJourneyAddressPrimary$outboundSchema.parse(startJourneyAddressPrimary),
|
|
2535
|
+
);
|
|
1321
2536
|
}
|
|
1322
2537
|
|
|
1323
2538
|
/** @internal */
|
|
1324
|
-
export
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
2539
|
+
export const StartJourneyTaxIdentifierType$outboundSchema: z.ZodMiniEnum<
|
|
2540
|
+
typeof StartJourneyTaxIdentifierType
|
|
2541
|
+
> = z.enum(StartJourneyTaxIdentifierType);
|
|
2542
|
+
|
|
2543
|
+
/** @internal */
|
|
2544
|
+
export type StartJourneyTaxIdentifier$Outbound = {
|
|
2545
|
+
type: string;
|
|
2546
|
+
value: string;
|
|
2547
|
+
country?: string | undefined;
|
|
1330
2548
|
};
|
|
1331
2549
|
|
|
1332
2550
|
/** @internal */
|
|
1333
|
-
export const
|
|
1334
|
-
|
|
1335
|
-
|
|
2551
|
+
export const StartJourneyTaxIdentifier$outboundSchema: z.ZodMiniType<
|
|
2552
|
+
StartJourneyTaxIdentifier$Outbound,
|
|
2553
|
+
StartJourneyTaxIdentifier
|
|
1336
2554
|
> = z.object({
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
lastNames: z.optional(z.array(z.string())),
|
|
1341
|
-
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
2555
|
+
type: StartJourneyTaxIdentifierType$outboundSchema,
|
|
2556
|
+
value: z.string(),
|
|
2557
|
+
country: z.optional(z.string()),
|
|
1342
2558
|
});
|
|
1343
2559
|
|
|
1344
|
-
export function
|
|
1345
|
-
|
|
2560
|
+
export function startJourneyTaxIdentifierToJSON(
|
|
2561
|
+
startJourneyTaxIdentifier: StartJourneyTaxIdentifier,
|
|
1346
2562
|
): string {
|
|
1347
2563
|
return JSON.stringify(
|
|
1348
|
-
|
|
2564
|
+
StartJourneyTaxIdentifier$outboundSchema.parse(startJourneyTaxIdentifier),
|
|
1349
2565
|
);
|
|
1350
2566
|
}
|
|
1351
2567
|
|
|
1352
2568
|
/** @internal */
|
|
1353
|
-
export const
|
|
1354
|
-
typeof
|
|
1355
|
-
> = z.enum(
|
|
2569
|
+
export const StartJourneySystem$outboundSchema: z.ZodMiniEnum<
|
|
2570
|
+
typeof StartJourneySystem
|
|
2571
|
+
> = z.enum(StartJourneySystem);
|
|
1356
2572
|
|
|
1357
2573
|
/** @internal */
|
|
1358
|
-
export type
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
lastNames?: Array<string> | undefined;
|
|
1363
|
-
lastNamesAtBirth?: Array<string> | undefined;
|
|
1364
|
-
relationship: string;
|
|
2574
|
+
export type StartJourneyIndustryClassification$Outbound = {
|
|
2575
|
+
system: string;
|
|
2576
|
+
code: string;
|
|
2577
|
+
description?: string | undefined;
|
|
1365
2578
|
};
|
|
1366
2579
|
|
|
1367
2580
|
/** @internal */
|
|
1368
|
-
export const
|
|
1369
|
-
|
|
1370
|
-
|
|
2581
|
+
export const StartJourneyIndustryClassification$outboundSchema: z.ZodMiniType<
|
|
2582
|
+
StartJourneyIndustryClassification$Outbound,
|
|
2583
|
+
StartJourneyIndustryClassification
|
|
1371
2584
|
> = z.object({
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
lastNames: z.optional(z.array(z.string())),
|
|
1376
|
-
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
1377
|
-
relationship: StartJourneyIdentityRelationship$outboundSchema,
|
|
2585
|
+
system: StartJourneySystem$outboundSchema,
|
|
2586
|
+
code: z.string(),
|
|
2587
|
+
description: z.optional(z.string()),
|
|
1378
2588
|
});
|
|
1379
2589
|
|
|
1380
|
-
export function
|
|
1381
|
-
|
|
2590
|
+
export function startJourneyIndustryClassificationToJSON(
|
|
2591
|
+
startJourneyIndustryClassification: StartJourneyIndustryClassification,
|
|
1382
2592
|
): string {
|
|
1383
2593
|
return JSON.stringify(
|
|
1384
|
-
|
|
1385
|
-
|
|
2594
|
+
StartJourneyIndustryClassification$outboundSchema.parse(
|
|
2595
|
+
startJourneyIndustryClassification,
|
|
1386
2596
|
),
|
|
1387
2597
|
);
|
|
1388
2598
|
}
|
|
1389
2599
|
|
|
1390
2600
|
/** @internal */
|
|
1391
|
-
export
|
|
2601
|
+
export const StartJourneyRegistrationType$outboundSchema: z.ZodMiniEnum<
|
|
2602
|
+
typeof StartJourneyRegistrationType
|
|
2603
|
+
> = z.enum(StartJourneyRegistrationType);
|
|
2604
|
+
|
|
2605
|
+
/** @internal */
|
|
2606
|
+
export type StartJourneyRegisteredAddressLocation$Outbound = {
|
|
1392
2607
|
latitude?: string | undefined;
|
|
1393
2608
|
longitude?: string | undefined;
|
|
1394
2609
|
geoAccuracy?: string | undefined;
|
|
@@ -1396,10 +2611,10 @@ export type StartJourneyIdentityCurrentAddressLocation$Outbound = {
|
|
|
1396
2611
|
};
|
|
1397
2612
|
|
|
1398
2613
|
/** @internal */
|
|
1399
|
-
export const
|
|
2614
|
+
export const StartJourneyRegisteredAddressLocation$outboundSchema:
|
|
1400
2615
|
z.ZodMiniType<
|
|
1401
|
-
|
|
1402
|
-
|
|
2616
|
+
StartJourneyRegisteredAddressLocation$Outbound,
|
|
2617
|
+
StartJourneyRegisteredAddressLocation
|
|
1403
2618
|
> = z.object({
|
|
1404
2619
|
latitude: z.optional(z.string()),
|
|
1405
2620
|
longitude: z.optional(z.string()),
|
|
@@ -1407,19 +2622,18 @@ export const StartJourneyIdentityCurrentAddressLocation$outboundSchema:
|
|
|
1407
2622
|
what3words: z.optional(z.string()),
|
|
1408
2623
|
});
|
|
1409
2624
|
|
|
1410
|
-
export function
|
|
1411
|
-
|
|
1412
|
-
StartJourneyIdentityCurrentAddressLocation,
|
|
2625
|
+
export function startJourneyRegisteredAddressLocationToJSON(
|
|
2626
|
+
startJourneyRegisteredAddressLocation: StartJourneyRegisteredAddressLocation,
|
|
1413
2627
|
): string {
|
|
1414
2628
|
return JSON.stringify(
|
|
1415
|
-
|
|
1416
|
-
|
|
2629
|
+
StartJourneyRegisteredAddressLocation$outboundSchema.parse(
|
|
2630
|
+
startJourneyRegisteredAddressLocation,
|
|
1417
2631
|
),
|
|
1418
2632
|
);
|
|
1419
2633
|
}
|
|
1420
2634
|
|
|
1421
2635
|
/** @internal */
|
|
1422
|
-
export type
|
|
2636
|
+
export type StartJourneyRegisteredAddress$Outbound = {
|
|
1423
2637
|
lines?: Array<string> | undefined;
|
|
1424
2638
|
addressString?: string | undefined;
|
|
1425
2639
|
premise?: string | undefined;
|
|
@@ -1437,13 +2651,13 @@ export type StartJourneyIdentityCurrentAddress$Outbound = {
|
|
|
1437
2651
|
administrativeArea?: string | undefined;
|
|
1438
2652
|
subAdministrativeArea?: string | undefined;
|
|
1439
2653
|
organization?: string | undefined;
|
|
1440
|
-
location?:
|
|
2654
|
+
location?: StartJourneyRegisteredAddressLocation$Outbound | undefined;
|
|
1441
2655
|
};
|
|
1442
2656
|
|
|
1443
2657
|
/** @internal */
|
|
1444
|
-
export const
|
|
1445
|
-
|
|
1446
|
-
|
|
2658
|
+
export const StartJourneyRegisteredAddress$outboundSchema: z.ZodMiniType<
|
|
2659
|
+
StartJourneyRegisteredAddress$Outbound,
|
|
2660
|
+
StartJourneyRegisteredAddress
|
|
1447
2661
|
> = z.object({
|
|
1448
2662
|
lines: z.optional(z.array(z.string())),
|
|
1449
2663
|
addressString: z.optional(z.string()),
|
|
@@ -1463,22 +2677,22 @@ export const StartJourneyIdentityCurrentAddress$outboundSchema: z.ZodMiniType<
|
|
|
1463
2677
|
subAdministrativeArea: z.optional(z.string()),
|
|
1464
2678
|
organization: z.optional(z.string()),
|
|
1465
2679
|
location: z.optional(
|
|
1466
|
-
z.lazy(() =>
|
|
2680
|
+
z.lazy(() => StartJourneyRegisteredAddressLocation$outboundSchema),
|
|
1467
2681
|
),
|
|
1468
2682
|
});
|
|
1469
2683
|
|
|
1470
|
-
export function
|
|
1471
|
-
|
|
2684
|
+
export function startJourneyRegisteredAddressToJSON(
|
|
2685
|
+
startJourneyRegisteredAddress: StartJourneyRegisteredAddress,
|
|
1472
2686
|
): string {
|
|
1473
2687
|
return JSON.stringify(
|
|
1474
|
-
|
|
1475
|
-
|
|
2688
|
+
StartJourneyRegisteredAddress$outboundSchema.parse(
|
|
2689
|
+
startJourneyRegisteredAddress,
|
|
1476
2690
|
),
|
|
1477
2691
|
);
|
|
1478
2692
|
}
|
|
1479
2693
|
|
|
1480
2694
|
/** @internal */
|
|
1481
|
-
export type
|
|
2695
|
+
export type StartJourneyAgentAddressLocation$Outbound = {
|
|
1482
2696
|
latitude?: string | undefined;
|
|
1483
2697
|
longitude?: string | undefined;
|
|
1484
2698
|
geoAccuracy?: string | undefined;
|
|
@@ -1486,30 +2700,28 @@ export type StartJourneyIdentityPreviousAddressLocation$Outbound = {
|
|
|
1486
2700
|
};
|
|
1487
2701
|
|
|
1488
2702
|
/** @internal */
|
|
1489
|
-
export const
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
});
|
|
2703
|
+
export const StartJourneyAgentAddressLocation$outboundSchema: z.ZodMiniType<
|
|
2704
|
+
StartJourneyAgentAddressLocation$Outbound,
|
|
2705
|
+
StartJourneyAgentAddressLocation
|
|
2706
|
+
> = z.object({
|
|
2707
|
+
latitude: z.optional(z.string()),
|
|
2708
|
+
longitude: z.optional(z.string()),
|
|
2709
|
+
geoAccuracy: z.optional(z.string()),
|
|
2710
|
+
what3words: z.optional(z.string()),
|
|
2711
|
+
});
|
|
1499
2712
|
|
|
1500
|
-
export function
|
|
1501
|
-
|
|
1502
|
-
StartJourneyIdentityPreviousAddressLocation,
|
|
2713
|
+
export function startJourneyAgentAddressLocationToJSON(
|
|
2714
|
+
startJourneyAgentAddressLocation: StartJourneyAgentAddressLocation,
|
|
1503
2715
|
): string {
|
|
1504
2716
|
return JSON.stringify(
|
|
1505
|
-
|
|
1506
|
-
|
|
2717
|
+
StartJourneyAgentAddressLocation$outboundSchema.parse(
|
|
2718
|
+
startJourneyAgentAddressLocation,
|
|
1507
2719
|
),
|
|
1508
2720
|
);
|
|
1509
2721
|
}
|
|
1510
2722
|
|
|
1511
2723
|
/** @internal */
|
|
1512
|
-
export type
|
|
2724
|
+
export type StartJourneyAgentAddress$Outbound = {
|
|
1513
2725
|
lines?: Array<string> | undefined;
|
|
1514
2726
|
addressString?: string | undefined;
|
|
1515
2727
|
premise?: string | undefined;
|
|
@@ -1527,15 +2739,13 @@ export type StartJourneyIdentityPreviousAddress$Outbound = {
|
|
|
1527
2739
|
administrativeArea?: string | undefined;
|
|
1528
2740
|
subAdministrativeArea?: string | undefined;
|
|
1529
2741
|
organization?: string | undefined;
|
|
1530
|
-
location?:
|
|
1531
|
-
fromDate: string;
|
|
1532
|
-
toDate: string;
|
|
2742
|
+
location?: StartJourneyAgentAddressLocation$Outbound | undefined;
|
|
1533
2743
|
};
|
|
1534
2744
|
|
|
1535
2745
|
/** @internal */
|
|
1536
|
-
export const
|
|
1537
|
-
|
|
1538
|
-
|
|
2746
|
+
export const StartJourneyAgentAddress$outboundSchema: z.ZodMiniType<
|
|
2747
|
+
StartJourneyAgentAddress$Outbound,
|
|
2748
|
+
StartJourneyAgentAddress
|
|
1539
2749
|
> = z.object({
|
|
1540
2750
|
lines: z.optional(z.array(z.string())),
|
|
1541
2751
|
addressString: z.optional(z.string()),
|
|
@@ -1555,24 +2765,67 @@ export const StartJourneyIdentityPreviousAddress$outboundSchema: z.ZodMiniType<
|
|
|
1555
2765
|
subAdministrativeArea: z.optional(z.string()),
|
|
1556
2766
|
organization: z.optional(z.string()),
|
|
1557
2767
|
location: z.optional(
|
|
1558
|
-
z.lazy(() =>
|
|
2768
|
+
z.lazy(() => StartJourneyAgentAddressLocation$outboundSchema),
|
|
1559
2769
|
),
|
|
1560
|
-
fromDate: z.string(),
|
|
1561
|
-
toDate: z.string(),
|
|
1562
2770
|
});
|
|
1563
2771
|
|
|
1564
|
-
export function
|
|
1565
|
-
|
|
2772
|
+
export function startJourneyAgentAddressToJSON(
|
|
2773
|
+
startJourneyAgentAddress: StartJourneyAgentAddress,
|
|
1566
2774
|
): string {
|
|
1567
2775
|
return JSON.stringify(
|
|
1568
|
-
|
|
1569
|
-
startJourneyIdentityPreviousAddress,
|
|
1570
|
-
),
|
|
2776
|
+
StartJourneyAgentAddress$outboundSchema.parse(startJourneyAgentAddress),
|
|
1571
2777
|
);
|
|
1572
2778
|
}
|
|
1573
2779
|
|
|
1574
2780
|
/** @internal */
|
|
1575
|
-
export type
|
|
2781
|
+
export type StartJourneyRegistration$Outbound = {
|
|
2782
|
+
jurisdiction?: string | undefined;
|
|
2783
|
+
registrationType?: string | undefined;
|
|
2784
|
+
fileNumber?: string | undefined;
|
|
2785
|
+
issueDate?: string | undefined;
|
|
2786
|
+
registeredAddress?: StartJourneyRegisteredAddress$Outbound | undefined;
|
|
2787
|
+
agentName?: string | undefined;
|
|
2788
|
+
agentAddress?: StartJourneyAgentAddress$Outbound | undefined;
|
|
2789
|
+
};
|
|
2790
|
+
|
|
2791
|
+
/** @internal */
|
|
2792
|
+
export const StartJourneyRegistration$outboundSchema: z.ZodMiniType<
|
|
2793
|
+
StartJourneyRegistration$Outbound,
|
|
2794
|
+
StartJourneyRegistration
|
|
2795
|
+
> = z.object({
|
|
2796
|
+
jurisdiction: z.optional(z.string()),
|
|
2797
|
+
registrationType: z.optional(StartJourneyRegistrationType$outboundSchema),
|
|
2798
|
+
fileNumber: z.optional(z.string()),
|
|
2799
|
+
issueDate: z.optional(z.string()),
|
|
2800
|
+
registeredAddress: z.optional(
|
|
2801
|
+
z.lazy(() => StartJourneyRegisteredAddress$outboundSchema),
|
|
2802
|
+
),
|
|
2803
|
+
agentName: z.optional(z.string()),
|
|
2804
|
+
agentAddress: z.optional(
|
|
2805
|
+
z.lazy(() => StartJourneyAgentAddress$outboundSchema),
|
|
2806
|
+
),
|
|
2807
|
+
});
|
|
2808
|
+
|
|
2809
|
+
export function startJourneyRegistrationToJSON(
|
|
2810
|
+
startJourneyRegistration: StartJourneyRegistration,
|
|
2811
|
+
): string {
|
|
2812
|
+
return JSON.stringify(
|
|
2813
|
+
StartJourneyRegistration$outboundSchema.parse(startJourneyRegistration),
|
|
2814
|
+
);
|
|
2815
|
+
}
|
|
2816
|
+
|
|
2817
|
+
/** @internal */
|
|
2818
|
+
export const StartJourneyTypePrimary2$outboundSchema: z.ZodMiniEnum<
|
|
2819
|
+
typeof StartJourneyTypePrimary2
|
|
2820
|
+
> = z.enum(StartJourneyTypePrimary2);
|
|
2821
|
+
|
|
2822
|
+
/** @internal */
|
|
2823
|
+
export const StartJourneyRole$outboundSchema: z.ZodMiniEnum<
|
|
2824
|
+
typeof StartJourneyRole
|
|
2825
|
+
> = z.enum(StartJourneyRole);
|
|
2826
|
+
|
|
2827
|
+
/** @internal */
|
|
2828
|
+
export type StartJourneyCurrentAddressLocationPrimary$Outbound = {
|
|
1576
2829
|
latitude?: string | undefined;
|
|
1577
2830
|
longitude?: string | undefined;
|
|
1578
2831
|
geoAccuracy?: string | undefined;
|
|
@@ -1580,10 +2833,10 @@ export type StartJourneyIdentityPlaceOfBirthLocation$Outbound = {
|
|
|
1580
2833
|
};
|
|
1581
2834
|
|
|
1582
2835
|
/** @internal */
|
|
1583
|
-
export const
|
|
2836
|
+
export const StartJourneyCurrentAddressLocationPrimary$outboundSchema:
|
|
1584
2837
|
z.ZodMiniType<
|
|
1585
|
-
|
|
1586
|
-
|
|
2838
|
+
StartJourneyCurrentAddressLocationPrimary$Outbound,
|
|
2839
|
+
StartJourneyCurrentAddressLocationPrimary
|
|
1587
2840
|
> = z.object({
|
|
1588
2841
|
latitude: z.optional(z.string()),
|
|
1589
2842
|
longitude: z.optional(z.string()),
|
|
@@ -1591,19 +2844,19 @@ export const StartJourneyIdentityPlaceOfBirthLocation$outboundSchema:
|
|
|
1591
2844
|
what3words: z.optional(z.string()),
|
|
1592
2845
|
});
|
|
1593
2846
|
|
|
1594
|
-
export function
|
|
1595
|
-
|
|
1596
|
-
|
|
2847
|
+
export function startJourneyCurrentAddressLocationPrimaryToJSON(
|
|
2848
|
+
startJourneyCurrentAddressLocationPrimary:
|
|
2849
|
+
StartJourneyCurrentAddressLocationPrimary,
|
|
1597
2850
|
): string {
|
|
1598
2851
|
return JSON.stringify(
|
|
1599
|
-
|
|
1600
|
-
|
|
2852
|
+
StartJourneyCurrentAddressLocationPrimary$outboundSchema.parse(
|
|
2853
|
+
startJourneyCurrentAddressLocationPrimary,
|
|
1601
2854
|
),
|
|
1602
2855
|
);
|
|
1603
2856
|
}
|
|
1604
2857
|
|
|
1605
2858
|
/** @internal */
|
|
1606
|
-
export type
|
|
2859
|
+
export type StartJourneyCurrentAddressPrimary$Outbound = {
|
|
1607
2860
|
lines?: Array<string> | undefined;
|
|
1608
2861
|
addressString?: string | undefined;
|
|
1609
2862
|
premise?: string | undefined;
|
|
@@ -1621,13 +2874,13 @@ export type StartJourneyIdentityPlaceOfBirth$Outbound = {
|
|
|
1621
2874
|
administrativeArea?: string | undefined;
|
|
1622
2875
|
subAdministrativeArea?: string | undefined;
|
|
1623
2876
|
organization?: string | undefined;
|
|
1624
|
-
location?:
|
|
2877
|
+
location?: StartJourneyCurrentAddressLocationPrimary$Outbound | undefined;
|
|
1625
2878
|
};
|
|
1626
2879
|
|
|
1627
2880
|
/** @internal */
|
|
1628
|
-
export const
|
|
1629
|
-
|
|
1630
|
-
|
|
2881
|
+
export const StartJourneyCurrentAddressPrimary$outboundSchema: z.ZodMiniType<
|
|
2882
|
+
StartJourneyCurrentAddressPrimary$Outbound,
|
|
2883
|
+
StartJourneyCurrentAddressPrimary
|
|
1631
2884
|
> = z.object({
|
|
1632
2885
|
lines: z.optional(z.array(z.string())),
|
|
1633
2886
|
addressString: z.optional(z.string()),
|
|
@@ -1647,193 +2900,167 @@ export const StartJourneyIdentityPlaceOfBirth$outboundSchema: z.ZodMiniType<
|
|
|
1647
2900
|
subAdministrativeArea: z.optional(z.string()),
|
|
1648
2901
|
organization: z.optional(z.string()),
|
|
1649
2902
|
location: z.optional(
|
|
1650
|
-
z.lazy(() =>
|
|
2903
|
+
z.lazy(() => StartJourneyCurrentAddressLocationPrimary$outboundSchema),
|
|
1651
2904
|
),
|
|
1652
2905
|
});
|
|
1653
2906
|
|
|
1654
|
-
export function
|
|
1655
|
-
|
|
2907
|
+
export function startJourneyCurrentAddressPrimaryToJSON(
|
|
2908
|
+
startJourneyCurrentAddressPrimary: StartJourneyCurrentAddressPrimary,
|
|
1656
2909
|
): string {
|
|
1657
2910
|
return JSON.stringify(
|
|
1658
|
-
|
|
1659
|
-
|
|
2911
|
+
StartJourneyCurrentAddressPrimary$outboundSchema.parse(
|
|
2912
|
+
startJourneyCurrentAddressPrimary,
|
|
1660
2913
|
),
|
|
1661
2914
|
);
|
|
1662
2915
|
}
|
|
1663
2916
|
|
|
1664
2917
|
/** @internal */
|
|
1665
|
-
export type
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
2918
|
+
export type StartJourneyPerson$Outbound = {
|
|
2919
|
+
title?: string | undefined;
|
|
2920
|
+
firstName?: string | undefined;
|
|
2921
|
+
middleNames?: Array<string> | undefined;
|
|
2922
|
+
lastNames?: Array<string> | undefined;
|
|
2923
|
+
lastNamesAtBirth?: Array<string> | undefined;
|
|
2924
|
+
id?: string | undefined;
|
|
2925
|
+
type?: string | undefined;
|
|
2926
|
+
role?: string | undefined;
|
|
2927
|
+
position?: string | undefined;
|
|
2928
|
+
ownershipPercentage?: number | undefined;
|
|
2929
|
+
nationality?: string | undefined;
|
|
2930
|
+
dateOfBirth?: string | undefined;
|
|
2931
|
+
startDate?: string | undefined;
|
|
2932
|
+
endDate?: string | undefined;
|
|
2933
|
+
currentAddress?: StartJourneyCurrentAddressPrimary$Outbound | undefined;
|
|
1669
2934
|
};
|
|
1670
2935
|
|
|
1671
2936
|
/** @internal */
|
|
1672
|
-
export const
|
|
1673
|
-
|
|
1674
|
-
|
|
2937
|
+
export const StartJourneyPerson$outboundSchema: z.ZodMiniType<
|
|
2938
|
+
StartJourneyPerson$Outbound,
|
|
2939
|
+
StartJourneyPerson
|
|
1675
2940
|
> = z.object({
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
2941
|
+
title: z.optional(z.string()),
|
|
2942
|
+
firstName: z.optional(z.string()),
|
|
2943
|
+
middleNames: z.optional(z.array(z.string())),
|
|
2944
|
+
lastNames: z.optional(z.array(z.string())),
|
|
2945
|
+
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
2946
|
+
id: z.optional(z.string()),
|
|
2947
|
+
type: z.optional(StartJourneyTypePrimary2$outboundSchema),
|
|
2948
|
+
role: z.optional(StartJourneyRole$outboundSchema),
|
|
2949
|
+
position: z.optional(z.string()),
|
|
2950
|
+
ownershipPercentage: z.optional(z.number()),
|
|
2951
|
+
nationality: z.optional(z.string()),
|
|
2952
|
+
dateOfBirth: z.optional(z.string()),
|
|
2953
|
+
startDate: z.optional(z.string()),
|
|
2954
|
+
endDate: z.optional(z.string()),
|
|
2955
|
+
currentAddress: z.optional(
|
|
2956
|
+
z.lazy(() => StartJourneyCurrentAddressPrimary$outboundSchema),
|
|
2957
|
+
),
|
|
1679
2958
|
});
|
|
1680
2959
|
|
|
1681
|
-
export function
|
|
1682
|
-
|
|
2960
|
+
export function startJourneyPersonToJSON(
|
|
2961
|
+
startJourneyPerson: StartJourneyPerson,
|
|
1683
2962
|
): string {
|
|
1684
2963
|
return JSON.stringify(
|
|
1685
|
-
|
|
1686
|
-
startJourneyIdentityIdNumber,
|
|
1687
|
-
),
|
|
2964
|
+
StartJourneyPerson$outboundSchema.parse(startJourneyPerson),
|
|
1688
2965
|
);
|
|
1689
2966
|
}
|
|
1690
2967
|
|
|
1691
2968
|
/** @internal */
|
|
1692
|
-
export type
|
|
2969
|
+
export type StartJourneyPhonePrimary$Outbound = {
|
|
1693
2970
|
type: string;
|
|
1694
2971
|
number: string;
|
|
1695
2972
|
};
|
|
1696
2973
|
|
|
1697
2974
|
/** @internal */
|
|
1698
|
-
export const
|
|
1699
|
-
|
|
1700
|
-
|
|
2975
|
+
export const StartJourneyPhonePrimary$outboundSchema: z.ZodMiniType<
|
|
2976
|
+
StartJourneyPhonePrimary$Outbound,
|
|
2977
|
+
StartJourneyPhonePrimary
|
|
1701
2978
|
> = z.object({
|
|
1702
2979
|
type: z.string(),
|
|
1703
2980
|
number: z.string(),
|
|
1704
2981
|
});
|
|
1705
2982
|
|
|
1706
|
-
export function
|
|
1707
|
-
|
|
1708
|
-
): string {
|
|
1709
|
-
return JSON.stringify(
|
|
1710
|
-
StartJourneyIdentityPhone$outboundSchema.parse(startJourneyIdentityPhone),
|
|
1711
|
-
);
|
|
1712
|
-
}
|
|
1713
|
-
|
|
1714
|
-
/** @internal */
|
|
1715
|
-
export type StartJourneyIdentityEmail$Outbound = {
|
|
1716
|
-
type: string;
|
|
1717
|
-
email: string;
|
|
1718
|
-
};
|
|
1719
|
-
|
|
1720
|
-
/** @internal */
|
|
1721
|
-
export const StartJourneyIdentityEmail$outboundSchema: z.ZodMiniType<
|
|
1722
|
-
StartJourneyIdentityEmail$Outbound,
|
|
1723
|
-
StartJourneyIdentityEmail
|
|
1724
|
-
> = z.object({
|
|
1725
|
-
type: z.string(),
|
|
1726
|
-
email: z.string(),
|
|
1727
|
-
});
|
|
1728
|
-
|
|
1729
|
-
export function startJourneyIdentityEmailToJSON(
|
|
1730
|
-
startJourneyIdentityEmail: StartJourneyIdentityEmail,
|
|
1731
|
-
): string {
|
|
1732
|
-
return JSON.stringify(
|
|
1733
|
-
StartJourneyIdentityEmail$outboundSchema.parse(startJourneyIdentityEmail),
|
|
1734
|
-
);
|
|
1735
|
-
}
|
|
1736
|
-
|
|
1737
|
-
/** @internal */
|
|
1738
|
-
export type StartJourneyIdentitySocial$Outbound = {
|
|
1739
|
-
type: string;
|
|
1740
|
-
identity: string;
|
|
1741
|
-
};
|
|
1742
|
-
|
|
1743
|
-
/** @internal */
|
|
1744
|
-
export const StartJourneyIdentitySocial$outboundSchema: z.ZodMiniType<
|
|
1745
|
-
StartJourneyIdentitySocial$Outbound,
|
|
1746
|
-
StartJourneyIdentitySocial
|
|
1747
|
-
> = z.object({
|
|
1748
|
-
type: z.string(),
|
|
1749
|
-
identity: z.string(),
|
|
1750
|
-
});
|
|
1751
|
-
|
|
1752
|
-
export function startJourneyIdentitySocialToJSON(
|
|
1753
|
-
startJourneyIdentitySocial: StartJourneyIdentitySocial,
|
|
2983
|
+
export function startJourneyPhonePrimaryToJSON(
|
|
2984
|
+
startJourneyPhonePrimary: StartJourneyPhonePrimary,
|
|
1754
2985
|
): string {
|
|
1755
2986
|
return JSON.stringify(
|
|
1756
|
-
|
|
2987
|
+
StartJourneyPhonePrimary$outboundSchema.parse(startJourneyPhonePrimary),
|
|
1757
2988
|
);
|
|
1758
2989
|
}
|
|
1759
2990
|
|
|
1760
2991
|
/** @internal */
|
|
1761
|
-
export type
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
previousAddresses?:
|
|
1775
|
-
| Array<StartJourneyIdentityPreviousAddress$Outbound>
|
|
2992
|
+
export type StartJourneyEntity$Outbound = {
|
|
2993
|
+
id?: string | undefined;
|
|
2994
|
+
type?: string | undefined;
|
|
2995
|
+
name?: string | undefined;
|
|
2996
|
+
aliases?: Array<string> | undefined;
|
|
2997
|
+
businessType?: string | undefined;
|
|
2998
|
+
status?: string | undefined;
|
|
2999
|
+
description?: string | undefined;
|
|
3000
|
+
addresses?: Array<StartJourneyAddressPrimary$Outbound> | undefined;
|
|
3001
|
+
taxIdentifiers?: Array<StartJourneyTaxIdentifier$Outbound> | undefined;
|
|
3002
|
+
companyNumber?: string | undefined;
|
|
3003
|
+
industryClassifications?:
|
|
3004
|
+
| Array<StartJourneyIndustryClassification$Outbound>
|
|
1776
3005
|
| undefined;
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
3006
|
+
registrations?: Array<StartJourneyRegistration$Outbound> | undefined;
|
|
3007
|
+
corporateStructure?: string | undefined;
|
|
3008
|
+
persons?: Array<StartJourneyPerson$Outbound> | undefined;
|
|
3009
|
+
incorporationDate?: string | undefined;
|
|
3010
|
+
dissolutionDate?: string | undefined;
|
|
3011
|
+
phones?: Array<StartJourneyPhonePrimary$Outbound> | undefined;
|
|
3012
|
+
websites?: Array<string> | undefined;
|
|
3013
|
+
headcount?: number | undefined;
|
|
3014
|
+
isNonProfit?: boolean | undefined;
|
|
1783
3015
|
};
|
|
1784
3016
|
|
|
1785
3017
|
/** @internal */
|
|
1786
|
-
export const
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
> = z.object({
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
z.array(z.lazy(() => StartJourneyIdentityRelatedPerson$outboundSchema)),
|
|
1800
|
-
),
|
|
1801
|
-
dateOfBirth: z.optional(z.string()),
|
|
1802
|
-
gender: z.optional(z.string()),
|
|
1803
|
-
currentAddress: z.optional(
|
|
1804
|
-
z.lazy(() => StartJourneyIdentityCurrentAddress$outboundSchema),
|
|
3018
|
+
export const StartJourneyEntity$outboundSchema: z.ZodMiniType<
|
|
3019
|
+
StartJourneyEntity$Outbound,
|
|
3020
|
+
StartJourneyEntity
|
|
3021
|
+
> = z.object({
|
|
3022
|
+
id: z.optional(z.string()),
|
|
3023
|
+
type: z.optional(StartJourneyTypePrimary1$outboundSchema),
|
|
3024
|
+
name: z.optional(z.string()),
|
|
3025
|
+
aliases: z.optional(z.array(z.string())),
|
|
3026
|
+
businessType: z.optional(z.string()),
|
|
3027
|
+
status: z.optional(StartJourneyStatus$outboundSchema),
|
|
3028
|
+
description: z.optional(z.string()),
|
|
3029
|
+
addresses: z.optional(
|
|
3030
|
+
z.array(z.lazy(() => StartJourneyAddressPrimary$outboundSchema)),
|
|
1805
3031
|
),
|
|
1806
|
-
|
|
1807
|
-
z.array(z.lazy(() =>
|
|
3032
|
+
taxIdentifiers: z.optional(
|
|
3033
|
+
z.array(z.lazy(() => StartJourneyTaxIdentifier$outboundSchema)),
|
|
1808
3034
|
),
|
|
1809
|
-
|
|
1810
|
-
|
|
3035
|
+
companyNumber: z.optional(z.string()),
|
|
3036
|
+
industryClassifications: z.optional(
|
|
3037
|
+
z.array(z.lazy(() => StartJourneyIndustryClassification$outboundSchema)),
|
|
1811
3038
|
),
|
|
1812
|
-
|
|
1813
|
-
z.array(z.lazy(() =>
|
|
3039
|
+
registrations: z.optional(
|
|
3040
|
+
z.array(z.lazy(() => StartJourneyRegistration$outboundSchema)),
|
|
1814
3041
|
),
|
|
3042
|
+
corporateStructure: z.optional(z.string()),
|
|
3043
|
+
persons: z.optional(z.array(z.lazy(() => StartJourneyPerson$outboundSchema))),
|
|
3044
|
+
incorporationDate: z.optional(z.string()),
|
|
3045
|
+
dissolutionDate: z.optional(z.string()),
|
|
1815
3046
|
phones: z.optional(
|
|
1816
|
-
z.array(z.lazy(() =>
|
|
1817
|
-
),
|
|
1818
|
-
emails: z.optional(
|
|
1819
|
-
z.array(z.lazy(() => StartJourneyIdentityEmail$outboundSchema)),
|
|
3047
|
+
z.array(z.lazy(() => StartJourneyPhonePrimary$outboundSchema)),
|
|
1820
3048
|
),
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
),
|
|
1824
|
-
mothersMaidenName: z.optional(z.string()),
|
|
3049
|
+
websites: z.optional(z.array(z.string())),
|
|
3050
|
+
headcount: z.optional(z.int()),
|
|
3051
|
+
isNonProfit: z.optional(z.boolean()),
|
|
1825
3052
|
});
|
|
1826
3053
|
|
|
1827
|
-
export function
|
|
1828
|
-
|
|
3054
|
+
export function startJourneyEntityToJSON(
|
|
3055
|
+
startJourneyEntity: StartJourneyEntity,
|
|
1829
3056
|
): string {
|
|
1830
3057
|
return JSON.stringify(
|
|
1831
|
-
|
|
3058
|
+
StartJourneyEntity$outboundSchema.parse(startJourneyEntity),
|
|
1832
3059
|
);
|
|
1833
3060
|
}
|
|
1834
3061
|
|
|
1835
3062
|
/** @internal */
|
|
1836
|
-
export type
|
|
3063
|
+
export type StartJourneyDocumentAddress$Outbound = {
|
|
1837
3064
|
addressString?: string | undefined;
|
|
1838
3065
|
extractedAddressString?: string | undefined;
|
|
1839
3066
|
addressLine1?: string | undefined;
|
|
@@ -1844,9 +3071,9 @@ export type StartJourneyAddress$Outbound = {
|
|
|
1844
3071
|
};
|
|
1845
3072
|
|
|
1846
3073
|
/** @internal */
|
|
1847
|
-
export const
|
|
1848
|
-
|
|
1849
|
-
|
|
3074
|
+
export const StartJourneyDocumentAddress$outboundSchema: z.ZodMiniType<
|
|
3075
|
+
StartJourneyDocumentAddress$Outbound,
|
|
3076
|
+
StartJourneyDocumentAddress
|
|
1850
3077
|
> = z.object({
|
|
1851
3078
|
addressString: z.optional(z.string()),
|
|
1852
3079
|
extractedAddressString: z.optional(z.string()),
|
|
@@ -1857,11 +3084,13 @@ export const StartJourneyAddress$outboundSchema: z.ZodMiniType<
|
|
|
1857
3084
|
postalCode: z.optional(z.string()),
|
|
1858
3085
|
});
|
|
1859
3086
|
|
|
1860
|
-
export function
|
|
1861
|
-
|
|
3087
|
+
export function startJourneyDocumentAddressToJSON(
|
|
3088
|
+
startJourneyDocumentAddress: StartJourneyDocumentAddress,
|
|
1862
3089
|
): string {
|
|
1863
3090
|
return JSON.stringify(
|
|
1864
|
-
|
|
3091
|
+
StartJourneyDocumentAddress$outboundSchema.parse(
|
|
3092
|
+
startJourneyDocumentAddress,
|
|
3093
|
+
),
|
|
1865
3094
|
);
|
|
1866
3095
|
}
|
|
1867
3096
|
|
|
@@ -1898,6 +3127,72 @@ export function startJourneyDocumentDeviceToJSON(
|
|
|
1898
3127
|
);
|
|
1899
3128
|
}
|
|
1900
3129
|
|
|
3130
|
+
/** @internal */
|
|
3131
|
+
export type StartJourneySide1Device$Outbound = {
|
|
3132
|
+
type?: string | undefined;
|
|
3133
|
+
model?: string | undefined;
|
|
3134
|
+
hasContactlessReader?: boolean | undefined;
|
|
3135
|
+
hasMagneticStripeReader?: boolean | undefined;
|
|
3136
|
+
hasCamera?: boolean | undefined;
|
|
3137
|
+
serialNumber?: string | undefined;
|
|
3138
|
+
manufacturer?: string | undefined;
|
|
3139
|
+
};
|
|
3140
|
+
|
|
3141
|
+
/** @internal */
|
|
3142
|
+
export const StartJourneySide1Device$outboundSchema: z.ZodMiniType<
|
|
3143
|
+
StartJourneySide1Device$Outbound,
|
|
3144
|
+
StartJourneySide1Device
|
|
3145
|
+
> = z.object({
|
|
3146
|
+
type: z.optional(z.string()),
|
|
3147
|
+
model: z.optional(z.string()),
|
|
3148
|
+
hasContactlessReader: z.optional(z.boolean()),
|
|
3149
|
+
hasMagneticStripeReader: z.optional(z.boolean()),
|
|
3150
|
+
hasCamera: z.optional(z.boolean()),
|
|
3151
|
+
serialNumber: z.optional(z.string()),
|
|
3152
|
+
manufacturer: z.optional(z.string()),
|
|
3153
|
+
});
|
|
3154
|
+
|
|
3155
|
+
export function startJourneySide1DeviceToJSON(
|
|
3156
|
+
startJourneySide1Device: StartJourneySide1Device,
|
|
3157
|
+
): string {
|
|
3158
|
+
return JSON.stringify(
|
|
3159
|
+
StartJourneySide1Device$outboundSchema.parse(startJourneySide1Device),
|
|
3160
|
+
);
|
|
3161
|
+
}
|
|
3162
|
+
|
|
3163
|
+
/** @internal */
|
|
3164
|
+
export type StartJourneySide2Device$Outbound = {
|
|
3165
|
+
type?: string | undefined;
|
|
3166
|
+
model?: string | undefined;
|
|
3167
|
+
hasContactlessReader?: boolean | undefined;
|
|
3168
|
+
hasMagneticStripeReader?: boolean | undefined;
|
|
3169
|
+
hasCamera?: boolean | undefined;
|
|
3170
|
+
serialNumber?: string | undefined;
|
|
3171
|
+
manufacturer?: string | undefined;
|
|
3172
|
+
};
|
|
3173
|
+
|
|
3174
|
+
/** @internal */
|
|
3175
|
+
export const StartJourneySide2Device$outboundSchema: z.ZodMiniType<
|
|
3176
|
+
StartJourneySide2Device$Outbound,
|
|
3177
|
+
StartJourneySide2Device
|
|
3178
|
+
> = z.object({
|
|
3179
|
+
type: z.optional(z.string()),
|
|
3180
|
+
model: z.optional(z.string()),
|
|
3181
|
+
hasContactlessReader: z.optional(z.boolean()),
|
|
3182
|
+
hasMagneticStripeReader: z.optional(z.boolean()),
|
|
3183
|
+
hasCamera: z.optional(z.boolean()),
|
|
3184
|
+
serialNumber: z.optional(z.string()),
|
|
3185
|
+
manufacturer: z.optional(z.string()),
|
|
3186
|
+
});
|
|
3187
|
+
|
|
3188
|
+
export function startJourneySide2DeviceToJSON(
|
|
3189
|
+
startJourneySide2Device: StartJourneySide2Device,
|
|
3190
|
+
): string {
|
|
3191
|
+
return JSON.stringify(
|
|
3192
|
+
StartJourneySide2Device$outboundSchema.parse(startJourneySide2Device),
|
|
3193
|
+
);
|
|
3194
|
+
}
|
|
3195
|
+
|
|
1901
3196
|
/** @internal */
|
|
1902
3197
|
export const StartJourneyName$outboundSchema: z.ZodMiniEnum<
|
|
1903
3198
|
typeof StartJourneyName
|
|
@@ -2584,6 +3879,7 @@ export type StartJourneyDocumentAlias$Outbound = {
|
|
|
2584
3879
|
middleNames?: Array<string> | undefined;
|
|
2585
3880
|
lastNames?: Array<string> | undefined;
|
|
2586
3881
|
lastNamesAtBirth?: Array<string> | undefined;
|
|
3882
|
+
fullName?: string | undefined;
|
|
2587
3883
|
};
|
|
2588
3884
|
|
|
2589
3885
|
/** @internal */
|
|
@@ -2596,6 +3892,7 @@ export const StartJourneyDocumentAlias$outboundSchema: z.ZodMiniType<
|
|
|
2596
3892
|
middleNames: z.optional(z.array(z.string())),
|
|
2597
3893
|
lastNames: z.optional(z.array(z.string())),
|
|
2598
3894
|
lastNamesAtBirth: z.optional(z.array(z.string())),
|
|
3895
|
+
fullName: z.optional(z.string()),
|
|
2599
3896
|
});
|
|
2600
3897
|
|
|
2601
3898
|
export function startJourneyDocumentAliasToJSON(
|
|
@@ -2785,8 +4082,8 @@ export type StartJourneyDocumentPreviousAddress$Outbound = {
|
|
|
2785
4082
|
subAdministrativeArea?: string | undefined;
|
|
2786
4083
|
organization?: string | undefined;
|
|
2787
4084
|
location?: StartJourneyDocumentPreviousAddressLocation$Outbound | undefined;
|
|
2788
|
-
fromDate
|
|
2789
|
-
toDate
|
|
4085
|
+
fromDate?: string | undefined;
|
|
4086
|
+
toDate?: string | undefined;
|
|
2790
4087
|
};
|
|
2791
4088
|
|
|
2792
4089
|
/** @internal */
|
|
@@ -2814,8 +4111,8 @@ export const StartJourneyDocumentPreviousAddress$outboundSchema: z.ZodMiniType<
|
|
|
2814
4111
|
location: z.optional(
|
|
2815
4112
|
z.lazy(() => StartJourneyDocumentPreviousAddressLocation$outboundSchema),
|
|
2816
4113
|
),
|
|
2817
|
-
fromDate: z.string(),
|
|
2818
|
-
toDate: z.string(),
|
|
4114
|
+
fromDate: z.optional(z.string()),
|
|
4115
|
+
toDate: z.optional(z.string()),
|
|
2819
4116
|
});
|
|
2820
4117
|
|
|
2821
4118
|
export function startJourneyDocumentPreviousAddressToJSON(
|
|
@@ -3037,6 +4334,7 @@ export type StartJourneyDocumentSubject$Outbound = {
|
|
|
3037
4334
|
emails?: Array<StartJourneyDocumentEmail$Outbound> | undefined;
|
|
3038
4335
|
socials?: Array<StartJourneyDocumentSocial$Outbound> | undefined;
|
|
3039
4336
|
mothersMaidenName?: string | undefined;
|
|
4337
|
+
nationality?: string | undefined;
|
|
3040
4338
|
};
|
|
3041
4339
|
|
|
3042
4340
|
/** @internal */
|
|
@@ -3079,6 +4377,7 @@ export const StartJourneyDocumentSubject$outboundSchema: z.ZodMiniType<
|
|
|
3079
4377
|
z.array(z.lazy(() => StartJourneyDocumentSocial$outboundSchema)),
|
|
3080
4378
|
),
|
|
3081
4379
|
mothersMaidenName: z.optional(z.string()),
|
|
4380
|
+
nationality: z.optional(z.string()),
|
|
3082
4381
|
});
|
|
3083
4382
|
|
|
3084
4383
|
export function startJourneyDocumentSubjectToJSON(
|
|
@@ -3094,7 +4393,7 @@ export function startJourneyDocumentSubjectToJSON(
|
|
|
3094
4393
|
/** @internal */
|
|
3095
4394
|
export type StartJourneyDocument$Outbound = {
|
|
3096
4395
|
oneDBarcode?: string | undefined;
|
|
3097
|
-
address?:
|
|
4396
|
+
address?: StartJourneyDocumentAddress$Outbound | undefined;
|
|
3098
4397
|
applicationDate?: string | undefined;
|
|
3099
4398
|
applicationNumber?: string | undefined;
|
|
3100
4399
|
dateOfBirth?: string | undefined;
|
|
@@ -3166,13 +4465,15 @@ export type StartJourneyDocument$Outbound = {
|
|
|
3166
4465
|
cardNumber?: string | undefined;
|
|
3167
4466
|
issuerCountryCode?: string | undefined;
|
|
3168
4467
|
id?: string | undefined;
|
|
3169
|
-
type
|
|
4468
|
+
type: string;
|
|
3170
4469
|
category?: string | undefined;
|
|
3171
4470
|
subtype?: string | undefined;
|
|
3172
4471
|
format?: string | undefined;
|
|
3173
4472
|
device?: StartJourneyDocumentDevice$Outbound | undefined;
|
|
3174
4473
|
side1Image?: string | undefined;
|
|
3175
4474
|
side2Image?: string | undefined;
|
|
4475
|
+
side1Device?: StartJourneySide1Device$Outbound | undefined;
|
|
4476
|
+
side2Device?: StartJourneySide2Device$Outbound | undefined;
|
|
3176
4477
|
chip?: StartJourneyChip$Outbound | undefined;
|
|
3177
4478
|
classification?: StartJourneyClassification$Outbound | undefined;
|
|
3178
4479
|
extraction?: StartJourneyExtraction$Outbound | undefined;
|
|
@@ -3180,8 +4481,26 @@ export type StartJourneyDocument$Outbound = {
|
|
|
3180
4481
|
subType?: string | undefined;
|
|
3181
4482
|
number?: string | undefined;
|
|
3182
4483
|
expiryDate?: string | undefined;
|
|
4484
|
+
cardType?: string | undefined;
|
|
4485
|
+
expiryMonth?: string | undefined;
|
|
4486
|
+
cardColour?: string | undefined;
|
|
4487
|
+
cardStatus?: string | undefined;
|
|
3183
4488
|
subject?: StartJourneyDocumentSubject$Outbound | undefined;
|
|
3184
4489
|
country?: string | undefined;
|
|
4490
|
+
certificateFormat?: string | undefined;
|
|
4491
|
+
registrationNumber?: string | undefined;
|
|
4492
|
+
registrationDate?: string | undefined;
|
|
4493
|
+
registrationYear?: string | undefined;
|
|
4494
|
+
partyRole?: string | undefined;
|
|
4495
|
+
dateOfEvent?: string | undefined;
|
|
4496
|
+
previousFirstName?: string | undefined;
|
|
4497
|
+
previousMiddleName?: string | undefined;
|
|
4498
|
+
previousSurname?: string | undefined;
|
|
4499
|
+
individualReferenceNumber?: string | undefined;
|
|
4500
|
+
nameLine1?: string | undefined;
|
|
4501
|
+
nameLine2?: string | undefined;
|
|
4502
|
+
nameLine3?: string | undefined;
|
|
4503
|
+
nameLine4?: string | undefined;
|
|
3185
4504
|
};
|
|
3186
4505
|
|
|
3187
4506
|
/** @internal */
|
|
@@ -3190,7 +4509,7 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
|
|
|
3190
4509
|
StartJourneyDocument
|
|
3191
4510
|
> = z.object({
|
|
3192
4511
|
oneDBarcode: z.optional(z.string()),
|
|
3193
|
-
address: z.optional(z.lazy(() =>
|
|
4512
|
+
address: z.optional(z.lazy(() => StartJourneyDocumentAddress$outboundSchema)),
|
|
3194
4513
|
applicationDate: z.optional(z.string()),
|
|
3195
4514
|
applicationNumber: z.optional(z.string()),
|
|
3196
4515
|
dateOfBirth: z.optional(z.string()),
|
|
@@ -3262,13 +4581,15 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
|
|
|
3262
4581
|
cardNumber: z.optional(z.string()),
|
|
3263
4582
|
issuerCountryCode: z.optional(z.string()),
|
|
3264
4583
|
id: z.optional(z.string()),
|
|
3265
|
-
type: z.
|
|
4584
|
+
type: z.string(),
|
|
3266
4585
|
category: z.optional(z.string()),
|
|
3267
4586
|
subtype: z.optional(z.string()),
|
|
3268
4587
|
format: z.optional(z.string()),
|
|
3269
4588
|
device: z.optional(z.lazy(() => StartJourneyDocumentDevice$outboundSchema)),
|
|
3270
4589
|
side1Image: z.optional(z.string()),
|
|
3271
4590
|
side2Image: z.optional(z.string()),
|
|
4591
|
+
side1Device: z.optional(z.lazy(() => StartJourneySide1Device$outboundSchema)),
|
|
4592
|
+
side2Device: z.optional(z.lazy(() => StartJourneySide2Device$outboundSchema)),
|
|
3272
4593
|
chip: z.optional(z.lazy(() => StartJourneyChip$outboundSchema)),
|
|
3273
4594
|
classification: z.optional(
|
|
3274
4595
|
z.lazy(() => StartJourneyClassification$outboundSchema),
|
|
@@ -3278,8 +4599,26 @@ export const StartJourneyDocument$outboundSchema: z.ZodMiniType<
|
|
|
3278
4599
|
subType: z.optional(z.string()),
|
|
3279
4600
|
number: z.optional(z.string()),
|
|
3280
4601
|
expiryDate: z.optional(z.string()),
|
|
4602
|
+
cardType: z.optional(z.string()),
|
|
4603
|
+
expiryMonth: z.optional(z.string()),
|
|
4604
|
+
cardColour: z.optional(z.string()),
|
|
4605
|
+
cardStatus: z.optional(z.string()),
|
|
3281
4606
|
subject: z.optional(z.lazy(() => StartJourneyDocumentSubject$outboundSchema)),
|
|
3282
4607
|
country: z.optional(z.string()),
|
|
4608
|
+
certificateFormat: z.optional(z.string()),
|
|
4609
|
+
registrationNumber: z.optional(z.string()),
|
|
4610
|
+
registrationDate: z.optional(z.string()),
|
|
4611
|
+
registrationYear: z.optional(z.string()),
|
|
4612
|
+
partyRole: z.optional(z.string()),
|
|
4613
|
+
dateOfEvent: z.optional(z.string()),
|
|
4614
|
+
previousFirstName: z.optional(z.string()),
|
|
4615
|
+
previousMiddleName: z.optional(z.string()),
|
|
4616
|
+
previousSurname: z.optional(z.string()),
|
|
4617
|
+
individualReferenceNumber: z.optional(z.string()),
|
|
4618
|
+
nameLine1: z.optional(z.string()),
|
|
4619
|
+
nameLine2: z.optional(z.string()),
|
|
4620
|
+
nameLine3: z.optional(z.string()),
|
|
4621
|
+
nameLine4: z.optional(z.string()),
|
|
3283
4622
|
});
|
|
3284
4623
|
|
|
3285
4624
|
export function startJourneyDocumentToJSON(
|
|
@@ -3290,6 +4629,63 @@ export function startJourneyDocumentToJSON(
|
|
|
3290
4629
|
);
|
|
3291
4630
|
}
|
|
3292
4631
|
|
|
4632
|
+
/** @internal */
|
|
4633
|
+
export const StartJourneyBiometricType$outboundSchema: z.ZodMiniEnum<
|
|
4634
|
+
typeof StartJourneyBiometricType
|
|
4635
|
+
> = z.enum(StartJourneyBiometricType);
|
|
4636
|
+
|
|
4637
|
+
/** @internal */
|
|
4638
|
+
export type StartJourneyBiometricStoredFace$Outbound = {
|
|
4639
|
+
id?: string | undefined;
|
|
4640
|
+
type: string;
|
|
4641
|
+
templateReference: string;
|
|
4642
|
+
};
|
|
4643
|
+
|
|
4644
|
+
/** @internal */
|
|
4645
|
+
export const StartJourneyBiometricStoredFace$outboundSchema: z.ZodMiniType<
|
|
4646
|
+
StartJourneyBiometricStoredFace$Outbound,
|
|
4647
|
+
StartJourneyBiometricStoredFace
|
|
4648
|
+
> = z.object({
|
|
4649
|
+
id: z.optional(z.string()),
|
|
4650
|
+
type: StartJourneyBiometricType$outboundSchema,
|
|
4651
|
+
templateReference: z.string(),
|
|
4652
|
+
});
|
|
4653
|
+
|
|
4654
|
+
export function startJourneyBiometricStoredFaceToJSON(
|
|
4655
|
+
startJourneyBiometricStoredFace: StartJourneyBiometricStoredFace,
|
|
4656
|
+
): string {
|
|
4657
|
+
return JSON.stringify(
|
|
4658
|
+
StartJourneyBiometricStoredFace$outboundSchema.parse(
|
|
4659
|
+
startJourneyBiometricStoredFace,
|
|
4660
|
+
),
|
|
4661
|
+
);
|
|
4662
|
+
}
|
|
4663
|
+
|
|
4664
|
+
/** @internal */
|
|
4665
|
+
export type StartJourneyBiometric5$Outbound = {
|
|
4666
|
+
id?: string | undefined;
|
|
4667
|
+
type?: string | undefined;
|
|
4668
|
+
anchorImage: string;
|
|
4669
|
+
};
|
|
4670
|
+
|
|
4671
|
+
/** @internal */
|
|
4672
|
+
export const StartJourneyBiometric5$outboundSchema: z.ZodMiniType<
|
|
4673
|
+
StartJourneyBiometric5$Outbound,
|
|
4674
|
+
StartJourneyBiometric5
|
|
4675
|
+
> = z.object({
|
|
4676
|
+
id: z.optional(z.string()),
|
|
4677
|
+
type: z.optional(z.string()),
|
|
4678
|
+
anchorImage: z.string(),
|
|
4679
|
+
});
|
|
4680
|
+
|
|
4681
|
+
export function startJourneyBiometric5ToJSON(
|
|
4682
|
+
startJourneyBiometric5: StartJourneyBiometric5,
|
|
4683
|
+
): string {
|
|
4684
|
+
return JSON.stringify(
|
|
4685
|
+
StartJourneyBiometric5$outboundSchema.parse(startJourneyBiometric5),
|
|
4686
|
+
);
|
|
4687
|
+
}
|
|
4688
|
+
|
|
3293
4689
|
/** @internal */
|
|
3294
4690
|
export type StartJourneyBiometric4$Outbound = {
|
|
3295
4691
|
id?: string | undefined;
|
|
@@ -3400,8 +4796,10 @@ export function startJourneyBiometric1ToJSON(
|
|
|
3400
4796
|
export type StartJourneyBiometricUnion$Outbound =
|
|
3401
4797
|
| StartJourneyBiometric1$Outbound
|
|
3402
4798
|
| StartJourneyBiometric2$Outbound
|
|
4799
|
+
| StartJourneyBiometricStoredFace$Outbound
|
|
3403
4800
|
| StartJourneyBiometric3$Outbound
|
|
3404
|
-
| StartJourneyBiometric4$Outbound
|
|
4801
|
+
| StartJourneyBiometric4$Outbound
|
|
4802
|
+
| StartJourneyBiometric5$Outbound;
|
|
3405
4803
|
|
|
3406
4804
|
/** @internal */
|
|
3407
4805
|
export const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<
|
|
@@ -3410,8 +4808,10 @@ export const StartJourneyBiometricUnion$outboundSchema: z.ZodMiniType<
|
|
|
3410
4808
|
> = smartUnion([
|
|
3411
4809
|
z.lazy(() => StartJourneyBiometric1$outboundSchema),
|
|
3412
4810
|
z.lazy(() => StartJourneyBiometric2$outboundSchema),
|
|
4811
|
+
z.lazy(() => StartJourneyBiometricStoredFace$outboundSchema),
|
|
3413
4812
|
z.lazy(() => StartJourneyBiometric3$outboundSchema),
|
|
3414
4813
|
z.lazy(() => StartJourneyBiometric4$outboundSchema),
|
|
4814
|
+
z.lazy(() => StartJourneyBiometric5$outboundSchema),
|
|
3415
4815
|
]);
|
|
3416
4816
|
|
|
3417
4817
|
export function startJourneyBiometricUnionToJSON(
|
|
@@ -3425,8 +4825,8 @@ export function startJourneyBiometricUnionToJSON(
|
|
|
3425
4825
|
/** @internal */
|
|
3426
4826
|
export type StartJourneyUser$Outbound = {
|
|
3427
4827
|
id: string;
|
|
3428
|
-
email
|
|
3429
|
-
domain
|
|
4828
|
+
email?: string | undefined;
|
|
4829
|
+
domain?: string | undefined;
|
|
3430
4830
|
};
|
|
3431
4831
|
|
|
3432
4832
|
/** @internal */
|
|
@@ -3435,8 +4835,8 @@ export const StartJourneyUser$outboundSchema: z.ZodMiniType<
|
|
|
3435
4835
|
StartJourneyUser
|
|
3436
4836
|
> = z.object({
|
|
3437
4837
|
id: z.string(),
|
|
3438
|
-
email: z.string(),
|
|
3439
|
-
domain: z.string(),
|
|
4838
|
+
email: z.optional(z.string()),
|
|
4839
|
+
domain: z.optional(z.string()),
|
|
3440
4840
|
});
|
|
3441
4841
|
|
|
3442
4842
|
export function startJourneyUserToJSON(
|
|
@@ -3622,6 +5022,9 @@ export function startJourneySessionAuthToJSON(
|
|
|
3622
5022
|
|
|
3623
5023
|
/** @internal */
|
|
3624
5024
|
export type StartJourneySession$Outbound = {
|
|
5025
|
+
id?: string | undefined;
|
|
5026
|
+
type?: string | undefined;
|
|
5027
|
+
provider?: string | undefined;
|
|
3625
5028
|
user?: StartJourneyUser$Outbound | undefined;
|
|
3626
5029
|
client?: StartJourneyClient$Outbound | undefined;
|
|
3627
5030
|
device?: StartJourneySessionDevice$Outbound | undefined;
|
|
@@ -3636,6 +5039,9 @@ export const StartJourneySession$outboundSchema: z.ZodMiniType<
|
|
|
3636
5039
|
StartJourneySession$Outbound,
|
|
3637
5040
|
StartJourneySession
|
|
3638
5041
|
> = z.object({
|
|
5042
|
+
id: z.optional(z.string()),
|
|
5043
|
+
type: z.optional(z.string()),
|
|
5044
|
+
provider: z.optional(z.string()),
|
|
3639
5045
|
user: z.optional(z.lazy(() => StartJourneyUser$outboundSchema)),
|
|
3640
5046
|
client: z.optional(z.lazy(() => StartJourneyClient$outboundSchema)),
|
|
3641
5047
|
device: z.optional(z.lazy(() => StartJourneySessionDevice$outboundSchema)),
|
|
@@ -3742,21 +5148,119 @@ export function startJourneyAccountToJSON(
|
|
|
3742
5148
|
);
|
|
3743
5149
|
}
|
|
3744
5150
|
|
|
5151
|
+
/** @internal */
|
|
5152
|
+
export type StartJourneyChoice$Outbound = {
|
|
5153
|
+
label: string;
|
|
5154
|
+
text: string;
|
|
5155
|
+
};
|
|
5156
|
+
|
|
5157
|
+
/** @internal */
|
|
5158
|
+
export const StartJourneyChoice$outboundSchema: z.ZodMiniType<
|
|
5159
|
+
StartJourneyChoice$Outbound,
|
|
5160
|
+
StartJourneyChoice
|
|
5161
|
+
> = z.object({
|
|
5162
|
+
label: z.string(),
|
|
5163
|
+
text: z.string(),
|
|
5164
|
+
});
|
|
5165
|
+
|
|
5166
|
+
export function startJourneyChoiceToJSON(
|
|
5167
|
+
startJourneyChoice: StartJourneyChoice,
|
|
5168
|
+
): string {
|
|
5169
|
+
return JSON.stringify(
|
|
5170
|
+
StartJourneyChoice$outboundSchema.parse(startJourneyChoice),
|
|
5171
|
+
);
|
|
5172
|
+
}
|
|
5173
|
+
|
|
5174
|
+
/** @internal */
|
|
5175
|
+
export type StartJourneyQuestion$Outbound = {
|
|
5176
|
+
id: number;
|
|
5177
|
+
questionText: string;
|
|
5178
|
+
helpText?: string | undefined;
|
|
5179
|
+
choices: Array<StartJourneyChoice$Outbound>;
|
|
5180
|
+
};
|
|
5181
|
+
|
|
5182
|
+
/** @internal */
|
|
5183
|
+
export const StartJourneyQuestion$outboundSchema: z.ZodMiniType<
|
|
5184
|
+
StartJourneyQuestion$Outbound,
|
|
5185
|
+
StartJourneyQuestion
|
|
5186
|
+
> = z.object({
|
|
5187
|
+
id: z.int(),
|
|
5188
|
+
questionText: z.string(),
|
|
5189
|
+
helpText: z.optional(z.string()),
|
|
5190
|
+
choices: z.array(z.lazy(() => StartJourneyChoice$outboundSchema)),
|
|
5191
|
+
});
|
|
5192
|
+
|
|
5193
|
+
export function startJourneyQuestionToJSON(
|
|
5194
|
+
startJourneyQuestion: StartJourneyQuestion,
|
|
5195
|
+
): string {
|
|
5196
|
+
return JSON.stringify(
|
|
5197
|
+
StartJourneyQuestion$outboundSchema.parse(startJourneyQuestion),
|
|
5198
|
+
);
|
|
5199
|
+
}
|
|
5200
|
+
|
|
5201
|
+
/** @internal */
|
|
5202
|
+
export type StartJourneyAnswer$Outbound = {
|
|
5203
|
+
id: number;
|
|
5204
|
+
choices: Array<string>;
|
|
5205
|
+
};
|
|
5206
|
+
|
|
5207
|
+
/** @internal */
|
|
5208
|
+
export const StartJourneyAnswer$outboundSchema: z.ZodMiniType<
|
|
5209
|
+
StartJourneyAnswer$Outbound,
|
|
5210
|
+
StartJourneyAnswer
|
|
5211
|
+
> = z.object({
|
|
5212
|
+
id: z.int(),
|
|
5213
|
+
choices: z.array(z.string()),
|
|
5214
|
+
});
|
|
5215
|
+
|
|
5216
|
+
export function startJourneyAnswerToJSON(
|
|
5217
|
+
startJourneyAnswer: StartJourneyAnswer,
|
|
5218
|
+
): string {
|
|
5219
|
+
return JSON.stringify(
|
|
5220
|
+
StartJourneyAnswer$outboundSchema.parse(startJourneyAnswer),
|
|
5221
|
+
);
|
|
5222
|
+
}
|
|
5223
|
+
|
|
5224
|
+
/** @internal */
|
|
5225
|
+
export type StartJourneyKba$Outbound = {
|
|
5226
|
+
questions: Array<StartJourneyQuestion$Outbound>;
|
|
5227
|
+
answers: Array<StartJourneyAnswer$Outbound>;
|
|
5228
|
+
};
|
|
5229
|
+
|
|
5230
|
+
/** @internal */
|
|
5231
|
+
export const StartJourneyKba$outboundSchema: z.ZodMiniType<
|
|
5232
|
+
StartJourneyKba$Outbound,
|
|
5233
|
+
StartJourneyKba
|
|
5234
|
+
> = z.object({
|
|
5235
|
+
questions: z.array(z.lazy(() => StartJourneyQuestion$outboundSchema)),
|
|
5236
|
+
answers: z.array(z.lazy(() => StartJourneyAnswer$outboundSchema)),
|
|
5237
|
+
});
|
|
5238
|
+
|
|
5239
|
+
export function startJourneyKbaToJSON(
|
|
5240
|
+
startJourneyKba: StartJourneyKba,
|
|
5241
|
+
): string {
|
|
5242
|
+
return JSON.stringify(StartJourneyKba$outboundSchema.parse(startJourneyKba));
|
|
5243
|
+
}
|
|
5244
|
+
|
|
3745
5245
|
/** @internal */
|
|
3746
5246
|
export type StartJourneySubject$Outbound = {
|
|
3747
5247
|
identity?: StartJourneyIdentity$Outbound | undefined;
|
|
5248
|
+
entities?: Array<StartJourneyEntity$Outbound> | undefined;
|
|
3748
5249
|
documents?: Array<StartJourneyDocument$Outbound> | undefined;
|
|
3749
5250
|
biometrics?:
|
|
3750
5251
|
| Array<
|
|
3751
5252
|
| StartJourneyBiometric1$Outbound
|
|
3752
5253
|
| StartJourneyBiometric2$Outbound
|
|
5254
|
+
| StartJourneyBiometricStoredFace$Outbound
|
|
3753
5255
|
| StartJourneyBiometric3$Outbound
|
|
3754
5256
|
| StartJourneyBiometric4$Outbound
|
|
5257
|
+
| StartJourneyBiometric5$Outbound
|
|
3755
5258
|
>
|
|
3756
5259
|
| undefined;
|
|
3757
5260
|
sessions?: Array<StartJourneySession$Outbound> | undefined;
|
|
3758
5261
|
consent?: Array<StartJourneyConsent$Outbound> | undefined;
|
|
3759
5262
|
accounts?: Array<StartJourneyAccount$Outbound> | undefined;
|
|
5263
|
+
kba?: StartJourneyKba$Outbound | undefined;
|
|
3760
5264
|
uid?: string | undefined;
|
|
3761
5265
|
};
|
|
3762
5266
|
|
|
@@ -3766,6 +5270,9 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
|
|
|
3766
5270
|
StartJourneySubject
|
|
3767
5271
|
> = z.object({
|
|
3768
5272
|
identity: z.optional(z.lazy(() => StartJourneyIdentity$outboundSchema)),
|
|
5273
|
+
entities: z.optional(
|
|
5274
|
+
z.array(z.lazy(() => StartJourneyEntity$outboundSchema)),
|
|
5275
|
+
),
|
|
3769
5276
|
documents: z.optional(
|
|
3770
5277
|
z.array(z.lazy(() => StartJourneyDocument$outboundSchema)),
|
|
3771
5278
|
),
|
|
@@ -3775,8 +5282,10 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
|
|
|
3775
5282
|
z.lazy(() =>
|
|
3776
5283
|
StartJourneyBiometric2$outboundSchema
|
|
3777
5284
|
),
|
|
5285
|
+
z.lazy(() => StartJourneyBiometricStoredFace$outboundSchema),
|
|
3778
5286
|
z.lazy(() => StartJourneyBiometric3$outboundSchema),
|
|
3779
5287
|
z.lazy(() => StartJourneyBiometric4$outboundSchema),
|
|
5288
|
+
z.lazy(() => StartJourneyBiometric5$outboundSchema),
|
|
3780
5289
|
])),
|
|
3781
5290
|
),
|
|
3782
5291
|
sessions: z.optional(
|
|
@@ -3788,6 +5297,7 @@ export const StartJourneySubject$outboundSchema: z.ZodMiniType<
|
|
|
3788
5297
|
accounts: z.optional(
|
|
3789
5298
|
z.array(z.lazy(() => StartJourneyAccount$outboundSchema)),
|
|
3790
5299
|
),
|
|
5300
|
+
kba: z.optional(z.lazy(() => StartJourneyKba$outboundSchema)),
|
|
3791
5301
|
uid: z.optional(z.string()),
|
|
3792
5302
|
});
|
|
3793
5303
|
|
|
@@ -3800,110 +5310,172 @@ export function startJourneySubjectToJSON(
|
|
|
3800
5310
|
}
|
|
3801
5311
|
|
|
3802
5312
|
/** @internal */
|
|
3803
|
-
export
|
|
3804
|
-
|
|
3805
|
-
|
|
5313
|
+
export const ResumeMode$outboundSchema: z.ZodMiniEnum<typeof ResumeMode> = z
|
|
5314
|
+
.enum(ResumeMode);
|
|
5315
|
+
|
|
5316
|
+
/** @internal */
|
|
5317
|
+
export type LinkConfig$Outbound = {
|
|
5318
|
+
ttlMinutes?: number | undefined;
|
|
5319
|
+
resumeMode?: string | undefined;
|
|
5320
|
+
resumeExpiryMinutes?: number | undefined;
|
|
3806
5321
|
};
|
|
3807
5322
|
|
|
3808
5323
|
/** @internal */
|
|
3809
|
-
export const
|
|
3810
|
-
|
|
3811
|
-
|
|
5324
|
+
export const LinkConfig$outboundSchema: z.ZodMiniType<
|
|
5325
|
+
LinkConfig$Outbound,
|
|
5326
|
+
LinkConfig
|
|
3812
5327
|
> = z.object({
|
|
3813
|
-
|
|
3814
|
-
|
|
5328
|
+
ttlMinutes: z.optional(z.int()),
|
|
5329
|
+
resumeMode: z.optional(ResumeMode$outboundSchema),
|
|
5330
|
+
resumeExpiryMinutes: z.optional(z.int()),
|
|
3815
5331
|
});
|
|
3816
5332
|
|
|
3817
|
-
export function
|
|
3818
|
-
|
|
3819
|
-
): string {
|
|
3820
|
-
return JSON.stringify(
|
|
3821
|
-
StartJourneyContext$outboundSchema.parse(startJourneyContext),
|
|
3822
|
-
);
|
|
5333
|
+
export function linkConfigToJSON(linkConfig: LinkConfig): string {
|
|
5334
|
+
return JSON.stringify(LinkConfig$outboundSchema.parse(linkConfig));
|
|
3823
5335
|
}
|
|
3824
5336
|
|
|
3825
5337
|
/** @internal */
|
|
3826
|
-
export type
|
|
3827
|
-
|
|
3828
|
-
context?: StartJourneyContext$Outbound | undefined;
|
|
3829
|
-
data?: { [k: string]: any } | undefined;
|
|
5338
|
+
export type Overlay$Outbound = {
|
|
5339
|
+
version: string;
|
|
3830
5340
|
};
|
|
3831
5341
|
|
|
3832
5342
|
/** @internal */
|
|
3833
|
-
export const
|
|
3834
|
-
|
|
3835
|
-
|
|
3836
|
-
|
|
3837
|
-
resourceId: z.string(),
|
|
3838
|
-
context: z.optional(z.lazy(() => StartJourneyContext$outboundSchema)),
|
|
3839
|
-
data: z.optional(z.record(z.string(), z.any())),
|
|
3840
|
-
});
|
|
5343
|
+
export const Overlay$outboundSchema: z.ZodMiniType<Overlay$Outbound, Overlay> =
|
|
5344
|
+
z.object({
|
|
5345
|
+
version: z.string(),
|
|
5346
|
+
});
|
|
3841
5347
|
|
|
3842
|
-
export function
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
|
|
5348
|
+
export function overlayToJSON(overlay: Overlay): string {
|
|
5349
|
+
return JSON.stringify(Overlay$outboundSchema.parse(overlay));
|
|
5350
|
+
}
|
|
5351
|
+
|
|
5352
|
+
/** @internal */
|
|
5353
|
+
export type Config$Outbound = {
|
|
5354
|
+
delivery: string;
|
|
5355
|
+
branding?: any | undefined;
|
|
5356
|
+
assisted?: boolean | undefined;
|
|
5357
|
+
inlineResult?: boolean | undefined;
|
|
5358
|
+
syncWaitSeconds?: number | undefined;
|
|
5359
|
+
linkConfig?: LinkConfig$Outbound | undefined;
|
|
5360
|
+
overlay?: Overlay$Outbound | undefined;
|
|
5361
|
+
[additionalProperties: string]: unknown;
|
|
5362
|
+
};
|
|
5363
|
+
|
|
5364
|
+
/** @internal */
|
|
5365
|
+
export const Config$outboundSchema: z.ZodMiniType<Config$Outbound, Config> = z
|
|
5366
|
+
.catchall(
|
|
5367
|
+
z.object({
|
|
5368
|
+
delivery: z.string(),
|
|
5369
|
+
branding: z.optional(z.any()),
|
|
5370
|
+
assisted: z.optional(z.boolean()),
|
|
5371
|
+
inlineResult: z.optional(z.boolean()),
|
|
5372
|
+
syncWaitSeconds: z.optional(z.int()),
|
|
5373
|
+
linkConfig: z.optional(z.lazy(() => LinkConfig$outboundSchema)),
|
|
5374
|
+
overlay: z.optional(z.lazy(() => Overlay$outboundSchema)),
|
|
5375
|
+
}),
|
|
5376
|
+
z.any(),
|
|
3847
5377
|
);
|
|
5378
|
+
|
|
5379
|
+
export function configToJSON(config: Config): string {
|
|
5380
|
+
return JSON.stringify(Config$outboundSchema.parse(config));
|
|
3848
5381
|
}
|
|
3849
5382
|
|
|
3850
5383
|
/** @internal */
|
|
3851
|
-
export
|
|
3852
|
-
|
|
3853
|
-
|
|
5384
|
+
export type StartJourneyContext$Outbound = {
|
|
5385
|
+
subject?: StartJourneySubject$Outbound | undefined;
|
|
5386
|
+
config: Config$Outbound;
|
|
5387
|
+
[additionalProperties: string]: unknown;
|
|
5388
|
+
};
|
|
5389
|
+
|
|
5390
|
+
/** @internal */
|
|
5391
|
+
export const StartJourneyContext$outboundSchema: z.ZodMiniType<
|
|
5392
|
+
StartJourneyContext$Outbound,
|
|
5393
|
+
StartJourneyContext
|
|
3854
5394
|
> = z.catchall(
|
|
3855
5395
|
z.object({
|
|
3856
|
-
|
|
5396
|
+
subject: z.optional(z.lazy(() => StartJourneySubject$outboundSchema)),
|
|
5397
|
+
config: z.lazy(() => Config$outboundSchema),
|
|
3857
5398
|
}),
|
|
3858
5399
|
z.any(),
|
|
3859
5400
|
);
|
|
3860
5401
|
|
|
3861
|
-
export function
|
|
3862
|
-
|
|
3863
|
-
):
|
|
3864
|
-
return
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
5402
|
+
export function startJourneyContextToJSON(
|
|
5403
|
+
startJourneyContext: StartJourneyContext,
|
|
5404
|
+
): string {
|
|
5405
|
+
return JSON.stringify(
|
|
5406
|
+
StartJourneyContext$outboundSchema.parse(startJourneyContext),
|
|
5407
|
+
);
|
|
5408
|
+
}
|
|
5409
|
+
|
|
5410
|
+
/** @internal */
|
|
5411
|
+
export type Modules$Outbound = {
|
|
5412
|
+
outcome: string;
|
|
5413
|
+
advice?: { [k: string]: any } | undefined;
|
|
5414
|
+
[additionalProperties: string]: unknown;
|
|
5415
|
+
};
|
|
5416
|
+
|
|
5417
|
+
/** @internal */
|
|
5418
|
+
export const Modules$outboundSchema: z.ZodMiniType<Modules$Outbound, Modules> =
|
|
5419
|
+
z.catchall(
|
|
5420
|
+
z.object({
|
|
5421
|
+
outcome: z.string(),
|
|
5422
|
+
advice: z.optional(z.record(z.string(), z.any())),
|
|
5423
|
+
}),
|
|
5424
|
+
z.any(),
|
|
3868
5425
|
);
|
|
5426
|
+
|
|
5427
|
+
export function modulesToJSON(modules: Modules): string {
|
|
5428
|
+
return JSON.stringify(Modules$outboundSchema.parse(modules));
|
|
3869
5429
|
}
|
|
3870
5430
|
|
|
3871
5431
|
/** @internal */
|
|
3872
|
-
export
|
|
3873
|
-
|
|
3874
|
-
|
|
5432
|
+
export type Scenario$Outbound = {
|
|
5433
|
+
modules: { [k: string]: Modules$Outbound };
|
|
5434
|
+
defaultOutcome?: string | undefined;
|
|
5435
|
+
defaultAdvice?: { [k: string]: any } | undefined;
|
|
5436
|
+
description?: string | undefined;
|
|
5437
|
+
[additionalProperties: string]: unknown;
|
|
5438
|
+
};
|
|
5439
|
+
|
|
5440
|
+
/** @internal */
|
|
5441
|
+
export const Scenario$outboundSchema: z.ZodMiniType<
|
|
5442
|
+
Scenario$Outbound,
|
|
5443
|
+
Scenario
|
|
3875
5444
|
> = z.catchall(
|
|
3876
5445
|
z.object({
|
|
3877
|
-
|
|
5446
|
+
modules: z.record(z.string(), z.lazy(() => Modules$outboundSchema)),
|
|
5447
|
+
defaultOutcome: z.optional(z.string()),
|
|
5448
|
+
defaultAdvice: z.optional(z.record(z.string(), z.any())),
|
|
5449
|
+
description: z.optional(z.string()),
|
|
3878
5450
|
}),
|
|
3879
5451
|
z.any(),
|
|
3880
5452
|
);
|
|
3881
5453
|
|
|
3882
|
-
export function
|
|
3883
|
-
|
|
3884
|
-
): SafeParseResult<StartJourneyResponseBody1, SDKValidationError> {
|
|
3885
|
-
return safeParse(
|
|
3886
|
-
jsonString,
|
|
3887
|
-
(x) => StartJourneyResponseBody1$inboundSchema.parse(JSON.parse(x)),
|
|
3888
|
-
`Failed to parse 'StartJourneyResponseBody1' from JSON`,
|
|
3889
|
-
);
|
|
5454
|
+
export function scenarioToJSON(scenario: Scenario): string {
|
|
5455
|
+
return JSON.stringify(Scenario$outboundSchema.parse(scenario));
|
|
3890
5456
|
}
|
|
3891
5457
|
|
|
3892
5458
|
/** @internal */
|
|
3893
|
-
export
|
|
3894
|
-
|
|
3895
|
-
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
|
|
3899
|
-
|
|
5459
|
+
export type StartJourneyRequest$Outbound = {
|
|
5460
|
+
resourceId: string;
|
|
5461
|
+
context: StartJourneyContext$Outbound;
|
|
5462
|
+
scenario?: Scenario$Outbound | undefined;
|
|
5463
|
+
};
|
|
5464
|
+
|
|
5465
|
+
/** @internal */
|
|
5466
|
+
export const StartJourneyRequest$outboundSchema: z.ZodMiniType<
|
|
5467
|
+
StartJourneyRequest$Outbound,
|
|
5468
|
+
StartJourneyRequest
|
|
5469
|
+
> = z.object({
|
|
5470
|
+
resourceId: z.string(),
|
|
5471
|
+
context: z.lazy(() => StartJourneyContext$outboundSchema),
|
|
5472
|
+
scenario: z.optional(z.lazy(() => Scenario$outboundSchema)),
|
|
5473
|
+
});
|
|
3900
5474
|
|
|
3901
|
-
export function
|
|
3902
|
-
|
|
3903
|
-
):
|
|
3904
|
-
return
|
|
3905
|
-
|
|
3906
|
-
(x) => StartJourneyResponse$inboundSchema.parse(JSON.parse(x)),
|
|
3907
|
-
`Failed to parse 'StartJourneyResponse' from JSON`,
|
|
5475
|
+
export function startJourneyRequestToJSON(
|
|
5476
|
+
startJourneyRequest: StartJourneyRequest,
|
|
5477
|
+
): string {
|
|
5478
|
+
return JSON.stringify(
|
|
5479
|
+
StartJourneyRequest$outboundSchema.parse(startJourneyRequest),
|
|
3908
5480
|
);
|
|
3909
5481
|
}
|