@epilot/sdk 2.4.2 → 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 (364) 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/automation.json +42 -0
  5. package/definitions/calendar-runtime.json +1 -0
  6. package/definitions/calendar.json +675 -0
  7. package/definitions/customer-portal.json +29 -0
  8. package/definitions/notes.json +175 -130
  9. package/definitions/pricing-runtime.json +1 -1
  10. package/definitions/pricing.json +163 -84
  11. package/dist/README-46VYEGGW.js +7 -0
  12. package/dist/README-IVBISSWB.cjs +7 -0
  13. package/dist/{_index-HE4B6FOA.js → _index-5FB6F5YY.js} +3 -0
  14. package/dist/{_index-55HAH24D.cjs → _index-DB2VV4PQ.cjs} +4 -1
  15. package/dist/apis/_registry.d.ts +8 -0
  16. package/dist/apis/access-token.cjs +6 -6
  17. package/dist/apis/access-token.d.ts +9 -12
  18. package/dist/apis/access-token.js +1 -1
  19. package/dist/apis/address-suggestions.cjs +6 -6
  20. package/dist/apis/address-suggestions.d.ts +9 -12
  21. package/dist/apis/address-suggestions.js +1 -1
  22. package/dist/apis/address.cjs +6 -6
  23. package/dist/apis/address.d.ts +9 -12
  24. package/dist/apis/address.js +1 -1
  25. package/dist/apis/ai-agents.cjs +6 -6
  26. package/dist/apis/ai-agents.d.ts +9 -12
  27. package/dist/apis/ai-agents.js +1 -1
  28. package/dist/apis/app.cjs +6 -6
  29. package/dist/apis/app.d.ts +9 -12
  30. package/dist/apis/app.js +1 -1
  31. package/dist/apis/audit-logs.cjs +6 -6
  32. package/dist/apis/audit-logs.d.ts +9 -12
  33. package/dist/apis/audit-logs.js +1 -1
  34. package/dist/apis/automation.cjs +6 -6
  35. package/dist/apis/automation.d.ts +9 -12
  36. package/dist/apis/automation.js +1 -1
  37. package/dist/apis/billing.cjs +6 -6
  38. package/dist/apis/billing.d.ts +9 -12
  39. package/dist/apis/billing.js +1 -1
  40. package/dist/apis/blueprint-manifest.cjs +6 -6
  41. package/dist/apis/blueprint-manifest.d.ts +9 -12
  42. package/dist/apis/blueprint-manifest.js +1 -1
  43. package/dist/apis/calendar.cjs +38 -0
  44. package/dist/apis/calendar.d.ts +15 -0
  45. package/dist/apis/calendar.js +38 -0
  46. package/dist/apis/configuration-hub.cjs +6 -6
  47. package/dist/apis/configuration-hub.d.ts +9 -12
  48. package/dist/apis/configuration-hub.js +1 -1
  49. package/dist/apis/consent.cjs +6 -6
  50. package/dist/apis/consent.d.ts +9 -12
  51. package/dist/apis/consent.js +1 -1
  52. package/dist/apis/customer-portal.cjs +6 -6
  53. package/dist/apis/customer-portal.d.ts +9 -12
  54. package/dist/apis/customer-portal.js +1 -1
  55. package/dist/apis/dashboard.cjs +6 -6
  56. package/dist/apis/dashboard.d.ts +9 -12
  57. package/dist/apis/dashboard.js +1 -1
  58. package/dist/apis/data-governance.cjs +6 -6
  59. package/dist/apis/data-governance.d.ts +9 -12
  60. package/dist/apis/data-governance.js +1 -1
  61. package/dist/apis/deduplication.cjs +6 -6
  62. package/dist/apis/deduplication.d.ts +9 -12
  63. package/dist/apis/deduplication.js +1 -1
  64. package/dist/apis/design.cjs +6 -6
  65. package/dist/apis/design.d.ts +9 -12
  66. package/dist/apis/design.js +1 -1
  67. package/dist/apis/document.cjs +6 -6
  68. package/dist/apis/document.d.ts +9 -12
  69. package/dist/apis/document.js +1 -1
  70. package/dist/apis/email-settings.cjs +6 -6
  71. package/dist/apis/email-settings.d.ts +9 -12
  72. package/dist/apis/email-settings.js +1 -1
  73. package/dist/apis/email-template.cjs +6 -6
  74. package/dist/apis/email-template.d.ts +9 -12
  75. package/dist/apis/email-template.js +1 -1
  76. package/dist/apis/entity-mapping.cjs +6 -6
  77. package/dist/apis/entity-mapping.d.ts +9 -12
  78. package/dist/apis/entity-mapping.js +1 -1
  79. package/dist/apis/entity.cjs +6 -6
  80. package/dist/apis/entity.d.ts +9 -12
  81. package/dist/apis/entity.js +1 -1
  82. package/dist/apis/environments.cjs +6 -6
  83. package/dist/apis/environments.d.ts +9 -12
  84. package/dist/apis/environments.js +1 -1
  85. package/dist/apis/event-catalog.cjs +6 -6
  86. package/dist/apis/event-catalog.d.ts +9 -12
  87. package/dist/apis/event-catalog.js +1 -1
  88. package/dist/apis/file.cjs +6 -6
  89. package/dist/apis/file.d.ts +9 -12
  90. package/dist/apis/file.js +1 -1
  91. package/dist/apis/iban.cjs +6 -6
  92. package/dist/apis/iban.d.ts +9 -12
  93. package/dist/apis/iban.js +1 -1
  94. package/dist/apis/integration-toolkit.cjs +6 -6
  95. package/dist/apis/integration-toolkit.d.ts +9 -12
  96. package/dist/apis/integration-toolkit.js +1 -1
  97. package/dist/apis/journey.cjs +6 -6
  98. package/dist/apis/journey.d.ts +9 -12
  99. package/dist/apis/journey.js +1 -1
  100. package/dist/apis/kanban.cjs +6 -6
  101. package/dist/apis/kanban.d.ts +9 -12
  102. package/dist/apis/kanban.js +1 -1
  103. package/dist/apis/message.cjs +6 -6
  104. package/dist/apis/message.d.ts +9 -12
  105. package/dist/apis/message.js +1 -1
  106. package/dist/apis/metering.cjs +6 -6
  107. package/dist/apis/metering.d.ts +9 -12
  108. package/dist/apis/metering.js +1 -1
  109. package/dist/apis/notes.cjs +6 -6
  110. package/dist/apis/notes.d.ts +9 -12
  111. package/dist/apis/notes.js +1 -1
  112. package/dist/apis/notification.cjs +6 -6
  113. package/dist/apis/notification.d.ts +9 -12
  114. package/dist/apis/notification.js +1 -1
  115. package/dist/apis/organization.cjs +6 -6
  116. package/dist/apis/organization.d.ts +9 -12
  117. package/dist/apis/organization.js +1 -1
  118. package/dist/apis/partner-directory.cjs +6 -6
  119. package/dist/apis/partner-directory.d.ts +9 -12
  120. package/dist/apis/partner-directory.js +1 -1
  121. package/dist/apis/permissions.cjs +6 -6
  122. package/dist/apis/permissions.d.ts +9 -12
  123. package/dist/apis/permissions.js +1 -1
  124. package/dist/apis/pricing-tier.cjs +6 -6
  125. package/dist/apis/pricing-tier.d.ts +9 -12
  126. package/dist/apis/pricing-tier.js +1 -1
  127. package/dist/apis/pricing.cjs +8 -8
  128. package/dist/apis/pricing.d.ts +9 -12
  129. package/dist/apis/pricing.js +2 -2
  130. package/dist/apis/purpose.cjs +6 -6
  131. package/dist/apis/purpose.d.ts +9 -12
  132. package/dist/apis/purpose.js +1 -1
  133. package/dist/apis/query.cjs +6 -6
  134. package/dist/apis/query.d.ts +9 -12
  135. package/dist/apis/query.js +1 -1
  136. package/dist/apis/sandbox.cjs +6 -6
  137. package/dist/apis/sandbox.d.ts +9 -12
  138. package/dist/apis/sandbox.js +1 -1
  139. package/dist/apis/sharing.cjs +6 -6
  140. package/dist/apis/sharing.d.ts +9 -12
  141. package/dist/apis/sharing.js +1 -1
  142. package/dist/apis/submission.cjs +6 -6
  143. package/dist/apis/submission.d.ts +9 -12
  144. package/dist/apis/submission.js +1 -1
  145. package/dist/apis/target.cjs +6 -6
  146. package/dist/apis/target.d.ts +9 -591
  147. package/dist/apis/target.js +1 -1
  148. package/dist/apis/targeting.cjs +6 -6
  149. package/dist/apis/targeting.d.ts +9 -12
  150. package/dist/apis/targeting.js +1 -1
  151. package/dist/apis/template-variables.cjs +6 -6
  152. package/dist/apis/template-variables.d.ts +9 -12
  153. package/dist/apis/template-variables.js +1 -1
  154. package/dist/apis/user.cjs +6 -6
  155. package/dist/apis/user.d.ts +9 -12
  156. package/dist/apis/user.js +1 -1
  157. package/dist/apis/validation-rules.cjs +6 -6
  158. package/dist/apis/validation-rules.d.ts +9 -12
  159. package/dist/apis/validation-rules.js +1 -1
  160. package/dist/apis/webhooks.cjs +6 -6
  161. package/dist/apis/webhooks.d.ts +9 -12
  162. package/dist/apis/webhooks.js +1 -1
  163. package/dist/apis/workflow-definition.cjs +6 -6
  164. package/dist/apis/workflow-definition.d.ts +9 -12
  165. package/dist/apis/workflow-definition.js +1 -1
  166. package/dist/apis/workflow.cjs +6 -6
  167. package/dist/apis/workflow.d.ts +9 -12
  168. package/dist/apis/workflow.js +1 -1
  169. package/dist/authorize.d.ts +3 -0
  170. package/dist/automation-BMO7ZFTN.cjs +7 -0
  171. package/dist/automation-MEZTSUR3.js +7 -0
  172. package/dist/bin/cli.d.ts +1 -0
  173. package/dist/bin/cli.js +1 -1
  174. package/dist/calendar-2YDAYG7S.cjs +7 -0
  175. package/dist/calendar-ACFIHQ2N.js +7 -0
  176. package/dist/calendar-runtime-6CMMEQMG.js +5 -0
  177. package/dist/calendar-runtime-G4SN5PDY.cjs +5 -0
  178. package/dist/{chunk-MEUS7LCE.js → chunk-63BFJKWV.js} +1 -1
  179. package/dist/{chunk-YLJD7G7H.cjs → chunk-CD4OX2U6.cjs} +7 -5
  180. package/dist/chunk-CKLEBO4K.cjs +14 -0
  181. package/dist/chunk-JNH37UUH.js +14 -0
  182. package/dist/{chunk-JXJC6WEW.cjs → chunk-KP7H52BF.cjs} +1 -1
  183. package/dist/{chunk-CQ3AKMIJ.js → chunk-TSV242UN.js} +7 -5
  184. package/dist/client-factory.d.ts +9 -0
  185. package/dist/client-map.d.ts +102 -0
  186. package/dist/compact.d.ts +22 -0
  187. package/dist/help.d.ts +12 -0
  188. package/dist/index.cjs +27 -19
  189. package/dist/index.d.ts +12 -180
  190. package/dist/index.js +22 -14
  191. package/dist/{js-yaml-DLCVPJ7G.js → js-yaml-UPZKYVRY.js} +15 -17
  192. package/dist/large-response.d.ts +9 -0
  193. package/dist/openapi.d.ts +12 -0
  194. package/dist/overrides.d.ts +9 -0
  195. package/dist/pricing-G67CH3XH.js +7 -0
  196. package/dist/pricing-XAET4G7T.cjs +7 -0
  197. package/dist/{pricing-runtime-JRR4FWFI.js → pricing-runtime-2YKEJJMZ.js} +1 -1
  198. package/dist/{pricing-runtime-6XNS4EOF.cjs → pricing-runtime-XDCOKL47.cjs} +2 -2
  199. package/dist/proxy.d.ts +14 -0
  200. package/dist/registry.d.ts +19 -0
  201. package/dist/retry.d.ts +11 -0
  202. package/dist/sdk.d.ts +29 -0
  203. package/dist/types.d.ts +53 -0
  204. package/docs/automation.md +42 -5
  205. package/docs/calendar.md +441 -0
  206. package/docs/pricing.md +39 -15
  207. package/package.json +10 -1
  208. package/dist/README-6MG272KM.cjs +0 -7
  209. package/dist/README-7N542PBL.js +0 -7
  210. package/dist/access-token.d-CnmUTOlq.d.cts +0 -552
  211. package/dist/access-token.d-CnmUTOlq.d.ts +0 -552
  212. package/dist/address-suggestions.d-_YwTOR-9.d.cts +0 -339
  213. package/dist/address-suggestions.d-_YwTOR-9.d.ts +0 -339
  214. package/dist/address.d-CwAPOVxa.d.cts +0 -437
  215. package/dist/address.d-CwAPOVxa.d.ts +0 -437
  216. package/dist/ai-agents.d-OkXfr2bz.d.cts +0 -1339
  217. package/dist/ai-agents.d-OkXfr2bz.d.ts +0 -1339
  218. package/dist/apis/access-token.d.cts +0 -18
  219. package/dist/apis/address-suggestions.d.cts +0 -18
  220. package/dist/apis/address.d.cts +0 -18
  221. package/dist/apis/ai-agents.d.cts +0 -18
  222. package/dist/apis/app.d.cts +0 -18
  223. package/dist/apis/audit-logs.d.cts +0 -18
  224. package/dist/apis/automation.d.cts +0 -18
  225. package/dist/apis/billing.d.cts +0 -18
  226. package/dist/apis/blueprint-manifest.d.cts +0 -18
  227. package/dist/apis/configuration-hub.d.cts +0 -18
  228. package/dist/apis/consent.d.cts +0 -18
  229. package/dist/apis/customer-portal.d.cts +0 -18
  230. package/dist/apis/dashboard.d.cts +0 -18
  231. package/dist/apis/data-governance.d.cts +0 -18
  232. package/dist/apis/deduplication.d.cts +0 -18
  233. package/dist/apis/design.d.cts +0 -18
  234. package/dist/apis/document.d.cts +0 -18
  235. package/dist/apis/email-settings.d.cts +0 -18
  236. package/dist/apis/email-template.d.cts +0 -18
  237. package/dist/apis/entity-mapping.d.cts +0 -18
  238. package/dist/apis/entity.d.cts +0 -18
  239. package/dist/apis/environments.d.cts +0 -18
  240. package/dist/apis/event-catalog.d.cts +0 -18
  241. package/dist/apis/file.d.cts +0 -18
  242. package/dist/apis/iban.d.cts +0 -18
  243. package/dist/apis/integration-toolkit.d.cts +0 -18
  244. package/dist/apis/journey.d.cts +0 -18
  245. package/dist/apis/kanban.d.cts +0 -18
  246. package/dist/apis/message.d.cts +0 -18
  247. package/dist/apis/metering.d.cts +0 -18
  248. package/dist/apis/notes.d.cts +0 -18
  249. package/dist/apis/notification.d.cts +0 -18
  250. package/dist/apis/organization.d.cts +0 -18
  251. package/dist/apis/partner-directory.d.cts +0 -18
  252. package/dist/apis/permissions.d.cts +0 -18
  253. package/dist/apis/pricing-tier.d.cts +0 -18
  254. package/dist/apis/pricing.d.cts +0 -18
  255. package/dist/apis/purpose.d.cts +0 -18
  256. package/dist/apis/query.d.cts +0 -18
  257. package/dist/apis/sandbox.d.cts +0 -18
  258. package/dist/apis/sharing.d.cts +0 -18
  259. package/dist/apis/submission.d.cts +0 -18
  260. package/dist/apis/target.d.cts +0 -597
  261. package/dist/apis/targeting.d.cts +0 -18
  262. package/dist/apis/template-variables.d.cts +0 -18
  263. package/dist/apis/user.d.cts +0 -18
  264. package/dist/apis/validation-rules.d.cts +0 -18
  265. package/dist/apis/webhooks.d.cts +0 -18
  266. package/dist/apis/workflow-definition.d.cts +0 -18
  267. package/dist/apis/workflow.d.cts +0 -18
  268. package/dist/app.d-u7Dq42kU.d.cts +0 -3391
  269. package/dist/app.d-u7Dq42kU.d.ts +0 -3391
  270. package/dist/audit-logs.d-BRToFqeX.d.cts +0 -287
  271. package/dist/audit-logs.d-BRToFqeX.d.ts +0 -287
  272. package/dist/automation-GFNNLSIN.js +0 -7
  273. package/dist/automation-IOCVCTKR.cjs +0 -7
  274. package/dist/automation.d-CzhG2m4L.d.cts +0 -5252
  275. package/dist/automation.d-CzhG2m4L.d.ts +0 -5252
  276. package/dist/billing.d-Bs8Ku9qE.d.cts +0 -993
  277. package/dist/billing.d-Bs8Ku9qE.d.ts +0 -993
  278. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +0 -4343
  279. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +0 -4343
  280. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +0 -478
  281. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +0 -478
  282. package/dist/consent.d-C2PROHhX.d.cts +0 -265
  283. package/dist/consent.d-C2PROHhX.d.ts +0 -265
  284. package/dist/customer-portal.d-DyZ2n2dW.d.cts +0 -16728
  285. package/dist/customer-portal.d-DyZ2n2dW.d.ts +0 -16728
  286. package/dist/dashboard.d-CsGcA74I.d.cts +0 -440
  287. package/dist/dashboard.d-CsGcA74I.d.ts +0 -440
  288. package/dist/data-governance.d-BbZ466j5.d.cts +0 -1178
  289. package/dist/data-governance.d-BbZ466j5.d.ts +0 -1178
  290. package/dist/deduplication.d-D5GYddVu.d.cts +0 -218
  291. package/dist/deduplication.d-D5GYddVu.d.ts +0 -218
  292. package/dist/design.d-BRre8iLg.d.cts +0 -2346
  293. package/dist/design.d-BRre8iLg.d.ts +0 -2346
  294. package/dist/document.d-DN37pjdx.d.cts +0 -648
  295. package/dist/document.d-DN37pjdx.d.ts +0 -648
  296. package/dist/email-settings.d-B7Q_xT25.d.cts +0 -2417
  297. package/dist/email-settings.d-B7Q_xT25.d.ts +0 -2417
  298. package/dist/email-template.d-gtQkdaXM.d.cts +0 -1188
  299. package/dist/email-template.d-gtQkdaXM.d.ts +0 -1188
  300. package/dist/entity-mapping.d-DKSW3sfy.d.cts +0 -1092
  301. package/dist/entity-mapping.d-DKSW3sfy.d.ts +0 -1092
  302. package/dist/entity.d-BHR9dEon.d.cts +0 -18479
  303. package/dist/entity.d-BHR9dEon.d.ts +0 -18479
  304. package/dist/environments.d-BvqvN-PD.d.cts +0 -382
  305. package/dist/environments.d-BvqvN-PD.d.ts +0 -382
  306. package/dist/event-catalog.d-ENw6HO-w.d.cts +0 -1511
  307. package/dist/event-catalog.d-ENw6HO-w.d.ts +0 -1511
  308. package/dist/file.d-DcTJxjp7.d.cts +0 -2992
  309. package/dist/file.d-DcTJxjp7.d.ts +0 -2992
  310. package/dist/iban.d-BwdiGbxi.d.cts +0 -70
  311. package/dist/iban.d-BwdiGbxi.d.ts +0 -70
  312. package/dist/index.d.cts +0 -180
  313. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +0 -5796
  314. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +0 -5796
  315. package/dist/journey.d-ClXO0xK8.d.cts +0 -1931
  316. package/dist/journey.d-ClXO0xK8.d.ts +0 -1931
  317. package/dist/kanban.d-BHnSRCYW.d.cts +0 -760
  318. package/dist/kanban.d-BHnSRCYW.d.ts +0 -760
  319. package/dist/message.d-B5UuSqgw.d.cts +0 -3811
  320. package/dist/message.d-B5UuSqgw.d.ts +0 -3811
  321. package/dist/metering.d-DvtPv7wk.d.cts +0 -1841
  322. package/dist/metering.d-DvtPv7wk.d.ts +0 -1841
  323. package/dist/notes.d-BC-scR42.d.cts +0 -1046
  324. package/dist/notes.d-BC-scR42.d.ts +0 -1046
  325. package/dist/notification.d-BfBL3lga.d.cts +0 -1147
  326. package/dist/notification.d-BfBL3lga.d.ts +0 -1147
  327. package/dist/organization.d-DqwnNxMg.d.cts +0 -1271
  328. package/dist/organization.d-DqwnNxMg.d.ts +0 -1271
  329. package/dist/partner-directory.d-BCIjHoGs.d.cts +0 -2337
  330. package/dist/partner-directory.d-BCIjHoGs.d.ts +0 -2337
  331. package/dist/permissions.d-l6AT8SYP.d.cts +0 -1279
  332. package/dist/permissions.d-l6AT8SYP.d.ts +0 -1279
  333. package/dist/pricing-4Z4TOETA.cjs +0 -7
  334. package/dist/pricing-C65DTZSX.js +0 -7
  335. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +0 -81
  336. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +0 -81
  337. package/dist/pricing.d-Cv39plGm.d.cts +0 -12200
  338. package/dist/pricing.d-Cv39plGm.d.ts +0 -12200
  339. package/dist/purpose.d-CbIYfTua.d.cts +0 -372
  340. package/dist/purpose.d-CbIYfTua.d.ts +0 -372
  341. package/dist/query.d-Cmp78IhZ.d.cts +0 -2375
  342. package/dist/query.d-Cmp78IhZ.d.ts +0 -2375
  343. package/dist/sandbox.d-BdbOFzDu.d.cts +0 -465
  344. package/dist/sandbox.d-BdbOFzDu.d.ts +0 -465
  345. package/dist/sharing.d-sOXq-gtz.d.cts +0 -571
  346. package/dist/sharing.d-sOXq-gtz.d.ts +0 -571
  347. package/dist/submission.d-BamwfhXw.d.cts +0 -469
  348. package/dist/submission.d-BamwfhXw.d.ts +0 -469
  349. package/dist/targeting.d-BNmcVsNS.d.cts +0 -2057
  350. package/dist/targeting.d-BNmcVsNS.d.ts +0 -2057
  351. package/dist/template-variables.d-Ble9TSBa.d.cts +0 -1320
  352. package/dist/template-variables.d-Ble9TSBa.d.ts +0 -1320
  353. package/dist/types-ChU9Acbv.d.cts +0 -37
  354. package/dist/types-ChU9Acbv.d.ts +0 -37
  355. package/dist/user.d-D18fe97W.d.cts +0 -2270
  356. package/dist/user.d-D18fe97W.d.ts +0 -2270
  357. package/dist/validation-rules.d-Db5c5zTf.d.cts +0 -807
  358. package/dist/validation-rules.d-Db5c5zTf.d.ts +0 -807
  359. package/dist/webhooks.d-pLHIL_io.d.cts +0 -1256
  360. package/dist/webhooks.d-pLHIL_io.d.ts +0 -1256
  361. package/dist/workflow-definition.d-DOeb0KVV.d.cts +0 -1922
  362. package/dist/workflow-definition.d-DOeb0KVV.d.ts +0 -1922
  363. package/dist/workflow.d-CMSKt8oN.d.cts +0 -3151
  364. package/dist/workflow.d-CMSKt8oN.d.ts +0 -3151
@@ -1,1188 +0,0 @@
1
- import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
-
3
- /* Auto-copied from email-template-client */
4
-
5
-
6
- declare namespace Components {
7
- namespace Schemas {
8
- /**
9
- * Type of approval action for the bulk message request.
10
- * * APPROVE_WITH_CONSENT: Approve the bulk message request and send emails to queued recipients with consent
11
- * * APPROVE_ALL: Approve the bulk message request and send emails to all queued recipients, including those without consent
12
- *
13
- */
14
- export type ApproveAction = "APPROVE_WITH_CONSENT" | "APPROVE_ALL";
15
- /**
16
- * Time when the bulk message action was last approved
17
- */
18
- export type ApprovedAt = string; // date-time
19
- export interface AsyncEmailTemplateResponse {
20
- /**
21
- * Job ID of the email template that is requested to replace and generate docs
22
- * example:
23
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
24
- */
25
- job_id: string;
26
- status: "STARTED" | "PROCESSING" | "SUCCESS" | "FAILED";
27
- /**
28
- * Error message
29
- */
30
- message?: string;
31
- /**
32
- * Progress count of the documents that are needed to generate
33
- */
34
- doc_progress_count?: {
35
- /**
36
- * Total count
37
- * example:
38
- * 10
39
- */
40
- total: number;
41
- /**
42
- * Completed count
43
- * example:
44
- * 5
45
- */
46
- completed: number;
47
- };
48
- /**
49
- * Result of the email template that is replaced along with generated docs
50
- */
51
- result?: {
52
- entity?: EmailTemplateEntity;
53
- relations?: {
54
- [key: string]: any;
55
- }[];
56
- };
57
- }
58
- export type Attachment = {
59
- /**
60
- * Attachment ID
61
- * example:
62
- * f820ce3b-07b0-45ae-bcc6-babb2f53f79f
63
- */
64
- cid?: string;
65
- /**
66
- * File name
67
- * example:
68
- * Produktinformationen_epilot360_Double_Opt_in.pdf
69
- */
70
- filename: string;
71
- /**
72
- * File size in bytes
73
- * example:
74
- * 451349
75
- */
76
- size: number;
77
- /**
78
- * Content type
79
- * example:
80
- * application/pdf
81
- */
82
- content_type: string;
83
- /**
84
- * URL to download the attachment.
85
- * example:
86
- * https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
87
- */
88
- url?: string;
89
- /**
90
- * S3 bucket where file is stored
91
- * example:
92
- * 893487340562-message-attachment
93
- */
94
- bucket: string;
95
- /**
96
- * S3 object apiKey
97
- * example:
98
- * attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
99
- */
100
- object_key: string;
101
- /**
102
- * If true then this attachment should not be offered for download (at least not in the main attachments list).\
103
- * The usecase is CID embedded image (aka inline image).
104
- *
105
- */
106
- inline?: boolean;
107
- /**
108
- * If true then this attachment is sent via link. The link is already inserted to email body by API caller. In this case, service doesn't process this attachment.
109
- */
110
- send_as_link?: boolean;
111
- /**
112
- * File type such as Document template, Document,... Use for replace variables on document template
113
- * example:
114
- * Document template
115
- */
116
- type?: string;
117
- /**
118
- * If true then this attachment is copied to the message and replaces corresponding one
119
- */
120
- copy_to_message?: boolean;
121
- } | null;
122
- export interface AttachmentResponse {
123
- /**
124
- * Total attachments
125
- * example:
126
- * 10
127
- */
128
- total?: number;
129
- /**
130
- * List attachments
131
- */
132
- attachments?: {
133
- /**
134
- * File name
135
- * example:
136
- * order.docx
137
- */
138
- filename?: string;
139
- /**
140
- * Bucket name
141
- * example:
142
- * epilot-playground-upload-document
143
- */
144
- bucket?: string;
145
- /**
146
- * Object key
147
- * example:
148
- * 9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx
149
- */
150
- object_key?: string;
151
- /**
152
- * URL
153
- * example:
154
- * https://epilot-playground-upload-document.s3.eu-central-1.amazonaws.com/9f561bea-f0d9-4e96-b7a9-879fc1643ac0.docx
155
- */
156
- url?: string;
157
- /**
158
- * Document type:
159
- * * 0: Static docs
160
- * * 1: Templates
161
- *
162
- * example:
163
- * 0
164
- */
165
- document_type?: number;
166
- }[];
167
- }
168
- export interface BaseEntity {
169
- /**
170
- * Entity ID
171
- * example:
172
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
173
- */
174
- _id: string;
175
- /**
176
- * Entity title
177
- */
178
- _title: string;
179
- /**
180
- * Ivy Organization ID the entity belongs to
181
- * example:
182
- * 206801
183
- */
184
- _org: string;
185
- /**
186
- * URL-friendly identifier for the entity schema
187
- * example:
188
- * message
189
- */
190
- _schema: string;
191
- /**
192
- * Entity tags
193
- * example:
194
- * [
195
- * "automatic email template"
196
- * ]
197
- */
198
- _tags?: string[];
199
- /**
200
- * Created date
201
- * example:
202
- * 2021-02-09T12:41:43.662Z
203
- */
204
- _created_at: string; // date-time
205
- /**
206
- * Updated date
207
- * example:
208
- * 2021-02-10T09:14:31.990Z
209
- */
210
- _updated_at: string; // date-time
211
- /**
212
- * Entity Purposes
213
- * example:
214
- * [
215
- * "a0ec23ac-12f8-4d89-9a63-91cba3787f2a",
216
- * "310cd388-2f15-4b5b-8f98-ca14c1e03304"
217
- * ]
218
- */
219
- _purpose?: string[];
220
- /**
221
- * Manifest ID used to create/update the entity
222
- */
223
- _manifest?: string /* uuid */[];
224
- }
225
- export interface BulkSendMessageJob {
226
- org_id?: /**
227
- * Organization ID
228
- * example:
229
- * 206801
230
- */
231
- OrgId;
232
- /**
233
- * Job ID for tracking the status of bulk message action
234
- * example:
235
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
236
- */
237
- job_id: string;
238
- skip_creating_entities?: /* When true, it lets to send only the email by skip creating the thread & message entities. */ SkipCreatingEntities;
239
- complete_thread?: /* Whether the thread is marked as Done immediately after sending the message */ CompleteThread;
240
- /**
241
- * Status of the bulk message action
242
- * * PROCESSING: Bulk message action is processing the request
243
- * * QUEUEING: Bulk message action is generating emails to send in a queue
244
- * * SENDING: Bulk message action is sending emails from the queue
245
- * * SUCCESS: Bulk message action is completed successfully
246
- * * FAILED: Bulk message action is failed
247
- * * CANCELLED: Bulk message action was cancelled
248
- *
249
- */
250
- status: "PROCESSING" | "QUEUEING" | "APPROVAL" | "SENDING" | "SUCCESS" | "FAILED" | "CANCELLED";
251
- request: /**
252
- * It takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.
253
- * For e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.
254
- *
255
- */
256
- BulkSendMessageRequest | /**
257
- * It takes an entity query to derive recipient_ids, treating each as a separate mainEntity to construct individual messages.
258
- * For e.g; if the query is provided as `_schema:opportunity AND status:PENDING`,
259
- * then all the opportunity Ids with status PENDING are treated as separate mainEntity to construct individual messages.
260
- *
261
- */
262
- BulkSendMessageRequestWithQuery;
263
- created_by?: /**
264
- * User ID who created the bulk message action
265
- * example:
266
- * 1234
267
- */
268
- CreatedBy;
269
- created_at?: /* Time when the bulk message action was created */ CreatedAt /* date-time */;
270
- updated_at?: /* Time when the bulk message action was last updated */ UpdatedAt /* date-time */;
271
- approved_at?: /* Time when the bulk message action was last approved */ ApprovedAt /* date-time */;
272
- approve_action?: /**
273
- * Type of approval action for the bulk message request.
274
- * * APPROVE_WITH_CONSENT: Approve the bulk message request and send emails to queued recipients with consent
275
- * * APPROVE_ALL: Approve the bulk message request and send emails to all queued recipients, including those without consent
276
- *
277
- */
278
- ApproveAction;
279
- task_token?: /**
280
- * Task token to approve or cancel the bulk message action
281
- * example:
282
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
283
- */
284
- TaskToken;
285
- /**
286
- * Total number of emails generated and queued for sending
287
- * example:
288
- * 100
289
- */
290
- total_queued?: number;
291
- /**
292
- * List of entity ids that are queued for sending
293
- */
294
- queued?: {
295
- /**
296
- * Recipient Entity ID
297
- * example:
298
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
299
- */
300
- entity_id: string;
301
- /**
302
- * Recipient emails
303
- */
304
- email_to: string[];
305
- /**
306
- * Recipient emails with consent
307
- */
308
- email_with_consent: string[];
309
- }[];
310
- /**
311
- * List of entity ids and message ids that were sent successfully
312
- */
313
- sent?: {
314
- /**
315
- * Recipient Entity ID
316
- * example:
317
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
318
- */
319
- entity_id: string;
320
- /**
321
- * Message ID
322
- * example:
323
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
324
- */
325
- message_id: string;
326
- email_to?: string[];
327
- }[];
328
- /**
329
- * List of entity ids that were skipped or failed
330
- */
331
- failed?: {
332
- /**
333
- * Recipient Entity ID
334
- * example:
335
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
336
- */
337
- entity_id: string;
338
- /**
339
- * Error message
340
- */
341
- error: string;
342
- email_to?: string[];
343
- }[];
344
- }
345
- /**
346
- * It takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.
347
- * For e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.
348
- *
349
- */
350
- export interface BulkSendMessageRequest {
351
- skip_creating_entities?: /* When true, it lets to send only the email by skip creating the thread & message entities. */ SkipCreatingEntities;
352
- complete_thread?: /* Whether the thread is marked as Done immediately after sending the message */ CompleteThread;
353
- /**
354
- * ID of email template to use for sending bulk emails
355
- * example:
356
- * 511ceb90-f738-47aa-8b1e-915ace0ae13c
357
- */
358
- email_template_id: string;
359
- /**
360
- * If true then include unsubscribe link in the email body
361
- *
362
- */
363
- must_include_unsubscribe_link?: boolean;
364
- /**
365
- * List of entity ids to use as recipients
366
- * example:
367
- * [
368
- * "3fa85f64-5717-4562-b3fc-2c963f66afa6",
369
- * "3fa85f64-5717-4562-b3fc-2c963f66afa7",
370
- * "3fa85f64-5717-4562-b3fc-2c963f66afa8"
371
- * ]
372
- */
373
- recipient_ids: string[];
374
- custom_variables?: /* Custom variables to be replaced in the email template */ CustomVariables;
375
- }
376
- /**
377
- * It takes an entity query to derive recipient_ids, treating each as a separate mainEntity to construct individual messages.
378
- * For e.g; if the query is provided as `_schema:opportunity AND status:PENDING`,
379
- * then all the opportunity Ids with status PENDING are treated as separate mainEntity to construct individual messages.
380
- *
381
- */
382
- export interface BulkSendMessageRequestWithQuery {
383
- skip_creating_entities?: /* When true, it lets to send only the email by skip creating the thread & message entities. */ SkipCreatingEntities;
384
- complete_thread?: /* Whether the thread is marked as Done immediately after sending the message */ CompleteThread;
385
- /**
386
- * ID of email template to use for sending bulk emails
387
- * example:
388
- * 511ceb90-f738-47aa-8b1e-915ace0ae13c
389
- */
390
- email_template_id: string;
391
- /**
392
- * If true then include unsubscribe link in the email body
393
- *
394
- */
395
- must_include_unsubscribe_link?: boolean;
396
- /**
397
- * Entity search query to select recipients
398
- * example:
399
- * _schema:contact AND consent_email_marketing:active
400
- */
401
- recipient_query: string;
402
- custom_variables?: /* Custom variables to be replaced in the email template */ CustomVariables;
403
- }
404
- /**
405
- * Whether the thread is marked as Done immediately after sending the message
406
- */
407
- export type CompleteThread = boolean;
408
- export interface CreateSystemTemplatesReq {
409
- /**
410
- * example:
411
- * [
412
- * "DoubleOptIn_Email_DE",
413
- * "Einladung Kundenportal",
414
- * "Partner_Kooperation_Email_DE"
415
- * ]
416
- */
417
- template_names: string[];
418
- }
419
- export type CreateSystemTemplatesResp = BaseEntity[];
420
- /**
421
- * Time when the bulk message action was created
422
- */
423
- export type CreatedAt = string; // date-time
424
- /**
425
- * User ID who created the bulk message action
426
- * example:
427
- * 1234
428
- */
429
- export type CreatedBy = string;
430
- /**
431
- * Custom variables to be replaced in the email template
432
- */
433
- export type CustomVariables = {
434
- /**
435
- * Template Variable Name
436
- * example:
437
- * {{abc.xyz}}
438
- */
439
- variable?: string;
440
- /**
441
- * Value to be Replaced
442
- * example:
443
- * ReplacedValue
444
- */
445
- value?: string;
446
- }[];
447
- export interface EmailTemplateEntity {
448
- /**
449
- * Entity ID
450
- * example:
451
- * 3fa85f64-5717-4562-b3fc-2c963f66afa6
452
- */
453
- _id: string;
454
- /**
455
- * Entity title
456
- */
457
- _title: string;
458
- /**
459
- * Ivy Organization ID the entity belongs to
460
- * example:
461
- * 206801
462
- */
463
- _org: string;
464
- /**
465
- * URL-friendly identifier for the entity schema
466
- * example:
467
- * message
468
- */
469
- _schema: string;
470
- /**
471
- * Entity tags
472
- * example:
473
- * [
474
- * "automatic email template"
475
- * ]
476
- */
477
- _tags?: string[];
478
- /**
479
- * Created date
480
- * example:
481
- * 2021-02-09T12:41:43.662Z
482
- */
483
- _created_at: string; // date-time
484
- /**
485
- * Updated date
486
- * example:
487
- * 2021-02-10T09:14:31.990Z
488
- */
489
- _updated_at: string; // date-time
490
- /**
491
- * Entity Purposes
492
- * example:
493
- * [
494
- * "a0ec23ac-12f8-4d89-9a63-91cba3787f2a",
495
- * "310cd388-2f15-4b5b-8f98-ca14c1e03304"
496
- * ]
497
- */
498
- _purpose?: string[];
499
- /**
500
- * Manifest ID used to create/update the entity
501
- */
502
- _manifest?: string /* uuid */[];
503
- /**
504
- * name
505
- * example:
506
- * Order confirmation
507
- */
508
- name: string;
509
- /**
510
- * Brand ID. Equal 0 if available for All brands
511
- * example:
512
- * 0
513
- */
514
- brand_id?: number | null;
515
- from?: From;
516
- /**
517
- * To
518
- */
519
- to?: To[];
520
- /**
521
- * Cc
522
- */
523
- cc?: To[];
524
- /**
525
- * Bcc
526
- */
527
- bcc?: To[];
528
- /**
529
- * Subject
530
- * example:
531
- * We have received your order!
532
- */
533
- subject?: string;
534
- /**
535
- * Body
536
- * example:
537
- * Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly
538
- */
539
- body?: string;
540
- /**
541
- * Email template attachments
542
- */
543
- attachments?: Attachment[] | null;
544
- file?: {
545
- /**
546
- * Entity tags
547
- */
548
- $relation?: {
549
- [key: string]: any;
550
- }[];
551
- };
552
- /**
553
- * Created by
554
- * example:
555
- * 1234
556
- */
557
- created_by?: string;
558
- /**
559
- * Updated by
560
- * example:
561
- * 1234
562
- */
563
- updated_by?: string;
564
- /**
565
- * This field is used to store JSON templates. If this field is populated, then the Body html is derived from the JSON.
566
- */
567
- json_template?: string;
568
- /**
569
- * If template is created by system (Double Opt-in, CMD invitation,...) then true, and some attributes can not be edited such as Name, To,...
570
- * Remember to add default content of template to system_template enum for revert to original feature
571
- *
572
- * example:
573
- * false
574
- */
575
- system_template?: boolean;
576
- }
577
- export interface EmailTemplateRequest {
578
- /**
579
- * example:
580
- * cd7809ba-a111-4dd9-8d15-18eb4de0faed
581
- */
582
- _id?: string;
583
- /**
584
- * Entity tags
585
- * example:
586
- * [
587
- * "template"
588
- * ]
589
- */
590
- _tags?: string[];
591
- /**
592
- * Manifest ID used to create/update the entity
593
- */
594
- _manifest?: string /* uuid */[];
595
- /**
596
- * Entity Purposes
597
- * example:
598
- * [
599
- * "a0ec23ac-12f8-4d89-9a63-91cba3787f2a",
600
- * "310cd388-2f15-4b5b-8f98-ca14c1e03304"
601
- * ]
602
- */
603
- _purpose?: string[];
604
- /**
605
- * name
606
- * example:
607
- * Order confirmation
608
- */
609
- name: string;
610
- /**
611
- * Brand ID. Equal 0 if available for All brands
612
- * example:
613
- * 0
614
- */
615
- brand_id?: number | null;
616
- /**
617
- * From
618
- */
619
- from?: From;
620
- /**
621
- * To
622
- */
623
- to?: To[];
624
- /**
625
- * Cc
626
- */
627
- cc?: To[];
628
- /**
629
- * Bcc
630
- */
631
- bcc?: To[];
632
- /**
633
- * Subject
634
- * example:
635
- * We have received your order!
636
- */
637
- subject: string;
638
- /**
639
- * Body
640
- * example:
641
- * Hi Ms Ny Huynh, </br> Thank you for your order. We will contact you shortly
642
- */
643
- body?: string;
644
- /**
645
- * Email template attachments
646
- */
647
- attachments?: Attachment[] | null;
648
- file?: {
649
- /**
650
- * Entity tags
651
- */
652
- $relation?: {
653
- [key: string]: any;
654
- }[];
655
- };
656
- /**
657
- * If template is created by system (Double Opt-in, CMD invitation,...) then true, and some attributes can not be edited such as Name, To,...
658
- * Remember to add default content of template to [system-template.ts](https://gitlab.com/e-pilot/product/email-templates/svc-email-templates-api/-/blob/main/lambda/HandlerFunction/src/enum/system-template.ts) enum for revert to original feature
659
- *
660
- * example:
661
- * false
662
- */
663
- system_template?: boolean;
664
- /**
665
- * Created by
666
- * example:
667
- * 1234
668
- */
669
- created_by?: string;
670
- /**
671
- * Updated by
672
- * example:
673
- * 1234
674
- */
675
- updated_by?: string;
676
- /**
677
- * This field is used to store JSON templates. If this field is populated, then the Body html is derived from the JSON.
678
- */
679
- json_template?: string;
680
- }
681
- export interface EmailTemplateResponse {
682
- entity?: EmailTemplateEntity;
683
- relations?: {
684
- [key: string]: any;
685
- }[];
686
- }
687
- export interface From {
688
- /**
689
- * example:
690
- * epilot
691
- */
692
- name?: string;
693
- /**
694
- * example:
695
- * no-reply@epilot.cloud
696
- */
697
- email: string;
698
- }
699
- /**
700
- * Organization ID
701
- * example:
702
- * 206801
703
- */
704
- export type OrgId = string;
705
- export interface PresignedRequest {
706
- /**
707
- * UUID
708
- * example:
709
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
710
- */
711
- id: string;
712
- /**
713
- * File name
714
- * example:
715
- * order.pdf
716
- */
717
- filename: string;
718
- /**
719
- * Content type
720
- * example:
721
- * application/pdf
722
- */
723
- content_type: string;
724
- }
725
- export interface PresignedResponse {
726
- /**
727
- * URL to download the attachment. This URL is not accessible until attachment is uploaded successfully.
728
- * example:
729
- * https://go.epilot.cloud/attachments/3e7c616a-3e89-4f92-b4c5-ea5ab140e3dd/Produktinformationen_epilot360_Double_Opt_in.pdf
730
- */
731
- download_url: string;
732
- /**
733
- * Post presigned URL to upload file
734
- */
735
- upload_url: {
736
- /**
737
- * URL to upload the attachment
738
- * example:
739
- * https://s3.eu-central-1.amazonaws.com/893487340562-message-attachment
740
- */
741
- url: number;
742
- /**
743
- * Fields are provided by AWS to authenticate and validate the request. All fields should be included in form-data when performing upload request.
744
- * example:
745
- * {}
746
- */
747
- fields: {
748
- [key: string]: any;
749
- };
750
- };
751
- }
752
- /**
753
- * When true, it lets to send only the email by skip creating the thread & message entities.
754
- */
755
- export type SkipCreatingEntities = boolean;
756
- /**
757
- * Task token to approve or cancel the bulk message action
758
- * example:
759
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
760
- */
761
- export type TaskToken = string;
762
- export type TemplateType = "email" | "document";
763
- export interface To {
764
- /**
765
- * example:
766
- * Ny Huynh
767
- */
768
- name?: string;
769
- /**
770
- * example:
771
- * ny.huynh@axonactive.com
772
- */
773
- email: string;
774
- }
775
- /**
776
- * Time when the bulk message action was last updated
777
- */
778
- export type UpdatedAt = string; // date-time
779
- export interface UserResponse {
780
- id?: string;
781
- organization_id?: string;
782
- /**
783
- * User's display name (default: email address)
784
- * example:
785
- * Example User
786
- */
787
- display_name?: string;
788
- email?: string; // email
789
- /**
790
- * example:
791
- * 1234567890
792
- */
793
- phone?: string | null;
794
- /**
795
- * example:
796
- * de
797
- */
798
- preferred_language?: string;
799
- /**
800
- * example:
801
- * {
802
- * "original": "https://account-profile-images.epilot.cloud/1/avatar.png",
803
- * "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png"
804
- * }
805
- */
806
- image_uri?: {
807
- [name: string]: any;
808
- original?: string; // uri
809
- thumbnail_32?: string; // uri
810
- };
811
- properties?: {
812
- /**
813
- * example:
814
- * profileImageName
815
- */
816
- name: string;
817
- /**
818
- * example:
819
- * avatar.png
820
- */
821
- value: string;
822
- }[];
823
- }
824
- export interface VariableParameters {
825
- template_type: TemplateType;
826
- language?: "en" | "de";
827
- /**
828
- * The main entity ID. Use main entity in order to use the variable without schema slug prefix - or just pass directly to other object ID.
829
- * example:
830
- * 63753437-c9e2-4e83-82bb-b1c666514561
831
- */
832
- main_entity_id?: string;
833
- /**
834
- * User ID
835
- * example:
836
- * 123452
837
- */
838
- user_id?: string;
839
- custom_variables?: /* Custom variables to be replaced in the email template */ CustomVariables;
840
- }
841
- }
842
- }
843
- declare namespace Paths {
844
- namespace BulkSendMessage {
845
- export type RequestBody = /**
846
- * It takes an entity query to derive recipient_ids, treating each as a separate mainEntity to construct individual messages.
847
- * For e.g; if the query is provided as `_schema:opportunity AND status:PENDING`,
848
- * then all the opportunity Ids with status PENDING are treated as separate mainEntity to construct individual messages.
849
- *
850
- */
851
- Components.Schemas.BulkSendMessageRequestWithQuery | /**
852
- * It takes a list of entity ids, treating each as a separate mainEntity to construct individual messages.
853
- * For e.g; if there some opportunityIds are provided, then each opportunityId is treated as a separate mainEntity to construct individual messages.
854
- *
855
- */
856
- Components.Schemas.BulkSendMessageRequest | {
857
- /**
858
- * Job ID for tracking the status of a bulk message request
859
- * example:
860
- * 8c086140-f33e-4bb7-a993-50c0f2402c7b
861
- */
862
- job_id: string;
863
- /**
864
- * Trigger an APPROVE OR CANCEL action for the bulk message request.
865
- *
866
- * * APPROVE: Alias for APPROVE_WITH_CONSENT
867
- * * APPROVE_WITH_CONSENT: Approve the bulk message request and send emails to queued recipients with consent
868
- * * APPROVE_ALL: Approve the bulk message request and send emails to all queued recipients, including those without consent
869
- * * CANCEL: Cancel the bulk message request
870
- *
871
- */
872
- action?: "APPROVE" | "APPROVE_WITH_CONSENT" | "APPROVE_ALL" | "CANCEL";
873
- };
874
- namespace Responses {
875
- export type $200 = Components.Schemas.BulkSendMessageJob;
876
- export interface $403 {
877
- }
878
- }
879
- }
880
- namespace GetTemplateDetail {
881
- namespace Parameters {
882
- export type Id = string;
883
- }
884
- export interface PathParameters {
885
- id: Parameters.Id;
886
- }
887
- namespace Responses {
888
- export type $200 = Components.Schemas.EmailTemplateResponse;
889
- export interface $403 {
890
- }
891
- export interface $404 {
892
- }
893
- }
894
- }
895
- namespace ReplaceVariables {
896
- export interface RequestBody {
897
- /**
898
- * example:
899
- * 511ceb90-f738-47aa-8b1e-915ace0ae13c
900
- */
901
- email_template_id: string;
902
- variable_parameters?: Components.Schemas.VariableParameters;
903
- /**
904
- * If true then include unsubscribe link in the email body
905
- *
906
- */
907
- must_include_unsubscribe_link?: boolean;
908
- /**
909
- * If true then skip document generation. This is useful when you want to replace html variables only. Speeds up the process.
910
- *
911
- */
912
- skip_document_generation?: boolean;
913
- }
914
- namespace Responses {
915
- export type $200 = Components.Schemas.EmailTemplateResponse;
916
- export interface $403 {
917
- }
918
- }
919
- }
920
- namespace ReplaceVariablesAsync {
921
- namespace Parameters {
922
- export type JobId = string;
923
- }
924
- export interface QueryParameters {
925
- job_id?: Parameters.JobId;
926
- }
927
- export interface RequestBody {
928
- /**
929
- * example:
930
- * 511ceb90-f738-47aa-8b1e-915ace0ae13c
931
- */
932
- email_template_id?: string;
933
- variable_parameters?: Components.Schemas.VariableParameters;
934
- /**
935
- * If true then include unsubscribe link in the email body
936
- *
937
- */
938
- must_include_unsubscribe_link?: boolean;
939
- /**
940
- * If true then skip document generation. This is useful when you want to replace html variables only. Speeds up the process.
941
- *
942
- */
943
- skip_document_generation?: boolean;
944
- }
945
- namespace Responses {
946
- export type $200 = Components.Schemas.AsyncEmailTemplateResponse;
947
- export interface $403 {
948
- }
949
- }
950
- }
951
- namespace RevertToOriginalTemplate {
952
- export interface RequestBody {
953
- /**
954
- * example:
955
- * 511ceb90-f738-47aa-8b1e-915ace0ae13c
956
- */
957
- email_template_id: string;
958
- }
959
- namespace Responses {
960
- export interface $200 {
961
- }
962
- export interface $403 {
963
- }
964
- }
965
- }
966
- namespace SaveTemplate {
967
- export type RequestBody = Components.Schemas.EmailTemplateRequest;
968
- namespace Responses {
969
- export type $200 = Components.Schemas.EmailTemplateEntity;
970
- export interface $403 {
971
- }
972
- }
973
- }
974
- namespace UpdateTemplateDetail {
975
- namespace Parameters {
976
- export type Id = string;
977
- }
978
- export interface PathParameters {
979
- id: Parameters.Id;
980
- }
981
- export type RequestBody = Components.Schemas.EmailTemplateRequest;
982
- namespace Responses {
983
- export type $200 = Components.Schemas.EmailTemplateEntity;
984
- export interface $403 {
985
- }
986
- export interface $404 {
987
- }
988
- }
989
- }
990
- }
991
-
992
- interface OperationMethods {
993
- /**
994
- * saveTemplate - saveTemplate
995
- *
996
- * Create or update a template. If `id` is provided, it will update the template.
997
- */
998
- 'saveTemplate'(
999
- parameters?: Parameters<UnknownParamsObject> | null,
1000
- data?: Paths.SaveTemplate.RequestBody,
1001
- config?: AxiosRequestConfig
1002
- ): OperationResponse<Paths.SaveTemplate.Responses.$200>
1003
- /**
1004
- * getTemplateDetail - getTemplateDetail
1005
- *
1006
- * Get email template by ID
1007
- */
1008
- 'getTemplateDetail'(
1009
- parameters?: Parameters<Paths.GetTemplateDetail.PathParameters> | null,
1010
- data?: any,
1011
- config?: AxiosRequestConfig
1012
- ): OperationResponse<Paths.GetTemplateDetail.Responses.$200>
1013
- /**
1014
- * updateTemplateDetail - updateTemplateDetail
1015
- *
1016
- * Update email template by ID
1017
- */
1018
- 'updateTemplateDetail'(
1019
- parameters?: Parameters<Paths.UpdateTemplateDetail.PathParameters> | null,
1020
- data?: Paths.UpdateTemplateDetail.RequestBody,
1021
- config?: AxiosRequestConfig
1022
- ): OperationResponse<Paths.UpdateTemplateDetail.Responses.$200>
1023
- /**
1024
- * replaceVariables - replaceVariables
1025
- *
1026
- * Get template detail and replace all variables (template variables and document generation)
1027
- */
1028
- 'replaceVariables'(
1029
- parameters?: Parameters<UnknownParamsObject> | null,
1030
- data?: Paths.ReplaceVariables.RequestBody,
1031
- config?: AxiosRequestConfig
1032
- ): OperationResponse<Paths.ReplaceVariables.Responses.$200>
1033
- /**
1034
- * replaceVariablesAsync - replaceVariablesAsync
1035
- *
1036
- * This endpoint allows to initiate an asynchronous process in replacing the template details & generating the documents.
1037
- * On initial request, a jobId and STARTED status are returned. Subsequent requests can use this jobId to poll for the resolved template.
1038
- * If still processing, it returns the jobId and IN-PROGRESS status. Upon completion or failure, it returns the final template or a failure status with reason.
1039
- *
1040
- */
1041
- 'replaceVariablesAsync'(
1042
- parameters?: Parameters<Paths.ReplaceVariablesAsync.QueryParameters> | null,
1043
- data?: Paths.ReplaceVariablesAsync.RequestBody,
1044
- config?: AxiosRequestConfig
1045
- ): OperationResponse<Paths.ReplaceVariablesAsync.Responses.$200>
1046
- /**
1047
- * bulkSendMessage - bulkSendMessage
1048
- *
1049
- * Send emails to multiple recipients using a template
1050
- */
1051
- 'bulkSendMessage'(
1052
- parameters?: Parameters<UnknownParamsObject> | null,
1053
- data?: Paths.BulkSendMessage.RequestBody,
1054
- config?: AxiosRequestConfig
1055
- ): OperationResponse<Paths.BulkSendMessage.Responses.$200>
1056
- /**
1057
- * revertToOriginalTemplate - revertToOriginalTemplate
1058
- *
1059
- * Revert to the original system generated email template
1060
- */
1061
- 'revertToOriginalTemplate'(
1062
- parameters?: Parameters<UnknownParamsObject> | null,
1063
- data?: Paths.RevertToOriginalTemplate.RequestBody,
1064
- config?: AxiosRequestConfig
1065
- ): OperationResponse<Paths.RevertToOriginalTemplate.Responses.$200>
1066
- }
1067
-
1068
- interface PathsDictionary {
1069
- ['/v1/email-template/templates']: {
1070
- /**
1071
- * saveTemplate - saveTemplate
1072
- *
1073
- * Create or update a template. If `id` is provided, it will update the template.
1074
- */
1075
- 'post'(
1076
- parameters?: Parameters<UnknownParamsObject> | null,
1077
- data?: Paths.SaveTemplate.RequestBody,
1078
- config?: AxiosRequestConfig
1079
- ): OperationResponse<Paths.SaveTemplate.Responses.$200>
1080
- }
1081
- ['/v1/email-template/templates/{id}']: {
1082
- /**
1083
- * getTemplateDetail - getTemplateDetail
1084
- *
1085
- * Get email template by ID
1086
- */
1087
- 'get'(
1088
- parameters?: Parameters<Paths.GetTemplateDetail.PathParameters> | null,
1089
- data?: any,
1090
- config?: AxiosRequestConfig
1091
- ): OperationResponse<Paths.GetTemplateDetail.Responses.$200>
1092
- /**
1093
- * updateTemplateDetail - updateTemplateDetail
1094
- *
1095
- * Update email template by ID
1096
- */
1097
- 'put'(
1098
- parameters?: Parameters<Paths.UpdateTemplateDetail.PathParameters> | null,
1099
- data?: Paths.UpdateTemplateDetail.RequestBody,
1100
- config?: AxiosRequestConfig
1101
- ): OperationResponse<Paths.UpdateTemplateDetail.Responses.$200>
1102
- }
1103
- ['/v1/email-template/templates:replace']: {
1104
- /**
1105
- * replaceVariables - replaceVariables
1106
- *
1107
- * Get template detail and replace all variables (template variables and document generation)
1108
- */
1109
- 'post'(
1110
- parameters?: Parameters<UnknownParamsObject> | null,
1111
- data?: Paths.ReplaceVariables.RequestBody,
1112
- config?: AxiosRequestConfig
1113
- ): OperationResponse<Paths.ReplaceVariables.Responses.$200>
1114
- }
1115
- ['/v1/email-template/templates:replaceAsync']: {
1116
- /**
1117
- * replaceVariablesAsync - replaceVariablesAsync
1118
- *
1119
- * This endpoint allows to initiate an asynchronous process in replacing the template details & generating the documents.
1120
- * On initial request, a jobId and STARTED status are returned. Subsequent requests can use this jobId to poll for the resolved template.
1121
- * If still processing, it returns the jobId and IN-PROGRESS status. Upon completion or failure, it returns the final template or a failure status with reason.
1122
- *
1123
- */
1124
- 'post'(
1125
- parameters?: Parameters<Paths.ReplaceVariablesAsync.QueryParameters> | null,
1126
- data?: Paths.ReplaceVariablesAsync.RequestBody,
1127
- config?: AxiosRequestConfig
1128
- ): OperationResponse<Paths.ReplaceVariablesAsync.Responses.$200>
1129
- }
1130
- ['/v1/email-template/templates:bulkSendMessage']: {
1131
- /**
1132
- * bulkSendMessage - bulkSendMessage
1133
- *
1134
- * Send emails to multiple recipients using a template
1135
- */
1136
- 'post'(
1137
- parameters?: Parameters<UnknownParamsObject> | null,
1138
- data?: Paths.BulkSendMessage.RequestBody,
1139
- config?: AxiosRequestConfig
1140
- ): OperationResponse<Paths.BulkSendMessage.Responses.$200>
1141
- }
1142
- ['/v1/email-template/templates:revert']: {
1143
- /**
1144
- * revertToOriginalTemplate - revertToOriginalTemplate
1145
- *
1146
- * Revert to the original system generated email template
1147
- */
1148
- 'post'(
1149
- parameters?: Parameters<UnknownParamsObject> | null,
1150
- data?: Paths.RevertToOriginalTemplate.RequestBody,
1151
- config?: AxiosRequestConfig
1152
- ): OperationResponse<Paths.RevertToOriginalTemplate.Responses.$200>
1153
- }
1154
- }
1155
-
1156
- type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1157
-
1158
- type ApproveAction = Components.Schemas.ApproveAction;
1159
- type ApprovedAt = Components.Schemas.ApprovedAt;
1160
- type AsyncEmailTemplateResponse = Components.Schemas.AsyncEmailTemplateResponse;
1161
- type Attachment = Components.Schemas.Attachment;
1162
- type AttachmentResponse = Components.Schemas.AttachmentResponse;
1163
- type BaseEntity = Components.Schemas.BaseEntity;
1164
- type BulkSendMessageJob = Components.Schemas.BulkSendMessageJob;
1165
- type BulkSendMessageRequest = Components.Schemas.BulkSendMessageRequest;
1166
- type BulkSendMessageRequestWithQuery = Components.Schemas.BulkSendMessageRequestWithQuery;
1167
- type CompleteThread = Components.Schemas.CompleteThread;
1168
- type CreateSystemTemplatesReq = Components.Schemas.CreateSystemTemplatesReq;
1169
- type CreateSystemTemplatesResp = Components.Schemas.CreateSystemTemplatesResp;
1170
- type CreatedAt = Components.Schemas.CreatedAt;
1171
- type CreatedBy = Components.Schemas.CreatedBy;
1172
- type CustomVariables = Components.Schemas.CustomVariables;
1173
- type EmailTemplateEntity = Components.Schemas.EmailTemplateEntity;
1174
- type EmailTemplateRequest = Components.Schemas.EmailTemplateRequest;
1175
- type EmailTemplateResponse = Components.Schemas.EmailTemplateResponse;
1176
- type From = Components.Schemas.From;
1177
- type OrgId = Components.Schemas.OrgId;
1178
- type PresignedRequest = Components.Schemas.PresignedRequest;
1179
- type PresignedResponse = Components.Schemas.PresignedResponse;
1180
- type SkipCreatingEntities = Components.Schemas.SkipCreatingEntities;
1181
- type TaskToken = Components.Schemas.TaskToken;
1182
- type TemplateType = Components.Schemas.TemplateType;
1183
- type To = Components.Schemas.To;
1184
- type UpdatedAt = Components.Schemas.UpdatedAt;
1185
- type UserResponse = Components.Schemas.UserResponse;
1186
- type VariableParameters = Components.Schemas.VariableParameters;
1187
-
1188
- export { type ApproveAction as A, type BaseEntity as B, type Client as C, type EmailTemplateEntity as E, type From as F, type OperationMethods as O, Paths as P, type SkipCreatingEntities as S, type TaskToken as T, type UpdatedAt as U, type VariableParameters as V, Components as a, type PathsDictionary as b, type ApprovedAt as c, type AsyncEmailTemplateResponse as d, type Attachment as e, type AttachmentResponse as f, type BulkSendMessageJob as g, type BulkSendMessageRequest as h, type BulkSendMessageRequestWithQuery as i, type CompleteThread as j, type CreateSystemTemplatesReq as k, type CreateSystemTemplatesResp as l, type CreatedAt as m, type CreatedBy as n, type CustomVariables as o, type EmailTemplateRequest as p, type EmailTemplateResponse as q, type OrgId as r, type PresignedRequest as s, type PresignedResponse as t, type TemplateType as u, type To as v, type UserResponse as w };