@rox-one/sdk 0.0.0-stage → 0.7.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 (482) 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/draft.d.ts +160 -0
  360. package/dist/src/entities/email/filter.d.ts +44 -0
  361. package/dist/src/entities/email/label.d.ts +37 -0
  362. package/dist/src/entities/email/link.d.ts +35 -0
  363. package/dist/src/entities/email/message.d.ts +223 -0
  364. package/dist/src/entities/email/namespace.d.ts +235 -0
  365. package/dist/src/entities/email/namespace.test.d.ts +1 -0
  366. package/dist/src/entities/email/thread.d.ts +268 -0
  367. package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
  368. package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
  369. package/dist/src/entities/entity.d.ts +167 -0
  370. package/dist/src/entities/external-chat/chat.d.ts +173 -0
  371. package/dist/src/entities/external-chat/message.d.ts +54 -0
  372. package/dist/src/entities/external-chat/namespace.d.ts +22 -0
  373. package/dist/src/entities/external-chat/participant.d.ts +28 -0
  374. package/dist/src/entities/external-chat/send.d.ts +40 -0
  375. package/dist/src/entities/external-chat/upload.d.ts +25 -0
  376. package/dist/src/entities/favorites/namespace.d.ts +52 -0
  377. package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
  378. package/dist/src/entities/foreign/namespace.d.ts +54 -0
  379. package/dist/src/entities/forms/form.d.ts +319 -0
  380. package/dist/src/entities/forms/namespace.d.ts +30 -0
  381. package/dist/src/entities/forms/question.d.ts +65 -0
  382. package/dist/src/entities/forms/response.d.ts +52 -0
  383. package/dist/src/entities/forms/section.d.ts +31 -0
  384. package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
  385. package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
  386. package/dist/src/entities/harnesses/harness.d.ts +76 -0
  387. package/dist/src/entities/harnesses/namespace.d.ts +83 -0
  388. package/dist/src/entities/harnesses/pairing.d.ts +50 -0
  389. package/dist/src/entities/images/image.d.ts +88 -0
  390. package/dist/src/entities/images/namespace.d.ts +55 -0
  391. package/dist/src/entities/images/namespace.test.d.ts +1 -0
  392. package/dist/src/entities/imports/entry.d.ts +65 -0
  393. package/dist/src/entities/imports/namespace.d.ts +103 -0
  394. package/dist/src/entities/imports/namespace.test.d.ts +1 -0
  395. package/dist/src/entities/initiatives/initiative.d.ts +185 -0
  396. package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
  397. package/dist/src/entities/initiatives/namespace.d.ts +90 -0
  398. package/dist/src/entities/me/namespace.d.ts +68 -0
  399. package/dist/src/entities/meetings/meeting.d.ts +81 -0
  400. package/dist/src/entities/meetings/namespace.d.ts +38 -0
  401. package/dist/src/entities/memory/namespace.d.ts +49 -0
  402. package/dist/src/entities/memory/namespace.test.d.ts +1 -0
  403. package/dist/src/entities/messages/discussion.d.ts +84 -0
  404. package/dist/src/entities/messages/thread.d.ts +115 -0
  405. package/dist/src/entities/notifications/namespace.d.ts +66 -0
  406. package/dist/src/entities/notifications/notification.d.ts +78 -0
  407. package/dist/src/entities/notifications/notification.test.d.ts +1 -0
  408. package/dist/src/entities/passwords/item.d.ts +118 -0
  409. package/dist/src/entities/passwords/namespace.d.ts +45 -0
  410. package/dist/src/entities/pins/namespace.d.ts +42 -0
  411. package/dist/src/entities/projects/namespace.d.ts +45 -0
  412. package/dist/src/entities/projects/project.d.ts +108 -0
  413. package/dist/src/entities/properties/namespace.d.ts +105 -0
  414. package/dist/src/entities/properties/namespace.test.d.ts +1 -0
  415. package/dist/src/entities/properties/property-definition.d.ts +70 -0
  416. package/dist/src/entities/properties/property-option.d.ts +44 -0
  417. package/dist/src/entities/reference.d.ts +82 -0
  418. package/dist/src/entities/referrals/namespace.d.ts +40 -0
  419. package/dist/src/entities/routines/namespace.d.ts +239 -0
  420. package/dist/src/entities/routines/routine.d.ts +341 -0
  421. package/dist/src/entities/routines/suggestion.d.ts +38 -0
  422. package/dist/src/entities/saved-views/namespace.d.ts +58 -0
  423. package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
  424. package/dist/src/entities/search/exclusions.d.ts +6 -0
  425. package/dist/src/entities/search/namespace.d.ts +71 -0
  426. package/dist/src/entities/search/options.d.ts +30 -0
  427. package/dist/src/entities/search/types.d.ts +90 -0
  428. package/dist/src/entities/sharing/access.d.ts +120 -0
  429. package/dist/src/entities/sharing/permissions.d.ts +13 -0
  430. package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
  431. package/dist/src/entities/suggestions/namespace.d.ts +118 -0
  432. package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
  433. package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
  434. package/dist/src/entities/tasks/namespace.d.ts +77 -0
  435. package/dist/src/entities/tasks/task.d.ts +99 -0
  436. package/dist/src/entities/teams/invite.d.ts +33 -0
  437. package/dist/src/entities/teams/namespace.d.ts +23 -0
  438. package/dist/src/entities/teams/team.d.ts +129 -0
  439. package/dist/src/entities/ui/app-link.d.ts +24 -0
  440. package/dist/src/entities/ui/namespace.d.ts +75 -0
  441. package/dist/src/entities/unfurls/namespace.d.ts +24 -0
  442. package/dist/src/entities/users/namespace.d.ts +41 -0
  443. package/dist/src/entities/users/profile-picture.d.ts +29 -0
  444. package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
  445. package/dist/src/entities/users/user.d.ts +102 -0
  446. package/dist/src/entities/web/namespace.d.ts +67 -0
  447. package/dist/src/entities/web/namespace.test.d.ts +1 -0
  448. package/dist/src/entities/webhooks/namespace.d.ts +38 -0
  449. package/dist/src/entities/webhooks/webhook.d.ts +130 -0
  450. package/dist/src/entities/whatsapp/account.d.ts +24 -0
  451. package/dist/src/entities/whatsapp/chat.d.ts +62 -0
  452. package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
  453. package/dist/src/entities/workspace/items.d.ts +14 -0
  454. package/dist/src/entities/workspace/namespace.d.ts +96 -0
  455. package/dist/src/entities/workspace/query.d.ts +39 -0
  456. package/dist/src/entities/workspace/query.test.d.ts +1 -0
  457. package/dist/src/entities/workspace/types.d.ts +99 -0
  458. package/dist/src/events/hydrate/agentSession.d.ts +192 -0
  459. package/dist/src/events/hydrate/call.d.ts +101 -0
  460. package/dist/src/events/hydrate/channel.d.ts +55 -0
  461. package/dist/src/events/hydrate/document.d.ts +59 -0
  462. package/dist/src/events/hydrate/message.d.ts +70 -0
  463. package/dist/src/events/hydrate/user.d.ts +14 -0
  464. package/dist/src/events/receiver.d.ts +91 -0
  465. package/dist/src/events/types.d.ts +44 -0
  466. package/dist/src/events/verify.d.ts +13 -0
  467. package/dist/src/local-portmap.d.ts +8 -0
  468. package/dist/src/mentions.d.ts +42 -0
  469. package/dist/src/raw.d.ts +12 -0
  470. package/dist/src/rox.d.ts +267 -0
  471. package/dist/src/rox.js +23217 -0
  472. package/dist/src/utils/activity.d.ts +34 -0
  473. package/dist/src/utils/activity.test.d.ts +1 -0
  474. package/dist/src/utils/client.d.ts +62 -0
  475. package/dist/src/utils/concurrency.d.ts +5 -0
  476. package/dist/src/utils/index.d.ts +5 -0
  477. package/dist/src/utils/lazy.d.ts +37 -0
  478. package/dist/src/utils/options.d.ts +7 -0
  479. package/dist/src/utils/pagination.d.ts +28 -0
  480. package/dist/src/utils/unwrap.d.ts +48 -0
  481. package/dist/src/utils/verbs.d.ts +3 -0
  482. package/package.json +82 -4
@@ -0,0 +1,14 @@
1
+ import type { SoupApiItem, SoupProperty } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { WorkspaceItem, WorkspaceTag } from './types';
4
+ /** @internal */
5
+ export declare function properties(item: SoupApiItem): SoupProperty[];
6
+ /**
7
+ * The caller-visible labels of an item's tag properties, deduplicated; option
8
+ * ids outside the caller's tag sets are left out.
9
+ *
10
+ * @internal
11
+ */
12
+ export declare function visibleTags(properties: readonly Pick<SoupProperty, 'definition' | 'value'>[], tagMap: Map<string, WorkspaceTag>): WorkspaceTag[];
13
+ /** @internal */
14
+ export declare function workspaceItem(client: RoxClient, item: SoupApiItem, tagMap: Map<string, WorkspaceTag>): WorkspaceItem;
@@ -0,0 +1,96 @@
1
+ import { type IterationOptions } from '../../utils';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { WorkspaceItem, WorkspaceListOptions, WorkspacePage, WorkspacePageOptions } from './types';
4
+ /**
5
+ * Browse recent workspace documents (including tasks), agent sessions, AI chats,
6
+ * projects, email, channels, message threads, calls, calendar events and
7
+ * foreign entities. Queries run with the caller's normal access permissions.
8
+ * Use `macro.search` to find specific names/content; use this namespace for
9
+ * activity and filtered lists.
10
+ *
11
+ * Each item has an existing `entity` handle plus a generated API `snapshot` for
12
+ * reading metadata without another request. Calendar snapshots contain event time
13
+ * and conference details; calendar handles support operations, but cannot fetch
14
+ * event details by ID. Use `snapshot.data` when the listing already has your data.
15
+ *
16
+ * @example Important emails from a particular accessible inbox
17
+ * ```js
18
+ * const page = await macro.workspace.page({
19
+ * emailPreset: 'signal', inbox: 'team@example.com', limit: 20,
20
+ * });
21
+ * const evidence = page.items.map(item => ({
22
+ * id: item.id, ...item.type === 'email' ? {
23
+ * subject: item.subject, snippet: item.snippet, sender: item.senderEmail,
24
+ * } : {},
25
+ * }));
26
+ * // Report page.hasMore; this bounded page is not exhaustive.
27
+ * ```
28
+ *
29
+ * @example Tasks assigned to me, completed and updated within a time window
30
+ * ```js
31
+ * const owner = await macro.myPrincipalId();
32
+ * const tasks = macro.workspace.list({
33
+ * includeTypes: ['document'],
34
+ * df: {'&': [{l: {dst: 'task'}}, {'&': [
35
+ * {l: {ua: {gte: '2026-10-14T00:00:00Z'}}},
36
+ * {l: {ua: {lt: '2026-10-15T00:00:00Z'}}},
37
+ * ]}]},
38
+ * propf: {'&': [
39
+ * {l: {pd: '00000001-0000-0000-0000-000000000002', et: 'TASK',
40
+ * v: {so: '00000001-0000-0000-0002-000000000004'}}},
41
+ * {l: {pd: '00000001-0000-0000-0000-000000000001', et: 'TASK',
42
+ * v: {er: owner}}},
43
+ * ]},
44
+ * });
45
+ * for await (const item of tasks) {
46
+ * if (item.type === 'document') console.log(item.id, item.name);
47
+ * }
48
+ * // updatedAt is not a completion timestamp; describe this scope accurately.
49
+ * ```
50
+ *
51
+ * @example Personal and team tags, favorites, and early stopping
52
+ * ```js
53
+ * let count = 0;
54
+ * for await (const item of macro.workspace.list({
55
+ * favoritesOnly: true, sortBy: 'recently_viewed',
56
+ * tags: [{label: 'Launch', scope: 'team'}], tagsMatch: 'all',
57
+ * })) {
58
+ * console.log(item.type, item.id, item.tags);
59
+ * if (++count === 10) break; // No subsequent page is fetched.
60
+ * }
61
+ * ```
62
+ *
63
+ * A single filter is `{l: {dst: 'task'}}`; `&` and `|` require exactly two
64
+ * expressions, nested for larger combinations.
65
+ * Advanced filters use the normal API AST. `df` accepts `dst` (task/skill/snippet),
66
+ * `ft`, `id`, `pid`, and `ca`/`ua` timestamp bounds. `ef` supports `Sender`,
67
+ * `Recipient`, `Read`, `ThreadId`, `ca`/`ua`/`va`; `chanf` supports `ChannelId`,
68
+ * `Sender`, `IsParticipant`; `cthf` supports `ChannelId`/`ThreadId`; `callf`
69
+ * supports `CallId`/`ChannelId`/`Speaker`/`Attended`; `asf` supports `id`, `o`
70
+ * (owner principal), `src` and `vis`. Filters remain server-validated.
71
+ * CRM, initiatives and database rows have their own namespaces and are not
72
+ * included in this browsing surface.
73
+ *
74
+ * @routing Use when browsing the user's recent or filtered workspace items, such as what changed today; not keyword search (`macro.search`).
75
+ */
76
+ export declare class WorkspaceNamespace {
77
+ private readonly client;
78
+ constructor(client: RoxClient);
79
+ /**
80
+ * One bounded page of recent items, newest first by default; resume using nextCursor and the same options.
81
+ *
82
+ * @readonly
83
+ */
84
+ page(options?: WorkspacePageOptions): Promise<WorkspacePage>;
85
+ /**
86
+ * Every matching item, newest first by default, auto-paginated; `maxItems` caps the total. `limit` is a
87
+ * page size; `maxItems` caps the total.
88
+ * Break a `for await` loop to stop; no speculative next page is fetched.
89
+ * Tag/inbox resolution is reused within this iterator.
90
+ *
91
+ * @readonly
92
+ */
93
+ list(options?: WorkspaceListOptions & IterationOptions): AsyncGenerator<WorkspaceItem>;
94
+ private listPages;
95
+ private fetch;
96
+ }
@@ -0,0 +1,39 @@
1
+ import type { Link as EmailLink } from '../../../generated/email/types.gen';
2
+ import type { PostSoupAstRequest } from '../../../generated/storage/types.gen';
3
+ import type { RoxClient } from '../../utils/client';
4
+ import type { WorkspaceListOptions, WorkspaceTag } from './types';
5
+ /** A tag label as a filter names it: any scope unless one is given. */
6
+ export type TagFilter = {
7
+ label: string;
8
+ scope?: 'personal' | 'team';
9
+ };
10
+ /** One of the caller's tag options. */
11
+ type ResolvedTag = WorkspaceTag & {
12
+ id: string;
13
+ definitionId: string;
14
+ };
15
+ /**
16
+ * @internal
17
+ *
18
+ * @mcp-exclude Internal query-building helper, not reachable from the `Rox` client.
19
+ */
20
+ export declare class WorkspaceQuery {
21
+ private readonly client;
22
+ private tagSets?;
23
+ constructor(client: RoxClient);
24
+ private sets;
25
+ tagMap(): Promise<Map<string, WorkspaceTag>>;
26
+ /**
27
+ * The connected inbox an address names, matched case-insensitively; none for
28
+ * a blank address. An unknown or ambiguous address fails with the choices.
29
+ */
30
+ inbox(address: string | undefined): Promise<EmailLink | undefined>;
31
+ /**
32
+ * The caller's tag options that the labels name, deduplicated. An unknown
33
+ * label fails with the available tags; with `all`, so does a label both
34
+ * scopes share, rather than guessing one.
35
+ */
36
+ tags(filters: TagFilter[] | undefined, match: 'any' | 'all' | undefined): Promise<ResolvedTag[]>;
37
+ body(options: WorkspaceListOptions): Promise<PostSoupAstRequest>;
38
+ }
39
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,99 @@
1
+ import type { ApiEntityFilterAst, SoupApiItem } from '../../../generated/storage/types.gen';
2
+ import type { AgentSession } from '../agent-sessions/agent-session';
3
+ import type { CalendarEvent } from '../calendar/event';
4
+ import type { CallRecord } from '../calls/call-record';
5
+ import type { Channel } from '../channels/channel';
6
+ import type { Thread } from '../channels/thread';
7
+ import type { Chat } from '../chats/chat';
8
+ import type { Document } from '../documents/document';
9
+ import type { EmailThread } from '../email/thread';
10
+ import type { ForeignEntity } from '../foreign/foreign-entity';
11
+ import type { Project } from '../projects/project';
12
+ /** Workspace types supported by the browsing API. Tasks are documents. */
13
+ export type WorkspaceType = 'agent_session' | 'calendar_event' | 'document' | 'ai_chat' | 'project' | 'email' | 'channel' | 'channel_thread' | 'call' | 'foreign_entity';
14
+ /** A tag label visible to the caller, optionally qualified by ownership scope. */
15
+ export type WorkspaceTag = {
16
+ label: string;
17
+ scope: 'personal' | 'team';
18
+ };
19
+ /**
20
+ * Server-validated AST filters, identical to the normal workspace API. Use
21
+ * `{l: literal}`, `{'&': [left, right]}`, `{'|': [left, right]}` or `{'!': expr}`.
22
+ * `&` and `|` require exactly two expressions; nest them for three or more.
23
+ * A single condition is `{l: literal}` without an `&` wrapper.
24
+ * Each entity filter applies only to that type; `propf` applies across types.
25
+ * See {@link WorkspaceNamespace} for task and time-window examples.
26
+ */
27
+ export type WorkspaceFilters = Pick<ApiEntityFilterAst, 'df' | 'pf' | 'cf' | 'ef' | 'chanf' | 'cthf' | 'callf' | 'fef' | 'calf' | 'asf' | 'propf'>;
28
+ /** Options shared by bounded pages and automatic iteration. */
29
+ export type WorkspaceListOptions = WorkspaceFilters & {
30
+ /** Omitted or empty means all supported types; signal defaults to email when omitted. */
31
+ includeTypes?: WorkspaceType[];
32
+ favoritesOnly?: boolean;
33
+ /** Defaults to recently_updated, descending. */
34
+ sortBy?: 'recently_viewed' | 'recently_updated' | 'recently_created';
35
+ /** Page size, default 50, clamped to 1–500. Iteration may fetch many pages. */
36
+ limit?: number;
37
+ /** Case-insensitive labels resolved against the caller's personal/team tags. */
38
+ tags?: Array<{
39
+ label: string;
40
+ scope?: 'personal' | 'team';
41
+ }>;
42
+ /** Default any. All rejects ambiguous unscoped labels rather than guessing. */
43
+ tagsMatch?: 'any' | 'all';
44
+ /** Connected inbox email address. Omit to include all accessible/delegated inboxes. */
45
+ inbox?: string;
46
+ /** Important/signal email: overrides ef with Importance=true AND Shared=exclude. */
47
+ emailPreset?: 'signal';
48
+ /** Default inbox. Use signal + inbox for important emails, not the important view. */
49
+ emailView?: 'inbox' | 'sent' | 'drafts' | 'starred' | 'all' | 'important' | 'other' | `user:${string}`;
50
+ };
51
+ /** Resume a page with its opaque cursor and the same options. */
52
+ export type WorkspacePageOptions = WorkspaceListOptions & {
53
+ cursor?: string;
54
+ };
55
+ type Entry<Tag extends SoupApiItem['tag'], Type extends WorkspaceType, Entity> = {
56
+ type: Type;
57
+ id: string;
58
+ /** Existing entity handle for subsequent reads or mutations; no eager detail fetch. */
59
+ entity: Entity;
60
+ /** Full generated API snapshot, including timestamps and type-specific metadata. */
61
+ snapshot: Extract<SoupApiItem, {
62
+ tag: Tag;
63
+ }>;
64
+ /** Visible labels only; option IDs outside the caller's tag sets are excluded. */
65
+ tags: WorkspaceTag[];
66
+ };
67
+ /** Discriminated listing result. Read snapshot data without additional API calls. */
68
+ export type WorkspaceItem = (Entry<'document', 'document', Document> & {
69
+ name: string;
70
+ fileType?: string | null;
71
+ subType?: string | null;
72
+ }) | (Entry<'chat', 'ai_chat', Chat> & {
73
+ name: string;
74
+ }) | (Entry<'project', 'project', Project> & {
75
+ name: string;
76
+ }) | (Entry<'emailThread', 'email', EmailThread> & Pick<Extract<SoupApiItem, {
77
+ tag: 'emailThread';
78
+ }>['data'], 'snippet' | 'senderName' | 'senderEmail' | 'inboxVisible' | 'isRead' | 'isDraft'> & {
79
+ subject?: string | null;
80
+ }) | (Entry<'channel', 'channel', Channel> & {
81
+ name?: string | null;
82
+ }) | (Entry<'channelThread', 'channel_thread', Thread> & {
83
+ channelId: string;
84
+ }) | (Entry<'call', 'call', CallRecord> & {
85
+ createdBy: string;
86
+ }) | (Entry<'calendarEvent', 'calendar_event', CalendarEvent> & Pick<Extract<SoupApiItem, {
87
+ tag: 'calendarEvent';
88
+ }>['data'], 'title' | 'status' | 'location' | 'conferenceUrl' | 'conferenceProvider' | 'time'>) | (Entry<'agentSession', 'agent_session', AgentSession> & Pick<Extract<SoupApiItem, {
89
+ tag: 'agentSession';
90
+ }>['data'], 'name' | 'archivedAt' | 'pullRequestUrl' | 'repoUrl'>) | (Entry<'foreignEntity', 'foreign_entity', ForeignEntity> & Pick<Extract<SoupApiItem, {
91
+ tag: 'foreignEntity';
92
+ }>['data'], 'foreignEntityId' | 'foreignEntitySource' | 'metadata'>);
93
+ /** A bounded page. A cursor means more results exist, not an exact total count. */
94
+ export type WorkspacePage = {
95
+ items: WorkspaceItem[];
96
+ nextCursor?: string | null;
97
+ hasMore: boolean;
98
+ };
99
+ export {};
@@ -0,0 +1,192 @@
1
+ import { AgentSession } from '../../entities/agent-sessions/agent-session';
2
+ import { Channel } from '../../entities/channels/channel';
3
+ import { Message } from '../../entities/channels/message';
4
+ import { Thread } from '../../entities/channels/thread';
5
+ import { User } from '../../entities/users/user';
6
+ import type { RoxClient } from '../../utils/client';
7
+ import type { RoxEvent } from '../types';
8
+ export type AgentSessionEvent = Extract<RoxEvent, {
9
+ event_type: `agent_session.${string}`;
10
+ }>;
11
+ /** Attach SDK entity handles to an agent-session lifecycle webhook event. */
12
+ export declare function hydrateAgentSessionEvent(client: RoxClient, event: AgentSessionEvent): {
13
+ channel: Channel;
14
+ thread: Thread;
15
+ session: AgentSession;
16
+ owner: User;
17
+ event_type: "agent_session.opened";
18
+ metadata: import("../../../generated/storage").SessionOpenedMetadata;
19
+ } | {
20
+ channel: undefined;
21
+ thread: undefined;
22
+ session: AgentSession;
23
+ owner: User;
24
+ event_type: "agent_session.opened";
25
+ metadata: import("../../../generated/storage").SessionOpenedMetadata;
26
+ } | {
27
+ actor: User | undefined;
28
+ announcement: Message | undefined;
29
+ channel: Channel;
30
+ thread: Thread;
31
+ session: AgentSession;
32
+ owner: User;
33
+ event_type: "agent_session.turn_started";
34
+ metadata: import("../../../generated/storage").TurnStartedMetadata;
35
+ } | {
36
+ actor: User | undefined;
37
+ announcement: Message | undefined;
38
+ channel: undefined;
39
+ thread: undefined;
40
+ session: AgentSession;
41
+ owner: User;
42
+ event_type: "agent_session.turn_started";
43
+ metadata: import("../../../generated/storage").TurnStartedMetadata;
44
+ } | {
45
+ actor: User | undefined;
46
+ announcement: Message | undefined;
47
+ channel: Channel;
48
+ thread: Thread;
49
+ session: AgentSession;
50
+ owner: User;
51
+ event_type: "agent_session.turn_ended";
52
+ metadata: import("../../../generated/storage").TurnEndedMetadata;
53
+ } | {
54
+ actor: User | undefined;
55
+ announcement: Message | undefined;
56
+ channel: undefined;
57
+ thread: undefined;
58
+ session: AgentSession;
59
+ owner: User;
60
+ event_type: "agent_session.turn_ended";
61
+ metadata: import("../../../generated/storage").TurnEndedMetadata;
62
+ } | {
63
+ actor: User | undefined;
64
+ announcement: Message | undefined;
65
+ channel: Channel;
66
+ thread: Thread;
67
+ session: AgentSession;
68
+ owner: User;
69
+ event_type: "agent_session.command_rejected";
70
+ metadata: import("../../../generated/storage").CommandRejectedMetadata;
71
+ } | {
72
+ actor: User | undefined;
73
+ announcement: Message | undefined;
74
+ channel: undefined;
75
+ thread: undefined;
76
+ session: AgentSession;
77
+ owner: User;
78
+ event_type: "agent_session.command_rejected";
79
+ metadata: import("../../../generated/storage").CommandRejectedMetadata;
80
+ } | {
81
+ actor: User | undefined;
82
+ announcement: Message | undefined;
83
+ channel: Channel;
84
+ thread: Thread;
85
+ session: AgentSession;
86
+ owner: User;
87
+ event_type: "agent_session.settled";
88
+ metadata: import("../../../generated/storage").SessionSettledMetadata;
89
+ } | {
90
+ actor: User | undefined;
91
+ announcement: Message | undefined;
92
+ channel: undefined;
93
+ thread: undefined;
94
+ session: AgentSession;
95
+ owner: User;
96
+ event_type: "agent_session.settled";
97
+ metadata: import("../../../generated/storage").SessionSettledMetadata;
98
+ } | {
99
+ announcement: Message | undefined;
100
+ channel: Channel;
101
+ thread: Thread;
102
+ session: AgentSession;
103
+ owner: User;
104
+ event_type: "agent_session.waiting_for_input";
105
+ metadata: import("../../../generated/storage").WaitingForInputMetadata;
106
+ } | {
107
+ announcement: Message | undefined;
108
+ channel: undefined;
109
+ thread: undefined;
110
+ session: AgentSession;
111
+ owner: User;
112
+ event_type: "agent_session.waiting_for_input";
113
+ metadata: import("../../../generated/storage").WaitingForInputMetadata;
114
+ } | {
115
+ channel: Channel;
116
+ thread: Thread;
117
+ session: AgentSession;
118
+ owner: User;
119
+ event_type: "agent_session.input_received";
120
+ metadata: import("../../../generated/storage").InputReceivedMetadata;
121
+ } | {
122
+ channel: undefined;
123
+ thread: undefined;
124
+ session: AgentSession;
125
+ owner: User;
126
+ event_type: "agent_session.input_received";
127
+ metadata: import("../../../generated/storage").InputReceivedMetadata;
128
+ } | {
129
+ mentionedBy: User | undefined;
130
+ mentioned: User[];
131
+ channel: Channel;
132
+ thread: Thread;
133
+ session: AgentSession;
134
+ owner: User;
135
+ event_type: "agent_session.mentioned";
136
+ metadata: import("../../../generated/storage").SessionMentionedMetadata;
137
+ } | {
138
+ mentionedBy: User | undefined;
139
+ mentioned: User[];
140
+ channel: undefined;
141
+ thread: undefined;
142
+ session: AgentSession;
143
+ owner: User;
144
+ event_type: "agent_session.mentioned";
145
+ metadata: import("../../../generated/storage").SessionMentionedMetadata;
146
+ } | {
147
+ actor: User | undefined;
148
+ announcement: Message | undefined;
149
+ channel: Channel;
150
+ thread: Thread;
151
+ session: AgentSession;
152
+ owner: User;
153
+ event_type: "agent_session.stopped";
154
+ metadata: import("../../../generated/storage").SessionStoppedMetadata;
155
+ } | {
156
+ actor: User | undefined;
157
+ announcement: Message | undefined;
158
+ channel: undefined;
159
+ thread: undefined;
160
+ session: AgentSession;
161
+ owner: User;
162
+ event_type: "agent_session.stopped";
163
+ metadata: import("../../../generated/storage").SessionStoppedMetadata;
164
+ } | {
165
+ channel: Channel;
166
+ thread: Thread;
167
+ session: AgentSession;
168
+ owner: User;
169
+ event_type: "agent_session.renamed";
170
+ metadata: import("../../../generated/storage").SessionRenamedMetadata;
171
+ } | {
172
+ channel: undefined;
173
+ thread: undefined;
174
+ session: AgentSession;
175
+ owner: User;
176
+ event_type: "agent_session.renamed";
177
+ metadata: import("../../../generated/storage").SessionRenamedMetadata;
178
+ } | {
179
+ channel: Channel;
180
+ thread: Thread;
181
+ session: AgentSession;
182
+ owner: User;
183
+ event_type: "agent_session.deleted";
184
+ metadata: import("../../../generated/storage").SessionDeletedMetadata;
185
+ } | {
186
+ channel: undefined;
187
+ thread: undefined;
188
+ session: AgentSession;
189
+ owner: User;
190
+ event_type: "agent_session.deleted";
191
+ metadata: import("../../../generated/storage").SessionDeletedMetadata;
192
+ } | undefined;
@@ -0,0 +1,101 @@
1
+ import { CallRecord } from '../../entities/calls/call-record';
2
+ import { Channel } from '../../entities/channels/channel';
3
+ import { Meeting } from '../../entities/meetings/meeting';
4
+ import { User } from '../../entities/users/user';
5
+ import type { RoxClient } from '../../utils/client';
6
+ import type { RoxEvent } from '../types';
7
+ export type CallEvent = Extract<RoxEvent, {
8
+ event_type: `call.${string}`;
9
+ }>;
10
+ /** Attach call, channel, meeting, and actor handles to call notifications. */
11
+ export declare function hydrateCallEvent(client: RoxClient, event: CallEvent): {
12
+ call: CallRecord;
13
+ channel: Channel | undefined;
14
+ meeting: Meeting | undefined;
15
+ creator: User | undefined;
16
+ user: User | undefined;
17
+ inviter: User | undefined;
18
+ event_type: "call.started";
19
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
20
+ } | {
21
+ call: CallRecord;
22
+ channel: Channel | undefined;
23
+ meeting: Meeting | undefined;
24
+ creator: User | undefined;
25
+ user: User | undefined;
26
+ inviter: User | undefined;
27
+ event_type: "call.ended";
28
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
29
+ } | {
30
+ call: CallRecord;
31
+ channel: Channel | undefined;
32
+ meeting: Meeting | undefined;
33
+ creator: User | undefined;
34
+ user: User | undefined;
35
+ inviter: User | undefined;
36
+ event_type: "call.participant_joined";
37
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
38
+ } | {
39
+ call: CallRecord;
40
+ channel: Channel | undefined;
41
+ meeting: Meeting | undefined;
42
+ creator: User | undefined;
43
+ user: User | undefined;
44
+ inviter: User | undefined;
45
+ event_type: "call.participant_left";
46
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
47
+ } | {
48
+ call: CallRecord;
49
+ channel: Channel | undefined;
50
+ meeting: Meeting | undefined;
51
+ creator: User | undefined;
52
+ user: User | undefined;
53
+ inviter: User | undefined;
54
+ event_type: "call.recording_ready";
55
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
56
+ } | {
57
+ call: CallRecord;
58
+ channel: Channel | undefined;
59
+ meeting: Meeting | undefined;
60
+ creator: User | undefined;
61
+ user: User | undefined;
62
+ inviter: User | undefined;
63
+ event_type: "call.summarized";
64
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
65
+ } | {
66
+ call: CallRecord;
67
+ channel: Channel | undefined;
68
+ meeting: Meeting | undefined;
69
+ creator: User | undefined;
70
+ user: User | undefined;
71
+ inviter: User | undefined;
72
+ event_type: "call.ringing";
73
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
74
+ } | {
75
+ call: CallRecord;
76
+ channel: Channel | undefined;
77
+ meeting: Meeting | undefined;
78
+ creator: User | undefined;
79
+ user: User | undefined;
80
+ inviter: User | undefined;
81
+ event_type: "call.answered";
82
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
83
+ } | {
84
+ call: CallRecord;
85
+ channel: Channel | undefined;
86
+ meeting: Meeting | undefined;
87
+ creator: User | undefined;
88
+ user: User | undefined;
89
+ inviter: User | undefined;
90
+ event_type: "call.declined";
91
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
92
+ } | {
93
+ call: CallRecord;
94
+ channel: Channel | undefined;
95
+ meeting: Meeting | undefined;
96
+ creator: User | undefined;
97
+ user: User | undefined;
98
+ inviter: User | undefined;
99
+ event_type: "call.invited";
100
+ metadata: import("../../../generated/storage").CallNotificationMetadata;
101
+ } | undefined;
@@ -0,0 +1,55 @@
1
+ import { ChannelAccessRequest } from '../../entities/channels/access-request';
2
+ import { Channel } from '../../entities/channels/channel';
3
+ import { User } from '../../entities/users/user';
4
+ import type { RoxClient } from '../../utils/client';
5
+ import type { RoxEvent } from '../types';
6
+ export type ChannelEvent = Extract<RoxEvent, {
7
+ event_type: `channel.${string}`;
8
+ }>;
9
+ /**
10
+ * Resolve a channel principal to a user handle, or undefined when it names a
11
+ * bot. Lower-cased to match how the backend stores ids. Note `|` is legal in an
12
+ * email, so `macro|bot|a@b.com` is a user.
13
+ */
14
+ export declare function userFromPrincipal(client: RoxClient, principalId: string): User | undefined;
15
+ /** Attach SDK entity handles to a channel webhook event. */
16
+ export declare function hydrateChannelEvent(client: RoxClient, event: ChannelEvent): {
17
+ event_type: "channel.created";
18
+ metadata: import("../../../generated/storage").ChannelCreatedMetadata;
19
+ channel: Channel;
20
+ actor: User | undefined;
21
+ participants: User[];
22
+ } | {
23
+ event_type: "channel.updated";
24
+ metadata: import("../../../generated/storage").ChannelUpdatedMetadata;
25
+ channel: Channel;
26
+ actor: User | undefined;
27
+ } | {
28
+ event_type: "channel.deleted";
29
+ metadata: import("../../../generated/storage").ChannelDeletedMetadata;
30
+ channel: Channel;
31
+ actor: User | undefined;
32
+ } | {
33
+ event_type: "channel.picture_changed";
34
+ metadata: import("../../../generated/storage").ChannelPictureChangedMetadata;
35
+ channel: Channel;
36
+ actor: User | undefined;
37
+ } | {
38
+ event_type: "channel.participant_added";
39
+ metadata: import("../../../generated/storage").ChannelParticipantAddedMetadata;
40
+ channel: Channel;
41
+ addedBy: User | undefined;
42
+ addedUsers: User[];
43
+ } | {
44
+ event_type: "channel.participant_removed";
45
+ metadata: import("../../../generated/storage").ChannelParticipantRemovedMetadata;
46
+ channel: Channel;
47
+ removedBy: User;
48
+ removedUsers: User[];
49
+ } | {
50
+ event_type: "channel.access_requested";
51
+ metadata: import("../../../generated/storage").ChannelAccessRequestedMetadata;
52
+ channel: Channel;
53
+ request: ChannelAccessRequest;
54
+ requester: User;
55
+ } | undefined;
@@ -0,0 +1,59 @@
1
+ import { Document } from '../../entities/documents/document';
2
+ import { Project } from '../../entities/projects/project';
3
+ import { User } from '../../entities/users/user';
4
+ import type { RoxClient } from '../../utils/client';
5
+ import type { RoxEvent } from '../types';
6
+ export type DocumentEvent = Extract<RoxEvent, {
7
+ event_type: `document.${string}`;
8
+ }>;
9
+ /** Attach SDK entity handles to a document webhook event. */
10
+ export declare function hydrateDocumentEvent(client: RoxClient, event: DocumentEvent): {
11
+ event_type: "document.created";
12
+ metadata: import("../../../generated/storage").DocumentCreatedMetadata;
13
+ document: Document;
14
+ owner: User;
15
+ project: Project | undefined;
16
+ } | {
17
+ event_type: "document.updated";
18
+ metadata: import("../../../generated/storage").DocumentUpdatedMetadata;
19
+ document: Document;
20
+ owner: User;
21
+ actor: User | undefined;
22
+ project: Project | undefined;
23
+ previousProject: Project | undefined;
24
+ } | {
25
+ event_type: "document.deleted";
26
+ metadata: import("../../../generated/storage").DocumentDeletedMetadata;
27
+ document: Document;
28
+ actor: User | undefined;
29
+ project: Project | undefined;
30
+ } | {
31
+ event_type: "document.content_uploaded";
32
+ metadata: import("../../../generated/storage").DocumentContentUploadedMetadata;
33
+ document: Document;
34
+ owner: User;
35
+ } | {
36
+ event_type: "document.sync_content_updated";
37
+ metadata: import("../../../generated/storage").DocumentSyncContentUpdatedMetadata;
38
+ document: Document;
39
+ } | {
40
+ event_type: "document.purged";
41
+ metadata: import("../../../generated/storage").DocumentPurgedMetadata;
42
+ document: Document;
43
+ } | {
44
+ event_type: "document.copied";
45
+ metadata: import("../../../generated/storage").DocumentCopiedMetadata;
46
+ document: Document;
47
+ sourceDocument: Document;
48
+ owner: User;
49
+ project: Project | undefined;
50
+ } | {
51
+ event_type: "document.interaction";
52
+ metadata: import("../../../generated/storage").DocumentInteractionMetadata;
53
+ document: Document;
54
+ } | {
55
+ event_type: "document.email_attachments_released";
56
+ metadata: import("../../../generated/storage").EmailAttachmentsReleasedMetadata;
57
+ trashedDocuments: Document[];
58
+ keptDocuments: Document[];
59
+ } | undefined;