@epilot/sdk 2.20.9 → 2.20.10
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/file-runtime.json +1 -1
- package/definitions/file.json +392 -0
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +526 -5
- 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/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 +24 -6
- package/dist/apis/entity.d.cts +15 -1
- package/dist/apis/entity.d.ts +15 -1
- package/dist/apis/entity.js +19 -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 +8 -8
- package/dist/apis/file.d.cts +2 -2
- package/dist/apis/file.d.ts +2 -2
- package/dist/apis/file.js +2 -2
- 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.js +1 -1
- package/dist/apis/journey.cjs +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +2 -2
- 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 -27
- package/dist/apis/pricing.d.cts +1 -13
- package/dist/apis/pricing.d.ts +1 -13
- package/dist/apis/pricing.js +1 -22
- 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-5S2PEECD.cjs → chunk-424JLS5G.cjs} +1 -1
- package/dist/{chunk-JBFTKLP2.js → chunk-A7UIYIBZ.js} +4 -4
- package/dist/chunk-FGQBS7TA.js +14 -0
- package/dist/chunk-HL4MZXEK.js +14 -0
- package/dist/{chunk-VCD3C4UW.cjs → chunk-VAGYR2R6.cjs} +4 -4
- package/dist/chunk-W6R2J6KQ.cjs +14 -0
- package/dist/file-LFOTXMRJ.cjs +7 -0
- package/dist/file-ND2JH5EM.js +7 -0
- package/dist/file-runtime-JL2IZ2CE.cjs +5 -0
- package/dist/{file-runtime-423SISQ2.js → file-runtime-RS4DX5LB.js} +1 -1
- package/dist/{file.d-CBsXF4W8.d.cts → file.d-DELNV63w.d.cts} +340 -9
- package/dist/{file.d-CBsXF4W8.d.ts → file.d-DELNV63w.d.ts} +340 -9
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/journey-FNWHSZW3.js +7 -0
- package/dist/journey-FUJDOH5O.cjs +7 -0
- package/dist/{journey-runtime-PAJVCFMZ.cjs → journey-runtime-EFWGEDUE.cjs} +2 -2
- package/dist/{journey-runtime-33QDS2WK.js → journey-runtime-VCADGDRV.js} +1 -1
- package/dist/{journey.d-bxl2l7qg.d.cts → journey.d-6Bs1uNLT.d.cts} +1062 -14
- package/dist/{journey.d-bxl2l7qg.d.ts → journey.d-6Bs1uNLT.d.ts} +1062 -14
- package/docs/file.md +272 -0
- package/docs/journey.md +676 -0
- package/package.json +1 -1
- package/dist/chunk-CIKDOXDL.cjs +0 -14
- package/dist/chunk-IBMGFLXF.js +0 -14
- package/dist/chunk-XJUB5BYM.js +0 -14
- package/dist/file-M5HNKOPG.cjs +0 -7
- package/dist/file-ZUNCUDBY.js +0 -7
- package/dist/file-runtime-IHVDQNIX.cjs +0 -5
- package/dist/journey-2HHH7MLM.js +0 -7
- package/dist/journey-4CXKZMKV.cjs +0 -7
|
@@ -421,7 +421,15 @@ declare namespace Components {
|
|
|
421
421
|
createdAt: string;
|
|
422
422
|
lastModifiedAt: string;
|
|
423
423
|
deletedAt?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Revision row number of this item. `0` is the journey record, the published version.
|
|
426
|
+
*
|
|
427
|
+
*/
|
|
424
428
|
version: number;
|
|
429
|
+
/**
|
|
430
|
+
* Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on `PUT`, by submissions (`journey_context.journey_revision`) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via `publish-state`.
|
|
431
|
+
*
|
|
432
|
+
*/
|
|
425
433
|
revisions: number;
|
|
426
434
|
featureFlags?: {
|
|
427
435
|
[name: string]: any;
|
|
@@ -443,7 +451,15 @@ declare namespace Components {
|
|
|
443
451
|
createdAt: string;
|
|
444
452
|
lastModifiedAt: string;
|
|
445
453
|
deletedAt?: string;
|
|
454
|
+
/**
|
|
455
|
+
* Revision row number of this item. `0` is the journey record, the published version.
|
|
456
|
+
*
|
|
457
|
+
*/
|
|
446
458
|
version: number;
|
|
459
|
+
/**
|
|
460
|
+
* Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on `PUT`, by submissions (`journey_context.journey_revision`) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via `publish-state`.
|
|
461
|
+
*
|
|
462
|
+
*/
|
|
447
463
|
revisions: number;
|
|
448
464
|
}
|
|
449
465
|
export interface JourneyCreationRequest {
|
|
@@ -1000,20 +1016,709 @@ declare namespace Components {
|
|
|
1000
1016
|
_schema?: string;
|
|
1001
1017
|
_title?: string;
|
|
1002
1018
|
name?: string;
|
|
1003
|
-
_id?: string;
|
|
1004
|
-
_org?: string;
|
|
1005
|
-
code?: string;
|
|
1019
|
+
_id?: string;
|
|
1020
|
+
_org?: string;
|
|
1021
|
+
code?: string;
|
|
1022
|
+
description?: string;
|
|
1023
|
+
feature?: any[];
|
|
1024
|
+
product_images?: any[];
|
|
1025
|
+
legal_footnote?: string;
|
|
1026
|
+
product_downloads?: any[];
|
|
1027
|
+
price?: {
|
|
1028
|
+
[key: string]: any;
|
|
1029
|
+
};
|
|
1030
|
+
}[];
|
|
1031
|
+
export interface JourneyPublishState {
|
|
1032
|
+
journey_id: string; // uuid
|
|
1033
|
+
/**
|
|
1034
|
+
* An explicit `null` means the journey has not adopted versioning yet: it exists, customers receive its journey record, and no revision is the published version.
|
|
1035
|
+
*
|
|
1036
|
+
* example:
|
|
1037
|
+
* 42
|
|
1038
|
+
*/
|
|
1039
|
+
published_revision_id: string | null;
|
|
1040
|
+
published_at?: string; // date-time
|
|
1041
|
+
published_by?: string;
|
|
1042
|
+
}
|
|
1043
|
+
export interface JourneyResponse {
|
|
1044
|
+
createdJourney?: Journey;
|
|
1045
|
+
}
|
|
1046
|
+
export interface JourneyRevision {
|
|
1047
|
+
/**
|
|
1048
|
+
* Opaque identifier of the revision. Moves on every save.
|
|
1049
|
+
* example:
|
|
1050
|
+
* 42
|
|
1051
|
+
*/
|
|
1052
|
+
revision_id: string;
|
|
1053
|
+
created_at: string; // date-time
|
|
1054
|
+
/**
|
|
1055
|
+
* User id of the author. Absent for revisions recorded from writes without a user, e.g. blueprint installs.
|
|
1056
|
+
*
|
|
1057
|
+
*/
|
|
1058
|
+
created_by?: string;
|
|
1059
|
+
/**
|
|
1060
|
+
* Set at publish time only, so present if and only if this revision has been published at least once.
|
|
1061
|
+
*
|
|
1062
|
+
* example:
|
|
1063
|
+
* Summer campaign
|
|
1064
|
+
*/
|
|
1065
|
+
name?: string;
|
|
1066
|
+
description?: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* The last time this revision was published. Not the same question as `is_published`: a revision that was the published version yesterday still carries a `published_at`.
|
|
1069
|
+
*
|
|
1070
|
+
*/
|
|
1071
|
+
published_at?: string; // date-time
|
|
1072
|
+
/**
|
|
1073
|
+
* Whether this revision is the published version right now.
|
|
1074
|
+
*/
|
|
1075
|
+
is_published: boolean;
|
|
1076
|
+
/**
|
|
1077
|
+
* Version of the entity-mapping config stored alongside this revision.
|
|
1078
|
+
* example:
|
|
1079
|
+
* 12
|
|
1080
|
+
*/
|
|
1081
|
+
mapping_config_version?: number;
|
|
1082
|
+
/**
|
|
1083
|
+
* The journey configuration as it was saved in this revision, in the shape the builder holds a journey in.
|
|
1084
|
+
*
|
|
1085
|
+
*/
|
|
1086
|
+
configuration: {
|
|
1087
|
+
[name: string]: any;
|
|
1088
|
+
journeyId?: string;
|
|
1089
|
+
organizationId: string;
|
|
1090
|
+
brandId?: string;
|
|
1091
|
+
name: string;
|
|
1092
|
+
steps: {
|
|
1093
|
+
showStepName?: boolean | null;
|
|
1094
|
+
title?: string | null;
|
|
1095
|
+
subTitle?: string | null;
|
|
1096
|
+
showStepSubtitle?: boolean | null;
|
|
1097
|
+
showStepper?: boolean | null;
|
|
1098
|
+
showStepperLabels?: boolean | null;
|
|
1099
|
+
stepperType?: "numbers" | "progress bar";
|
|
1100
|
+
hideNextButton?: boolean | null;
|
|
1101
|
+
name: string;
|
|
1102
|
+
stepId?: string;
|
|
1103
|
+
schema: any;
|
|
1104
|
+
uischema: any;
|
|
1105
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1106
|
+
}[];
|
|
1107
|
+
design?: {
|
|
1108
|
+
logoUrl?: string | null;
|
|
1109
|
+
theme?: {
|
|
1110
|
+
[name: string]: any;
|
|
1111
|
+
};
|
|
1112
|
+
designTokens?: {
|
|
1113
|
+
[key: string]: any;
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
rules?: {
|
|
1117
|
+
type: "inject" | "injectWithKey";
|
|
1118
|
+
sourceType: "journey" | "step" | "block";
|
|
1119
|
+
source: string;
|
|
1120
|
+
target: string;
|
|
1121
|
+
}[];
|
|
1122
|
+
logics?: {
|
|
1123
|
+
autoGeneratedId?: string;
|
|
1124
|
+
conditions: string[];
|
|
1125
|
+
actions: string[];
|
|
1126
|
+
}[];
|
|
1127
|
+
logicsV4?: {
|
|
1128
|
+
[name: string]: {
|
|
1129
|
+
/**
|
|
1130
|
+
* Unique identifier for logic. Use uuidv7
|
|
1131
|
+
*/
|
|
1132
|
+
id?: string; // uuid
|
|
1133
|
+
/**
|
|
1134
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1135
|
+
*/
|
|
1136
|
+
protected?: boolean;
|
|
1137
|
+
/**
|
|
1138
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1139
|
+
*/
|
|
1140
|
+
action?: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* Indicates when the logic should be evaluated
|
|
1143
|
+
*/
|
|
1144
|
+
triggeredOn?: string;
|
|
1145
|
+
conditions?: {
|
|
1146
|
+
/**
|
|
1147
|
+
* Operator to be applied between the fact value and the value
|
|
1148
|
+
*/
|
|
1149
|
+
operator?: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* If operator is a custom function, this needs to be provided
|
|
1152
|
+
*/
|
|
1153
|
+
functionName?: string;
|
|
1154
|
+
fact?: {
|
|
1155
|
+
/**
|
|
1156
|
+
* Unique identifier for a fact
|
|
1157
|
+
*/
|
|
1158
|
+
id?: string; // uuid
|
|
1159
|
+
/**
|
|
1160
|
+
* Indicates reference type (block or context parameter)
|
|
1161
|
+
*/
|
|
1162
|
+
referenceType?: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* Id of the reference
|
|
1165
|
+
*/
|
|
1166
|
+
referenceId?: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Path to a property. Used if only part of the value is needed
|
|
1169
|
+
*/
|
|
1170
|
+
path?: string;
|
|
1171
|
+
/**
|
|
1172
|
+
* If path is a reference, indicates the intention of it
|
|
1173
|
+
*/
|
|
1174
|
+
meaning?: string;
|
|
1175
|
+
};
|
|
1176
|
+
value?: string | number | boolean | {
|
|
1177
|
+
[key: string]: any;
|
|
1178
|
+
} | any[];
|
|
1179
|
+
args?: {
|
|
1180
|
+
[key: string]: any;
|
|
1181
|
+
};
|
|
1182
|
+
}[][];
|
|
1183
|
+
/**
|
|
1184
|
+
* Logic specific settings. Will vary by type of logic
|
|
1185
|
+
*/
|
|
1186
|
+
settings?: {
|
|
1187
|
+
[key: string]: any;
|
|
1188
|
+
};
|
|
1189
|
+
};
|
|
1190
|
+
};
|
|
1191
|
+
contextSchema?: {
|
|
1192
|
+
/**
|
|
1193
|
+
* Unique identifier for the context schema item
|
|
1194
|
+
*/
|
|
1195
|
+
id?: string; // uuid
|
|
1196
|
+
/**
|
|
1197
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1198
|
+
*/
|
|
1199
|
+
type: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* Expected key to be received in the context
|
|
1202
|
+
*/
|
|
1203
|
+
paramKey: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* Indicates if a value is expected to be provided
|
|
1206
|
+
*/
|
|
1207
|
+
isRequired?: boolean;
|
|
1208
|
+
/**
|
|
1209
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1210
|
+
*/
|
|
1211
|
+
shouldLoadEntity?: boolean;
|
|
1212
|
+
/**
|
|
1213
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1214
|
+
*/
|
|
1215
|
+
description?: string | null;
|
|
1216
|
+
}[];
|
|
1217
|
+
/**
|
|
1218
|
+
* Journey Template
|
|
1219
|
+
* example:
|
|
1220
|
+
* Sales template (Premium)
|
|
1221
|
+
*/
|
|
1222
|
+
journey_type?: string;
|
|
1223
|
+
/**
|
|
1224
|
+
* If true, journey is displayed in read-only mode
|
|
1225
|
+
*/
|
|
1226
|
+
protected?: boolean;
|
|
1227
|
+
/**
|
|
1228
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
1229
|
+
*/
|
|
1230
|
+
protectedEditable?: string[];
|
|
1231
|
+
settings?: {
|
|
1232
|
+
embedOptions?: {
|
|
1233
|
+
mode?: "full-screen" | "inline";
|
|
1234
|
+
/**
|
|
1235
|
+
* example:
|
|
1236
|
+
* de
|
|
1237
|
+
*/
|
|
1238
|
+
lang?: string;
|
|
1239
|
+
width?: string;
|
|
1240
|
+
topBar?: boolean;
|
|
1241
|
+
scrollToTop?: boolean;
|
|
1242
|
+
button?: {
|
|
1243
|
+
text?: string | null;
|
|
1244
|
+
align?: "left" | "center" | "right";
|
|
1245
|
+
};
|
|
1246
|
+
};
|
|
1247
|
+
safeModeAutomation?: boolean;
|
|
1248
|
+
/**
|
|
1249
|
+
* DEPRECATED - This API will return hardcoded value of false. Please note that this field is internal to epilot and should not be used by external clients. If you wish to get the canary flag, please use the /v1/journey/{id}/settings API.
|
|
1250
|
+
*/
|
|
1251
|
+
canary?: boolean;
|
|
1252
|
+
designId: string;
|
|
1253
|
+
templateId?: string | null;
|
|
1254
|
+
entityId?: string | null;
|
|
1255
|
+
mappingsAutomationId?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
1258
|
+
*/
|
|
1259
|
+
newMappings?: boolean;
|
|
1260
|
+
targetedCustomer?: string;
|
|
1261
|
+
description?: string | null;
|
|
1262
|
+
organizationSettings?: {
|
|
1263
|
+
[name: string]: boolean;
|
|
1264
|
+
} | null;
|
|
1265
|
+
publicToken?: string | null;
|
|
1266
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
1267
|
+
filePurposes?: string[];
|
|
1268
|
+
entityTags?: string[];
|
|
1269
|
+
/**
|
|
1270
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
1271
|
+
*/
|
|
1272
|
+
addressSuggestionsFileUrl?: string | null;
|
|
1273
|
+
addressSuggestionsFileId?: string | null;
|
|
1274
|
+
/**
|
|
1275
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
1276
|
+
*/
|
|
1277
|
+
addressSuggestionsCountryCode?: string | null;
|
|
1278
|
+
/**
|
|
1279
|
+
* Whether address auto-complete is enabled
|
|
1280
|
+
*/
|
|
1281
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
1282
|
+
/**
|
|
1283
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
1284
|
+
*/
|
|
1285
|
+
addressSuggestionsSource?: string[];
|
|
1286
|
+
/**
|
|
1287
|
+
* Whether free text input is allowed when auto-complete is on
|
|
1288
|
+
*/
|
|
1289
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
1290
|
+
/**
|
|
1291
|
+
* This property is deprecated and will be removed in a future version
|
|
1292
|
+
*/
|
|
1293
|
+
useNewDesign?: boolean;
|
|
1294
|
+
/**
|
|
1295
|
+
* If true, some journey input labels are in Austrian format
|
|
1296
|
+
*/
|
|
1297
|
+
useAustrianLabels?: boolean;
|
|
1298
|
+
/**
|
|
1299
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
1300
|
+
*/
|
|
1301
|
+
enableDarkMode?: boolean;
|
|
1302
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
1303
|
+
/**
|
|
1304
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
1305
|
+
*/
|
|
1306
|
+
authGate?: {
|
|
1307
|
+
/**
|
|
1308
|
+
* The step containing the Login & Registration block
|
|
1309
|
+
*/
|
|
1310
|
+
stepId: string;
|
|
1311
|
+
};
|
|
1312
|
+
isPublished?: boolean;
|
|
1313
|
+
status?: string;
|
|
1314
|
+
isActive?: boolean;
|
|
1315
|
+
savingProgress?: {
|
|
1316
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
1317
|
+
supportedRevision?: number;
|
|
1318
|
+
};
|
|
1319
|
+
/**
|
|
1320
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
1321
|
+
*/
|
|
1322
|
+
thirdPartyCookies?: boolean;
|
|
1323
|
+
};
|
|
1324
|
+
validationRules?: /**
|
|
1325
|
+
* References to validation rules organized by blocks and fields.
|
|
1326
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1327
|
+
* or rule references (for field-level rules).
|
|
1328
|
+
*
|
|
1329
|
+
* example:
|
|
1330
|
+
* {
|
|
1331
|
+
* "block1": "rule123",
|
|
1332
|
+
* "block2": [
|
|
1333
|
+
* "rule456",
|
|
1334
|
+
* "rule789"
|
|
1335
|
+
* ],
|
|
1336
|
+
* "block3": {
|
|
1337
|
+
* "field1": "rule101",
|
|
1338
|
+
* "field2": [
|
|
1339
|
+
* "rule102",
|
|
1340
|
+
* "rule103"
|
|
1341
|
+
* ]
|
|
1342
|
+
* }
|
|
1343
|
+
* }
|
|
1344
|
+
*/
|
|
1345
|
+
ValidationRuleRef;
|
|
1346
|
+
/**
|
|
1347
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
1348
|
+
*/
|
|
1349
|
+
_manifest?: string /* uuid */[];
|
|
1350
|
+
createdBy?: string;
|
|
1351
|
+
updatedBy?: string | null;
|
|
1352
|
+
/**
|
|
1353
|
+
* If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
|
|
1354
|
+
*/
|
|
1355
|
+
__lastModifiedAt?: string | null;
|
|
1356
|
+
createdAt: string;
|
|
1357
|
+
lastModifiedAt: string;
|
|
1358
|
+
deletedAt?: string;
|
|
1359
|
+
/**
|
|
1360
|
+
* Revision row number of this item. `0` is the journey record, the published version.
|
|
1361
|
+
*
|
|
1362
|
+
*/
|
|
1363
|
+
version: number;
|
|
1364
|
+
/**
|
|
1365
|
+
* Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on `PUT`, by submissions (`journey_context.journey_revision`) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via `publish-state`.
|
|
1366
|
+
*
|
|
1367
|
+
*/
|
|
1368
|
+
revisions: number;
|
|
1369
|
+
featureFlags?: {
|
|
1370
|
+
[name: string]: any;
|
|
1371
|
+
};
|
|
1372
|
+
};
|
|
1373
|
+
}
|
|
1374
|
+
export interface JourneyRevisionConflict {
|
|
1375
|
+
/**
|
|
1376
|
+
* example:
|
|
1377
|
+
* The journey has been saved since your editor loaded it
|
|
1378
|
+
*/
|
|
1379
|
+
message: string;
|
|
1380
|
+
latest_revision: JourneyRevisionSummary;
|
|
1381
|
+
}
|
|
1382
|
+
export interface JourneyRevisionList {
|
|
1383
|
+
results: JourneyRevisionSummary[];
|
|
1384
|
+
/**
|
|
1385
|
+
* Opaque cursor to pass back as `cursor` to fetch the next page. Absent when the client has reached the end of the history.
|
|
1386
|
+
*
|
|
1387
|
+
*/
|
|
1388
|
+
next_cursor?: string;
|
|
1389
|
+
}
|
|
1390
|
+
/**
|
|
1391
|
+
* The 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.
|
|
1392
|
+
*
|
|
1393
|
+
*/
|
|
1394
|
+
export interface JourneyRevisionRequest {
|
|
1395
|
+
[name: string]: any;
|
|
1396
|
+
journeyId?: string;
|
|
1397
|
+
organizationId: string;
|
|
1398
|
+
brandId?: string;
|
|
1399
|
+
name: string;
|
|
1400
|
+
steps: {
|
|
1401
|
+
showStepName?: boolean | null;
|
|
1402
|
+
title?: string | null;
|
|
1403
|
+
subTitle?: string | null;
|
|
1404
|
+
showStepSubtitle?: boolean | null;
|
|
1405
|
+
showStepper?: boolean | null;
|
|
1406
|
+
showStepperLabels?: boolean | null;
|
|
1407
|
+
stepperType?: "numbers" | "progress bar";
|
|
1408
|
+
hideNextButton?: boolean | null;
|
|
1409
|
+
name: string;
|
|
1410
|
+
stepId?: string;
|
|
1411
|
+
schema: any;
|
|
1412
|
+
uischema: any;
|
|
1413
|
+
maxWidth?: "small" | "medium" | "large" | "extra large";
|
|
1414
|
+
}[];
|
|
1415
|
+
design?: {
|
|
1416
|
+
logoUrl?: string | null;
|
|
1417
|
+
theme?: {
|
|
1418
|
+
[name: string]: any;
|
|
1419
|
+
};
|
|
1420
|
+
designTokens?: {
|
|
1421
|
+
[key: string]: any;
|
|
1422
|
+
};
|
|
1423
|
+
};
|
|
1424
|
+
rules?: {
|
|
1425
|
+
type: "inject" | "injectWithKey";
|
|
1426
|
+
sourceType: "journey" | "step" | "block";
|
|
1427
|
+
source: string;
|
|
1428
|
+
target: string;
|
|
1429
|
+
}[];
|
|
1430
|
+
logics?: {
|
|
1431
|
+
autoGeneratedId?: string;
|
|
1432
|
+
conditions: string[];
|
|
1433
|
+
actions: string[];
|
|
1434
|
+
}[];
|
|
1435
|
+
logicsV4?: {
|
|
1436
|
+
[name: string]: {
|
|
1437
|
+
/**
|
|
1438
|
+
* Unique identifier for logic. Use uuidv7
|
|
1439
|
+
*/
|
|
1440
|
+
id?: string; // uuid
|
|
1441
|
+
/**
|
|
1442
|
+
* If true, logic can't be manipulated by the configuring user
|
|
1443
|
+
*/
|
|
1444
|
+
protected?: boolean;
|
|
1445
|
+
/**
|
|
1446
|
+
* Indicates which action to take in case logic evaluates to true
|
|
1447
|
+
*/
|
|
1448
|
+
action?: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* Indicates when the logic should be evaluated
|
|
1451
|
+
*/
|
|
1452
|
+
triggeredOn?: string;
|
|
1453
|
+
conditions?: {
|
|
1454
|
+
/**
|
|
1455
|
+
* Operator to be applied between the fact value and the value
|
|
1456
|
+
*/
|
|
1457
|
+
operator?: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* If operator is a custom function, this needs to be provided
|
|
1460
|
+
*/
|
|
1461
|
+
functionName?: string;
|
|
1462
|
+
fact?: {
|
|
1463
|
+
/**
|
|
1464
|
+
* Unique identifier for a fact
|
|
1465
|
+
*/
|
|
1466
|
+
id?: string; // uuid
|
|
1467
|
+
/**
|
|
1468
|
+
* Indicates reference type (block or context parameter)
|
|
1469
|
+
*/
|
|
1470
|
+
referenceType?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* Id of the reference
|
|
1473
|
+
*/
|
|
1474
|
+
referenceId?: string;
|
|
1475
|
+
/**
|
|
1476
|
+
* Path to a property. Used if only part of the value is needed
|
|
1477
|
+
*/
|
|
1478
|
+
path?: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* If path is a reference, indicates the intention of it
|
|
1481
|
+
*/
|
|
1482
|
+
meaning?: string;
|
|
1483
|
+
};
|
|
1484
|
+
value?: string | number | boolean | {
|
|
1485
|
+
[key: string]: any;
|
|
1486
|
+
} | any[];
|
|
1487
|
+
args?: {
|
|
1488
|
+
[key: string]: any;
|
|
1489
|
+
};
|
|
1490
|
+
}[][];
|
|
1491
|
+
/**
|
|
1492
|
+
* Logic specific settings. Will vary by type of logic
|
|
1493
|
+
*/
|
|
1494
|
+
settings?: {
|
|
1495
|
+
[key: string]: any;
|
|
1496
|
+
};
|
|
1497
|
+
};
|
|
1498
|
+
};
|
|
1499
|
+
contextSchema?: {
|
|
1500
|
+
/**
|
|
1501
|
+
* Unique identifier for the context schema item
|
|
1502
|
+
*/
|
|
1503
|
+
id?: string; // uuid
|
|
1504
|
+
/**
|
|
1505
|
+
* Type of the parameter. It could be either an entity slug, or a text
|
|
1506
|
+
*/
|
|
1507
|
+
type: string;
|
|
1508
|
+
/**
|
|
1509
|
+
* Expected key to be received in the context
|
|
1510
|
+
*/
|
|
1511
|
+
paramKey: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* Indicates if a value is expected to be provided
|
|
1514
|
+
*/
|
|
1515
|
+
isRequired?: boolean;
|
|
1516
|
+
/**
|
|
1517
|
+
* If type is not text, we can instruct the journey to fetch the entity id we receive as value
|
|
1518
|
+
*/
|
|
1519
|
+
shouldLoadEntity?: boolean;
|
|
1520
|
+
/**
|
|
1521
|
+
* Human-readable note describing the parameter's purpose. Free text; may contain newlines.
|
|
1522
|
+
*/
|
|
1523
|
+
description?: string | null;
|
|
1524
|
+
}[];
|
|
1525
|
+
/**
|
|
1526
|
+
* Journey Template
|
|
1527
|
+
* example:
|
|
1528
|
+
* Sales template (Premium)
|
|
1529
|
+
*/
|
|
1530
|
+
journey_type?: string;
|
|
1531
|
+
/**
|
|
1532
|
+
* If true, journey is displayed in read-only mode
|
|
1533
|
+
*/
|
|
1534
|
+
protected?: boolean;
|
|
1535
|
+
/**
|
|
1536
|
+
* Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
|
|
1537
|
+
*/
|
|
1538
|
+
protectedEditable?: string[];
|
|
1539
|
+
settings?: {
|
|
1540
|
+
embedOptions?: {
|
|
1541
|
+
mode?: "full-screen" | "inline";
|
|
1542
|
+
/**
|
|
1543
|
+
* example:
|
|
1544
|
+
* de
|
|
1545
|
+
*/
|
|
1546
|
+
lang?: string;
|
|
1547
|
+
width?: string;
|
|
1548
|
+
topBar?: boolean;
|
|
1549
|
+
scrollToTop?: boolean;
|
|
1550
|
+
button?: {
|
|
1551
|
+
text?: string | null;
|
|
1552
|
+
align?: "left" | "center" | "right";
|
|
1553
|
+
};
|
|
1554
|
+
};
|
|
1555
|
+
safeModeAutomation?: boolean;
|
|
1556
|
+
/**
|
|
1557
|
+
* DEPRECATED - This API will return hardcoded value of false. Please note that this field is internal to epilot and should not be used by external clients. If you wish to get the canary flag, please use the /v1/journey/{id}/settings API.
|
|
1558
|
+
*/
|
|
1559
|
+
canary?: boolean;
|
|
1560
|
+
designId: string;
|
|
1561
|
+
templateId?: string | null;
|
|
1562
|
+
entityId?: string | null;
|
|
1563
|
+
mappingsAutomationId?: string;
|
|
1564
|
+
/**
|
|
1565
|
+
* When true, the journey is created without a mapping config or automation; mappings are managed as advanced mappings on a lazily created automation.
|
|
1566
|
+
*/
|
|
1567
|
+
newMappings?: boolean;
|
|
1568
|
+
targetedCustomer?: string;
|
|
1569
|
+
description?: string | null;
|
|
1570
|
+
organizationSettings?: {
|
|
1571
|
+
[name: string]: boolean;
|
|
1572
|
+
} | null;
|
|
1573
|
+
publicToken?: string | null;
|
|
1574
|
+
runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
|
|
1575
|
+
filePurposes?: string[];
|
|
1576
|
+
entityTags?: string[];
|
|
1577
|
+
/**
|
|
1578
|
+
* @deprecated Use addressSuggestionsFileId instead
|
|
1579
|
+
*/
|
|
1580
|
+
addressSuggestionsFileUrl?: string | null;
|
|
1581
|
+
addressSuggestionsFileId?: string | null;
|
|
1582
|
+
/**
|
|
1583
|
+
* Country code for address format (e.g. DE, AT, CH, LU)
|
|
1584
|
+
*/
|
|
1585
|
+
addressSuggestionsCountryCode?: string | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* Whether address auto-complete is enabled
|
|
1588
|
+
*/
|
|
1589
|
+
addressSuggestionsEnableAutoComplete?: boolean;
|
|
1590
|
+
/**
|
|
1591
|
+
* Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
|
|
1592
|
+
*/
|
|
1593
|
+
addressSuggestionsSource?: string[];
|
|
1594
|
+
/**
|
|
1595
|
+
* Whether free text input is allowed when auto-complete is on
|
|
1596
|
+
*/
|
|
1597
|
+
addressSuggestionsEnableFreeText?: boolean;
|
|
1598
|
+
/**
|
|
1599
|
+
* This property is deprecated and will be removed in a future version
|
|
1600
|
+
*/
|
|
1601
|
+
useNewDesign?: boolean;
|
|
1602
|
+
/**
|
|
1603
|
+
* If true, some journey input labels are in Austrian format
|
|
1604
|
+
*/
|
|
1605
|
+
useAustrianLabels?: boolean;
|
|
1606
|
+
/**
|
|
1607
|
+
* If true, the journey shows an icon to toggle dark mode
|
|
1608
|
+
*/
|
|
1609
|
+
enableDarkMode?: boolean;
|
|
1610
|
+
accessMode?: "PUBLIC" | "PRIVATE";
|
|
1611
|
+
/**
|
|
1612
|
+
* Steps after this step require an authenticated session (auth gate)
|
|
1613
|
+
*/
|
|
1614
|
+
authGate?: {
|
|
1615
|
+
/**
|
|
1616
|
+
* The step containing the Login & Registration block
|
|
1617
|
+
*/
|
|
1618
|
+
stepId: string;
|
|
1619
|
+
};
|
|
1620
|
+
isPublished?: boolean;
|
|
1621
|
+
status?: string;
|
|
1622
|
+
isActive?: boolean;
|
|
1623
|
+
savingProgress?: {
|
|
1624
|
+
mode?: "auto" | "local" | "remote" | "none";
|
|
1625
|
+
supportedRevision?: number;
|
|
1626
|
+
};
|
|
1627
|
+
/**
|
|
1628
|
+
* If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
|
|
1629
|
+
*/
|
|
1630
|
+
thirdPartyCookies?: boolean;
|
|
1631
|
+
};
|
|
1632
|
+
validationRules?: /**
|
|
1633
|
+
* References to validation rules organized by blocks and fields.
|
|
1634
|
+
* Maps block IDs to either one or more ordered rule IDs (for block-level rules)
|
|
1635
|
+
* or rule references (for field-level rules).
|
|
1636
|
+
*
|
|
1637
|
+
* example:
|
|
1638
|
+
* {
|
|
1639
|
+
* "block1": "rule123",
|
|
1640
|
+
* "block2": [
|
|
1641
|
+
* "rule456",
|
|
1642
|
+
* "rule789"
|
|
1643
|
+
* ],
|
|
1644
|
+
* "block3": {
|
|
1645
|
+
* "field1": "rule101",
|
|
1646
|
+
* "field2": [
|
|
1647
|
+
* "rule102",
|
|
1648
|
+
* "rule103"
|
|
1649
|
+
* ]
|
|
1650
|
+
* }
|
|
1651
|
+
* }
|
|
1652
|
+
*/
|
|
1653
|
+
ValidationRuleRef;
|
|
1654
|
+
/**
|
|
1655
|
+
* Manifest/Blueprint ID used to create/update the entity
|
|
1656
|
+
*/
|
|
1657
|
+
_manifest?: string /* uuid */[];
|
|
1658
|
+
createdBy?: string;
|
|
1659
|
+
updatedBy?: string | null;
|
|
1660
|
+
/**
|
|
1661
|
+
* If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
|
|
1662
|
+
*/
|
|
1663
|
+
__lastModifiedAt?: string | null;
|
|
1664
|
+
/**
|
|
1665
|
+
* The revision the editor started from. When present and not the latest revision the save is rejected with `409`; absent skips the check.
|
|
1666
|
+
*
|
|
1667
|
+
* example:
|
|
1668
|
+
* 41
|
|
1669
|
+
*/
|
|
1670
|
+
parent_revision_id?: string;
|
|
1671
|
+
/**
|
|
1672
|
+
* Provenance, not configuration: the revision that was loaded into the editor before this save, when it was an older one.
|
|
1673
|
+
*
|
|
1674
|
+
* example:
|
|
1675
|
+
* 37
|
|
1676
|
+
*/
|
|
1677
|
+
based_on_revision_id?: string;
|
|
1678
|
+
/**
|
|
1679
|
+
* Version of the entity-mapping config stored alongside this revision. Publishing the revision points the journey's automation at it.
|
|
1680
|
+
*
|
|
1681
|
+
* example:
|
|
1682
|
+
* 12
|
|
1683
|
+
*/
|
|
1684
|
+
mapping_config_version?: number;
|
|
1685
|
+
}
|
|
1686
|
+
export interface JourneyRevisionSummary {
|
|
1687
|
+
/**
|
|
1688
|
+
* Opaque identifier of the revision. Moves on every save.
|
|
1689
|
+
* example:
|
|
1690
|
+
* 42
|
|
1691
|
+
*/
|
|
1692
|
+
revision_id: string;
|
|
1693
|
+
created_at: string; // date-time
|
|
1694
|
+
/**
|
|
1695
|
+
* User id of the author. Absent for revisions recorded from writes without a user, e.g. blueprint installs.
|
|
1696
|
+
*
|
|
1697
|
+
*/
|
|
1698
|
+
created_by?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* Set at publish time only, so present if and only if this revision has been published at least once.
|
|
1701
|
+
*
|
|
1702
|
+
* example:
|
|
1703
|
+
* Summer campaign
|
|
1704
|
+
*/
|
|
1705
|
+
name?: string;
|
|
1006
1706
|
description?: string;
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1707
|
+
/**
|
|
1708
|
+
* The last time this revision was published. Not the same question as `is_published`: a revision that was the published version yesterday still carries a `published_at`.
|
|
1709
|
+
*
|
|
1710
|
+
*/
|
|
1711
|
+
published_at?: string; // date-time
|
|
1712
|
+
/**
|
|
1713
|
+
* Whether this revision is the published version right now.
|
|
1714
|
+
*/
|
|
1715
|
+
is_published: boolean;
|
|
1716
|
+
/**
|
|
1717
|
+
* Version of the entity-mapping config stored alongside this revision.
|
|
1718
|
+
* example:
|
|
1719
|
+
* 12
|
|
1720
|
+
*/
|
|
1721
|
+
mapping_config_version?: number;
|
|
1017
1722
|
}
|
|
1018
1723
|
export interface JourneyValidationError {
|
|
1019
1724
|
/**
|
|
@@ -1095,6 +1800,45 @@ declare namespace Components {
|
|
|
1095
1800
|
*/
|
|
1096
1801
|
__lastModifiedAt?: string | null;
|
|
1097
1802
|
}
|
|
1803
|
+
export interface PublishResult {
|
|
1804
|
+
/**
|
|
1805
|
+
* example:
|
|
1806
|
+
* 42
|
|
1807
|
+
*/
|
|
1808
|
+
revision_id: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* The name now on the revision: the one sent in the request, the one a previous publish set when this request omitted `name`, or the server-generated default.
|
|
1811
|
+
*
|
|
1812
|
+
* example:
|
|
1813
|
+
* Summer campaign
|
|
1814
|
+
*/
|
|
1815
|
+
name: string;
|
|
1816
|
+
published_at: string; // date-time
|
|
1817
|
+
published_by?: string;
|
|
1818
|
+
/**
|
|
1819
|
+
* Names any best-effort side effect that failed after the publish itself succeeded, e.g. the journey entity sync, so a caller can say "published, but the entity did not update".
|
|
1820
|
+
*
|
|
1821
|
+
*/
|
|
1822
|
+
post_publish_warnings: string[];
|
|
1823
|
+
}
|
|
1824
|
+
export interface PublishRevisionRequest {
|
|
1825
|
+
/**
|
|
1826
|
+
* example:
|
|
1827
|
+
* 42
|
|
1828
|
+
*/
|
|
1829
|
+
revision_id: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* Name stamped onto the revision being published. Optional: when omitted the server generates one, so every revision that has ever been published carries a name. An omitted name never replaces a name a previous publish already set; an explicit one does.
|
|
1832
|
+
*
|
|
1833
|
+
* example:
|
|
1834
|
+
* Summer campaign
|
|
1835
|
+
*/
|
|
1836
|
+
name?: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* Optional description stamped onto the revision at publish time
|
|
1839
|
+
*/
|
|
1840
|
+
description?: string;
|
|
1841
|
+
}
|
|
1098
1842
|
/**
|
|
1099
1843
|
* Field-level rule references within a block.
|
|
1100
1844
|
* Maps field names to one or more ordered rule IDs.
|
|
@@ -1388,6 +2132,37 @@ declare namespace Paths {
|
|
|
1388
2132
|
export type $400 = Components.Schemas.JourneyValidationError;
|
|
1389
2133
|
}
|
|
1390
2134
|
}
|
|
2135
|
+
namespace CreateJourneyRevision {
|
|
2136
|
+
namespace Parameters {
|
|
2137
|
+
/**
|
|
2138
|
+
* example:
|
|
2139
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2140
|
+
*/
|
|
2141
|
+
export type Id = string; // uuid
|
|
2142
|
+
}
|
|
2143
|
+
export interface PathParameters {
|
|
2144
|
+
id: /**
|
|
2145
|
+
* example:
|
|
2146
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2147
|
+
*/
|
|
2148
|
+
Parameters.Id /* uuid */;
|
|
2149
|
+
}
|
|
2150
|
+
export type RequestBody = /**
|
|
2151
|
+
* The 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.
|
|
2152
|
+
*
|
|
2153
|
+
*/
|
|
2154
|
+
Components.Schemas.JourneyRevisionRequest;
|
|
2155
|
+
namespace Responses {
|
|
2156
|
+
export type $201 = Components.Schemas.JourneyRevisionSummary;
|
|
2157
|
+
export interface $400 {
|
|
2158
|
+
}
|
|
2159
|
+
export interface $403 {
|
|
2160
|
+
}
|
|
2161
|
+
export interface $404 {
|
|
2162
|
+
}
|
|
2163
|
+
export type $409 = Components.Schemas.JourneyRevisionConflict;
|
|
2164
|
+
}
|
|
2165
|
+
}
|
|
1391
2166
|
namespace CreateJourneyV2 {
|
|
1392
2167
|
namespace Parameters {
|
|
1393
2168
|
/**
|
|
@@ -1764,7 +2539,15 @@ declare namespace Paths {
|
|
|
1764
2539
|
createdAt: string;
|
|
1765
2540
|
lastModifiedAt: string;
|
|
1766
2541
|
deletedAt?: string;
|
|
2542
|
+
/**
|
|
2543
|
+
* Revision row number of this item. `0` is the journey record, the published version.
|
|
2544
|
+
*
|
|
2545
|
+
*/
|
|
1767
2546
|
version: number;
|
|
2547
|
+
/**
|
|
2548
|
+
* Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on `PUT`, by submissions (`journey_context.journey_revision`) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via `publish-state`.
|
|
2549
|
+
*
|
|
2550
|
+
*/
|
|
1768
2551
|
revisions: number;
|
|
1769
2552
|
featureFlags?: {
|
|
1770
2553
|
[name: string]: any;
|
|
@@ -1831,6 +2614,62 @@ declare namespace Paths {
|
|
|
1831
2614
|
export type $200 = Components.Schemas.JourneyProductsResponse;
|
|
1832
2615
|
}
|
|
1833
2616
|
}
|
|
2617
|
+
namespace GetJourneyPublishState {
|
|
2618
|
+
namespace Parameters {
|
|
2619
|
+
/**
|
|
2620
|
+
* example:
|
|
2621
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2622
|
+
*/
|
|
2623
|
+
export type Id = string; // uuid
|
|
2624
|
+
}
|
|
2625
|
+
export interface PathParameters {
|
|
2626
|
+
id: /**
|
|
2627
|
+
* example:
|
|
2628
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2629
|
+
*/
|
|
2630
|
+
Parameters.Id /* uuid */;
|
|
2631
|
+
}
|
|
2632
|
+
namespace Responses {
|
|
2633
|
+
export type $200 = Components.Schemas.JourneyPublishState;
|
|
2634
|
+
export interface $403 {
|
|
2635
|
+
}
|
|
2636
|
+
export interface $404 {
|
|
2637
|
+
}
|
|
2638
|
+
}
|
|
2639
|
+
}
|
|
2640
|
+
namespace GetJourneyRevision {
|
|
2641
|
+
namespace Parameters {
|
|
2642
|
+
/**
|
|
2643
|
+
* example:
|
|
2644
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2645
|
+
*/
|
|
2646
|
+
export type Id = string; // uuid
|
|
2647
|
+
/**
|
|
2648
|
+
* example:
|
|
2649
|
+
* 42
|
|
2650
|
+
*/
|
|
2651
|
+
export type RevisionId = string;
|
|
2652
|
+
}
|
|
2653
|
+
export interface PathParameters {
|
|
2654
|
+
id: /**
|
|
2655
|
+
* example:
|
|
2656
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
2657
|
+
*/
|
|
2658
|
+
Parameters.Id /* uuid */;
|
|
2659
|
+
revision_id: /**
|
|
2660
|
+
* example:
|
|
2661
|
+
* 42
|
|
2662
|
+
*/
|
|
2663
|
+
Parameters.RevisionId;
|
|
2664
|
+
}
|
|
2665
|
+
namespace Responses {
|
|
2666
|
+
export type $200 = Components.Schemas.JourneyRevision;
|
|
2667
|
+
export interface $403 {
|
|
2668
|
+
}
|
|
2669
|
+
export interface $404 {
|
|
2670
|
+
}
|
|
2671
|
+
}
|
|
2672
|
+
}
|
|
1834
2673
|
namespace GetJourneyV2 {
|
|
1835
2674
|
namespace Parameters {
|
|
1836
2675
|
/**
|
|
@@ -2178,6 +3017,37 @@ declare namespace Paths {
|
|
|
2178
3017
|
}
|
|
2179
3018
|
}
|
|
2180
3019
|
}
|
|
3020
|
+
namespace ListJourneyRevisions {
|
|
3021
|
+
namespace Parameters {
|
|
3022
|
+
export type Cursor = string;
|
|
3023
|
+
/**
|
|
3024
|
+
* example:
|
|
3025
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
3026
|
+
*/
|
|
3027
|
+
export type Id = string; // uuid
|
|
3028
|
+
export type Limit = number;
|
|
3029
|
+
}
|
|
3030
|
+
export interface PathParameters {
|
|
3031
|
+
id: /**
|
|
3032
|
+
* example:
|
|
3033
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
3034
|
+
*/
|
|
3035
|
+
Parameters.Id /* uuid */;
|
|
3036
|
+
}
|
|
3037
|
+
export interface QueryParameters {
|
|
3038
|
+
limit?: Parameters.Limit;
|
|
3039
|
+
cursor?: Parameters.Cursor;
|
|
3040
|
+
}
|
|
3041
|
+
namespace Responses {
|
|
3042
|
+
export type $200 = Components.Schemas.JourneyRevisionList;
|
|
3043
|
+
export interface $400 {
|
|
3044
|
+
}
|
|
3045
|
+
export interface $403 {
|
|
3046
|
+
}
|
|
3047
|
+
export interface $404 {
|
|
3048
|
+
}
|
|
3049
|
+
}
|
|
3050
|
+
}
|
|
2181
3051
|
namespace PatchUpdateJourney {
|
|
2182
3052
|
export type RequestBody = /**
|
|
2183
3053
|
* Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
|
|
@@ -2214,6 +3084,34 @@ declare namespace Paths {
|
|
|
2214
3084
|
}
|
|
2215
3085
|
}
|
|
2216
3086
|
}
|
|
3087
|
+
namespace PublishJourneyRevision {
|
|
3088
|
+
namespace Parameters {
|
|
3089
|
+
/**
|
|
3090
|
+
* example:
|
|
3091
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
3092
|
+
*/
|
|
3093
|
+
export type Id = string; // uuid
|
|
3094
|
+
}
|
|
3095
|
+
export interface PathParameters {
|
|
3096
|
+
id: /**
|
|
3097
|
+
* example:
|
|
3098
|
+
* 509cdffe-424f-457a-95c2-9708c304ce77
|
|
3099
|
+
*/
|
|
3100
|
+
Parameters.Id /* uuid */;
|
|
3101
|
+
}
|
|
3102
|
+
export type RequestBody = Components.Schemas.PublishRevisionRequest;
|
|
3103
|
+
namespace Responses {
|
|
3104
|
+
export type $200 = Components.Schemas.PublishResult;
|
|
3105
|
+
export interface $400 {
|
|
3106
|
+
}
|
|
3107
|
+
export interface $403 {
|
|
3108
|
+
}
|
|
3109
|
+
export interface $404 {
|
|
3110
|
+
}
|
|
3111
|
+
export interface $409 {
|
|
3112
|
+
}
|
|
3113
|
+
}
|
|
3114
|
+
}
|
|
2217
3115
|
namespace RemoveJourney {
|
|
2218
3116
|
namespace Parameters {
|
|
2219
3117
|
/**
|
|
@@ -2319,6 +3217,73 @@ interface OperationMethods {
|
|
|
2319
3217
|
data?: any,
|
|
2320
3218
|
config?: AxiosRequestConfig
|
|
2321
3219
|
): OperationResponse<any>
|
|
3220
|
+
/**
|
|
3221
|
+
* listJourneyRevisions - listJourneyRevisions
|
|
3222
|
+
*
|
|
3223
|
+
* Lists 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 from `published_at`, which records the last time it was published.
|
|
3224
|
+
*
|
|
3225
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3226
|
+
*
|
|
3227
|
+
*/
|
|
3228
|
+
'listJourneyRevisions'(
|
|
3229
|
+
parameters?: Parameters<Paths.ListJourneyRevisions.QueryParameters & Paths.ListJourneyRevisions.PathParameters> | null,
|
|
3230
|
+
data?: any,
|
|
3231
|
+
config?: AxiosRequestConfig
|
|
3232
|
+
): OperationResponse<Paths.ListJourneyRevisions.Responses.$200>
|
|
3233
|
+
/**
|
|
3234
|
+
* createJourneyRevision - createJourneyRevision
|
|
3235
|
+
*
|
|
3236
|
+
* Creates 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 published. The payload is complete and is not merged against the journey record or the previous revision. The entity datasource set of the revision is stored separately through the datasources API under the same `revision_id`.
|
|
3237
|
+
*
|
|
3238
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3239
|
+
*
|
|
3240
|
+
*/
|
|
3241
|
+
'createJourneyRevision'(
|
|
3242
|
+
parameters?: Parameters<Paths.CreateJourneyRevision.PathParameters> | null,
|
|
3243
|
+
data?: Paths.CreateJourneyRevision.RequestBody,
|
|
3244
|
+
config?: AxiosRequestConfig
|
|
3245
|
+
): OperationResponse<Paths.CreateJourneyRevision.Responses.$201>
|
|
3246
|
+
/**
|
|
3247
|
+
* getJourneyRevision - getJourneyRevision
|
|
3248
|
+
*
|
|
3249
|
+
* Returns 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 client persists it, if at all, by posting it back to `POST .../revisions`.
|
|
3250
|
+
*
|
|
3251
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3252
|
+
*
|
|
3253
|
+
*/
|
|
3254
|
+
'getJourneyRevision'(
|
|
3255
|
+
parameters?: Parameters<Paths.GetJourneyRevision.PathParameters> | null,
|
|
3256
|
+
data?: any,
|
|
3257
|
+
config?: AxiosRequestConfig
|
|
3258
|
+
): OperationResponse<Paths.GetJourneyRevision.Responses.$200>
|
|
3259
|
+
/**
|
|
3260
|
+
* publishJourneyRevision - publishJourneyRevision
|
|
3261
|
+
*
|
|
3262
|
+
* Makes 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 datasources, and `name`, `description`, `published_at` and `published_by` are stamped onto the revision. Any revision can be published, old or new, so publishing an older revision is the rollback.
|
|
3263
|
+
*
|
|
3264
|
+
* `name` is generated server-side when omitted, so every published revision carries one; an omitted name never replaces a name a previous publish already set. `settings.isActive` is never changed by a publish.
|
|
3265
|
+
*
|
|
3266
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3267
|
+
*
|
|
3268
|
+
*/
|
|
3269
|
+
'publishJourneyRevision'(
|
|
3270
|
+
parameters?: Parameters<Paths.PublishJourneyRevision.PathParameters> | null,
|
|
3271
|
+
data?: Paths.PublishJourneyRevision.RequestBody,
|
|
3272
|
+
config?: AxiosRequestConfig
|
|
3273
|
+
): OperationResponse<Paths.PublishJourneyRevision.Responses.$200>
|
|
3274
|
+
/**
|
|
3275
|
+
* getJourneyPublishState - getJourneyPublishState
|
|
3276
|
+
*
|
|
3277
|
+
* Answers 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`.
|
|
3278
|
+
*
|
|
3279
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3280
|
+
*
|
|
3281
|
+
*/
|
|
3282
|
+
'getJourneyPublishState'(
|
|
3283
|
+
parameters?: Parameters<Paths.GetJourneyPublishState.PathParameters> | null,
|
|
3284
|
+
data?: any,
|
|
3285
|
+
config?: AxiosRequestConfig
|
|
3286
|
+
): OperationResponse<Paths.GetJourneyPublishState.Responses.$200>
|
|
2322
3287
|
/**
|
|
2323
3288
|
* getJourneyEnvironment - getJourneyEnvironment
|
|
2324
3289
|
*
|
|
@@ -2517,6 +3482,81 @@ interface PathsDictionary {
|
|
|
2517
3482
|
config?: AxiosRequestConfig
|
|
2518
3483
|
): OperationResponse<any>
|
|
2519
3484
|
}
|
|
3485
|
+
['/v1/journey/configuration/{id}/revisions']: {
|
|
3486
|
+
/**
|
|
3487
|
+
* createJourneyRevision - createJourneyRevision
|
|
3488
|
+
*
|
|
3489
|
+
* Creates 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 published. The payload is complete and is not merged against the journey record or the previous revision. The entity datasource set of the revision is stored separately through the datasources API under the same `revision_id`.
|
|
3490
|
+
*
|
|
3491
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3492
|
+
*
|
|
3493
|
+
*/
|
|
3494
|
+
'post'(
|
|
3495
|
+
parameters?: Parameters<Paths.CreateJourneyRevision.PathParameters> | null,
|
|
3496
|
+
data?: Paths.CreateJourneyRevision.RequestBody,
|
|
3497
|
+
config?: AxiosRequestConfig
|
|
3498
|
+
): OperationResponse<Paths.CreateJourneyRevision.Responses.$201>
|
|
3499
|
+
/**
|
|
3500
|
+
* listJourneyRevisions - listJourneyRevisions
|
|
3501
|
+
*
|
|
3502
|
+
* Lists 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 from `published_at`, which records the last time it was published.
|
|
3503
|
+
*
|
|
3504
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3505
|
+
*
|
|
3506
|
+
*/
|
|
3507
|
+
'get'(
|
|
3508
|
+
parameters?: Parameters<Paths.ListJourneyRevisions.QueryParameters & Paths.ListJourneyRevisions.PathParameters> | null,
|
|
3509
|
+
data?: any,
|
|
3510
|
+
config?: AxiosRequestConfig
|
|
3511
|
+
): OperationResponse<Paths.ListJourneyRevisions.Responses.$200>
|
|
3512
|
+
}
|
|
3513
|
+
['/v1/journey/configuration/{id}/revisions/{revision_id}']: {
|
|
3514
|
+
/**
|
|
3515
|
+
* getJourneyRevision - getJourneyRevision
|
|
3516
|
+
*
|
|
3517
|
+
* Returns 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 client persists it, if at all, by posting it back to `POST .../revisions`.
|
|
3518
|
+
*
|
|
3519
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3520
|
+
*
|
|
3521
|
+
*/
|
|
3522
|
+
'get'(
|
|
3523
|
+
parameters?: Parameters<Paths.GetJourneyRevision.PathParameters> | null,
|
|
3524
|
+
data?: any,
|
|
3525
|
+
config?: AxiosRequestConfig
|
|
3526
|
+
): OperationResponse<Paths.GetJourneyRevision.Responses.$200>
|
|
3527
|
+
}
|
|
3528
|
+
['/v1/journey/configuration/{id}/publish']: {
|
|
3529
|
+
/**
|
|
3530
|
+
* publishJourneyRevision - publishJourneyRevision
|
|
3531
|
+
*
|
|
3532
|
+
* Makes 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 datasources, and `name`, `description`, `published_at` and `published_by` are stamped onto the revision. Any revision can be published, old or new, so publishing an older revision is the rollback.
|
|
3533
|
+
*
|
|
3534
|
+
* `name` is generated server-side when omitted, so every published revision carries one; an omitted name never replaces a name a previous publish already set. `settings.isActive` is never changed by a publish.
|
|
3535
|
+
*
|
|
3536
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3537
|
+
*
|
|
3538
|
+
*/
|
|
3539
|
+
'post'(
|
|
3540
|
+
parameters?: Parameters<Paths.PublishJourneyRevision.PathParameters> | null,
|
|
3541
|
+
data?: Paths.PublishJourneyRevision.RequestBody,
|
|
3542
|
+
config?: AxiosRequestConfig
|
|
3543
|
+
): OperationResponse<Paths.PublishJourneyRevision.Responses.$200>
|
|
3544
|
+
}
|
|
3545
|
+
['/v1/journey/configuration/{id}/publish-state']: {
|
|
3546
|
+
/**
|
|
3547
|
+
* getJourneyPublishState - getJourneyPublishState
|
|
3548
|
+
*
|
|
3549
|
+
* Answers 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`.
|
|
3550
|
+
*
|
|
3551
|
+
* Only available for organizations with journey versioning enabled; returns `404` otherwise.
|
|
3552
|
+
*
|
|
3553
|
+
*/
|
|
3554
|
+
'get'(
|
|
3555
|
+
parameters?: Parameters<Paths.GetJourneyPublishState.PathParameters> | null,
|
|
3556
|
+
data?: any,
|
|
3557
|
+
config?: AxiosRequestConfig
|
|
3558
|
+
): OperationResponse<Paths.GetJourneyPublishState.Responses.$200>
|
|
3559
|
+
}
|
|
2520
3560
|
['/v1/journey/configuration/{id}/environment']: {
|
|
2521
3561
|
/**
|
|
2522
3562
|
* getJourneyEnvironment - getJourneyEnvironment
|
|
@@ -2719,10 +3759,18 @@ type JourneyEnvironmentResponse = Components.Schemas.JourneyEnvironmentResponse;
|
|
|
2719
3759
|
type JourneyEnvironmentVariablesResponse = Components.Schemas.JourneyEnvironmentVariablesResponse;
|
|
2720
3760
|
type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
|
|
2721
3761
|
type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
|
|
3762
|
+
type JourneyPublishState = Components.Schemas.JourneyPublishState;
|
|
2722
3763
|
type JourneyResponse = Components.Schemas.JourneyResponse;
|
|
3764
|
+
type JourneyRevision = Components.Schemas.JourneyRevision;
|
|
3765
|
+
type JourneyRevisionConflict = Components.Schemas.JourneyRevisionConflict;
|
|
3766
|
+
type JourneyRevisionList = Components.Schemas.JourneyRevisionList;
|
|
3767
|
+
type JourneyRevisionRequest = Components.Schemas.JourneyRevisionRequest;
|
|
3768
|
+
type JourneyRevisionSummary = Components.Schemas.JourneyRevisionSummary;
|
|
2723
3769
|
type JourneyValidationError = Components.Schemas.JourneyValidationError;
|
|
2724
3770
|
type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
|
|
2725
3771
|
type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
|
|
3772
|
+
type PublishResult = Components.Schemas.PublishResult;
|
|
3773
|
+
type PublishRevisionRequest = Components.Schemas.PublishRevisionRequest;
|
|
2726
3774
|
type RuleRef = Components.Schemas.RuleRef;
|
|
2727
3775
|
type S3Reference = Components.Schemas.S3Reference;
|
|
2728
3776
|
type SearchJourneysQueryRequest = Components.Schemas.SearchJourneysQueryRequest;
|
|
@@ -2730,4 +3778,4 @@ type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
|
|
|
2730
3778
|
type TemplateSettings = Components.Schemas.TemplateSettings;
|
|
2731
3779
|
type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
|
|
2732
3780
|
|
|
2733
|
-
export { type ButtonOption as B, type Client as C, type EnvironmentMap as E, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type
|
|
3781
|
+
export { type SearchJourneysQueryRequest as A, type ButtonOption as B, type Client as C, type SearchJourneysResponse as D, type EnvironmentMap as E, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type EnvironmentMapEntry as c, type GenerateDocumentResponse as d, type GetJourneysResponse as e, GetSettingsForJourney as f, type JourneyActivationGuarantee as g, type JourneyAuditInfo as h, type JourneyCreationRequest as i, type JourneyCreationRequestV2 as j, type JourneyEnvironmentResponse as k, type JourneyEnvironmentVariablesResponse as l, type JourneyFeatureFlags as m, type JourneyProductsResponse as n, type JourneyPublishState as o, type JourneyResponse as p, type JourneyRevision as q, type JourneyRevisionConflict as r, type JourneyRevisionList as s, type JourneyRevisionRequest as t, type JourneyRevisionSummary as u, type JourneyValidationError as v, type JourneyValidationResponse as w, type PatchUpdateJourneyRequest as x, type PublishResult as y, type PublishRevisionRequest as z };
|