@epilot/sdk 2.1.9 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (202) hide show
  1. package/dist/apis/access-token.cjs +6 -6
  2. package/dist/apis/access-token.js +1 -1
  3. package/dist/apis/address-suggestions.cjs +6 -6
  4. package/dist/apis/address-suggestions.js +1 -1
  5. package/dist/apis/address.cjs +6 -6
  6. package/dist/apis/address.js +1 -1
  7. package/dist/apis/ai-agents.cjs +6 -6
  8. package/dist/apis/ai-agents.js +1 -1
  9. package/dist/apis/app.cjs +6 -6
  10. package/dist/apis/app.js +1 -1
  11. package/dist/apis/audit-logs.cjs +6 -6
  12. package/dist/apis/audit-logs.js +1 -1
  13. package/dist/apis/automation.cjs +6 -6
  14. package/dist/apis/automation.js +1 -1
  15. package/dist/apis/billing.cjs +6 -6
  16. package/dist/apis/billing.js +1 -1
  17. package/dist/apis/blueprint-manifest.cjs +6 -6
  18. package/dist/apis/blueprint-manifest.js +1 -1
  19. package/dist/apis/consent.cjs +6 -6
  20. package/dist/apis/consent.js +1 -1
  21. package/dist/apis/customer-portal.cjs +6 -6
  22. package/dist/apis/customer-portal.js +1 -1
  23. package/dist/apis/dashboard.cjs +6 -6
  24. package/dist/apis/dashboard.js +1 -1
  25. package/dist/apis/data-management.cjs +6 -6
  26. package/dist/apis/data-management.js +1 -1
  27. package/dist/apis/deduplication.cjs +6 -6
  28. package/dist/apis/deduplication.js +1 -1
  29. package/dist/apis/design.cjs +6 -6
  30. package/dist/apis/design.js +1 -1
  31. package/dist/apis/document.cjs +6 -6
  32. package/dist/apis/document.js +1 -1
  33. package/dist/apis/email-settings.cjs +6 -6
  34. package/dist/apis/email-settings.js +1 -1
  35. package/dist/apis/email-template.cjs +6 -6
  36. package/dist/apis/email-template.js +1 -1
  37. package/dist/apis/entity-mapping.cjs +6 -6
  38. package/dist/apis/entity-mapping.js +1 -1
  39. package/dist/apis/entity.cjs +6 -6
  40. package/dist/apis/entity.js +1 -1
  41. package/dist/apis/environments.cjs +6 -6
  42. package/dist/apis/environments.js +1 -1
  43. package/dist/apis/erp-integration.cjs +6 -6
  44. package/dist/apis/erp-integration.js +1 -1
  45. package/dist/apis/event-catalog.cjs +6 -6
  46. package/dist/apis/event-catalog.js +1 -1
  47. package/dist/apis/file.cjs +6 -6
  48. package/dist/apis/file.js +1 -1
  49. package/dist/apis/iban.cjs +6 -6
  50. package/dist/apis/iban.js +1 -1
  51. package/dist/apis/journey.cjs +6 -6
  52. package/dist/apis/journey.d.cts +2 -2
  53. package/dist/apis/journey.d.ts +2 -2
  54. package/dist/apis/journey.js +1 -1
  55. package/dist/apis/kanban.cjs +6 -6
  56. package/dist/apis/kanban.js +1 -1
  57. package/dist/apis/message.cjs +6 -6
  58. package/dist/apis/message.js +1 -1
  59. package/dist/apis/metering.cjs +6 -6
  60. package/dist/apis/metering.js +1 -1
  61. package/dist/apis/notes.cjs +6 -6
  62. package/dist/apis/notes.js +1 -1
  63. package/dist/apis/notification.cjs +6 -6
  64. package/dist/apis/notification.js +1 -1
  65. package/dist/apis/organization.cjs +6 -6
  66. package/dist/apis/organization.js +1 -1
  67. package/dist/apis/partner-directory.cjs +6 -6
  68. package/dist/apis/partner-directory.js +1 -1
  69. package/dist/apis/permissions.cjs +6 -6
  70. package/dist/apis/permissions.js +1 -1
  71. package/dist/apis/pricing-tier.cjs +6 -6
  72. package/dist/apis/pricing-tier.js +1 -1
  73. package/dist/apis/pricing.cjs +6 -6
  74. package/dist/apis/pricing.js +1 -1
  75. package/dist/apis/purpose.cjs +6 -6
  76. package/dist/apis/purpose.js +1 -1
  77. package/dist/apis/sandbox.cjs +6 -6
  78. package/dist/apis/sandbox.js +1 -1
  79. package/dist/apis/submission.cjs +6 -6
  80. package/dist/apis/submission.js +1 -1
  81. package/dist/apis/targeting.cjs +6 -6
  82. package/dist/apis/targeting.js +1 -1
  83. package/dist/apis/template-variables.cjs +6 -6
  84. package/dist/apis/template-variables.js +1 -1
  85. package/dist/apis/user.cjs +6 -6
  86. package/dist/apis/user.js +1 -1
  87. package/dist/apis/validation-rules.cjs +6 -6
  88. package/dist/apis/validation-rules.js +1 -1
  89. package/dist/apis/webhooks.cjs +6 -6
  90. package/dist/apis/webhooks.js +1 -1
  91. package/dist/apis/workflow-definition.cjs +6 -6
  92. package/dist/apis/workflow-definition.js +1 -1
  93. package/dist/apis/workflow.cjs +6 -6
  94. package/dist/apis/workflow.js +1 -1
  95. package/dist/bin/cli.js +35 -11
  96. package/dist/{chunk-FXN6IHCZ.cjs → chunk-6TKKEGYU.cjs} +1 -1
  97. package/dist/{chunk-6D5AZZ2F.js → chunk-G33CBNJD.js} +1 -1
  98. package/dist/index.cjs +8 -8
  99. package/dist/index.d.cts +1 -1
  100. package/dist/index.d.ts +1 -1
  101. package/dist/index.js +1 -1
  102. package/dist/journey-KDR5EU3W.js +7 -0
  103. package/dist/journey-REBN4TGQ.cjs +7 -0
  104. package/dist/{journey.d-C4N4t1Rh.d.ts → journey.d-ClXO0xK8.d.cts} +20 -0
  105. package/dist/{journey.d-C4N4t1Rh.d.cts → journey.d-ClXO0xK8.d.ts} +20 -0
  106. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  107. package/docs/journey.md +21 -2
  108. package/package.json +1 -1
  109. package/definitions/access-token-runtime.json +0 -1
  110. package/definitions/access-token.json +0 -663
  111. package/definitions/address-runtime.json +0 -1
  112. package/definitions/address-suggestions-runtime.json +0 -1
  113. package/definitions/address-suggestions.json +0 -582
  114. package/definitions/address.json +0 -578
  115. package/definitions/ai-agents-runtime.json +0 -1
  116. package/definitions/ai-agents.json +0 -1711
  117. package/definitions/app-runtime.json +0 -1
  118. package/definitions/app.json +0 -4493
  119. package/definitions/audit-logs-runtime.json +0 -1
  120. package/definitions/audit-logs.json +0 -305
  121. package/definitions/automation-runtime.json +0 -1
  122. package/definitions/automation.json +0 -4815
  123. package/definitions/billing-runtime.json +0 -1
  124. package/definitions/billing.json +0 -837
  125. package/definitions/blueprint-manifest-runtime.json +0 -1
  126. package/definitions/blueprint-manifest.json +0 -3490
  127. package/definitions/consent-runtime.json +0 -1
  128. package/definitions/consent.json +0 -344
  129. package/definitions/customer-portal-runtime.json +0 -1
  130. package/definitions/customer-portal.json +0 -15676
  131. package/definitions/dashboard-runtime.json +0 -1
  132. package/definitions/dashboard.json +0 -484
  133. package/definitions/data-management-runtime.json +0 -1
  134. package/definitions/data-management.json +0 -972
  135. package/definitions/deduplication-runtime.json +0 -1
  136. package/definitions/deduplication.json +0 -183
  137. package/definitions/design-runtime.json +0 -1
  138. package/definitions/design.json +0 -1423
  139. package/definitions/document-runtime.json +0 -1
  140. package/definitions/document.json +0 -758
  141. package/definitions/email-settings-runtime.json +0 -1
  142. package/definitions/email-settings.json +0 -2748
  143. package/definitions/email-template-runtime.json +0 -1
  144. package/definitions/email-template.json +0 -1441
  145. package/definitions/entity-mapping-runtime.json +0 -1
  146. package/definitions/entity-mapping.json +0 -1642
  147. package/definitions/entity-runtime.json +0 -1
  148. package/definitions/entity.json +0 -10276
  149. package/definitions/environments-runtime.json +0 -1
  150. package/definitions/environments.json +0 -363
  151. package/definitions/erp-integration-runtime.json +0 -1
  152. package/definitions/erp-integration.json +0 -6304
  153. package/definitions/event-catalog-runtime.json +0 -1
  154. package/definitions/event-catalog.json +0 -1051
  155. package/definitions/file-runtime.json +0 -1
  156. package/definitions/file.json +0 -2842
  157. package/definitions/iban-runtime.json +0 -1
  158. package/definitions/iban.json +0 -132
  159. package/definitions/journey-runtime.json +0 -1
  160. package/definitions/journey.json +0 -2586
  161. package/definitions/kanban-runtime.json +0 -1
  162. package/definitions/kanban.json +0 -1505
  163. package/definitions/message-runtime.json +0 -1
  164. package/definitions/message.json +0 -2660
  165. package/definitions/metering-runtime.json +0 -1
  166. package/definitions/metering.json +0 -2321
  167. package/definitions/notes-runtime.json +0 -1
  168. package/definitions/notes.json +0 -1531
  169. package/definitions/notification-runtime.json +0 -1
  170. package/definitions/notification.json +0 -1425
  171. package/definitions/organization-runtime.json +0 -1
  172. package/definitions/organization.json +0 -1192
  173. package/definitions/partner-directory-runtime.json +0 -1
  174. package/definitions/partner-directory.json +0 -2284
  175. package/definitions/permissions-runtime.json +0 -1
  176. package/definitions/permissions.json +0 -1515
  177. package/definitions/pricing-runtime.json +0 -1
  178. package/definitions/pricing-tier-runtime.json +0 -1
  179. package/definitions/pricing-tier.json +0 -105
  180. package/definitions/pricing.json +0 -9884
  181. package/definitions/purpose-runtime.json +0 -1
  182. package/definitions/purpose.json +0 -524
  183. package/definitions/sandbox-runtime.json +0 -1
  184. package/definitions/sandbox.json +0 -453
  185. package/definitions/submission-runtime.json +0 -1
  186. package/definitions/submission.json +0 -313
  187. package/definitions/targeting-runtime.json +0 -1
  188. package/definitions/targeting.json +0 -1474
  189. package/definitions/template-variables-runtime.json +0 -1
  190. package/definitions/template-variables.json +0 -1408
  191. package/definitions/user-runtime.json +0 -1
  192. package/definitions/user.json +0 -2408
  193. package/definitions/validation-rules-runtime.json +0 -1
  194. package/definitions/validation-rules.json +0 -1491
  195. package/definitions/webhooks-runtime.json +0 -1
  196. package/definitions/webhooks.json +0 -1634
  197. package/definitions/workflow-definition-runtime.json +0 -1
  198. package/definitions/workflow-definition.json +0 -3417
  199. package/definitions/workflow-runtime.json +0 -1
  200. package/definitions/workflow.json +0 -4146
  201. package/dist/journey-7CKX67M7.js +0 -7
  202. package/dist/journey-EUZ6MVHG.cjs +0 -7
@@ -1,2586 +0,0 @@
1
- {
2
- "openapi": "3.0.0",
3
- "info": {
4
- "title": "Journey API",
5
- "description": "API to configure journeys",
6
- "version": "1.4.0"
7
- },
8
- "security": [
9
- {
10
- "EpilotAuth": []
11
- }
12
- ],
13
- "tags": [
14
- {
15
- "name": "Journeys",
16
- "description": "Journey operations"
17
- },
18
- {
19
- "name": "Journeys V2",
20
- "description": "Journey V2 operations"
21
- },
22
- {
23
- "name": "journey_schema",
24
- "x-displayName": "Journey",
25
- "description": "<SchemaDefinition schemaRef=\"#/components/schemas/Journey\" />\n"
26
- }
27
- ],
28
- "x-tagGroups": [
29
- {
30
- "name": "APIs",
31
- "tags": [
32
- "Journeys",
33
- "Journeys V2"
34
- ]
35
- },
36
- {
37
- "name": "Schemas",
38
- "tags": [
39
- "journey_schema"
40
- ]
41
- }
42
- ],
43
- "paths": {
44
- "/v1/journey/organization/{id}": {
45
- "get": {
46
- "operationId": "getJourneysByOrgId",
47
- "summary": "getJourneysByOrgId",
48
- "description": "Get all journeys by organization id",
49
- "tags": [
50
- "Journeys"
51
- ],
52
- "parameters": [
53
- {
54
- "name": "id",
55
- "in": "path",
56
- "description": "Organization ID",
57
- "required": true,
58
- "schema": {
59
- "type": "string",
60
- "example": "123"
61
- }
62
- },
63
- {
64
- "name": "hydrate",
65
- "in": "query",
66
- "description": "Hydrate",
67
- "required": false,
68
- "schema": {
69
- "type": "string",
70
- "example": "true"
71
- }
72
- }
73
- ],
74
- "responses": {
75
- "200": {
76
- "description": "Success",
77
- "content": {
78
- "application/json": {
79
- "schema": {
80
- "$ref": "#/components/schemas/GetJourneysResponse"
81
- }
82
- }
83
- }
84
- }
85
- }
86
- }
87
- },
88
- "/v1/journey/configuration/{id}": {
89
- "get": {
90
- "operationId": "getJourney",
91
- "summary": "getJourney",
92
- "description": "Get journey by id. Private journeys requires valid private token to be passed",
93
- "security": [
94
- {},
95
- {
96
- "EpilotAuth": []
97
- },
98
- {
99
- "PortalAuth": []
100
- }
101
- ],
102
- "tags": [
103
- "Journeys"
104
- ],
105
- "parameters": [
106
- {
107
- "name": "id",
108
- "in": "path",
109
- "description": "Journey ID",
110
- "required": true,
111
- "schema": {
112
- "type": "string",
113
- "format": "uuid",
114
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
115
- }
116
- },
117
- {
118
- "name": "source",
119
- "in": "query",
120
- "description": "What source ID. Journey or Entity ID",
121
- "required": false,
122
- "schema": {
123
- "type": "string"
124
- }
125
- },
126
- {
127
- "name": "orgId",
128
- "in": "query",
129
- "description": "Organization ID",
130
- "required": false,
131
- "schema": {
132
- "type": "string"
133
- }
134
- }
135
- ],
136
- "responses": {
137
- "200": {
138
- "description": "Success",
139
- "content": {
140
- "application/json": {
141
- "schema": {
142
- "$ref": "#/components/schemas/Journey"
143
- }
144
- }
145
- }
146
- }
147
- }
148
- },
149
- "delete": {
150
- "operationId": "removeJourney",
151
- "summary": "removeJourney",
152
- "description": "Remove journey by id",
153
- "tags": [
154
- "Journeys"
155
- ],
156
- "parameters": [
157
- {
158
- "name": "id",
159
- "in": "path",
160
- "description": "Journey ID",
161
- "required": true,
162
- "schema": {
163
- "type": "string",
164
- "format": "uuid",
165
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
166
- }
167
- }
168
- ],
169
- "responses": {
170
- "200": {
171
- "description": "Success",
172
- "content": {}
173
- },
174
- "404": {
175
- "description": "Journey not found",
176
- "content": {
177
- "application/json": {
178
- "schema": {
179
- "type": "object",
180
- "properties": {
181
- "message": {
182
- "type": "string",
183
- "example": "journey not found"
184
- }
185
- }
186
- }
187
- }
188
- }
189
- }
190
- }
191
- }
192
- },
193
- "/v1/journey/products/{id}": {
194
- "get": {
195
- "operationId": "getJourneyProducts",
196
- "summary": "getJourneyProducts",
197
- "description": "Get products available in the journey by id. requires public journey token to be passed.",
198
- "security": [
199
- {
200
- "EpilotAuth": []
201
- }
202
- ],
203
- "tags": [
204
- "Journeys"
205
- ],
206
- "parameters": [
207
- {
208
- "name": "id",
209
- "in": "path",
210
- "description": "Journey ID",
211
- "required": true,
212
- "schema": {
213
- "type": "string",
214
- "format": "uuid",
215
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
216
- }
217
- },
218
- {
219
- "name": "source",
220
- "in": "query",
221
- "description": "What source ID. Journey or Entity ID",
222
- "required": false,
223
- "schema": {
224
- "type": "string"
225
- }
226
- },
227
- {
228
- "name": "postal_code",
229
- "in": "query",
230
- "description": "Zip Code for availibility",
231
- "required": false,
232
- "schema": {
233
- "type": "string"
234
- }
235
- },
236
- {
237
- "name": "city",
238
- "in": "query",
239
- "description": "city for availibility",
240
- "required": false,
241
- "schema": {
242
- "type": "string"
243
- }
244
- },
245
- {
246
- "name": "street",
247
- "in": "query",
248
- "description": "street name for availibility",
249
- "required": false,
250
- "schema": {
251
- "type": "string"
252
- }
253
- },
254
- {
255
- "name": "street_number",
256
- "in": "query",
257
- "description": "street number for availibility",
258
- "required": false,
259
- "schema": {
260
- "type": "string"
261
- }
262
- }
263
- ],
264
- "responses": {
265
- "200": {
266
- "description": "Success",
267
- "content": {
268
- "application/json": {
269
- "schema": {
270
- "$ref": "#/components/schemas/JourneyProductsResponse"
271
- }
272
- }
273
- }
274
- }
275
- }
276
- }
277
- },
278
- "/v1/journey/configuration": {
279
- "post": {
280
- "operationId": "createJourney",
281
- "summary": "createJourney",
282
- "description": "Create a Journey",
283
- "tags": [
284
- "Journeys"
285
- ],
286
- "requestBody": {
287
- "content": {
288
- "application/json": {
289
- "schema": {
290
- "$ref": "#/components/schemas/JourneyCreationRequest"
291
- }
292
- }
293
- },
294
- "description": "Payload"
295
- },
296
- "parameters": [
297
- {
298
- "name": "skipAutomation",
299
- "in": "query",
300
- "description": "skip creating an Automation (it takes Yn format \"true, yes, 1, y\")",
301
- "required": false,
302
- "schema": {
303
- "type": "string",
304
- "format": "Yn",
305
- "example": "true"
306
- }
307
- }
308
- ],
309
- "responses": {
310
- "201": {
311
- "description": "Success",
312
- "content": {
313
- "application/json": {
314
- "schema": {
315
- "$ref": "#/components/schemas/Journey"
316
- }
317
- }
318
- }
319
- },
320
- "400": {
321
- "description": "Validation failed (when validation mode is STRICT)",
322
- "content": {
323
- "application/json": {
324
- "schema": {
325
- "$ref": "#/components/schemas/JourneyValidationError"
326
- }
327
- }
328
- }
329
- }
330
- }
331
- },
332
- "put": {
333
- "operationId": "updateJourney",
334
- "summary": "updateJourney",
335
- "description": "Update a Journey",
336
- "tags": [
337
- "Journeys"
338
- ],
339
- "requestBody": {
340
- "content": {
341
- "application/json": {
342
- "schema": {
343
- "$ref": "#/components/schemas/JourneyCreationRequest"
344
- }
345
- }
346
- },
347
- "description": "Payload"
348
- },
349
- "parameters": [],
350
- "responses": {
351
- "204": {
352
- "description": "Success",
353
- "headers": {
354
- "X-Resource-Revisions": {
355
- "schema": {
356
- "type": "integer",
357
- "minimum": 0
358
- },
359
- "description": "Last revisions number of the updated resource"
360
- }
361
- }
362
- },
363
- "400": {
364
- "description": "Validation failed (when validation mode is STRICT)",
365
- "content": {
366
- "application/json": {
367
- "schema": {
368
- "$ref": "#/components/schemas/JourneyValidationError"
369
- }
370
- }
371
- }
372
- },
373
- "409": {
374
- "description": "The Journey has been modified since your last read, please refresh it and try again"
375
- }
376
- }
377
- },
378
- "patch": {
379
- "operationId": "patchUpdateJourney",
380
- "summary": "patchUpdateJourney",
381
- "description": "Update a Journey (partially / patch). Support for nested properties updates (e.g. \"property[0].name\").",
382
- "tags": [
383
- "Journeys"
384
- ],
385
- "requestBody": {
386
- "content": {
387
- "application/json": {
388
- "schema": {
389
- "$ref": "#/components/schemas/PatchUpdateJourneyRequest"
390
- },
391
- "example": {
392
- "journeyId": "509cdffe-424f-457a-95c2-9708c304ce77",
393
- "name": "New Journey Name",
394
- "steps[0].uischema.elements[0].products": [
395
- "123456",
396
- "654321"
397
- ]
398
- }
399
- }
400
- },
401
- "description": "Payload"
402
- },
403
- "parameters": [],
404
- "responses": {
405
- "200": {
406
- "description": "Success",
407
- "content": {
408
- "application/json": {
409
- "schema": {
410
- "$ref": "#/components/schemas/JourneyResponse"
411
- }
412
- }
413
- }
414
- },
415
- "400": {
416
- "description": "Validation failed (when validation mode is STRICT)",
417
- "content": {
418
- "application/json": {
419
- "schema": {
420
- "$ref": "#/components/schemas/JourneyValidationError"
421
- }
422
- }
423
- }
424
- },
425
- "404": {
426
- "description": "Journey or associated entity not found",
427
- "content": {
428
- "application/json": {
429
- "schema": {
430
- "type": "object",
431
- "properties": {
432
- "message": {
433
- "type": "string",
434
- "example": "journey not found"
435
- }
436
- }
437
- }
438
- }
439
- }
440
- }
441
- }
442
- }
443
- },
444
- "/v1/journey/configuration/search": {
445
- "post": {
446
- "operationId": "searchJourneys",
447
- "summary": "searchJourneys",
448
- "description": "Search Journeys",
449
- "tags": [
450
- "Journeys"
451
- ],
452
- "requestBody": {
453
- "content": {
454
- "application/json": {
455
- "schema": {
456
- "$ref": "#/components/schemas/SearchJourneysQueryRequest"
457
- }
458
- }
459
- },
460
- "description": "Payload"
461
- },
462
- "parameters": [],
463
- "responses": {
464
- "200": {
465
- "description": "Success",
466
- "content": {
467
- "application/json": {
468
- "schema": {
469
- "$ref": "#/components/schemas/SearchJourneysResponse"
470
- }
471
- }
472
- }
473
- }
474
- }
475
- }
476
- },
477
- "/v1/journey/document:generate": {
478
- "post": {
479
- "operationId": "generateDocument",
480
- "summary": "generateDocument",
481
- "description": "Builds document generated from a template with journey values.\"\n\nSupported input document types:\n- .docx\n\nSupported output document types:\n- .pdf\n- .docx but limited to only text based variables\n\nUses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.\nUses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.\n",
482
- "security": [
483
- {},
484
- {
485
- "EpilotAuth": []
486
- }
487
- ],
488
- "tags": [
489
- "Journeys"
490
- ],
491
- "requestBody": {
492
- "content": {
493
- "application/json": {
494
- "schema": {
495
- "$ref": "#/components/schemas/GenerateDocumentRequest"
496
- }
497
- }
498
- }
499
- },
500
- "responses": {
501
- "200": {
502
- "description": "Generated document output",
503
- "content": {
504
- "application/json": {
505
- "schema": {
506
- "$ref": "#/components/schemas/GenerateDocumentResponse"
507
- }
508
- }
509
- }
510
- }
511
- }
512
- }
513
- },
514
- "/v2/journey/configuration": {
515
- "post": {
516
- "operationId": "createJourneyV2",
517
- "summary": "createJourneyV2",
518
- "description": "Create a Journey",
519
- "tags": [
520
- "Journeys V2"
521
- ],
522
- "requestBody": {
523
- "content": {
524
- "application/json": {
525
- "schema": {
526
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
527
- }
528
- }
529
- },
530
- "description": "Payload"
531
- },
532
- "parameters": [
533
- {
534
- "name": "skipAutomation",
535
- "in": "query",
536
- "description": "skip creating an Automation (it takes Yn format \"true, yes, 1, y\")",
537
- "required": false,
538
- "schema": {
539
- "type": "string",
540
- "format": "Yn",
541
- "example": "true"
542
- }
543
- }
544
- ],
545
- "responses": {
546
- "201": {
547
- "description": "Success",
548
- "content": {
549
- "application/json": {
550
- "schema": {
551
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
552
- }
553
- }
554
- }
555
- },
556
- "400": {
557
- "description": "Validation failed (when validation mode is STRICT)",
558
- "content": {
559
- "application/json": {
560
- "schema": {
561
- "$ref": "#/components/schemas/JourneyValidationError"
562
- }
563
- }
564
- }
565
- }
566
- }
567
- },
568
- "put": {
569
- "operationId": "updateJourneyV2",
570
- "summary": "updateJourneyV2",
571
- "description": "Update a Journey",
572
- "tags": [
573
- "Journeys V2"
574
- ],
575
- "requestBody": {
576
- "content": {
577
- "application/json": {
578
- "schema": {
579
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
580
- }
581
- }
582
- },
583
- "description": "Payload"
584
- },
585
- "parameters": [],
586
- "responses": {
587
- "200": {
588
- "description": "Success",
589
- "content": {
590
- "application/json": {
591
- "schema": {
592
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
593
- }
594
- }
595
- }
596
- },
597
- "400": {
598
- "description": "Validation failed (when validation mode is STRICT)",
599
- "content": {
600
- "application/json": {
601
- "schema": {
602
- "$ref": "#/components/schemas/JourneyValidationError"
603
- }
604
- }
605
- }
606
- },
607
- "404": {
608
- "description": "Journey or associated entity not found",
609
- "content": {
610
- "application/json": {
611
- "schema": {
612
- "type": "object",
613
- "properties": {
614
- "message": {
615
- "type": "string",
616
- "example": "journey not found"
617
- }
618
- }
619
- }
620
- }
621
- }
622
- }
623
- }
624
- },
625
- "patch": {
626
- "operationId": "patchUpdateJourneyV2",
627
- "summary": "patchUpdateJourneyV2",
628
- "description": "Update a Journey (partially / patch). Support for nested properties updates (e.g. \"property[0].name\").",
629
- "tags": [
630
- "Journeys V2"
631
- ],
632
- "requestBody": {
633
- "content": {
634
- "application/json": {
635
- "schema": {
636
- "$ref": "#/components/schemas/PatchUpdateJourneyRequest"
637
- },
638
- "example": {
639
- "journeyId": "509cdffe-424f-457a-95c2-9708c304ce77",
640
- "name": "New Journey Name",
641
- "steps[0].uischema.elements[0].products": [
642
- "123456",
643
- "654321"
644
- ]
645
- }
646
- }
647
- },
648
- "description": "Payload"
649
- },
650
- "parameters": [],
651
- "responses": {
652
- "200": {
653
- "description": "Success",
654
- "content": {
655
- "application/json": {
656
- "schema": {
657
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
658
- }
659
- }
660
- }
661
- },
662
- "400": {
663
- "description": "Validation failed (when validation mode is STRICT)",
664
- "content": {
665
- "application/json": {
666
- "schema": {
667
- "$ref": "#/components/schemas/JourneyValidationError"
668
- }
669
- }
670
- }
671
- },
672
- "404": {
673
- "description": "Journey or associated entity not found",
674
- "content": {
675
- "application/json": {
676
- "schema": {
677
- "type": "object",
678
- "properties": {
679
- "message": {
680
- "type": "string",
681
- "example": "journey not found"
682
- }
683
- }
684
- }
685
- }
686
- }
687
- }
688
- }
689
- }
690
- },
691
- "/v2/journey/configuration/{id}": {
692
- "get": {
693
- "operationId": "getJourneyV2",
694
- "summary": "getJourneyV2",
695
- "description": "Get journey by id",
696
- "security": [],
697
- "tags": [
698
- "Journeys V2"
699
- ],
700
- "parameters": [
701
- {
702
- "name": "id",
703
- "in": "path",
704
- "description": "Journey ID",
705
- "required": true,
706
- "schema": {
707
- "type": "string",
708
- "format": "uuid",
709
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
710
- }
711
- }
712
- ],
713
- "responses": {
714
- "200": {
715
- "description": "Success",
716
- "content": {
717
- "application/json": {
718
- "schema": {
719
- "$ref": "#/components/schemas/JourneyCreationRequestV2"
720
- }
721
- }
722
- }
723
- }
724
- }
725
- },
726
- "delete": {
727
- "operationId": "removeJourneyV2",
728
- "summary": "removeJourneyV2",
729
- "description": "Remove journey by id",
730
- "tags": [
731
- "Journeys V2"
732
- ],
733
- "parameters": [
734
- {
735
- "name": "id",
736
- "in": "path",
737
- "description": "Journey ID",
738
- "required": true,
739
- "schema": {
740
- "type": "string",
741
- "format": "uuid",
742
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
743
- }
744
- }
745
- ],
746
- "responses": {
747
- "200": {
748
- "description": "Success",
749
- "content": {}
750
- }
751
- }
752
- }
753
- },
754
- "/v1/journey/{id}/settings": {
755
- "get": {
756
- "operationId": "getSettingsForJourney",
757
- "summary": "getSettingsForJourney",
758
- "description": "Get settings related to the journey using journey ID.",
759
- "tags": [
760
- "Journeys"
761
- ],
762
- "security": [
763
- {}
764
- ],
765
- "parameters": [
766
- {
767
- "name": "id",
768
- "in": "path",
769
- "description": "Journey ID",
770
- "required": true,
771
- "schema": {
772
- "type": "string",
773
- "format": "uuid",
774
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
775
- }
776
- }
777
- ],
778
- "responses": {
779
- "200": {
780
- "description": "Success",
781
- "content": {
782
- "application/json": {
783
- "schema": {
784
- "$ref": "#/components/schemas/GetSettingsForJourney"
785
- }
786
- }
787
- }
788
- },
789
- "404": {
790
- "description": "Not found",
791
- "content": {
792
- "application/json": {
793
- "schema": {
794
- "type": "object",
795
- "properties": {
796
- "message": {
797
- "type": "string",
798
- "example": "journey not found"
799
- }
800
- }
801
- }
802
- }
803
- }
804
- },
805
- "500": {
806
- "description": "Internal Server Error",
807
- "content": {
808
- "application/json": {
809
- "schema": {
810
- "type": "object",
811
- "properties": {
812
- "message": {
813
- "type": "string",
814
- "example": "Unknown API Error"
815
- }
816
- }
817
- }
818
- }
819
- }
820
- }
821
- }
822
- }
823
- },
824
- "/v1/journey/button-options": {
825
- "get": {
826
- "operationId": "getButtonOptions",
827
- "summary": "getButtonOptions",
828
- "description": "Get button options from a csv file.",
829
- "security": [
830
- {
831
- "EpilotAuth": []
832
- }
833
- ],
834
- "tags": [
835
- "Journeys"
836
- ],
837
- "parameters": [
838
- {
839
- "in": "query",
840
- "name": "fileId",
841
- "required": true,
842
- "description": "file id to get button options from",
843
- "schema": {
844
- "type": "string",
845
- "example": "535ef74a-dd66-4d01-94a9-725016e70d1c"
846
- }
847
- }
848
- ],
849
- "responses": {
850
- "200": {
851
- "description": "Success",
852
- "content": {
853
- "application/json": {
854
- "schema": {
855
- "type": "array",
856
- "items": {
857
- "$ref": "#/components/schemas/ButtonOption"
858
- }
859
- }
860
- }
861
- }
862
- },
863
- "400": {
864
- "description": "Bad Request - Invalid file or content",
865
- "content": {
866
- "application/json": {
867
- "schema": {
868
- "type": "object",
869
- "properties": {
870
- "message": {
871
- "type": "string",
872
- "example": "UTF-8 encoding error while processing CSV content"
873
- },
874
- "details": {
875
- "type": "string",
876
- "example": "Please ensure your CSV file is properly encoded in UTF-8 format"
877
- }
878
- }
879
- }
880
- }
881
- }
882
- },
883
- "404": {
884
- "description": "Not found",
885
- "content": {
886
- "application/json": {
887
- "schema": {
888
- "type": "object",
889
- "properties": {
890
- "message": {
891
- "type": "string",
892
- "example": "File with ID 535ef74a-dd66-4d01-94a9-725016e70d1c not found."
893
- }
894
- }
895
- }
896
- }
897
- }
898
- },
899
- "500": {
900
- "description": "Internal Server Error",
901
- "content": {
902
- "application/json": {
903
- "schema": {
904
- "type": "object",
905
- "properties": {
906
- "message": {
907
- "type": "string",
908
- "example": "Unknown API Error"
909
- }
910
- }
911
- }
912
- }
913
- }
914
- }
915
- }
916
- }
917
- }
918
- },
919
- "components": {
920
- "schemas": {
921
- "GetJourneysResponse": {
922
- "type": "object"
923
- },
924
- "JourneyResponse": {
925
- "type": "object",
926
- "properties": {
927
- "createdJourney": {
928
- "$ref": "#/components/schemas/Journey"
929
- }
930
- }
931
- },
932
- "JourneyProductsResponse": {
933
- "type": "array",
934
- "items": {
935
- "type": "object",
936
- "properties": {
937
- "type": {
938
- "type": "string"
939
- },
940
- "_schema": {
941
- "type": "string"
942
- },
943
- "_title": {
944
- "type": "string"
945
- },
946
- "name": {
947
- "type": "string"
948
- },
949
- "_id": {
950
- "type": "string"
951
- },
952
- "_org": {
953
- "type": "string"
954
- },
955
- "code": {
956
- "type": "string"
957
- },
958
- "description": {
959
- "type": "string"
960
- },
961
- "feature": {
962
- "type": "array",
963
- "items": {}
964
- },
965
- "product_images": {
966
- "type": "array",
967
- "items": {}
968
- },
969
- "legal_footnote": {
970
- "type": "string"
971
- },
972
- "product_downloads": {
973
- "type": "array",
974
- "items": {}
975
- },
976
- "price": {
977
- "type": "object"
978
- }
979
- }
980
- }
981
- },
982
- "PatchUpdateJourneyRequest": {
983
- "type": "object",
984
- "properties": {
985
- "journeyId": {
986
- "type": "string",
987
- "format": "uuid",
988
- "example": "509cdffe-424f-457a-95c2-9708c304ce77"
989
- },
990
- "__lastModifiedAt": {
991
- "type": "string",
992
- "description": "If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey",
993
- "nullable": true
994
- }
995
- },
996
- "additionalProperties": true,
997
- "description": "Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.\n",
998
- "required": [
999
- "journeyId"
1000
- ]
1001
- },
1002
- "JourneyCreationRequest": {
1003
- "type": "object",
1004
- "properties": {
1005
- "journeyId": {
1006
- "type": "string"
1007
- },
1008
- "organizationId": {
1009
- "type": "string"
1010
- },
1011
- "brandId": {
1012
- "type": "string"
1013
- },
1014
- "name": {
1015
- "type": "string"
1016
- },
1017
- "steps": {
1018
- "type": "array",
1019
- "items": {
1020
- "type": "object",
1021
- "additionalProperties": false,
1022
- "properties": {
1023
- "showStepName": {
1024
- "type": "boolean",
1025
- "nullable": true
1026
- },
1027
- "title": {
1028
- "type": "string",
1029
- "nullable": true
1030
- },
1031
- "subTitle": {
1032
- "type": "string",
1033
- "nullable": true
1034
- },
1035
- "showStepSubtitle": {
1036
- "type": "boolean",
1037
- "nullable": true
1038
- },
1039
- "showStepper": {
1040
- "type": "boolean",
1041
- "nullable": true
1042
- },
1043
- "showStepperLabels": {
1044
- "type": "boolean",
1045
- "nullable": true
1046
- },
1047
- "hideNextButton": {
1048
- "type": "boolean",
1049
- "nullable": true
1050
- },
1051
- "name": {
1052
- "type": "string"
1053
- },
1054
- "stepId": {
1055
- "type": "string"
1056
- },
1057
- "schema": {},
1058
- "uischema": {},
1059
- "maxWidth": {
1060
- "type": "string",
1061
- "enum": [
1062
- "small",
1063
- "medium",
1064
- "large",
1065
- "extra large"
1066
- ]
1067
- }
1068
- },
1069
- "required": [
1070
- "name",
1071
- "schema",
1072
- "uischema"
1073
- ]
1074
- }
1075
- },
1076
- "design": {
1077
- "type": "object",
1078
- "properties": {
1079
- "logoUrl": {
1080
- "type": "string",
1081
- "nullable": true
1082
- },
1083
- "theme": {
1084
- "type": "object",
1085
- "additionalProperties": {}
1086
- },
1087
- "designTokens": {
1088
- "type": "object"
1089
- }
1090
- },
1091
- "additionalProperties": false
1092
- },
1093
- "rules": {
1094
- "type": "array",
1095
- "items": {
1096
- "type": "object",
1097
- "properties": {
1098
- "type": {
1099
- "type": "string",
1100
- "enum": [
1101
- "inject",
1102
- "injectWithKey"
1103
- ]
1104
- },
1105
- "sourceType": {
1106
- "type": "string",
1107
- "enum": [
1108
- "journey",
1109
- "step",
1110
- "block"
1111
- ]
1112
- },
1113
- "source": {
1114
- "type": "string"
1115
- },
1116
- "target": {
1117
- "type": "string"
1118
- }
1119
- },
1120
- "required": [
1121
- "type",
1122
- "sourceType",
1123
- "source",
1124
- "target"
1125
- ],
1126
- "additionalProperties": false
1127
- }
1128
- },
1129
- "logics": {
1130
- "type": "array",
1131
- "items": {
1132
- "type": "object",
1133
- "properties": {
1134
- "autoGeneratedId": {
1135
- "type": "string"
1136
- },
1137
- "conditions": {
1138
- "type": "array",
1139
- "items": {
1140
- "type": "string"
1141
- }
1142
- },
1143
- "actions": {
1144
- "type": "array",
1145
- "items": {
1146
- "type": "string"
1147
- }
1148
- }
1149
- },
1150
- "required": [
1151
- "conditions",
1152
- "actions"
1153
- ],
1154
- "additionalProperties": false
1155
- }
1156
- },
1157
- "logicsV4": {
1158
- "type": "object",
1159
- "additionalProperties": {
1160
- "type": "object",
1161
- "properties": {
1162
- "id": {
1163
- "type": "string",
1164
- "format": "uuid",
1165
- "description": "Unique identifier for logic. Use uuidv7"
1166
- },
1167
- "protected": {
1168
- "type": "boolean",
1169
- "description": "If true, logic can't be manipulated by the configuring user"
1170
- },
1171
- "action": {
1172
- "type": "string",
1173
- "description": "Indicates which action to take in case logic evaluates to true"
1174
- },
1175
- "triggeredOn": {
1176
- "type": "string",
1177
- "description": "Indicates when the logic should be evaluated"
1178
- },
1179
- "conditions": {
1180
- "type": "array",
1181
- "items": {
1182
- "type": "array",
1183
- "items": {
1184
- "type": "object",
1185
- "properties": {
1186
- "operator": {
1187
- "type": "string",
1188
- "description": "Operator to be applied between the fact value and the value"
1189
- },
1190
- "functionName": {
1191
- "type": "string",
1192
- "description": "If operator is a custom function, this needs to be provided"
1193
- },
1194
- "fact": {
1195
- "type": "object",
1196
- "properties": {
1197
- "id": {
1198
- "type": "string",
1199
- "format": "uuid",
1200
- "description": "Unique identifier for a fact"
1201
- },
1202
- "referenceType": {
1203
- "type": "string",
1204
- "description": "Indicates reference type (block or context parameter)"
1205
- },
1206
- "referenceId": {
1207
- "type": "string",
1208
- "description": "Id of the reference"
1209
- },
1210
- "path": {
1211
- "type": "string",
1212
- "description": "Path to a property. Used if only part of the value is needed"
1213
- },
1214
- "meaning": {
1215
- "type": "string",
1216
- "description": "If path is a reference, indicates the intention of it"
1217
- }
1218
- }
1219
- },
1220
- "value": {
1221
- "oneOf": [
1222
- {
1223
- "type": "string"
1224
- },
1225
- {
1226
- "type": "number"
1227
- },
1228
- {
1229
- "type": "boolean"
1230
- },
1231
- {
1232
- "type": "object"
1233
- },
1234
- {
1235
- "type": "array",
1236
- "items": {}
1237
- }
1238
- ]
1239
- },
1240
- "args": {
1241
- "type": "object"
1242
- }
1243
- }
1244
- }
1245
- }
1246
- },
1247
- "settings": {
1248
- "type": "object",
1249
- "description": "Logic specific settings. Will vary by type of logic"
1250
- }
1251
- }
1252
- }
1253
- },
1254
- "contextSchema": {
1255
- "type": "array",
1256
- "items": {
1257
- "type": "object",
1258
- "properties": {
1259
- "id": {
1260
- "type": "string",
1261
- "format": "uuid",
1262
- "description": "Unique identifier for the context schema item"
1263
- },
1264
- "type": {
1265
- "type": "string",
1266
- "description": "Type of the parameter. It could be either an entity slug, or a text"
1267
- },
1268
- "paramKey": {
1269
- "type": "string",
1270
- "description": "Expected key to be received in the context"
1271
- },
1272
- "isRequired": {
1273
- "type": "boolean",
1274
- "description": "Indicates if a value is expected to be provided"
1275
- },
1276
- "shouldLoadEntity": {
1277
- "type": "boolean",
1278
- "description": "If type is not text, we can instruct the journey to fetch the entity id we receive as value"
1279
- }
1280
- },
1281
- "required": [
1282
- "paramKey",
1283
- "type"
1284
- ],
1285
- "additionalProperties": false
1286
- }
1287
- },
1288
- "journey_type": {
1289
- "type": "string",
1290
- "description": "Journey Template",
1291
- "example": "Sales template (Premium)"
1292
- },
1293
- "settings": {
1294
- "type": "object",
1295
- "properties": {
1296
- "embedOptions": {
1297
- "type": "object",
1298
- "properties": {
1299
- "mode": {
1300
- "type": "string",
1301
- "enum": [
1302
- "full-screen",
1303
- "inline"
1304
- ]
1305
- },
1306
- "lang": {
1307
- "type": "string",
1308
- "enum": [
1309
- "de",
1310
- "en",
1311
- "fr"
1312
- ]
1313
- },
1314
- "width": {
1315
- "type": "string"
1316
- },
1317
- "topBar": {
1318
- "type": "boolean"
1319
- },
1320
- "scrollToTop": {
1321
- "type": "boolean"
1322
- },
1323
- "button": {
1324
- "type": "object",
1325
- "properties": {
1326
- "text": {
1327
- "type": "string",
1328
- "nullable": true
1329
- },
1330
- "align": {
1331
- "type": "string",
1332
- "enum": [
1333
- "left",
1334
- "center",
1335
- "right"
1336
- ]
1337
- }
1338
- }
1339
- }
1340
- }
1341
- },
1342
- "safeModeAutomation": {
1343
- "type": "boolean"
1344
- },
1345
- "canary": {
1346
- "deprecated": true,
1347
- "description": "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.",
1348
- "type": "boolean"
1349
- },
1350
- "designId": {
1351
- "type": "string"
1352
- },
1353
- "templateId": {
1354
- "type": "string"
1355
- },
1356
- "entityId": {
1357
- "type": "string",
1358
- "nullable": true
1359
- },
1360
- "mappingsAutomationId": {
1361
- "type": "string"
1362
- },
1363
- "targetedCustomer": {
1364
- "type": "string"
1365
- },
1366
- "description": {
1367
- "type": "string",
1368
- "nullable": true
1369
- },
1370
- "organizationSettings": {
1371
- "type": "object",
1372
- "additionalProperties": {
1373
- "type": "boolean"
1374
- },
1375
- "nullable": true
1376
- },
1377
- "publicToken": {
1378
- "type": "string",
1379
- "nullable": true
1380
- },
1381
- "runtimeEntities": {
1382
- "type": "array",
1383
- "items": {
1384
- "type": "string",
1385
- "enum": [
1386
- "ORDER",
1387
- "OPPORTUNITY"
1388
- ]
1389
- }
1390
- },
1391
- "filePurposes": {
1392
- "type": "array",
1393
- "items": {
1394
- "type": "string"
1395
- }
1396
- },
1397
- "entityTags": {
1398
- "type": "array",
1399
- "items": {
1400
- "type": "string"
1401
- }
1402
- },
1403
- "addressSuggestionsFileUrl": {
1404
- "type": "string",
1405
- "nullable": true,
1406
- "deprecated": true,
1407
- "description": "@deprecated Use addressSuggestionsFileId instead"
1408
- },
1409
- "addressSuggestionsFileId": {
1410
- "type": "string",
1411
- "nullable": true
1412
- },
1413
- "addressSuggestionsCountryCode": {
1414
- "type": "string",
1415
- "nullable": true,
1416
- "description": "Country code for address format (e.g. DE, AT, CH, LU)"
1417
- },
1418
- "addressSuggestionsEnableAutoComplete": {
1419
- "type": "boolean",
1420
- "description": "Whether address auto-complete is enabled"
1421
- },
1422
- "addressSuggestionsSource": {
1423
- "type": "array",
1424
- "items": {
1425
- "type": "string"
1426
- },
1427
- "description": "Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)"
1428
- },
1429
- "addressSuggestionsEnableFreeText": {
1430
- "type": "boolean",
1431
- "description": "Whether free text input is allowed when auto-complete is on"
1432
- },
1433
- "useNewDesign": {
1434
- "type": "boolean",
1435
- "deprecated": true,
1436
- "description": "This property is deprecated and will be removed in a future version"
1437
- },
1438
- "useAustrianLabels": {
1439
- "type": "boolean",
1440
- "description": "If true, some journey input labels are in Austrian format"
1441
- },
1442
- "enableDarkMode": {
1443
- "type": "boolean",
1444
- "description": "If true, the journey shows an icon to toggle dark mode"
1445
- },
1446
- "accessMode": {
1447
- "type": "string",
1448
- "enum": [
1449
- "PUBLIC",
1450
- "PRIVATE"
1451
- ]
1452
- },
1453
- "isPublished": {
1454
- "type": "boolean"
1455
- },
1456
- "status": {
1457
- "type": "string"
1458
- },
1459
- "isActive": {
1460
- "type": "boolean"
1461
- },
1462
- "savingProgress": {
1463
- "type": "object",
1464
- "properties": {
1465
- "savingMode": {
1466
- "type": "string",
1467
- "enum": [
1468
- "auto",
1469
- "local",
1470
- "remote",
1471
- "none"
1472
- ]
1473
- },
1474
- "supportedVersion": {
1475
- "type": "number"
1476
- }
1477
- }
1478
- },
1479
- "thirdPartyCookies": {
1480
- "type": "boolean",
1481
- "description": "If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent."
1482
- }
1483
- },
1484
- "required": [
1485
- "designId"
1486
- ],
1487
- "additionalProperties": false
1488
- },
1489
- "validationRules": {
1490
- "$ref": "#/components/schemas/ValidationRuleRef"
1491
- },
1492
- "createdBy": {
1493
- "type": "string"
1494
- },
1495
- "updatedBy": {
1496
- "type": "string",
1497
- "nullable": true
1498
- },
1499
- "__lastModifiedAt": {
1500
- "type": "string",
1501
- "description": "If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey",
1502
- "nullable": true
1503
- }
1504
- },
1505
- "required": [
1506
- "organizationId",
1507
- "name",
1508
- "steps"
1509
- ],
1510
- "additionalProperties": true
1511
- },
1512
- "JourneyCreationRequestV2": {
1513
- "type": "object",
1514
- "properties": {
1515
- "journeyId": {
1516
- "type": "string"
1517
- },
1518
- "brandId": {
1519
- "type": "string"
1520
- },
1521
- "name": {
1522
- "type": "string"
1523
- },
1524
- "steps": {
1525
- "type": "array",
1526
- "items": {
1527
- "type": "object",
1528
- "additionalProperties": false,
1529
- "properties": {
1530
- "showStepName": {
1531
- "type": "boolean",
1532
- "nullable": true
1533
- },
1534
- "title": {
1535
- "type": "string",
1536
- "nullable": true
1537
- },
1538
- "subTitle": {
1539
- "type": "string",
1540
- "nullable": true
1541
- },
1542
- "showStepSubtitle": {
1543
- "type": "boolean",
1544
- "nullable": true
1545
- },
1546
- "showStepper": {
1547
- "type": "boolean",
1548
- "nullable": true
1549
- },
1550
- "showStepperLabels": {
1551
- "type": "boolean",
1552
- "nullable": true
1553
- },
1554
- "hideNextButton": {
1555
- "type": "boolean",
1556
- "nullable": true
1557
- },
1558
- "name": {
1559
- "type": "string"
1560
- },
1561
- "stepId": {
1562
- "type": "string"
1563
- },
1564
- "schema": {},
1565
- "uischema": {},
1566
- "maxWidth": {
1567
- "type": "string",
1568
- "enum": [
1569
- "small",
1570
- "medium",
1571
- "large",
1572
- "extra large"
1573
- ]
1574
- }
1575
- },
1576
- "required": [
1577
- "name",
1578
- "schema",
1579
- "uischema"
1580
- ]
1581
- }
1582
- },
1583
- "design": {
1584
- "type": "object",
1585
- "properties": {
1586
- "logoUrl": {
1587
- "type": "string",
1588
- "nullable": true
1589
- },
1590
- "theme": {
1591
- "type": "object",
1592
- "additionalProperties": {}
1593
- },
1594
- "designTokens": {
1595
- "type": "object"
1596
- }
1597
- },
1598
- "additionalProperties": false
1599
- },
1600
- "rules": {
1601
- "type": "array",
1602
- "items": {
1603
- "type": "object",
1604
- "properties": {
1605
- "type": {
1606
- "type": "string",
1607
- "enum": [
1608
- "inject",
1609
- "injectWithKey"
1610
- ]
1611
- },
1612
- "sourceType": {
1613
- "type": "string",
1614
- "enum": [
1615
- "journey",
1616
- "step",
1617
- "block"
1618
- ]
1619
- },
1620
- "source": {
1621
- "type": "string"
1622
- },
1623
- "target": {
1624
- "type": "string"
1625
- }
1626
- },
1627
- "required": [
1628
- "type",
1629
- "sourceType",
1630
- "source",
1631
- "target"
1632
- ],
1633
- "additionalProperties": false
1634
- }
1635
- },
1636
- "logics": {
1637
- "type": "array",
1638
- "items": {
1639
- "type": "object",
1640
- "properties": {
1641
- "autoGeneratedId": {
1642
- "type": "string"
1643
- },
1644
- "conditions": {
1645
- "type": "array",
1646
- "items": {
1647
- "type": "string"
1648
- }
1649
- },
1650
- "actions": {
1651
- "type": "array",
1652
- "items": {
1653
- "type": "string"
1654
- }
1655
- }
1656
- },
1657
- "required": [
1658
- "conditions",
1659
- "actions"
1660
- ],
1661
- "additionalProperties": false
1662
- }
1663
- },
1664
- "logicsV4": {
1665
- "type": "object",
1666
- "additionalProperties": {
1667
- "type": "object",
1668
- "properties": {
1669
- "id": {
1670
- "type": "string",
1671
- "format": "uuid",
1672
- "description": "Unique identifier for logic. Use uuidv7"
1673
- },
1674
- "protected": {
1675
- "type": "boolean",
1676
- "description": "If true, logic can't be manipulated by the configuring user"
1677
- },
1678
- "action": {
1679
- "type": "string",
1680
- "description": "Indicates which action to take in case logic evaluates to true"
1681
- },
1682
- "triggeredOn": {
1683
- "type": "string",
1684
- "description": "Indicates when the logic should be evaluated"
1685
- },
1686
- "conditions": {
1687
- "type": "array",
1688
- "items": {
1689
- "type": "array",
1690
- "items": {
1691
- "type": "object",
1692
- "properties": {
1693
- "operator": {
1694
- "type": "string",
1695
- "description": "Operator to be applied between the fact value and the value"
1696
- },
1697
- "functionName": {
1698
- "type": "string",
1699
- "description": "If operator is a custom function, this needs to be provided"
1700
- },
1701
- "fact": {
1702
- "type": "object",
1703
- "properties": {
1704
- "id": {
1705
- "type": "string",
1706
- "format": "uuid",
1707
- "description": "Unique identifier for a fact"
1708
- },
1709
- "referenceType": {
1710
- "type": "string",
1711
- "description": "Indicates reference type (block or context parameter)"
1712
- },
1713
- "referenceId": {
1714
- "type": "string",
1715
- "description": "Id of the reference"
1716
- },
1717
- "path": {
1718
- "type": "string",
1719
- "description": "Path to a property. Used if only part of the value is needed"
1720
- },
1721
- "meaning": {
1722
- "type": "string",
1723
- "description": "If path is a reference, indicates the intention of it"
1724
- }
1725
- }
1726
- },
1727
- "value": {
1728
- "oneOf": [
1729
- {
1730
- "type": "string"
1731
- },
1732
- {
1733
- "type": "number"
1734
- },
1735
- {
1736
- "type": "boolean"
1737
- },
1738
- {
1739
- "type": "object"
1740
- },
1741
- {
1742
- "type": "array",
1743
- "items": {}
1744
- }
1745
- ]
1746
- },
1747
- "args": {
1748
- "type": "object"
1749
- }
1750
- }
1751
- }
1752
- }
1753
- },
1754
- "settings": {
1755
- "type": "object",
1756
- "description": "Logic specific settings. Will vary by type of logic"
1757
- }
1758
- }
1759
- }
1760
- },
1761
- "contextSchema": {
1762
- "type": "array",
1763
- "items": {
1764
- "type": "object",
1765
- "properties": {
1766
- "id": {
1767
- "type": "string",
1768
- "format": "uuid",
1769
- "description": "Unique identifier for the context schema item"
1770
- },
1771
- "type": {
1772
- "type": "string",
1773
- "description": "Type of the parameter. It could be either an entity slug, or a text"
1774
- },
1775
- "paramKey": {
1776
- "type": "string",
1777
- "description": "Expected key to be received in the context"
1778
- },
1779
- "isRequired": {
1780
- "type": "boolean",
1781
- "description": "Indicates if a value is expected to be provided"
1782
- },
1783
- "shouldLoadEntity": {
1784
- "type": "boolean",
1785
- "description": "If type is not text, we can instruct the journey to fetch the entity id we receive as value"
1786
- }
1787
- },
1788
- "required": [
1789
- "paramKey",
1790
- "type"
1791
- ],
1792
- "additionalProperties": false
1793
- }
1794
- },
1795
- "journey_type": {
1796
- "type": "string",
1797
- "description": "Journey Template",
1798
- "example": "Sales template (Premium)"
1799
- },
1800
- "settings": {
1801
- "type": "object",
1802
- "properties": {
1803
- "embedOptions": {
1804
- "type": "object",
1805
- "properties": {
1806
- "mode": {
1807
- "type": "string",
1808
- "enum": [
1809
- "full-screen",
1810
- "inline"
1811
- ]
1812
- },
1813
- "lang": {
1814
- "type": "string",
1815
- "enum": [
1816
- "de",
1817
- "en",
1818
- "fr"
1819
- ]
1820
- },
1821
- "width": {
1822
- "type": "string"
1823
- },
1824
- "topBar": {
1825
- "type": "boolean"
1826
- },
1827
- "scrollToTop": {
1828
- "type": "boolean"
1829
- },
1830
- "button": {
1831
- "type": "object",
1832
- "properties": {
1833
- "text": {
1834
- "type": "string",
1835
- "nullable": true
1836
- },
1837
- "align": {
1838
- "type": "string",
1839
- "enum": [
1840
- "left",
1841
- "center",
1842
- "right"
1843
- ]
1844
- }
1845
- }
1846
- }
1847
- }
1848
- },
1849
- "safeModeAutomation": {
1850
- "type": "boolean"
1851
- },
1852
- "designId": {
1853
- "type": "string"
1854
- },
1855
- "entityId": {
1856
- "type": "string",
1857
- "nullable": true
1858
- },
1859
- "mappingsAutomationId": {
1860
- "type": "string"
1861
- },
1862
- "templateId": {
1863
- "type": "string"
1864
- },
1865
- "targetedCustomer": {
1866
- "type": "string"
1867
- },
1868
- "description": {
1869
- "type": "string",
1870
- "nullable": true
1871
- },
1872
- "publicToken": {
1873
- "type": "string",
1874
- "nullable": true
1875
- },
1876
- "runtimeEntities": {
1877
- "type": "array",
1878
- "items": {
1879
- "type": "string",
1880
- "enum": [
1881
- "ORDER",
1882
- "OPPORTUNITY"
1883
- ]
1884
- }
1885
- },
1886
- "filePurposes": {
1887
- "type": "array",
1888
- "items": {
1889
- "type": "string"
1890
- }
1891
- },
1892
- "entityTags": {
1893
- "type": "array",
1894
- "items": {
1895
- "type": "string"
1896
- }
1897
- },
1898
- "addressSuggestionsFileUrl": {
1899
- "type": "string",
1900
- "nullable": true,
1901
- "deprecated": true,
1902
- "description": "@deprecated Use addressSuggestionsFileId instead"
1903
- },
1904
- "addressSuggestionsFileId": {
1905
- "type": "string",
1906
- "nullable": true
1907
- },
1908
- "addressSuggestionsCountryCode": {
1909
- "type": "string",
1910
- "nullable": true,
1911
- "description": "Country code for address format (e.g. DE, AT, CH, LU)"
1912
- },
1913
- "addressSuggestionsEnableAutoComplete": {
1914
- "type": "boolean",
1915
- "description": "Whether address auto-complete is enabled"
1916
- },
1917
- "addressSuggestionsSource": {
1918
- "type": "array",
1919
- "items": {
1920
- "type": "string"
1921
- },
1922
- "description": "Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)"
1923
- },
1924
- "addressSuggestionsEnableFreeText": {
1925
- "type": "boolean",
1926
- "description": "Whether free text input is allowed when auto-complete is on"
1927
- },
1928
- "useNewDesign": {
1929
- "type": "boolean",
1930
- "deprecated": true,
1931
- "description": "This property is deprecated and will be removed in a future version"
1932
- },
1933
- "thirdPartyCookies": {
1934
- "type": "boolean",
1935
- "description": "If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent."
1936
- },
1937
- "accessMode": {
1938
- "type": "string",
1939
- "enum": [
1940
- "PUBLIC",
1941
- "PRIVATE"
1942
- ]
1943
- },
1944
- "enableDarkMode": {
1945
- "type": "boolean",
1946
- "description": "If true, the journey shows an icon to toggle dark mode"
1947
- }
1948
- },
1949
- "additionalProperties": false
1950
- },
1951
- "validationRules": {
1952
- "$ref": "#/components/schemas/ValidationRuleRef"
1953
- },
1954
- "_manifest": {
1955
- "type": "array",
1956
- "description": "Manifest/Blueprint ID used to create/update the entity",
1957
- "items": {
1958
- "type": "string",
1959
- "format": "uuid",
1960
- "example": "123e4567-e89b-12d3-a456-426614174000"
1961
- }
1962
- }
1963
- },
1964
- "required": [
1965
- "name",
1966
- "steps"
1967
- ]
1968
- },
1969
- "SearchJourneysQueryRequest": {
1970
- "type": "object",
1971
- "properties": {
1972
- "q": {
1973
- "type": "string",
1974
- "description": "Lucene query syntax\nSee https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html\n",
1975
- "example": "_tags:*Flex*",
1976
- "default": "*"
1977
- },
1978
- "from": {
1979
- "type": "integer",
1980
- "description": "The offset of the first result to return.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\n",
1981
- "example": 0,
1982
- "default": 0
1983
- },
1984
- "size": {
1985
- "type": "integer",
1986
- "description": "The maximum number of results to return.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html\n",
1987
- "example": 25,
1988
- "default": 25
1989
- },
1990
- "sort": {
1991
- "type": "string",
1992
- "description": "The sort order. Follows Lucene syntax.\n",
1993
- "example": "_created_at:desc",
1994
- "default": "_created_at:desc"
1995
- }
1996
- }
1997
- },
1998
- "SearchJourneysResponse": {
1999
- "type": "object",
2000
- "properties": {
2001
- "hits": {
2002
- "type": "number",
2003
- "description": "The total number of hits.\n",
2004
- "example": 1
2005
- },
2006
- "results": {
2007
- "type": "array",
2008
- "description": "The results.\n",
2009
- "items": {
2010
- "type": "object",
2011
- "properties": {
2012
- "_id": {
2013
- "type": "string",
2014
- "description": "Journey Entity ID",
2015
- "format": "uuid",
2016
- "example": "e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8"
2017
- },
2018
- "_schema": {
2019
- "type": "string",
2020
- "description": "Entity Schema (journey always in this case)",
2021
- "example": "journey"
2022
- },
2023
- "_title": {
2024
- "type": "string",
2025
- "description": "Journey Entity Title",
2026
- "example": "Journey Entity Title"
2027
- },
2028
- "_org": {
2029
- "type": "string",
2030
- "description": "Organization ID",
2031
- "example": "739224"
2032
- },
2033
- "_created_at": {
2034
- "type": "string",
2035
- "format": "date-time",
2036
- "example": "2020-01-01T00:00:00.000Z"
2037
- },
2038
- "_updated_at": {
2039
- "type": "string",
2040
- "format": "date-time",
2041
- "example": "2020-01-01T00:00:00.000Z"
2042
- },
2043
- "_tags": {
2044
- "type": "array",
2045
- "items": {
2046
- "type": "string",
2047
- "example": "Flex"
2048
- }
2049
- },
2050
- "_manifest": {
2051
- "type": "array",
2052
- "description": "Manifest ID used to create/update the entity",
2053
- "items": {
2054
- "type": "string",
2055
- "format": "uuid",
2056
- "example": "123e4567-e89b-12d3-a456-426614174000"
2057
- }
2058
- },
2059
- "journey_name": {
2060
- "type": "string",
2061
- "description": "Journey Name",
2062
- "example": "Journey Name"
2063
- },
2064
- "journey_id": {
2065
- "type": "string",
2066
- "format": "uuid",
2067
- "description": "Journey config ID",
2068
- "example": "de7df470-253e-11ed-9174-116b8a718c0a"
2069
- },
2070
- "journey_type": {
2071
- "type": "string",
2072
- "description": "Journey Template",
2073
- "example": "Sales template"
2074
- },
2075
- "design": {
2076
- "type": "string",
2077
- "description": "Journey Design Name",
2078
- "example": "Design EPILOT"
2079
- },
2080
- "created_by": {
2081
- "type": "array",
2082
- "items": {
2083
- "type": "object",
2084
- "properties": {
2085
- "id": {
2086
- "type": "string",
2087
- "description": "User ID",
2088
- "example": "12345"
2089
- }
2090
- }
2091
- }
2092
- },
2093
- "journey_version": {
2094
- "type": "string",
2095
- "description": "Journey Version",
2096
- "enum": [
2097
- "Flex"
2098
- ]
2099
- }
2100
- }
2101
- }
2102
- }
2103
- }
2104
- },
2105
- "Journey": {
2106
- "allOf": [
2107
- {
2108
- "$ref": "#/components/schemas/JourneyCreationRequest"
2109
- },
2110
- {
2111
- "$ref": "#/components/schemas/JourneyAuditInfo"
2112
- },
2113
- {
2114
- "$ref": "#/components/schemas/JourneyFeatureFlags"
2115
- }
2116
- ]
2117
- },
2118
- "JourneyFeatureFlags": {
2119
- "type": "object",
2120
- "properties": {
2121
- "featureFlags": {
2122
- "type": "object",
2123
- "additionalProperties": true
2124
- }
2125
- }
2126
- },
2127
- "JourneyAuditInfo": {
2128
- "type": "object",
2129
- "properties": {
2130
- "createdAt": {
2131
- "type": "string"
2132
- },
2133
- "lastModifiedAt": {
2134
- "type": "string"
2135
- },
2136
- "deletedAt": {
2137
- "type": "string"
2138
- },
2139
- "version": {
2140
- "type": "number"
2141
- },
2142
- "revisions": {
2143
- "type": "number"
2144
- }
2145
- },
2146
- "required": [
2147
- "createdAt",
2148
- "lastModifiedAt",
2149
- "version",
2150
- "revisions"
2151
- ]
2152
- },
2153
- "JourneyValidationResponse": {
2154
- "type": "object",
2155
- "properties": {
2156
- "valid": {
2157
- "type": "boolean",
2158
- "description": "Whether the journey configuration is valid"
2159
- },
2160
- "errors": {
2161
- "type": "array",
2162
- "items": {
2163
- "type": "object",
2164
- "properties": {
2165
- "type": {
2166
- "type": "string",
2167
- "description": "Pattern type (e.g. PatternA_DotsInStepId)"
2168
- },
2169
- "severity": {
2170
- "type": "string",
2171
- "enum": [
2172
- "critical",
2173
- "high",
2174
- "medium",
2175
- "low"
2176
- ]
2177
- },
2178
- "message": {
2179
- "type": "string"
2180
- },
2181
- "affectedStepIds": {
2182
- "type": "array",
2183
- "items": {
2184
- "type": "string"
2185
- }
2186
- },
2187
- "count": {
2188
- "type": "integer"
2189
- },
2190
- "autoFix": {
2191
- "type": "object",
2192
- "properties": {
2193
- "feasible": {
2194
- "type": "boolean"
2195
- },
2196
- "confidence": {
2197
- "type": "string",
2198
- "enum": [
2199
- "high",
2200
- "medium",
2201
- "low"
2202
- ]
2203
- },
2204
- "reason": {
2205
- "type": "string"
2206
- },
2207
- "details": {
2208
- "type": "string"
2209
- }
2210
- }
2211
- }
2212
- }
2213
- },
2214
- "description": "List of detected validation errors"
2215
- },
2216
- "warnings": {
2217
- "type": "array",
2218
- "items": {
2219
- "type": "object",
2220
- "properties": {
2221
- "type": {
2222
- "type": "string"
2223
- },
2224
- "message": {
2225
- "type": "string"
2226
- }
2227
- }
2228
- },
2229
- "description": "List of warnings (non-critical issues)"
2230
- }
2231
- },
2232
- "required": [
2233
- "valid",
2234
- "errors"
2235
- ]
2236
- },
2237
- "JourneyValidationError": {
2238
- "type": "object",
2239
- "properties": {
2240
- "error": {
2241
- "type": "string",
2242
- "example": "ValidationError",
2243
- "description": "Error type identifier"
2244
- },
2245
- "message": {
2246
- "type": "string",
2247
- "example": "Journey configuration validation failed",
2248
- "description": "High-level error message"
2249
- },
2250
- "details": {
2251
- "type": "array",
2252
- "items": {
2253
- "type": "object",
2254
- "properties": {
2255
- "pattern": {
2256
- "type": "string",
2257
- "description": "Validation pattern that failed"
2258
- },
2259
- "severity": {
2260
- "type": "string",
2261
- "enum": [
2262
- "critical",
2263
- "high",
2264
- "medium",
2265
- "low"
2266
- ]
2267
- },
2268
- "message": {
2269
- "type": "string",
2270
- "description": "Detailed error message"
2271
- },
2272
- "count": {
2273
- "type": "integer",
2274
- "description": "Number of issues found"
2275
- }
2276
- }
2277
- },
2278
- "description": "Detailed validation errors for each pattern that failed"
2279
- }
2280
- },
2281
- "required": [
2282
- "error",
2283
- "message",
2284
- "details"
2285
- ]
2286
- },
2287
- "S3Reference": {
2288
- "type": "object",
2289
- "properties": {
2290
- "bucket": {
2291
- "type": "string",
2292
- "example": "document-api-prod"
2293
- },
2294
- "key": {
2295
- "type": "string",
2296
- "example": "uploads/my-template.pdf"
2297
- }
2298
- },
2299
- "required": [
2300
- "bucket",
2301
- "key"
2302
- ]
2303
- },
2304
- "TemplateSettings": {
2305
- "type": "object",
2306
- "description": "Template Settings for document generation",
2307
- "properties": {
2308
- "custom_margins": {
2309
- "description": "Custom margins for the document",
2310
- "type": "object",
2311
- "properties": {
2312
- "top": {
2313
- "description": "Top margin in cm",
2314
- "type": "number",
2315
- "example": 2.54
2316
- },
2317
- "bottom": {
2318
- "description": "Bottom margin in cm",
2319
- "type": "number",
2320
- "example": 2.54
2321
- }
2322
- }
2323
- },
2324
- "suggested_margins": {
2325
- "description": "Suggested margins for the document",
2326
- "type": "object",
2327
- "properties": {
2328
- "top": {
2329
- "description": "Top margin in cm",
2330
- "type": "number",
2331
- "example": 2.54
2332
- },
2333
- "bottom": {
2334
- "description": "Bottom margin in cm",
2335
- "type": "number",
2336
- "example": 2.54
2337
- }
2338
- }
2339
- },
2340
- "display_margin_guidelines": {
2341
- "description": "Display margin guidelines (applicable to partial generation only)",
2342
- "type": "boolean",
2343
- "example": true
2344
- },
2345
- "enable_data_table_margin_autofix": {
2346
- "description": "Enable data table margin autofix",
2347
- "type": "boolean",
2348
- "example": false
2349
- },
2350
- "template_with_datatable": {
2351
- "description": "A flag that indicates whether the template has 1 or more data tables in it",
2352
- "type": "boolean",
2353
- "example": false
2354
- },
2355
- "enabled_template_settings_persistence": {
2356
- "description": "Enables the persistance of template settings",
2357
- "type": "boolean",
2358
- "example": false
2359
- },
2360
- "misconfigured_margins": {
2361
- "description": "An indication that the page margins are misconfigured",
2362
- "type": "boolean",
2363
- "example": false
2364
- },
2365
- "file_entity_id": {
2366
- "description": "The file entity id, used when persisting a new template version with updated settings",
2367
- "type": "string",
2368
- "format": "uuid",
2369
- "example": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
2370
- }
2371
- }
2372
- },
2373
- "GenerateDocumentResponse": {
2374
- "type": "object",
2375
- "properties": {
2376
- "job_id": {
2377
- "type": "string",
2378
- "format": "uuid"
2379
- },
2380
- "job_status": {
2381
- "description": "Status of the job",
2382
- "type": "string",
2383
- "enum": [
2384
- "STARTED",
2385
- "PROCESSING",
2386
- "SUCCESS",
2387
- "FAILED"
2388
- ]
2389
- },
2390
- "message": {
2391
- "description": "A message explaining the progress",
2392
- "type": "string"
2393
- },
2394
- "pdf_output": {
2395
- "type": "object",
2396
- "properties": {
2397
- "preview_url": {
2398
- "description": "Pre-signed S3 GET URL for PDF preview",
2399
- "type": "string",
2400
- "example": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf"
2401
- },
2402
- "output_document": {
2403
- "type": "object",
2404
- "properties": {
2405
- "filename": {
2406
- "description": "Generated document filename for PDF",
2407
- "type": "string",
2408
- "example": "my-template-OR-001.pdf"
2409
- },
2410
- "s3ref": {
2411
- "$ref": "#/components/schemas/S3Reference"
2412
- }
2413
- },
2414
- "example": {
2415
- "s3ref": {
2416
- "bucket": "document-api-preview-prod",
2417
- "key": "preview/my-template.pdf"
2418
- }
2419
- }
2420
- }
2421
- }
2422
- },
2423
- "docx_output": {
2424
- "type": "object",
2425
- "properties": {
2426
- "preview_url": {
2427
- "description": "Pre-signed S3 GET URL for DOCX preview",
2428
- "type": "string",
2429
- "example": "https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx"
2430
- },
2431
- "output_document": {
2432
- "type": "object",
2433
- "properties": {
2434
- "filename": {
2435
- "description": "Generated document filename for DOCX",
2436
- "type": "string",
2437
- "example": "my-template-OR-001.docx"
2438
- },
2439
- "s3ref": {
2440
- "$ref": "#/components/schemas/S3Reference"
2441
- }
2442
- },
2443
- "example": {
2444
- "s3ref": {
2445
- "bucket": "document-api-preview-prod",
2446
- "key": "preview/my-template.docx"
2447
- }
2448
- }
2449
- }
2450
- }
2451
- },
2452
- "variable_payload": {
2453
- "description": "List of variables and its corresponding replaced values from the document template",
2454
- "type": "object",
2455
- "properties": {
2456
- "additionalProperties": {
2457
- "type": "string"
2458
- }
2459
- }
2460
- },
2461
- "template_settings": {
2462
- "$ref": "#/components/schemas/TemplateSettings"
2463
- }
2464
- }
2465
- },
2466
- "GenerateDocumentRequest": {
2467
- "type": "object",
2468
- "properties": {
2469
- "file_id": {
2470
- "description": "Entity id for the template being used",
2471
- "type": "string",
2472
- "example": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p"
2473
- },
2474
- "context_data": {
2475
- "description": "Custom values for variables in the template. Takes the higher precedence than others.",
2476
- "type": "object",
2477
- "properties": {
2478
- "additionalProperties": {
2479
- "type": "string"
2480
- }
2481
- }
2482
- },
2483
- "language": {
2484
- "description": "Language code for the document",
2485
- "type": "string",
2486
- "example": "de"
2487
- }
2488
- },
2489
- "required": [
2490
- "file_id",
2491
- "context_data"
2492
- ]
2493
- },
2494
- "GetSettingsForJourney": {
2495
- "type": "object",
2496
- "properties": {
2497
- "organizationId": {
2498
- "type": "string",
2499
- "description": "ID of an organization in epilot platform",
2500
- "example": "739224"
2501
- },
2502
- "canary": {
2503
- "type": "boolean",
2504
- "description": "The canary flag controls update frequency of epilot application: when true, customers receive continuous updates; when false, they only get updates with new version releases.",
2505
- "example": true
2506
- },
2507
- "thirdPartyCookies": {
2508
- "type": "boolean",
2509
- "description": "When set to false, third-party cookies and resources should be completely disabled to comply with GDPR regulations.",
2510
- "example": true
2511
- }
2512
- }
2513
- },
2514
- "ButtonOption": {
2515
- "type": "object",
2516
- "description": "A single button option data",
2517
- "properties": {
2518
- "value": {
2519
- "type": "string",
2520
- "example": "Button Hidden Value",
2521
- "description": "The value of the button"
2522
- },
2523
- "label": {
2524
- "type": "string",
2525
- "example": "Button Label",
2526
- "description": "The label of the button"
2527
- }
2528
- }
2529
- },
2530
- "ValidationRuleRef": {
2531
- "type": "object",
2532
- "description": "References to validation rules organized by blocks and fields.\nMaps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).\n",
2533
- "additionalProperties": {
2534
- "oneOf": [
2535
- {
2536
- "type": "string",
2537
- "description": "Rule ID for block-level validation"
2538
- },
2539
- {
2540
- "$ref": "#/components/schemas/RuleRef"
2541
- }
2542
- ]
2543
- },
2544
- "example": {
2545
- "block1": "rule123",
2546
- "block2": {
2547
- "field1": "rule456",
2548
- "field2": "rule789"
2549
- }
2550
- }
2551
- },
2552
- "RuleRef": {
2553
- "type": "object",
2554
- "description": "Field-level rule references within a block.\nMaps field names to rule IDs.\n",
2555
- "additionalProperties": {
2556
- "type": "string",
2557
- "description": "Rule ID for field-level validation"
2558
- },
2559
- "example": {
2560
- "firstName": "rule123",
2561
- "lastName": "rule456",
2562
- "email": "rule789"
2563
- }
2564
- }
2565
- },
2566
- "securitySchemes": {
2567
- "EpilotAuth": {
2568
- "type": "http",
2569
- "scheme": "bearer",
2570
- "description": "Epilot Authorization Bearer Token - public access token / user token",
2571
- "bearerFormat": "JWT"
2572
- },
2573
- "PortalAuth": {
2574
- "type": "http",
2575
- "scheme": "bearer",
2576
- "description": "Portal Authorization Bearer Token",
2577
- "bearerFormat": "JWT"
2578
- }
2579
- }
2580
- },
2581
- "servers": [
2582
- {
2583
- "url": "https://journey-config.sls.epilot.io"
2584
- }
2585
- ]
2586
- }