@epilot/sdk 2.20.24 → 2.20.26
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/definitions/integration-toolkit.json +44 -7
- package/definitions/journey.json +80 -3
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-B43U4DLU.cjs → chunk-6CWZ6WAC.cjs} +2 -2
- package/dist/{chunk-5D6VD6OZ.js → chunk-ELW5R5D6.js} +2 -2
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/integration-toolkit-FHPQSYLH.js +7 -0
- package/dist/integration-toolkit-YBZJK4IG.cjs +7 -0
- package/dist/{integration-toolkit.d-bhpB79pc.d.cts → integration-toolkit.d--hon4GPp.d.cts} +79 -26
- package/dist/{integration-toolkit.d-bhpB79pc.d.ts → integration-toolkit.d--hon4GPp.d.ts} +79 -26
- package/dist/journey-IVIBYU5V.js +7 -0
- package/dist/journey-ZN46FFPM.cjs +7 -0
- package/dist/{journey.d-DvwLALwc.d.cts → journey.d-Dj93v-Lw.d.cts} +54 -5
- package/dist/{journey.d-DvwLALwc.d.ts → journey.d-Dj93v-Lw.d.ts} +54 -5
- package/docs/integration-toolkit.md +19 -250
- package/docs/journey.md +47 -2
- package/package.json +1 -1
- package/dist/integration-toolkit-GOFVOMNH.js +0 -7
- package/dist/integration-toolkit-XMM5LLK6.cjs +0 -7
- package/dist/journey-LIJDXSEC.js +0 -7
- package/dist/journey-LNA7JFP3.cjs +0 -7
|
@@ -6124,6 +6124,27 @@ declare namespace Components {
|
|
|
6124
6124
|
* ISO instant the rule last cleared back to OK.
|
|
6125
6125
|
*/
|
|
6126
6126
|
last_cleared_at?: string | null; // date-time
|
|
6127
|
+
/**
|
|
6128
|
+
* The most recent evaluation of this rule, or null when it has never been evaluated. Answers "why isn't this rule firing?" for a rule that neither fires nor transitions — which otherwise leaves no trace at all.
|
|
6129
|
+
*/
|
|
6130
|
+
last_evaluation?: {
|
|
6131
|
+
/**
|
|
6132
|
+
* ISO instant of the evaluation. Updates on every sweep tick.
|
|
6133
|
+
*/
|
|
6134
|
+
evaluated_at: string; // date-time
|
|
6135
|
+
/**
|
|
6136
|
+
* The measure seen (error/warning count, success rate, or event total).
|
|
6137
|
+
*/
|
|
6138
|
+
observed: number;
|
|
6139
|
+
/**
|
|
6140
|
+
* What it was compared against; null for a rule type with no threshold.
|
|
6141
|
+
*/
|
|
6142
|
+
threshold?: number | null;
|
|
6143
|
+
/**
|
|
6144
|
+
* Present ONLY when the rule could not be evaluated. `sample_size` means the success-rate minimum-sample guard was not met, so the rule is neither healthy nor alerting — it is not evaluating at all. Absent when the evaluation ran normally.
|
|
6145
|
+
*/
|
|
6146
|
+
suppressed_reason?: "sample_size";
|
|
6147
|
+
} | null;
|
|
6127
6148
|
/**
|
|
6128
6149
|
* Present only for enabled 'auto'-threshold rules; null otherwise.
|
|
6129
6150
|
*/
|
|
@@ -7006,9 +7027,9 @@ declare namespace Components {
|
|
|
7006
7027
|
*/
|
|
7007
7028
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
|
|
7008
7029
|
/**
|
|
7009
|
-
* Filter by event level
|
|
7030
|
+
* Filter by event level. `skipped` is accepted but can never match: the v2 pipeline normalises it to `info`, and the table's enum has no such member. It is retained here — and ONLY here, not on `MonitoringEventV2` — so that a client with a saved `level=skipped` filter keeps getting an empty 200 rather than a 400 from request validation. Use `info` instead.
|
|
7010
7031
|
*/
|
|
7011
|
-
level?: "success" | "error" | "info" | "warning";
|
|
7032
|
+
level?: "success" | "error" | "info" | "warning" | "skipped";
|
|
7012
7033
|
/**
|
|
7013
7034
|
* Filter by taxonomy code (e.g. OAUTH2_TOKEN_FAILURE, HTTP_502). Accepts any `MonitoringCode` value, or an `HTTP_{status}` family value.
|
|
7014
7035
|
*/
|
|
@@ -10116,9 +10137,13 @@ interface OperationMethods {
|
|
|
10116
10137
|
/**
|
|
10117
10138
|
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
10118
10139
|
*
|
|
10119
|
-
*
|
|
10120
|
-
*
|
|
10121
|
-
*
|
|
10140
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` table this
|
|
10141
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
10142
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
10143
|
+
* responds `200` with an empty result and never reads any data.
|
|
10144
|
+
*
|
|
10145
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
10146
|
+
* filtered to `use_case_type: inbound`.
|
|
10122
10147
|
*
|
|
10123
10148
|
*/
|
|
10124
10149
|
'queryInboundMonitoringEvents'(
|
|
@@ -10129,9 +10154,13 @@ interface OperationMethods {
|
|
|
10129
10154
|
/**
|
|
10130
10155
|
* getMonitoringStats - getMonitoringStats
|
|
10131
10156
|
*
|
|
10132
|
-
*
|
|
10133
|
-
*
|
|
10134
|
-
*
|
|
10157
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
10158
|
+
* `webhook_events` tables this endpoint aggregated have been retired in favour
|
|
10159
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
10160
|
+
* existing clients do not 404; it always responds `200` with zeroed counters
|
|
10161
|
+
* and never reads any data.
|
|
10162
|
+
*
|
|
10163
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/stats` instead.
|
|
10135
10164
|
*
|
|
10136
10165
|
*/
|
|
10137
10166
|
'getMonitoringStats'(
|
|
@@ -10142,9 +10171,13 @@ interface OperationMethods {
|
|
|
10142
10171
|
/**
|
|
10143
10172
|
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
10144
10173
|
*
|
|
10145
|
-
*
|
|
10146
|
-
*
|
|
10147
|
-
*
|
|
10174
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
10175
|
+
* `webhook_events` tables this endpoint bucketed have been retired in favour
|
|
10176
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
10177
|
+
* existing clients do not 404; it always responds `200` with an empty bucket
|
|
10178
|
+
* list and never reads any data.
|
|
10179
|
+
*
|
|
10180
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/time-series` instead.
|
|
10148
10181
|
*
|
|
10149
10182
|
*/
|
|
10150
10183
|
'getMonitoringTimeSeries'(
|
|
@@ -10288,9 +10321,13 @@ interface OperationMethods {
|
|
|
10288
10321
|
/**
|
|
10289
10322
|
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
10290
10323
|
*
|
|
10291
|
-
*
|
|
10292
|
-
*
|
|
10293
|
-
*
|
|
10324
|
+
* **Deprecated and no longer implemented.** The `webhook_events` table this
|
|
10325
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
10326
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
10327
|
+
* responds `200` with an empty result and never reads any data.
|
|
10328
|
+
*
|
|
10329
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
10330
|
+
* filtered to `use_case_type: outbound`.
|
|
10294
10331
|
*
|
|
10295
10332
|
*/
|
|
10296
10333
|
'queryOutboundMonitoringEvents'(
|
|
@@ -11081,9 +11118,13 @@ interface PathsDictionary {
|
|
|
11081
11118
|
/**
|
|
11082
11119
|
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
11083
11120
|
*
|
|
11084
|
-
*
|
|
11085
|
-
*
|
|
11086
|
-
*
|
|
11121
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` table this
|
|
11122
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
11123
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
11124
|
+
* responds `200` with an empty result and never reads any data.
|
|
11125
|
+
*
|
|
11126
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
11127
|
+
* filtered to `use_case_type: inbound`.
|
|
11087
11128
|
*
|
|
11088
11129
|
*/
|
|
11089
11130
|
'post'(
|
|
@@ -11096,9 +11137,13 @@ interface PathsDictionary {
|
|
|
11096
11137
|
/**
|
|
11097
11138
|
* getMonitoringStats - getMonitoringStats
|
|
11098
11139
|
*
|
|
11099
|
-
*
|
|
11100
|
-
*
|
|
11101
|
-
*
|
|
11140
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
11141
|
+
* `webhook_events` tables this endpoint aggregated have been retired in favour
|
|
11142
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
11143
|
+
* existing clients do not 404; it always responds `200` with zeroed counters
|
|
11144
|
+
* and never reads any data.
|
|
11145
|
+
*
|
|
11146
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/stats` instead.
|
|
11102
11147
|
*
|
|
11103
11148
|
*/
|
|
11104
11149
|
'post'(
|
|
@@ -11111,9 +11156,13 @@ interface PathsDictionary {
|
|
|
11111
11156
|
/**
|
|
11112
11157
|
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
11113
11158
|
*
|
|
11114
|
-
*
|
|
11115
|
-
*
|
|
11116
|
-
*
|
|
11159
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
11160
|
+
* `webhook_events` tables this endpoint bucketed have been retired in favour
|
|
11161
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
11162
|
+
* existing clients do not 404; it always responds `200` with an empty bucket
|
|
11163
|
+
* list and never reads any data.
|
|
11164
|
+
*
|
|
11165
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/time-series` instead.
|
|
11117
11166
|
*
|
|
11118
11167
|
*/
|
|
11119
11168
|
'post'(
|
|
@@ -11275,9 +11324,13 @@ interface PathsDictionary {
|
|
|
11275
11324
|
/**
|
|
11276
11325
|
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
11277
11326
|
*
|
|
11278
|
-
*
|
|
11279
|
-
*
|
|
11280
|
-
*
|
|
11327
|
+
* **Deprecated and no longer implemented.** The `webhook_events` table this
|
|
11328
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
11329
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
11330
|
+
* responds `200` with an empty result and never reads any data.
|
|
11331
|
+
*
|
|
11332
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
11333
|
+
* filtered to `use_case_type: outbound`.
|
|
11281
11334
|
*
|
|
11282
11335
|
*/
|
|
11283
11336
|
'post'(
|
|
@@ -6124,6 +6124,27 @@ declare namespace Components {
|
|
|
6124
6124
|
* ISO instant the rule last cleared back to OK.
|
|
6125
6125
|
*/
|
|
6126
6126
|
last_cleared_at?: string | null; // date-time
|
|
6127
|
+
/**
|
|
6128
|
+
* The most recent evaluation of this rule, or null when it has never been evaluated. Answers "why isn't this rule firing?" for a rule that neither fires nor transitions — which otherwise leaves no trace at all.
|
|
6129
|
+
*/
|
|
6130
|
+
last_evaluation?: {
|
|
6131
|
+
/**
|
|
6132
|
+
* ISO instant of the evaluation. Updates on every sweep tick.
|
|
6133
|
+
*/
|
|
6134
|
+
evaluated_at: string; // date-time
|
|
6135
|
+
/**
|
|
6136
|
+
* The measure seen (error/warning count, success rate, or event total).
|
|
6137
|
+
*/
|
|
6138
|
+
observed: number;
|
|
6139
|
+
/**
|
|
6140
|
+
* What it was compared against; null for a rule type with no threshold.
|
|
6141
|
+
*/
|
|
6142
|
+
threshold?: number | null;
|
|
6143
|
+
/**
|
|
6144
|
+
* Present ONLY when the rule could not be evaluated. `sample_size` means the success-rate minimum-sample guard was not met, so the rule is neither healthy nor alerting — it is not evaluating at all. Absent when the evaluation ran normally.
|
|
6145
|
+
*/
|
|
6146
|
+
suppressed_reason?: "sample_size";
|
|
6147
|
+
} | null;
|
|
6127
6148
|
/**
|
|
6128
6149
|
* Present only for enabled 'auto'-threshold rules; null otherwise.
|
|
6129
6150
|
*/
|
|
@@ -7006,9 +7027,9 @@ declare namespace Components {
|
|
|
7006
7027
|
*/
|
|
7007
7028
|
use_case_type?: "inbound" | "outbound" | "file_proxy" | "managed_call" | "secure_proxy";
|
|
7008
7029
|
/**
|
|
7009
|
-
* Filter by event level
|
|
7030
|
+
* Filter by event level. `skipped` is accepted but can never match: the v2 pipeline normalises it to `info`, and the table's enum has no such member. It is retained here — and ONLY here, not on `MonitoringEventV2` — so that a client with a saved `level=skipped` filter keeps getting an empty 200 rather than a 400 from request validation. Use `info` instead.
|
|
7010
7031
|
*/
|
|
7011
|
-
level?: "success" | "error" | "info" | "warning";
|
|
7032
|
+
level?: "success" | "error" | "info" | "warning" | "skipped";
|
|
7012
7033
|
/**
|
|
7013
7034
|
* Filter by taxonomy code (e.g. OAUTH2_TOKEN_FAILURE, HTTP_502). Accepts any `MonitoringCode` value, or an `HTTP_{status}` family value.
|
|
7014
7035
|
*/
|
|
@@ -10116,9 +10137,13 @@ interface OperationMethods {
|
|
|
10116
10137
|
/**
|
|
10117
10138
|
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
10118
10139
|
*
|
|
10119
|
-
*
|
|
10120
|
-
*
|
|
10121
|
-
*
|
|
10140
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` table this
|
|
10141
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
10142
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
10143
|
+
* responds `200` with an empty result and never reads any data.
|
|
10144
|
+
*
|
|
10145
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
10146
|
+
* filtered to `use_case_type: inbound`.
|
|
10122
10147
|
*
|
|
10123
10148
|
*/
|
|
10124
10149
|
'queryInboundMonitoringEvents'(
|
|
@@ -10129,9 +10154,13 @@ interface OperationMethods {
|
|
|
10129
10154
|
/**
|
|
10130
10155
|
* getMonitoringStats - getMonitoringStats
|
|
10131
10156
|
*
|
|
10132
|
-
*
|
|
10133
|
-
*
|
|
10134
|
-
*
|
|
10157
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
10158
|
+
* `webhook_events` tables this endpoint aggregated have been retired in favour
|
|
10159
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
10160
|
+
* existing clients do not 404; it always responds `200` with zeroed counters
|
|
10161
|
+
* and never reads any data.
|
|
10162
|
+
*
|
|
10163
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/stats` instead.
|
|
10135
10164
|
*
|
|
10136
10165
|
*/
|
|
10137
10166
|
'getMonitoringStats'(
|
|
@@ -10142,9 +10171,13 @@ interface OperationMethods {
|
|
|
10142
10171
|
/**
|
|
10143
10172
|
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
10144
10173
|
*
|
|
10145
|
-
*
|
|
10146
|
-
*
|
|
10147
|
-
*
|
|
10174
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
10175
|
+
* `webhook_events` tables this endpoint bucketed have been retired in favour
|
|
10176
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
10177
|
+
* existing clients do not 404; it always responds `200` with an empty bucket
|
|
10178
|
+
* list and never reads any data.
|
|
10179
|
+
*
|
|
10180
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/time-series` instead.
|
|
10148
10181
|
*
|
|
10149
10182
|
*/
|
|
10150
10183
|
'getMonitoringTimeSeries'(
|
|
@@ -10288,9 +10321,13 @@ interface OperationMethods {
|
|
|
10288
10321
|
/**
|
|
10289
10322
|
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
10290
10323
|
*
|
|
10291
|
-
*
|
|
10292
|
-
*
|
|
10293
|
-
*
|
|
10324
|
+
* **Deprecated and no longer implemented.** The `webhook_events` table this
|
|
10325
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
10326
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
10327
|
+
* responds `200` with an empty result and never reads any data.
|
|
10328
|
+
*
|
|
10329
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
10330
|
+
* filtered to `use_case_type: outbound`.
|
|
10294
10331
|
*
|
|
10295
10332
|
*/
|
|
10296
10333
|
'queryOutboundMonitoringEvents'(
|
|
@@ -11081,9 +11118,13 @@ interface PathsDictionary {
|
|
|
11081
11118
|
/**
|
|
11082
11119
|
* queryInboundMonitoringEvents - queryInboundMonitoringEvents
|
|
11083
11120
|
*
|
|
11084
|
-
*
|
|
11085
|
-
*
|
|
11086
|
-
*
|
|
11121
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` table this
|
|
11122
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
11123
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
11124
|
+
* responds `200` with an empty result and never reads any data.
|
|
11125
|
+
*
|
|
11126
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
11127
|
+
* filtered to `use_case_type: inbound`.
|
|
11087
11128
|
*
|
|
11088
11129
|
*/
|
|
11089
11130
|
'post'(
|
|
@@ -11096,9 +11137,13 @@ interface PathsDictionary {
|
|
|
11096
11137
|
/**
|
|
11097
11138
|
* getMonitoringStats - getMonitoringStats
|
|
11098
11139
|
*
|
|
11099
|
-
*
|
|
11100
|
-
*
|
|
11101
|
-
*
|
|
11140
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
11141
|
+
* `webhook_events` tables this endpoint aggregated have been retired in favour
|
|
11142
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
11143
|
+
* existing clients do not 404; it always responds `200` with zeroed counters
|
|
11144
|
+
* and never reads any data.
|
|
11145
|
+
*
|
|
11146
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/stats` instead.
|
|
11102
11147
|
*
|
|
11103
11148
|
*/
|
|
11104
11149
|
'post'(
|
|
@@ -11111,9 +11156,13 @@ interface PathsDictionary {
|
|
|
11111
11156
|
/**
|
|
11112
11157
|
* getMonitoringTimeSeries - getMonitoringTimeSeries
|
|
11113
11158
|
*
|
|
11114
|
-
*
|
|
11115
|
-
*
|
|
11116
|
-
*
|
|
11159
|
+
* **Deprecated and no longer implemented.** The `erp_monitoring` and
|
|
11160
|
+
* `webhook_events` tables this endpoint bucketed have been retired in favour
|
|
11161
|
+
* of the unified `erp_monitoring_v2` table. The endpoint is kept only so
|
|
11162
|
+
* existing clients do not 404; it always responds `200` with an empty bucket
|
|
11163
|
+
* list and never reads any data.
|
|
11164
|
+
*
|
|
11165
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/time-series` instead.
|
|
11117
11166
|
*
|
|
11118
11167
|
*/
|
|
11119
11168
|
'post'(
|
|
@@ -11275,9 +11324,13 @@ interface PathsDictionary {
|
|
|
11275
11324
|
/**
|
|
11276
11325
|
* queryOutboundMonitoringEvents - queryOutboundMonitoringEvents
|
|
11277
11326
|
*
|
|
11278
|
-
*
|
|
11279
|
-
*
|
|
11280
|
-
*
|
|
11327
|
+
* **Deprecated and no longer implemented.** The `webhook_events` table this
|
|
11328
|
+
* endpoint read has been retired in favour of the unified `erp_monitoring_v2`
|
|
11329
|
+
* table. The endpoint is kept only so existing clients do not 404; it always
|
|
11330
|
+
* responds `200` with an empty result and never reads any data.
|
|
11331
|
+
*
|
|
11332
|
+
* Use `POST /v2/integrations/{integrationId}/monitoring/events` instead,
|
|
11333
|
+
* filtered to `use_case_type: outbound`.
|
|
11281
11334
|
*
|
|
11282
11335
|
*/
|
|
11283
11336
|
'post'(
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/docs/journey.json
|
|
4
|
+
var journey_default = '# Journey API\n\n- **Base URL:** `https://journey-config.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/journey](https://docs.epilot.io/api/journey)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.journey.getJourneysByOrgId(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/journey\'\n\nconst journeyClient = getClient()\nauthorize(journeyClient, () => \'<token>\')\nconst { data } = await journeyClient.getJourneysByOrgId(...)\n```\n\n## Operations\n\n**Journeys**\n- [`getJourneysByOrgId`](#getjourneysbyorgid)\n- [`getJourney`](#getjourney)\n- [`removeJourney`](#removejourney)\n- [`createJourneyRevision`](#createjourneyrevision)\n- [`listJourneyRevisions`](#listjourneyrevisions)\n- [`getJourneyRevision`](#getjourneyrevision)\n- [`publishJourneyRevision`](#publishjourneyrevision)\n- [`getJourneyPublishState`](#getjourneypublishstate)\n- [`getJourneyEnvironment`](#getjourneyenvironment)\n- [`getJourneyEnvironmentVariables`](#getjourneyenvironmentvariables)\n- [`getJourneyProducts`](#getjourneyproducts)\n- [`createJourney`](#createjourney)\n- [`updateJourney`](#updatejourney)\n- [`patchUpdateJourney`](#patchupdatejourney)\n- [`searchJourneys`](#searchjourneys)\n- [`generateDocument`](#generatedocument)\n- [`getSettingsForJourney`](#getsettingsforjourney)\n- [`getButtonOptions`](#getbuttonoptions)\n\n**Journeys V2**\n- [`createJourneyV2`](#createjourneyv2)\n- [`updateJourneyV2`](#updatejourneyv2)\n- [`patchUpdateJourneyV2`](#patchupdatejourneyv2)\n- [`getJourneyV2`](#getjourneyv2)\n- [`removeJourneyV2`](#removejourneyv2)\n\n**Schemas**\n- [`EnvironmentMapEntry`](#environmentmapentry)\n- [`EnvironmentMap`](#environmentmap)\n- [`EnvironmentLink`](#environmentlink)\n- [`EnvironmentLinkList`](#environmentlinklist)\n- [`JourneyEnvironmentResponse`](#journeyenvironmentresponse)\n- [`JourneyEnvironmentVariablesResponse`](#journeyenvironmentvariablesresponse)\n- [`GetJourneysResponse`](#getjourneysresponse)\n- [`JourneyResponse`](#journeyresponse)\n- [`JourneyProductsResponse`](#journeyproductsresponse)\n- [`PatchUpdateJourneyRequest`](#patchupdatejourneyrequest)\n- [`JourneyCreationRequest`](#journeycreationrequest)\n- [`JourneyCreationRequestV2`](#journeycreationrequestv2)\n- [`SearchJourneysQueryRequest`](#searchjourneysqueryrequest)\n- [`SearchJourneysResponse`](#searchjourneysresponse)\n- [`Journey`](#journey)\n- [`JourneyServedRevision`](#journeyservedrevision)\n- [`JourneyActivationGuarantee`](#journeyactivationguarantee)\n- [`JourneyFeatureFlags`](#journeyfeatureflags)\n- [`JourneyAuditInfo`](#journeyauditinfo)\n- [`JourneyRevisionRequest`](#journeyrevisionrequest)\n- [`PublishRevisionRequest`](#publishrevisionrequest)\n- [`JourneyRevisionSummary`](#journeyrevisionsummary)\n- [`JourneyRevisionList`](#journeyrevisionlist)\n- [`JourneyRevision`](#journeyrevision)\n- [`JourneyRevisionConflict`](#journeyrevisionconflict)\n- [`JourneyPublishState`](#journeypublishstate)\n- [`PublishResult`](#publishresult)\n- [`JourneyValidationResponse`](#journeyvalidationresponse)\n- [`JourneyValidationError`](#journeyvalidationerror)\n- [`S3Reference`](#s3reference)\n- [`TemplateSettings`](#templatesettings)\n- [`GenerateDocumentResponse`](#generatedocumentresponse)\n- [`GenerateDocumentRequest`](#generatedocumentrequest)\n- [`GetSettingsForJourney`](#getsettingsforjourney)\n- [`ButtonOption`](#buttonoption)\n- [`ValidationRuleRef`](#validationruleref)\n- [`RuleRef`](#ruleref)\n\n### `getJourneysByOrgId`\n\nGet all journeys by organization id\n\n`GET /v1/journey/organization/{id}`\n\n```ts\nconst { data } = await client.getJourneysByOrgId({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n hydrate: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getJourney`\n\nGet journey by id. Private journeys requires valid private token to be passed\n\n`GET /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n revision_id: \'example\',\n source: \'example\',\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {},\n "revision_id": "42"\n}\n```\n\n</details>\n\n---\n\n### `removeJourney`\n\nRemove journey by id\n\n`DELETE /v1/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `createJourneyRevision`\n\nCreates a revision: an immutable copy of the complete journey configuration, identified by `revision_id`. Nothing customers receive changes; the revision only becomes the published version when it is \n\n`POST /v1/journey/configuration/{id}/revisions`\n\n```ts\nconst { data } = await client.createJourneyRevision(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n stepperType: \'numbers\',\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true,\n description: \'string\'\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n protectedEditable: [\'string\'],\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n newMappings: true,\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n authGate: {\n stepId: \'string\'\n },\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n mode: \'auto\',\n supportedRevision: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: [\'rule456\', \'rule789\'],\n block3: {\n field1: \'rule101\',\n field2: [\'rule102\', \'rule103\']\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\',\n parent_revision_id: \'41\',\n based_on_revision_id: \'37\',\n mapping_config_version: 12,\n revision_name: \'Changes to Steps and Logic\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "revision_id": "42",\n "created_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "name": "Summer campaign",\n "description": "string",\n "published_at": "1970-01-01T00:00:00.000Z",\n "is_published": true,\n "mapping_config_version": 12\n}\n```\n\n</details>\n\n---\n\n### `listJourneyRevisions`\n\nLists the journey\'s revision history, newest first. Metadata only, no configuration payload. `is_published` says whether a revision is the published version right now, which is a different question fr\n\n`GET /v1/journey/configuration/{id}/revisions`\n\n```ts\nconst { data } = await client.listJourneyRevisions({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n limit: 1,\n cursor: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "revision_id": "42",\n "created_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "name": "Summer campaign",\n "description": "string",\n "published_at": "1970-01-01T00:00:00.000Z",\n "is_published": true,\n "mapping_config_version": 12\n }\n ],\n "next_cursor": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJourneyRevision`\n\nReturns one revision with its full configuration, in the shape the builder holds a journey in, so it can be loaded straight into the editor as unsaved changes. Reading a revision changes nothing; a cl\n\n`GET /v1/journey/configuration/{id}/revisions/{revision_id}`\n\n```ts\nconst { data } = await client.getJourneyRevision({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n revision_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "revision_id": "42",\n "created_at": "1970-01-01T00:00:00.000Z",\n "created_by": "string",\n "name": "Summer campaign",\n "description": "string",\n "published_at": "1970-01-01T00:00:00.000Z",\n "is_published": true,\n "mapping_config_version": 12,\n "configuration": {\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {}\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {}\n ],\n "logics": [\n {}\n ],\n "logicsV4": {},\n "contextSchema": [\n {}\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {},\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "authGate": {},\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {},\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {}\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `publishJourneyRevision`\n\nMakes one revision the published version, the one customers receive, in a single transaction: the revision\'s configuration is copied onto the journey record, its datasource set onto the published data\n\n`POST /v1/journey/configuration/{id}/publish`\n\n```ts\nconst { data } = await client.publishJourneyRevision(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n revision_id: \'42\',\n name: \'Summer campaign\',\n description: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "revision_id": "42",\n "name": "Summer campaign",\n "published_at": "1970-01-01T00:00:00.000Z",\n "published_by": "string",\n "post_publish_warnings": ["string"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyPublishState`\n\nAnswers which revision is the published version without paging through the history. A journey that has not adopted versioning yet returns `200` with `published_revision_id: null`, not `404`.\n\n`GET /v1/journey/configuration/{id}/publish-state`\n\n```ts\nconst { data } = await client.getJourneyPublishState({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journey_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "published_revision_id": "42",\n "published_at": "1970-01-01T00:00:00.000Z",\n "published_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `getJourneyEnvironment`\n\nResolve the environment variables referenced by this journey. Only browser-safe value types are returned.\n\n`GET /v1/journey/configuration/{id}/environment`\n\n```ts\nconst { data } = await client.getJourneyEnvironment({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "datasourceId": "string",\n "type": "Text",\n "value": "string"\n }\n ],\n "errors": [\n {\n "datasourceId": "string",\n "code": "not_found"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyEnvironmentVariables`\n\nList the organization\'s environment variables that a journey block may use as an options source. Only Map variables that currently hold a valid value are returned. Intended for the journey builder\'s a\n\n`GET /v1/journey/environment-variables`\n\n```ts\nconst { data } = await client.getJourneyEnvironmentVariables()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "items": [\n {\n "key": "string",\n "type": "Map",\n "value": {\n "fallbackLanguage": "de",\n "options": [\n {\n "key": "string",\n "value": "string"\n }\n ]\n },\n "description": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyProducts`\n\nGet products available in the journey by id. requires public journey token to be passed.\n\n`GET /v1/journey/products/{id}`\n\n```ts\nconst { data } = await client.getJourneyProducts({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n source: \'example\',\n postal_code: \'example\',\n city: \'example\',\n street: \'example\',\n street_number: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "type": "string",\n "_schema": "string",\n "_title": "string",\n "name": "string",\n "_id": "string",\n "_org": "string",\n "code": "string",\n "description": "string",\n "feature": [\n {}\n ],\n "product_images": [\n {}\n ],\n "legal_footnote": "string",\n "product_downloads": [\n {}\n ],\n "price": {}\n }\n]\n```\n\n</details>\n\n---\n\n### `createJourney`\n\nCreate a Journey\n\n`POST /v1/journey/configuration`\n\n```ts\nconst { data } = await client.createJourney(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n stepperType: \'numbers\',\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true,\n description: \'string\'\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n protectedEditable: [\'string\'],\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n newMappings: true,\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n authGate: {\n stepId: \'string\'\n },\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n mode: \'auto\',\n supportedRevision: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: [\'rule456\', \'rule789\'],\n block3: {\n field1: \'rule101\',\n field2: [\'rule102\', \'rule103\']\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n },\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n}\n```\n\n</details>\n\n---\n\n### `updateJourney`\n\nUpdate a Journey\n\n`PUT /v1/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourney(\n null,\n {\n journeyId: \'string\',\n organizationId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n stepperType: \'numbers\',\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true,\n description: \'string\'\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n protectedEditable: [\'string\'],\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n canary: true,\n designId: \'string\',\n templateId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n newMappings: true,\n targetedCustomer: \'string\',\n description: \'string\',\n organizationSettings: {},\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n useAustrianLabels: true,\n enableDarkMode: true,\n accessMode: \'PUBLIC\',\n authGate: {\n stepId: \'string\'\n },\n isPublished: true,\n status: \'string\',\n isActive: true,\n savingProgress: {\n mode: \'auto\',\n supportedRevision: 0\n },\n thirdPartyCookies: true\n },\n validationRules: {\n block1: \'rule123\',\n block2: [\'rule456\', \'rule789\'],\n block3: {\n field1: \'rule101\',\n field2: [\'rule102\', \'rule103\']\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\'],\n createdBy: \'string\',\n updatedBy: \'string\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n---\n\n### `patchUpdateJourney`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v1/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourney(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "createdJourney": {\n "journeyId": "string",\n "organizationId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {}\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {}\n ],\n "logics": [\n {}\n ],\n "logicsV4": {},\n "contextSchema": [\n {}\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {},\n "safeModeAutomation": true,\n "canary": true,\n "designId": "string",\n "templateId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "targetedCustomer": "string",\n "description": "string",\n "organizationSettings": {},\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "useAustrianLabels": true,\n "enableDarkMode": true,\n "accessMode": "PUBLIC",\n "authGate": {},\n "isPublished": true,\n "status": "string",\n "isActive": true,\n "savingProgress": {},\n "thirdPartyCookies": true\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {}\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "createdBy": "string",\n "updatedBy": "string",\n "__lastModifiedAt": "string",\n "createdAt": "string",\n "lastModifiedAt": "string",\n "deletedAt": "string",\n "version": 0,\n "revisions": 0,\n "featureFlags": {}\n }\n}\n```\n\n</details>\n\n---\n\n### `searchJourneys`\n\nSearch Journeys\n\n`POST /v1/journey/configuration/search`\n\n```ts\nconst { data } = await client.searchJourneys(\n null,\n {\n q: \'_tags:*Flex*\',\n from: 0,\n size: 25,\n sort: \'_created_at:desc\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 1,\n "results": [\n {\n "_id": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8",\n "_schema": "journey",\n "_title": "Journey Entity Title",\n "_org": "739224",\n "_created_at": "2020-01-01T00:00:00.000Z",\n "_updated_at": "2020-01-01T00:00:00.000Z",\n "_tags": ["Flex"],\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],\n "journey_name": "Journey Name",\n "journey_id": "de7df470-253e-11ed-9174-116b8a718c0a",\n "journey_type": "Sales template",\n "design": "Design EPILOT",\n "created_by": [\n {\n "id": "12345"\n }\n ],\n "journey_version": "Flex"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `generateDocument`\n\nBuilds document generated from a template with journey values."\n\n`POST /v1/journey/document:generate`\n\n```ts\nconst { data } = await client.generateDocument(\n null,\n {\n file_id: \'1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p\',\n context_data: {\n additionalProperties: \'string\'\n },\n context_entity_id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n language: \'de\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "job_status": "STARTED",\n "message": "string",\n "pdf_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.pdf"\n }\n }\n },\n "docx_output": {\n "preview_url": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx",\n "output_document": {\n "s3ref": {\n "bucket": "document-api-preview-prod",\n "key": "preview/my-template.docx"\n }\n }\n },\n "variable_payload": {\n "additionalProperties": "string"\n },\n "template_settings": {\n "custom_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "suggested_margins": {\n "top": 2.54,\n "bottom": 2.54\n },\n "display_margin_guidelines": true,\n "enable_data_table_margin_autofix": false,\n "template_with_datatable": false,\n "enabled_template_settings_persistence": false,\n "misconfigured_margins": false,\n "file_entity_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"\n }\n}\n```\n\n</details>\n\n---\n\n### `createJourneyV2`\n\nCreate a Journey\n\n`POST /v2/journey/configuration`\n\n```ts\nconst { data } = await client.createJourneyV2(\n {\n skipAutomation: \'example\',\n },\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n stepperType: \'numbers\',\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true,\n description: \'string\'\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n protectedEditable: [\'string\'],\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n newMappings: true,\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n authGate: {\n stepId: \'string\'\n },\n enableDarkMode: true,\n useAustrianLabels: true,\n isActive: true,\n savingProgress: {\n mode: \'auto\',\n supportedRevision: 0\n }\n },\n validationRules: {\n block1: \'rule123\',\n block2: [\'rule456\', \'rule789\'],\n block3: {\n field1: \'rule101\',\n field2: [\'rule102\', \'rule103\']\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "enableDarkMode": true,\n "useAustrianLabels": true,\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n }\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `updateJourneyV2`\n\nUpdate a Journey\n\n`PUT /v2/journey/configuration`\n\n```ts\nconst { data } = await client.updateJourneyV2(\n null,\n {\n journeyId: \'string\',\n brandId: \'string\',\n name: \'string\',\n steps: [\n {\n showStepName: true,\n title: \'string\',\n subTitle: \'string\',\n showStepSubtitle: true,\n showStepper: true,\n showStepperLabels: true,\n stepperType: \'numbers\',\n hideNextButton: true,\n name: \'string\',\n stepId: \'string\',\n schema: {},\n uischema: {},\n maxWidth: \'small\'\n }\n ],\n design: {\n logoUrl: \'string\',\n theme: {},\n designTokens: {}\n },\n rules: [\n {\n type: \'inject\',\n sourceType: \'journey\',\n source: \'string\',\n target: \'string\'\n }\n ],\n logics: [\n {\n autoGeneratedId: \'string\',\n conditions: [\'string\'],\n actions: [\'string\']\n }\n ],\n logicsV4: {},\n contextSchema: [\n {\n id: \'3fa85f64-5717-4562-b3fc-2c963f66afa6\',\n type: \'string\',\n paramKey: \'string\',\n isRequired: true,\n shouldLoadEntity: true,\n description: \'string\'\n }\n ],\n journey_type: \'Sales template (Premium)\',\n protected: true,\n protectedEditable: [\'string\'],\n settings: {\n embedOptions: {\n mode: \'full-screen\',\n lang: \'de\',\n width: \'string\',\n topBar: true,\n scrollToTop: true,\n button: { /* ... */ }\n },\n safeModeAutomation: true,\n designId: \'string\',\n entityId: \'string\',\n mappingsAutomationId: \'string\',\n newMappings: true,\n templateId: \'string\',\n targetedCustomer: \'string\',\n description: \'string\',\n publicToken: \'string\',\n runtimeEntities: [\'ORDER\'],\n filePurposes: [\'string\'],\n entityTags: [\'string\'],\n addressSuggestionsFileUrl: \'string\',\n addressSuggestionsFileId: \'string\',\n addressSuggestionsCountryCode: \'string\',\n addressSuggestionsEnableAutoComplete: true,\n addressSuggestionsSource: [\'string\'],\n addressSuggestionsEnableFreeText: true,\n useNewDesign: true,\n thirdPartyCookies: true,\n accessMode: \'PUBLIC\',\n authGate: {\n stepId: \'string\'\n },\n enableDarkMode: true,\n useAustrianLabels: true,\n isActive: true,\n savingProgress: {\n mode: \'auto\',\n supportedRevision: 0\n }\n },\n validationRules: {\n block1: \'rule123\',\n block2: [\'rule456\', \'rule789\'],\n block3: {\n field1: \'rule101\',\n field2: [\'rule102\', \'rule103\']\n }\n },\n _manifest: [\'123e4567-e89b-12d3-a456-426614174000\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "enableDarkMode": true,\n "useAustrianLabels": true,\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n }\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `patchUpdateJourneyV2`\n\nUpdate a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").\n\n`PATCH /v2/journey/configuration`\n\n```ts\nconst { data } = await client.patchUpdateJourneyV2(\n null,\n {\n journeyId: \'509cdffe-424f-457a-95c2-9708c304ce77\',\n __lastModifiedAt: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "enableDarkMode": true,\n "useAustrianLabels": true,\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n }\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `getJourneyV2`\n\nGet journey by id\n\n`GET /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.getJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n version: 1,\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "journeyId": "string",\n "brandId": "string",\n "name": "string",\n "steps": [\n {\n "showStepName": true,\n "title": "string",\n "subTitle": "string",\n "showStepSubtitle": true,\n "showStepper": true,\n "showStepperLabels": true,\n "stepperType": "numbers",\n "hideNextButton": true,\n "name": "string",\n "stepId": "string",\n "schema": {},\n "uischema": {},\n "maxWidth": "small"\n }\n ],\n "design": {\n "logoUrl": "string",\n "theme": {},\n "designTokens": {}\n },\n "rules": [\n {\n "type": "inject",\n "sourceType": "journey",\n "source": "string",\n "target": "string"\n }\n ],\n "logics": [\n {\n "autoGeneratedId": "string",\n "conditions": ["string"],\n "actions": ["string"]\n }\n ],\n "logicsV4": {},\n "contextSchema": [\n {\n "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "type": "string",\n "paramKey": "string",\n "isRequired": true,\n "shouldLoadEntity": true,\n "description": "string"\n }\n ],\n "journey_type": "Sales template (Premium)",\n "protected": true,\n "protectedEditable": ["string"],\n "settings": {\n "embedOptions": {\n "mode": "full-screen",\n "lang": "de",\n "width": "string",\n "topBar": true,\n "scrollToTop": true,\n "button": {}\n },\n "safeModeAutomation": true,\n "designId": "string",\n "entityId": "string",\n "mappingsAutomationId": "string",\n "newMappings": true,\n "templateId": "string",\n "targetedCustomer": "string",\n "description": "string",\n "publicToken": "string",\n "runtimeEntities": ["ORDER"],\n "filePurposes": ["string"],\n "entityTags": ["string"],\n "addressSuggestionsFileUrl": "string",\n "addressSuggestionsFileId": "string",\n "addressSuggestionsCountryCode": "string",\n "addressSuggestionsEnableAutoComplete": true,\n "addressSuggestionsSource": ["string"],\n "addressSuggestionsEnableFreeText": true,\n "useNewDesign": true,\n "thirdPartyCookies": true,\n "accessMode": "PUBLIC",\n "authGate": {\n "stepId": "string"\n },\n "enableDarkMode": true,\n "useAustrianLabels": true,\n "isActive": true,\n "savingProgress": {\n "mode": "auto",\n "supportedRevision": 0\n }\n },\n "validationRules": {\n "block1": "rule123",\n "block2": ["rule456", "rule789"],\n "block3": {\n "field1": "rule101",\n "field2": ["rule102", "rule103"]\n }\n },\n "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]\n}\n```\n\n</details>\n\n---\n\n### `removeJourneyV2`\n\nRemove journey by id\n\n`DELETE /v2/journey/configuration/{id}`\n\n```ts\nconst { data } = await client.removeJourneyV2({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n---\n\n### `getSettingsForJourney`\n\nGet settings related to the journey using journey ID.\n\n`GET /v1/journey/{id}/settings`\n\n```ts\nconst { data } = await client.getSettingsForJourney({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "organizationId": "739224",\n "canary": true,\n "thirdPartyCookies": true\n}\n```\n\n</details>\n\n---\n\n### `getButtonOptions`\n\nGet button options from a csv file.\n\n`GET /v1/journey/button-options`\n\n```ts\nconst { data } = await client.getButtonOptions({\n fileId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "value": "Button Hidden Value",\n "label": "Button Label"\n }\n]\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `EnvironmentMapEntry`\n\n```ts\ntype EnvironmentMapEntry = {\n key: string\n value: string | Record<string, string>\n}\n```\n\n### `EnvironmentMap`\n\n```ts\ntype EnvironmentMap = {\n fallbackLanguage?: string\n options: Array<{\n key: string\n value: string | Record<string, string>\n }>\n}\n```\n\n### `EnvironmentLink`\n\nOne link a customer clicks. `label` and `description` are each either a\nplain string or one string per language, deciding that independently.\nMirrors environments-api\'s `LinkFields`.\n\n\n```ts\ntype EnvironmentLink = {\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n}\n```\n\n### `EnvironmentLinkList`\n\nA list of links, served under this service\'s own `List`<Link>`` type\ntoken. environments-api types the variable `List` and declares the\nelement type inside the value; journey-api composes the two so a\nconsumer needs only one discriminant.\n\n\n```ts\ntype EnvironmentLinkList = {\n itemType: "Link"\n fallbackLanguage?: string\n items: Array<{\n url: string\n label: string | Record<string, string>\n description?: string | Record<string, string>\n }>\n}\n```\n\n### `JourneyEnvironmentResponse`\n\n```ts\ntype JourneyEnvironmentResponse = {\n items: Array<{\n datasourceId: string\n type: "Text" | "Number" | "Boolean" | "Map" | "List<Link>"\n value: string | number | boolean | {\n fallbackLanguage?: { ... }\n options: { ... }\n } | {\n itemType: { ... }\n fallbackLanguage?: { ... }\n items: { ... }\n }\n }>\n errors: Array<{\n datasourceId: string\n code: "not_found" | "unsupported_type" | "not_set" | "invalid_value" | "incompatible_consumer"\n }>\n}\n```\n\n### `JourneyEnvironmentVariablesResponse`\n\n```ts\ntype JourneyEnvironmentVariablesResponse = {\n items: Array<{\n key: string\n type: "Map" | "List<Link>"\n value: {\n fallbackLanguage?: { ... }\n options: { ... }\n } | {\n itemType: { ... }\n fallbackLanguage?: { ... }\n items: { ... }\n }\n description?: string\n }>\n}\n```\n\n### `GetJourneysResponse`\n\n```ts\ntype GetJourneysResponse = object\n```\n\n### `JourneyResponse`\n\n```ts\ntype JourneyResponse = {\n createdJourney?: {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: { ... }\n title?: { ... }\n subTitle?: { ... }\n showStepSubtitle?: { ... }\n showStepper?: { ... }\n showStepperLabels?: { ... }\n stepperType?: { ... }\n hideNextButton?: { ... }\n name: { ... }\n stepId?: { ... }\n schema: { ... }\n uischema: { ... }\n maxWidth?: { ... }\n }>\n design?: {\n logoUrl?: { ... }\n theme?: { ... }\n designTokens?: { ... }\n }\n rules?: Array<{\n type: { ... }\n sourceType: { ... }\n source: { ... }\n target: { ... }\n }>\n logics?: Array<{\n autoGeneratedId?: { ... }\n conditions: { ... }\n actions: { ... }\n }>\n logicsV4?: Record<string, {\n id?: { ... }\n protected?: { ... }\n action?: { ... }\n triggeredOn?: { ... }\n conditions?: { ... }\n settings?: { ... }\n }>\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n description?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\n newMappings?: { ... }\n targetedCustomer?: { ... }\n description?: { ... }\n organizationSettings?: { ... }\n publicToken?: { ... }\n runtimeEntities?: { ... }\n filePurposes?: { ... }\n entityTags?: { ... }\n addressSuggestionsFileUrl?: { ... }\n addressSuggestionsFileId?: { ... }\n addressSuggestionsCountryCode?: { ... }\n addressSuggestionsEnableAutoComplete?: { ... }\n addressSuggestionsSource?: { ... }\n addressSuggestionsEnableFreeText?: { ... }\n useNewDesign?: { ... }\n useAustrianLabels?: { ... }\n enableDarkMode?: { ... }\n accessMode?: { ... }\n authGate?: { ... }\n isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record<string, string | string[] | Record<string, string | string[]>>\n _manifest?: string // uuid[]\n createdBy?: string\n updatedBy?: string\n __lastModifiedAt?: string\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n featureFlags?: Record<string, unknown>\n // ...\n}\n```\n\n### `JourneyProductsResponse`\n\n```ts\ntype JourneyProductsResponse = Array<{\n type?: string\n _schema?: string\n _title?: string\n name?: string\n _id?: string\n _org?: string\n code?: string\n description?: string\n feature?: unknown[]\n product_images?: unknown[]\n legal_footnote?: string\n product_downloads?: unknown[]\n price?: object\n}>\n```\n\n### `PatchUpdateJourneyRequest`\n\nPatch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n\n\n```ts\ntype PatchUpdateJourneyRequest = {\n journeyId: string // uuid\n __lastModifiedAt?: string\n}\n```\n\n### `JourneyCreationRequest`\n\n```ts\ntype JourneyCreationRequest = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n stepperType?: "numbers" | "progress bar"\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n description?: string\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n newMappings?: boolean\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n authGate?: {\n stepId: { ... }\n }\n isPublished?: boolean\n status?: string\n isActive?: boolean\n // ...\n}\n```\n\n### `JourneyCreationRequestV2`\n\n```ts\ntype JourneyCreationRequestV2 = {\n journeyId?: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n stepperType?: "numbers" | "progress bar"\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n description?: string\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n designId?: string\n entityId?: string\n mappingsAutomationId?: string\n newMappings?: boolean\n templateId?: string\n targetedCustomer?: string\n description?: string\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n thirdPartyCookies?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n authGate?: {\n stepId: { ... }\n }\n enableDarkMode?: boolean\n useAustrianLabels?: boolean\n isActive?: boolean\n savingProgress?: {\n mode?: { ... }\n supportedRevision?: { ... }\n }\n // ...\n}\n```\n\n### `SearchJourneysQueryRequest`\n\n```ts\ntype SearchJourneysQueryRequest = {\n q?: string\n from?: number\n size?: number\n sort?: string\n}\n```\n\n### `SearchJourneysResponse`\n\n```ts\ntype SearchJourneysResponse = {\n hits?: number\n results?: Array<{\n _id?: string // uuid\n _schema?: string\n _title?: string\n _org?: string\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _tags?: string[]\n _manifest?: string // uuid[]\n journey_name?: string\n journey_id?: string // uuid\n journey_type?: string\n design?: string\n created_by?: Array<{\n id?: { ... }\n }>\n journey_version?: "Flex"\n }>\n}\n```\n\n### `Journey`\n\n```ts\ntype Journey = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n stepperType?: "numbers" | "progress bar"\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n description?: string\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n newMappings?: boolean\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n authGate?: {\n stepId: { ... }\n }\n isPublished?: boolean\n status?: string\n isActive?: boolean\n // ...\n}\n```\n\n### `JourneyServedRevision`\n\nWhich revision the runtime read served: the requested one, or the published version when no revision was requested. Absent while the journey has not adopted versioning and on legacy `version` reads.\n\n\n```ts\ntype JourneyServedRevision = {\n revision_id?: string\n}\n```\n\n### `JourneyActivationGuarantee`\n\nJourneys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.\n\n\n```ts\ntype JourneyActivationGuarantee = {\n settings: {\n isActive: boolean\n }\n}\n```\n\n### `JourneyFeatureFlags`\n\n```ts\ntype JourneyFeatureFlags = {\n featureFlags?: Record<string, unknown>\n}\n```\n\n### `JourneyAuditInfo`\n\n```ts\ntype JourneyAuditInfo = {\n createdAt: string\n lastModifiedAt: string\n deletedAt?: string\n version: number\n revisions: number\n}\n```\n\n### `JourneyRevisionRequest`\n\nThe complete journey configuration a revision is created from, same shape as the `PUT` body. Server-managed attributes of the journey record (`revisions`, `version`, publish metadata) are ignored.\n\n\n```ts\ntype JourneyRevisionRequest = {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: boolean\n title?: string\n subTitle?: string\n showStepSubtitle?: boolean\n showStepper?: boolean\n showStepperLabels?: boolean\n stepperType?: "numbers" | "progress bar"\n hideNextButton?: boolean\n name: string\n stepId?: string\n schema: unknown\n uischema: unknown\n maxWidth?: "small" | "medium" | "large" | "extra large"\n }>\n design?: {\n logoUrl?: string\n theme?: Record<string, unknown>\n designTokens?: object\n }\n rules?: Array<{\n type: "inject" | "injectWithKey"\n sourceType: "journey" | "step" | "block"\n source: string\n target: string\n }>\n logics?: Array<{\n autoGeneratedId?: string\n conditions: string[]\n actions: string[]\n }>\n logicsV4?: Record<string, {\n id?: string // uuid\n protected?: boolean\n action?: string\n triggeredOn?: string\n conditions?: Array<Array<{\n operator?: { ... }\n functionName?: { ... }\n fact?: { ... }\n value?: { ... }\n args?: { ... }\n }>>\n settings?: object\n }>\n contextSchema?: Array<{\n id?: string // uuid\n type: string\n paramKey: string\n isRequired?: boolean\n shouldLoadEntity?: boolean\n description?: string\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: {\n mode?: { ... }\n lang?: { ... }\n width?: { ... }\n topBar?: { ... }\n scrollToTop?: { ... }\n button?: { ... }\n }\n safeModeAutomation?: boolean\n canary?: boolean\n designId: string\n templateId?: string\n entityId?: string\n mappingsAutomationId?: string\n newMappings?: boolean\n targetedCustomer?: string\n description?: string\n organizationSettings?: Record<string, boolean>\n publicToken?: string\n runtimeEntities?: "ORDER" | "OPPORTUNITY"[]\n filePurposes?: string[]\n entityTags?: string[]\n addressSuggestionsFileUrl?: string\n addressSuggestionsFileId?: string\n addressSuggestionsCountryCode?: string\n addressSuggestionsEnableAutoComplete?: boolean\n addressSuggestionsSource?: string[]\n addressSuggestionsEnableFreeText?: boolean\n useNewDesign?: boolean\n useAustrianLabels?: boolean\n enableDarkMode?: boolean\n accessMode?: "PUBLIC" | "PRIVATE"\n authGate?: {\n stepId: { ... }\n }\n isPublished?: boolean\n status?: string\n isActive?: boolean\n // ...\n}\n```\n\n### `PublishRevisionRequest`\n\n```ts\ntype PublishRevisionRequest = {\n revision_id: string\n name?: string\n description?: string\n}\n```\n\n### `JourneyRevisionSummary`\n\n```ts\ntype JourneyRevisionSummary = {\n revision_id: string\n created_at: string // date-time\n created_by?: string\n name?: string\n description?: string\n published_at?: string // date-time\n is_published: boolean\n mapping_config_version?: number\n}\n```\n\n### `JourneyRevisionList`\n\n```ts\ntype JourneyRevisionList = {\n results: Array<{\n revision_id: string\n created_at: string // date-time\n created_by?: string\n name?: string\n description?: string\n published_at?: string // date-time\n is_published: boolean\n mapping_config_version?: number\n }>\n next_cursor?: string\n}\n```\n\n### `JourneyRevision`\n\n```ts\ntype JourneyRevision = {\n revision_id: string\n created_at: string // date-time\n created_by?: string\n name?: string\n description?: string\n published_at?: string // date-time\n is_published: boolean\n mapping_config_version?: number\n configuration: {\n journeyId?: string\n organizationId: string\n brandId?: string\n name: string\n steps: Array<{\n showStepName?: { ... }\n title?: { ... }\n subTitle?: { ... }\n showStepSubtitle?: { ... }\n showStepper?: { ... }\n showStepperLabels?: { ... }\n stepperType?: { ... }\n hideNextButton?: { ... }\n name: { ... }\n stepId?: { ... }\n schema: { ... }\n uischema: { ... }\n maxWidth?: { ... }\n }>\n design?: {\n logoUrl?: { ... }\n theme?: { ... }\n designTokens?: { ... }\n }\n rules?: Array<{\n type: { ... }\n sourceType: { ... }\n source: { ... }\n target: { ... }\n }>\n logics?: Array<{\n autoGeneratedId?: { ... }\n conditions: { ... }\n actions: { ... }\n }>\n logicsV4?: Record<string, {\n id?: { ... }\n protected?: { ... }\n action?: { ... }\n triggeredOn?: { ... }\n conditions?: { ... }\n settings?: { ... }\n }>\n contextSchema?: Array<{\n id?: { ... }\n type: { ... }\n paramKey: { ... }\n isRequired?: { ... }\n shouldLoadEntity?: { ... }\n description?: { ... }\n }>\n journey_type?: string\n protected?: boolean\n protectedEditable?: string[]\n settings?: {\n embedOptions?: { ... }\n safeModeAutomation?: { ... }\n canary?: { ... }\n designId: { ... }\n templateId?: { ... }\n entityId?: { ... }\n mappingsAutomationId?: { ... }\n newMappings?: { ... }\n targetedCustomer?: { ... }\n description?: { ... }\n organizationSettings?: { ... }\n publicToken?: { ... }\n runtimeEntities?: { ... }\n filePurposes?: { ... }\n entityTags?: { ... }\n addressSuggestionsFileUrl?: { ... }\n addressSuggestionsFileId?: { ... }\n addressSuggestionsCountryCode?: { ... }\n addressSuggestionsEnableAutoComplete?: { ... }\n addressSuggestionsSource?: { ... }\n addressSuggestionsEnableFreeText?: { ... }\n useNewDesign?: { ... }\n useAustrianLabels?: { ... }\n enableDarkMode?: { ... }\n accessMode?: { ... }\n authGate?: { ... }\n isPublished?: { ... }\n status?: { ... }\n isActive?: { ... }\n savingProgress?: { ... }\n thirdPartyCookies?: { ... }\n }\n validationRules?: Record<string, string | string[] | Record<string, string | string[]>>\n _manifest?: string // uuid[]\n createdBy?: string\n // ...\n}\n```\n\n### `JourneyRevisionConflict`\n\n```ts\ntype JourneyRevisionConflict = {\n message: string\n latest_revision: {\n revision_id: string\n created_at: string // date-time\n created_by?: string\n name?: string\n description?: string\n published_at?: string // date-time\n is_published: boolean\n mapping_config_version?: number\n }\n}\n```\n\n### `JourneyPublishState`\n\n```ts\ntype JourneyPublishState = {\n journey_id: string // uuid\n published_revision_id: string\n published_at?: string // date-time\n published_by?: string\n}\n```\n\n### `PublishResult`\n\n```ts\ntype PublishResult = {\n revision_id: string\n name: string\n published_at: string // date-time\n published_by?: string\n post_publish_warnings: string[]\n}\n```\n\n### `JourneyValidationResponse`\n\n```ts\ntype JourneyValidationResponse = {\n valid: boolean\n errors: Array<{\n type?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n affectedStepIds?: string[]\n count?: number\n autoFix?: {\n feasible?: { ... }\n confidence?: { ... }\n reason?: { ... }\n details?: { ... }\n }\n }>\n warnings?: Array<{\n type?: string\n message?: string\n }>\n}\n```\n\n### `JourneyValidationError`\n\n```ts\ntype JourneyValidationError = {\n error: string\n message: string\n details: Array<{\n pattern?: string\n severity?: "critical" | "high" | "medium" | "low"\n message?: string\n count?: number\n }>\n}\n```\n\n### `S3Reference`\n\n```ts\ntype S3Reference = {\n bucket: string\n key: string\n}\n```\n\n### `TemplateSettings`\n\nTemplate Settings for document generation\n\n```ts\ntype TemplateSettings = {\n custom_margins?: {\n top?: number\n bottom?: number\n }\n suggested_margins?: {\n top?: number\n bottom?: number\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n}\n```\n\n### `GenerateDocumentResponse`\n\n```ts\ntype GenerateDocumentResponse = {\n job_id?: string // uuid\n job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED"\n message?: string\n pdf_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n docx_output?: {\n preview_url?: string\n output_document?: {\n filename?: { ... }\n s3ref?: { ... }\n }\n }\n variable_payload?: {\n additionalProperties?: string\n }\n template_settings?: {\n custom_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n suggested_margins?: {\n top?: { ... }\n bottom?: { ... }\n }\n display_margin_guidelines?: boolean\n enable_data_table_margin_autofix?: boolean\n template_with_datatable?: boolean\n enabled_template_settings_persistence?: boolean\n misconfigured_margins?: boolean\n file_entity_id?: string // uuid\n }\n}\n```\n\n### `GenerateDocumentRequest`\n\n```ts\ntype GenerateDocumentRequest = {\n file_id: string\n context_data: {\n additionalProperties?: string\n }\n context_entity_id?: string // uuid\n language?: string\n}\n```\n\n### `GetSettingsForJourney`\n\n```ts\ntype GetSettingsForJourney = {\n organizationId?: string\n canary?: boolean\n thirdPartyCookies?: boolean\n}\n```\n\n### `ButtonOption`\n\nA single button option data\n\n```ts\ntype ButtonOption = {\n value?: string\n label?: string\n}\n```\n\n### `ValidationRuleRef`\n\nReferences to validation rules organized by blocks and fields.\nMaps block IDs to either one or more ordered rule IDs (for block-level rules)\nor rule references (for field-level rules).\n\n\n```ts\ntype ValidationRuleRef = Record<string, string | string[] | Record<string, string | string[]>>\n```\n\n### `RuleRef`\n\nField-level rule references within a block.\nMaps field names to one or more ordered rule IDs.\n\n\n```ts\ntype RuleRef = Record<string, string | string[]>\n```\n';
|
|
5
|
+
export {
|
|
6
|
+
journey_default as default
|
|
7
|
+
};
|