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