@epilot/sdk 2.0.0-beta.4 → 2.0.3

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