@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,268 @@
1
+ import type { ApiContactInfo, ApiDraftContactInfo, ApiThreadPreviewCursorInner, CalendarInvitation, GetThreadResponses, MailboxOperation, UpdateThreadStateRequest } from '../../../generated/email/types.gen';
2
+ import type { EmailFollowupCommand } from '../../../generated/storage/types.gen';
3
+ import type { RoxClient } from '../../utils/client';
4
+ import type { Calendar } from '../calendar/calendar';
5
+ import { CalendarEvent } from '../calendar/event';
6
+ import type { Channel } from '../channels/channel';
7
+ import { PropertiedEntity } from '../entity';
8
+ import { Project } from '../projects/project';
9
+ import { EntityAccess } from '../sharing/access';
10
+ import { type SharePermissionOptions } from '../sharing/permissions';
11
+ import { EmailAttachment } from './attachment';
12
+ import { EmailDraft } from './draft';
13
+ import type { Label } from './label';
14
+ import { Link } from './link';
15
+ import { EmailMessage } from './message';
16
+ type ThreadDetail = GetThreadResponses[200]['thread'];
17
+ /** Options for replying within an email thread. */
18
+ export interface ReplyEmailOptions {
19
+ /** Recipients. */
20
+ to: ApiDraftContactInfo[];
21
+ /** Cc recipients. */
22
+ cc?: ApiDraftContactInfo[];
23
+ /** Bcc recipients. */
24
+ bcc?: ApiDraftContactInfo[];
25
+ /** Plain-text body. */
26
+ bodyText: string;
27
+ /** Subject line. Defaults to the subject of the thread's first message. */
28
+ subject?: string;
29
+ /** The message being replied to. */
30
+ replyingTo?: EmailMessage;
31
+ }
32
+ /** Open tracking for one of the caller's sent messages. */
33
+ export interface EmailReadReceipt {
34
+ /** The tracked message. */
35
+ message: EmailMessage;
36
+ /** Counted pixel fetches; repeats within a few seconds count once. */
37
+ openCount: number;
38
+ /** When the first counted fetch happened, if any. */
39
+ firstOpenedAt?: string;
40
+ /** When the latest counted fetch happened, if any. */
41
+ lastOpenedAt?: string;
42
+ }
43
+ /**
44
+ * An email thread. A free-to-construct handle: the detail record (including
45
+ * up to the first 100 messages) loads lazily on first field access.
46
+ */
47
+ export declare class EmailThread extends PropertiedEntity<ThreadDetail> {
48
+ /** Access requests and direct user grants. */
49
+ readonly access: EntityAccess;
50
+ /**
51
+ * Read follow-up state for this thread.
52
+ *
53
+ * @readonly
54
+ */
55
+ followup(): Promise<import("../../../generated/storage").EmailFollowupResponse>;
56
+ /**
57
+ * Set or remove a follow-up using a persisted operation id and revision.
58
+ *
59
+ * @write
60
+ * @idempotent
61
+ */
62
+ setFollowup(command: EmailFollowupCommand): Promise<import("../../../generated/storage").EmailFollowup>;
63
+ /**
64
+ * Calendar invitations resolved from this thread's messages.
65
+ *
66
+ * @readonly
67
+ */
68
+ calendarInvitations(): Promise<{
69
+ [key: string]: import("../../../generated/email").InvitationResolution;
70
+ }>;
71
+ /** Add a shared event one of this thread's messages carries (a published
72
+ * `.ics`, such as one sent with Forward by email) to one of the
73
+ * requester's Google calendars, and return a handle to the synced
74
+ * snapshot. The event is read from the saved message, never from the
75
+ * caller, and lands the way {@link CalendarEvent.addToCalendar} adds a
76
+ * channel-shared one: the meeting's iCalendar UID and organizer, only the
77
+ * requester as a guest, no join link, nobody notified. Refused with
78
+ * `invalid_input` for an invitation, which is answered from the calendar
79
+ * instead, `already_on_calendar` when the meeting is already on one of
80
+ * their calendars, whichever calendar is named (it cannot be added to
81
+ * another of theirs either), and `copy_refused` when Google will not
82
+ * import it.
83
+ *
84
+ * @write
85
+ * @openworld
86
+ */
87
+ addEventToCalendar(message: EmailMessage, invitation: CalendarInvitation, options?: {
88
+ calendar?: Calendar;
89
+ }): Promise<CalendarEvent>;
90
+ /**
91
+ * Opens recorded for messages sent from the caller's own or delegated
92
+ * inboxes with read receipts on, newest message first. Counts are
93
+ * approximate: some mail apps prefetch images and others block them.
94
+ *
95
+ * @readonly
96
+ */
97
+ readReceipts(): Promise<EmailReadReceipt[]>;
98
+ /**
99
+ * Change project membership or share permissions for this thread.
100
+ *
101
+ * @write
102
+ * @idempotent
103
+ */
104
+ update(options: {
105
+ project?: Project | null;
106
+ sharePermission?: SharePermissionOptions;
107
+ }): Promise<void>;
108
+ /** Favorites identify email threads as `email_thread`. */
109
+ readonly entityType = "email_thread";
110
+ /**
111
+ * Share this email thread with a channel's current members, as posting it in the
112
+ * channel does. The caller must be in the channel and able to share the
113
+ * email thread; sharing again changes nothing.
114
+ *
115
+ * @write
116
+ * @idempotent
117
+ */
118
+ shareWithChannel(channel: Channel): Promise<void>;
119
+ /** The properties service identifies email threads as `THREAD`. */
120
+ protected readonly propertyEntityType = "THREAD";
121
+ protected fetch(): Promise<ThreadDetail>;
122
+ /**
123
+ * The thread's URL in the Rox web app; hand it to users as the link.
124
+ *
125
+ * @readonly
126
+ */
127
+ webUrl(): string;
128
+ /** Identity, loaded detail and {@link webUrl}, so serialized handles carry their link. */
129
+ toJSON(): {
130
+ url: string;
131
+ id: string;
132
+ detail?: import("../../../generated/email").ApiThread | undefined;
133
+ };
134
+ /** A handle to a thread by id. Details load on first access. */
135
+ static byId(client: RoxClient, id: string): EmailThread;
136
+ /**
137
+ * A handle seeded from an inbox preview with the thread columns it carries.
138
+ * Its subject is the latest message's and its times are inbox sort times,
139
+ * so `subject()` and the timestamps still read the thread.
140
+ */
141
+ static fromPreview(client: RoxClient, preview: ApiThreadPreviewCursorInner): EmailThread;
142
+ /** When the thread was created. */
143
+ readonly createdAt: () => Promise<string>;
144
+ /** When the thread was last updated. */
145
+ readonly updatedAt: () => Promise<string>;
146
+ /** Whether the thread has been read. */
147
+ readonly isRead: () => Promise<boolean>;
148
+ /** Whether the thread is visible in the inbox (i.e. not archived). */
149
+ readonly inboxVisible: () => Promise<boolean>;
150
+ /** The viewer's access level to this thread. */
151
+ readonly accessLevel: () => Promise<import("../../../generated/email").AccessLevel>;
152
+ /** The provider-internal thread id (e.g. Gmail/Outlook), if any. */
153
+ readonly providerId: () => Promise<string | undefined>;
154
+ /** The inbox (email link) that owns this thread. */
155
+ readonly link: () => Promise<Link>;
156
+ /** The project this thread is attached to, if any. */
157
+ readonly project: () => Promise<Project | undefined>;
158
+ /** Timestamp of the latest inbound message, if any. */
159
+ readonly latestInboundAt: () => Promise<string | undefined>;
160
+ /** Timestamp of the latest outbound message, if any. */
161
+ readonly latestOutboundAt: () => Promise<string | undefined>;
162
+ /** Timestamp of the latest non-spam message, if any. */
163
+ readonly latestNonSpamAt: () => Promise<string | undefined>;
164
+ /**
165
+ * The thread's subject, from its first message with one.
166
+ *
167
+ * @readonly
168
+ */
169
+ subject(): Promise<string | undefined>;
170
+ /**
171
+ * Everyone on the thread (senders and recipients), deduped by email.
172
+ * Derived from the thread's first 100 messages.
173
+ *
174
+ * @readonly
175
+ */
176
+ participants(): Promise<ApiContactInfo[]>;
177
+ /**
178
+ * The messages in this thread, pre-seeded from the list endpoint.
179
+ *
180
+ * @readonly
181
+ */
182
+ messages(opts?: {
183
+ since?: string;
184
+ limit?: number;
185
+ }): Promise<EmailMessage[]>;
186
+ /**
187
+ * The unsent drafts among this thread's first 100 messages, from the thread detail.
188
+ *
189
+ * @readonly
190
+ */
191
+ drafts(): Promise<EmailDraft[]>;
192
+ /**
193
+ * The attachments across this thread's first 100 messages, pre-seeded from the thread detail.
194
+ *
195
+ * @readonly
196
+ */
197
+ attachments(): Promise<EmailAttachment[]>;
198
+ /**
199
+ * Send a plain-text reply in this thread; an agent's program is refused
200
+ * (403) and replies through a review or `email.sendConfirmed` with
201
+ * `replyingTo` instead. Returns a handle when the API reports the created
202
+ * message's id.
203
+ *
204
+ * @send
205
+ * @openworld
206
+ */
207
+ reply(opts: ReplyEmailOptions): Promise<EmailMessage | undefined>;
208
+ /**
209
+ * Archive the thread (or unarchive with `false`).
210
+ *
211
+ * @write
212
+ * @openworld
213
+ * @idempotent
214
+ */
215
+ archive(archived?: boolean): Promise<void>;
216
+ /**
217
+ * Archive many threads (or unarchive with `false`), sending one request per
218
+ * 100 threads. Resolves to the threads whose state could not change.
219
+ */
220
+ static archiveMany(client: RoxClient, threads: EmailThread[], archived?: boolean): Promise<EmailThread[]>;
221
+ /**
222
+ * Update provider-neutral read, trash, spam, or star state.
223
+ *
224
+ * @destructive
225
+ * @openworld
226
+ * @idempotent
227
+ */
228
+ updateState(request: UpdateThreadStateRequest): Promise<void>;
229
+ /**
230
+ * Read pending or failed mailbox changes without initiating a retry.
231
+ *
232
+ * @readonly
233
+ */
234
+ operations(): Promise<MailboxOperation[]>;
235
+ /**
236
+ * Mark the thread as seen.
237
+ *
238
+ * @write
239
+ * @idempotent
240
+ */
241
+ markSeen(): Promise<void>;
242
+ /**
243
+ * Add a label to every message in the thread.
244
+ *
245
+ * @write
246
+ * @openworld
247
+ * @idempotent
248
+ */
249
+ addLabel(label: Label): Promise<void>;
250
+ /**
251
+ * Remove a label from every message in the thread.
252
+ *
253
+ * @write
254
+ * @openworld
255
+ * @idempotent
256
+ */
257
+ removeLabel(label: Label): Promise<void>;
258
+ /**
259
+ * Attach the thread to a project, or clear the project with `null`.
260
+ *
261
+ * @write
262
+ * @idempotent
263
+ */
264
+ moveToProject(project: Project | null): Promise<void>;
265
+ /** Search email threads by subject and content, most relevant first, auto-paginated; `maxItems` caps the total. */
266
+ static search: (client: RoxClient, query: string, searchOpts?: import("../search/options").SearchOpts) => AsyncGenerator<EmailThread, any, any>;
267
+ }
268
+ export {};
@@ -0,0 +1,21 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ /** A stored mention connecting two resources. */
3
+ export declare class EntityMention {
4
+ private readonly client;
5
+ /** Mention identity. */
6
+ readonly id: string;
7
+ private constructor();
8
+ /** Construct a mention handle for removal. */
9
+ static byId(client: RoxClient, id: string): EntityMention;
10
+ /**
11
+ * Remove this mention.
12
+ *
13
+ * @destructive
14
+ * @idempotent
15
+ */
16
+ delete(): Promise<void>;
17
+ /** Serialize identity only. */
18
+ toJSON(): {
19
+ id: string;
20
+ };
21
+ }
@@ -0,0 +1,20 @@
1
+ import type { RoxClient } from '../../utils/client';
2
+ import type { EntityReference } from '../reference';
3
+ import { EntityMention } from './mention';
4
+ /**
5
+ * Stored entity mention relationships.
6
+ *
7
+ * @routing Use when recording or removing a typed mention relationship between two Rox items; not writing mention tags into text.
8
+ */
9
+ export declare class EntityMentionNamespace {
10
+ private readonly client;
11
+ constructor(client: RoxClient);
12
+ /** Construct a stored mention handle. */
13
+ byId(id: string): EntityMention;
14
+ /**
15
+ * Create a mention from a source resource to a target resource.
16
+ *
17
+ * @write
18
+ */
19
+ create(source: EntityReference, target: EntityReference): Promise<EntityMention>;
20
+ }
@@ -0,0 +1,167 @@
1
+ import type { BulkUpdateEntityPropertyOptionsResponse, EntityPropertyWithDefinition, PropertyTargetEntityType as PropertyEntityType, PropertyTargetReference, SetPropertyValue } from '../../generated/properties/types.gen';
2
+ import type { FavoriteEntityRef } from '../../generated/storage/types.gen';
3
+ import { Lazy } from '../utils';
4
+ import type { RoxClient } from '../utils/client';
5
+ import type { PropertyDefinition } from './properties/property-definition';
6
+ import type { PropertyOption } from './properties/property-option';
7
+ /** How the entity-addressed APIs (favorites) identify an entity's type. */
8
+ export type RoxEntityType = FavoriteEntityRef['entityType'];
9
+ /** An entity that can be added to and removed from the user's favorites. */
10
+ export interface Favoritable {
11
+ favorite(): Promise<this>;
12
+ unfavorite(): Promise<this>;
13
+ }
14
+ /** A favoritable entity that also carries user-defined properties. */
15
+ export interface Propertied extends Favoritable {
16
+ properties(opts?: {
17
+ includeMetadata?: boolean;
18
+ }): Promise<EntityPropertyWithDefinition[]>;
19
+ setProperty(property: PropertyDefinition, value?: SetPropertyValue): Promise<void>;
20
+ deleteProperty(assignment: EntityPropertyWithDefinition): Promise<void>;
21
+ }
22
+ /** A delta to apply to one multi-select property. */
23
+ export interface PropertyOptionDelta {
24
+ /** The multi-select property definition to update. */
25
+ property: PropertyDefinition;
26
+ /** Options to add to the property's current selection. */
27
+ add?: PropertyOption[];
28
+ /** Options to remove from the property's current selection. */
29
+ remove?: PropertyOption[];
30
+ }
31
+ /** `null` folded into `undefined`, so optional API fields read naturally. */
32
+ type Normalized<V> = null extends V ? NonNullable<V> | undefined : undefined extends V ? NonNullable<V> | undefined : V;
33
+ /**
34
+ * Base for entity handles: a free-to-construct `(client, id)` pair whose
35
+ * detail record loads lazily on first field access and is dropped after any
36
+ * mutation. Subclasses implement {@link fetch} and build their surface from
37
+ * {@link field} and {@link mutate}.
38
+ */
39
+ export declare abstract class RoxEntity<Detail> {
40
+ protected readonly client: RoxClient;
41
+ readonly id: string;
42
+ protected readonly detail: Lazy<Detail>;
43
+ protected constructor(client: RoxClient, id: string, seed?: Detail);
44
+ /**
45
+ * Seed fields a listing returned, so {@link field} and {@link mappedField}
46
+ * read them without loading the detail. Map listing fields onto detail keys
47
+ * only where both mean the same thing; leave out anything the listing
48
+ * leaves empty or reports differently. Returns this handle.
49
+ */
50
+ protected withListed(fields: Partial<Detail>): this;
51
+ /** Load the detail record backing {@link field} accessors. */
52
+ protected abstract fetch(): Promise<Detail>;
53
+ /** A lazy accessor for one detail field, `null` normalized to `undefined`. */
54
+ protected field<K extends keyof Detail>(key: K): () => Promise<Normalized<Detail[K]>>;
55
+ /**
56
+ * Like {@link field}, but maps the raw value through `map` before returning.
57
+ * Used to expose an id field as a handle to the entity it references, e.g.
58
+ * `this.mappedField('owner', (id) => User.byId(this.client, id))`.
59
+ */
60
+ protected mappedField<K extends keyof Detail, T>(key: K, map: (value: Normalized<Detail[K]>) => T): () => Promise<T>;
61
+ private readDetailField;
62
+ toJSON(): {
63
+ id: string;
64
+ detail?: Detail;
65
+ };
66
+ /** Run a write, unwrap it, and drop the cached detail so reads refetch. */
67
+ protected mutate<TData>(fn: (client: RoxClient) => Promise<{
68
+ data?: TData;
69
+ error?: unknown;
70
+ response?: Response;
71
+ }>): Promise<TData>;
72
+ }
73
+ /** An entity the favorites API can address, and so can be (un)favorited. */
74
+ export declare abstract class FavoritableEntity<Detail> extends RoxEntity<Detail> implements Favoritable {
75
+ /** How the entity-addressed APIs (favorites) identify this entity's type. */
76
+ abstract readonly entityType: RoxEntityType;
77
+ /**
78
+ * Read the caller's effective permission on this entity.
79
+ *
80
+ * @readonly
81
+ */
82
+ permission(): Promise<{
83
+ permission: import("../../generated/storage").EntityPermission;
84
+ status: "access";
85
+ } | {
86
+ status: "no_access";
87
+ }>;
88
+ /**
89
+ * Add this entity to the user's favorites. Returns this handle for chaining.
90
+ * Plain unwrap: favoriting alters the user's favorites collection, not this
91
+ * entity's own detail, so there's nothing cached to invalidate.
92
+ *
93
+ * @write
94
+ * @idempotent
95
+ */
96
+ favorite(): Promise<this>;
97
+ /**
98
+ * Mute notifications about this item for the user only, as Mute in the app
99
+ * does; with `until`, a snooze that ends then. Nobody else's notifications
100
+ * change. Returns this handle for chaining.
101
+ *
102
+ * @write
103
+ */
104
+ muteNotifications(opts?: {
105
+ /** When notifications resume; must be in the future. Omit to mute until unmuted. */
106
+ until?: Date;
107
+ }): Promise<this>;
108
+ /** Resume notifications about this item, ending a mute or snooze. Returns this handle for chaining.
109
+ *
110
+ * @write
111
+ */
112
+ unmuteNotifications(): Promise<this>;
113
+ /**
114
+ * Remove this entity from the user's favorites. Returns this handle for chaining.
115
+ *
116
+ * @write
117
+ * @idempotent
118
+ */
119
+ unfavorite(): Promise<this>;
120
+ }
121
+ /** A favoritable entity that also carries user-defined properties. */
122
+ export declare abstract class PropertiedEntity<Detail> extends FavoritableEntity<Detail> implements Propertied {
123
+ /**
124
+ * This entity's type in the properties service, which names types
125
+ * differently from {@link entityType} (e.g. `THREAD` for `email_thread`).
126
+ */
127
+ protected abstract readonly propertyEntityType: PropertyEntityType;
128
+ /**
129
+ * This entity's reference for bulk property operations.
130
+ *
131
+ * @readonly
132
+ */
133
+ propertyReference(): PropertyTargetReference;
134
+ /**
135
+ * The properties set on this entity, each with its definition, value, and options.
136
+ *
137
+ * @readonly
138
+ */
139
+ properties(opts?: {
140
+ includeMetadata?: boolean;
141
+ }): Promise<EntityPropertyWithDefinition[]>;
142
+ /**
143
+ * Set a property value on this entity, or attach the property without a
144
+ * value when `value` is omitted.
145
+ *
146
+ * @write
147
+ * @idempotent
148
+ */
149
+ setProperty(property: PropertyDefinition, value?: SetPropertyValue): Promise<void>;
150
+ /**
151
+ * Apply multi-select option deltas atomically across this entity's properties.
152
+ *
153
+ * @write
154
+ * @idempotent
155
+ * @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
156
+ */
157
+ updatePropertyOptions(changes: PropertyOptionDelta[]): Promise<BulkUpdateEntityPropertyOptionsResponse>;
158
+ /**
159
+ * Clear one property's value on this item, given its {@link properties}
160
+ * entry; the item itself and the property's definition are kept.
161
+ *
162
+ * @destructive
163
+ * @idempotent
164
+ */
165
+ deleteProperty(assignment: EntityPropertyWithDefinition): Promise<void>;
166
+ }
167
+ export {};
@@ -0,0 +1,173 @@
1
+ import type { ExternalChatDetail, UpdateSharePermissionRequestV2 } from '../../../generated/storage/types.gen';
2
+ import type { RoxClient } from '../../utils/client';
3
+ import type { Channel } from '../channels/channel';
4
+ import { FavoritableEntity } from '../entity';
5
+ import { User } from '../users/user';
6
+ import { type WhatsAppCommunity } from '../whatsapp/chat';
7
+ import { ExternalChatMessage } from './message';
8
+ import { ExternalChatParticipant } from './participant';
9
+ import { ExternalChatSend } from './send';
10
+ import { ExternalChatUpload } from './upload';
11
+ /** Deliberate content sent from the credential owner's own provider account. */
12
+ export type ExternalChatContent = {
13
+ type: 'text';
14
+ text: string;
15
+ /** Participants mentioned (from `participants()`); the text names each as `@<mentionToken>`. */
16
+ mentions?: ExternalChatParticipant[];
17
+ } | {
18
+ type: 'media';
19
+ upload: ExternalChatUpload;
20
+ caption?: string;
21
+ } | {
22
+ type: 'mutation';
23
+ message: ExternalChatMessage;
24
+ operation: 'reaction' | 'edit' | 'delete';
25
+ text?: string;
26
+ };
27
+ /**
28
+ * A chat from an external messaging provider (WhatsApp today), added to Rox
29
+ * by its owner and shareable like any other entity: a group or a direct chat.
30
+ */
31
+ export declare class ExternalChat extends FavoritableEntity<ExternalChatDetail> {
32
+ /** Canonical sharing and favorites kind. */
33
+ readonly entityType: "external_chat";
34
+ /**
35
+ * Share this chat with a channel's current members, as posting it in the
36
+ * channel does. The caller must be in the channel and able to share the
37
+ * chat; sharing again changes nothing.
38
+ *
39
+ * @write
40
+ * @idempotent
41
+ */
42
+ shareWithChannel(channel: Channel): Promise<void>;
43
+ /** Reference an added chat; access is checked on each request. */
44
+ static byId(client: RoxClient, id: string): ExternalChat;
45
+ protected fetch(): Promise<ExternalChatDetail>;
46
+ /** The messaging provider the chat lives in, such as `whatsapp`. */
47
+ readonly provider: () => Promise<"whatsapp">;
48
+ /** Display name: the group's, or a direct chat's other person. */
49
+ readonly name: () => Promise<string>;
50
+ /** `group`, or `direct` for a one-to-one chat (only its owner sends). */
51
+ readonly kind: () => Promise<import("../../../generated/storage").ExternalChatKind>;
52
+ /** Whether the caller can send from their own connected account. */
53
+ readonly canSend: () => Promise<boolean>;
54
+ /** Reason sending is blocked. */
55
+ readonly sendReason: () => Promise<NonNullable<import("../../../generated/storage").ExternalChatReplyBlock | null | undefined> | undefined>;
56
+ /** Caller's own verified sending identity. */
57
+ readonly sendingIdentity: () => Promise<string | undefined>;
58
+ /** Per-user unread count. */
59
+ readonly unreadCount: () => Promise<number>;
60
+ /** Importing earlier messages from the owner's phone after adding, if any. */
61
+ readonly backfill: () => Promise<import("../../../generated/storage").ExternalChatBackfill | undefined>;
62
+ /** Supported sizes and mutation window. */
63
+ readonly limits: () => Promise<import("../../../generated/storage").ExternalChatCapabilities>;
64
+ /** Current remote members (name, participants, announce), when known. */
65
+ readonly members: () => Promise<import("../../../generated/storage").ExternalChatMembers | undefined>;
66
+ /** Everyone in the chat, from its members; empty when none are known. */
67
+ readonly participants: () => Promise<ExternalChatParticipant[]>;
68
+ /** The provider's disappearing-messages timer in seconds while on; Rox keeps the messages. */
69
+ readonly disappearingSeconds: () => Promise<number | undefined>;
70
+ /** Actual owner, independent of provider membership. */
71
+ readonly owner: () => Promise<User>;
72
+ /**
73
+ * The community a group belongs to, if any: the community's own provider chat, its name, and whether this is its announcement group.
74
+ *
75
+ * @readonly
76
+ */
77
+ community(): Promise<WhatsAppCommunity | undefined>;
78
+ /**
79
+ * Iterate newest-first timeline pages lazily; `maxItems` caps the total.
80
+ *
81
+ * @readonly
82
+ */
83
+ messages(options?: {
84
+ limit?: number;
85
+ maxItems?: number;
86
+ }): AsyncGenerator<ExternalChatMessage>;
87
+ /**
88
+ * Advance the caller's own read cursor.
89
+ *
90
+ * @write
91
+ * @idempotent
92
+ */
93
+ markRead(message: ExternalChatMessage): Promise<void>;
94
+ /**
95
+ * Read standard link/team sharing settings.
96
+ *
97
+ * @readonly
98
+ */
99
+ permissions(): Promise<import("../../../generated/storage").SharePermissionV2>;
100
+ /**
101
+ * Actual owner updates standard link/team sharing settings.
102
+ *
103
+ * @write
104
+ * @idempotent
105
+ */
106
+ updatePermissions(update: UpdateSharePermissionRequestV2): Promise<void>;
107
+ /**
108
+ * Owner stops syncing the chat; history and established sharing stay.
109
+ *
110
+ * @destructive
111
+ * @idempotent
112
+ */
113
+ remove(): Promise<void>;
114
+ /**
115
+ * Stage a supported attachment for a deliberate send.
116
+ *
117
+ * @write
118
+ * @mcp-exclude Takes file bytes; MCP calls carry JSON only.
119
+ */
120
+ upload(file: Blob | File): Promise<ExternalChatUpload>;
121
+ /** Send to the chat; an agent's program must quote the user's reply approving this send in `userConfirmation`, or it is refused (403).
122
+ *
123
+ * Write the message out, ask, and send only after the user says yes; the
124
+ * request that asked for the message is not the approval. Personal sessions
125
+ * and owner API credentials can send. Bots never send.
126
+ * Preserve the idempotency key; uncertain outcomes are never automatically resent.
127
+ * The server enforces one request per second per user.
128
+ *
129
+ * @destructive
130
+ * @openworld
131
+ */
132
+ send(content: ExternalChatContent, options: {
133
+ idempotencyKey: string;
134
+ replyTo?: ExternalChatMessage;
135
+ /** The user's own reply approving this send, quoted verbatim. Required from an agent's program. */
136
+ userConfirmation?: string;
137
+ }): Promise<ExternalChatSend>;
138
+ /**
139
+ * Read only the caller's pending, uncertain or failed sends.
140
+ *
141
+ * @readonly
142
+ */
143
+ sends(): Promise<ExternalChatSend[]>;
144
+ /**
145
+ * Read delivery for selected caller-owned intents or messages.
146
+ *
147
+ * @readonly
148
+ */
149
+ delivery(sends: Array<ExternalChatSend | ExternalChatMessage>): Promise<ExternalChatSend[]>;
150
+ /**
151
+ * Read attachment states for selected messages.
152
+ *
153
+ * @readonly
154
+ */
155
+ messageAttachments(messages: ExternalChatMessage[]): Promise<{
156
+ message: ExternalChatMessage;
157
+ attachments: {
158
+ ordinal: number;
159
+ state: import("../../../generated/storage").ExternalChatAttachmentState;
160
+ fileName: string;
161
+ mime: string;
162
+ size: number;
163
+ url: string | undefined;
164
+ }[];
165
+ }[]>;
166
+ /**
167
+ * Reload detail, permissions and caller capabilities.
168
+ *
169
+ * @readonly
170
+ */
171
+ refresh(): Promise<this>;
172
+ private assertChat;
173
+ }