@epilot/sdk 2.20.9 → 2.20.11

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