@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,84 @@
1
+ import type { Message as MessageRecord, ThreadState } from '../../../generated/storage/types.gen';
2
+ import { type RichMessage } from '../../mentions';
3
+ import type { RoxClient } from '../../utils/client';
4
+ import { RoxEntity } from '../entity';
5
+ import { User } from '../users/user';
6
+ /** The CRM record or initiative a discussion hangs off. */
7
+ export interface DiscussionParent {
8
+ type: 'crm_company' | 'crm_contact' | 'initiative';
9
+ id: string;
10
+ }
11
+ /** One of a discussion's comment threads: its state and its comments. */
12
+ export interface DiscussionThread {
13
+ /** The thread state: root id, resolved flag, owner, timestamps. */
14
+ thread: ThreadState;
15
+ /** The thread's comments, root first, then replies oldest first. */
16
+ comments: DiscussionComment[];
17
+ }
18
+ /**
19
+ * A comment on a CRM company, CRM contact or initiative: a message whose
20
+ * parent is that record, addressed by the record and the message UUID. Its
21
+ * record and mutations are the ones document comments and channel messages use.
22
+ */
23
+ export declare class DiscussionComment extends RoxEntity<MessageRecord> {
24
+ /** The company, contact or initiative this comment belongs to. */
25
+ readonly parent: DiscussionParent;
26
+ private constructor();
27
+ private get path();
28
+ protected fetch(): Promise<MessageRecord>;
29
+ /** A handle to a comment by id. Fields load on first access. */
30
+ static byId(client: RoxClient, parent: DiscussionParent, id: string): DiscussionComment;
31
+ /** Build a comment from a message record (pre-seeded, no fetch). */
32
+ static from(client: RoxClient, parent: DiscussionParent, record: MessageRecord): DiscussionComment;
33
+ /** The comment's text (markdown). */
34
+ readonly text: () => Promise<string>;
35
+ /** When the comment was created. */
36
+ readonly createdAt: () => Promise<string>;
37
+ /** When the comment was last updated. */
38
+ readonly updatedAt: () => Promise<string>;
39
+ /** When the comment was deleted, if it has been. */
40
+ readonly deletedAt: () => Promise<string | undefined>;
41
+ /**
42
+ * The id of the thread this comment belongs to: its root, or itself for a root.
43
+ *
44
+ * @readonly
45
+ */
46
+ threadId(): Promise<string>;
47
+ /**
48
+ * The user who wrote this comment.
49
+ *
50
+ * @readonly
51
+ */
52
+ author(): Promise<User>;
53
+ /**
54
+ * Reply in this comment's thread.
55
+ *
56
+ * @write
57
+ */
58
+ reply(body: string | RichMessage): Promise<DiscussionComment>;
59
+ /**
60
+ * Replace the comment's text. Only its author may.
61
+ *
62
+ * @param body - Plain text, or a rich body composed with {@link msg}.
63
+ *
64
+ * @write
65
+ * @idempotent
66
+ */
67
+ edit(body: string | RichMessage): Promise<this>;
68
+ /**
69
+ * Delete this comment. Deleting a thread's root keeps its replies.
70
+ *
71
+ * @destructive
72
+ * @idempotent
73
+ */
74
+ delete(): Promise<void>;
75
+ }
76
+ /** A discussion's live comment threads, each with its comments, newest thread first. */
77
+ export declare function listDiscussionThreads(client: RoxClient, parent: DiscussionParent): Promise<DiscussionThread[]>;
78
+ /**
79
+ * Post a comment in a discussion: a new thread, or a reply when `threadId`
80
+ * (the thread's root comment id) is given.
81
+ */
82
+ export declare function postDiscussionComment(client: RoxClient, parent: DiscussionParent, body: string | RichMessage, opts?: {
83
+ threadId?: string;
84
+ }): Promise<DiscussionComment>;
@@ -0,0 +1,115 @@
1
+ import type { MessageListItem, MessageTimelineQuery, ThreadState } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { CallRecord } from '../calls/call-record';
4
+ import type { CallMessage } from '../calls/message';
5
+ import type { Channel } from '../channels/channel';
6
+ import type { Message } from '../channels/message';
7
+ import type { Company } from '../crm/company';
8
+ import type { Contact } from '../crm/contact';
9
+ import type { Comment } from '../documents/comment';
10
+ import type { Document } from '../documents/document';
11
+ import { RoxEntity } from '../entity';
12
+ import type { Initiative } from '../initiatives/initiative';
13
+ import { User } from '../users/user';
14
+ import type { DiscussionComment } from './discussion';
15
+ /** A message handle accepted by a mixed timeline selector. */
16
+ export type TimelineMessage = Message | Comment | DiscussionComment | CallMessage;
17
+ /** Timeline selection with typed message references and camel case options. */
18
+ export interface TimelineOptions<TMessage extends TimelineMessage = TimelineMessage> {
19
+ /** Opaque continuation cursor from a previous page. */
20
+ cursor?: MessageTimelineQuery['cursor'];
21
+ /** Fetch around this message. */
22
+ around?: TMessage;
23
+ /** Restrict selection to these messages. */
24
+ messages?: TMessage[];
25
+ /** Inclusive activity lower bound. */
26
+ activityAfter?: string;
27
+ /** Exclusive activity upper bound. */
28
+ activityBefore?: string;
29
+ /** Select anchored threads. */
30
+ anchored?: boolean;
31
+ /** Page direction. */
32
+ direction?: MessageTimelineQuery['direction'];
33
+ /** Include deleted threads. */
34
+ includeDeletedThreads?: boolean;
35
+ /** Page size. */
36
+ limit?: number;
37
+ }
38
+ /** The typed parent of a shared message thread. */
39
+ export type MessageParent = {
40
+ type: 'channel';
41
+ entity: Channel;
42
+ } | {
43
+ type: 'document';
44
+ entity: Document;
45
+ } | {
46
+ type: 'crm_company';
47
+ entity: Company;
48
+ } | {
49
+ type: 'crm_contact';
50
+ entity: Contact;
51
+ } | {
52
+ type: 'initiative';
53
+ entity: Initiative;
54
+ } | {
55
+ type: 'call';
56
+ entity: CallRecord;
57
+ };
58
+ /** A shared message thread with resolution and deletion operations. */
59
+ export declare class MessageThread extends RoxEntity<ThreadState> {
60
+ /** The entity containing this thread. */
61
+ readonly parent: MessageParent;
62
+ /** Serialize identity with its owning resource. */
63
+ toJSON(): {
64
+ parentType: "channel" | "document" | "call" | "crm_company" | "crm_contact" | "initiative";
65
+ parentId: string;
66
+ id: string;
67
+ detail?: ThreadState | undefined;
68
+ };
69
+ private constructor();
70
+ /** Construct a scoped thread handle. */
71
+ static byId(client: RoxClient, parent: MessageParent, id: string): MessageThread;
72
+ private get path();
73
+ protected fetch(): Promise<ThreadState>;
74
+ /** Whether the thread is resolved. */
75
+ readonly resolved: () => Promise<boolean>;
76
+ /**
77
+ * Resolve the thread or detach its annotation anchor.
78
+ *
79
+ * @write
80
+ * @idempotent
81
+ */
82
+ update(options: {
83
+ resolved?: boolean;
84
+ detachAnchor?: boolean;
85
+ nonce?: string;
86
+ }): Promise<void>;
87
+ /**
88
+ * Delete the entire thread, including replies.
89
+ *
90
+ * @destructive
91
+ * @idempotent
92
+ */
93
+ delete(nonce?: string): Promise<void>;
94
+ }
95
+ /** A bounded mixed message/activity page with typed message handles. */
96
+ export declare function timeline<TMessage extends TimelineMessage>(client: RoxClient, parent: MessageParent, map: (record: MessageListItem) => TMessage, selection?: TimelineOptions<TMessage>): Promise<{
97
+ entries: ({
98
+ type: "activity";
99
+ activity: {
100
+ actor: User;
101
+ action: string;
102
+ actor_id: string;
103
+ id: string;
104
+ occurred_at: string;
105
+ payload?: unknown;
106
+ };
107
+ message?: undefined;
108
+ } | {
109
+ type: "message";
110
+ message: TMessage;
111
+ activity?: undefined;
112
+ })[];
113
+ nextCursor: import("../../../generated/storage").MessageCursor | undefined;
114
+ previousCursor: import("../../../generated/storage").MessageCursor | undefined;
115
+ }>;
@@ -0,0 +1,66 @@
1
+ import type { GetNotificationTypePreferencesResponses, NotifEvent } from '../../../generated/notification/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { Notification } from './notification';
4
+ /** A notification event type name, e.g. `channel_mention`. */
5
+ export type NotificationType = NotifEvent['tag'];
6
+ type NotificationTypePreferences = GetNotificationTypePreferencesResponses[200];
7
+ /**
8
+ * @routing Use when reading the user's notifications or marking them seen, such as catching up on what they missed; not sending messages.
9
+ */
10
+ export declare class NotificationNamespace {
11
+ private readonly client;
12
+ constructor(client: RoxClient);
13
+ /** A handle to a notification by id. */
14
+ byId(id: string): Notification;
15
+ /**
16
+ * The viewer's notification feed, most recent first, auto-paginated; `maxItems` caps the total.
17
+ *
18
+ * @readonly
19
+ */
20
+ list(opts?: {
21
+ pageSize?: number;
22
+ maxItems?: number;
23
+ }): AsyncGenerator<Notification>;
24
+ /**
25
+ * Mark a batch of notifications as seen.
26
+ *
27
+ * @write
28
+ * @idempotent
29
+ */
30
+ markSeen(ids: string[]): Promise<void>;
31
+ /**
32
+ * Mark a batch of notifications as done.
33
+ *
34
+ * @write
35
+ * @idempotent
36
+ */
37
+ markDone(ids: string[]): Promise<void>;
38
+ /**
39
+ * Delete a batch of notifications.
40
+ *
41
+ * @destructive
42
+ * @idempotent
43
+ */
44
+ delete(ids: string[]): Promise<void>;
45
+ /**
46
+ * The viewer's notification type preferences (disabled types).
47
+ *
48
+ * @readonly
49
+ */
50
+ preferences(): Promise<NotificationTypePreferences>;
51
+ /**
52
+ * Re-enable delivery of a notification type.
53
+ *
54
+ * @write
55
+ * @idempotent
56
+ */
57
+ enableType(type: NotificationType): Promise<void>;
58
+ /**
59
+ * Disable delivery of a notification type.
60
+ *
61
+ * @write
62
+ * @idempotent
63
+ */
64
+ disableType(type: NotificationType): Promise<void>;
65
+ }
66
+ export {};
@@ -0,0 +1,78 @@
1
+ import type { GetTypedNotificationByIdResponses, NotificationState } from '../../../generated/notification/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import { User } from '../users/user';
5
+ type NotificationDetail = GetTypedNotificationByIdResponses[200];
6
+ /**
7
+ * A notification in the viewer's feed.
8
+ */
9
+ export declare class Notification extends RoxEntity<NotificationDetail> {
10
+ protected fetch(): Promise<NotificationDetail>;
11
+ /** A handle to a notification by id. Details load on first access. */
12
+ static byId(client: RoxClient, id: string): Notification;
13
+ /** Build a notification from a list-endpoint record (pre-seeded, no fetch). */
14
+ static from(client: RoxClient, data: NotificationDetail): Notification;
15
+ /** The viewer's notification feed, most recent first, auto-paginated; `maxItems` caps the total. */
16
+ static list(client: RoxClient, opts?: {
17
+ pageSize?: number;
18
+ states?: NotificationState[];
19
+ maxItems?: number;
20
+ }): AsyncGenerator<Notification>;
21
+ /** The notification event type (e.g. `channel_mention`). */
22
+ readonly type: () => Promise<string>;
23
+ /** When the notification was created. */
24
+ readonly createdAt: () => Promise<string>;
25
+ /** When the notification was last updated. */
26
+ readonly updatedAt: () => Promise<string>;
27
+ /** The authoritative lifecycle state, independent of viewing timestamps. */
28
+ readonly state: () => Promise<NotificationState>;
29
+ /** Whether the notification is completed. */
30
+ readonly done: () => Promise<boolean>;
31
+ /** Whether the notification has been sent (delivered out of band). */
32
+ readonly sent: () => Promise<boolean>;
33
+ /** When the notification was viewed, if it has been seen. */
34
+ readonly viewedAt: () => Promise<string | undefined>;
35
+ /** When the notification was deleted, if it has been. */
36
+ readonly deletedAt: () => Promise<string | undefined>;
37
+ /** The user who owns (receives) this notification. */
38
+ readonly owner: () => Promise<User>;
39
+ /** The user who triggered the notification, if any. */
40
+ readonly sender: () => Promise<User | undefined>;
41
+ /** The typed notification payload (tagged by event type). */
42
+ readonly metadata: () => Promise<import("../../../generated/notification").NotifEvent>;
43
+ /**
44
+ * Whether the notification is acknowledged (seen or done).
45
+ *
46
+ * @readonly
47
+ */
48
+ seen(): Promise<boolean>;
49
+ /**
50
+ * Mark the notification as seen.
51
+ *
52
+ * @write
53
+ * @idempotent
54
+ */
55
+ markSeen(): Promise<void>;
56
+ /**
57
+ * Mark the notification as done.
58
+ *
59
+ * @write
60
+ * @idempotent
61
+ */
62
+ markDone(): Promise<void>;
63
+ /**
64
+ * Move the notification back to not-done.
65
+ *
66
+ * @write
67
+ * @idempotent
68
+ */
69
+ markUndone(): Promise<void>;
70
+ /**
71
+ * Delete the notification.
72
+ *
73
+ * @destructive
74
+ * @idempotent
75
+ */
76
+ delete(): Promise<void>;
77
+ }
78
+ export {};
@@ -0,0 +1,118 @@
1
+ import type { PasswordAgentAccessRequestState, PasswordAgentItemAccess, PasswordAgentSearchHit, PasswordAgentSecretPatch, PasswordAgentSecretSelector, PasswordItemKind, PasswordPermission } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { Team } from '../teams/team';
4
+ /**
5
+ * The one agent wake (a single agent query) a vault call is attributed to:
6
+ * a UUIDv7 the agent's runtime mints per wake. It is untrusted correlation for
7
+ * audit, never authorization, and is never kept across wakes.
8
+ */
9
+ export interface AgentWake {
10
+ /** The wake's UUIDv7. */
11
+ wake: string;
12
+ }
13
+ /** One field of a login or API credential an agent may copy. */
14
+ export type SecretSelector = PasswordAgentSecretSelector;
15
+ /** One disclosed field, for the agent's clipboard; never for model context. */
16
+ export interface DisclosedSecret {
17
+ /** The field's value. */
18
+ value: string;
19
+ /** The committed version it was read from. */
20
+ version: number;
21
+ /** The field that was disclosed. */
22
+ selector: SecretSelector;
23
+ }
24
+ /** A verification code with its conservative remaining lifetime. */
25
+ export interface VerificationCode {
26
+ /** The current code. */
27
+ code: string;
28
+ /** Conservative usable-until time on the server clock. */
29
+ expiresAt: string;
30
+ /** Code period in seconds. */
31
+ periodSeconds: number;
32
+ /**
33
+ * Milliseconds the server measured until `expiresAt`. Subtract the whole
34
+ * time since the request was sent, rounded up, before using the code.
35
+ */
36
+ validForMs: number;
37
+ }
38
+ /** An agent's access request on one item. */
39
+ export interface AgentAccessRequest {
40
+ /** Request lifecycle; `none` when the agent has never requested. */
41
+ status: PasswordAgentAccessRequestState['status'];
42
+ /** Requested permission, when a request exists. */
43
+ permission?: PasswordPermission;
44
+ /** Request revision; 0 when none exists. */
45
+ revision: number;
46
+ /** The agent's current access to the item. */
47
+ access: PasswordAgentItemAccess;
48
+ /** Last transition time, when a request exists. */
49
+ updatedAt?: string;
50
+ }
51
+ /** The wire headers of every agent vault call; mutations also carry the CSRF header. */
52
+ export declare function vaultHeaders(wake: AgentWake): {
53
+ 'X-Macro-Agent-Session-Id': string;
54
+ 'X-Macro-Passwords': string;
55
+ };
56
+ /**
57
+ * A team vault item as seen by the authenticated agent, for one wake. Search
58
+ * hits carry metadata only; values are disclosed one field at a time.
59
+ *
60
+ * @mcp-exclude Agent vault values must reach only the agent's secrets capability, never model context.
61
+ */
62
+ export declare class PasswordItem {
63
+ private readonly client;
64
+ /** The team that owns the item. */
65
+ readonly team: Team;
66
+ private readonly wake;
67
+ /** The item's id. */
68
+ readonly id: string;
69
+ private hit?;
70
+ private constructor();
71
+ /** A handle to an item from a search hit or write result. */
72
+ static fromHit(client: RoxClient, team: Team, wake: AgentWake, hit: PasswordAgentSearchHit): PasswordItem;
73
+ /** A handle to an item by id, without metadata until a write returns it. */
74
+ static byId(client: RoxClient, team: Team, wake: AgentWake, id: string): PasswordItem;
75
+ /** Display name, when this handle came from a search or write. */
76
+ get name(): string | undefined;
77
+ /** Stored kind, when known. */
78
+ get kind(): PasswordItemKind | undefined;
79
+ /** Website URL, when known. */
80
+ get url(): string | undefined;
81
+ /** Committed version, when known. */
82
+ get version(): number | undefined;
83
+ /** The agent's access when this handle was read; recomputed by every call. */
84
+ get access(): PasswordAgentItemAccess | undefined;
85
+ private path;
86
+ /** Disclose one field for copying. Values never belong in model context. */
87
+ disclose(selector: SecretSelector, opts?: {
88
+ /** Fail with `version_conflict` unless this is the committed version. */
89
+ expectedVersion?: number;
90
+ }): Promise<DisclosedSecret>;
91
+ /** The current verification code of a login or verification-code item. */
92
+ verificationCode(): Promise<VerificationCode>;
93
+ /**
94
+ * Replace supplied fields of a login or API item at `expectedVersion`.
95
+ * Notes and custom fields are kept exactly. A retry with the same
96
+ * `operationId` returns the accepted result.
97
+ */
98
+ update(opts: {
99
+ expectedVersion: number;
100
+ secret?: PasswordAgentSecretPatch;
101
+ name?: string;
102
+ /** `null` clears the URL. */
103
+ url?: string | null;
104
+ /** UUIDv7 stable across retries of this update; generated when omitted. */
105
+ operationId?: string;
106
+ }): Promise<PasswordItem>;
107
+ /** Enroll a base32 verification-code seed on a login item this agent created. */
108
+ setVerificationSeed(opts: {
109
+ seed: string;
110
+ expectedVersion: number;
111
+ /** UUIDv7 naming this enrollment, stable across retries; generated when omitted. */
112
+ operationId?: string;
113
+ }): Promise<void>;
114
+ /** Ask the item's managers for access; deduplicated while pending. */
115
+ requestAccess(permission: PasswordPermission): Promise<AgentAccessRequest>;
116
+ /** This agent's own request state for the item. */
117
+ accessRequest(): Promise<AgentAccessRequest>;
118
+ }
@@ -0,0 +1,45 @@
1
+ import type { PasswordAgentCreateSecret } from '../../../generated/storage/types.gen';
2
+ import { type IterationOptions } from '../../utils';
3
+ import type { RoxClient } from '../../utils/client';
4
+ import type { Team } from '../teams/team';
5
+ import { type AgentWake, PasswordItem } from './item';
6
+ /**
7
+ * Team vault access for the authenticated agent. Only the agent's own API key
8
+ * can use it; human vault routes are not part of the SDK.
9
+ *
10
+ * @mcp-exclude Agent vault values must reach only the agent's secrets capability, never model context.
11
+ */
12
+ export declare class PasswordNamespace {
13
+ private readonly client;
14
+ constructor(client: RoxClient);
15
+ /** The team's vault as this agent sees it during one wake. */
16
+ forAgent(team: Team, wake: AgentWake): AgentVault;
17
+ }
18
+ /**
19
+ * One team's vault for one agent wake. Every call recomputes the agent's
20
+ * current access.
21
+ *
22
+ * @mcp-exclude Agent vault values must reach only the agent's secrets capability, never model context.
23
+ */
24
+ export declare class AgentVault {
25
+ private readonly client;
26
+ /** The team that owns the vault. */
27
+ readonly team: Team;
28
+ private readonly wake;
29
+ constructor(client: RoxClient,
30
+ /** The team that owns the vault. */
31
+ team: Team, wake: AgentWake);
32
+ /** Items the agent may use or request, newest first, metadata only; `maxItems` caps the total. */
33
+ search(query?: string, opts?: IterationOptions): AsyncGenerator<PasswordItem>;
34
+ /**
35
+ * Create a login or API item owned by the team and usable by this agent at
36
+ * once. A retry with the same `operationId` returns the same item.
37
+ */
38
+ create(opts: {
39
+ name: string;
40
+ url?: string;
41
+ secret: PasswordAgentCreateSecret;
42
+ /** UUIDv7 stable across retries; generated when omitted. */
43
+ operationId?: string;
44
+ }): Promise<PasswordItem>;
45
+ }
@@ -0,0 +1,42 @@
1
+ import type { PinnedItem, ReorderPinRequest } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { FavoritableEntity } from '../entity';
4
+ export type { PinnedItem, ReorderPinRequest };
5
+ /**
6
+ * The user's pins: items pinned to fixed slots in the home view.
7
+ *
8
+ * @routing Use when pinning or unpinning items; not favorites (`macro.favorites`).
9
+ */
10
+ export declare class PinsNamespace {
11
+ private readonly client;
12
+ constructor(client: RoxClient);
13
+ /**
14
+ * The user's pinned items, with their pin indices.
15
+ *
16
+ * @readonly
17
+ */
18
+ list(): Promise<PinnedItem[]>;
19
+ /**
20
+ * Pin an entity to a slot. `index` is the slot to put it in.
21
+ *
22
+ * @write
23
+ * @idempotent
24
+ */
25
+ add(entity: FavoritableEntity<unknown>, opts: {
26
+ index: number;
27
+ }): Promise<void>;
28
+ /**
29
+ * Unpin an entity.
30
+ *
31
+ * @write
32
+ * @idempotent
33
+ */
34
+ remove(entity: FavoritableEntity<unknown>): Promise<void>;
35
+ /**
36
+ * Reorder pins: pass each pinned item with its type and new index.
37
+ *
38
+ * @write
39
+ * @idempotent
40
+ */
41
+ reorder(pins: ReorderPinRequest[]): Promise<void>;
42
+ }
@@ -0,0 +1,45 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import type { SearchOpts } from '../search/options';
3
+ import { Project } from './project';
4
+ /**
5
+ * Projects are folders that hold documents, chats and other projects.
6
+ *
7
+ * An agent session cannot be placed in a project: sessions have no project,
8
+ * and `Project.items()` never lists them. To keep a session with a project's
9
+ * work, create a Markdown document in the project that links the session with
10
+ * an agent session chip; `"expanded": true` shows the card that follows its
11
+ * latest turn.
12
+ *
13
+ * @example Link an agent session from a project.
14
+ * ```js
15
+ * const chip = JSON.stringify({ id: session.id, label: '', expanded: true });
16
+ * const document = await macro.documents.create({
17
+ * name: 'Agent work',
18
+ * project,
19
+ * markdown: `<m-agent-session-mention>${chip}</m-agent-session-mention>`,
20
+ * });
21
+ * return { data: { url: document.webUrl() } };
22
+ * ```
23
+ *
24
+ * @routing Use when organizing items into projects (folders); not initiatives, which group tasks.
25
+ */
26
+ export declare class ProjectNamespace {
27
+ private readonly client;
28
+ constructor(client: RoxClient);
29
+ byId(id: string): Project;
30
+ /**
31
+ * Create a project, optionally nested inside a parent project.
32
+ *
33
+ * @write
34
+ */
35
+ create(opts: {
36
+ name: string;
37
+ parent?: Project;
38
+ }): Promise<Project>;
39
+ /**
40
+ * Search projects by name and content, most relevant first, auto-paginated; `maxItems` caps the total.
41
+ *
42
+ * @readonly
43
+ */
44
+ search(query: string, opts?: SearchOpts): AsyncGenerator<Project>;
45
+ }