@epilot/sdk 2.4.3 → 2.4.4-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (348) hide show
  1. package/README.md +1 -0
  2. package/definitions/app-runtime.json +1 -1
  3. package/definitions/app.json +346 -10
  4. package/definitions/calendar-runtime.json +1 -0
  5. package/definitions/calendar.json +675 -0
  6. package/definitions/customer-portal.json +29 -0
  7. package/definitions/notes.json +175 -130
  8. package/definitions/pricing.json +5 -1
  9. package/dist/README-46VYEGGW.js +7 -0
  10. package/dist/README-IVBISSWB.cjs +7 -0
  11. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  12. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  13. package/dist/apis/_registry.d.ts +8 -0
  14. package/dist/apis/access-token.cjs +6 -6
  15. package/dist/apis/access-token.d.ts +9 -12
  16. package/dist/apis/access-token.js +1 -1
  17. package/dist/apis/address-suggestions.cjs +6 -6
  18. package/dist/apis/address-suggestions.d.ts +9 -12
  19. package/dist/apis/address-suggestions.js +1 -1
  20. package/dist/apis/address.cjs +6 -6
  21. package/dist/apis/address.d.ts +9 -12
  22. package/dist/apis/address.js +1 -1
  23. package/dist/apis/ai-agents.cjs +6 -6
  24. package/dist/apis/ai-agents.d.ts +9 -12
  25. package/dist/apis/ai-agents.js +1 -1
  26. package/dist/apis/app.cjs +6 -6
  27. package/dist/apis/app.d.ts +9 -12
  28. package/dist/apis/app.js +1 -1
  29. package/dist/apis/audit-logs.cjs +6 -6
  30. package/dist/apis/audit-logs.d.ts +9 -12
  31. package/dist/apis/audit-logs.js +1 -1
  32. package/dist/apis/automation.cjs +6 -6
  33. package/dist/apis/automation.d.ts +9 -12
  34. package/dist/apis/automation.js +1 -1
  35. package/dist/apis/billing.cjs +6 -6
  36. package/dist/apis/billing.d.ts +9 -12
  37. package/dist/apis/billing.js +1 -1
  38. package/dist/apis/blueprint-manifest.cjs +6 -6
  39. package/dist/apis/blueprint-manifest.d.ts +9 -12
  40. package/dist/apis/blueprint-manifest.js +1 -1
  41. package/dist/apis/calendar.cjs +38 -0
  42. package/dist/apis/calendar.d.ts +15 -0
  43. package/dist/apis/calendar.js +38 -0
  44. package/dist/apis/configuration-hub.cjs +6 -6
  45. package/dist/apis/configuration-hub.d.ts +9 -12
  46. package/dist/apis/configuration-hub.js +1 -1
  47. package/dist/apis/consent.cjs +6 -6
  48. package/dist/apis/consent.d.ts +9 -12
  49. package/dist/apis/consent.js +1 -1
  50. package/dist/apis/customer-portal.cjs +6 -6
  51. package/dist/apis/customer-portal.d.ts +9 -12
  52. package/dist/apis/customer-portal.js +1 -1
  53. package/dist/apis/dashboard.cjs +6 -6
  54. package/dist/apis/dashboard.d.ts +9 -12
  55. package/dist/apis/dashboard.js +1 -1
  56. package/dist/apis/data-governance.cjs +6 -6
  57. package/dist/apis/data-governance.d.ts +9 -12
  58. package/dist/apis/data-governance.js +1 -1
  59. package/dist/apis/deduplication.cjs +6 -6
  60. package/dist/apis/deduplication.d.ts +9 -12
  61. package/dist/apis/deduplication.js +1 -1
  62. package/dist/apis/design.cjs +6 -6
  63. package/dist/apis/design.d.ts +9 -12
  64. package/dist/apis/design.js +1 -1
  65. package/dist/apis/document.cjs +6 -6
  66. package/dist/apis/document.d.ts +9 -12
  67. package/dist/apis/document.js +1 -1
  68. package/dist/apis/email-settings.cjs +6 -6
  69. package/dist/apis/email-settings.d.ts +9 -12
  70. package/dist/apis/email-settings.js +1 -1
  71. package/dist/apis/email-template.cjs +6 -6
  72. package/dist/apis/email-template.d.ts +9 -12
  73. package/dist/apis/email-template.js +1 -1
  74. package/dist/apis/entity-mapping.cjs +6 -6
  75. package/dist/apis/entity-mapping.d.ts +9 -12
  76. package/dist/apis/entity-mapping.js +1 -1
  77. package/dist/apis/entity.cjs +6 -6
  78. package/dist/apis/entity.d.ts +9 -12
  79. package/dist/apis/entity.js +1 -1
  80. package/dist/apis/environments.cjs +6 -6
  81. package/dist/apis/environments.d.ts +9 -12
  82. package/dist/apis/environments.js +1 -1
  83. package/dist/apis/event-catalog.cjs +6 -6
  84. package/dist/apis/event-catalog.d.ts +9 -12
  85. package/dist/apis/event-catalog.js +1 -1
  86. package/dist/apis/file.cjs +6 -6
  87. package/dist/apis/file.d.ts +9 -12
  88. package/dist/apis/file.js +1 -1
  89. package/dist/apis/iban.cjs +6 -6
  90. package/dist/apis/iban.d.ts +9 -12
  91. package/dist/apis/iban.js +1 -1
  92. package/dist/apis/integration-toolkit.cjs +6 -6
  93. package/dist/apis/integration-toolkit.d.ts +9 -12
  94. package/dist/apis/integration-toolkit.js +1 -1
  95. package/dist/apis/journey.cjs +6 -6
  96. package/dist/apis/journey.d.ts +9 -12
  97. package/dist/apis/journey.js +1 -1
  98. package/dist/apis/kanban.cjs +6 -6
  99. package/dist/apis/kanban.d.ts +9 -12
  100. package/dist/apis/kanban.js +1 -1
  101. package/dist/apis/message.cjs +6 -6
  102. package/dist/apis/message.d.ts +9 -12
  103. package/dist/apis/message.js +1 -1
  104. package/dist/apis/metering.cjs +6 -6
  105. package/dist/apis/metering.d.ts +9 -12
  106. package/dist/apis/metering.js +1 -1
  107. package/dist/apis/notes.cjs +6 -6
  108. package/dist/apis/notes.d.ts +9 -12
  109. package/dist/apis/notes.js +1 -1
  110. package/dist/apis/notification.cjs +6 -6
  111. package/dist/apis/notification.d.ts +9 -12
  112. package/dist/apis/notification.js +1 -1
  113. package/dist/apis/organization.cjs +6 -6
  114. package/dist/apis/organization.d.ts +9 -12
  115. package/dist/apis/organization.js +1 -1
  116. package/dist/apis/partner-directory.cjs +6 -6
  117. package/dist/apis/partner-directory.d.ts +9 -12
  118. package/dist/apis/partner-directory.js +1 -1
  119. package/dist/apis/permissions.cjs +6 -6
  120. package/dist/apis/permissions.d.ts +9 -12
  121. package/dist/apis/permissions.js +1 -1
  122. package/dist/apis/pricing-tier.cjs +6 -6
  123. package/dist/apis/pricing-tier.d.ts +9 -12
  124. package/dist/apis/pricing-tier.js +1 -1
  125. package/dist/apis/pricing.cjs +6 -6
  126. package/dist/apis/pricing.d.ts +9 -12
  127. package/dist/apis/pricing.js +1 -1
  128. package/dist/apis/purpose.cjs +6 -6
  129. package/dist/apis/purpose.d.ts +9 -12
  130. package/dist/apis/purpose.js +1 -1
  131. package/dist/apis/query.cjs +6 -6
  132. package/dist/apis/query.d.ts +9 -12
  133. package/dist/apis/query.js +1 -1
  134. package/dist/apis/sandbox.cjs +6 -6
  135. package/dist/apis/sandbox.d.ts +9 -12
  136. package/dist/apis/sandbox.js +1 -1
  137. package/dist/apis/sharing.cjs +6 -6
  138. package/dist/apis/sharing.d.ts +9 -12
  139. package/dist/apis/sharing.js +1 -1
  140. package/dist/apis/submission.cjs +6 -6
  141. package/dist/apis/submission.d.ts +9 -12
  142. package/dist/apis/submission.js +1 -1
  143. package/dist/apis/target.cjs +6 -6
  144. package/dist/apis/target.d.ts +9 -591
  145. package/dist/apis/target.js +1 -1
  146. package/dist/apis/targeting.cjs +6 -6
  147. package/dist/apis/targeting.d.ts +9 -12
  148. package/dist/apis/targeting.js +1 -1
  149. package/dist/apis/template-variables.cjs +6 -6
  150. package/dist/apis/template-variables.d.ts +9 -12
  151. package/dist/apis/template-variables.js +1 -1
  152. package/dist/apis/user.cjs +6 -6
  153. package/dist/apis/user.d.ts +9 -12
  154. package/dist/apis/user.js +1 -1
  155. package/dist/apis/validation-rules.cjs +6 -6
  156. package/dist/apis/validation-rules.d.ts +9 -12
  157. package/dist/apis/validation-rules.js +1 -1
  158. package/dist/apis/webhooks.cjs +6 -6
  159. package/dist/apis/webhooks.d.ts +9 -12
  160. package/dist/apis/webhooks.js +1 -1
  161. package/dist/apis/workflow-definition.cjs +6 -6
  162. package/dist/apis/workflow-definition.d.ts +9 -12
  163. package/dist/apis/workflow-definition.js +1 -1
  164. package/dist/apis/workflow.cjs +6 -6
  165. package/dist/apis/workflow.d.ts +9 -12
  166. package/dist/apis/workflow.js +1 -1
  167. package/dist/authorize.d.ts +3 -0
  168. package/dist/bin/cli.d.ts +1 -0
  169. package/dist/bin/cli.js +1 -1
  170. package/dist/calendar-2YDAYG7S.cjs +7 -0
  171. package/dist/calendar-ACFIHQ2N.js +7 -0
  172. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  173. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  174. package/dist/{chunk-AM5TSEMU.cjs → chunk-CD4OX2U6.cjs} +4 -2
  175. package/dist/chunk-CKLEBO4K.cjs +14 -0
  176. package/dist/chunk-JNH37UUH.js +14 -0
  177. package/dist/{chunk-M25MI6ZX.js → chunk-TSV242UN.js} +4 -2
  178. package/dist/client-factory.d.ts +9 -0
  179. package/dist/client-map.d.ts +102 -0
  180. package/dist/compact.d.ts +22 -0
  181. package/dist/help.d.ts +12 -0
  182. package/dist/index.cjs +25 -17
  183. package/dist/index.d.ts +12 -180
  184. package/dist/index.js +21 -13
  185. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  186. package/dist/large-response.d.ts +9 -0
  187. package/dist/openapi.d.ts +12 -0
  188. package/dist/overrides.d.ts +9 -0
  189. package/dist/proxy.d.ts +14 -0
  190. package/dist/registry.d.ts +19 -0
  191. package/dist/retry.d.ts +11 -0
  192. package/dist/sdk.d.ts +29 -0
  193. package/dist/types.d.ts +53 -0
  194. package/docs/calendar.md +441 -0
  195. package/package.json +10 -1
  196. package/dist/README-6MG272KM.cjs +0 -7
  197. package/dist/README-7N542PBL.js +0 -7
  198. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  199. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  200. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  201. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  202. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  203. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  204. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  205. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  206. package/dist/apis/access-token.d.cts +0 -18
  207. package/dist/apis/address-suggestions.d.cts +0 -18
  208. package/dist/apis/address.d.cts +0 -18
  209. package/dist/apis/ai-agents.d.cts +0 -18
  210. package/dist/apis/app.d.cts +0 -18
  211. package/dist/apis/audit-logs.d.cts +0 -18
  212. package/dist/apis/automation.d.cts +0 -18
  213. package/dist/apis/billing.d.cts +0 -18
  214. package/dist/apis/blueprint-manifest.d.cts +0 -18
  215. package/dist/apis/configuration-hub.d.cts +0 -18
  216. package/dist/apis/consent.d.cts +0 -18
  217. package/dist/apis/customer-portal.d.cts +0 -18
  218. package/dist/apis/dashboard.d.cts +0 -18
  219. package/dist/apis/data-governance.d.cts +0 -18
  220. package/dist/apis/deduplication.d.cts +0 -18
  221. package/dist/apis/design.d.cts +0 -18
  222. package/dist/apis/document.d.cts +0 -18
  223. package/dist/apis/email-settings.d.cts +0 -18
  224. package/dist/apis/email-template.d.cts +0 -18
  225. package/dist/apis/entity-mapping.d.cts +0 -18
  226. package/dist/apis/entity.d.cts +0 -18
  227. package/dist/apis/environments.d.cts +0 -18
  228. package/dist/apis/event-catalog.d.cts +0 -18
  229. package/dist/apis/file.d.cts +0 -18
  230. package/dist/apis/iban.d.cts +0 -18
  231. package/dist/apis/integration-toolkit.d.cts +0 -18
  232. package/dist/apis/journey.d.cts +0 -18
  233. package/dist/apis/kanban.d.cts +0 -18
  234. package/dist/apis/message.d.cts +0 -18
  235. package/dist/apis/metering.d.cts +0 -18
  236. package/dist/apis/notes.d.cts +0 -18
  237. package/dist/apis/notification.d.cts +0 -18
  238. package/dist/apis/organization.d.cts +0 -18
  239. package/dist/apis/partner-directory.d.cts +0 -18
  240. package/dist/apis/permissions.d.cts +0 -18
  241. package/dist/apis/pricing-tier.d.cts +0 -18
  242. package/dist/apis/pricing.d.cts +0 -18
  243. package/dist/apis/purpose.d.cts +0 -18
  244. package/dist/apis/query.d.cts +0 -18
  245. package/dist/apis/sandbox.d.cts +0 -18
  246. package/dist/apis/sharing.d.cts +0 -18
  247. package/dist/apis/submission.d.cts +0 -18
  248. package/dist/apis/target.d.cts +0 -597
  249. package/dist/apis/targeting.d.cts +0 -18
  250. package/dist/apis/template-variables.d.cts +0 -18
  251. package/dist/apis/user.d.cts +0 -18
  252. package/dist/apis/validation-rules.d.cts +0 -18
  253. package/dist/apis/webhooks.d.cts +0 -18
  254. package/dist/apis/workflow-definition.d.cts +0 -18
  255. package/dist/apis/workflow.d.cts +0 -18
  256. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  257. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  258. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  259. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  260. package/dist/automation.d-Du6-uiz5.d.cts +0 -5283
  261. package/dist/automation.d-Du6-uiz5.d.ts +0 -5283
  262. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  263. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  264. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  265. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  266. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  267. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  268. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  269. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  270. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  271. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  272. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  273. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  274. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  275. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  276. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  277. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  278. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  279. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  280. package/dist/document.d-DN37pjdx.d.cts +0 -648
  281. package/dist/document.d-DN37pjdx.d.ts +0 -648
  282. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  283. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  284. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  285. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  286. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  287. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  288. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  289. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  290. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  291. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  292. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  293. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  294. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  295. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  296. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  297. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  298. package/dist/index.d.cts +0 -180
  299. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  300. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  301. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  302. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  303. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  304. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  305. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  306. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  307. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  308. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  309. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  310. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  311. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  312. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  313. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  314. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  315. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  316. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  317. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  318. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  319. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  320. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  321. package/dist/pricing.d-BHpMU4KU.d.cts +0 -12255
  322. package/dist/pricing.d-BHpMU4KU.d.ts +0 -12255
  323. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  324. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  325. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  326. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  327. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  328. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  329. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  330. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  331. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  332. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  333. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  334. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  335. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  336. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  337. package/dist/types-ChU9Acbv.d.cts +0 -37
  338. package/dist/types-ChU9Acbv.d.ts +0 -37
  339. package/dist/user.d-D18fe97W.d.cts +0 -2270
  340. package/dist/user.d-D18fe97W.d.ts +0 -2270
  341. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  342. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  343. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  344. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  345. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  346. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  347. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  348. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,1931 +0,0 @@
1
- import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from journey-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- /**
9
- * A single button option data
10
- */
11
- export interface ButtonOption {
12
- /**
13
- * The value of the button
14
- * example:
15
- * Button Hidden Value
16
- */
17
- value?: string;
18
- /**
19
- * The label of the button
20
- * example:
21
- * Button Label
22
- */
23
- label?: string;
24
- }
25
- export interface GenerateDocumentRequest {
26
- /**
27
- * Entity id for the template being used
28
- * example:
29
- * 1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p
30
- */
31
- file_id: string;
32
- /**
33
- * Custom values for variables in the template. Takes the higher precedence than others.
34
- */
35
- context_data: {
36
- additionalProperties?: string;
37
- };
38
- /**
39
- * Language code for the document
40
- * example:
41
- * de
42
- */
43
- language?: string;
44
- }
45
- export interface GenerateDocumentResponse {
46
- job_id?: string; // uuid
47
- /**
48
- * Status of the job
49
- */
50
- job_status?: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED";
51
- /**
52
- * A message explaining the progress
53
- */
54
- message?: string;
55
- pdf_output?: {
56
- /**
57
- * Pre-signed S3 GET URL for PDF preview
58
- * example:
59
- * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.pdf
60
- */
61
- preview_url?: string;
62
- /**
63
- * example:
64
- * {
65
- * "s3ref": {
66
- * "bucket": "document-api-preview-prod",
67
- * "key": "preview/my-template.pdf"
68
- * }
69
- * }
70
- */
71
- output_document?: {
72
- /**
73
- * Generated document filename for PDF
74
- * example:
75
- * my-template-OR-001.pdf
76
- */
77
- filename?: string;
78
- s3ref?: S3Reference;
79
- };
80
- };
81
- docx_output?: {
82
- /**
83
- * Pre-signed S3 GET URL for DOCX preview
84
- * example:
85
- * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.docx
86
- */
87
- preview_url?: string;
88
- /**
89
- * example:
90
- * {
91
- * "s3ref": {
92
- * "bucket": "document-api-preview-prod",
93
- * "key": "preview/my-template.docx"
94
- * }
95
- * }
96
- */
97
- output_document?: {
98
- /**
99
- * Generated document filename for DOCX
100
- * example:
101
- * my-template-OR-001.docx
102
- */
103
- filename?: string;
104
- s3ref?: S3Reference;
105
- };
106
- };
107
- /**
108
- * List of variables and its corresponding replaced values from the document template
109
- */
110
- variable_payload?: {
111
- additionalProperties?: string;
112
- };
113
- template_settings?: /* Template Settings for document generation */ TemplateSettings;
114
- }
115
- export interface GetJourneysResponse {
116
- }
117
- export interface GetSettingsForJourney {
118
- /**
119
- * ID of an organization in epilot platform
120
- * example:
121
- * 739224
122
- */
123
- organizationId?: string;
124
- /**
125
- * 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.
126
- * example:
127
- * true
128
- */
129
- canary?: boolean;
130
- /**
131
- * When set to false, third-party cookies and resources should be completely disabled to comply with GDPR regulations.
132
- * example:
133
- * true
134
- */
135
- thirdPartyCookies?: boolean;
136
- }
137
- export interface Journey {
138
- [name: string]: any;
139
- journeyId?: string;
140
- organizationId: string;
141
- brandId?: string;
142
- name: string;
143
- steps: {
144
- showStepName?: boolean | null;
145
- title?: string | null;
146
- subTitle?: string | null;
147
- showStepSubtitle?: boolean | null;
148
- showStepper?: boolean | null;
149
- showStepperLabels?: boolean | null;
150
- hideNextButton?: boolean | null;
151
- name: string;
152
- stepId?: string;
153
- schema: any;
154
- uischema: any;
155
- maxWidth?: "small" | "medium" | "large" | "extra large";
156
- }[];
157
- design?: {
158
- logoUrl?: string | null;
159
- theme?: {
160
- [name: string]: any;
161
- };
162
- designTokens?: {
163
- [key: string]: any;
164
- };
165
- };
166
- rules?: {
167
- type: "inject" | "injectWithKey";
168
- sourceType: "journey" | "step" | "block";
169
- source: string;
170
- target: string;
171
- }[];
172
- logics?: {
173
- autoGeneratedId?: string;
174
- conditions: string[];
175
- actions: string[];
176
- }[];
177
- logicsV4?: {
178
- [name: string]: {
179
- /**
180
- * Unique identifier for logic. Use uuidv7
181
- */
182
- id?: string; // uuid
183
- /**
184
- * If true, logic can't be manipulated by the configuring user
185
- */
186
- protected?: boolean;
187
- /**
188
- * Indicates which action to take in case logic evaluates to true
189
- */
190
- action?: string;
191
- /**
192
- * Indicates when the logic should be evaluated
193
- */
194
- triggeredOn?: string;
195
- conditions?: {
196
- /**
197
- * Operator to be applied between the fact value and the value
198
- */
199
- operator?: string;
200
- /**
201
- * If operator is a custom function, this needs to be provided
202
- */
203
- functionName?: string;
204
- fact?: {
205
- /**
206
- * Unique identifier for a fact
207
- */
208
- id?: string; // uuid
209
- /**
210
- * Indicates reference type (block or context parameter)
211
- */
212
- referenceType?: string;
213
- /**
214
- * Id of the reference
215
- */
216
- referenceId?: string;
217
- /**
218
- * Path to a property. Used if only part of the value is needed
219
- */
220
- path?: string;
221
- /**
222
- * If path is a reference, indicates the intention of it
223
- */
224
- meaning?: string;
225
- };
226
- value?: string | number | boolean | {
227
- [key: string]: any;
228
- } | any[];
229
- args?: {
230
- [key: string]: any;
231
- };
232
- }[][];
233
- /**
234
- * Logic specific settings. Will vary by type of logic
235
- */
236
- settings?: {
237
- [key: string]: any;
238
- };
239
- };
240
- };
241
- contextSchema?: {
242
- /**
243
- * Unique identifier for the context schema item
244
- */
245
- id?: string; // uuid
246
- /**
247
- * Type of the parameter. It could be either an entity slug, or a text
248
- */
249
- type: string;
250
- /**
251
- * Expected key to be received in the context
252
- */
253
- paramKey: string;
254
- /**
255
- * Indicates if a value is expected to be provided
256
- */
257
- isRequired?: boolean;
258
- /**
259
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
260
- */
261
- shouldLoadEntity?: boolean;
262
- }[];
263
- /**
264
- * Journey Template
265
- * example:
266
- * Sales template (Premium)
267
- */
268
- journey_type?: string;
269
- /**
270
- * If true, journey is displayed in read-only mode
271
- */
272
- protected?: boolean;
273
- settings?: {
274
- embedOptions?: {
275
- mode?: "full-screen" | "inline";
276
- lang?: "de" | "en" | "fr";
277
- width?: string;
278
- topBar?: boolean;
279
- scrollToTop?: boolean;
280
- button?: {
281
- text?: string | null;
282
- align?: "left" | "center" | "right";
283
- };
284
- };
285
- safeModeAutomation?: boolean;
286
- /**
287
- * 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.
288
- */
289
- canary?: boolean;
290
- designId: string;
291
- templateId?: string;
292
- entityId?: string | null;
293
- mappingsAutomationId?: string;
294
- targetedCustomer?: string;
295
- description?: string | null;
296
- organizationSettings?: {
297
- [name: string]: boolean;
298
- } | null;
299
- publicToken?: string | null;
300
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
301
- filePurposes?: string[];
302
- entityTags?: string[];
303
- /**
304
- * @deprecated Use addressSuggestionsFileId instead
305
- */
306
- addressSuggestionsFileUrl?: string | null;
307
- addressSuggestionsFileId?: string | null;
308
- /**
309
- * Country code for address format (e.g. DE, AT, CH, LU)
310
- */
311
- addressSuggestionsCountryCode?: string | null;
312
- /**
313
- * Whether address auto-complete is enabled
314
- */
315
- addressSuggestionsEnableAutoComplete?: boolean;
316
- /**
317
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
318
- */
319
- addressSuggestionsSource?: string[];
320
- /**
321
- * Whether free text input is allowed when auto-complete is on
322
- */
323
- addressSuggestionsEnableFreeText?: boolean;
324
- /**
325
- * This property is deprecated and will be removed in a future version
326
- */
327
- useNewDesign?: boolean;
328
- /**
329
- * If true, some journey input labels are in Austrian format
330
- */
331
- useAustrianLabels?: boolean;
332
- /**
333
- * If true, the journey shows an icon to toggle dark mode
334
- */
335
- enableDarkMode?: boolean;
336
- accessMode?: "PUBLIC" | "PRIVATE";
337
- isPublished?: boolean;
338
- status?: string;
339
- isActive?: boolean;
340
- savingProgress?: {
341
- savingMode?: "auto" | "local" | "remote" | "none";
342
- supportedVersion?: number;
343
- };
344
- /**
345
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
346
- */
347
- thirdPartyCookies?: boolean;
348
- };
349
- validationRules?: /**
350
- * References to validation rules organized by blocks and fields.
351
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
352
- *
353
- * example:
354
- * {
355
- * "block1": "rule123",
356
- * "block2": {
357
- * "field1": "rule456",
358
- * "field2": "rule789"
359
- * }
360
- * }
361
- */
362
- ValidationRuleRef;
363
- /**
364
- * Manifest/Blueprint ID used to create/update the entity
365
- */
366
- _manifest?: string /* uuid */[];
367
- createdBy?: string;
368
- updatedBy?: string | null;
369
- /**
370
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
371
- */
372
- __lastModifiedAt?: string | null;
373
- createdAt: string;
374
- lastModifiedAt: string;
375
- deletedAt?: string;
376
- version: number;
377
- revisions: number;
378
- featureFlags?: {
379
- [name: string]: any;
380
- };
381
- }
382
- export interface JourneyAuditInfo {
383
- createdAt: string;
384
- lastModifiedAt: string;
385
- deletedAt?: string;
386
- version: number;
387
- revisions: number;
388
- }
389
- export interface JourneyCreationRequest {
390
- [name: string]: any;
391
- journeyId?: string;
392
- organizationId: string;
393
- brandId?: string;
394
- name: string;
395
- steps: {
396
- showStepName?: boolean | null;
397
- title?: string | null;
398
- subTitle?: string | null;
399
- showStepSubtitle?: boolean | null;
400
- showStepper?: boolean | null;
401
- showStepperLabels?: boolean | null;
402
- hideNextButton?: boolean | null;
403
- name: string;
404
- stepId?: string;
405
- schema: any;
406
- uischema: any;
407
- maxWidth?: "small" | "medium" | "large" | "extra large";
408
- }[];
409
- design?: {
410
- logoUrl?: string | null;
411
- theme?: {
412
- [name: string]: any;
413
- };
414
- designTokens?: {
415
- [key: string]: any;
416
- };
417
- };
418
- rules?: {
419
- type: "inject" | "injectWithKey";
420
- sourceType: "journey" | "step" | "block";
421
- source: string;
422
- target: string;
423
- }[];
424
- logics?: {
425
- autoGeneratedId?: string;
426
- conditions: string[];
427
- actions: string[];
428
- }[];
429
- logicsV4?: {
430
- [name: string]: {
431
- /**
432
- * Unique identifier for logic. Use uuidv7
433
- */
434
- id?: string; // uuid
435
- /**
436
- * If true, logic can't be manipulated by the configuring user
437
- */
438
- protected?: boolean;
439
- /**
440
- * Indicates which action to take in case logic evaluates to true
441
- */
442
- action?: string;
443
- /**
444
- * Indicates when the logic should be evaluated
445
- */
446
- triggeredOn?: string;
447
- conditions?: {
448
- /**
449
- * Operator to be applied between the fact value and the value
450
- */
451
- operator?: string;
452
- /**
453
- * If operator is a custom function, this needs to be provided
454
- */
455
- functionName?: string;
456
- fact?: {
457
- /**
458
- * Unique identifier for a fact
459
- */
460
- id?: string; // uuid
461
- /**
462
- * Indicates reference type (block or context parameter)
463
- */
464
- referenceType?: string;
465
- /**
466
- * Id of the reference
467
- */
468
- referenceId?: string;
469
- /**
470
- * Path to a property. Used if only part of the value is needed
471
- */
472
- path?: string;
473
- /**
474
- * If path is a reference, indicates the intention of it
475
- */
476
- meaning?: string;
477
- };
478
- value?: string | number | boolean | {
479
- [key: string]: any;
480
- } | any[];
481
- args?: {
482
- [key: string]: any;
483
- };
484
- }[][];
485
- /**
486
- * Logic specific settings. Will vary by type of logic
487
- */
488
- settings?: {
489
- [key: string]: any;
490
- };
491
- };
492
- };
493
- contextSchema?: {
494
- /**
495
- * Unique identifier for the context schema item
496
- */
497
- id?: string; // uuid
498
- /**
499
- * Type of the parameter. It could be either an entity slug, or a text
500
- */
501
- type: string;
502
- /**
503
- * Expected key to be received in the context
504
- */
505
- paramKey: string;
506
- /**
507
- * Indicates if a value is expected to be provided
508
- */
509
- isRequired?: boolean;
510
- /**
511
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
512
- */
513
- shouldLoadEntity?: boolean;
514
- }[];
515
- /**
516
- * Journey Template
517
- * example:
518
- * Sales template (Premium)
519
- */
520
- journey_type?: string;
521
- /**
522
- * If true, journey is displayed in read-only mode
523
- */
524
- protected?: boolean;
525
- settings?: {
526
- embedOptions?: {
527
- mode?: "full-screen" | "inline";
528
- lang?: "de" | "en" | "fr";
529
- width?: string;
530
- topBar?: boolean;
531
- scrollToTop?: boolean;
532
- button?: {
533
- text?: string | null;
534
- align?: "left" | "center" | "right";
535
- };
536
- };
537
- safeModeAutomation?: boolean;
538
- /**
539
- * 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.
540
- */
541
- canary?: boolean;
542
- designId: string;
543
- templateId?: string;
544
- entityId?: string | null;
545
- mappingsAutomationId?: string;
546
- targetedCustomer?: string;
547
- description?: string | null;
548
- organizationSettings?: {
549
- [name: string]: boolean;
550
- } | null;
551
- publicToken?: string | null;
552
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
553
- filePurposes?: string[];
554
- entityTags?: string[];
555
- /**
556
- * @deprecated Use addressSuggestionsFileId instead
557
- */
558
- addressSuggestionsFileUrl?: string | null;
559
- addressSuggestionsFileId?: string | null;
560
- /**
561
- * Country code for address format (e.g. DE, AT, CH, LU)
562
- */
563
- addressSuggestionsCountryCode?: string | null;
564
- /**
565
- * Whether address auto-complete is enabled
566
- */
567
- addressSuggestionsEnableAutoComplete?: boolean;
568
- /**
569
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
570
- */
571
- addressSuggestionsSource?: string[];
572
- /**
573
- * Whether free text input is allowed when auto-complete is on
574
- */
575
- addressSuggestionsEnableFreeText?: boolean;
576
- /**
577
- * This property is deprecated and will be removed in a future version
578
- */
579
- useNewDesign?: boolean;
580
- /**
581
- * If true, some journey input labels are in Austrian format
582
- */
583
- useAustrianLabels?: boolean;
584
- /**
585
- * If true, the journey shows an icon to toggle dark mode
586
- */
587
- enableDarkMode?: boolean;
588
- accessMode?: "PUBLIC" | "PRIVATE";
589
- isPublished?: boolean;
590
- status?: string;
591
- isActive?: boolean;
592
- savingProgress?: {
593
- savingMode?: "auto" | "local" | "remote" | "none";
594
- supportedVersion?: number;
595
- };
596
- /**
597
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
598
- */
599
- thirdPartyCookies?: boolean;
600
- };
601
- validationRules?: /**
602
- * References to validation rules organized by blocks and fields.
603
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
604
- *
605
- * example:
606
- * {
607
- * "block1": "rule123",
608
- * "block2": {
609
- * "field1": "rule456",
610
- * "field2": "rule789"
611
- * }
612
- * }
613
- */
614
- ValidationRuleRef;
615
- /**
616
- * Manifest/Blueprint ID used to create/update the entity
617
- */
618
- _manifest?: string /* uuid */[];
619
- createdBy?: string;
620
- updatedBy?: string | null;
621
- /**
622
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
623
- */
624
- __lastModifiedAt?: string | null;
625
- }
626
- export interface JourneyCreationRequestV2 {
627
- journeyId?: string;
628
- brandId?: string;
629
- name: string;
630
- steps: {
631
- showStepName?: boolean | null;
632
- title?: string | null;
633
- subTitle?: string | null;
634
- showStepSubtitle?: boolean | null;
635
- showStepper?: boolean | null;
636
- showStepperLabels?: boolean | null;
637
- hideNextButton?: boolean | null;
638
- name: string;
639
- stepId?: string;
640
- schema: any;
641
- uischema: any;
642
- maxWidth?: "small" | "medium" | "large" | "extra large";
643
- }[];
644
- design?: {
645
- logoUrl?: string | null;
646
- theme?: {
647
- [name: string]: any;
648
- };
649
- designTokens?: {
650
- [key: string]: any;
651
- };
652
- };
653
- rules?: {
654
- type: "inject" | "injectWithKey";
655
- sourceType: "journey" | "step" | "block";
656
- source: string;
657
- target: string;
658
- }[];
659
- logics?: {
660
- autoGeneratedId?: string;
661
- conditions: string[];
662
- actions: string[];
663
- }[];
664
- logicsV4?: {
665
- [name: string]: {
666
- /**
667
- * Unique identifier for logic. Use uuidv7
668
- */
669
- id?: string; // uuid
670
- /**
671
- * If true, logic can't be manipulated by the configuring user
672
- */
673
- protected?: boolean;
674
- /**
675
- * Indicates which action to take in case logic evaluates to true
676
- */
677
- action?: string;
678
- /**
679
- * Indicates when the logic should be evaluated
680
- */
681
- triggeredOn?: string;
682
- conditions?: {
683
- /**
684
- * Operator to be applied between the fact value and the value
685
- */
686
- operator?: string;
687
- /**
688
- * If operator is a custom function, this needs to be provided
689
- */
690
- functionName?: string;
691
- fact?: {
692
- /**
693
- * Unique identifier for a fact
694
- */
695
- id?: string; // uuid
696
- /**
697
- * Indicates reference type (block or context parameter)
698
- */
699
- referenceType?: string;
700
- /**
701
- * Id of the reference
702
- */
703
- referenceId?: string;
704
- /**
705
- * Path to a property. Used if only part of the value is needed
706
- */
707
- path?: string;
708
- /**
709
- * If path is a reference, indicates the intention of it
710
- */
711
- meaning?: string;
712
- };
713
- value?: string | number | boolean | {
714
- [key: string]: any;
715
- } | any[];
716
- args?: {
717
- [key: string]: any;
718
- };
719
- }[][];
720
- /**
721
- * Logic specific settings. Will vary by type of logic
722
- */
723
- settings?: {
724
- [key: string]: any;
725
- };
726
- };
727
- };
728
- contextSchema?: {
729
- /**
730
- * Unique identifier for the context schema item
731
- */
732
- id?: string; // uuid
733
- /**
734
- * Type of the parameter. It could be either an entity slug, or a text
735
- */
736
- type: string;
737
- /**
738
- * Expected key to be received in the context
739
- */
740
- paramKey: string;
741
- /**
742
- * Indicates if a value is expected to be provided
743
- */
744
- isRequired?: boolean;
745
- /**
746
- * If type is not text, we can instruct the journey to fetch the entity id we receive as value
747
- */
748
- shouldLoadEntity?: boolean;
749
- }[];
750
- /**
751
- * Journey Template
752
- * example:
753
- * Sales template (Premium)
754
- */
755
- journey_type?: string;
756
- /**
757
- * If true, journey is displayed in read-only mode
758
- */
759
- protected?: boolean;
760
- settings?: {
761
- embedOptions?: {
762
- mode?: "full-screen" | "inline";
763
- lang?: "de" | "en" | "fr";
764
- width?: string;
765
- topBar?: boolean;
766
- scrollToTop?: boolean;
767
- button?: {
768
- text?: string | null;
769
- align?: "left" | "center" | "right";
770
- };
771
- };
772
- safeModeAutomation?: boolean;
773
- designId?: string;
774
- entityId?: string | null;
775
- mappingsAutomationId?: string;
776
- templateId?: string;
777
- targetedCustomer?: string;
778
- description?: string | null;
779
- publicToken?: string | null;
780
- runtimeEntities?: ("ORDER" | "OPPORTUNITY")[];
781
- filePurposes?: string[];
782
- entityTags?: string[];
783
- /**
784
- * @deprecated Use addressSuggestionsFileId instead
785
- */
786
- addressSuggestionsFileUrl?: string | null;
787
- addressSuggestionsFileId?: string | null;
788
- /**
789
- * Country code for address format (e.g. DE, AT, CH, LU)
790
- */
791
- addressSuggestionsCountryCode?: string | null;
792
- /**
793
- * Whether address auto-complete is enabled
794
- */
795
- addressSuggestionsEnableAutoComplete?: boolean;
796
- /**
797
- * Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
798
- */
799
- addressSuggestionsSource?: string[];
800
- /**
801
- * Whether free text input is allowed when auto-complete is on
802
- */
803
- addressSuggestionsEnableFreeText?: boolean;
804
- /**
805
- * This property is deprecated and will be removed in a future version
806
- */
807
- useNewDesign?: boolean;
808
- /**
809
- * If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
810
- */
811
- thirdPartyCookies?: boolean;
812
- accessMode?: "PUBLIC" | "PRIVATE";
813
- /**
814
- * If true, the journey shows an icon to toggle dark mode
815
- */
816
- enableDarkMode?: boolean;
817
- };
818
- validationRules?: /**
819
- * References to validation rules organized by blocks and fields.
820
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
821
- *
822
- * example:
823
- * {
824
- * "block1": "rule123",
825
- * "block2": {
826
- * "field1": "rule456",
827
- * "field2": "rule789"
828
- * }
829
- * }
830
- */
831
- ValidationRuleRef;
832
- /**
833
- * Manifest/Blueprint ID used to create/update the entity
834
- */
835
- _manifest?: string /* uuid */[];
836
- }
837
- export interface JourneyFeatureFlags {
838
- featureFlags?: {
839
- [name: string]: any;
840
- };
841
- }
842
- export type JourneyProductsResponse = {
843
- type?: string;
844
- _schema?: string;
845
- _title?: string;
846
- name?: string;
847
- _id?: string;
848
- _org?: string;
849
- code?: string;
850
- description?: string;
851
- feature?: any[];
852
- product_images?: any[];
853
- legal_footnote?: string;
854
- product_downloads?: any[];
855
- price?: {
856
- [key: string]: any;
857
- };
858
- }[];
859
- export interface JourneyResponse {
860
- createdJourney?: Journey;
861
- }
862
- export interface JourneyValidationError {
863
- /**
864
- * Error type identifier
865
- * example:
866
- * ValidationError
867
- */
868
- error: string;
869
- /**
870
- * High-level error message
871
- * example:
872
- * Journey configuration validation failed
873
- */
874
- message: string;
875
- /**
876
- * Detailed validation errors for each pattern that failed
877
- */
878
- details: {
879
- /**
880
- * Validation pattern that failed
881
- */
882
- pattern?: string;
883
- severity?: "critical" | "high" | "medium" | "low";
884
- /**
885
- * Detailed error message
886
- */
887
- message?: string;
888
- /**
889
- * Number of issues found
890
- */
891
- count?: number;
892
- }[];
893
- }
894
- export interface JourneyValidationResponse {
895
- /**
896
- * Whether the journey configuration is valid
897
- */
898
- valid: boolean;
899
- /**
900
- * List of detected validation errors
901
- */
902
- errors: {
903
- /**
904
- * Pattern type (e.g. PatternA_DotsInStepId)
905
- */
906
- type?: string;
907
- severity?: "critical" | "high" | "medium" | "low";
908
- message?: string;
909
- affectedStepIds?: string[];
910
- count?: number;
911
- autoFix?: {
912
- feasible?: boolean;
913
- confidence?: "high" | "medium" | "low";
914
- reason?: string;
915
- details?: string;
916
- };
917
- }[];
918
- /**
919
- * List of warnings (non-critical issues)
920
- */
921
- warnings?: {
922
- type?: string;
923
- message?: string;
924
- }[];
925
- }
926
- /**
927
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
928
- *
929
- */
930
- export interface PatchUpdateJourneyRequest {
931
- [name: string]: any;
932
- /**
933
- * example:
934
- * 509cdffe-424f-457a-95c2-9708c304ce77
935
- */
936
- journeyId: string; // uuid
937
- /**
938
- * If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
939
- */
940
- __lastModifiedAt?: string | null;
941
- }
942
- /**
943
- * Field-level rule references within a block.
944
- * Maps field names to rule IDs.
945
- *
946
- * example:
947
- * {
948
- * "firstName": "rule123",
949
- * "lastName": "rule456",
950
- * "email": "rule789"
951
- * }
952
- */
953
- export interface RuleRef {
954
- [name: string]: string;
955
- }
956
- export interface S3Reference {
957
- /**
958
- * example:
959
- * document-api-prod
960
- */
961
- bucket: string;
962
- /**
963
- * example:
964
- * uploads/my-template.pdf
965
- */
966
- key: string;
967
- }
968
- export interface SearchJourneysQueryRequest {
969
- /**
970
- * Lucene query syntax
971
- * See https://lucene.apache.org/core/2_9_4/queryparsersyntax.html ; https://www.elastic.co/guide/en/kibana/current/lucene-query.html
972
- *
973
- * example:
974
- * _tags:*Flex*
975
- */
976
- q?: string;
977
- /**
978
- * The offset of the first result to return.
979
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
980
- *
981
- * example:
982
- * 0
983
- */
984
- from?: number;
985
- /**
986
- * The maximum number of results to return.
987
- * See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-from-size.html
988
- *
989
- * example:
990
- * 25
991
- */
992
- size?: number;
993
- /**
994
- * The sort order. Follows Lucene syntax.
995
- *
996
- * example:
997
- * _created_at:desc
998
- */
999
- sort?: string;
1000
- }
1001
- export interface SearchJourneysResponse {
1002
- /**
1003
- * The total number of hits.
1004
- *
1005
- * example:
1006
- * 1
1007
- */
1008
- hits?: number;
1009
- /**
1010
- * The results.
1011
- *
1012
- */
1013
- results?: {
1014
- /**
1015
- * Journey Entity ID
1016
- * example:
1017
- * e0f8f8f8-f8f8-f8f8-f8f8-f8f8f8f8f8f8
1018
- */
1019
- _id?: string; // uuid
1020
- /**
1021
- * Entity Schema (journey always in this case)
1022
- * example:
1023
- * journey
1024
- */
1025
- _schema?: string;
1026
- /**
1027
- * Journey Entity Title
1028
- * example:
1029
- * Journey Entity Title
1030
- */
1031
- _title?: string;
1032
- /**
1033
- * Organization ID
1034
- * example:
1035
- * 739224
1036
- */
1037
- _org?: string;
1038
- /**
1039
- * example:
1040
- * 2020-01-01T00:00:00.000Z
1041
- */
1042
- _created_at?: string; // date-time
1043
- /**
1044
- * example:
1045
- * 2020-01-01T00:00:00.000Z
1046
- */
1047
- _updated_at?: string; // date-time
1048
- _tags?: string[];
1049
- /**
1050
- * Manifest ID used to create/update the entity
1051
- */
1052
- _manifest?: string /* uuid */[];
1053
- /**
1054
- * Journey Name
1055
- * example:
1056
- * Journey Name
1057
- */
1058
- journey_name?: string;
1059
- /**
1060
- * Journey config ID
1061
- * example:
1062
- * de7df470-253e-11ed-9174-116b8a718c0a
1063
- */
1064
- journey_id?: string; // uuid
1065
- /**
1066
- * Journey Template
1067
- * example:
1068
- * Sales template
1069
- */
1070
- journey_type?: string;
1071
- /**
1072
- * Journey Design Name
1073
- * example:
1074
- * Design EPILOT
1075
- */
1076
- design?: string;
1077
- created_by?: {
1078
- /**
1079
- * User ID
1080
- * example:
1081
- * 12345
1082
- */
1083
- id?: string;
1084
- }[];
1085
- /**
1086
- * Journey Version
1087
- */
1088
- journey_version?: "Flex";
1089
- }[];
1090
- }
1091
- /**
1092
- * Template Settings for document generation
1093
- */
1094
- export interface TemplateSettings {
1095
- /**
1096
- * Custom margins for the document
1097
- */
1098
- custom_margins?: {
1099
- /**
1100
- * Top margin in cm
1101
- * example:
1102
- * 2.54
1103
- */
1104
- top?: number;
1105
- /**
1106
- * Bottom margin in cm
1107
- * example:
1108
- * 2.54
1109
- */
1110
- bottom?: number;
1111
- };
1112
- /**
1113
- * Suggested margins for the document
1114
- */
1115
- suggested_margins?: {
1116
- /**
1117
- * Top margin in cm
1118
- * example:
1119
- * 2.54
1120
- */
1121
- top?: number;
1122
- /**
1123
- * Bottom margin in cm
1124
- * example:
1125
- * 2.54
1126
- */
1127
- bottom?: number;
1128
- };
1129
- /**
1130
- * Display margin guidelines (applicable to partial generation only)
1131
- * example:
1132
- * true
1133
- */
1134
- display_margin_guidelines?: boolean;
1135
- /**
1136
- * Enable data table margin autofix
1137
- * example:
1138
- * false
1139
- */
1140
- enable_data_table_margin_autofix?: boolean;
1141
- /**
1142
- * A flag that indicates whether the template has 1 or more data tables in it
1143
- * example:
1144
- * false
1145
- */
1146
- template_with_datatable?: boolean;
1147
- /**
1148
- * Enables the persistance of template settings
1149
- * example:
1150
- * false
1151
- */
1152
- enabled_template_settings_persistence?: boolean;
1153
- /**
1154
- * An indication that the page margins are misconfigured
1155
- * example:
1156
- * false
1157
- */
1158
- misconfigured_margins?: boolean;
1159
- /**
1160
- * The file entity id, used when persisting a new template version with updated settings
1161
- * example:
1162
- * 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
1163
- */
1164
- file_entity_id?: string; // uuid
1165
- }
1166
- /**
1167
- * References to validation rules organized by blocks and fields.
1168
- * Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).
1169
- *
1170
- * example:
1171
- * {
1172
- * "block1": "rule123",
1173
- * "block2": {
1174
- * "field1": "rule456",
1175
- * "field2": "rule789"
1176
- * }
1177
- * }
1178
- */
1179
- export interface ValidationRuleRef {
1180
- [name: string]: string | /**
1181
- * Field-level rule references within a block.
1182
- * Maps field names to rule IDs.
1183
- *
1184
- * example:
1185
- * {
1186
- * "firstName": "rule123",
1187
- * "lastName": "rule456",
1188
- * "email": "rule789"
1189
- * }
1190
- */
1191
- RuleRef;
1192
- }
1193
- }
1194
- }
1195
- declare namespace Paths {
1196
- namespace CreateJourney {
1197
- namespace Parameters {
1198
- /**
1199
- * example:
1200
- * true
1201
- */
1202
- export type SkipAutomation = string; // Yn
1203
- }
1204
- export interface QueryParameters {
1205
- skipAutomation?: /**
1206
- * example:
1207
- * true
1208
- */
1209
- Parameters.SkipAutomation /* Yn */;
1210
- }
1211
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
1212
- namespace Responses {
1213
- export type $201 = Components.Schemas.Journey;
1214
- export type $400 = Components.Schemas.JourneyValidationError;
1215
- }
1216
- }
1217
- namespace CreateJourneyV2 {
1218
- namespace Parameters {
1219
- /**
1220
- * example:
1221
- * true
1222
- */
1223
- export type SkipAutomation = string; // Yn
1224
- }
1225
- export interface QueryParameters {
1226
- skipAutomation?: /**
1227
- * example:
1228
- * true
1229
- */
1230
- Parameters.SkipAutomation /* Yn */;
1231
- }
1232
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
1233
- namespace Responses {
1234
- export type $201 = Components.Schemas.JourneyCreationRequestV2;
1235
- export type $400 = Components.Schemas.JourneyValidationError;
1236
- }
1237
- }
1238
- namespace GenerateDocument {
1239
- export type RequestBody = Components.Schemas.GenerateDocumentRequest;
1240
- namespace Responses {
1241
- export type $200 = Components.Schemas.GenerateDocumentResponse;
1242
- }
1243
- }
1244
- namespace GetButtonOptions {
1245
- namespace Parameters {
1246
- /**
1247
- * example:
1248
- * 535ef74a-dd66-4d01-94a9-725016e70d1c
1249
- */
1250
- export type FileId = string;
1251
- }
1252
- export interface QueryParameters {
1253
- fileId: /**
1254
- * example:
1255
- * 535ef74a-dd66-4d01-94a9-725016e70d1c
1256
- */
1257
- Parameters.FileId;
1258
- }
1259
- namespace Responses {
1260
- export type $200 = /* A single button option data */ Components.Schemas.ButtonOption[];
1261
- export interface $400 {
1262
- /**
1263
- * example:
1264
- * UTF-8 encoding error while processing CSV content
1265
- */
1266
- message?: string;
1267
- /**
1268
- * example:
1269
- * Please ensure your CSV file is properly encoded in UTF-8 format
1270
- */
1271
- details?: string;
1272
- }
1273
- export interface $404 {
1274
- /**
1275
- * example:
1276
- * File with ID 535ef74a-dd66-4d01-94a9-725016e70d1c not found.
1277
- */
1278
- message?: string;
1279
- }
1280
- export interface $500 {
1281
- /**
1282
- * example:
1283
- * Unknown API Error
1284
- */
1285
- message?: string;
1286
- }
1287
- }
1288
- }
1289
- namespace GetJourney {
1290
- namespace Parameters {
1291
- /**
1292
- * example:
1293
- * 509cdffe-424f-457a-95c2-9708c304ce77
1294
- */
1295
- export type Id = string; // uuid
1296
- export type OrgId = string;
1297
- export type Source = string;
1298
- }
1299
- export interface PathParameters {
1300
- id: /**
1301
- * example:
1302
- * 509cdffe-424f-457a-95c2-9708c304ce77
1303
- */
1304
- Parameters.Id /* uuid */;
1305
- }
1306
- export interface QueryParameters {
1307
- source?: Parameters.Source;
1308
- orgId?: Parameters.OrgId;
1309
- }
1310
- namespace Responses {
1311
- export type $200 = Components.Schemas.Journey;
1312
- }
1313
- }
1314
- namespace GetJourneyProducts {
1315
- namespace Parameters {
1316
- export type City = string;
1317
- /**
1318
- * example:
1319
- * 509cdffe-424f-457a-95c2-9708c304ce77
1320
- */
1321
- export type Id = string; // uuid
1322
- export type PostalCode = string;
1323
- export type Source = string;
1324
- export type Street = string;
1325
- export type StreetNumber = string;
1326
- }
1327
- export interface PathParameters {
1328
- id: /**
1329
- * example:
1330
- * 509cdffe-424f-457a-95c2-9708c304ce77
1331
- */
1332
- Parameters.Id /* uuid */;
1333
- }
1334
- export interface QueryParameters {
1335
- source?: Parameters.Source;
1336
- postal_code?: Parameters.PostalCode;
1337
- city?: Parameters.City;
1338
- street?: Parameters.Street;
1339
- street_number?: Parameters.StreetNumber;
1340
- }
1341
- namespace Responses {
1342
- export type $200 = Components.Schemas.JourneyProductsResponse;
1343
- }
1344
- }
1345
- namespace GetJourneyV2 {
1346
- namespace Parameters {
1347
- /**
1348
- * example:
1349
- * 509cdffe-424f-457a-95c2-9708c304ce77
1350
- */
1351
- export type Id = string; // uuid
1352
- }
1353
- export interface PathParameters {
1354
- id: /**
1355
- * example:
1356
- * 509cdffe-424f-457a-95c2-9708c304ce77
1357
- */
1358
- Parameters.Id /* uuid */;
1359
- }
1360
- namespace Responses {
1361
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1362
- }
1363
- }
1364
- namespace GetJourneysByOrgId {
1365
- namespace Parameters {
1366
- /**
1367
- * example:
1368
- * true
1369
- */
1370
- export type Hydrate = string;
1371
- /**
1372
- * example:
1373
- * 123
1374
- */
1375
- export type Id = string;
1376
- }
1377
- export interface PathParameters {
1378
- id: /**
1379
- * example:
1380
- * 123
1381
- */
1382
- Parameters.Id;
1383
- }
1384
- export interface QueryParameters {
1385
- hydrate?: /**
1386
- * example:
1387
- * true
1388
- */
1389
- Parameters.Hydrate;
1390
- }
1391
- namespace Responses {
1392
- export type $200 = Components.Schemas.GetJourneysResponse;
1393
- }
1394
- }
1395
- namespace GetSettingsForJourney {
1396
- namespace Parameters {
1397
- /**
1398
- * example:
1399
- * 509cdffe-424f-457a-95c2-9708c304ce77
1400
- */
1401
- export type Id = string; // uuid
1402
- }
1403
- export interface PathParameters {
1404
- id: /**
1405
- * example:
1406
- * 509cdffe-424f-457a-95c2-9708c304ce77
1407
- */
1408
- Parameters.Id /* uuid */;
1409
- }
1410
- namespace Responses {
1411
- export type $200 = Components.Schemas.GetSettingsForJourney;
1412
- export interface $404 {
1413
- /**
1414
- * example:
1415
- * journey not found
1416
- */
1417
- message?: string;
1418
- }
1419
- export interface $500 {
1420
- /**
1421
- * example:
1422
- * Unknown API Error
1423
- */
1424
- message?: string;
1425
- }
1426
- }
1427
- }
1428
- namespace PatchUpdateJourney {
1429
- export type RequestBody = /**
1430
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
1431
- *
1432
- */
1433
- Components.Schemas.PatchUpdateJourneyRequest;
1434
- namespace Responses {
1435
- export type $200 = Components.Schemas.JourneyResponse;
1436
- export type $400 = Components.Schemas.JourneyValidationError;
1437
- export interface $404 {
1438
- /**
1439
- * example:
1440
- * journey not found
1441
- */
1442
- message?: string;
1443
- }
1444
- }
1445
- }
1446
- namespace PatchUpdateJourneyV2 {
1447
- export type RequestBody = /**
1448
- * Patch request to update a journey (journey id is required) Support for nested properties (e.g. steps[0].uischema.elements[0].products) is supported.
1449
- *
1450
- */
1451
- Components.Schemas.PatchUpdateJourneyRequest;
1452
- namespace Responses {
1453
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1454
- export type $400 = Components.Schemas.JourneyValidationError;
1455
- export interface $404 {
1456
- /**
1457
- * example:
1458
- * journey not found
1459
- */
1460
- message?: string;
1461
- }
1462
- }
1463
- }
1464
- namespace RemoveJourney {
1465
- namespace Parameters {
1466
- /**
1467
- * example:
1468
- * 509cdffe-424f-457a-95c2-9708c304ce77
1469
- */
1470
- export type Id = string; // uuid
1471
- }
1472
- export interface PathParameters {
1473
- id: /**
1474
- * example:
1475
- * 509cdffe-424f-457a-95c2-9708c304ce77
1476
- */
1477
- Parameters.Id /* uuid */;
1478
- }
1479
- namespace Responses {
1480
- export interface $404 {
1481
- /**
1482
- * example:
1483
- * journey not found
1484
- */
1485
- message?: string;
1486
- }
1487
- }
1488
- }
1489
- namespace RemoveJourneyV2 {
1490
- namespace Parameters {
1491
- /**
1492
- * example:
1493
- * 509cdffe-424f-457a-95c2-9708c304ce77
1494
- */
1495
- export type Id = string; // uuid
1496
- }
1497
- export interface PathParameters {
1498
- id: /**
1499
- * example:
1500
- * 509cdffe-424f-457a-95c2-9708c304ce77
1501
- */
1502
- Parameters.Id /* uuid */;
1503
- }
1504
- }
1505
- namespace SearchJourneys {
1506
- export type RequestBody = Components.Schemas.SearchJourneysQueryRequest;
1507
- namespace Responses {
1508
- export type $200 = Components.Schemas.SearchJourneysResponse;
1509
- }
1510
- }
1511
- namespace UpdateJourney {
1512
- export type RequestBody = Components.Schemas.JourneyCreationRequest;
1513
- namespace Responses {
1514
- export interface $204 {
1515
- }
1516
- export type $400 = Components.Schemas.JourneyValidationError;
1517
- export interface $409 {
1518
- }
1519
- }
1520
- }
1521
- namespace UpdateJourneyV2 {
1522
- export type RequestBody = Components.Schemas.JourneyCreationRequestV2;
1523
- namespace Responses {
1524
- export type $200 = Components.Schemas.JourneyCreationRequestV2;
1525
- export type $400 = Components.Schemas.JourneyValidationError;
1526
- export interface $404 {
1527
- /**
1528
- * example:
1529
- * journey not found
1530
- */
1531
- message?: string;
1532
- }
1533
- }
1534
- }
1535
- }
1536
-
1537
-
1538
- interface OperationMethods {
1539
- /**
1540
- * getJourneysByOrgId - getJourneysByOrgId
1541
- *
1542
- * Get all journeys by organization id
1543
- */
1544
- 'getJourneysByOrgId'(
1545
- parameters?: Parameters<Paths.GetJourneysByOrgId.QueryParameters & Paths.GetJourneysByOrgId.PathParameters> | null,
1546
- data?: any,
1547
- config?: AxiosRequestConfig
1548
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
1549
- /**
1550
- * getJourney - getJourney
1551
- *
1552
- * Get journey by id. Private journeys requires valid private token to be passed
1553
- */
1554
- 'getJourney'(
1555
- parameters?: Parameters<Paths.GetJourney.QueryParameters & Paths.GetJourney.PathParameters> | null,
1556
- data?: any,
1557
- config?: AxiosRequestConfig
1558
- ): OperationResponse<Paths.GetJourney.Responses.$200>
1559
- /**
1560
- * removeJourney - removeJourney
1561
- *
1562
- * Remove journey by id
1563
- */
1564
- 'removeJourney'(
1565
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
1566
- data?: any,
1567
- config?: AxiosRequestConfig
1568
- ): OperationResponse<any>
1569
- /**
1570
- * getJourneyProducts - getJourneyProducts
1571
- *
1572
- * Get products available in the journey by id. requires public journey token to be passed.
1573
- */
1574
- 'getJourneyProducts'(
1575
- parameters?: Parameters<Paths.GetJourneyProducts.QueryParameters & Paths.GetJourneyProducts.PathParameters> | null,
1576
- data?: any,
1577
- config?: AxiosRequestConfig
1578
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
1579
- /**
1580
- * updateJourney - updateJourney
1581
- *
1582
- * Update a Journey
1583
- */
1584
- 'updateJourney'(
1585
- parameters?: Parameters<UnknownParamsObject> | null,
1586
- data?: Paths.UpdateJourney.RequestBody,
1587
- config?: AxiosRequestConfig
1588
- ): OperationResponse<Paths.UpdateJourney.Responses.$204>
1589
- /**
1590
- * createJourney - createJourney
1591
- *
1592
- * Create a Journey
1593
- */
1594
- 'createJourney'(
1595
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
1596
- data?: Paths.CreateJourney.RequestBody,
1597
- config?: AxiosRequestConfig
1598
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
1599
- /**
1600
- * patchUpdateJourney - patchUpdateJourney
1601
- *
1602
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1603
- */
1604
- 'patchUpdateJourney'(
1605
- parameters?: Parameters<UnknownParamsObject> | null,
1606
- data?: Paths.PatchUpdateJourney.RequestBody,
1607
- config?: AxiosRequestConfig
1608
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1609
- /**
1610
- * searchJourneys - searchJourneys
1611
- *
1612
- * Search Journeys
1613
- */
1614
- 'searchJourneys'(
1615
- parameters?: Parameters<UnknownParamsObject> | null,
1616
- data?: Paths.SearchJourneys.RequestBody,
1617
- config?: AxiosRequestConfig
1618
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1619
- /**
1620
- * generateDocument - generateDocument
1621
- *
1622
- * Builds document generated from a template with journey values."
1623
- *
1624
- * Supported input document types:
1625
- * - .docx
1626
- *
1627
- * Supported output document types:
1628
- * - .pdf
1629
- * - .docx but limited to only text based variables
1630
- *
1631
- * Uses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.
1632
- * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
1633
- *
1634
- */
1635
- 'generateDocument'(
1636
- parameters?: Parameters<UnknownParamsObject> | null,
1637
- data?: Paths.GenerateDocument.RequestBody,
1638
- config?: AxiosRequestConfig
1639
- ): OperationResponse<Paths.GenerateDocument.Responses.$200>
1640
- /**
1641
- * updateJourneyV2 - updateJourneyV2
1642
- *
1643
- * Update a Journey
1644
- */
1645
- 'updateJourneyV2'(
1646
- parameters?: Parameters<UnknownParamsObject> | null,
1647
- data?: Paths.UpdateJourneyV2.RequestBody,
1648
- config?: AxiosRequestConfig
1649
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
1650
- /**
1651
- * createJourneyV2 - createJourneyV2
1652
- *
1653
- * Create a Journey
1654
- */
1655
- 'createJourneyV2'(
1656
- parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
1657
- data?: Paths.CreateJourneyV2.RequestBody,
1658
- config?: AxiosRequestConfig
1659
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
1660
- /**
1661
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
1662
- *
1663
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1664
- */
1665
- 'patchUpdateJourneyV2'(
1666
- parameters?: Parameters<UnknownParamsObject> | null,
1667
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
1668
- config?: AxiosRequestConfig
1669
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
1670
- /**
1671
- * getJourneyV2 - getJourneyV2
1672
- *
1673
- * Get journey by id
1674
- */
1675
- 'getJourneyV2'(
1676
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
1677
- data?: any,
1678
- config?: AxiosRequestConfig
1679
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
1680
- /**
1681
- * removeJourneyV2 - removeJourneyV2
1682
- *
1683
- * Remove journey by id
1684
- */
1685
- 'removeJourneyV2'(
1686
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
1687
- data?: any,
1688
- config?: AxiosRequestConfig
1689
- ): OperationResponse<any>
1690
- /**
1691
- * getSettingsForJourney - getSettingsForJourney
1692
- *
1693
- * Get settings related to the journey using journey ID.
1694
- */
1695
- 'getSettingsForJourney'(
1696
- parameters?: Parameters<Paths.GetSettingsForJourney.PathParameters> | null,
1697
- data?: any,
1698
- config?: AxiosRequestConfig
1699
- ): OperationResponse<Paths.GetSettingsForJourney.Responses.$200>
1700
- /**
1701
- * getButtonOptions - getButtonOptions
1702
- *
1703
- * Get button options from a csv file.
1704
- */
1705
- 'getButtonOptions'(
1706
- parameters?: Parameters<Paths.GetButtonOptions.QueryParameters> | null,
1707
- data?: any,
1708
- config?: AxiosRequestConfig
1709
- ): OperationResponse<Paths.GetButtonOptions.Responses.$200>
1710
- }
1711
-
1712
- interface PathsDictionary {
1713
- ['/v1/journey/organization/{id}']: {
1714
- /**
1715
- * getJourneysByOrgId - getJourneysByOrgId
1716
- *
1717
- * Get all journeys by organization id
1718
- */
1719
- 'get'(
1720
- parameters?: Parameters<Paths.GetJourneysByOrgId.QueryParameters & Paths.GetJourneysByOrgId.PathParameters> | null,
1721
- data?: any,
1722
- config?: AxiosRequestConfig
1723
- ): OperationResponse<Paths.GetJourneysByOrgId.Responses.$200>
1724
- }
1725
- ['/v1/journey/configuration/{id}']: {
1726
- /**
1727
- * getJourney - getJourney
1728
- *
1729
- * Get journey by id. Private journeys requires valid private token to be passed
1730
- */
1731
- 'get'(
1732
- parameters?: Parameters<Paths.GetJourney.QueryParameters & Paths.GetJourney.PathParameters> | null,
1733
- data?: any,
1734
- config?: AxiosRequestConfig
1735
- ): OperationResponse<Paths.GetJourney.Responses.$200>
1736
- /**
1737
- * removeJourney - removeJourney
1738
- *
1739
- * Remove journey by id
1740
- */
1741
- 'delete'(
1742
- parameters?: Parameters<Paths.RemoveJourney.PathParameters> | null,
1743
- data?: any,
1744
- config?: AxiosRequestConfig
1745
- ): OperationResponse<any>
1746
- }
1747
- ['/v1/journey/products/{id}']: {
1748
- /**
1749
- * getJourneyProducts - getJourneyProducts
1750
- *
1751
- * Get products available in the journey by id. requires public journey token to be passed.
1752
- */
1753
- 'get'(
1754
- parameters?: Parameters<Paths.GetJourneyProducts.QueryParameters & Paths.GetJourneyProducts.PathParameters> | null,
1755
- data?: any,
1756
- config?: AxiosRequestConfig
1757
- ): OperationResponse<Paths.GetJourneyProducts.Responses.$200>
1758
- }
1759
- ['/v1/journey/configuration']: {
1760
- /**
1761
- * createJourney - createJourney
1762
- *
1763
- * Create a Journey
1764
- */
1765
- 'post'(
1766
- parameters?: Parameters<Paths.CreateJourney.QueryParameters> | null,
1767
- data?: Paths.CreateJourney.RequestBody,
1768
- config?: AxiosRequestConfig
1769
- ): OperationResponse<Paths.CreateJourney.Responses.$201>
1770
- /**
1771
- * updateJourney - updateJourney
1772
- *
1773
- * Update a Journey
1774
- */
1775
- 'put'(
1776
- parameters?: Parameters<UnknownParamsObject> | null,
1777
- data?: Paths.UpdateJourney.RequestBody,
1778
- config?: AxiosRequestConfig
1779
- ): OperationResponse<Paths.UpdateJourney.Responses.$204>
1780
- /**
1781
- * patchUpdateJourney - patchUpdateJourney
1782
- *
1783
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1784
- */
1785
- 'patch'(
1786
- parameters?: Parameters<UnknownParamsObject> | null,
1787
- data?: Paths.PatchUpdateJourney.RequestBody,
1788
- config?: AxiosRequestConfig
1789
- ): OperationResponse<Paths.PatchUpdateJourney.Responses.$200>
1790
- }
1791
- ['/v1/journey/configuration/search']: {
1792
- /**
1793
- * searchJourneys - searchJourneys
1794
- *
1795
- * Search Journeys
1796
- */
1797
- 'post'(
1798
- parameters?: Parameters<UnknownParamsObject> | null,
1799
- data?: Paths.SearchJourneys.RequestBody,
1800
- config?: AxiosRequestConfig
1801
- ): OperationResponse<Paths.SearchJourneys.Responses.$200>
1802
- }
1803
- ['/v1/journey/document:generate']: {
1804
- /**
1805
- * generateDocument - generateDocument
1806
- *
1807
- * Builds document generated from a template with journey values."
1808
- *
1809
- * Supported input document types:
1810
- * - .docx
1811
- *
1812
- * Supported output document types:
1813
- * - .pdf
1814
- * - .docx but limited to only text based variables
1815
- *
1816
- * Uses [Document API](https://gitlab.com/e-pilot/product/file-management/document-api) to generate the document.
1817
- * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the document.
1818
- *
1819
- */
1820
- 'post'(
1821
- parameters?: Parameters<UnknownParamsObject> | null,
1822
- data?: Paths.GenerateDocument.RequestBody,
1823
- config?: AxiosRequestConfig
1824
- ): OperationResponse<Paths.GenerateDocument.Responses.$200>
1825
- }
1826
- ['/v2/journey/configuration']: {
1827
- /**
1828
- * createJourneyV2 - createJourneyV2
1829
- *
1830
- * Create a Journey
1831
- */
1832
- 'post'(
1833
- parameters?: Parameters<Paths.CreateJourneyV2.QueryParameters> | null,
1834
- data?: Paths.CreateJourneyV2.RequestBody,
1835
- config?: AxiosRequestConfig
1836
- ): OperationResponse<Paths.CreateJourneyV2.Responses.$201>
1837
- /**
1838
- * updateJourneyV2 - updateJourneyV2
1839
- *
1840
- * Update a Journey
1841
- */
1842
- 'put'(
1843
- parameters?: Parameters<UnknownParamsObject> | null,
1844
- data?: Paths.UpdateJourneyV2.RequestBody,
1845
- config?: AxiosRequestConfig
1846
- ): OperationResponse<Paths.UpdateJourneyV2.Responses.$200>
1847
- /**
1848
- * patchUpdateJourneyV2 - patchUpdateJourneyV2
1849
- *
1850
- * Update a Journey (partially / patch). Support for nested properties updates (e.g. "property[0].name").
1851
- */
1852
- 'patch'(
1853
- parameters?: Parameters<UnknownParamsObject> | null,
1854
- data?: Paths.PatchUpdateJourneyV2.RequestBody,
1855
- config?: AxiosRequestConfig
1856
- ): OperationResponse<Paths.PatchUpdateJourneyV2.Responses.$200>
1857
- }
1858
- ['/v2/journey/configuration/{id}']: {
1859
- /**
1860
- * getJourneyV2 - getJourneyV2
1861
- *
1862
- * Get journey by id
1863
- */
1864
- 'get'(
1865
- parameters?: Parameters<Paths.GetJourneyV2.PathParameters> | null,
1866
- data?: any,
1867
- config?: AxiosRequestConfig
1868
- ): OperationResponse<Paths.GetJourneyV2.Responses.$200>
1869
- /**
1870
- * removeJourneyV2 - removeJourneyV2
1871
- *
1872
- * Remove journey by id
1873
- */
1874
- 'delete'(
1875
- parameters?: Parameters<Paths.RemoveJourneyV2.PathParameters> | null,
1876
- data?: any,
1877
- config?: AxiosRequestConfig
1878
- ): OperationResponse<any>
1879
- }
1880
- ['/v1/journey/{id}/settings']: {
1881
- /**
1882
- * getSettingsForJourney - getSettingsForJourney
1883
- *
1884
- * Get settings related to the journey using journey ID.
1885
- */
1886
- 'get'(
1887
- parameters?: Parameters<Paths.GetSettingsForJourney.PathParameters> | null,
1888
- data?: any,
1889
- config?: AxiosRequestConfig
1890
- ): OperationResponse<Paths.GetSettingsForJourney.Responses.$200>
1891
- }
1892
- ['/v1/journey/button-options']: {
1893
- /**
1894
- * getButtonOptions - getButtonOptions
1895
- *
1896
- * Get button options from a csv file.
1897
- */
1898
- 'get'(
1899
- parameters?: Parameters<Paths.GetButtonOptions.QueryParameters> | null,
1900
- data?: any,
1901
- config?: AxiosRequestConfig
1902
- ): OperationResponse<Paths.GetButtonOptions.Responses.$200>
1903
- }
1904
- }
1905
-
1906
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1907
-
1908
-
1909
- type ButtonOption = Components.Schemas.ButtonOption;
1910
- type GenerateDocumentRequest = Components.Schemas.GenerateDocumentRequest;
1911
- type GenerateDocumentResponse = Components.Schemas.GenerateDocumentResponse;
1912
- type GetJourneysResponse = Components.Schemas.GetJourneysResponse;
1913
- type GetSettingsForJourney = Components.Schemas.GetSettingsForJourney;
1914
- type Journey = Components.Schemas.Journey;
1915
- type JourneyAuditInfo = Components.Schemas.JourneyAuditInfo;
1916
- type JourneyCreationRequest = Components.Schemas.JourneyCreationRequest;
1917
- type JourneyCreationRequestV2 = Components.Schemas.JourneyCreationRequestV2;
1918
- type JourneyFeatureFlags = Components.Schemas.JourneyFeatureFlags;
1919
- type JourneyProductsResponse = Components.Schemas.JourneyProductsResponse;
1920
- type JourneyResponse = Components.Schemas.JourneyResponse;
1921
- type JourneyValidationError = Components.Schemas.JourneyValidationError;
1922
- type JourneyValidationResponse = Components.Schemas.JourneyValidationResponse;
1923
- type PatchUpdateJourneyRequest = Components.Schemas.PatchUpdateJourneyRequest;
1924
- type RuleRef = Components.Schemas.RuleRef;
1925
- type S3Reference = Components.Schemas.S3Reference;
1926
- type SearchJourneysQueryRequest = Components.Schemas.SearchJourneysQueryRequest;
1927
- type SearchJourneysResponse = Components.Schemas.SearchJourneysResponse;
1928
- type TemplateSettings = Components.Schemas.TemplateSettings;
1929
- type ValidationRuleRef = Components.Schemas.ValidationRuleRef;
1930
-
1931
- export { type ButtonOption as B, type Client as C, type GenerateDocumentRequest as G, type Journey as J, type OperationMethods as O, Paths as P, type RuleRef as R, type S3Reference as S, type TemplateSettings as T, type ValidationRuleRef as V, Components as a, type PathsDictionary as b, type GenerateDocumentResponse as c, type GetJourneysResponse as d, GetSettingsForJourney as e, type JourneyAuditInfo as f, type JourneyCreationRequest as g, type JourneyCreationRequestV2 as h, type JourneyFeatureFlags as i, type JourneyProductsResponse as j, type JourneyResponse as k, type JourneyValidationError as l, type JourneyValidationResponse as m, type PatchUpdateJourneyRequest as n, type SearchJourneysQueryRequest as o, type SearchJourneysResponse as p };