@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,118 @@
1
+ import type { Category, EntityAction, RunMode } from '../../../generated/scheduled-action/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { Suggestion, type SuggestionItem, type SuggestionWriteOutcome } from './suggestion';
4
+ /** What a suggestions session reads before managing the user's suggestions. */
5
+ export interface SuggestionsReview {
6
+ /** Open suggestions first, best first, then closed ones newest first. */
7
+ readonly suggestions: Suggestion[];
8
+ /** Open suggestions the user has, and the most they may have. */
9
+ readonly open: number;
10
+ readonly openLimit: number;
11
+ /** Suggestions this session's generation may still add or bring back. */
12
+ readonly newLeft: number;
13
+ }
14
+ /** How much of the user's feed to read, and for which time zone. */
15
+ export interface SuggestionListOptions {
16
+ /** Most open suggestions to return, best first; all when unset. At least 1. With a limit, the done ones are left out. */
17
+ limit?: number;
18
+ /**
19
+ * The user's IANA time zone, such as `Europe/Paris`, when known (say, their
20
+ * calendar's): reading the feed with it schedules their nightly suggestions
21
+ * in their night. Never pass the zone the program happens to run in.
22
+ */
23
+ timezone?: string;
24
+ }
25
+ /** Fields every new suggestion has. */
26
+ interface SuggestionBase {
27
+ /** A short lowercase key, the same every night for the same suggestion, such as `thread:<id>:reply`. */
28
+ dedupKey: string;
29
+ /** What to do, in a few words. Names no one's email address, phone number or street address. */
30
+ title: string;
31
+ /** Why, in a line or two, likewise. */
32
+ summary: string;
33
+ /** 0 to 100. */
34
+ importance: number;
35
+ categories?: Category[];
36
+ /** The items it is about, as handles the SDK returned. */
37
+ about?: SuggestionItem[];
38
+ /** Why, for the change log; required to bring back a suggestion the user dismissed. */
39
+ reason?: string;
40
+ }
41
+ /** A new suggestion, or a new version of the one with the same `dedupKey`. */
42
+ export type SuggestionInput = (SuggestionBase & {
43
+ kind: 'prompt';
44
+ /** What an agent is asked to do, as the user would ask it. */
45
+ prompt: string;
46
+ /** `composer`: opened prefilled for the user to send. `background`: run in a hidden session, the user sees the result. */
47
+ runMode: RunMode;
48
+ /** Only for `background`: what the run posts or sends, and where, in one plain sentence ("Posts the weekly status summary in #ops"). The card shows it, and running the suggestion approves exactly that; leave it out when the run posts and sends nothing. */
49
+ sends?: string;
50
+ }) | (SuggestionBase & {
51
+ kind: 'entity';
52
+ /** What to do about the items in `about` (at least one). */
53
+ action: EntityAction;
54
+ });
55
+ /**
56
+ * The user's suggestions: proactive suggestions in their feed.
57
+ *
58
+ * @routing Use when the user asks about their Suggestions feed of proactive suggestions or wants to take one up or dismiss one, or when a suggestions generation session manages that feed; not for routines, tasks or reminders the user asks to create.
59
+ *
60
+ * @agent
61
+ * ## Suggestions
62
+ *
63
+ * Each suggestion is a prompt to run, a note about specific items, or a routine suggestion.
64
+ *
65
+ * ### For the user
66
+ *
67
+ * - Read their feed with `rox.suggestions.list()`: their open suggestions, best first, then those done in the last day. Each one's `status` says where it is: `open`, `running` (its background run is under way), `failed` (its last run failed; the user can run it again from the app) or `done`. When they just dismissed one by mistake, `suggestion.restore()` brings it back within five minutes.
68
+ * - When they take one up, call `suggestion.accept()`. A background prompt suggestion is then only taken on: the user starts its run from the app, so tell them it is ready to run there; never try to run it another way. A reply suggestion is also only taken on: it stays open until the user replies on its item, which makes it done, so help them reply, using its `draft` when it has one. Any other suggestion becomes done, so do it yourself: run a composer prompt suggestion's `prompt`, or do an entity suggestion's `action` on the items in `about`. A routine suggestion can't be accepted (400): the user saves its routine from the app.
69
+ * - When they don't want one, call `suggestion.dismiss()`.
70
+ * - Never suggest, rewrite or retire suggestions for the user: only a suggestions generation session may, and any other session gets a 403.
71
+ *
72
+ * ### In a suggestions generation session
73
+ *
74
+ * - Read every suggestion first with `rox.suggestions.review()`. Then add with `suggest`, change with `suggestion.rewrite`, and retire with `suggestion.retire` what no longer matters. Never `list`, `accept` or `dismiss`: those are the user's, and a generation session gets a 403.
75
+ * - Each write answers `{ ok, problems }`: when `ok` is false, fix what `problems` says and try again.
76
+ * - Name items in `about`, never in words: titles, summaries and prompts name no one's email address, phone number or street address.
77
+ * - A reply suggestion may carry a reply draft: write it with `rox.email.createDraft({thread, replyingTo, ...}, await thread.link())`, never send it, and attach it with `suggestion.attachDraft(draft, reason)`. Write none in a thread that already holds a draft (`thread.drafts()`).
78
+ *
79
+ * @mcp-exclude Suggestions are written by hidden generation sessions and acted on in the app, not over MCP.
80
+ */
81
+ export declare class SuggestionNamespace {
82
+ private readonly client;
83
+ constructor(client: RoxClient);
84
+ /**
85
+ * The user's feed: their open suggestions about items they can still open, best
86
+ * first, then those done in the last day, most recently first. Each one's
87
+ * `status` is `open`, `running`, `failed` or `done`. With a `limit`, at
88
+ * most that many open ones and no done ones. For the user's own agent; a
89
+ * generation session gets a 403.
90
+ *
91
+ * @example
92
+ * const suggestions = await rox.suggestions.list({ limit: 5 });
93
+ * return suggestions.map((suggestion) => ({ title: suggestion.title, status: suggestion.status }));
94
+ */
95
+ list(options?: SuggestionListOptions): Promise<Suggestion[]>;
96
+ /** Every suggestion of the user's, open or not, and how many more may be added. Only a suggestions generation session may. */
97
+ review(): Promise<SuggestionsReview>;
98
+ /**
99
+ * Add a suggestion, or a new version of the one with the same `dedupKey`: an
100
+ * open one is updated in place, a retired one comes back, and a dismissed
101
+ * one comes back only with a `reason`. Its kind never changes.
102
+ *
103
+ * @example
104
+ * const outcome = await rox.suggestions.suggest({
105
+ * kind: 'entity',
106
+ * dedupKey: `thread:${thread.id}:reply`,
107
+ * title: 'Reply to the venue',
108
+ * summary: 'They asked for a headcount by Friday.',
109
+ * importance: 80,
110
+ * categories: ['important'],
111
+ * about: [{ entity: thread }],
112
+ * action: 'reply',
113
+ * });
114
+ * if (!outcome.ok) return outcome.problems;
115
+ */
116
+ suggest(suggestion: SuggestionInput): Promise<SuggestionWriteOutcome>;
117
+ }
118
+ export {};
@@ -0,0 +1,172 @@
1
+ import type { Category, EntityAction, RunMode, RunStateName, Suggestion as SuggestionRecord, SuggestionState, SuggestionStatus, SuggestionWriteOutcome as SuggestionWriteRecord, Target } from '../../../generated/scheduled-action/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { AgentSession } from '../agent-sessions/agent-session';
4
+ import { EmailDraft } from '../email/draft';
5
+ import type { RoxEntityType } from '../entity';
6
+ import type { EntityReference } from '../reference';
7
+ /** An item a suggestion is about: any handle with an entity type, such as an `EmailThread`, and optionally a part of it, such as one message in a channel. */
8
+ export interface SuggestionItem {
9
+ readonly entity: {
10
+ readonly id: string;
11
+ readonly entityType: RoxEntityType;
12
+ };
13
+ readonly part?: {
14
+ readonly id: string;
15
+ };
16
+ }
17
+ /** What became of a suggestions write: whether it was applied and, when not, the `problems` to fix before trying again. */
18
+ export interface SuggestionWriteOutcome {
19
+ readonly ok: boolean;
20
+ readonly problems: string[];
21
+ /** The suggestion as it now is, when the write was applied. */
22
+ readonly suggestion?: Suggestion;
23
+ }
24
+ /** Changes to an open suggestion; fields left out stay as they are. */
25
+ export interface SuggestionChanges {
26
+ title?: string;
27
+ summary?: string;
28
+ importance?: number;
29
+ categories?: Category[];
30
+ about?: SuggestionItem[];
31
+ /** Only on prompt suggestions. */
32
+ prompt?: string;
33
+ /** Only on background prompt suggestions: what the run posts or sends, and where. */
34
+ sends?: string;
35
+ /** Why, for the change log. */
36
+ reason: string;
37
+ }
38
+ /** The wire form of a suggestion's items. */
39
+ export declare function targets(items: SuggestionItem[]): Target[];
40
+ /** A suggestions write's outcome, with its suggestion as a handle. */
41
+ export declare function outcome(client: RoxClient, record: SuggestionWriteRecord): SuggestionWriteOutcome;
42
+ /**
43
+ * One of the user's suggestions: a prompt to run, a note about specific items, or a
44
+ * routine suggestion. List-sourced only, from `rox.suggestions.list()` or
45
+ * `rox.suggestions.review()`, so this wraps the record the caller already has.
46
+ *
47
+ * @mcp-exclude Suggestions are written by hidden generation sessions and acted on in the app, not over MCP.
48
+ */
49
+ export declare class Suggestion {
50
+ private readonly client;
51
+ private readonly record;
52
+ private constructor();
53
+ /** Wrap a suggestion record already in hand. */
54
+ static from(client: RoxClient, record: SuggestionRecord): Suggestion;
55
+ /** The suggestion's record, so a program can return a suggestion or a write's outcome. */
56
+ toJSON(): SuggestionRecord;
57
+ /** The suggestion's id. */
58
+ get id(): string;
59
+ /** `prompt`, `entity` or `routine`; never changes. */
60
+ get kind(): SuggestionRecord['kind'];
61
+ /** Names the suggestion across nights; suggesting the same key again updates this suggestion. */
62
+ get dedupKey(): string;
63
+ /** What to do, in a few words. */
64
+ get title(): string;
65
+ /** Why, in a line or two. */
66
+ get summary(): string;
67
+ /** 0 to 100. */
68
+ get importance(): number;
69
+ /** The feed's filters it shows under. */
70
+ get categories(): Category[];
71
+ /** Where it is for the user: `dismissed` ones were turned down by the user, `retired` ones by a session. */
72
+ get state(): SuggestionState;
73
+ /**
74
+ * What its card shows: `open` to act on, `running` while its background run
75
+ * is under way (or, restored after a dismissal, still being stopped),
76
+ * `failed` when that run failed (the user can run it again from the app),
77
+ * `done`, or `closed` (dismissed, resolved or retired; never in the feed).
78
+ */
79
+ get status(): SuggestionStatus;
80
+ /** When its state last changed, such as when the user dismissed it, as RFC 3339. */
81
+ get stateChangedAt(): string;
82
+ /** The items it is about, as `{ entityType, entityId, partId }`. */
83
+ get about(): Target[];
84
+ /** A prompt suggestion's prompt. */
85
+ get prompt(): string | undefined;
86
+ /** A prompt suggestion's run mode. */
87
+ get runMode(): RunMode | undefined;
88
+ /**
89
+ * What a background prompt suggestion's run posts or sends, and where, as its
90
+ * card shows it before Run; running the suggestion approves exactly that.
91
+ * Undefined when the run posts and sends nothing.
92
+ */
93
+ get sends(): string | undefined;
94
+ /**
95
+ * A background prompt suggestion's latest run: its hidden agent `session`
96
+ * (open it to see the result), when it started, its `state` as last
97
+ * recorded (`starting`, `running`, `waiting`, `stopping` or `cancelling`
98
+ * while under way; `finished`, `failed` or `cancelled` once settled), and
99
+ * when it entered that state.
100
+ */
101
+ get run(): {
102
+ session: AgentSession;
103
+ startedAt: string;
104
+ state: RunStateName;
105
+ stateChangedAt: string;
106
+ } | undefined;
107
+ /**
108
+ * What came of it, as a handle, while its `status` is `done` or `failed`:
109
+ * what its finished run made (else its agent session), its failed run's
110
+ * session, or without a run what acting on it made, such as a saved
111
+ * routine. Undefined otherwise, and for a kind of item the SDK has no
112
+ * handle for.
113
+ */
114
+ get result(): EntityReference | undefined;
115
+ /** An entity suggestion's action. */
116
+ get action(): EntityAction | undefined;
117
+ /** When the message a reply suggestion answers came, as RFC 3339; undefined once the user replied, or when unknown. */
118
+ get waitingSince(): string | undefined;
119
+ /** Who sent the message a reply suggestion answers, by name; never an address. */
120
+ get from(): string | undefined;
121
+ /** A reply suggestion's draft, once a session attached one; it no longer loads once the user deleted it. */
122
+ get draft(): EmailDraft | undefined;
123
+ /** The start of a reply suggestion's draft as plain text, as it was when attached, without loading the draft. */
124
+ get draftPreview(): string | undefined;
125
+ /**
126
+ * Mark this suggestion as taken up for the user. Only the user starts a
127
+ * background prompt suggestion's run, from the app: accepting one here only
128
+ * takes it on (`state` becomes `accepted`, no run), so tell the user it is
129
+ * ready for them to run. A reply suggestion is also only taken on: it stays
130
+ * open until the user replies on its item. A routine suggestion fails with
131
+ * 400: the user saves its routine from the app. Any other suggestion becomes
132
+ * done, so do what it suggests yourself. Fails with 409 when the suggestion
133
+ * changed since it was read: read it again. For the user's own agent; a
134
+ * generation session gets a 403.
135
+ */
136
+ accept(): Promise<void>;
137
+ /**
138
+ * The user doesn't want this open suggestion; a routine suggestion's routine
139
+ * suggestion is dismissed with it. For the user's own agent; a generation
140
+ * session gets a 403.
141
+ */
142
+ dismiss(): Promise<void>;
143
+ /**
144
+ * Take back the user's dismissal of this suggestion: it is open again. Only
145
+ * within five minutes of the dismissal, by the same user; fails with 409
146
+ * later, and for a routine suggestion. A background run the dismissal
147
+ * stopped stays stopped: the suggestion shows `running` until it has, then
148
+ * the user runs it again from the app. For the user's own agent; a
149
+ * generation session gets a 403.
150
+ */
151
+ restore(): Promise<void>;
152
+ /**
153
+ * Rewrite this open suggestion's title, summary, prompt, importance, categories
154
+ * or items, with a `reason`. Only a suggestions generation session may; its kind,
155
+ * run mode and action never change. Routine suggestions aren't rewritten.
156
+ */
157
+ rewrite(changes: SuggestionChanges): Promise<SuggestionWriteOutcome>;
158
+ /**
159
+ * Attach a reply draft to this open reply suggestion, with a `reason`; it replaces
160
+ * the suggestion's old draft. Only a suggestions generation session may. The draft is
161
+ * the user's own unsent draft in the thread the suggestion is about, from
162
+ * `rox.email.createDraft({thread, replyingTo, ...}, await thread.link())`.
163
+ * Nothing is sent.
164
+ */
165
+ attachDraft(draft: EmailDraft, reason: string): Promise<SuggestionWriteOutcome>;
166
+ /**
167
+ * Retire this open suggestion because it no longer matters, with a `reason`. Only
168
+ * a suggestions generation session may. Suggesting its `dedupKey` again brings
169
+ * it back.
170
+ */
171
+ retire(reason: string): Promise<SuggestionWriteOutcome>;
172
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,77 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import type { Initiative } from '../initiatives/initiative';
3
+ import type { Project } from '../projects/project';
4
+ import type { SearchOpts } from '../search/options';
5
+ import type { Team } from '../teams/team';
6
+ import type { User } from '../users/user';
7
+ import { type SimilarTask, Task, type TaskSummary } from './task';
8
+ /**
9
+ * Tasks: one `create` call sets initiative, assignees and due date; one
10
+ * `summaries` call reads many names (`name()` loads each whole document).
11
+ * Creating a task needs only what the request states; don't research what it
12
+ * describes unless asked.
13
+ *
14
+ * @routing Use when creating, assigning or updating tasks, or reporting on tasks such as open or overdue ones; not reminders, which are routines.
15
+ *
16
+ * @agent
17
+ * Never edit, merge or delete the tasks `findSimilar` matches unless the user asks.
18
+ */
19
+ export declare class TaskNamespace {
20
+ private readonly client;
21
+ constructor(client: RoxClient);
22
+ /** A handle to a task by document id. Details load on first access. */
23
+ byId(id: string): Task;
24
+ /**
25
+ * Create a task, with its initiative, assignees and due date in the same
26
+ * request. The task starts Not started.
27
+ *
28
+ * @write
29
+ */
30
+ create(opts: {
31
+ name: string;
32
+ markdown?: string;
33
+ /** Folder the task document is filed in; unrelated to `initiative`. */
34
+ project?: Project;
35
+ /** The initiative (shown as the task's Project in the app) it belongs to. */
36
+ initiative?: Initiative;
37
+ /** Assignees; defaults to the creator. Pass `[]` to leave it unassigned. */
38
+ assignees?: User[];
39
+ dueDate?: Date;
40
+ /** Scopes the team task number; may be omitted when the creator belongs to exactly one team. */
41
+ team?: Team;
42
+ /** Defaults to true. */
43
+ shareWithTeam?: boolean;
44
+ }): Promise<Task>;
45
+ /**
46
+ * Names and state of many tasks in one request, in the order given. Tasks
47
+ * that no longer exist are left out.
48
+ *
49
+ * @readonly
50
+ */
51
+ summaries(tasks: Task[]): Promise<TaskSummary[]>;
52
+ /**
53
+ * Existing tasks like a task with this `title` and `body` (not `create`'s
54
+ * `name` and `markdown`), yours or your team's, most similar first. Call it
55
+ * in the same program as `create`: create only when nothing is a likely
56
+ * duplicate, and otherwise return the matches and ask the user instead of
57
+ * creating.
58
+ *
59
+ * @readonly
60
+ */
61
+ findSimilar(opts: {
62
+ title: string;
63
+ body?: string;
64
+ }): Promise<SimilarTask[]>;
65
+ /**
66
+ * The tasks the GitHub pull request at `url` references, oldest link first.
67
+ *
68
+ * @readonly
69
+ */
70
+ forPullRequest(url: string): Promise<Task[]>;
71
+ /**
72
+ * Search tasks by name and content, most relevant first, auto-paginated; `maxItems` caps the total.
73
+ *
74
+ * @readonly
75
+ */
76
+ search(query: string, opts?: SearchOpts): AsyncGenerator<Task>;
77
+ }
@@ -0,0 +1,99 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import { Document } from '../documents/document';
3
+ import type { Initiative } from '../initiatives/initiative';
4
+ import type { Project } from '../projects/project';
5
+ import { Team } from '../teams/team';
6
+ import { User } from '../users/user';
7
+ /** A task's name and state from one batched read, without its content. */
8
+ export interface TaskSummary {
9
+ task: Task;
10
+ name: string;
11
+ owner: User;
12
+ updatedAt?: string;
13
+ completed: boolean;
14
+ }
15
+ /** An existing task that looks like the same work as a proposed one. */
16
+ export interface SimilarTask {
17
+ /** The existing task. */
18
+ task: Task;
19
+ /** The existing task's name. */
20
+ name: string;
21
+ /** Cosine similarity of the two tasks' embeddings, from 0 to 1. */
22
+ similarity: number;
23
+ }
24
+ /**
25
+ * A Rox task: a document with sub-type `task`, so every `Document` method
26
+ * works on it, including `content` and `edit` for its body. Inherits the full
27
+ * document surface ({@link Document.rename}, move, delete, restore, events)
28
+ * and adds task-specific state.
29
+ */
30
+ export declare class Task extends Document {
31
+ /** A handle to a task by document id. Details load on first access. */
32
+ static byId(client: RoxClient, id: string): Task;
33
+ /**
34
+ * Create a task, with its initiative, assignees and due date in the same
35
+ * request. The task starts Not started.
36
+ */
37
+ static create(client: RoxClient, opts: {
38
+ name: string;
39
+ markdown?: string;
40
+ /** Folder the task document is filed in; unrelated to `initiative`. */
41
+ project?: Project;
42
+ /** The initiative (shown as the task's Project in the app) it belongs to. */
43
+ initiative?: Initiative;
44
+ /** Assignees; defaults to the creator. Pass `[]` to leave it unassigned. */
45
+ assignees?: User[];
46
+ dueDate?: Date;
47
+ /** Scopes the team task number; may be omitted when the creator belongs to exactly one team. */
48
+ team?: Team;
49
+ /** Defaults to true. */
50
+ shareWithTeam?: boolean;
51
+ }): Promise<Task>;
52
+ /**
53
+ * Names and state of many tasks in one request, in the order given. Tasks
54
+ * that no longer exist are left out.
55
+ */
56
+ static summaries(client: RoxClient, tasks: Task[]): Promise<TaskSummary[]>;
57
+ /**
58
+ * Existing tasks of the caller or their team that look like the same work
59
+ * as a task with this title and body, most similar first. Creates and
60
+ * changes nothing; check it before creating a task.
61
+ */
62
+ static findSimilar(client: RoxClient, opts: {
63
+ title: string;
64
+ body?: string;
65
+ }): Promise<SimilarTask[]>;
66
+ /**
67
+ * The tasks the GitHub pull request at `url` references (as `MACRO-<id>` in
68
+ * its text, branch, or comments), oldest link first. Empty when the caller
69
+ * cannot see the pull request; tasks the caller cannot open still appear.
70
+ */
71
+ static forPullRequest(client: RoxClient, url: string): Promise<Task[]>;
72
+ /**
73
+ * Whether the task is completed (its Status property is "Completed");
74
+ * `undefined` if the document is not a task.
75
+ *
76
+ * @readonly
77
+ */
78
+ completed(): Promise<boolean | undefined>;
79
+ /**
80
+ * The task's team slug, such as `DB-245`, the short name to put in git
81
+ * branch names. It is the slug of the team the task is numbered in, then
82
+ * the task's number in that team; `documents.byTeamSlug` resolves a slug of
83
+ * the caller's current team back to its task. `undefined` when the task has
84
+ * no team number, or that team is not one of the caller's. `branchName()`
85
+ * suggests a whole branch name, but takes its prefix from the caller's first
86
+ * team, so it can differ from this slug.
87
+ *
88
+ * @readonly
89
+ */
90
+ slug(): Promise<string | undefined>;
91
+ /**
92
+ * The task's URL in the Rox web app.
93
+ *
94
+ * @readonly
95
+ */
96
+ webUrl(): string;
97
+ /** Search tasks by name and content, most relevant first, auto-paginated; `maxItems` caps the total. */
98
+ static search: (client: RoxClient, query: string, searchOpts?: import("../search/options").SearchOpts) => AsyncGenerator<Task, any, any>;
99
+ }
@@ -0,0 +1,33 @@
1
+ import type { TeamInviteDetails } from '../../../generated/auth/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import { User } from '../users/user';
5
+ /**
6
+ * A pending invite to the caller's current team. Reading and revoking invites
7
+ * requires a team admin or owner; `Team.invite` sends new ones.
8
+ */
9
+ export declare class TeamInvite extends RoxEntity<TeamInviteDetails> {
10
+ /** A handle to a pending team invite by id. Details load on first access. */
11
+ static byId(client: RoxClient, id: string): TeamInvite;
12
+ /** Build an invite from an already-fetched record (pre-seeded, no fetch). */
13
+ static from(client: RoxClient, record: TeamInviteDetails): TeamInvite;
14
+ protected fetch(): Promise<TeamInviteDetails>;
15
+ /** The invited email address. */
16
+ readonly email: () => Promise<string>;
17
+ /** The role the invitee gets when they join. */
18
+ readonly role: () => Promise<import("../../../generated/auth").TeamRole>;
19
+ /** The member who sent the invite. */
20
+ readonly invitedBy: () => Promise<User>;
21
+ /** When the invite was created, as an ISO 8601 timestamp. */
22
+ readonly createdAt: () => Promise<string>;
23
+ /** When the invite email was last sent, as an ISO 8601 timestamp. */
24
+ readonly lastSentAt: () => Promise<string>;
25
+ /**
26
+ * Revoke this invite so it can no longer be accepted; only a team admin or
27
+ * owner may revoke.
28
+ *
29
+ * @destructive
30
+ * @idempotent
31
+ */
32
+ revoke(): Promise<void>;
33
+ }
@@ -0,0 +1,23 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import { Team } from './team';
3
+ /**
4
+ * @routing Use when managing teams and membership or inviting people to a team; not inviting people to Macro, which is referrals.
5
+ */
6
+ export declare class TeamNamespace {
7
+ private readonly client;
8
+ constructor(client: RoxClient);
9
+ /** A handle to a team by id. */
10
+ byId(id: string): Team;
11
+ /**
12
+ * The caller's current team.
13
+ *
14
+ * @readonly
15
+ */
16
+ current(): Promise<Team>;
17
+ /**
18
+ * The teams the caller belongs to.
19
+ *
20
+ * @readonly
21
+ */
22
+ list(): Promise<Team[]>;
23
+ }
@@ -0,0 +1,129 @@
1
+ import type { DisableMemberReport, RuntimePreset, Team as TeamRecord, TeamRole } from '../../../generated/auth/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import { User } from '../users/user';
5
+ import { TeamInvite } from './invite';
6
+ /** A member of a team: the user and their role. */
7
+ export interface TeamMembership {
8
+ /** The member. */
9
+ user: User;
10
+ /** Their role on the team. */
11
+ role: TeamRole;
12
+ /** Whether this member may use the team CRM; mailbox consent is separate. */
13
+ crmAccess: boolean;
14
+ }
15
+ /**
16
+ * A Rox team. A free-to-construct handle; the record loads lazily on first
17
+ * field access, resolved from the caller's team memberships.
18
+ */
19
+ export declare class Team extends RoxEntity<TeamRecord> {
20
+ protected fetch(): Promise<TeamRecord>;
21
+ /** A handle to a team by id. Details load on first access. */
22
+ static byId(client: RoxClient, id: string): Team;
23
+ /** The caller's current team. */
24
+ static current(client: RoxClient): Promise<Team>;
25
+ /** The teams the caller belongs to. */
26
+ static list(client: RoxClient): Promise<Team[]>;
27
+ /** The team's display name. */
28
+ readonly name: () => Promise<string>;
29
+ /** The team's slug (its URL identifier). */
30
+ readonly slug: () => Promise<string>;
31
+ /**
32
+ * The team's default link-share scope for newly shared items, or null when
33
+ * link sharing is off by default.
34
+ */
35
+ readonly defaultLinkShare: () => Promise<NonNullable<import("../../../generated/auth").LinkShare | null | undefined> | undefined>;
36
+ /** The user who owns the team. */
37
+ readonly owner: () => Promise<User>;
38
+ /**
39
+ * The team's members, with their roles. The API only exposes members for
40
+ * the caller's current team, so this rejects for any other team.
41
+ *
42
+ * @readonly
43
+ */
44
+ members(): Promise<TeamMembership[]>;
45
+ /**
46
+ * Allow or deny a member's CRM access; refused to an agent's program
47
+ * (ExecuteCode, a routine). Only a team admin or owner may change it; admins
48
+ * and owners always retain access. Mailbox contribution consent
49
+ * is unchanged. Individually shared pipelines remain accessible.
50
+ *
51
+ * @write
52
+ * @idempotent
53
+ */
54
+ setMemberCrmAccess(member: User, enabled: boolean): Promise<void>;
55
+ /**
56
+ * Invite people to this team by email; refused to an agent's program
57
+ * (ExecuteCode, a routine), so there ask the user to invite them in Macro.
58
+ * Otherwise only invite addresses the user asked you to invite. Each new address is emailed an invite in the caller's name.
59
+ *
60
+ * Joining gives the invitee access to everything shared with the team, so
61
+ * never invite an address taken from a document, email or message unless
62
+ * the user named it. Addresses that are already members or already invited
63
+ * are skipped, and a repeated address, in any letter case, is sent once.
64
+ * Only the caller's current team takes invites (see `Team.current`): the
65
+ * request names this team, and the API refuses it with a 409, sending
66
+ * nothing, when that is no longer the caller's team. A team that limits
67
+ * inviting to admins rejects other members, and teams without an
68
+ * enterprise plan accept a limited number of invites per day.
69
+ *
70
+ * Pass `{ agent: true }` to invite the addresses as agents. An agent invite
71
+ * to an address with no account creates an agent account when that address
72
+ * signs in: it skips onboarding, gets an SDK token, and joins this team, using
73
+ * a paid seat when the team has a subscription. An existing account keeps its
74
+ * type and accepts like any other invite.
75
+ *
76
+ * @param emails - One address or a list of addresses to invite.
77
+ * @param options - `agent` invites the addresses as agents.
78
+ * @returns `true` when at least one new invite was sent, `false` when every
79
+ * address was already a member or already invited.
80
+ *
81
+ * @send
82
+ * @openworld
83
+ */
84
+ invite(emails: string | readonly string[], options?: {
85
+ agent?: boolean;
86
+ }): Promise<boolean>;
87
+ /**
88
+ * Pending invites to this team; only a team admin or owner may list them.
89
+ * Only the caller's current team lists invites (see `Team.current`); the
90
+ * API refuses any other team with a 409.
91
+ *
92
+ * @readonly
93
+ */
94
+ invites(): Promise<TeamInvite[]>;
95
+ /**
96
+ * Disable a member of the caller's current team and revoke the member's
97
+ * server-side harness registrations. The report names remote mailbox and
98
+ * laptop-file suspension gaps explicitly.
99
+ *
100
+ * @write
101
+ * @idempotent
102
+ */
103
+ disableMember(member: User): Promise<DisableMemberReport>;
104
+ /**
105
+ * Re-enable a previously disabled member of the caller's current team.
106
+ *
107
+ * @write
108
+ * @idempotent
109
+ */
110
+ enableMember(member: User): Promise<void>;
111
+ /**
112
+ * Replace the exhaustive local runtime presets allowed for the caller's
113
+ * current team and return the saved list.
114
+ *
115
+ * @write
116
+ * @idempotent
117
+ */
118
+ setRuntimePresets(presets: readonly RuntimePreset[]): Promise<RuntimePreset[]>;
119
+ /**
120
+ * Clear the current team's runtime allowlist, restoring the default local
121
+ * presets.
122
+ *
123
+ * @write
124
+ * @idempotent
125
+ */
126
+ clearRuntimePresets(): Promise<void>;
127
+ /** The caller's current team record, rejecting when this is another team. */
128
+ private requireCurrent;
129
+ }