@rox-one/sdk 0.0.0-stage → 0.7.1

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 (483) hide show
  1. package/CALLS.md +82 -0
  2. package/README.md +1259 -2
  3. package/dist/chunk-AOHK5YXC.js +5585 -0
  4. package/dist/chunk-CATFKTFD.js +80 -0
  5. package/dist/chunk-FQGPXWPJ.js +1491 -0
  6. package/dist/chunk-G43PLP2U.js +1087 -0
  7. package/dist/chunk-LMJW65ML.js +836 -0
  8. package/dist/chunk-MCSQNZ4E.js +836 -0
  9. package/dist/chunk-NSJ3GKUC.js +1552 -0
  10. package/dist/chunk-OGFKJOK7.js +2068 -0
  11. package/dist/chunk-RDEJZJBZ.js +1351 -0
  12. package/dist/chunk-TMTYN2UK.js +1128 -0
  13. package/dist/chunk-V45LUJDI.js +838 -0
  14. package/dist/chunk-YRUXFEZM.js +1044 -0
  15. package/dist/chunk-ZYBAKW25.js +994 -0
  16. package/dist/generated/agent-fold/index.d.ts +4520 -0
  17. package/dist/generated/agent-fold/index.js +0 -0
  18. package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
  19. package/dist/generated/agent-harness/client/index.d.ts +10 -0
  20. package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
  21. package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
  22. package/dist/generated/agent-harness/client.gen.d.ts +12 -0
  23. package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
  24. package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
  25. package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
  26. package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
  27. package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
  28. package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
  29. package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
  30. package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
  31. package/dist/generated/agent-harness/index.d.ts +2 -0
  32. package/dist/generated/agent-harness/index.js +6 -0
  33. package/dist/generated/agent-harness/sdk.gen.d.ts +375 -0
  34. package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
  35. package/dist/generated/agent-reviews/index.d.ts +895 -0
  36. package/dist/generated/agent-reviews/index.js +0 -0
  37. package/dist/generated/auth/client/client.gen.d.ts +2 -0
  38. package/dist/generated/auth/client/index.d.ts +10 -0
  39. package/dist/generated/auth/client/types.gen.d.ts +120 -0
  40. package/dist/generated/auth/client/utils.gen.d.ts +37 -0
  41. package/dist/generated/auth/client.gen.d.ts +12 -0
  42. package/dist/generated/auth/core/auth.gen.d.ts +25 -0
  43. package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
  44. package/dist/generated/auth/core/params.gen.d.ts +43 -0
  45. package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
  46. package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
  47. package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
  48. package/dist/generated/auth/core/types.gen.d.ts +83 -0
  49. package/dist/generated/auth/core/utils.gen.d.ts +19 -0
  50. package/dist/generated/auth/index.d.ts +2 -0
  51. package/dist/generated/auth/index.js +6 -0
  52. package/dist/generated/auth/sdk.gen.d.ts +674 -0
  53. package/dist/generated/auth/types.gen.d.ts +5233 -0
  54. package/dist/generated/calendar/client/client.gen.d.ts +2 -0
  55. package/dist/generated/calendar/client/index.d.ts +10 -0
  56. package/dist/generated/calendar/client/types.gen.d.ts +120 -0
  57. package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
  58. package/dist/generated/calendar/client.gen.d.ts +12 -0
  59. package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
  60. package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
  61. package/dist/generated/calendar/core/params.gen.d.ts +43 -0
  62. package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
  63. package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
  64. package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
  65. package/dist/generated/calendar/core/types.gen.d.ts +83 -0
  66. package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
  67. package/dist/generated/calendar/index.d.ts +2 -0
  68. package/dist/generated/calendar/index.js +6 -0
  69. package/dist/generated/calendar/sdk.gen.d.ts +157 -0
  70. package/dist/generated/calendar/types.gen.d.ts +2333 -0
  71. package/dist/generated/cognition/client/client.gen.d.ts +2 -0
  72. package/dist/generated/cognition/client/index.d.ts +10 -0
  73. package/dist/generated/cognition/client/types.gen.d.ts +120 -0
  74. package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
  75. package/dist/generated/cognition/client.gen.d.ts +12 -0
  76. package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
  77. package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
  78. package/dist/generated/cognition/core/params.gen.d.ts +43 -0
  79. package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
  80. package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
  81. package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
  82. package/dist/generated/cognition/core/types.gen.d.ts +83 -0
  83. package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
  84. package/dist/generated/cognition/index.d.ts +2 -0
  85. package/dist/generated/cognition/index.js +6 -0
  86. package/dist/generated/cognition/sdk.gen.d.ts +348 -0
  87. package/dist/generated/cognition/types.gen.d.ts +4228 -0
  88. package/dist/generated/connection/client/client.gen.d.ts +2 -0
  89. package/dist/generated/connection/client/index.d.ts +10 -0
  90. package/dist/generated/connection/client/types.gen.d.ts +120 -0
  91. package/dist/generated/connection/client/utils.gen.d.ts +37 -0
  92. package/dist/generated/connection/client.gen.d.ts +12 -0
  93. package/dist/generated/connection/core/auth.gen.d.ts +25 -0
  94. package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
  95. package/dist/generated/connection/core/params.gen.d.ts +43 -0
  96. package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
  97. package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
  98. package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
  99. package/dist/generated/connection/core/types.gen.d.ts +83 -0
  100. package/dist/generated/connection/core/utils.gen.d.ts +19 -0
  101. package/dist/generated/connection/index.d.ts +2 -0
  102. package/dist/generated/connection/index.js +854 -0
  103. package/dist/generated/connection/sdk.gen.d.ts +43 -0
  104. package/dist/generated/connection/types.gen.d.ts +252 -0
  105. package/dist/generated/contacts/client/client.gen.d.ts +2 -0
  106. package/dist/generated/contacts/client/index.d.ts +10 -0
  107. package/dist/generated/contacts/client/types.gen.d.ts +120 -0
  108. package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
  109. package/dist/generated/contacts/client.gen.d.ts +12 -0
  110. package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
  111. package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
  112. package/dist/generated/contacts/core/params.gen.d.ts +43 -0
  113. package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
  114. package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
  115. package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
  116. package/dist/generated/contacts/core/types.gen.d.ts +83 -0
  117. package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
  118. package/dist/generated/contacts/index.d.ts +2 -0
  119. package/dist/generated/contacts/index.js +6 -0
  120. package/dist/generated/contacts/sdk.gen.d.ts +47 -0
  121. package/dist/generated/contacts/types.gen.d.ts +108 -0
  122. package/dist/generated/email/client/client.gen.d.ts +2 -0
  123. package/dist/generated/email/client/index.d.ts +10 -0
  124. package/dist/generated/email/client/types.gen.d.ts +120 -0
  125. package/dist/generated/email/client/utils.gen.d.ts +37 -0
  126. package/dist/generated/email/client.gen.d.ts +12 -0
  127. package/dist/generated/email/core/auth.gen.d.ts +25 -0
  128. package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
  129. package/dist/generated/email/core/params.gen.d.ts +43 -0
  130. package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
  131. package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
  132. package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
  133. package/dist/generated/email/core/types.gen.d.ts +83 -0
  134. package/dist/generated/email/core/utils.gen.d.ts +19 -0
  135. package/dist/generated/email/index.d.ts +2 -0
  136. package/dist/generated/email/index.js +6 -0
  137. package/dist/generated/email/sdk.gen.d.ts +301 -0
  138. package/dist/generated/email/types.gen.d.ts +3262 -0
  139. package/dist/generated/notification/client/client.gen.d.ts +2 -0
  140. package/dist/generated/notification/client/index.d.ts +10 -0
  141. package/dist/generated/notification/client/types.gen.d.ts +120 -0
  142. package/dist/generated/notification/client/utils.gen.d.ts +37 -0
  143. package/dist/generated/notification/client.gen.d.ts +12 -0
  144. package/dist/generated/notification/core/auth.gen.d.ts +25 -0
  145. package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
  146. package/dist/generated/notification/core/params.gen.d.ts +43 -0
  147. package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
  148. package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
  149. package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
  150. package/dist/generated/notification/core/types.gen.d.ts +83 -0
  151. package/dist/generated/notification/core/utils.gen.d.ts +19 -0
  152. package/dist/generated/notification/index.d.ts +2 -0
  153. package/dist/generated/notification/index.js +6 -0
  154. package/dist/generated/notification/sdk.gen.d.ts +127 -0
  155. package/dist/generated/notification/types.gen.d.ts +2084 -0
  156. package/dist/generated/properties/client/client.gen.d.ts +2 -0
  157. package/dist/generated/properties/client/index.d.ts +10 -0
  158. package/dist/generated/properties/client/types.gen.d.ts +120 -0
  159. package/dist/generated/properties/client/utils.gen.d.ts +37 -0
  160. package/dist/generated/properties/client.gen.d.ts +12 -0
  161. package/dist/generated/properties/core/auth.gen.d.ts +25 -0
  162. package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
  163. package/dist/generated/properties/core/params.gen.d.ts +43 -0
  164. package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
  165. package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
  166. package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
  167. package/dist/generated/properties/core/types.gen.d.ts +83 -0
  168. package/dist/generated/properties/core/utils.gen.d.ts +19 -0
  169. package/dist/generated/properties/index.d.ts +2 -0
  170. package/dist/generated/properties/index.js +6 -0
  171. package/dist/generated/properties/sdk.gen.d.ts +158 -0
  172. package/dist/generated/properties/types.gen.d.ts +1311 -0
  173. package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
  174. package/dist/generated/scheduled-action/client/index.d.ts +10 -0
  175. package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
  176. package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
  177. package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
  178. package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
  179. package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
  180. package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
  181. package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
  182. package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
  183. package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
  184. package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
  185. package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
  186. package/dist/generated/scheduled-action/index.d.ts +2 -0
  187. package/dist/generated/scheduled-action/index.js +6 -0
  188. package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
  189. package/dist/generated/scheduled-action/types.gen.d.ts +3099 -0
  190. package/dist/generated/search/client/client.gen.d.ts +2 -0
  191. package/dist/generated/search/client/index.d.ts +10 -0
  192. package/dist/generated/search/client/types.gen.d.ts +120 -0
  193. package/dist/generated/search/client/utils.gen.d.ts +37 -0
  194. package/dist/generated/search/client.gen.d.ts +12 -0
  195. package/dist/generated/search/core/auth.gen.d.ts +25 -0
  196. package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
  197. package/dist/generated/search/core/params.gen.d.ts +43 -0
  198. package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
  199. package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
  200. package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
  201. package/dist/generated/search/core/types.gen.d.ts +83 -0
  202. package/dist/generated/search/core/utils.gen.d.ts +19 -0
  203. package/dist/generated/search/index.d.ts +2 -0
  204. package/dist/generated/search/index.js +6 -0
  205. package/dist/generated/search/sdk.gen.d.ts +44 -0
  206. package/dist/generated/search/types.gen.d.ts +2532 -0
  207. package/dist/generated/static-files/client/client.gen.d.ts +2 -0
  208. package/dist/generated/static-files/client/index.d.ts +10 -0
  209. package/dist/generated/static-files/client/types.gen.d.ts +120 -0
  210. package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
  211. package/dist/generated/static-files/client.gen.d.ts +12 -0
  212. package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
  213. package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
  214. package/dist/generated/static-files/core/params.gen.d.ts +43 -0
  215. package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
  216. package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
  217. package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
  218. package/dist/generated/static-files/core/types.gen.d.ts +83 -0
  219. package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
  220. package/dist/generated/static-files/index.d.ts +2 -0
  221. package/dist/generated/static-files/index.js +842 -0
  222. package/dist/generated/static-files/sdk.gen.d.ts +43 -0
  223. package/dist/generated/static-files/types.gen.d.ts +220 -0
  224. package/dist/generated/storage/client/client.gen.d.ts +2 -0
  225. package/dist/generated/storage/client/index.d.ts +10 -0
  226. package/dist/generated/storage/client/types.gen.d.ts +120 -0
  227. package/dist/generated/storage/client/utils.gen.d.ts +37 -0
  228. package/dist/generated/storage/client.gen.d.ts +12 -0
  229. package/dist/generated/storage/core/auth.gen.d.ts +25 -0
  230. package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
  231. package/dist/generated/storage/core/params.gen.d.ts +43 -0
  232. package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
  233. package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
  234. package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
  235. package/dist/generated/storage/core/types.gen.d.ts +83 -0
  236. package/dist/generated/storage/core/utils.gen.d.ts +19 -0
  237. package/dist/generated/storage/index.d.ts +2 -0
  238. package/dist/generated/storage/index.js +6 -0
  239. package/dist/generated/storage/sdk.gen.d.ts +2285 -0
  240. package/dist/generated/storage/types.gen.d.ts +34546 -0
  241. package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
  242. package/dist/generated/unfurl/client/index.d.ts +10 -0
  243. package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
  244. package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
  245. package/dist/generated/unfurl/client.gen.d.ts +12 -0
  246. package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
  247. package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
  248. package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
  249. package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
  250. package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
  251. package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
  252. package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
  253. package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
  254. package/dist/generated/unfurl/index.d.ts +2 -0
  255. package/dist/generated/unfurl/index.js +6 -0
  256. package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
  257. package/dist/generated/unfurl/types.gen.d.ts +145 -0
  258. package/dist/src/calls/browser.d.ts +14 -0
  259. package/dist/src/calls/browser.js +102 -0
  260. package/dist/src/calls/common.d.ts +18 -0
  261. package/dist/src/calls/node.d.ts +24 -0
  262. package/dist/src/calls/node.js +145 -0
  263. package/dist/src/calls/telemetry.d.ts +5 -0
  264. package/dist/src/config.d.ts +71 -0
  265. package/dist/src/entities/account-managers/grant.d.ts +62 -0
  266. package/dist/src/entities/account-managers/namespace.d.ts +29 -0
  267. package/dist/src/entities/activity/entity.d.ts +7 -0
  268. package/dist/src/entities/activity/namespace.d.ts +58 -0
  269. package/dist/src/entities/activity/namespace.test.d.ts +1 -0
  270. package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
  271. package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
  272. package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
  273. package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
  274. package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
  275. package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
  276. package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
  277. package/dist/src/entities/agent-sessions/review.d.ts +114 -0
  278. package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
  279. package/dist/src/entities/agent-sessions/view.d.ts +11 -0
  280. package/dist/src/entities/agents/agent.d.ts +142 -0
  281. package/dist/src/entities/agents/namespace.d.ts +66 -0
  282. package/dist/src/entities/ai/namespace.d.ts +36 -0
  283. package/dist/src/entities/api-keys/api-key.d.ts +22 -0
  284. package/dist/src/entities/api-keys/namespace.d.ts +37 -0
  285. package/dist/src/entities/bots/bot.d.ts +143 -0
  286. package/dist/src/entities/bots/namespace.d.ts +50 -0
  287. package/dist/src/entities/bots/token.d.ts +39 -0
  288. package/dist/src/entities/calendar/booking-link.d.ts +55 -0
  289. package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
  290. package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
  291. package/dist/src/entities/calendar/booking.d.ts +97 -0
  292. package/dist/src/entities/calendar/calendar.d.ts +49 -0
  293. package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
  294. package/dist/src/entities/calendar/event.d.ts +283 -0
  295. package/dist/src/entities/calendar/event.test.d.ts +1 -0
  296. package/dist/src/entities/calendar/namespace.d.ts +334 -0
  297. package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
  298. package/dist/src/entities/calendar/replacement.d.ts +31 -0
  299. package/dist/src/entities/calls/call-record.d.ts +231 -0
  300. package/dist/src/entities/calls/connection.d.ts +59 -0
  301. package/dist/src/entities/calls/errors.d.ts +15 -0
  302. package/dist/src/entities/calls/message.d.ts +55 -0
  303. package/dist/src/entities/calls/namespace.d.ts +41 -0
  304. package/dist/src/entities/calls/participant.d.ts +22 -0
  305. package/dist/src/entities/canvases/canvas.d.ts +329 -0
  306. package/dist/src/entities/channels/access-request.d.ts +42 -0
  307. package/dist/src/entities/channels/activity.d.ts +40 -0
  308. package/dist/src/entities/channels/channel.d.ts +302 -0
  309. package/dist/src/entities/channels/labels.d.ts +73 -0
  310. package/dist/src/entities/channels/message.d.ts +153 -0
  311. package/dist/src/entities/channels/message.test.d.ts +1 -0
  312. package/dist/src/entities/channels/namespace.d.ts +82 -0
  313. package/dist/src/entities/channels/namespace.test.d.ts +1 -0
  314. package/dist/src/entities/channels/picture.d.ts +11 -0
  315. package/dist/src/entities/channels/post.d.ts +37 -0
  316. package/dist/src/entities/channels/post.test.d.ts +1 -0
  317. package/dist/src/entities/channels/share.d.ts +9 -0
  318. package/dist/src/entities/channels/share.test.d.ts +1 -0
  319. package/dist/src/entities/channels/thread.d.ts +64 -0
  320. package/dist/src/entities/chats/chat.d.ts +121 -0
  321. package/dist/src/entities/chats/generation.d.ts +55 -0
  322. package/dist/src/entities/chats/namespace.d.ts +35 -0
  323. package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
  324. package/dist/src/entities/connected-apps/connector.d.ts +59 -0
  325. package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
  326. package/dist/src/entities/crm/company.d.ts +154 -0
  327. package/dist/src/entities/crm/contact.d.ts +168 -0
  328. package/dist/src/entities/crm/namespace.d.ts +163 -0
  329. package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
  330. package/dist/src/entities/crm/pipeline.d.ts +426 -0
  331. package/dist/src/entities/crm/pipelines.d.ts +79 -0
  332. package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
  333. package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
  334. package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
  335. package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
  336. package/dist/src/entities/databases/column.d.ts +122 -0
  337. package/dist/src/entities/databases/database.d.ts +431 -0
  338. package/dist/src/entities/databases/namespace.d.ts +109 -0
  339. package/dist/src/entities/databases/query.d.ts +86 -0
  340. package/dist/src/entities/databases/row.d.ts +29 -0
  341. package/dist/src/entities/databases/saved-query.d.ts +151 -0
  342. package/dist/src/entities/databases/table.d.ts +124 -0
  343. package/dist/src/entities/databases/view.d.ts +72 -0
  344. package/dist/src/entities/databases/webhook.d.ts +39 -0
  345. package/dist/src/entities/documents/ai-edit.d.ts +54 -0
  346. package/dist/src/entities/documents/anchor.d.ts +39 -0
  347. package/dist/src/entities/documents/comment.d.ts +68 -0
  348. package/dist/src/entities/documents/create.test.d.ts +1 -0
  349. package/dist/src/entities/documents/document.d.ts +675 -0
  350. package/dist/src/entities/documents/markdown.d.ts +25 -0
  351. package/dist/src/entities/documents/namespace.d.ts +291 -0
  352. package/dist/src/entities/documents/office-files.d.ts +47 -0
  353. package/dist/src/entities/documents/skills.test.d.ts +1 -0
  354. package/dist/src/entities/documents/system-skill.d.ts +36 -0
  355. package/dist/src/entities/documents/text-comment.d.ts +41 -0
  356. package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
  357. package/dist/src/entities/documents/version.d.ts +26 -0
  358. package/dist/src/entities/email/attachment.d.ts +39 -0
  359. package/dist/src/entities/email/body-rox-compat.d.ts +22 -0
  360. package/dist/src/entities/email/draft.d.ts +164 -0
  361. package/dist/src/entities/email/filter.d.ts +44 -0
  362. package/dist/src/entities/email/label.d.ts +37 -0
  363. package/dist/src/entities/email/link.d.ts +35 -0
  364. package/dist/src/entities/email/message.d.ts +223 -0
  365. package/dist/src/entities/email/namespace.d.ts +235 -0
  366. package/dist/src/entities/email/namespace.test.d.ts +1 -0
  367. package/dist/src/entities/email/thread.d.ts +268 -0
  368. package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
  369. package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
  370. package/dist/src/entities/entity.d.ts +167 -0
  371. package/dist/src/entities/external-chat/chat.d.ts +173 -0
  372. package/dist/src/entities/external-chat/message.d.ts +54 -0
  373. package/dist/src/entities/external-chat/namespace.d.ts +22 -0
  374. package/dist/src/entities/external-chat/participant.d.ts +28 -0
  375. package/dist/src/entities/external-chat/send.d.ts +40 -0
  376. package/dist/src/entities/external-chat/upload.d.ts +25 -0
  377. package/dist/src/entities/favorites/namespace.d.ts +52 -0
  378. package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
  379. package/dist/src/entities/foreign/namespace.d.ts +54 -0
  380. package/dist/src/entities/forms/form.d.ts +319 -0
  381. package/dist/src/entities/forms/namespace.d.ts +30 -0
  382. package/dist/src/entities/forms/question.d.ts +65 -0
  383. package/dist/src/entities/forms/response.d.ts +52 -0
  384. package/dist/src/entities/forms/section.d.ts +31 -0
  385. package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
  386. package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
  387. package/dist/src/entities/harnesses/harness.d.ts +76 -0
  388. package/dist/src/entities/harnesses/namespace.d.ts +83 -0
  389. package/dist/src/entities/harnesses/pairing.d.ts +50 -0
  390. package/dist/src/entities/images/image.d.ts +88 -0
  391. package/dist/src/entities/images/namespace.d.ts +55 -0
  392. package/dist/src/entities/images/namespace.test.d.ts +1 -0
  393. package/dist/src/entities/imports/entry.d.ts +65 -0
  394. package/dist/src/entities/imports/namespace.d.ts +103 -0
  395. package/dist/src/entities/imports/namespace.test.d.ts +1 -0
  396. package/dist/src/entities/initiatives/initiative.d.ts +185 -0
  397. package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
  398. package/dist/src/entities/initiatives/namespace.d.ts +90 -0
  399. package/dist/src/entities/me/namespace.d.ts +68 -0
  400. package/dist/src/entities/meetings/meeting.d.ts +81 -0
  401. package/dist/src/entities/meetings/namespace.d.ts +38 -0
  402. package/dist/src/entities/memory/namespace.d.ts +49 -0
  403. package/dist/src/entities/memory/namespace.test.d.ts +1 -0
  404. package/dist/src/entities/messages/discussion.d.ts +84 -0
  405. package/dist/src/entities/messages/thread.d.ts +115 -0
  406. package/dist/src/entities/notifications/namespace.d.ts +66 -0
  407. package/dist/src/entities/notifications/notification.d.ts +78 -0
  408. package/dist/src/entities/notifications/notification.test.d.ts +1 -0
  409. package/dist/src/entities/passwords/item.d.ts +118 -0
  410. package/dist/src/entities/passwords/namespace.d.ts +45 -0
  411. package/dist/src/entities/pins/namespace.d.ts +42 -0
  412. package/dist/src/entities/projects/namespace.d.ts +45 -0
  413. package/dist/src/entities/projects/project.d.ts +108 -0
  414. package/dist/src/entities/properties/namespace.d.ts +105 -0
  415. package/dist/src/entities/properties/namespace.test.d.ts +1 -0
  416. package/dist/src/entities/properties/property-definition.d.ts +70 -0
  417. package/dist/src/entities/properties/property-option.d.ts +44 -0
  418. package/dist/src/entities/reference.d.ts +82 -0
  419. package/dist/src/entities/referrals/namespace.d.ts +40 -0
  420. package/dist/src/entities/routines/namespace.d.ts +239 -0
  421. package/dist/src/entities/routines/routine.d.ts +341 -0
  422. package/dist/src/entities/routines/suggestion.d.ts +38 -0
  423. package/dist/src/entities/saved-views/namespace.d.ts +58 -0
  424. package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
  425. package/dist/src/entities/search/exclusions.d.ts +6 -0
  426. package/dist/src/entities/search/namespace.d.ts +71 -0
  427. package/dist/src/entities/search/options.d.ts +30 -0
  428. package/dist/src/entities/search/types.d.ts +90 -0
  429. package/dist/src/entities/sharing/access.d.ts +120 -0
  430. package/dist/src/entities/sharing/permissions.d.ts +13 -0
  431. package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
  432. package/dist/src/entities/suggestions/namespace.d.ts +118 -0
  433. package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
  434. package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
  435. package/dist/src/entities/tasks/namespace.d.ts +77 -0
  436. package/dist/src/entities/tasks/task.d.ts +99 -0
  437. package/dist/src/entities/teams/invite.d.ts +33 -0
  438. package/dist/src/entities/teams/namespace.d.ts +23 -0
  439. package/dist/src/entities/teams/team.d.ts +129 -0
  440. package/dist/src/entities/ui/app-link.d.ts +24 -0
  441. package/dist/src/entities/ui/namespace.d.ts +75 -0
  442. package/dist/src/entities/unfurls/namespace.d.ts +24 -0
  443. package/dist/src/entities/users/namespace.d.ts +41 -0
  444. package/dist/src/entities/users/profile-picture.d.ts +29 -0
  445. package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
  446. package/dist/src/entities/users/user.d.ts +102 -0
  447. package/dist/src/entities/web/namespace.d.ts +67 -0
  448. package/dist/src/entities/web/namespace.test.d.ts +1 -0
  449. package/dist/src/entities/webhooks/namespace.d.ts +38 -0
  450. package/dist/src/entities/webhooks/webhook.d.ts +130 -0
  451. package/dist/src/entities/whatsapp/account.d.ts +24 -0
  452. package/dist/src/entities/whatsapp/chat.d.ts +62 -0
  453. package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
  454. package/dist/src/entities/workspace/items.d.ts +14 -0
  455. package/dist/src/entities/workspace/namespace.d.ts +96 -0
  456. package/dist/src/entities/workspace/query.d.ts +39 -0
  457. package/dist/src/entities/workspace/query.test.d.ts +1 -0
  458. package/dist/src/entities/workspace/types.d.ts +99 -0
  459. package/dist/src/events/hydrate/agentSession.d.ts +192 -0
  460. package/dist/src/events/hydrate/call.d.ts +101 -0
  461. package/dist/src/events/hydrate/channel.d.ts +55 -0
  462. package/dist/src/events/hydrate/document.d.ts +59 -0
  463. package/dist/src/events/hydrate/message.d.ts +70 -0
  464. package/dist/src/events/hydrate/user.d.ts +14 -0
  465. package/dist/src/events/receiver.d.ts +91 -0
  466. package/dist/src/events/types.d.ts +44 -0
  467. package/dist/src/events/verify.d.ts +13 -0
  468. package/dist/src/local-portmap.d.ts +8 -0
  469. package/dist/src/mentions.d.ts +42 -0
  470. package/dist/src/raw.d.ts +12 -0
  471. package/dist/src/rox.d.ts +268 -0
  472. package/dist/src/rox.js +23231 -0
  473. package/dist/src/utils/activity.d.ts +34 -0
  474. package/dist/src/utils/activity.test.d.ts +1 -0
  475. package/dist/src/utils/client.d.ts +62 -0
  476. package/dist/src/utils/concurrency.d.ts +5 -0
  477. package/dist/src/utils/index.d.ts +5 -0
  478. package/dist/src/utils/lazy.d.ts +37 -0
  479. package/dist/src/utils/options.d.ts +7 -0
  480. package/dist/src/utils/pagination.d.ts +28 -0
  481. package/dist/src/utils/unwrap.d.ts +48 -0
  482. package/dist/src/utils/verbs.d.ts +3 -0
  483. package/package.json +82 -4
@@ -0,0 +1,44 @@
1
+ import type { ApiEmailFilter } from '../../../generated/email/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import type { Link } from './link';
5
+ /** Sender importance rule. */
6
+ export interface EmailFilterOptions {
7
+ /** Match an address. */
8
+ emailAddress?: string;
9
+ /** Match a domain. */
10
+ emailDomain?: string;
11
+ /** Whether matches are important. */
12
+ isImportant: boolean;
13
+ }
14
+ /** An importance filter matched by sender address or domain. */
15
+ export declare class EmailFilter extends RoxEntity<ApiEmailFilter> {
16
+ private readonly inbox?;
17
+ private constructor();
18
+ private get headers();
19
+ /** Construct a lazy filter handle. */
20
+ static byId(client: RoxClient, id: string, inbox?: Link): EmailFilter;
21
+ /** Seed from a server record. */
22
+ static from(client: RoxClient, record: ApiEmailFilter, inbox?: Link): EmailFilter;
23
+ protected fetch(): Promise<ApiEmailFilter>;
24
+ /** Matched address. */
25
+ readonly emailAddress: () => Promise<string | undefined>;
26
+ /** Matched domain. */
27
+ readonly emailDomain: () => Promise<string | undefined>;
28
+ /** Importance assigned by this filter. */
29
+ readonly isImportant: () => Promise<boolean>;
30
+ /**
31
+ * Change the importance for the same sender selector.
32
+ *
33
+ * @write
34
+ * @idempotent
35
+ */
36
+ setImportant(isImportant: boolean): Promise<void>;
37
+ /**
38
+ * Delete this filter.
39
+ *
40
+ * @destructive
41
+ * @idempotent
42
+ */
43
+ delete(): Promise<void>;
44
+ }
@@ -0,0 +1,37 @@
1
+ import type { ApiLabel } from '../../../generated/email/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ /**
5
+ * An email label. A free-to-construct handle: there is no single-label GET,
6
+ * so the detail record loads lazily on first field access by listing all
7
+ * labels and finding this one (mirroring {@link Link}).
8
+ */
9
+ export declare class Label extends RoxEntity<ApiLabel> {
10
+ protected fetch(): Promise<ApiLabel>;
11
+ /** A handle to a label by id. Details load on first access. */
12
+ static byId(client: RoxClient, id: string): Label;
13
+ /** All labels across the user's inboxes. */
14
+ static list(client: RoxClient): Promise<Label[]>;
15
+ /** Create a user label. */
16
+ static create(client: RoxClient, name: string): Promise<Label>;
17
+ /**
18
+ * Delete this label.
19
+ *
20
+ * @destructive
21
+ * @openworld
22
+ * @idempotent
23
+ */
24
+ delete(): Promise<void>;
25
+ /** The label's display name. */
26
+ readonly name: () => Promise<string>;
27
+ /** The inbox (email link) this label belongs to. */
28
+ readonly linkId: () => Promise<string>;
29
+ /** Whether this is a system label or a user-created one. */
30
+ readonly type: () => Promise<import("../../../generated/email").ApiLabelType>;
31
+ /** When the label was created. */
32
+ readonly createdAt: () => Promise<string>;
33
+ /** Whether the label is shown in the label list. */
34
+ readonly labelListVisibility: () => Promise<import("../../../generated/email").ApiLabelListVisibility>;
35
+ /** Whether the label is shown in the message list. */
36
+ readonly messageListVisibility: () => Promise<import("../../../generated/email").ApiMessageListVisibility>;
37
+ }
@@ -0,0 +1,35 @@
1
+ import type { Link as LinkRecord, MailboxSettingsOperation } from '../../../generated/email/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ /**
5
+ * An email link: a connected inbox (e.g. Gmail or Outlook) that threads and
6
+ * messages sync through. A free-to-construct handle, resolved from the
7
+ * caller's connected links.
8
+ */
9
+ export declare class Link extends RoxEntity<LinkRecord> {
10
+ protected fetch(): Promise<LinkRecord>;
11
+ /** A handle to an email link by id. Details load on first access. */
12
+ static byId(client: RoxClient, id: string): Link;
13
+ /** The caller's connected email links. */
14
+ static list(client: RoxClient): Promise<Link[]>;
15
+ /** The inbox's email address. */
16
+ readonly emailAddress: () => Promise<string>;
17
+ /** The email provider (e.g. `GMAIL` or `OUTLOOK`). */
18
+ readonly provider: () => Promise<import("../../../generated/email").UserProvider>;
19
+ /** Whether this is the user's primary inbox. */
20
+ readonly isPrimary: () => Promise<boolean>;
21
+ /** Whether syncing is currently active for this inbox. */
22
+ readonly isSyncActive: () => Promise<boolean>;
23
+ /** The inbox's sync status. */
24
+ readonly syncStatus: () => Promise<import("../../../generated/email").SyncStatus>;
25
+ /** Whether the inbox needs to be re-authenticated. */
26
+ readonly needsReauth: () => Promise<boolean>;
27
+ /** The inbox's avatar URL, if any. */
28
+ readonly photoUrl: () => Promise<string | undefined>;
29
+ /**
30
+ * Read category and sender-policy changes for this inbox.
31
+ *
32
+ * @readonly
33
+ */
34
+ settingsOperations(): Promise<MailboxSettingsOperation[]>;
35
+ }
@@ -0,0 +1,223 @@
1
+ import type { EmailRecipient, SendEmail } from '../../../generated/agent-reviews';
2
+ import type { ApiDraftContactInfo, GetMessageResponses, MessageOperationResponse, ResolveMessageOperationRequest, TransferDraftRequest, TransferDraftResponse } from '../../../generated/email/types.gen';
3
+ import type { RoxClient } from '../../utils/client';
4
+ import type { Document } from '../documents/document';
5
+ import { RoxEntity } from '../entity';
6
+ import { EmailAttachment } from './attachment';
7
+ import type { Label } from './label';
8
+ import { Link } from './link';
9
+ import { EmailThread } from './thread';
10
+ /** The API's representation of an email message (`ParsedMessage`). */
11
+ export type EmailMessageData = GetMessageResponses[200];
12
+ /** Options for sending a fresh email message. */
13
+ export interface SendEmailOptions {
14
+ /** Recipients. */
15
+ to: ApiDraftContactInfo[];
16
+ /** Cc recipients. */
17
+ cc?: ApiDraftContactInfo[];
18
+ /** Bcc recipients. */
19
+ bcc?: ApiDraftContactInfo[];
20
+ /** Subject line. */
21
+ subject: string;
22
+ /** Plain-text body. */
23
+ bodyText: string;
24
+ /**
25
+ * The address to send from: the primary inbox's own address or one of its
26
+ * verified Gmail send-as aliases, which sends under the alias's display
27
+ * name. An unverified or unknown address is refused.
28
+ */
29
+ from?: string;
30
+ }
31
+ /** An email the user has approved in conversation, for `email.sendConfirmed`. */
32
+ export interface ConfirmedEmailOptions {
33
+ /** Recipients. */
34
+ to: EmailRecipient[];
35
+ /** Cc recipients. */
36
+ cc?: EmailRecipient[];
37
+ /** Bcc recipients. */
38
+ bcc?: EmailRecipient[];
39
+ /** Subject line. */
40
+ subject: string;
41
+ /** The body, written as Markdown; it is rendered to HTML on send. */
42
+ body: string;
43
+ /**
44
+ * The connected inbox to send from, or the address of a verified Gmail
45
+ * send-as alias of one, which then sends from that inbox under the alias's
46
+ * display name. Omit it unless you know which is right: a reply then goes
47
+ * out from the inbox that received the message it answers, and a new email
48
+ * from the user's primary inbox. An unverified alias is refused.
49
+ */
50
+ from?: Link | string;
51
+ /** The message this answers; the email is then sent as a reply in its thread. */
52
+ replyingTo?: EmailMessage;
53
+ /**
54
+ * Rox documents to attach as files: uploaded files (PDFs, images,
55
+ * spreadsheets, Word documents) the user can view, 18 MB together. An
56
+ * editor-native document has no file; link to it in the body instead.
57
+ */
58
+ attachments?: Document[];
59
+ /** `false` leaves the inbox signature off this one email; omit for the inbox's default. */
60
+ includeSignature?: boolean;
61
+ /**
62
+ * The user's own reply approving this specific email, quoted verbatim, such
63
+ * as their "yes, send it" after you wrote the email out for them. Never the
64
+ * request that asked you to write it, and never your own words.
65
+ */
66
+ userConfirmation: string;
67
+ }
68
+ /** A forward the user has approved, for `EmailMessage.forwardDraft` and `forwardConfirmed`. */
69
+ export interface ForwardEmailOptions {
70
+ /** Recipients. */
71
+ to: EmailRecipient[];
72
+ /** Cc recipients. */
73
+ cc?: EmailRecipient[];
74
+ /** Bcc recipients. */
75
+ bcc?: EmailRecipient[];
76
+ /** A note above the forwarded message, written as Markdown. */
77
+ body?: string;
78
+ /**
79
+ * The connected inbox to send from, or a verified Gmail send-as alias of
80
+ * one; defaults to the inbox holding the message.
81
+ */
82
+ from?: Link | string;
83
+ /** `false` leaves the inbox signature off this one email; omit for the inbox's default. */
84
+ includeSignature?: boolean;
85
+ }
86
+ /** A sent email: the message and the thread it belongs to. */
87
+ export interface SentEmail {
88
+ /** The sent message. */
89
+ message: EmailMessage;
90
+ /** The thread the message belongs to. */
91
+ thread: EmailThread;
92
+ }
93
+ /**
94
+ * A message in an email thread. A thin handle keyed by message id; the
95
+ * record loads lazily on first field access.
96
+ */
97
+ export declare class EmailMessage extends RoxEntity<EmailMessageData> {
98
+ protected fetch(): Promise<EmailMessageData>;
99
+ /** A handle to a message by id. Fields load on first access. */
100
+ static byId(client: RoxClient, id: string): EmailMessage;
101
+ /** Build a message from an already-fetched record (pre-seeded, no fetch). */
102
+ static from(client: RoxClient, data: EmailMessageData): EmailMessage;
103
+ /**
104
+ * Send a new plain-text email; an agent's program is refused (403) and
105
+ * sends through a review or {@link EmailMessage.sendConfirmed} instead.
106
+ * Returns a handle when the API reports the created message's id.
107
+ */
108
+ static send(client: RoxClient, opts: SendEmailOptions): Promise<EmailMessage | undefined>;
109
+ /** Send an email the user approved in conversation, quoting their approval; see `EmailNamespace.sendConfirmed`. */
110
+ static sendConfirmed(client: RoxClient, opts: ConfirmedEmailOptions): Promise<SentEmail>;
111
+ /** @internal Run the SendConfirmedEmail tool with a SendEmail draft and its approval. */
112
+ private static sendReviewedDraft;
113
+ /**
114
+ * The files attached to this message, from its thread's first 100 messages.
115
+ *
116
+ * @readonly
117
+ */
118
+ attachments(): Promise<EmailAttachment[]>;
119
+ /**
120
+ * This message as a forward: a SendEmail draft with the note, the quoted
121
+ * message under the forwarded-message header, and its attachments as
122
+ * Rox documents. Pass it to `execution.reviews.create({kind: 'email'})`
123
+ * in a session; in a thread, use {@link forwardConfirmed}.
124
+ *
125
+ * @write
126
+ * @idempotent
127
+ */
128
+ forwardDraft(opts: ForwardEmailOptions): Promise<SendEmail>;
129
+ /**
130
+ * Forward this message, with its attachments, only after the user replied approving the forward, quoting that reply in `userConfirmation`.
131
+ *
132
+ * For a prompt from a channel or document thread: write the forward out
133
+ * (recipients and note), ask whether to send it, and call this in a later
134
+ * turn on the user's approving reply. In the agent session view, present
135
+ * `forwardDraft` as a review instead. The forward is a new email that
136
+ * quotes this message and carries its attachments; it takes effect at once
137
+ * and is never retried.
138
+ *
139
+ * @send
140
+ * @openworld
141
+ */
142
+ forwardConfirmed(opts: ForwardEmailOptions & {
143
+ userConfirmation: string;
144
+ }): Promise<SentEmail>;
145
+ /** The message's subject line. */
146
+ readonly subject: () => Promise<string | undefined>;
147
+ /** The sender. */
148
+ readonly from: () => Promise<import("../../../generated/email").ContactInfo | undefined>;
149
+ /** The To recipients. */
150
+ readonly to: () => Promise<import("../../../generated/email").ContactInfo[]>;
151
+ /** The Cc recipients. */
152
+ readonly cc: () => Promise<import("../../../generated/email").ContactInfo[]>;
153
+ /** The Bcc recipients. */
154
+ readonly bcc: () => Promise<import("../../../generated/email").ContactInfo[]>;
155
+ /** The parsed message body, as the API returns it. */
156
+ readonly body: () => Promise<string | undefined>;
157
+ /** The provider-internal date of the message. */
158
+ readonly sentAt: () => Promise<string | undefined>;
159
+ /** Labels on this message. */
160
+ readonly labels: () => Promise<import("../../../generated/email").LabelInfo[]>;
161
+ /** The inbox (email link) this message belongs to. */
162
+ readonly link: () => Promise<Link>;
163
+ /**
164
+ * Read the draft's durable send, upload, or conflict status without retrying it.
165
+ *
166
+ * @readonly
167
+ */
168
+ operationStatus(): Promise<MessageOperationResponse>;
169
+ /** Resolve the displayed operation revision after the user chooses an action.
170
+ * Retrying an uncertain send requires explicit duplicate-risk acceptance.
171
+ *
172
+ * @destructive
173
+ * @openworld
174
+ */
175
+ resolveOperation(request: ResolveMessageOperationRequest): Promise<void>;
176
+ /**
177
+ * Verify an uploaded attachment using the draft generation captured when its upload began.
178
+ *
179
+ * @write
180
+ * @idempotent
181
+ */
182
+ completeDraftAttachment(attachmentId: string, draftGeneration?: number): Promise<void>;
183
+ /** Move a draft to another inbox using a caller-persisted operation UUID.
184
+ * Continue editing the returned message_id; the original identity is retired.
185
+ * On an interrupted response, use email.recoverDraftTransfer(operation_id).
186
+ *
187
+ * @write
188
+ * @openworld
189
+ * @idempotent
190
+ */
191
+ transferDraft(request: TransferDraftRequest): Promise<TransferDraftResponse>;
192
+ /**
193
+ * Add a label to this message.
194
+ *
195
+ * @write
196
+ * @openworld
197
+ * @idempotent
198
+ */
199
+ addLabel(label: Label): Promise<void>;
200
+ /**
201
+ * Remove a label from this message.
202
+ *
203
+ * @write
204
+ * @openworld
205
+ * @idempotent
206
+ */
207
+ removeLabel(label: Label): Promise<void>;
208
+ /**
209
+ * The thread this message belongs to.
210
+ *
211
+ * @readonly
212
+ */
213
+ thread(): Promise<EmailThread>;
214
+ /**
215
+ * The message's original source, exactly as Gmail or Outlook holds it, as
216
+ * `message/rfc822` bytes for an `.eml` file. Drafts and messages still on
217
+ * their way have no source yet and fail with a 404.
218
+ *
219
+ * @readonly
220
+ * @mcp-exclude Returns raw bytes only; MCP calls carry JSON.
221
+ */
222
+ downloadEml(): Promise<Blob>;
223
+ }
@@ -0,0 +1,235 @@
1
+ import type { EmailConnectionProviders } from '../../../generated/auth/types.gen';
2
+ import type { ApiSortMethod, TransferRecoveryResponse } from '../../../generated/email/types.gen';
3
+ import type { ListEmailRemindersData } from '../../../generated/storage/types.gen';
4
+ import { type IterationOptions } from '../../utils';
5
+ import type { RoxClient } from '../../utils/client';
6
+ import type { SearchOpts } from '../search/options';
7
+ import { EmailAttachment } from './attachment';
8
+ import { type DraftOptions, EmailDraft } from './draft';
9
+ import { EmailFilter, type EmailFilterOptions } from './filter';
10
+ import { Label } from './label';
11
+ import { Link } from './link';
12
+ import { type ConfirmedEmailOptions, EmailMessage, type SendEmailOptions, type SentEmail } from './message';
13
+ import { EmailThread } from './thread';
14
+ /** Options for listing inbox threads. */
15
+ export interface InboxOptions extends IterationOptions {
16
+ /** Threads fetched per request (default 50, max 500). */
17
+ pageSize?: number;
18
+ /** Sort order. Defaults to `viewed_updated`. */
19
+ sort?: ApiSortMethod;
20
+ }
21
+ /**
22
+ * @routing Use when reading, searching, labelling, drafting or sending email, or working across several inboxes; not channel messages or calendar invites.
23
+ *
24
+ * @agent
25
+ * ## Email inboxes
26
+ *
27
+ * - A user can have more than one inbox: their primary one, others they connected, and inboxes teammates delegated to them. `rox.email.links()` lists them; most users have one.
28
+ * - Searching and listing span every inbox the user can access unless you pass one. When the user means a specific mailbox ("my work inbox", "the shared inbox"), find it in `links()` and pass that link; never guess an address.
29
+ * - Labels are per inbox: a label from one inbox does not apply to a thread in another. Change a thread's labels with labels from the inbox that owns the thread.
30
+ *
31
+ * ## Sending email
32
+ *
33
+ * - Nothing leaves without the user seeing it. A program cannot call `send` or `EmailThread.reply`; they are refused, and so is a draft's `send` or `schedule` without `userConfirmation`.
34
+ * - In an agent session, present the email as a review: `execution.reviews.create({kind: 'email', title, drafts})`, each draft with the same fields as `sendConfirmed` (Markdown `body`, `to`/`cc`/`bcc`, `from` as the inbox's address or a verified send-as alias of it, `replyingToId`, `attachments: [{documentId}]`), then return `reviews: [await review.reference()]`. The user sends it from the card. For a forward, `await message.forwardDraft({to, body})` is the draft.
35
+ * - For a prompt from a channel or document thread, where no card is seen: write the whole email into your reply, ask whether to send it, and stop. Only once the user replies approving that email, send it with their reply quoted in `userConfirmation`: `sendConfirmed` for a new email or a reply, `EmailMessage.forwardConfirmed` for a forward, `EmailDraft.send` or `EmailDraft.schedule` for a saved draft. Being asked to send an email is a request to draft one, never the approval.
36
+ */
37
+ export declare class EmailNamespace {
38
+ private readonly client;
39
+ /**
40
+ * Create a draft without sending it; the inbox defaults to the caller's primary.
41
+ *
42
+ * @write
43
+ * @openworld
44
+ */
45
+ createDraft(options: DraftOptions, inbox?: Link): Promise<EmailDraft>;
46
+ /**
47
+ * Construct a lazy draft handle.
48
+ *
49
+ * @readonly
50
+ */
51
+ draftById(id: string): EmailDraft;
52
+ /**
53
+ * Scheduled drafts, fetched lazily in bounded pages.
54
+ *
55
+ * @readonly
56
+ */
57
+ scheduled(options?: {
58
+ pageSize?: number;
59
+ inbox?: Link;
60
+ maxItems?: number;
61
+ }): AsyncGenerator<EmailDraft>;
62
+ private scheduledPages;
63
+ /**
64
+ * Importance filters.
65
+ *
66
+ * @readonly
67
+ */
68
+ filters(inbox?: Link): Promise<EmailFilter[]>;
69
+ /**
70
+ * Create or replace a filter matching an address or domain.
71
+ *
72
+ * @write
73
+ * @idempotent
74
+ */
75
+ upsertFilter(options: EmailFilterOptions, inbox?: Link): Promise<EmailFilter>;
76
+ /**
77
+ * Address book contacts grouped by the service's interaction buckets.
78
+ *
79
+ * @readonly
80
+ */
81
+ contacts(): Promise<{
82
+ [key: string]: import("../../../generated/email").ContactInfoWithInteraction[];
83
+ }>;
84
+ /**
85
+ * Follow-up reminders with thread handles, automatically paginated; `maxItems` caps the total.
86
+ *
87
+ * @readonly
88
+ */
89
+ reminders(options?: Omit<NonNullable<ListEmailRemindersData['query']>, 'inboxIds' | 'cursor'> & {
90
+ inboxes?: Link[];
91
+ maxItems?: number;
92
+ }): AsyncGenerator<{
93
+ thread: EmailThread;
94
+ followup: import("../../../generated/storage").EmailFollowup;
95
+ }, any, any>;
96
+ constructor(client: RoxClient);
97
+ /** A handle to an email thread by id. */
98
+ byId(id: string): EmailThread;
99
+ /**
100
+ * A handle to an email message by id.
101
+ *
102
+ * @readonly
103
+ */
104
+ message(id: string): EmailMessage;
105
+ /**
106
+ * A handle to an email attachment by id.
107
+ *
108
+ * @readonly
109
+ */
110
+ attachment(id: string): EmailAttachment;
111
+ /**
112
+ * A handle to a connected inbox (email link) by id.
113
+ *
114
+ * @readonly
115
+ */
116
+ link(id: string): Link;
117
+ /**
118
+ * The caller's connected inboxes (email links).
119
+ *
120
+ * @readonly
121
+ */
122
+ links(): Promise<Link[]>;
123
+ /**
124
+ * Providers the server currently permits this caller to connect.
125
+ *
126
+ * @readonly
127
+ */
128
+ connectionProviders(): Promise<EmailConnectionProviders>;
129
+ /** Recover a draft move using its original operation UUID; never starts a new move.
130
+ * An empty committed result fences the old move so it cannot commit later.
131
+ *
132
+ * @write
133
+ * @openworld
134
+ * @idempotent
135
+ */
136
+ recoverDraftTransfer(operationId: string): Promise<TransferRecoveryResponse>;
137
+ /**
138
+ * Send a new plain-text email; an agent's program is refused (403) and
139
+ * sends through a review or {@link sendConfirmed} instead.
140
+ *
141
+ * @send
142
+ * @openworld
143
+ */
144
+ send(opts: SendEmailOptions): Promise<EmailMessage | undefined>;
145
+ /**
146
+ * Send an email only after the user replied approving it, quoting that reply in `userConfirmation`; never on the request that asked for the email.
147
+ *
148
+ * For a prompt from a channel or document thread: write the email out
149
+ * there, ask whether to send it, and call this in a later turn on the
150
+ * user's approving reply. In the agent session view, present a review
151
+ * (`execution.reviews.create({kind: 'email', ...})`) instead; its card is
152
+ * the confirmation. Takes what the SendEmail tool takes: a Markdown body,
153
+ * Cc/Bcc, the inbox to send from, the message to reply to (sent in its
154
+ * thread) and Rox documents to attach. The send takes effect at once and
155
+ * is never retried; on an error, look for the message in the thread before
156
+ * sending again.
157
+ *
158
+ * @send
159
+ * @openworld
160
+ */
161
+ sendConfirmed(opts: ConfirmedEmailOptions): Promise<SentEmail>;
162
+ /**
163
+ * Search email threads by subject and content. To find a person's emails,
164
+ * search for their quoted email address, not their name: a name only
165
+ * matches where that display name appears. Resolve the address first, for
166
+ * example with `rox.users.search(name)`.
167
+ *
168
+ * @readonly
169
+ */
170
+ search(query: string, opts?: SearchOpts): AsyncGenerator<EmailThread>;
171
+ /**
172
+ * The threads in the inbox, most recent first, auto-paginated; `maxItems` caps the total.
173
+ *
174
+ * @readonly
175
+ */
176
+ inbox(opts?: InboxOptions): AsyncGenerator<EmailThread>;
177
+ /**
178
+ * A handle to a label by id.
179
+ *
180
+ * @readonly
181
+ */
182
+ label(id: string): Label;
183
+ /**
184
+ * All labels across the user's inboxes.
185
+ *
186
+ * @readonly
187
+ */
188
+ labels(): Promise<Label[]>;
189
+ /**
190
+ * Create a user label. Returns the created label.
191
+ *
192
+ * @write
193
+ * @openworld
194
+ */
195
+ createLabel(name: string): Promise<Label>;
196
+ /**
197
+ * Archive many threads (or unarchive with `false`). Resolves to the threads
198
+ * whose state could not change.
199
+ *
200
+ * @write
201
+ * @openworld
202
+ * @idempotent
203
+ */
204
+ archive(threads: EmailThread[], archived?: boolean): Promise<EmailThread[]>;
205
+ /**
206
+ * Delete a label.
207
+ *
208
+ * @destructive
209
+ * @openworld
210
+ * @idempotent
211
+ */
212
+ deleteLabel(label: Label): Promise<void>;
213
+ /**
214
+ * Block an email sender.
215
+ *
216
+ * @write
217
+ * @openworld
218
+ * @idempotent
219
+ */
220
+ blockSender(email: string): Promise<void>;
221
+ /**
222
+ * Unblock a previously blocked sender.
223
+ *
224
+ * @write
225
+ * @openworld
226
+ * @idempotent
227
+ */
228
+ unblockSender(email: string): Promise<void>;
229
+ /**
230
+ * The email addresses currently blocked.
231
+ *
232
+ * @readonly
233
+ */
234
+ blockedSenders(): Promise<string[]>;
235
+ }
@@ -0,0 +1 @@
1
+ export {};