@epilot/sdk 2.0.0-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 (381) hide show
  1. package/README.md +294 -0
  2. package/dist/access-token-MYDOBCIY.cjs +89 -0
  3. package/dist/access-token-Y5JR7PRG.js +89 -0
  4. package/dist/access-token.d-C2qnueDV.d.cts +553 -0
  5. package/dist/access-token.d-C2qnueDV.d.ts +553 -0
  6. package/dist/address-3RQRG3MK.js +84 -0
  7. package/dist/address-LQUTDOUA.cjs +84 -0
  8. package/dist/address-suggestions-PEKSA7B2.cjs +132 -0
  9. package/dist/address-suggestions-QNK5JWNH.js +132 -0
  10. package/dist/address-suggestions.d-CewXYNYH.d.cts +340 -0
  11. package/dist/address-suggestions.d-CewXYNYH.d.ts +340 -0
  12. package/dist/address.d-DP_aE2ex.d.cts +438 -0
  13. package/dist/address.d-DP_aE2ex.d.ts +438 -0
  14. package/dist/ai-agents-MO4PK2RJ.cjs +215 -0
  15. package/dist/ai-agents-OHP2F243.js +215 -0
  16. package/dist/ai-agents.d-vG-1utqk.d.cts +1340 -0
  17. package/dist/ai-agents.d-vG-1utqk.d.ts +1340 -0
  18. package/dist/apis/access-token.cjs +33 -0
  19. package/dist/apis/access-token.d.cts +18 -0
  20. package/dist/apis/access-token.d.ts +18 -0
  21. package/dist/apis/access-token.js +33 -0
  22. package/dist/apis/address-suggestions.cjs +33 -0
  23. package/dist/apis/address-suggestions.d.cts +18 -0
  24. package/dist/apis/address-suggestions.d.ts +18 -0
  25. package/dist/apis/address-suggestions.js +33 -0
  26. package/dist/apis/address.cjs +33 -0
  27. package/dist/apis/address.d.cts +18 -0
  28. package/dist/apis/address.d.ts +18 -0
  29. package/dist/apis/address.js +33 -0
  30. package/dist/apis/ai-agents.cjs +33 -0
  31. package/dist/apis/ai-agents.d.cts +18 -0
  32. package/dist/apis/ai-agents.d.ts +18 -0
  33. package/dist/apis/ai-agents.js +33 -0
  34. package/dist/apis/app.cjs +33 -0
  35. package/dist/apis/app.d.cts +18 -0
  36. package/dist/apis/app.d.ts +18 -0
  37. package/dist/apis/app.js +33 -0
  38. package/dist/apis/audit-logs.cjs +33 -0
  39. package/dist/apis/audit-logs.d.cts +18 -0
  40. package/dist/apis/audit-logs.d.ts +18 -0
  41. package/dist/apis/audit-logs.js +33 -0
  42. package/dist/apis/automation.cjs +33 -0
  43. package/dist/apis/automation.d.cts +18 -0
  44. package/dist/apis/automation.d.ts +18 -0
  45. package/dist/apis/automation.js +33 -0
  46. package/dist/apis/billing.cjs +33 -0
  47. package/dist/apis/billing.d.cts +18 -0
  48. package/dist/apis/billing.d.ts +18 -0
  49. package/dist/apis/billing.js +33 -0
  50. package/dist/apis/blueprint-manifest.cjs +33 -0
  51. package/dist/apis/blueprint-manifest.d.cts +18 -0
  52. package/dist/apis/blueprint-manifest.d.ts +18 -0
  53. package/dist/apis/blueprint-manifest.js +33 -0
  54. package/dist/apis/consent.cjs +33 -0
  55. package/dist/apis/consent.d.cts +18 -0
  56. package/dist/apis/consent.d.ts +18 -0
  57. package/dist/apis/consent.js +33 -0
  58. package/dist/apis/customer-portal.cjs +33 -0
  59. package/dist/apis/customer-portal.d.cts +18 -0
  60. package/dist/apis/customer-portal.d.ts +18 -0
  61. package/dist/apis/customer-portal.js +33 -0
  62. package/dist/apis/data-management.cjs +33 -0
  63. package/dist/apis/data-management.d.cts +18 -0
  64. package/dist/apis/data-management.d.ts +18 -0
  65. package/dist/apis/data-management.js +33 -0
  66. package/dist/apis/deduplication.cjs +33 -0
  67. package/dist/apis/deduplication.d.cts +18 -0
  68. package/dist/apis/deduplication.d.ts +18 -0
  69. package/dist/apis/deduplication.js +33 -0
  70. package/dist/apis/design.cjs +33 -0
  71. package/dist/apis/design.d.cts +18 -0
  72. package/dist/apis/design.d.ts +18 -0
  73. package/dist/apis/design.js +33 -0
  74. package/dist/apis/discussion.cjs +33 -0
  75. package/dist/apis/discussion.d.cts +18 -0
  76. package/dist/apis/discussion.d.ts +18 -0
  77. package/dist/apis/discussion.js +33 -0
  78. package/dist/apis/document.cjs +33 -0
  79. package/dist/apis/document.d.cts +18 -0
  80. package/dist/apis/document.d.ts +18 -0
  81. package/dist/apis/document.js +33 -0
  82. package/dist/apis/email-settings.cjs +33 -0
  83. package/dist/apis/email-settings.d.cts +18 -0
  84. package/dist/apis/email-settings.d.ts +18 -0
  85. package/dist/apis/email-settings.js +33 -0
  86. package/dist/apis/email-template.cjs +33 -0
  87. package/dist/apis/email-template.d.cts +18 -0
  88. package/dist/apis/email-template.d.ts +18 -0
  89. package/dist/apis/email-template.js +33 -0
  90. package/dist/apis/entity-mapping.cjs +33 -0
  91. package/dist/apis/entity-mapping.d.cts +18 -0
  92. package/dist/apis/entity-mapping.d.ts +18 -0
  93. package/dist/apis/entity-mapping.js +33 -0
  94. package/dist/apis/entity.cjs +33 -0
  95. package/dist/apis/entity.d.cts +18 -0
  96. package/dist/apis/entity.d.ts +18 -0
  97. package/dist/apis/entity.js +33 -0
  98. package/dist/apis/environments.cjs +33 -0
  99. package/dist/apis/environments.d.cts +18 -0
  100. package/dist/apis/environments.d.ts +18 -0
  101. package/dist/apis/environments.js +33 -0
  102. package/dist/apis/erp-integration.cjs +33 -0
  103. package/dist/apis/erp-integration.d.cts +18 -0
  104. package/dist/apis/erp-integration.d.ts +18 -0
  105. package/dist/apis/erp-integration.js +33 -0
  106. package/dist/apis/event-catalog.cjs +33 -0
  107. package/dist/apis/event-catalog.d.cts +18 -0
  108. package/dist/apis/event-catalog.d.ts +18 -0
  109. package/dist/apis/event-catalog.js +33 -0
  110. package/dist/apis/file.cjs +33 -0
  111. package/dist/apis/file.d.cts +18 -0
  112. package/dist/apis/file.d.ts +18 -0
  113. package/dist/apis/file.js +33 -0
  114. package/dist/apis/iban.cjs +33 -0
  115. package/dist/apis/iban.d.cts +18 -0
  116. package/dist/apis/iban.d.ts +18 -0
  117. package/dist/apis/iban.js +33 -0
  118. package/dist/apis/journey.cjs +33 -0
  119. package/dist/apis/journey.d.cts +18 -0
  120. package/dist/apis/journey.d.ts +18 -0
  121. package/dist/apis/journey.js +33 -0
  122. package/dist/apis/kanban.cjs +33 -0
  123. package/dist/apis/kanban.d.cts +18 -0
  124. package/dist/apis/kanban.d.ts +18 -0
  125. package/dist/apis/kanban.js +33 -0
  126. package/dist/apis/message.cjs +33 -0
  127. package/dist/apis/message.d.cts +18 -0
  128. package/dist/apis/message.d.ts +18 -0
  129. package/dist/apis/message.js +33 -0
  130. package/dist/apis/metering.cjs +33 -0
  131. package/dist/apis/metering.d.cts +18 -0
  132. package/dist/apis/metering.d.ts +18 -0
  133. package/dist/apis/metering.js +33 -0
  134. package/dist/apis/notes.cjs +33 -0
  135. package/dist/apis/notes.d.cts +18 -0
  136. package/dist/apis/notes.d.ts +18 -0
  137. package/dist/apis/notes.js +33 -0
  138. package/dist/apis/notification.cjs +33 -0
  139. package/dist/apis/notification.d.cts +18 -0
  140. package/dist/apis/notification.d.ts +18 -0
  141. package/dist/apis/notification.js +33 -0
  142. package/dist/apis/organization.cjs +33 -0
  143. package/dist/apis/organization.d.cts +18 -0
  144. package/dist/apis/organization.d.ts +18 -0
  145. package/dist/apis/organization.js +33 -0
  146. package/dist/apis/partner-directory.cjs +33 -0
  147. package/dist/apis/partner-directory.d.cts +18 -0
  148. package/dist/apis/partner-directory.d.ts +18 -0
  149. package/dist/apis/partner-directory.js +33 -0
  150. package/dist/apis/permissions.cjs +33 -0
  151. package/dist/apis/permissions.d.cts +18 -0
  152. package/dist/apis/permissions.d.ts +18 -0
  153. package/dist/apis/permissions.js +33 -0
  154. package/dist/apis/pricing-tier.cjs +33 -0
  155. package/dist/apis/pricing-tier.d.cts +18 -0
  156. package/dist/apis/pricing-tier.d.ts +18 -0
  157. package/dist/apis/pricing-tier.js +33 -0
  158. package/dist/apis/pricing.cjs +33 -0
  159. package/dist/apis/pricing.d.cts +18 -0
  160. package/dist/apis/pricing.d.ts +18 -0
  161. package/dist/apis/pricing.js +33 -0
  162. package/dist/apis/purpose.cjs +33 -0
  163. package/dist/apis/purpose.d.cts +18 -0
  164. package/dist/apis/purpose.d.ts +18 -0
  165. package/dist/apis/purpose.js +33 -0
  166. package/dist/apis/sandbox.cjs +33 -0
  167. package/dist/apis/sandbox.d.cts +18 -0
  168. package/dist/apis/sandbox.d.ts +18 -0
  169. package/dist/apis/sandbox.js +33 -0
  170. package/dist/apis/submission.cjs +33 -0
  171. package/dist/apis/submission.d.cts +18 -0
  172. package/dist/apis/submission.d.ts +18 -0
  173. package/dist/apis/submission.js +33 -0
  174. package/dist/apis/targeting.cjs +33 -0
  175. package/dist/apis/targeting.d.cts +18 -0
  176. package/dist/apis/targeting.d.ts +18 -0
  177. package/dist/apis/targeting.js +33 -0
  178. package/dist/apis/template-variables.cjs +33 -0
  179. package/dist/apis/template-variables.d.cts +18 -0
  180. package/dist/apis/template-variables.d.ts +18 -0
  181. package/dist/apis/template-variables.js +33 -0
  182. package/dist/apis/user.cjs +33 -0
  183. package/dist/apis/user.d.cts +18 -0
  184. package/dist/apis/user.d.ts +18 -0
  185. package/dist/apis/user.js +33 -0
  186. package/dist/apis/validation-rules.cjs +33 -0
  187. package/dist/apis/validation-rules.d.cts +18 -0
  188. package/dist/apis/validation-rules.d.ts +18 -0
  189. package/dist/apis/validation-rules.js +33 -0
  190. package/dist/apis/webhooks.cjs +33 -0
  191. package/dist/apis/webhooks.d.cts +18 -0
  192. package/dist/apis/webhooks.d.ts +18 -0
  193. package/dist/apis/webhooks.js +33 -0
  194. package/dist/apis/workflow-definition.cjs +33 -0
  195. package/dist/apis/workflow-definition.d.cts +18 -0
  196. package/dist/apis/workflow-definition.d.ts +18 -0
  197. package/dist/apis/workflow-definition.js +33 -0
  198. package/dist/apis/workflow.cjs +33 -0
  199. package/dist/apis/workflow.d.cts +18 -0
  200. package/dist/apis/workflow.d.ts +18 -0
  201. package/dist/apis/workflow.js +33 -0
  202. package/dist/app-UUTBO3WJ.js +573 -0
  203. package/dist/app-XJGY6SHO.cjs +573 -0
  204. package/dist/app.d-Uncn387s.d.cts +3370 -0
  205. package/dist/app.d-Uncn387s.d.ts +3370 -0
  206. package/dist/audit-logs-4IJYIOXF.js +55 -0
  207. package/dist/audit-logs-UWLCPBB4.cjs +55 -0
  208. package/dist/audit-logs.d-BxZqONu5.d.cts +288 -0
  209. package/dist/audit-logs.d-BxZqONu5.d.ts +288 -0
  210. package/dist/automation-4UQADTDO.cjs +282 -0
  211. package/dist/automation-PVXTQLZX.js +282 -0
  212. package/dist/automation.d-BteCzeFn.d.cts +4921 -0
  213. package/dist/automation.d-BteCzeFn.d.ts +4921 -0
  214. package/dist/billing-FI4V4UX5.cjs +175 -0
  215. package/dist/billing-OMWNJHGW.js +175 -0
  216. package/dist/billing.d-BH4__05Y.d.cts +994 -0
  217. package/dist/billing.d-BH4__05Y.d.ts +994 -0
  218. package/dist/bin/cli.js +135 -0
  219. package/dist/blueprint-manifest-CPQAL76N.cjs +504 -0
  220. package/dist/blueprint-manifest-FIMGDHSH.js +504 -0
  221. package/dist/blueprint-manifest.d-CU4v09fj.d.cts +3327 -0
  222. package/dist/blueprint-manifest.d-CU4v09fj.d.ts +3327 -0
  223. package/dist/chunk-3RG5ZIWI.js +10 -0
  224. package/dist/chunk-OBGZSXTJ.cjs +10 -0
  225. package/dist/chunk-UJTFRZMS.js +65 -0
  226. package/dist/chunk-YLLKMXS3.cjs +65 -0
  227. package/dist/consent-NHDCDJMK.js +84 -0
  228. package/dist/consent-R5GU3WCK.cjs +84 -0
  229. package/dist/consent.d-BETWwU_2.d.cts +266 -0
  230. package/dist/consent.d-BETWwU_2.d.ts +266 -0
  231. package/dist/customer-portal-6AV2W43T.cjs +2252 -0
  232. package/dist/customer-portal-EY57GJYV.js +2252 -0
  233. package/dist/customer-portal.d-Co_I6psR.d.cts +15255 -0
  234. package/dist/customer-portal.d-Co_I6psR.d.ts +15255 -0
  235. package/dist/data-management-ILQUYNTN.cjs +240 -0
  236. package/dist/data-management-QMXOLOEG.js +240 -0
  237. package/dist/data-management.d-CkR2E_Pm.d.cts +548 -0
  238. package/dist/data-management.d-CkR2E_Pm.d.ts +548 -0
  239. package/dist/deduplication-IVXANO7S.cjs +42 -0
  240. package/dist/deduplication-WN45DVK3.js +42 -0
  241. package/dist/deduplication.d-BlHnjhXk.d.cts +114 -0
  242. package/dist/deduplication.d-BlHnjhXk.d.ts +114 -0
  243. package/dist/design-ONRLY6XI.cjs +219 -0
  244. package/dist/design-UHMRO3PG.js +219 -0
  245. package/dist/design.d-JsNY_cGh.d.cts +834 -0
  246. package/dist/design.d-JsNY_cGh.d.ts +834 -0
  247. package/dist/discussion-4CZIG3ZM.cjs +134 -0
  248. package/dist/discussion-VWMWL2AF.js +134 -0
  249. package/dist/discussion.d-CxxaYKTf.d.cts +580 -0
  250. package/dist/discussion.d-CxxaYKTf.d.ts +580 -0
  251. package/dist/document-CN3JNXFF.js +78 -0
  252. package/dist/document-PCKNZA4K.cjs +78 -0
  253. package/dist/document.d-CZ_FGhEn.d.cts +649 -0
  254. package/dist/document.d-CZ_FGhEn.d.ts +649 -0
  255. package/dist/email-settings-ANURQMKZ.js +533 -0
  256. package/dist/email-settings-YE2XB2ZU.cjs +533 -0
  257. package/dist/email-settings.d-3eXYEyRr.d.cts +2278 -0
  258. package/dist/email-settings.d-3eXYEyRr.d.ts +2278 -0
  259. package/dist/email-template-4QI4YS4J.js +122 -0
  260. package/dist/email-template-BUJBC6HH.cjs +122 -0
  261. package/dist/email-template.d-C2L0dKqB.d.cts +1175 -0
  262. package/dist/email-template.d-C2L0dKqB.d.ts +1175 -0
  263. package/dist/entity-BCFE3UJT.cjs +1600 -0
  264. package/dist/entity-VEXNQC4Y.js +1600 -0
  265. package/dist/entity-mapping-PHRLSYP7.cjs +215 -0
  266. package/dist/entity-mapping-QK7MGNAW.js +215 -0
  267. package/dist/entity-mapping.d-B3Vyepok.d.cts +1093 -0
  268. package/dist/entity-mapping.d-B3Vyepok.d.ts +1093 -0
  269. package/dist/entity.d-DmER_7q5.d.cts +16018 -0
  270. package/dist/entity.d-DmER_7q5.d.ts +16018 -0
  271. package/dist/environments-266S44UM.cjs +71 -0
  272. package/dist/environments-AV7W6SLT.js +71 -0
  273. package/dist/environments.d-CpILpSNF.d.cts +254 -0
  274. package/dist/environments.d-CpILpSNF.d.ts +254 -0
  275. package/dist/erp-integration-5WNBCGWS.cjs +586 -0
  276. package/dist/erp-integration-EMI5WIWA.js +586 -0
  277. package/dist/erp-integration.d-DmxUZOUQ.d.cts +4120 -0
  278. package/dist/erp-integration.d-DmxUZOUQ.d.ts +4120 -0
  279. package/dist/event-catalog-DBWYKQ6J.cjs +130 -0
  280. package/dist/event-catalog-KKMXV5LB.js +130 -0
  281. package/dist/event-catalog.d-B2tq20gn.d.cts +1512 -0
  282. package/dist/event-catalog.d-B2tq20gn.d.ts +1512 -0
  283. package/dist/file-3ZLMS6TL.js +573 -0
  284. package/dist/file-Q66N5XMG.cjs +573 -0
  285. package/dist/file.d-Bi0EZkNu.d.cts +2993 -0
  286. package/dist/file.d-Bi0EZkNu.d.ts +2993 -0
  287. package/dist/iban-HSXVSIFW.cjs +43 -0
  288. package/dist/iban-Q27INTOC.js +43 -0
  289. package/dist/iban.d-DP7hl0Qt.d.cts +71 -0
  290. package/dist/iban.d-DP7hl0Qt.d.ts +71 -0
  291. package/dist/index.cjs +563 -0
  292. package/dist/index.d.cts +119 -0
  293. package/dist/index.d.ts +119 -0
  294. package/dist/index.js +563 -0
  295. package/dist/journey-DGKXVWZQ.js +270 -0
  296. package/dist/journey-T2Y72EBS.cjs +270 -0
  297. package/dist/journey.d-DxL16X6N.d.cts +1794 -0
  298. package/dist/journey.d-DxL16X6N.d.ts +1794 -0
  299. package/dist/kanban-A4B6RCJ2.cjs +164 -0
  300. package/dist/kanban-PP6WJVT2.js +164 -0
  301. package/dist/kanban.d-DDrBwr9h.d.cts +631 -0
  302. package/dist/kanban.d-DDrBwr9h.d.ts +631 -0
  303. package/dist/message-D6JY4GJH.cjs +673 -0
  304. package/dist/message-HFX2DDCV.js +673 -0
  305. package/dist/message.d-BeBH6vof.d.cts +3580 -0
  306. package/dist/message.d-BeBH6vof.d.ts +3580 -0
  307. package/dist/metering-63MJFCS2.cjs +399 -0
  308. package/dist/metering-F63PNFCZ.js +399 -0
  309. package/dist/metering.d-D5VR4tVa.d.cts +1842 -0
  310. package/dist/metering.d-D5VR4tVa.d.ts +1842 -0
  311. package/dist/notes-FTL5H4JE.cjs +219 -0
  312. package/dist/notes-GMWTQCMB.js +219 -0
  313. package/dist/notes.d-DZYeVo0I.d.cts +1047 -0
  314. package/dist/notes.d-DZYeVo0I.d.ts +1047 -0
  315. package/dist/notification-WXFSOORN.cjs +237 -0
  316. package/dist/notification-XHG3TIBW.js +237 -0
  317. package/dist/notification.d-BJwdFZnG.d.cts +1148 -0
  318. package/dist/notification.d-BJwdFZnG.d.ts +1148 -0
  319. package/dist/organization-CPXTUDJO.js +118 -0
  320. package/dist/organization-XIFV7MWP.cjs +118 -0
  321. package/dist/organization.d-DfUcuwKM.d.cts +629 -0
  322. package/dist/organization.d-DfUcuwKM.d.ts +629 -0
  323. package/dist/partner-directory-4WCHPJRO.js +282 -0
  324. package/dist/partner-directory-FKWPPO7F.cjs +282 -0
  325. package/dist/partner-directory.d-BRRDHFcz.d.cts +1511 -0
  326. package/dist/partner-directory.d-BRRDHFcz.d.ts +1511 -0
  327. package/dist/permissions-5E36GPG3.js +178 -0
  328. package/dist/permissions-PBTK5CCD.cjs +178 -0
  329. package/dist/permissions.d-CL7SwMFy.d.cts +1253 -0
  330. package/dist/permissions.d-CL7SwMFy.d.ts +1253 -0
  331. package/dist/pricing-FDWEBIQU.js +439 -0
  332. package/dist/pricing-FZQKL4DW.cjs +439 -0
  333. package/dist/pricing-tier-34O624R4.js +36 -0
  334. package/dist/pricing-tier-F4HE6WIM.cjs +36 -0
  335. package/dist/pricing-tier.d-VuH-NtlR.d.cts +82 -0
  336. package/dist/pricing-tier.d-VuH-NtlR.d.ts +82 -0
  337. package/dist/pricing.d-Dd1CaSX_.d.cts +12201 -0
  338. package/dist/pricing.d-Dd1CaSX_.d.ts +12201 -0
  339. package/dist/purpose-47HJIG2Q.cjs +180 -0
  340. package/dist/purpose-MX33NU5H.js +180 -0
  341. package/dist/purpose.d-D8YCSqt9.d.cts +373 -0
  342. package/dist/purpose.d-D8YCSqt9.d.ts +373 -0
  343. package/dist/sandbox-7QNLGFN2.cjs +100 -0
  344. package/dist/sandbox-TZCXHBJN.js +100 -0
  345. package/dist/sandbox.d-D1NgPMEc.d.cts +466 -0
  346. package/dist/sandbox.d-D1NgPMEc.d.ts +466 -0
  347. package/dist/submission-6LSPBI27.js +55 -0
  348. package/dist/submission-DBQNDJ4B.cjs +55 -0
  349. package/dist/submission.d-e9MPrbY1.d.cts +470 -0
  350. package/dist/submission.d-e9MPrbY1.d.ts +470 -0
  351. package/dist/targeting-HZRCLNIF.cjs +275 -0
  352. package/dist/targeting-MTQ6JBCY.js +275 -0
  353. package/dist/targeting.d-1GW3nh-y.d.cts +2058 -0
  354. package/dist/targeting.d-1GW3nh-y.d.ts +2058 -0
  355. package/dist/template-variables-S6IXK7SF.js +159 -0
  356. package/dist/template-variables-VPNIMC7L.cjs +159 -0
  357. package/dist/template-variables.d-CqqGe3sd.d.cts +1315 -0
  358. package/dist/template-variables.d-CqqGe3sd.d.ts +1315 -0
  359. package/dist/types-C5cGIwtq.d.cts +28 -0
  360. package/dist/types-C5cGIwtq.d.ts +28 -0
  361. package/dist/user-BHH4DAA5.cjs +488 -0
  362. package/dist/user-KBXFVRPI.js +488 -0
  363. package/dist/user.d-CWBgUia2.d.cts +2199 -0
  364. package/dist/user.d-CWBgUia2.d.ts +2199 -0
  365. package/dist/validation-rules-4V7KAWGW.cjs +120 -0
  366. package/dist/validation-rules-UGQY4ASY.js +120 -0
  367. package/dist/validation-rules.d-CMSvveua.d.cts +808 -0
  368. package/dist/validation-rules.d-CMSvveua.d.ts +808 -0
  369. package/dist/webhooks-JR475VD4.js +252 -0
  370. package/dist/webhooks-X64U3KCB.cjs +252 -0
  371. package/dist/webhooks.d-Bzl-u_Zs.d.cts +1201 -0
  372. package/dist/webhooks.d-Bzl-u_Zs.d.ts +1201 -0
  373. package/dist/workflow-7ANPQZDP.cjs +402 -0
  374. package/dist/workflow-DWSAHA5Q.js +402 -0
  375. package/dist/workflow-definition-2M3JBCUI.cjs +342 -0
  376. package/dist/workflow-definition-WLPGEU55.js +342 -0
  377. package/dist/workflow-definition.d-BKmIy2Qp.d.cts +2030 -0
  378. package/dist/workflow-definition.d-BKmIy2Qp.d.ts +2030 -0
  379. package/dist/workflow.d-DElz0XoQ.d.cts +3017 -0
  380. package/dist/workflow.d-DElz0XoQ.d.ts +3017 -0
  381. package/package.json +289 -0
@@ -0,0 +1,2278 @@
1
+ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
+
3
+ /* eslint-disable */
4
+ /* Auto-copied from email-settings-client */
5
+ /* eslint-disable */
6
+
7
+
8
+
9
+ declare namespace Components {
10
+ namespace Parameters {
11
+ export type EmailAddressId = string;
12
+ export type SharedInboxId = string;
13
+ }
14
+ export interface PathParameters {
15
+ EmailAddressId?: Parameters.EmailAddressId;
16
+ SharedInboxId?: Parameters.SharedInboxId;
17
+ }
18
+ namespace Responses {
19
+ export type BadRequest = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
20
+ export type Conflict = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
21
+ export type CreateEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
22
+ export type CreateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
23
+ export type Forbidden = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
24
+ export type GetEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
25
+ export type GetSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
26
+ export type InternalServerError = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
27
+ export type ListEmailAddressesSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse[];
28
+ export type ListInboxBucketsSuccessResponse = /* Inbox bucket representing the storage container for a shared inbox. */ Schemas.InboxBucketResponse[];
29
+ export type ListSharedInboxesSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse[];
30
+ export interface NoContent {
31
+ }
32
+ export type NotFound = /* Standard error response format for all API errors. */ Schemas.ErrorResponse;
33
+ export type OutlookErrorResponse = Schemas.OutlookConnectionError;
34
+ export type ProvisionEpilotEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
35
+ export type SetEmailAddressPrimarySuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
36
+ export type UpdateEmailAddressSuccessResponse = /* Email address configuration with all associated metadata. */ Schemas.EmailAddressResponse;
37
+ export type UpdateSharedInboxSuccessResponse = /* Shared inbox configuration with all associated metadata. */ Schemas.SharedInboxResponse;
38
+ }
39
+ namespace Schemas {
40
+ /**
41
+ * Mapping between an Outlook email and its Outlook Connection.
42
+ * This tracks which provider/tenant provisions each Outlook email.
43
+ *
44
+ */
45
+ export interface ConnectedOutlookEmail {
46
+ /**
47
+ * The Outlook shared mailbox email address
48
+ */
49
+ outlook_email: string; // email
50
+ /**
51
+ * Azure AD Tenant ID that provisions this mailbox
52
+ */
53
+ tenant_id?: string;
54
+ /**
55
+ * Provider type (for future extensibility)
56
+ */
57
+ provider?: "outlook";
58
+ /**
59
+ * When the mailbox was connected
60
+ */
61
+ connected_at?: string; // date-time
62
+ /**
63
+ * User who connected this mailbox
64
+ */
65
+ connected_by_user_id?: string;
66
+ }
67
+ /**
68
+ * Request payload for creating a new email address.
69
+ */
70
+ export interface CreateEmailAddressPayload {
71
+ /**
72
+ * The email address to add (e.g., from a custom domain or external provider)
73
+ * example:
74
+ * support@yourcompany.com
75
+ */
76
+ address: string;
77
+ /**
78
+ * Display name shown as the sender name in emails
79
+ * example:
80
+ * Customer Support
81
+ */
82
+ name?: string;
83
+ /**
84
+ * List of user IDs who can send from this address
85
+ * example:
86
+ * [
87
+ * "user-123"
88
+ * ]
89
+ */
90
+ user_ids?: string[];
91
+ /**
92
+ * List of group IDs whose members can send from this address
93
+ * example:
94
+ * [
95
+ * "group-456"
96
+ * ]
97
+ */
98
+ group_ids?: string[];
99
+ /**
100
+ * ID of the signature to use by default when sending from this address
101
+ * example:
102
+ * sig-789
103
+ */
104
+ default_signature_id?: string;
105
+ /**
106
+ * ID of the shared inbox to associate with this address
107
+ * example:
108
+ * inbox-abc
109
+ */
110
+ shared_inbox_id?: string;
111
+ }
112
+ /**
113
+ * Request payload for creating a new shared inbox.
114
+ */
115
+ export interface CreateSharedInboxPayload {
116
+ /**
117
+ * Optional custom ID for the inbox (auto-generated if not provided)
118
+ * example:
119
+ * support-inbox
120
+ */
121
+ id?: string;
122
+ /**
123
+ * Hex color code for visual identification in the UI (required)
124
+ * example:
125
+ * #2196F3
126
+ */
127
+ color: string;
128
+ /**
129
+ * Display name of the shared inbox (required)
130
+ * example:
131
+ * Sales Inquiries
132
+ */
133
+ name: string;
134
+ /**
135
+ * List of user IDs to assign to this inbox
136
+ * example:
137
+ * [
138
+ * "user-123",
139
+ * "user-456"
140
+ * ]
141
+ */
142
+ assignees?: string[];
143
+ /**
144
+ * Optional description of the inbox purpose
145
+ * example:
146
+ * Inbound sales and pricing requests
147
+ */
148
+ description?: string;
149
+ }
150
+ /**
151
+ * Custom email domain configuration.
152
+ */
153
+ export interface Domain {
154
+ /**
155
+ * The domain name to add or verify. Can be a root domain or subdomain.
156
+ * Examples: "yourcompany.com", "mail.yourcompany.com"
157
+ *
158
+ * example:
159
+ * mail.yourcompany.com
160
+ */
161
+ domain?: string;
162
+ }
163
+ /**
164
+ * Email address configuration with all associated metadata.
165
+ */
166
+ export interface EmailAddressResponse {
167
+ /**
168
+ * Unique identifier (UUID) for the resource
169
+ * example:
170
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
171
+ */
172
+ id: string;
173
+ /**
174
+ * Timestamp when the resource was created
175
+ * example:
176
+ * 2024-01-15T10:30:00Z
177
+ */
178
+ created_at: string; // date-time
179
+ /**
180
+ * Timestamp when the resource was last updated
181
+ * example:
182
+ * 2024-01-20T14:45:00Z
183
+ */
184
+ updated_at?: string; // date-time
185
+ /**
186
+ * User ID of the user who created the resource
187
+ * example:
188
+ * user-123
189
+ */
190
+ created_by?: string;
191
+ /**
192
+ * User ID of the user who last updated the resource
193
+ * example:
194
+ * user-456
195
+ */
196
+ updated_by?: string;
197
+ /**
198
+ * The email address string
199
+ * example:
200
+ * sales@yourcompany.com
201
+ */
202
+ address: string;
203
+ /**
204
+ * Display name shown as the sender name
205
+ * example:
206
+ * Sales Team
207
+ */
208
+ name?: string;
209
+ /**
210
+ * IDs of users who can send from this address
211
+ * example:
212
+ * [
213
+ * "user-123",
214
+ * "user-456"
215
+ * ]
216
+ */
217
+ user_ids?: string[];
218
+ /**
219
+ * IDs of groups whose members can send from this address
220
+ * example:
221
+ * [
222
+ * "group-789"
223
+ * ]
224
+ */
225
+ group_ids?: string[];
226
+ /**
227
+ * ID of the default signature for this address
228
+ * example:
229
+ * sig-abc
230
+ */
231
+ default_signature_id?: string;
232
+ /**
233
+ * ID of the associated shared inbox
234
+ * example:
235
+ * inbox-xyz
236
+ */
237
+ shared_inbox_id?: string;
238
+ /**
239
+ * Whether the address is currently active for sending
240
+ * example:
241
+ * true
242
+ */
243
+ is_active?: boolean;
244
+ /**
245
+ * Whether this is the organization's primary email address
246
+ * example:
247
+ * false
248
+ */
249
+ is_primary?: boolean;
250
+ /**
251
+ * Whether this is an epilot-managed address (@epilot.cloud)
252
+ * example:
253
+ * false
254
+ */
255
+ is_epilot_email_address?: boolean;
256
+ }
257
+ /**
258
+ * Setting that allows to add an email address on the custom domain. For e.g; john@doe.com
259
+ */
260
+ export type EmailAddressSetting = "email_address";
261
+ /**
262
+ * Setting that allows to add a custom domain. For e.g; doe.com
263
+ */
264
+ export type EmailDomainSetting = "email_domain";
265
+ /**
266
+ * Standard error response format for all API errors.
267
+ */
268
+ export interface ErrorResponse {
269
+ /**
270
+ * Human-readable error message describing what went wrong
271
+ * example:
272
+ * Resource not found
273
+ */
274
+ error: string;
275
+ /**
276
+ * HTTP status code of the error
277
+ * example:
278
+ * 404
279
+ */
280
+ status: number;
281
+ }
282
+ /**
283
+ * Inbox bucket representing the storage container for a shared inbox.
284
+ */
285
+ export interface InboxBucketResponse {
286
+ /**
287
+ * Unique identifier of the bucket
288
+ * example:
289
+ * bucket-abc
290
+ */
291
+ id: string;
292
+ /**
293
+ * ID of the shared inbox associated with this bucket
294
+ * example:
295
+ * inbox-xyz
296
+ */
297
+ inbox_id: string;
298
+ }
299
+ export type MailboxSyncFolderStatuses = "PENDING" | "RUNNING" | "COMPLETED" | "FAILED" | "SKIPPED";
300
+ export interface MailboxSyncStatus {
301
+ execution_id: string;
302
+ status: MailboxSyncStatuses;
303
+ timeframe: MailboxSyncTimeframePeriods;
304
+ started_at: string; // date-time
305
+ completed_at?: string; // date-time
306
+ inbox?: {
307
+ status?: MailboxSyncFolderStatuses;
308
+ total_messages?: number;
309
+ processed_messages?: number;
310
+ failed_messages?: number;
311
+ };
312
+ sent_items?: {
313
+ status?: MailboxSyncFolderStatuses;
314
+ total_messages?: number;
315
+ processed_messages?: number;
316
+ failed_messages?: number;
317
+ };
318
+ }
319
+ export type MailboxSyncStatuses = "RUNNING" | "COMPLETED" | "COMPLETED_WITH_ERRORS" | "FAILED" | "CANCELLED";
320
+ export type MailboxSyncTimeframePeriods = "5m" | "1w" | "2w" | "1m";
321
+ export interface OutlookConnectionError {
322
+ /**
323
+ * Error code or message from the OAuth flow.
324
+ */
325
+ error: string;
326
+ /**
327
+ * Human-readable description of the error.
328
+ */
329
+ error_description?: string;
330
+ /**
331
+ * URL for tenant admin to grant consent, if applicable.
332
+ */
333
+ admin_consent_url?: string; // uri
334
+ }
335
+ export interface OutlookConnectionStatus {
336
+ /**
337
+ * Current connection status:
338
+ * - pending_auth: Admin consent granted, waiting for user OAuth
339
+ * - connected: Fully connected with valid tokens
340
+ * - expired: Tokens expired, need to re-authenticate
341
+ * - not_connected: No connection, initiate OAuth
342
+ *
343
+ */
344
+ status: "connected" | "expired" | "pending_auth" | "not_connected";
345
+ /**
346
+ * Action for UI to take (all call GET /outlook/connect):
347
+ * - connect: No connection, initiate OAuth
348
+ * - authorize: Admin consent done, complete OAuth
349
+ * - reconnect: Re-authenticate expired session
350
+ * - none: Fully connected, no action needed
351
+ *
352
+ */
353
+ action: "connect" | "authorize" | "reconnect" | "none";
354
+ /**
355
+ * Display name of user who connected
356
+ */
357
+ connected_by_display_name?: string;
358
+ /**
359
+ * Email of the user who connected
360
+ */
361
+ connected_by_email?: string; // email
362
+ /**
363
+ * Azure AD Object ID of user who connected
364
+ */
365
+ connected_by_user_id?: string;
366
+ /**
367
+ * When the connection was established
368
+ */
369
+ connected_at?: string; // date-time
370
+ /**
371
+ * When the connection was last updated
372
+ */
373
+ updated_at?: string; // date-time
374
+ /**
375
+ * Microsoft Azure AD tenant ID
376
+ */
377
+ tenant_id: string;
378
+ /**
379
+ * Granted permission scopes
380
+ */
381
+ scopes?: string[];
382
+ /**
383
+ * When the current access token expires
384
+ */
385
+ expires_at?: string; // date-time
386
+ /**
387
+ * Whether the current token is still valid
388
+ */
389
+ is_token_valid?: boolean;
390
+ }
391
+ /**
392
+ * Request payload for provisioning an epilot-managed email address.
393
+ */
394
+ export interface ProvisionEpilotEmailAddressPayload {
395
+ /**
396
+ * The epilot email address to provision (must be on @epilot.cloud domain)
397
+ * example:
398
+ * mycompany@epilot.cloud
399
+ */
400
+ address: string;
401
+ }
402
+ /**
403
+ * - Restrict duplicates within:
404
+ * * 10s
405
+ * * 5m
406
+ * * 1d
407
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
408
+ * - Defaults to 3 minutes
409
+ * - Negative values will be treated same as positive values
410
+ * - If not set, defaults to 3 min
411
+ * - If set as 0, then the no email will be treated as a duplicate
412
+ * - Cannot have multiple values
413
+ *
414
+ */
415
+ export type RestrictDuplicatesWithinSetting = "restrict_duplicates_within";
416
+ /**
417
+ * Request payload for setting an email address as the organization's primary address.
418
+ */
419
+ export interface SetEmailAddressPrimaryPayload {
420
+ /**
421
+ * The email address to set as primary
422
+ * example:
423
+ * sales@yourcompany.com
424
+ */
425
+ address: string;
426
+ }
427
+ /**
428
+ * Generic setting object used for various email configuration types.
429
+ * The applicable fields depend on the setting type:
430
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
431
+ * - **email_domain**: Uses `value` (domain name)
432
+ * - **whitelist_email_address**: Uses `value` (email address)
433
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
434
+ *
435
+ */
436
+ export interface Setting {
437
+ [name: string]: any;
438
+ /**
439
+ * Unique identifier of the setting
440
+ * example:
441
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
442
+ */
443
+ id?: string;
444
+ /**
445
+ * Display name of the setting (used for signatures)
446
+ * example:
447
+ * Default Signature
448
+ */
449
+ name?: string;
450
+ /**
451
+ * Organization ID that owns this setting
452
+ * example:
453
+ * org-123
454
+ */
455
+ org_id?: string;
456
+ type: SettingType;
457
+ /**
458
+ * The setting value. Interpretation depends on type:
459
+ * - signature: Plain text version of the signature
460
+ * - email_domain: Domain name (e.g., "yourcompany.com")
461
+ * - whitelist_email_address: Email address to whitelist
462
+ * - restrict_duplicates_within: Time duration (e.g., "5m", "1d")
463
+ *
464
+ * example:
465
+ * Best regards, The Team
466
+ */
467
+ value?: string;
468
+ /**
469
+ * HTML content (only applicable for signature type)
470
+ * example:
471
+ * <p>Best regards,<br/><strong>The Team</strong></p>
472
+ */
473
+ html?: string;
474
+ /**
475
+ * ISO 8601 timestamp when the setting was created
476
+ * example:
477
+ * 2024-01-15T10:30:00Z
478
+ */
479
+ created_at?: string;
480
+ /**
481
+ * ISO 8601 timestamp when the setting was last updated
482
+ * example:
483
+ * 2024-01-20T14:45:00Z
484
+ */
485
+ updated_at?: string;
486
+ /**
487
+ * User ID of the creator
488
+ * example:
489
+ * user-123
490
+ */
491
+ created_by?: string;
492
+ /**
493
+ * User ID of the last editor
494
+ * example:
495
+ * user-456
496
+ */
497
+ updated_by?: string;
498
+ }
499
+ /**
500
+ * Common metadata fields for all settings and resources.
501
+ */
502
+ export interface SettingMeta {
503
+ /**
504
+ * Unique identifier (UUID) for the resource
505
+ * example:
506
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
507
+ */
508
+ id: string;
509
+ /**
510
+ * Timestamp when the resource was created
511
+ * example:
512
+ * 2024-01-15T10:30:00Z
513
+ */
514
+ created_at: string; // date-time
515
+ /**
516
+ * Timestamp when the resource was last updated
517
+ * example:
518
+ * 2024-01-20T14:45:00Z
519
+ */
520
+ updated_at?: string; // date-time
521
+ /**
522
+ * User ID of the user who created the resource
523
+ * example:
524
+ * user-123
525
+ */
526
+ created_by?: string;
527
+ /**
528
+ * User ID of the user who last updated the resource
529
+ * example:
530
+ * user-456
531
+ */
532
+ updated_by?: string;
533
+ }
534
+ export type SettingType = /* Setting that allows to add a signature. */ SignatureSetting | /* Setting that allows to add a custom domain. For e.g; doe.com */ EmailDomainSetting | /* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com */ EmailAddressSetting | /**
535
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
536
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
537
+ *
538
+ */
539
+ WhitelistEmailAddressSetting | /**
540
+ * - Restrict duplicates within:
541
+ * * 10s
542
+ * * 5m
543
+ * * 1d
544
+ * * 5000 // It converts to 5 seconds.When expressed as a numerical value, it will be interpreted as being in milliseconds.
545
+ * - Defaults to 3 minutes
546
+ * - Negative values will be treated same as positive values
547
+ * - If not set, defaults to 3 min
548
+ * - If set as 0, then the no email will be treated as a duplicate
549
+ * - Cannot have multiple values
550
+ *
551
+ */
552
+ RestrictDuplicatesWithinSetting;
553
+ export type SettingsResponse = /**
554
+ * Generic setting object used for various email configuration types.
555
+ * The applicable fields depend on the setting type:
556
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
557
+ * - **email_domain**: Uses `value` (domain name)
558
+ * - **whitelist_email_address**: Uses `value` (email address)
559
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
560
+ *
561
+ */
562
+ Setting[] | /**
563
+ * Generic setting object used for various email configuration types.
564
+ * The applicable fields depend on the setting type:
565
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
566
+ * - **email_domain**: Uses `value` (domain name)
567
+ * - **whitelist_email_address**: Uses `value` (email address)
568
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
569
+ *
570
+ */
571
+ Setting;
572
+ /**
573
+ * Shared inbox configuration with all associated metadata.
574
+ */
575
+ export interface SharedInboxResponse {
576
+ /**
577
+ * Unique identifier of the shared inbox
578
+ * example:
579
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
580
+ */
581
+ id: string;
582
+ /**
583
+ * Timestamp when the resource was created
584
+ * example:
585
+ * 2024-01-15T10:30:00Z
586
+ */
587
+ created_at: string; // date-time
588
+ /**
589
+ * Timestamp when the resource was last updated
590
+ * example:
591
+ * 2024-01-20T14:45:00Z
592
+ */
593
+ updated_at?: string; // date-time
594
+ /**
595
+ * User ID of the user who created the resource
596
+ * example:
597
+ * user-123
598
+ */
599
+ created_by?: string;
600
+ /**
601
+ * User ID of the user who last updated the resource
602
+ * example:
603
+ * user-456
604
+ */
605
+ updated_by?: string;
606
+ /**
607
+ * Display name of the shared inbox
608
+ * example:
609
+ * Customer Support
610
+ */
611
+ name: string;
612
+ /**
613
+ * Hex color code for visual identification
614
+ * example:
615
+ * #4CAF50
616
+ */
617
+ color: string;
618
+ /**
619
+ * List of user IDs assigned to this inbox
620
+ * example:
621
+ * [
622
+ * "user-123",
623
+ * "user-456"
624
+ * ]
625
+ */
626
+ assignees: string[];
627
+ /**
628
+ * Description of the inbox purpose
629
+ * example:
630
+ * Incoming customer support requests
631
+ */
632
+ description?: string;
633
+ /**
634
+ * ID of the associated storage bucket for messages
635
+ * example:
636
+ * bucket-xyz
637
+ */
638
+ bucket_id: string;
639
+ }
640
+ /**
641
+ * Setting that allows to add a signature.
642
+ */
643
+ export type SignatureSetting = "signature";
644
+ /**
645
+ * Request payload for updating an email address configuration.
646
+ * All fields are optional; only provided fields will be updated.
647
+ *
648
+ */
649
+ export interface UpdateEmailAddressPayload {
650
+ /**
651
+ * Display name shown as the sender name in emails
652
+ * example:
653
+ * Sales Team
654
+ */
655
+ name?: string;
656
+ /**
657
+ * List of user IDs who can send from this address
658
+ * example:
659
+ * [
660
+ * "user-123",
661
+ * "user-456"
662
+ * ]
663
+ */
664
+ user_ids?: string[];
665
+ /**
666
+ * List of group IDs whose members can send from this address
667
+ * example:
668
+ * [
669
+ * "group-789"
670
+ * ]
671
+ */
672
+ group_ids?: string[];
673
+ /**
674
+ * ID of the signature to use by default when sending from this address
675
+ * example:
676
+ * sig-abc
677
+ */
678
+ default_signature_id?: string;
679
+ /**
680
+ * ID of the shared inbox to associate with this address
681
+ * example:
682
+ * inbox-xyz
683
+ */
684
+ shared_inbox_id?: string;
685
+ /**
686
+ * Whether the email address is active and can be used for sending
687
+ * example:
688
+ * true
689
+ */
690
+ is_active?: boolean;
691
+ }
692
+ /**
693
+ * Request payload for updating a shared inbox configuration.
694
+ * All fields are optional; only provided fields will be updated.
695
+ *
696
+ */
697
+ export interface UpdateSharedInboxPayload {
698
+ /**
699
+ * Hex color code for visual identification in the UI
700
+ * example:
701
+ * #4CAF50
702
+ */
703
+ color?: string;
704
+ /**
705
+ * Display name of the shared inbox
706
+ * example:
707
+ * Customer Support
708
+ */
709
+ name?: string;
710
+ /**
711
+ * List of user IDs assigned to this inbox
712
+ * example:
713
+ * [
714
+ * "user-123",
715
+ * "user-456"
716
+ * ]
717
+ */
718
+ assignees?: string[];
719
+ /**
720
+ * Optional description of the inbox purpose
721
+ * example:
722
+ * Incoming customer support requests
723
+ */
724
+ description?: string;
725
+ }
726
+ /**
727
+ * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
728
+ * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
729
+ *
730
+ */
731
+ export type WhitelistEmailAddressSetting = "whitelist_email_address";
732
+ }
733
+ }
734
+ declare namespace Paths {
735
+ namespace AddDomain {
736
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
737
+ namespace Responses {
738
+ export type $200 = Components.Schemas.SettingsResponse;
739
+ export type $403 = Components.Responses.Forbidden;
740
+ export type $404 = Components.Responses.NotFound;
741
+ }
742
+ }
743
+ namespace AddEmailAddress {
744
+ export type RequestBody = /* Request payload for creating a new email address. */ Components.Schemas.CreateEmailAddressPayload;
745
+ namespace Responses {
746
+ export type $201 = Components.Responses.CreateEmailAddressSuccessResponse;
747
+ export type $400 = Components.Responses.BadRequest;
748
+ export type $403 = Components.Responses.Forbidden;
749
+ export type $409 = Components.Responses.Conflict;
750
+ export type $500 = Components.Responses.InternalServerError;
751
+ }
752
+ }
753
+ namespace AddSetting {
754
+ export type RequestBody = /**
755
+ * Generic setting object used for various email configuration types.
756
+ * The applicable fields depend on the setting type:
757
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
758
+ * - **email_domain**: Uses `value` (domain name)
759
+ * - **whitelist_email_address**: Uses `value` (email address)
760
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
761
+ *
762
+ */
763
+ Components.Schemas.Setting;
764
+ namespace Responses {
765
+ export type $200 = Components.Schemas.SettingsResponse;
766
+ export type $403 = Components.Responses.Forbidden;
767
+ export type $404 = Components.Responses.NotFound;
768
+ }
769
+ }
770
+ namespace AddSharedInbox {
771
+ export type RequestBody = /* Request payload for creating a new shared inbox. */ Components.Schemas.CreateSharedInboxPayload;
772
+ namespace Responses {
773
+ export type $201 = Components.Responses.CreateSharedInboxSuccessResponse;
774
+ export type $400 = Components.Responses.BadRequest;
775
+ export type $403 = Components.Responses.Forbidden;
776
+ export type $409 = Components.Responses.Conflict;
777
+ export type $500 = Components.Responses.InternalServerError;
778
+ }
779
+ }
780
+ namespace ConnectOutlook {
781
+ namespace Responses {
782
+ export interface $200 {
783
+ authorization_url?: string;
784
+ }
785
+ export type $403 = Components.Responses.OutlookErrorResponse;
786
+ }
787
+ }
788
+ namespace ConnectOutlookMailbox {
789
+ export interface RequestBody {
790
+ /**
791
+ * Email address of the Outlook mailbox to connect
792
+ */
793
+ email: string; // email
794
+ /**
795
+ * Shared inbox ID to associate with the mailbox. Defaults to the default shared inbox.
796
+ */
797
+ shared_inbox_id?: string;
798
+ /**
799
+ * Optional timeframe for initial mailbox sync. When provided, triggers an automatic
800
+ * mailbox sync after connecting the mailbox, syncing emails from the specified period.
801
+ *
802
+ */
803
+ mailboxSyncTimeframe?: "5m" | "1w" | "2w" | "1m";
804
+ }
805
+ namespace Responses {
806
+ export interface $201 {
807
+ email_address: /* Email address configuration with all associated metadata. */ Components.Schemas.EmailAddressResponse;
808
+ /**
809
+ * The email of the connected mailbox
810
+ */
811
+ outlook_email: string; // email
812
+ /**
813
+ * Azure AD Tenant ID that provisions this mailbox
814
+ */
815
+ tenant_id: string;
816
+ /**
817
+ * The provider type
818
+ */
819
+ provider: "outlook";
820
+ }
821
+ export interface $400 {
822
+ }
823
+ export interface $401 {
824
+ }
825
+ export interface $403 {
826
+ }
827
+ export interface $409 {
828
+ }
829
+ export interface $500 {
830
+ }
831
+ }
832
+ }
833
+ namespace DeleteDomain {
834
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
835
+ namespace Responses {
836
+ export interface $204 {
837
+ }
838
+ export type $403 = Components.Responses.Forbidden;
839
+ export type $404 = Components.Responses.NotFound;
840
+ }
841
+ }
842
+ namespace DeleteEmailAddress {
843
+ namespace Parameters {
844
+ export type Id = string;
845
+ }
846
+ export interface PathParameters {
847
+ id: Parameters.Id;
848
+ }
849
+ namespace Responses {
850
+ export type $204 = Components.Responses.NoContent;
851
+ export type $403 = Components.Responses.Forbidden;
852
+ export type $404 = Components.Responses.NotFound;
853
+ export type $500 = Components.Responses.InternalServerError;
854
+ }
855
+ }
856
+ namespace DeleteSetting {
857
+ export interface RequestBody {
858
+ type: Components.Schemas.SettingType;
859
+ /**
860
+ * The unique identifier of the setting to delete
861
+ * example:
862
+ * a10bd0ff-4391-4cfc-88ee-b19d718a9bf7
863
+ */
864
+ id: string;
865
+ }
866
+ namespace Responses {
867
+ export type $200 = /**
868
+ * Generic setting object used for various email configuration types.
869
+ * The applicable fields depend on the setting type:
870
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
871
+ * - **email_domain**: Uses `value` (domain name)
872
+ * - **whitelist_email_address**: Uses `value` (email address)
873
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
874
+ *
875
+ */
876
+ Components.Schemas.Setting;
877
+ export type $403 = Components.Responses.Forbidden;
878
+ export type $404 = Components.Responses.NotFound;
879
+ }
880
+ }
881
+ namespace DeleteSharedInbox {
882
+ namespace Parameters {
883
+ export type Id = string;
884
+ export type SuccessorInboxId = string;
885
+ }
886
+ export interface PathParameters {
887
+ id: Parameters.Id;
888
+ }
889
+ export interface QueryParameters {
890
+ successorInboxId?: Parameters.SuccessorInboxId;
891
+ }
892
+ namespace Responses {
893
+ export type $204 = Components.Responses.NoContent;
894
+ export type $400 = Components.Responses.BadRequest;
895
+ export type $403 = Components.Responses.Forbidden;
896
+ export type $404 = Components.Responses.NotFound;
897
+ export type $500 = Components.Responses.InternalServerError;
898
+ }
899
+ }
900
+ namespace DisconnectOutlook {
901
+ export interface RequestBody {
902
+ /**
903
+ * Azure AD Tenant ID of the connection to disconnect
904
+ */
905
+ tenant_id: string;
906
+ }
907
+ namespace Responses {
908
+ export interface $200 {
909
+ success?: boolean;
910
+ /**
911
+ * The tenant ID that was disconnected
912
+ */
913
+ tenant_id?: string;
914
+ /**
915
+ * List of shared inbox IDs that were affected by the disconnection
916
+ */
917
+ affected_shared_inboxes?: string[];
918
+ }
919
+ export interface $400 {
920
+ }
921
+ export interface $404 {
922
+ }
923
+ export interface $500 {
924
+ }
925
+ }
926
+ }
927
+ namespace DisconnectOutlookMailbox {
928
+ namespace Parameters {
929
+ export type Email = string; // email
930
+ }
931
+ export interface PathParameters {
932
+ email: Parameters.Email /* email */;
933
+ }
934
+ namespace Responses {
935
+ export interface $200 {
936
+ success: boolean;
937
+ /**
938
+ * The email address that was disconnected
939
+ */
940
+ email: string; // email
941
+ }
942
+ export interface $404 {
943
+ }
944
+ export interface $500 {
945
+ }
946
+ }
947
+ }
948
+ namespace GetConnectedOutlookEmails {
949
+ namespace Responses {
950
+ export interface $200 {
951
+ outlook_emails: /**
952
+ * Mapping between an Outlook email and its Outlook Connection.
953
+ * This tracks which provider/tenant provisions each Outlook email.
954
+ *
955
+ */
956
+ Components.Schemas.ConnectedOutlookEmail[];
957
+ /**
958
+ * Number of Outlook emails
959
+ */
960
+ count: number;
961
+ }
962
+ export interface $400 {
963
+ }
964
+ export interface $500 {
965
+ }
966
+ }
967
+ }
968
+ namespace GetEmailAddress {
969
+ namespace Parameters {
970
+ export type Id = string;
971
+ }
972
+ export interface PathParameters {
973
+ id: Parameters.Id;
974
+ }
975
+ namespace Responses {
976
+ export type $200 = Components.Responses.GetEmailAddressSuccessResponse;
977
+ export type $403 = Components.Responses.Forbidden;
978
+ export type $404 = Components.Responses.NotFound;
979
+ export type $500 = Components.Responses.InternalServerError;
980
+ }
981
+ }
982
+ namespace GetMailboxSyncStatus {
983
+ namespace Parameters {
984
+ export type Email = string; // email
985
+ }
986
+ export interface PathParameters {
987
+ email: Parameters.Email /* email */;
988
+ }
989
+ namespace Responses {
990
+ export type $200 = Components.Schemas.MailboxSyncStatus;
991
+ export interface $404 {
992
+ }
993
+ export interface $500 {
994
+ }
995
+ }
996
+ }
997
+ namespace GetOutlookConnectionStatus {
998
+ namespace Responses {
999
+ export interface $200 {
1000
+ /**
1001
+ * List of Outlook connections (one per tenant)
1002
+ */
1003
+ connections: Components.Schemas.OutlookConnectionStatus[];
1004
+ /**
1005
+ * Whether any connections exist
1006
+ */
1007
+ has_connections: boolean;
1008
+ }
1009
+ export interface $400 {
1010
+ }
1011
+ export interface $500 {
1012
+ }
1013
+ }
1014
+ }
1015
+ namespace GetSettings {
1016
+ namespace Parameters {
1017
+ export type Id = string;
1018
+ export type Type = Components.Schemas.SettingType;
1019
+ }
1020
+ export interface QueryParameters {
1021
+ type: Parameters.Type;
1022
+ id?: Parameters.Id;
1023
+ }
1024
+ namespace Responses {
1025
+ export type $200 = Components.Schemas.SettingsResponse;
1026
+ export type $403 = Components.Responses.Forbidden;
1027
+ export type $404 = Components.Responses.NotFound;
1028
+ }
1029
+ }
1030
+ namespace GetSharedInbox {
1031
+ namespace Parameters {
1032
+ export type Id = string;
1033
+ }
1034
+ export interface PathParameters {
1035
+ id: Parameters.Id;
1036
+ }
1037
+ namespace Responses {
1038
+ export type $200 = Components.Responses.GetSharedInboxSuccessResponse;
1039
+ export type $403 = Components.Responses.Forbidden;
1040
+ export type $404 = Components.Responses.NotFound;
1041
+ export type $500 = Components.Responses.InternalServerError;
1042
+ }
1043
+ }
1044
+ namespace ListEmailAddresses {
1045
+ namespace Responses {
1046
+ export type $200 = Components.Responses.ListEmailAddressesSuccessResponse;
1047
+ export type $403 = Components.Responses.Forbidden;
1048
+ export type $500 = Components.Responses.InternalServerError;
1049
+ }
1050
+ }
1051
+ namespace ListInboxBuckets {
1052
+ namespace Responses {
1053
+ export type $200 = Components.Responses.ListInboxBucketsSuccessResponse;
1054
+ export type $403 = Components.Responses.Forbidden;
1055
+ export type $500 = Components.Responses.InternalServerError;
1056
+ }
1057
+ }
1058
+ namespace ListSharedInboxes {
1059
+ namespace Responses {
1060
+ export type $200 = Components.Responses.ListSharedInboxesSuccessResponse;
1061
+ export type $403 = Components.Responses.Forbidden;
1062
+ export type $500 = Components.Responses.InternalServerError;
1063
+ }
1064
+ }
1065
+ namespace OutlookOAuthCallback {
1066
+ namespace Parameters {
1067
+ export type AdminConsent = string;
1068
+ export type ClientInfo = string;
1069
+ export type Code = string;
1070
+ export type Error = string;
1071
+ export type ErrorDescription = string;
1072
+ export type ErrorSubcode = string;
1073
+ export type ErrorUri = string;
1074
+ export type SessionState = string;
1075
+ export type State = string;
1076
+ export type Tenant = string;
1077
+ }
1078
+ export interface QueryParameters {
1079
+ code?: Parameters.Code;
1080
+ state: Parameters.State;
1081
+ session_state?: Parameters.SessionState;
1082
+ error?: Parameters.Error;
1083
+ error_description?: Parameters.ErrorDescription;
1084
+ error_subcode?: Parameters.ErrorSubcode;
1085
+ client_info?: Parameters.ClientInfo;
1086
+ error_uri?: Parameters.ErrorUri;
1087
+ admin_consent?: Parameters.AdminConsent;
1088
+ tenant?: Parameters.Tenant;
1089
+ }
1090
+ namespace Responses {
1091
+ export interface $200 {
1092
+ connected?: boolean;
1093
+ expires_at?: string; // date-time
1094
+ scope?: string;
1095
+ }
1096
+ }
1097
+ }
1098
+ namespace ProvisionEpilotEmailAddress {
1099
+ export type RequestBody = /* Request payload for provisioning an epilot-managed email address. */ Components.Schemas.ProvisionEpilotEmailAddressPayload;
1100
+ namespace Responses {
1101
+ export type $200 = Components.Responses.ProvisionEpilotEmailAddressSuccessResponse;
1102
+ export type $400 = Components.Responses.BadRequest;
1103
+ export type $409 = Components.Responses.Conflict;
1104
+ export type $500 = Components.Responses.InternalServerError;
1105
+ }
1106
+ }
1107
+ namespace RetryMailboxSync {
1108
+ namespace Parameters {
1109
+ export type Email = string; // email
1110
+ }
1111
+ export interface PathParameters {
1112
+ email: Parameters.Email /* email */;
1113
+ }
1114
+ export interface RequestBody {
1115
+ /**
1116
+ * Execution ID of the sync to retry
1117
+ */
1118
+ sync_id: string;
1119
+ /**
1120
+ * Retry scope. Use 'all_failed' to retry all retryable failed messages.
1121
+ */
1122
+ scope?: "all_failed";
1123
+ /**
1124
+ * Specific Graph message IDs to retry (alternative to scope)
1125
+ */
1126
+ message_ids?: string[];
1127
+ }
1128
+ namespace Responses {
1129
+ export interface $202 {
1130
+ /**
1131
+ * Execution ID for the retry sync
1132
+ */
1133
+ retry_execution_id: string;
1134
+ /**
1135
+ * Number of messages queued for retry
1136
+ */
1137
+ messages_queued: number;
1138
+ }
1139
+ export interface $404 {
1140
+ }
1141
+ export interface $409 {
1142
+ }
1143
+ export interface $500 {
1144
+ }
1145
+ }
1146
+ }
1147
+ namespace SetEmailAddressPrimary {
1148
+ export type RequestBody = /* Request payload for setting an email address as the organization's primary address. */ Components.Schemas.SetEmailAddressPrimaryPayload;
1149
+ namespace Responses {
1150
+ export type $200 = Components.Responses.SetEmailAddressPrimarySuccessResponse;
1151
+ export type $400 = Components.Responses.BadRequest;
1152
+ export type $403 = Components.Responses.Forbidden;
1153
+ export type $409 = Components.Responses.Conflict;
1154
+ export type $500 = Components.Responses.InternalServerError;
1155
+ }
1156
+ }
1157
+ namespace StartMailboxSync {
1158
+ namespace Parameters {
1159
+ export type Email = string; // email
1160
+ }
1161
+ export interface PathParameters {
1162
+ email: Parameters.Email /* email */;
1163
+ }
1164
+ export interface RequestBody {
1165
+ /**
1166
+ * Sync period:
1167
+ * - 5m: last 5 minutes (quick sync)
1168
+ * - 1w: 1 week
1169
+ * - 2w: 2 weeks
1170
+ * - 1m: 1 month
1171
+ *
1172
+ */
1173
+ timeframe: Components.Schemas.MailboxSyncTimeframePeriods;
1174
+ }
1175
+ namespace Responses {
1176
+ export interface $202 {
1177
+ /**
1178
+ * The execution ID
1179
+ */
1180
+ execution_id: string;
1181
+ status: Components.Schemas.MailboxSyncStatuses;
1182
+ timeframe: Components.Schemas.MailboxSyncTimeframePeriods;
1183
+ }
1184
+ export interface $400 {
1185
+ }
1186
+ export interface $404 {
1187
+ }
1188
+ export interface $409 {
1189
+ }
1190
+ export interface $500 {
1191
+ }
1192
+ }
1193
+ }
1194
+ namespace UpdateEmailAddress {
1195
+ namespace Parameters {
1196
+ export type Id = string;
1197
+ }
1198
+ export interface PathParameters {
1199
+ id: Parameters.Id;
1200
+ }
1201
+ export type RequestBody = /**
1202
+ * Request payload for updating an email address configuration.
1203
+ * All fields are optional; only provided fields will be updated.
1204
+ *
1205
+ */
1206
+ Components.Schemas.UpdateEmailAddressPayload;
1207
+ namespace Responses {
1208
+ export type $200 = Components.Responses.UpdateEmailAddressSuccessResponse;
1209
+ export type $400 = Components.Responses.BadRequest;
1210
+ export type $403 = Components.Responses.Forbidden;
1211
+ export type $404 = Components.Responses.NotFound;
1212
+ export type $409 = Components.Responses.Conflict;
1213
+ export type $500 = Components.Responses.InternalServerError;
1214
+ }
1215
+ }
1216
+ namespace UpdateSetting {
1217
+ namespace Parameters {
1218
+ export type Id = string;
1219
+ }
1220
+ export interface PathParameters {
1221
+ id: Parameters.Id;
1222
+ }
1223
+ export type RequestBody = /**
1224
+ * Generic setting object used for various email configuration types.
1225
+ * The applicable fields depend on the setting type:
1226
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
1227
+ * - **email_domain**: Uses `value` (domain name)
1228
+ * - **whitelist_email_address**: Uses `value` (email address)
1229
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
1230
+ *
1231
+ */
1232
+ Components.Schemas.Setting;
1233
+ namespace Responses {
1234
+ export type $200 = /**
1235
+ * Generic setting object used for various email configuration types.
1236
+ * The applicable fields depend on the setting type:
1237
+ * - **signature**: Uses `name`, `value` (plain text), and `html` (rich text)
1238
+ * - **email_domain**: Uses `value` (domain name)
1239
+ * - **whitelist_email_address**: Uses `value` (email address)
1240
+ * - **restrict_duplicates_within**: Uses `value` (time duration)
1241
+ *
1242
+ */
1243
+ Components.Schemas.Setting;
1244
+ export type $403 = Components.Responses.Forbidden;
1245
+ export type $404 = Components.Responses.NotFound;
1246
+ }
1247
+ }
1248
+ namespace UpdateSharedInbox {
1249
+ namespace Parameters {
1250
+ export type Id = string;
1251
+ }
1252
+ export interface PathParameters {
1253
+ id: Parameters.Id;
1254
+ }
1255
+ export type RequestBody = /**
1256
+ * Request payload for updating a shared inbox configuration.
1257
+ * All fields are optional; only provided fields will be updated.
1258
+ *
1259
+ */
1260
+ Components.Schemas.UpdateSharedInboxPayload;
1261
+ namespace Responses {
1262
+ export type $200 = Components.Responses.UpdateSharedInboxSuccessResponse;
1263
+ export type $400 = Components.Responses.BadRequest;
1264
+ export type $403 = Components.Responses.Forbidden;
1265
+ export type $404 = Components.Responses.NotFound;
1266
+ export type $409 = Components.Responses.Conflict;
1267
+ export type $500 = Components.Responses.InternalServerError;
1268
+ }
1269
+ }
1270
+ namespace VerifyDomain {
1271
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
1272
+ namespace Responses {
1273
+ export type $200 = Components.Schemas.SettingsResponse;
1274
+ export type $403 = Components.Responses.Forbidden;
1275
+ export type $404 = Components.Responses.NotFound;
1276
+ }
1277
+ }
1278
+ namespace VerifyNameServers {
1279
+ export type RequestBody = /* Custom email domain configuration. */ Components.Schemas.Domain;
1280
+ namespace Responses {
1281
+ export type $200 = Components.Schemas.SettingsResponse;
1282
+ export type $403 = Components.Responses.Forbidden;
1283
+ export type $404 = Components.Responses.NotFound;
1284
+ }
1285
+ }
1286
+ }
1287
+
1288
+
1289
+ interface OperationMethods {
1290
+ /**
1291
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
1292
+ *
1293
+ * Provisions or reactivates an epilot-managed email address for the organization.
1294
+ *
1295
+ * When provisioning a new epilot email address, any previously active epilot email addresses
1296
+ * will be automatically deactivated. Only one epilot email address can be active at a time.
1297
+ *
1298
+ * Epilot email addresses use the `@epilot.cloud` domain and are fully managed by the platform.
1299
+ *
1300
+ */
1301
+ 'provisionEpilotEmailAddress'(
1302
+ parameters?: Parameters<UnknownParamsObject> | null,
1303
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
1304
+ config?: AxiosRequestConfig
1305
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
1306
+ /**
1307
+ * setEmailAddressPrimary - setEmailAddressPrimary
1308
+ *
1309
+ * Sets the specified email address as the primary address for the organization.
1310
+ *
1311
+ * The primary email address is used as the default sender address when composing new emails.
1312
+ * Only one email address can be primary at a time; setting a new primary will unset the previous one.
1313
+ *
1314
+ */
1315
+ 'setEmailAddressPrimary'(
1316
+ parameters?: Parameters<UnknownParamsObject> | null,
1317
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
1318
+ config?: AxiosRequestConfig
1319
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
1320
+ /**
1321
+ * getEmailAddress - getEmailAddress
1322
+ *
1323
+ * Retrieves the details of a specific email address by its ID.
1324
+ *
1325
+ * Returns the full configuration including display name, assigned users/groups,
1326
+ * default signature, and shared inbox association.
1327
+ *
1328
+ */
1329
+ 'getEmailAddress'(
1330
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
1331
+ data?: any,
1332
+ config?: AxiosRequestConfig
1333
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
1334
+ /**
1335
+ * updateEmailAddress - updateEmailAddress
1336
+ *
1337
+ * Updates the configuration of an existing email address.
1338
+ *
1339
+ * You can modify:
1340
+ * - Display name
1341
+ * - Assigned users and groups
1342
+ * - Default signature
1343
+ * - Shared inbox association
1344
+ * - Active status
1345
+ *
1346
+ */
1347
+ 'updateEmailAddress'(
1348
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
1349
+ data?: Paths.UpdateEmailAddress.RequestBody,
1350
+ config?: AxiosRequestConfig
1351
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
1352
+ /**
1353
+ * deleteEmailAddress - deleteEmailAddress
1354
+ *
1355
+ * Permanently deletes an email address from the organization.
1356
+ *
1357
+ * **Warning**: This action cannot be undone. Users will no longer be able to send
1358
+ * emails from this address after deletion.
1359
+ *
1360
+ */
1361
+ 'deleteEmailAddress'(
1362
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
1363
+ data?: any,
1364
+ config?: AxiosRequestConfig
1365
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
1366
+ /**
1367
+ * listEmailAddresses - listEmailAddresses
1368
+ *
1369
+ * Retrieves all email addresses configured for the organization.
1370
+ *
1371
+ * Returns an array of email address configurations including their IDs, display names,
1372
+ * assigned users/groups, signatures, and status flags.
1373
+ *
1374
+ */
1375
+ 'listEmailAddresses'(
1376
+ parameters?: Parameters<UnknownParamsObject> | null,
1377
+ data?: any,
1378
+ config?: AxiosRequestConfig
1379
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
1380
+ /**
1381
+ * addEmailAddress - addEmailAddress
1382
+ *
1383
+ * Adds a new email address to the organization.
1384
+ *
1385
+ * The email address can be from a custom domain (if configured) or any external
1386
+ * email provider. Optionally assign users, groups, and a default signature.
1387
+ *
1388
+ */
1389
+ 'addEmailAddress'(
1390
+ parameters?: Parameters<UnknownParamsObject> | null,
1391
+ data?: Paths.AddEmailAddress.RequestBody,
1392
+ config?: AxiosRequestConfig
1393
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
1394
+ /**
1395
+ * getSharedInbox - getSharedInbox
1396
+ *
1397
+ * Retrieves the details of a specific shared inbox by its ID.
1398
+ *
1399
+ * Returns the inbox configuration including name, color, description, assigned team members,
1400
+ * and the associated bucket ID.
1401
+ *
1402
+ */
1403
+ 'getSharedInbox'(
1404
+ parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
1405
+ data?: any,
1406
+ config?: AxiosRequestConfig
1407
+ ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
1408
+ /**
1409
+ * updateSharedInbox - updateSharedInbox
1410
+ *
1411
+ * Updates the configuration of an existing shared inbox.
1412
+ *
1413
+ * You can modify the inbox name, color, description, and team member assignments.
1414
+ * Changes take effect immediately for all associated email addresses.
1415
+ *
1416
+ */
1417
+ 'updateSharedInbox'(
1418
+ parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
1419
+ data?: Paths.UpdateSharedInbox.RequestBody,
1420
+ config?: AxiosRequestConfig
1421
+ ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
1422
+ /**
1423
+ * deleteSharedInbox - deleteSharedInbox
1424
+ *
1425
+ * Deletes a shared inbox and reroutes all associated emails to a successor inbox.
1426
+ *
1427
+ * When a shared inbox is deleted:
1428
+ * - All email addresses associated with this inbox will be reassigned to the successor
1429
+ * - If no successor is specified, emails are routed to the default inbox
1430
+ * - The inbox's message history is preserved in the successor inbox
1431
+ *
1432
+ * **Note**: The default inbox cannot be deleted.
1433
+ *
1434
+ */
1435
+ 'deleteSharedInbox'(
1436
+ parameters?: Parameters<Paths.DeleteSharedInbox.QueryParameters & Paths.DeleteSharedInbox.PathParameters> | null,
1437
+ data?: any,
1438
+ config?: AxiosRequestConfig
1439
+ ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
1440
+ /**
1441
+ * listSharedInboxes - listSharedInboxes
1442
+ *
1443
+ * Retrieves all shared inboxes configured for the organization.
1444
+ *
1445
+ * **Note**: The default inbox (with ID `default`) is not included in this list but is
1446
+ * always available for all organizations. You do not need to create it explicitly.
1447
+ *
1448
+ */
1449
+ 'listSharedInboxes'(
1450
+ parameters?: Parameters<UnknownParamsObject> | null,
1451
+ data?: any,
1452
+ config?: AxiosRequestConfig
1453
+ ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
1454
+ /**
1455
+ * addSharedInbox - addSharedInbox
1456
+ *
1457
+ * Creates a new shared inbox for the organization.
1458
+ *
1459
+ * Shared inboxes help teams organize and categorize incoming emails.
1460
+ * Each inbox requires a name and color for visual identification.
1461
+ *
1462
+ */
1463
+ 'addSharedInbox'(
1464
+ parameters?: Parameters<UnknownParamsObject> | null,
1465
+ data?: Paths.AddSharedInbox.RequestBody,
1466
+ config?: AxiosRequestConfig
1467
+ ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
1468
+ /**
1469
+ * listInboxBuckets - listInboxBuckets
1470
+ *
1471
+ * Retrieves all inbox buckets for the organization.
1472
+ *
1473
+ * Inbox buckets are internal storage containers that correspond to shared inboxes.
1474
+ * Each shared inbox has an associated bucket for storing messages.
1475
+ *
1476
+ * **Note**: The default bucket (with ID `default`) is not included in this list but
1477
+ * is always available for all organizations.
1478
+ *
1479
+ */
1480
+ 'listInboxBuckets'(
1481
+ parameters?: Parameters<UnknownParamsObject> | null,
1482
+ data?: any,
1483
+ config?: AxiosRequestConfig
1484
+ ): OperationResponse<Paths.ListInboxBuckets.Responses.$200>
1485
+ /**
1486
+ * connectOutlook - connectOutlook
1487
+ *
1488
+ * Returns Microsoft authorization URL for Outlook OAuth.
1489
+ */
1490
+ 'connectOutlook'(
1491
+ parameters?: Parameters<UnknownParamsObject> | null,
1492
+ data?: any,
1493
+ config?: AxiosRequestConfig
1494
+ ): OperationResponse<Paths.ConnectOutlook.Responses.$200>
1495
+ /**
1496
+ * getOutlookConnectionStatus - getOutlookConnectionStatus
1497
+ *
1498
+ * Returns all Microsoft 365 / Outlook connections for the organization.
1499
+ * Supports multiple connections (one per Azure AD tenant).
1500
+ *
1501
+ * Each connection includes an `action` field that tells the UI what button to show
1502
+ * and what endpoint to call. All actions use GET /outlook/connect.
1503
+ *
1504
+ */
1505
+ 'getOutlookConnectionStatus'(
1506
+ parameters?: Parameters<UnknownParamsObject> | null,
1507
+ data?: any,
1508
+ config?: AxiosRequestConfig
1509
+ ): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
1510
+ /**
1511
+ * disconnectOutlook - disconnectOutlook
1512
+ *
1513
+ * Removes the Microsoft 365 / Outlook connection for a specific tenant.
1514
+ * This deletes the stored tokens and disconnects the integration.
1515
+ *
1516
+ */
1517
+ 'disconnectOutlook'(
1518
+ parameters?: Parameters<UnknownParamsObject> | null,
1519
+ data?: Paths.DisconnectOutlook.RequestBody,
1520
+ config?: AxiosRequestConfig
1521
+ ): OperationResponse<Paths.DisconnectOutlook.Responses.$200>
1522
+ /**
1523
+ * connectOutlookMailbox - connectOutlookMailbox
1524
+ *
1525
+ * Connects an Outlook mailbox:
1526
+ * 1. Validates the user has access to the mailbox via Microsoft Graph API
1527
+ * 2. Creates a mapping between the email address of the mailbox and the outlook connection
1528
+ * 3. Enables the user to send emails as the mailbox's email address
1529
+ *
1530
+ */
1531
+ 'connectOutlookMailbox'(
1532
+ parameters?: Parameters<UnknownParamsObject> | null,
1533
+ data?: Paths.ConnectOutlookMailbox.RequestBody,
1534
+ config?: AxiosRequestConfig
1535
+ ): OperationResponse<Paths.ConnectOutlookMailbox.Responses.$201>
1536
+ /**
1537
+ * disconnectOutlookMailbox - Disconnect Outlook Mailbox
1538
+ *
1539
+ * Disconnects a single Outlook mailbox by email address.
1540
+ * Deletes the email address entity, Outlook email mapping, and Graph API subscriptions.
1541
+ * Does not affect the tenant-level Outlook connection.
1542
+ *
1543
+ */
1544
+ 'disconnectOutlookMailbox'(
1545
+ parameters?: Parameters<Paths.DisconnectOutlookMailbox.PathParameters> | null,
1546
+ data?: any,
1547
+ config?: AxiosRequestConfig
1548
+ ): OperationResponse<Paths.DisconnectOutlookMailbox.Responses.$200>
1549
+ /**
1550
+ * startMailboxSync - Start Mailbox Sync
1551
+ *
1552
+ * Triggers an Outlook mailbox sync for the specified email address.
1553
+ * Syncs existing emails (inbox + sent items) for the specified timeframe.
1554
+ *
1555
+ */
1556
+ 'startMailboxSync'(
1557
+ parameters?: Parameters<Paths.StartMailboxSync.PathParameters> | null,
1558
+ data?: Paths.StartMailboxSync.RequestBody,
1559
+ config?: AxiosRequestConfig
1560
+ ): OperationResponse<Paths.StartMailboxSync.Responses.$202>
1561
+ /**
1562
+ * getMailboxSyncStatus - Get Mailbox Sync Status
1563
+ *
1564
+ * Returns the current or latest sync status for the specified mailbox.
1565
+ * Poll this endpoint to track sync progress.
1566
+ *
1567
+ */
1568
+ 'getMailboxSyncStatus'(
1569
+ parameters?: Parameters<Paths.GetMailboxSyncStatus.PathParameters> | null,
1570
+ data?: any,
1571
+ config?: AxiosRequestConfig
1572
+ ): OperationResponse<Paths.GetMailboxSyncStatus.Responses.$200>
1573
+ /**
1574
+ * retryMailboxSync - Retry Failed Messages
1575
+ *
1576
+ * Retries failed messages from a previous sync execution.
1577
+ * Only retries messages with status FAILED (not PERMANENTLY_FAILED).
1578
+ * Messages that fail 3+ retries become PERMANENTLY_FAILED.
1579
+ *
1580
+ */
1581
+ 'retryMailboxSync'(
1582
+ parameters?: Parameters<Paths.RetryMailboxSync.PathParameters> | null,
1583
+ data?: Paths.RetryMailboxSync.RequestBody,
1584
+ config?: AxiosRequestConfig
1585
+ ): OperationResponse<Paths.RetryMailboxSync.Responses.$202>
1586
+ /**
1587
+ * getConnectedOutlookEmails - getConnectedOutlookEmails
1588
+ *
1589
+ * Returns all Outlook email addresses connected to the organization.
1590
+ *
1591
+ */
1592
+ 'getConnectedOutlookEmails'(
1593
+ parameters?: Parameters<UnknownParamsObject> | null,
1594
+ data?: any,
1595
+ config?: AxiosRequestConfig
1596
+ ): OperationResponse<Paths.GetConnectedOutlookEmails.Responses.$200>
1597
+ /**
1598
+ * outlookOAuthCallback - outlookOAuthCallback
1599
+ *
1600
+ * Exchanges authorization code for tokens and stores them.
1601
+ */
1602
+ 'outlookOAuthCallback'(
1603
+ parameters?: Parameters<Paths.OutlookOAuthCallback.QueryParameters> | null,
1604
+ data?: any,
1605
+ config?: AxiosRequestConfig
1606
+ ): OperationResponse<Paths.OutlookOAuthCallback.Responses.$200>
1607
+ /**
1608
+ * getSettings - getSettings
1609
+ *
1610
+ * Retrieves settings of a specific type for the organization.
1611
+ *
1612
+ * If an `id` is provided, returns only that specific setting.
1613
+ * Otherwise, returns all settings of the specified type.
1614
+ *
1615
+ * ## Setting Types
1616
+ *
1617
+ * | Type | Description |
1618
+ * |------|-------------|
1619
+ * | `signature` | HTML email signatures |
1620
+ * | `email_domain` | Custom email domains |
1621
+ * | `email_address` | Sender email addresses |
1622
+ * | `whitelist_email_address` | Addresses exempt from duplicate detection |
1623
+ * | `restrict_duplicates_within` | Time window for duplicate email detection |
1624
+ *
1625
+ */
1626
+ 'getSettings'(
1627
+ parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
1628
+ data?: any,
1629
+ config?: AxiosRequestConfig
1630
+ ): OperationResponse<Paths.GetSettings.Responses.$200>
1631
+ /**
1632
+ * addSetting - addSetting
1633
+ *
1634
+ * Creates a new setting of the specified type.
1635
+ *
1636
+ * The setting type determines which fields are applicable:
1637
+ * - **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)
1638
+ * - **email_domain**: Requires `value` (domain name)
1639
+ * - **whitelist_email_address**: Requires `value` (email address)
1640
+ * - **restrict_duplicates_within**: Requires `value` (time duration like "5m", "1d")
1641
+ *
1642
+ */
1643
+ 'addSetting'(
1644
+ parameters?: Parameters<UnknownParamsObject> | null,
1645
+ data?: Paths.AddSetting.RequestBody,
1646
+ config?: AxiosRequestConfig
1647
+ ): OperationResponse<Paths.AddSetting.Responses.$200>
1648
+ /**
1649
+ * deleteSetting - deleteSetting
1650
+ *
1651
+ * Deletes a setting by its ID and type.
1652
+ *
1653
+ * Both the `id` and `type` are required to uniquely identify the setting to delete.
1654
+ *
1655
+ * **Warning**: This action cannot be undone.
1656
+ *
1657
+ */
1658
+ 'deleteSetting'(
1659
+ parameters?: Parameters<UnknownParamsObject> | null,
1660
+ data?: Paths.DeleteSetting.RequestBody,
1661
+ config?: AxiosRequestConfig
1662
+ ): OperationResponse<Paths.DeleteSetting.Responses.$200>
1663
+ /**
1664
+ * updateSetting - updateSetting
1665
+ *
1666
+ * Updates an existing setting identified by its ID.
1667
+ *
1668
+ * Include the `type` field in the request body to specify which setting type
1669
+ * is being updated. Only the fields provided will be updated.
1670
+ *
1671
+ */
1672
+ 'updateSetting'(
1673
+ parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
1674
+ data?: Paths.UpdateSetting.RequestBody,
1675
+ config?: AxiosRequestConfig
1676
+ ): OperationResponse<Paths.UpdateSetting.Responses.$200>
1677
+ /**
1678
+ * addDomain - addDomain
1679
+ *
1680
+ * Adds a custom email domain to the organization.
1681
+ *
1682
+ * After adding the domain, you must:
1683
+ * 1. Configure the required DNS records (provided in the response)
1684
+ * 2. Verify the domain using the verification endpoint
1685
+ *
1686
+ * Until verification is complete, the domain cannot be used for sending emails.
1687
+ *
1688
+ */
1689
+ 'addDomain'(
1690
+ parameters?: Parameters<UnknownParamsObject> | null,
1691
+ data?: Paths.AddDomain.RequestBody,
1692
+ config?: AxiosRequestConfig
1693
+ ): OperationResponse<Paths.AddDomain.Responses.$200>
1694
+ /**
1695
+ * deleteDomain - deleteDomain
1696
+ *
1697
+ * Removes a custom email domain from the organization.
1698
+ *
1699
+ * **Warning**: Deleting a domain will prevent sending emails from any addresses
1700
+ * using this domain. Existing email addresses on this domain should be removed
1701
+ * or reassigned before deleting the domain.
1702
+ *
1703
+ */
1704
+ 'deleteDomain'(
1705
+ parameters?: Parameters<UnknownParamsObject> | null,
1706
+ data?: Paths.DeleteDomain.RequestBody,
1707
+ config?: AxiosRequestConfig
1708
+ ): OperationResponse<Paths.DeleteDomain.Responses.$204>
1709
+ /**
1710
+ * verifyNameServers - verifyNameServers
1711
+ *
1712
+ * Verifies that the domain's name server (NS) records are correctly configured.
1713
+ *
1714
+ * This check ensures that DNS resolution is properly set up for the domain
1715
+ * before proceeding with full domain verification.
1716
+ *
1717
+ * Run this verification after configuring NS records in your DNS provider.
1718
+ *
1719
+ */
1720
+ 'verifyNameServers'(
1721
+ parameters?: Parameters<UnknownParamsObject> | null,
1722
+ data?: Paths.VerifyNameServers.RequestBody,
1723
+ config?: AxiosRequestConfig
1724
+ ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
1725
+ /**
1726
+ * verifyDomain - verifyDomain
1727
+ *
1728
+ * Verifies ownership and configuration of a custom email domain.
1729
+ *
1730
+ * Domain verification checks:
1731
+ * - DNS TXT records for domain ownership
1732
+ * - MX records for email routing
1733
+ * - SPF records for sender authentication
1734
+ * - DKIM records for email signing
1735
+ *
1736
+ * Once verified, the domain can be used to create email addresses and send emails.
1737
+ *
1738
+ */
1739
+ 'verifyDomain'(
1740
+ parameters?: Parameters<UnknownParamsObject> | null,
1741
+ data?: Paths.VerifyDomain.RequestBody,
1742
+ config?: AxiosRequestConfig
1743
+ ): OperationResponse<Paths.VerifyDomain.Responses.$200>
1744
+ }
1745
+
1746
+ interface PathsDictionary {
1747
+ ['/v2/email-settings/email-addresses/epilot:provision']: {
1748
+ /**
1749
+ * provisionEpilotEmailAddress - provisionEpilotEmailAddress
1750
+ *
1751
+ * Provisions or reactivates an epilot-managed email address for the organization.
1752
+ *
1753
+ * When provisioning a new epilot email address, any previously active epilot email addresses
1754
+ * will be automatically deactivated. Only one epilot email address can be active at a time.
1755
+ *
1756
+ * Epilot email addresses use the `@epilot.cloud` domain and are fully managed by the platform.
1757
+ *
1758
+ */
1759
+ 'put'(
1760
+ parameters?: Parameters<UnknownParamsObject> | null,
1761
+ data?: Paths.ProvisionEpilotEmailAddress.RequestBody,
1762
+ config?: AxiosRequestConfig
1763
+ ): OperationResponse<Paths.ProvisionEpilotEmailAddress.Responses.$200>
1764
+ }
1765
+ ['/v2/email-settings/email-addresses/primary']: {
1766
+ /**
1767
+ * setEmailAddressPrimary - setEmailAddressPrimary
1768
+ *
1769
+ * Sets the specified email address as the primary address for the organization.
1770
+ *
1771
+ * The primary email address is used as the default sender address when composing new emails.
1772
+ * Only one email address can be primary at a time; setting a new primary will unset the previous one.
1773
+ *
1774
+ */
1775
+ 'post'(
1776
+ parameters?: Parameters<UnknownParamsObject> | null,
1777
+ data?: Paths.SetEmailAddressPrimary.RequestBody,
1778
+ config?: AxiosRequestConfig
1779
+ ): OperationResponse<Paths.SetEmailAddressPrimary.Responses.$200>
1780
+ }
1781
+ ['/v2/email-settings/email-addresses/{id}']: {
1782
+ /**
1783
+ * getEmailAddress - getEmailAddress
1784
+ *
1785
+ * Retrieves the details of a specific email address by its ID.
1786
+ *
1787
+ * Returns the full configuration including display name, assigned users/groups,
1788
+ * default signature, and shared inbox association.
1789
+ *
1790
+ */
1791
+ 'get'(
1792
+ parameters?: Parameters<Paths.GetEmailAddress.PathParameters> | null,
1793
+ data?: any,
1794
+ config?: AxiosRequestConfig
1795
+ ): OperationResponse<Paths.GetEmailAddress.Responses.$200>
1796
+ /**
1797
+ * deleteEmailAddress - deleteEmailAddress
1798
+ *
1799
+ * Permanently deletes an email address from the organization.
1800
+ *
1801
+ * **Warning**: This action cannot be undone. Users will no longer be able to send
1802
+ * emails from this address after deletion.
1803
+ *
1804
+ */
1805
+ 'delete'(
1806
+ parameters?: Parameters<Paths.DeleteEmailAddress.PathParameters> | null,
1807
+ data?: any,
1808
+ config?: AxiosRequestConfig
1809
+ ): OperationResponse<Paths.DeleteEmailAddress.Responses.$204>
1810
+ /**
1811
+ * updateEmailAddress - updateEmailAddress
1812
+ *
1813
+ * Updates the configuration of an existing email address.
1814
+ *
1815
+ * You can modify:
1816
+ * - Display name
1817
+ * - Assigned users and groups
1818
+ * - Default signature
1819
+ * - Shared inbox association
1820
+ * - Active status
1821
+ *
1822
+ */
1823
+ 'put'(
1824
+ parameters?: Parameters<Paths.UpdateEmailAddress.PathParameters> | null,
1825
+ data?: Paths.UpdateEmailAddress.RequestBody,
1826
+ config?: AxiosRequestConfig
1827
+ ): OperationResponse<Paths.UpdateEmailAddress.Responses.$200>
1828
+ }
1829
+ ['/v2/email-settings/email-addresses']: {
1830
+ /**
1831
+ * listEmailAddresses - listEmailAddresses
1832
+ *
1833
+ * Retrieves all email addresses configured for the organization.
1834
+ *
1835
+ * Returns an array of email address configurations including their IDs, display names,
1836
+ * assigned users/groups, signatures, and status flags.
1837
+ *
1838
+ */
1839
+ 'get'(
1840
+ parameters?: Parameters<UnknownParamsObject> | null,
1841
+ data?: any,
1842
+ config?: AxiosRequestConfig
1843
+ ): OperationResponse<Paths.ListEmailAddresses.Responses.$200>
1844
+ /**
1845
+ * addEmailAddress - addEmailAddress
1846
+ *
1847
+ * Adds a new email address to the organization.
1848
+ *
1849
+ * The email address can be from a custom domain (if configured) or any external
1850
+ * email provider. Optionally assign users, groups, and a default signature.
1851
+ *
1852
+ */
1853
+ 'post'(
1854
+ parameters?: Parameters<UnknownParamsObject> | null,
1855
+ data?: Paths.AddEmailAddress.RequestBody,
1856
+ config?: AxiosRequestConfig
1857
+ ): OperationResponse<Paths.AddEmailAddress.Responses.$201>
1858
+ }
1859
+ ['/v2/email-settings/shared-inboxes/{id}']: {
1860
+ /**
1861
+ * getSharedInbox - getSharedInbox
1862
+ *
1863
+ * Retrieves the details of a specific shared inbox by its ID.
1864
+ *
1865
+ * Returns the inbox configuration including name, color, description, assigned team members,
1866
+ * and the associated bucket ID.
1867
+ *
1868
+ */
1869
+ 'get'(
1870
+ parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
1871
+ data?: any,
1872
+ config?: AxiosRequestConfig
1873
+ ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
1874
+ /**
1875
+ * deleteSharedInbox - deleteSharedInbox
1876
+ *
1877
+ * Deletes a shared inbox and reroutes all associated emails to a successor inbox.
1878
+ *
1879
+ * When a shared inbox is deleted:
1880
+ * - All email addresses associated with this inbox will be reassigned to the successor
1881
+ * - If no successor is specified, emails are routed to the default inbox
1882
+ * - The inbox's message history is preserved in the successor inbox
1883
+ *
1884
+ * **Note**: The default inbox cannot be deleted.
1885
+ *
1886
+ */
1887
+ 'delete'(
1888
+ parameters?: Parameters<Paths.DeleteSharedInbox.QueryParameters & Paths.DeleteSharedInbox.PathParameters> | null,
1889
+ data?: any,
1890
+ config?: AxiosRequestConfig
1891
+ ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
1892
+ /**
1893
+ * updateSharedInbox - updateSharedInbox
1894
+ *
1895
+ * Updates the configuration of an existing shared inbox.
1896
+ *
1897
+ * You can modify the inbox name, color, description, and team member assignments.
1898
+ * Changes take effect immediately for all associated email addresses.
1899
+ *
1900
+ */
1901
+ 'put'(
1902
+ parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
1903
+ data?: Paths.UpdateSharedInbox.RequestBody,
1904
+ config?: AxiosRequestConfig
1905
+ ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
1906
+ }
1907
+ ['/v2/email-settings/shared-inboxes']: {
1908
+ /**
1909
+ * listSharedInboxes - listSharedInboxes
1910
+ *
1911
+ * Retrieves all shared inboxes configured for the organization.
1912
+ *
1913
+ * **Note**: The default inbox (with ID `default`) is not included in this list but is
1914
+ * always available for all organizations. You do not need to create it explicitly.
1915
+ *
1916
+ */
1917
+ 'get'(
1918
+ parameters?: Parameters<UnknownParamsObject> | null,
1919
+ data?: any,
1920
+ config?: AxiosRequestConfig
1921
+ ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
1922
+ /**
1923
+ * addSharedInbox - addSharedInbox
1924
+ *
1925
+ * Creates a new shared inbox for the organization.
1926
+ *
1927
+ * Shared inboxes help teams organize and categorize incoming emails.
1928
+ * Each inbox requires a name and color for visual identification.
1929
+ *
1930
+ */
1931
+ 'post'(
1932
+ parameters?: Parameters<UnknownParamsObject> | null,
1933
+ data?: Paths.AddSharedInbox.RequestBody,
1934
+ config?: AxiosRequestConfig
1935
+ ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
1936
+ }
1937
+ ['/v2/email-settings/inbox-buckets']: {
1938
+ /**
1939
+ * listInboxBuckets - listInboxBuckets
1940
+ *
1941
+ * Retrieves all inbox buckets for the organization.
1942
+ *
1943
+ * Inbox buckets are internal storage containers that correspond to shared inboxes.
1944
+ * Each shared inbox has an associated bucket for storing messages.
1945
+ *
1946
+ * **Note**: The default bucket (with ID `default`) is not included in this list but
1947
+ * is always available for all organizations.
1948
+ *
1949
+ */
1950
+ 'get'(
1951
+ parameters?: Parameters<UnknownParamsObject> | null,
1952
+ data?: any,
1953
+ config?: AxiosRequestConfig
1954
+ ): OperationResponse<Paths.ListInboxBuckets.Responses.$200>
1955
+ }
1956
+ ['/v2/outlook/connect']: {
1957
+ /**
1958
+ * connectOutlook - connectOutlook
1959
+ *
1960
+ * Returns Microsoft authorization URL for Outlook OAuth.
1961
+ */
1962
+ 'get'(
1963
+ parameters?: Parameters<UnknownParamsObject> | null,
1964
+ data?: any,
1965
+ config?: AxiosRequestConfig
1966
+ ): OperationResponse<Paths.ConnectOutlook.Responses.$200>
1967
+ }
1968
+ ['/v2/outlook/connection/status']: {
1969
+ /**
1970
+ * getOutlookConnectionStatus - getOutlookConnectionStatus
1971
+ *
1972
+ * Returns all Microsoft 365 / Outlook connections for the organization.
1973
+ * Supports multiple connections (one per Azure AD tenant).
1974
+ *
1975
+ * Each connection includes an `action` field that tells the UI what button to show
1976
+ * and what endpoint to call. All actions use GET /outlook/connect.
1977
+ *
1978
+ */
1979
+ 'get'(
1980
+ parameters?: Parameters<UnknownParamsObject> | null,
1981
+ data?: any,
1982
+ config?: AxiosRequestConfig
1983
+ ): OperationResponse<Paths.GetOutlookConnectionStatus.Responses.$200>
1984
+ }
1985
+ ['/v2/outlook/connection/disconnect']: {
1986
+ /**
1987
+ * disconnectOutlook - disconnectOutlook
1988
+ *
1989
+ * Removes the Microsoft 365 / Outlook connection for a specific tenant.
1990
+ * This deletes the stored tokens and disconnects the integration.
1991
+ *
1992
+ */
1993
+ 'post'(
1994
+ parameters?: Parameters<UnknownParamsObject> | null,
1995
+ data?: Paths.DisconnectOutlook.RequestBody,
1996
+ config?: AxiosRequestConfig
1997
+ ): OperationResponse<Paths.DisconnectOutlook.Responses.$200>
1998
+ }
1999
+ ['/v2/outlook/mailbox/connect']: {
2000
+ /**
2001
+ * connectOutlookMailbox - connectOutlookMailbox
2002
+ *
2003
+ * Connects an Outlook mailbox:
2004
+ * 1. Validates the user has access to the mailbox via Microsoft Graph API
2005
+ * 2. Creates a mapping between the email address of the mailbox and the outlook connection
2006
+ * 3. Enables the user to send emails as the mailbox's email address
2007
+ *
2008
+ */
2009
+ 'post'(
2010
+ parameters?: Parameters<UnknownParamsObject> | null,
2011
+ data?: Paths.ConnectOutlookMailbox.RequestBody,
2012
+ config?: AxiosRequestConfig
2013
+ ): OperationResponse<Paths.ConnectOutlookMailbox.Responses.$201>
2014
+ }
2015
+ ['/v2/outlook/mailbox/{email}/disconnect']: {
2016
+ /**
2017
+ * disconnectOutlookMailbox - Disconnect Outlook Mailbox
2018
+ *
2019
+ * Disconnects a single Outlook mailbox by email address.
2020
+ * Deletes the email address entity, Outlook email mapping, and Graph API subscriptions.
2021
+ * Does not affect the tenant-level Outlook connection.
2022
+ *
2023
+ */
2024
+ 'post'(
2025
+ parameters?: Parameters<Paths.DisconnectOutlookMailbox.PathParameters> | null,
2026
+ data?: any,
2027
+ config?: AxiosRequestConfig
2028
+ ): OperationResponse<Paths.DisconnectOutlookMailbox.Responses.$200>
2029
+ }
2030
+ ['/v2/outlook/mailbox/{email}/sync']: {
2031
+ /**
2032
+ * startMailboxSync - Start Mailbox Sync
2033
+ *
2034
+ * Triggers an Outlook mailbox sync for the specified email address.
2035
+ * Syncs existing emails (inbox + sent items) for the specified timeframe.
2036
+ *
2037
+ */
2038
+ 'post'(
2039
+ parameters?: Parameters<Paths.StartMailboxSync.PathParameters> | null,
2040
+ data?: Paths.StartMailboxSync.RequestBody,
2041
+ config?: AxiosRequestConfig
2042
+ ): OperationResponse<Paths.StartMailboxSync.Responses.$202>
2043
+ }
2044
+ ['/v2/outlook/mailbox/{email}/sync/status']: {
2045
+ /**
2046
+ * getMailboxSyncStatus - Get Mailbox Sync Status
2047
+ *
2048
+ * Returns the current or latest sync status for the specified mailbox.
2049
+ * Poll this endpoint to track sync progress.
2050
+ *
2051
+ */
2052
+ 'get'(
2053
+ parameters?: Parameters<Paths.GetMailboxSyncStatus.PathParameters> | null,
2054
+ data?: any,
2055
+ config?: AxiosRequestConfig
2056
+ ): OperationResponse<Paths.GetMailboxSyncStatus.Responses.$200>
2057
+ }
2058
+ ['/v2/outlook/mailbox/{email}/sync/retry']: {
2059
+ /**
2060
+ * retryMailboxSync - Retry Failed Messages
2061
+ *
2062
+ * Retries failed messages from a previous sync execution.
2063
+ * Only retries messages with status FAILED (not PERMANENTLY_FAILED).
2064
+ * Messages that fail 3+ retries become PERMANENTLY_FAILED.
2065
+ *
2066
+ */
2067
+ 'post'(
2068
+ parameters?: Parameters<Paths.RetryMailboxSync.PathParameters> | null,
2069
+ data?: Paths.RetryMailboxSync.RequestBody,
2070
+ config?: AxiosRequestConfig
2071
+ ): OperationResponse<Paths.RetryMailboxSync.Responses.$202>
2072
+ }
2073
+ ['/v2/outlook/mailbox/mappings']: {
2074
+ /**
2075
+ * getConnectedOutlookEmails - getConnectedOutlookEmails
2076
+ *
2077
+ * Returns all Outlook email addresses connected to the organization.
2078
+ *
2079
+ */
2080
+ 'get'(
2081
+ parameters?: Parameters<UnknownParamsObject> | null,
2082
+ data?: any,
2083
+ config?: AxiosRequestConfig
2084
+ ): OperationResponse<Paths.GetConnectedOutlookEmails.Responses.$200>
2085
+ }
2086
+ ['/v2/outlook/oauth/callback']: {
2087
+ /**
2088
+ * outlookOAuthCallback - outlookOAuthCallback
2089
+ *
2090
+ * Exchanges authorization code for tokens and stores them.
2091
+ */
2092
+ 'get'(
2093
+ parameters?: Parameters<Paths.OutlookOAuthCallback.QueryParameters> | null,
2094
+ data?: any,
2095
+ config?: AxiosRequestConfig
2096
+ ): OperationResponse<Paths.OutlookOAuthCallback.Responses.$200>
2097
+ }
2098
+ ['/v1/email-settings']: {
2099
+ /**
2100
+ * getSettings - getSettings
2101
+ *
2102
+ * Retrieves settings of a specific type for the organization.
2103
+ *
2104
+ * If an `id` is provided, returns only that specific setting.
2105
+ * Otherwise, returns all settings of the specified type.
2106
+ *
2107
+ * ## Setting Types
2108
+ *
2109
+ * | Type | Description |
2110
+ * |------|-------------|
2111
+ * | `signature` | HTML email signatures |
2112
+ * | `email_domain` | Custom email domains |
2113
+ * | `email_address` | Sender email addresses |
2114
+ * | `whitelist_email_address` | Addresses exempt from duplicate detection |
2115
+ * | `restrict_duplicates_within` | Time window for duplicate email detection |
2116
+ *
2117
+ */
2118
+ 'get'(
2119
+ parameters?: Parameters<Paths.GetSettings.QueryParameters> | null,
2120
+ data?: any,
2121
+ config?: AxiosRequestConfig
2122
+ ): OperationResponse<Paths.GetSettings.Responses.$200>
2123
+ /**
2124
+ * addSetting - addSetting
2125
+ *
2126
+ * Creates a new setting of the specified type.
2127
+ *
2128
+ * The setting type determines which fields are applicable:
2129
+ * - **signature**: Requires `name`, `value` (plain text), and `html` (HTML content)
2130
+ * - **email_domain**: Requires `value` (domain name)
2131
+ * - **whitelist_email_address**: Requires `value` (email address)
2132
+ * - **restrict_duplicates_within**: Requires `value` (time duration like "5m", "1d")
2133
+ *
2134
+ */
2135
+ 'post'(
2136
+ parameters?: Parameters<UnknownParamsObject> | null,
2137
+ data?: Paths.AddSetting.RequestBody,
2138
+ config?: AxiosRequestConfig
2139
+ ): OperationResponse<Paths.AddSetting.Responses.$200>
2140
+ /**
2141
+ * deleteSetting - deleteSetting
2142
+ *
2143
+ * Deletes a setting by its ID and type.
2144
+ *
2145
+ * Both the `id` and `type` are required to uniquely identify the setting to delete.
2146
+ *
2147
+ * **Warning**: This action cannot be undone.
2148
+ *
2149
+ */
2150
+ 'delete'(
2151
+ parameters?: Parameters<UnknownParamsObject> | null,
2152
+ data?: Paths.DeleteSetting.RequestBody,
2153
+ config?: AxiosRequestConfig
2154
+ ): OperationResponse<Paths.DeleteSetting.Responses.$200>
2155
+ }
2156
+ ['/v1/email-settings/{id}']: {
2157
+ /**
2158
+ * updateSetting - updateSetting
2159
+ *
2160
+ * Updates an existing setting identified by its ID.
2161
+ *
2162
+ * Include the `type` field in the request body to specify which setting type
2163
+ * is being updated. Only the fields provided will be updated.
2164
+ *
2165
+ */
2166
+ 'post'(
2167
+ parameters?: Parameters<Paths.UpdateSetting.PathParameters> | null,
2168
+ data?: Paths.UpdateSetting.RequestBody,
2169
+ config?: AxiosRequestConfig
2170
+ ): OperationResponse<Paths.UpdateSetting.Responses.$200>
2171
+ }
2172
+ ['/v1/email-settings/domain']: {
2173
+ /**
2174
+ * addDomain - addDomain
2175
+ *
2176
+ * Adds a custom email domain to the organization.
2177
+ *
2178
+ * After adding the domain, you must:
2179
+ * 1. Configure the required DNS records (provided in the response)
2180
+ * 2. Verify the domain using the verification endpoint
2181
+ *
2182
+ * Until verification is complete, the domain cannot be used for sending emails.
2183
+ *
2184
+ */
2185
+ 'post'(
2186
+ parameters?: Parameters<UnknownParamsObject> | null,
2187
+ data?: Paths.AddDomain.RequestBody,
2188
+ config?: AxiosRequestConfig
2189
+ ): OperationResponse<Paths.AddDomain.Responses.$200>
2190
+ /**
2191
+ * deleteDomain - deleteDomain
2192
+ *
2193
+ * Removes a custom email domain from the organization.
2194
+ *
2195
+ * **Warning**: Deleting a domain will prevent sending emails from any addresses
2196
+ * using this domain. Existing email addresses on this domain should be removed
2197
+ * or reassigned before deleting the domain.
2198
+ *
2199
+ */
2200
+ 'delete'(
2201
+ parameters?: Parameters<UnknownParamsObject> | null,
2202
+ data?: Paths.DeleteDomain.RequestBody,
2203
+ config?: AxiosRequestConfig
2204
+ ): OperationResponse<Paths.DeleteDomain.Responses.$204>
2205
+ }
2206
+ ['/v1/email-settings/domain/name-servers:verify']: {
2207
+ /**
2208
+ * verifyNameServers - verifyNameServers
2209
+ *
2210
+ * Verifies that the domain's name server (NS) records are correctly configured.
2211
+ *
2212
+ * This check ensures that DNS resolution is properly set up for the domain
2213
+ * before proceeding with full domain verification.
2214
+ *
2215
+ * Run this verification after configuring NS records in your DNS provider.
2216
+ *
2217
+ */
2218
+ 'post'(
2219
+ parameters?: Parameters<UnknownParamsObject> | null,
2220
+ data?: Paths.VerifyNameServers.RequestBody,
2221
+ config?: AxiosRequestConfig
2222
+ ): OperationResponse<Paths.VerifyNameServers.Responses.$200>
2223
+ }
2224
+ ['/v1/email-settings/domain:verify']: {
2225
+ /**
2226
+ * verifyDomain - verifyDomain
2227
+ *
2228
+ * Verifies ownership and configuration of a custom email domain.
2229
+ *
2230
+ * Domain verification checks:
2231
+ * - DNS TXT records for domain ownership
2232
+ * - MX records for email routing
2233
+ * - SPF records for sender authentication
2234
+ * - DKIM records for email signing
2235
+ *
2236
+ * Once verified, the domain can be used to create email addresses and send emails.
2237
+ *
2238
+ */
2239
+ 'post'(
2240
+ parameters?: Parameters<UnknownParamsObject> | null,
2241
+ data?: Paths.VerifyDomain.RequestBody,
2242
+ config?: AxiosRequestConfig
2243
+ ): OperationResponse<Paths.VerifyDomain.Responses.$200>
2244
+ }
2245
+ }
2246
+
2247
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
2248
+
2249
+
2250
+ type ConnectedOutlookEmail = Components.Schemas.ConnectedOutlookEmail;
2251
+ type CreateEmailAddressPayload = Components.Schemas.CreateEmailAddressPayload;
2252
+ type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
2253
+ type Domain = Components.Schemas.Domain;
2254
+ type EmailAddressResponse = Components.Schemas.EmailAddressResponse;
2255
+ type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
2256
+ type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
2257
+ type ErrorResponse = Components.Schemas.ErrorResponse;
2258
+ type InboxBucketResponse = Components.Schemas.InboxBucketResponse;
2259
+ type MailboxSyncFolderStatuses = Components.Schemas.MailboxSyncFolderStatuses;
2260
+ type MailboxSyncStatus = Components.Schemas.MailboxSyncStatus;
2261
+ type MailboxSyncStatuses = Components.Schemas.MailboxSyncStatuses;
2262
+ type MailboxSyncTimeframePeriods = Components.Schemas.MailboxSyncTimeframePeriods;
2263
+ type OutlookConnectionError = Components.Schemas.OutlookConnectionError;
2264
+ type OutlookConnectionStatus = Components.Schemas.OutlookConnectionStatus;
2265
+ type ProvisionEpilotEmailAddressPayload = Components.Schemas.ProvisionEpilotEmailAddressPayload;
2266
+ type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
2267
+ type SetEmailAddressPrimaryPayload = Components.Schemas.SetEmailAddressPrimaryPayload;
2268
+ type Setting = Components.Schemas.Setting;
2269
+ type SettingMeta = Components.Schemas.SettingMeta;
2270
+ type SettingType = Components.Schemas.SettingType;
2271
+ type SettingsResponse = Components.Schemas.SettingsResponse;
2272
+ type SharedInboxResponse = Components.Schemas.SharedInboxResponse;
2273
+ type SignatureSetting = Components.Schemas.SignatureSetting;
2274
+ type UpdateEmailAddressPayload = Components.Schemas.UpdateEmailAddressPayload;
2275
+ type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
2276
+ type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;
2277
+
2278
+ export type { Client as C, Domain as D, EmailAddressResponse as E, InboxBucketResponse as I, MailboxSyncFolderStatuses as M, OperationMethods as O, PathsDictionary as P, RestrictDuplicatesWithinSetting as R, SetEmailAddressPrimaryPayload as S, UpdateEmailAddressPayload as U, WhitelistEmailAddressSetting as W, ConnectedOutlookEmail as a, CreateEmailAddressPayload as b, CreateSharedInboxPayload as c, EmailAddressSetting as d, EmailDomainSetting as e, ErrorResponse as f, MailboxSyncStatus as g, MailboxSyncStatuses as h, MailboxSyncTimeframePeriods as i, OutlookConnectionError as j, OutlookConnectionStatus as k, ProvisionEpilotEmailAddressPayload as l, Setting as m, SettingMeta as n, SettingType as o, SettingsResponse as p, SharedInboxResponse as q, SignatureSetting as r, UpdateSharedInboxPayload as s };