@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,66 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import { Agent, type AgentOptions } from './agent';
3
+ /**
4
+ * A coding agent the caller can start a session as right now: a built-in
5
+ * persona such as Cursor once its runtime is connected, or one of their
6
+ * configured coding agents whose runtime is reachable.
7
+ */
8
+ export type CodingAgent = {
9
+ /** Pass as `agent` to {@link AgentSessionNamespace.createManaged}. */
10
+ agent: Agent;
11
+ /** Display name. */
12
+ name: string;
13
+ /** What the persona is for, when known. */
14
+ description: string | undefined;
15
+ /** Saved guidance on its repositories and specialties; empty for built-ins. */
16
+ instructions: string;
17
+ /** Runtime its sessions run on, e.g. `cursor` or `roxd`. */
18
+ harness: string;
19
+ /** Default model, absent when the runtime chooses. */
20
+ model: string | undefined;
21
+ };
22
+ /**
23
+ * Agent personas: the built-in ones Rox ships and the agents the user configures.
24
+ *
25
+ * @routing Use when the user wants to pick, read or change one of their Rox agent personas: its instructions, model, runtime, channels, apps or hosts; not any request the user asks you, the agent, to carry out.
26
+ */
27
+ export declare class AgentNamespace {
28
+ private readonly client;
29
+ constructor(client: RoxClient);
30
+ /**
31
+ * A lazy handle to a configurable agent. Get handles from
32
+ * {@link AgentNamespace.list} or {@link AgentNamespace.coding} instead of
33
+ * constructing one from an id.
34
+ */
35
+ byId(id: string): Agent;
36
+ /**
37
+ * The configurable agents the user can manage (their own, their teams', and
38
+ * channel agents they can mention), coding and chat, with their full
39
+ * settings. Built-in personas such as Cursor are not here; list those with
40
+ * {@link AgentNamespace.coding}. Pass one as `agent` to
41
+ * {@link AgentSessionNamespace.createManaged} to start a session as it.
42
+ *
43
+ * @readonly
44
+ */
45
+ list(): Promise<Agent[]>;
46
+ /**
47
+ * Choose a coding agent from this list before delegating coding work: the
48
+ * coding personas the user can start a session as right now, built-in ones
49
+ * such as Cursor first, then their configured coding agents whose runtime
50
+ * is connected. Prefer the agent the user named, otherwise the one whose
51
+ * name, description, instructions and runtime best fit the repository and
52
+ * task, and pass its `agent` to {@link AgentSessionNamespace.createManaged}.
53
+ * Empty when nothing is connected; tell the user to connect Cursor or
54
+ * configure a coding agent. Macro's own default persona is not listed:
55
+ * omit `agent` to use it.
56
+ *
57
+ * @readonly
58
+ */
59
+ coding(): Promise<CodingAgent[]>;
60
+ /**
61
+ * Create an agent.
62
+ *
63
+ * @write
64
+ */
65
+ create(options: AgentOptions): Promise<Agent>;
66
+ }
@@ -0,0 +1,36 @@
1
+ import type { DecisionRequest, DecisionResponse, StructuredCompletionRequest, StructuredCompletionResponse, UsageRequest } from '../../../generated/cognition/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { User } from '../users/user';
4
+ export type { DecisionRequest, DecisionResponse, StructuredCompletionRequest, StructuredCompletionResponse, };
5
+ /**
6
+ * Shared cognition endpoints, charged to the authenticated acting user.
7
+ *
8
+ * @routing Use when asking a model to answer named yes/no questions or fill a JSON Schema from content you supply, or when reading AI usage; not generating images (`macro.images`) or answering the user yourself.
9
+ */
10
+ export declare class AiNamespace {
11
+ private readonly client;
12
+ /**
13
+ * Read AI usage over a time range, optionally restricting it to users.
14
+ *
15
+ * @readonly
16
+ */
17
+ usage(options?: Omit<UsageRequest, 'include_users'> & {
18
+ users?: User[];
19
+ }): Promise<import("../../../generated/cognition").UsageSummary>;
20
+ constructor(client: RoxClient);
21
+ /**
22
+ * Generate an answer matching a JSON Schema. Set toolset to { type: 'none' }
23
+ * to use only supplied context. Other toolsets can perform the requested
24
+ * actions; always inspect outcome and toolActivity, including interruptions.
25
+ *
26
+ * @write
27
+ */
28
+ structuredCompletion(request: StructuredCompletionRequest): Promise<StructuredCompletionResponse>;
29
+ /**
30
+ * Ask named yes/no questions about JSON input. Each probability estimates
31
+ * yes, from 0 to 1. This classifies supplied data without running tools.
32
+ *
33
+ * @readonly
34
+ */
35
+ decide(request: DecisionRequest): Promise<DecisionResponse>;
36
+ }
@@ -0,0 +1,22 @@
1
+ import type { UserApiKeyInfo } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ /** A user API key's metadata. Secrets are returned only at creation. */
5
+ export declare class UserApiKey extends RoxEntity<UserApiKeyInfo> {
6
+ /** Construct a lazy key handle. */
7
+ static byId(client: RoxClient, id: string): UserApiKey;
8
+ /** Seed from metadata, deliberately excluding the secret. */
9
+ static from(client: RoxClient, record: UserApiKeyInfo): UserApiKey;
10
+ protected fetch(): Promise<UserApiKeyInfo>;
11
+ /** Human readable label. */
12
+ readonly name: () => Promise<string>;
13
+ /** Creation time. */
14
+ readonly createdAt: () => Promise<string>;
15
+ /**
16
+ * Revoke this key.
17
+ *
18
+ * @destructive
19
+ * @idempotent
20
+ */
21
+ delete(): Promise<void>;
22
+ }
@@ -0,0 +1,37 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import { UserApiKey } from './api-key';
3
+ /**
4
+ * User API key management.
5
+ *
6
+ * @routing Use when creating, listing or revoking the user's API keys; not bot credentials.
7
+ */
8
+ export declare class ApiKeyNamespace {
9
+ private readonly client;
10
+ constructor(client: RoxClient);
11
+ /** Construct a lazy key handle. */
12
+ byId(id: string): UserApiKey;
13
+ /**
14
+ * List metadata for the caller's API keys.
15
+ *
16
+ * @readonly
17
+ */
18
+ list(): Promise<UserApiKey[]>;
19
+ /**
20
+ * Create a key; refused to an agent's program (ExecuteCode, a routine), so
21
+ * there have the user create one in Macro's settings. Save the secret now;
22
+ * it cannot be retrieved later.
23
+ *
24
+ * @write
25
+ */
26
+ create(name: string): Promise<{
27
+ key: UserApiKey;
28
+ secret: string;
29
+ }>;
30
+ /**
31
+ * Exchange an email address for a Rox API token, subject to server
32
+ * authorization; refused to an agent's program (ExecuteCode, a routine).
33
+ *
34
+ * @write
35
+ */
36
+ tokenForEmail(email: string): Promise<import("../../../generated/auth").RoxApiTokenResponse>;
37
+ }
@@ -0,0 +1,143 @@
1
+ import type { Bot as BotRecord } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { Channel } from '../channels/channel';
4
+ import { RoxEntity } from '../entity';
5
+ import { Team } from '../teams/team';
6
+ import { User } from '../users/user';
7
+ import { BotToken } from './token';
8
+ /** Settings for a new bot. */
9
+ export type CreateBotOptions = {
10
+ /** Display name. */
11
+ name: string;
12
+ /** Stable mention handle: lowercase ASCII letters, digits, `-` and `_`, at most 64 characters. */
13
+ handle: string;
14
+ /** Short description of what the bot does. */
15
+ description?: string;
16
+ /** Profile picture URL, such as a Rox static-file URL. */
17
+ avatarUrl?: string;
18
+ /** Owning team; omit for a bot owned by the caller. Requires team admin or owner. */
19
+ team?: Team;
20
+ /** Whether mentioning the bot opens a coding-agent session. Defaults to false. */
21
+ hasAgent?: boolean;
22
+ };
23
+ /** Profile changes for a bot; omitted fields keep their value. */
24
+ export type UpdateBotOptions = {
25
+ /** New display name. */
26
+ name?: string;
27
+ /** New stable handle. Integrations and mentions may rely on the old one. */
28
+ handle?: string;
29
+ /** New description; an empty string clears it. */
30
+ description?: string;
31
+ /** New profile picture URL; an empty string clears it. */
32
+ avatarUrl?: string;
33
+ /** Whether mentioning the bot opens a coding-agent session. */
34
+ hasAgent?: boolean;
35
+ };
36
+ /** A bot channel webhook: POST `{ content }` to `url` to post as the bot. */
37
+ export type BotWebhook = {
38
+ /** Channel the webhook posts into. */
39
+ channel: Channel;
40
+ /** Public URL to POST to. */
41
+ url: string;
42
+ };
43
+ /** Who owns a bot. */
44
+ export type BotOwner = {
45
+ type: 'user';
46
+ user: User;
47
+ } | {
48
+ type: 'team';
49
+ team: Team;
50
+ };
51
+ /** A user- or team-owned bot: an identity that posts to channels through webhooks or the SDK. */
52
+ export declare class Bot extends RoxEntity<BotRecord> {
53
+ /** A handle to a bot by id. */
54
+ static byId(client: RoxClient, id: string): Bot;
55
+ /** Seed from a listed or created bot. */
56
+ static from(client: RoxClient, record: BotRecord): Bot;
57
+ /** Create a bot owned by the caller or by a team. */
58
+ static create(client: RoxClient, options: CreateBotOptions): Promise<Bot>;
59
+ /** The bots the caller can manage: their own and their teams'. */
60
+ static list(client: RoxClient): Promise<Bot[]>;
61
+ protected fetch(): Promise<BotRecord>;
62
+ /** Display name. */
63
+ readonly name: () => Promise<string>;
64
+ /** Stable mention handle, without the `@`. */
65
+ readonly handle: () => Promise<string>;
66
+ /** Short description. */
67
+ readonly description: () => Promise<string | undefined>;
68
+ /** Profile picture URL. */
69
+ readonly avatarUrl: () => Promise<string | undefined>;
70
+ /** Whether mentioning the bot opens a coding-agent session. */
71
+ readonly hasAgent: () => Promise<boolean>;
72
+ /** Creation time. */
73
+ readonly createdAt: () => Promise<string>;
74
+ /** Last profile change. */
75
+ readonly updatedAt: () => Promise<string>;
76
+ /** The owning user or team. */
77
+ readonly owner: () => Promise<BotOwner | undefined>;
78
+ /**
79
+ * Change the bot's profile; pass only the fields that should change.
80
+ *
81
+ * @write
82
+ * @idempotent
83
+ */
84
+ update(changes: UpdateBotOptions): Promise<void>;
85
+ /**
86
+ * Delete the bot. Its tokens stop working and it leaves every channel.
87
+ *
88
+ * @destructive
89
+ * @idempotent
90
+ */
91
+ delete(): Promise<void>;
92
+ /**
93
+ * Channels the bot can post to.
94
+ *
95
+ * @readonly
96
+ */
97
+ channels(): Promise<Channel[]>;
98
+ /**
99
+ * One webhook per channel the bot can post to. POST JSON `{ content }` with
100
+ * a token from {@link createToken} in the `x-macro-bot-token` header and
101
+ * `x-macro-bot-scope: user`. Empty until {@link grantChannel}.
102
+ *
103
+ * @readonly
104
+ */
105
+ webhooks(): Promise<BotWebhook[]>;
106
+ /**
107
+ * Let the bot post to a channel. The caller must be a member of it and manage the bot.
108
+ *
109
+ * @write
110
+ * @idempotent
111
+ */
112
+ grantChannel(channel: Channel): Promise<void>;
113
+ /**
114
+ * Remove the bot from a channel. Works after the caller has left the channel.
115
+ *
116
+ * @destructive
117
+ * @idempotent
118
+ */
119
+ revokeChannel(channel: Channel): Promise<void>;
120
+ /**
121
+ * The bot's tokens, including revoked and expired ones. Secrets are never returned.
122
+ *
123
+ * @readonly
124
+ */
125
+ tokens(): Promise<BotToken[]>;
126
+ /**
127
+ * Mint a bearer token for the bot's webhooks and API; refused to an agent's
128
+ * program (ExecuteCode, a routine), so there present a card that mints it,
129
+ * `execution.views.present({widgets: [{type: 'botCredential', botId}]})` in
130
+ * an agent session, or have the user mint it in bot settings. The secret is
131
+ * returned once and cannot be read again; never write it into chat,
132
+ * documents or results.
133
+ *
134
+ * @write
135
+ */
136
+ createToken(options?: {
137
+ label?: string;
138
+ expiresAt?: Date;
139
+ }): Promise<{
140
+ token: BotToken;
141
+ secret: string;
142
+ }>;
143
+ }
@@ -0,0 +1,50 @@
1
+ import type { BotChannel, Bot as BotRecord } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { Bot, type CreateBotOptions } from './bot';
4
+ /**
5
+ * Bots the user manages — create, list, configure, delete, channel access,
6
+ * webhooks and tokens — and, with bot auth (`auth: { type: 'bot', token }`),
7
+ * the authenticated bot's own identity.
8
+ *
9
+ * @routing Use when inspecting or managing bots and their channel access; not an agent's instructions, which are agents.
10
+ */
11
+ export declare class BotsNamespace {
12
+ private readonly client;
13
+ constructor(client: RoxClient);
14
+ /** A handle to a bot by id. */
15
+ byId(id: string): Bot;
16
+ /**
17
+ * The bots the user can manage: their own and their teams'.
18
+ *
19
+ * @readonly
20
+ */
21
+ list(): Promise<Bot[]>;
22
+ /**
23
+ * Create a bot. It can post nowhere until `bot.grantChannel(channel)`; then
24
+ * `bot.webhooks()` and `bot.createToken()` give an integration what it needs.
25
+ *
26
+ * @write
27
+ */
28
+ create(options: CreateBotOptions): Promise<Bot>;
29
+ /**
30
+ * The authenticated bot's own record. Requires bot auth; with a user API
31
+ * key this throws (a user token has no bot identity).
32
+ *
33
+ * @readonly
34
+ */
35
+ me(): Promise<BotRecord>;
36
+ /**
37
+ * Channels containing the authenticated bot. Requires bot auth.
38
+ *
39
+ * @readonly
40
+ */
41
+ channels(): Promise<BotChannel[]>;
42
+ /**
43
+ * The authenticated bot's canonical principal id (`bot|<uuid>`) — the form
44
+ * used for bot mentions, senders, and webhook `ids` filters. Cached on the
45
+ * client; see {@link RoxClient.myPrincipalId}.
46
+ *
47
+ * @readonly
48
+ */
49
+ myPrincipalId(): Promise<string>;
50
+ }
@@ -0,0 +1,39 @@
1
+ import type { BotToken as BotTokenRecord } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import type { Bot } from './bot';
5
+ /** A bot bearer token's metadata. The secret is returned only by `Bot.createToken`. */
6
+ export declare class BotToken extends RoxEntity<BotTokenRecord> {
7
+ /** The bot this token authenticates. */
8
+ readonly bot: Bot;
9
+ private constructor();
10
+ /** A handle to one of a bot's tokens by id. */
11
+ static byId(client: RoxClient, bot: Bot, id: string): BotToken;
12
+ /** Seed from a listed or created token. */
13
+ static from(client: RoxClient, bot: Bot, record: BotTokenRecord): BotToken;
14
+ protected fetch(): Promise<BotTokenRecord>;
15
+ /** The first characters of the secret, for telling tokens apart. */
16
+ readonly prefix: () => Promise<string>;
17
+ /** Where the token is used, such as `github-webhook`. */
18
+ readonly label: () => Promise<string | undefined>;
19
+ /** Last time the token authenticated a request. */
20
+ readonly lastUsedAt: () => Promise<string | undefined>;
21
+ /** Scheduled expiry. */
22
+ readonly expiresAt: () => Promise<string | undefined>;
23
+ /** When the token was revoked. */
24
+ readonly revokedAt: () => Promise<string | undefined>;
25
+ /** Creation time. */
26
+ readonly createdAt: () => Promise<string>;
27
+ /**
28
+ * Revoke the token; requests using it fail from now on.
29
+ *
30
+ * @destructive
31
+ * @idempotent
32
+ */
33
+ revoke(): Promise<void>;
34
+ toJSON(): {
35
+ id: string;
36
+ botId: string;
37
+ detail?: BotTokenRecord;
38
+ };
39
+ }
@@ -0,0 +1,55 @@
1
+ import type { BookingLinkDraft, BookingLink as BookingLinkRecord } from '../../../generated/calendar/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { RoxEntity } from '../entity';
4
+ import type { Team } from '../teams/team';
5
+ /**
6
+ * A reusable booking page (not a calendar meeting) on the user's or a team's
7
+ * profile: its full draft, the profile revision to edit it at, and the URL
8
+ * guests book through. Paused links (`enabled: false`) stay listed but accept
9
+ * no bookings.
10
+ */
11
+ export declare class BookingLink extends RoxEntity<BookingLinkRecord> {
12
+ /** The team owning the link; undefined for a personal link. */
13
+ readonly team: Team | undefined;
14
+ private constructor();
15
+ protected fetch(): Promise<BookingLinkRecord>;
16
+ /** A handle to a personal link, or a team's when `team` is given. Detail loads on first access. */
17
+ static byId(client: RoxClient, id: string, team?: Team): BookingLink;
18
+ /** A handle seeded with a link record the service returned. */
19
+ static fromRecord(client: RoxClient, record: BookingLinkRecord, team?: Team): BookingLink;
20
+ /** The full editable configuration: event details, hosts, rules, questions and schedule. */
21
+ readonly draft: () => Promise<BookingLinkDraft>;
22
+ /** The profile revision this link was read at; {@link edit} saves against it. */
23
+ readonly revision: () => Promise<number>;
24
+ /**
25
+ * The shareable URL guests book through.
26
+ *
27
+ * @readonly
28
+ */
29
+ webUrl(): Promise<string>;
30
+ /**
31
+ * Replace this link's whole configuration, only after the user replied
32
+ * approving the edited proposal, quoting that reply in `userConfirmation`.
33
+ *
34
+ * Start from {@link draft} and change only what the user asked for. Other
35
+ * links and the personal default hours keep their settings. The edit saves
36
+ * against {@link revision}; when someone saved in between it is refused
37
+ * (409): read the link again and confirm the updated proposal instead of
38
+ * overwriting their change. Returns the saved link.
39
+ *
40
+ * @write
41
+ */
42
+ edit(draft: BookingLinkDraft, options: {
43
+ userConfirmation: string;
44
+ }): Promise<BookingLink>;
45
+ toJSON(): {
46
+ id: string;
47
+ detail?: BookingLinkRecord | undefined;
48
+ } | {
49
+ url: string;
50
+ id: string;
51
+ detail?: BookingLinkRecord | undefined;
52
+ };
53
+ }
54
+ /** The public booking page of a profile, or of one link on it. */
55
+ export declare function bookingPageUrl(client: RoxClient, profileId: string, slug?: string): string;
@@ -0,0 +1,143 @@
1
+ import type { BookingInsights, BookingLinkDraft, BookingProfile, BookingSchedule } from '../../../generated/calendar/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import { Team } from '../teams/team';
4
+ import { User } from '../users/user';
5
+ import { Booking } from './booking';
6
+ import { BookingLink } from './booking-link';
7
+ /** Whose booking links: the user's own when `team` is omitted, otherwise that team's. */
8
+ export interface BookingScope {
9
+ /** A team the user belongs to; omit for the user's personal booking links. */
10
+ team?: Team;
11
+ }
12
+ /** A profile's booking settings and its public booking page. */
13
+ export interface BookingSettings {
14
+ /** Every setting, with the revision {@link BookingNamespace.saveSettings} saves against. */
15
+ profile: BookingProfile;
16
+ /** The public page listing the profile's links; a revision-0 profile must be saved before sharing it. */
17
+ pageUrl: string;
18
+ }
19
+ /** The user's or a team's booking links, and what a new link can reuse. */
20
+ export interface BookingLinkListing {
21
+ /** Matching links, paused ones included. */
22
+ links: BookingLink[];
23
+ /** Reusable availability schedules to copy into a new draft. */
24
+ schedules: BookingSchedule[];
25
+ /** The user, as the host to name in a personal draft's `hosts`. */
26
+ host: User;
27
+ /** The user's teams, whose links {@link BookingNamespace.links} lists with `team`. */
28
+ teams: Team[];
29
+ /** The profile's public booking page. */
30
+ pageUrl: string;
31
+ }
32
+ /** A local date range for {@link BookingNamespace.insights}. */
33
+ export interface BookingInsightsQuery extends BookingScope {
34
+ /** First local date (`YYYY-MM-DD`), inclusive. */
35
+ from: string;
36
+ /** Last local date (`YYYY-MM-DD`), inclusive; at most 366 days after `from`. */
37
+ to: string;
38
+ /** IANA zone for dates and hour-of-day grouping. */
39
+ timeZone: string;
40
+ /** Only bookings of this link. */
41
+ link?: BookingLink;
42
+ /** Only bookings this user hosts. */
43
+ host?: User;
44
+ }
45
+ /**
46
+ * Booking links (`macro.calendar.booking`): reusable booking pages, the
47
+ * settings behind them, the meetings guests book through them, and their
48
+ * statistics. Personal unless a `team` is given; any team member can read and
49
+ * edit a team's.
50
+ */
51
+ export declare class BookingNamespace {
52
+ private readonly client;
53
+ constructor(client: RoxClient);
54
+ /**
55
+ * List and search the user's booking links (or a team's), with their full
56
+ * drafts, the reusable schedules and the user as host; call this before
57
+ * creating a link. Reading never creates settings.
58
+ *
59
+ * `query` matches link title, slug and description; omit it for every link
60
+ * (at most 100).
61
+ *
62
+ * @readonly
63
+ */
64
+ links(options?: BookingScope & {
65
+ query?: string;
66
+ }): Promise<BookingLinkListing>;
67
+ /**
68
+ * Create a booking link only after the user replied approving the full
69
+ * proposal, quoting that reply in `userConfirmation`; never on the request
70
+ * that asked for the link.
71
+ *
72
+ * List {@link links} first and reuse what fits. Before creating, write the
73
+ * whole proposal out for the user: personal or team ownership, the named
74
+ * hosts and who attends, meeting name and description, duration, location,
75
+ * Rox call or Google Meet, time zone, weekly hours and date exceptions,
76
+ * link name, buffers, minimum notice, booking window, slot interval, daily
77
+ * limit, guest questions and whether bookings are enabled. Ask whether to
78
+ * proceed and stop. Never ask the user for ids, revisions or JSON.
79
+ *
80
+ * The draft needs all seven weekdays (Sunday is 0), an IANA time zone and
81
+ * real hosts: a personal link names {@link BookingLinkListing.host} with
82
+ * mode `individual`; a team link uses `collective` or `roundRobin`.
83
+ * `requiresConfirmation` must be false. For video set `macroCall`
84
+ * or `googleMeet`, as the user asks, never both. Creating sends no invitations.
85
+ * Replaying an identical draft at the same slug returns the saved link; a
86
+ * different draft at that slug conflicts (409). Share the link's
87
+ * {@link BookingLink.webUrl} as an `<m-booking-link-mention>` chip.
88
+ *
89
+ * @write
90
+ * @idempotent
91
+ */
92
+ createLink(draft: BookingLinkDraft, options: BookingScope & {
93
+ userConfirmation: string;
94
+ }): Promise<BookingLink>;
95
+ /**
96
+ * Read every booking setting of the user (or a team): booking-page name and
97
+ * introduction, reusable schedules, default hours and every link. Reading
98
+ * never creates settings.
99
+ *
100
+ * @readonly
101
+ */
102
+ settings(options?: BookingScope): Promise<BookingSettings>;
103
+ /**
104
+ * Save the full settings read with {@link settings}, only after the user
105
+ * replied approving the changes; use {@link createLink} and
106
+ * {@link BookingLink.edit} for a single link.
107
+ *
108
+ * Change only what the user asked for and keep every id; generate new
109
+ * UUIDs for new schedules, links and questions. A shared schedule's hours
110
+ * apply to every link using it, and personal default hours apply to team
111
+ * hosting, so name the affected links before changing them. Deleting a link
112
+ * cancels none of its bookings. Saving at a stale revision is refused (409):
113
+ * read again and reconcile instead of overwriting.
114
+ *
115
+ * @destructive
116
+ */
117
+ saveSettings(profile: BookingProfile, options?: BookingScope): Promise<BookingSettings>;
118
+ /**
119
+ * Every booking starting in a half-open range (`from` inclusive, `to`
120
+ * exclusive, ISO timestamps with an offset, at most 733 days apart), with
121
+ * guests, answers, attendance and reschedule history. An oversized result
122
+ * fails rather than truncating: narrow the range. Use {@link insights} for
123
+ * statistics.
124
+ *
125
+ * @readonly
126
+ */
127
+ bookings(options: BookingScope & {
128
+ from: string;
129
+ to: string;
130
+ }): Promise<Booking[]>;
131
+ /**
132
+ * Booking statistics for local dates, and the equally long period before:
133
+ * totals, completed, rescheduled, cancelled, no-shows, scheduled minutes,
134
+ * daily trends, popular hours and counts by link and host.
135
+ *
136
+ * Failed and processing requests are excluded. Completed means confirmed
137
+ * and ended without a recorded no-show, not verified attendance; minutes
138
+ * are scheduled duration, not call length. No guest contact details.
139
+ *
140
+ * @readonly
141
+ */
142
+ insights(query: BookingInsightsQuery): Promise<BookingInsights>;
143
+ }