@rox-one/sdk 0.0.0-stage → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (483) hide show
  1. package/CALLS.md +82 -0
  2. package/README.md +1259 -2
  3. package/dist/chunk-AOHK5YXC.js +5585 -0
  4. package/dist/chunk-CATFKTFD.js +80 -0
  5. package/dist/chunk-FQGPXWPJ.js +1491 -0
  6. package/dist/chunk-G43PLP2U.js +1087 -0
  7. package/dist/chunk-LMJW65ML.js +836 -0
  8. package/dist/chunk-MCSQNZ4E.js +836 -0
  9. package/dist/chunk-NSJ3GKUC.js +1552 -0
  10. package/dist/chunk-OGFKJOK7.js +2068 -0
  11. package/dist/chunk-RDEJZJBZ.js +1351 -0
  12. package/dist/chunk-TMTYN2UK.js +1128 -0
  13. package/dist/chunk-V45LUJDI.js +838 -0
  14. package/dist/chunk-YRUXFEZM.js +1044 -0
  15. package/dist/chunk-ZYBAKW25.js +994 -0
  16. package/dist/generated/agent-fold/index.d.ts +4520 -0
  17. package/dist/generated/agent-fold/index.js +0 -0
  18. package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
  19. package/dist/generated/agent-harness/client/index.d.ts +10 -0
  20. package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
  21. package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
  22. package/dist/generated/agent-harness/client.gen.d.ts +12 -0
  23. package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
  24. package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
  25. package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
  26. package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
  27. package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
  28. package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
  29. package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
  30. package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
  31. package/dist/generated/agent-harness/index.d.ts +2 -0
  32. package/dist/generated/agent-harness/index.js +6 -0
  33. package/dist/generated/agent-harness/sdk.gen.d.ts +375 -0
  34. package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
  35. package/dist/generated/agent-reviews/index.d.ts +895 -0
  36. package/dist/generated/agent-reviews/index.js +0 -0
  37. package/dist/generated/auth/client/client.gen.d.ts +2 -0
  38. package/dist/generated/auth/client/index.d.ts +10 -0
  39. package/dist/generated/auth/client/types.gen.d.ts +120 -0
  40. package/dist/generated/auth/client/utils.gen.d.ts +37 -0
  41. package/dist/generated/auth/client.gen.d.ts +12 -0
  42. package/dist/generated/auth/core/auth.gen.d.ts +25 -0
  43. package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
  44. package/dist/generated/auth/core/params.gen.d.ts +43 -0
  45. package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
  46. package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
  47. package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
  48. package/dist/generated/auth/core/types.gen.d.ts +83 -0
  49. package/dist/generated/auth/core/utils.gen.d.ts +19 -0
  50. package/dist/generated/auth/index.d.ts +2 -0
  51. package/dist/generated/auth/index.js +6 -0
  52. package/dist/generated/auth/sdk.gen.d.ts +674 -0
  53. package/dist/generated/auth/types.gen.d.ts +5233 -0
  54. package/dist/generated/calendar/client/client.gen.d.ts +2 -0
  55. package/dist/generated/calendar/client/index.d.ts +10 -0
  56. package/dist/generated/calendar/client/types.gen.d.ts +120 -0
  57. package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
  58. package/dist/generated/calendar/client.gen.d.ts +12 -0
  59. package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
  60. package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
  61. package/dist/generated/calendar/core/params.gen.d.ts +43 -0
  62. package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
  63. package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
  64. package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
  65. package/dist/generated/calendar/core/types.gen.d.ts +83 -0
  66. package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
  67. package/dist/generated/calendar/index.d.ts +2 -0
  68. package/dist/generated/calendar/index.js +6 -0
  69. package/dist/generated/calendar/sdk.gen.d.ts +157 -0
  70. package/dist/generated/calendar/types.gen.d.ts +2333 -0
  71. package/dist/generated/cognition/client/client.gen.d.ts +2 -0
  72. package/dist/generated/cognition/client/index.d.ts +10 -0
  73. package/dist/generated/cognition/client/types.gen.d.ts +120 -0
  74. package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
  75. package/dist/generated/cognition/client.gen.d.ts +12 -0
  76. package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
  77. package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
  78. package/dist/generated/cognition/core/params.gen.d.ts +43 -0
  79. package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
  80. package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
  81. package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
  82. package/dist/generated/cognition/core/types.gen.d.ts +83 -0
  83. package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
  84. package/dist/generated/cognition/index.d.ts +2 -0
  85. package/dist/generated/cognition/index.js +6 -0
  86. package/dist/generated/cognition/sdk.gen.d.ts +348 -0
  87. package/dist/generated/cognition/types.gen.d.ts +4228 -0
  88. package/dist/generated/connection/client/client.gen.d.ts +2 -0
  89. package/dist/generated/connection/client/index.d.ts +10 -0
  90. package/dist/generated/connection/client/types.gen.d.ts +120 -0
  91. package/dist/generated/connection/client/utils.gen.d.ts +37 -0
  92. package/dist/generated/connection/client.gen.d.ts +12 -0
  93. package/dist/generated/connection/core/auth.gen.d.ts +25 -0
  94. package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
  95. package/dist/generated/connection/core/params.gen.d.ts +43 -0
  96. package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
  97. package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
  98. package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
  99. package/dist/generated/connection/core/types.gen.d.ts +83 -0
  100. package/dist/generated/connection/core/utils.gen.d.ts +19 -0
  101. package/dist/generated/connection/index.d.ts +2 -0
  102. package/dist/generated/connection/index.js +854 -0
  103. package/dist/generated/connection/sdk.gen.d.ts +43 -0
  104. package/dist/generated/connection/types.gen.d.ts +252 -0
  105. package/dist/generated/contacts/client/client.gen.d.ts +2 -0
  106. package/dist/generated/contacts/client/index.d.ts +10 -0
  107. package/dist/generated/contacts/client/types.gen.d.ts +120 -0
  108. package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
  109. package/dist/generated/contacts/client.gen.d.ts +12 -0
  110. package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
  111. package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
  112. package/dist/generated/contacts/core/params.gen.d.ts +43 -0
  113. package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
  114. package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
  115. package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
  116. package/dist/generated/contacts/core/types.gen.d.ts +83 -0
  117. package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
  118. package/dist/generated/contacts/index.d.ts +2 -0
  119. package/dist/generated/contacts/index.js +6 -0
  120. package/dist/generated/contacts/sdk.gen.d.ts +47 -0
  121. package/dist/generated/contacts/types.gen.d.ts +108 -0
  122. package/dist/generated/email/client/client.gen.d.ts +2 -0
  123. package/dist/generated/email/client/index.d.ts +10 -0
  124. package/dist/generated/email/client/types.gen.d.ts +120 -0
  125. package/dist/generated/email/client/utils.gen.d.ts +37 -0
  126. package/dist/generated/email/client.gen.d.ts +12 -0
  127. package/dist/generated/email/core/auth.gen.d.ts +25 -0
  128. package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
  129. package/dist/generated/email/core/params.gen.d.ts +43 -0
  130. package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
  131. package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
  132. package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
  133. package/dist/generated/email/core/types.gen.d.ts +83 -0
  134. package/dist/generated/email/core/utils.gen.d.ts +19 -0
  135. package/dist/generated/email/index.d.ts +2 -0
  136. package/dist/generated/email/index.js +6 -0
  137. package/dist/generated/email/sdk.gen.d.ts +301 -0
  138. package/dist/generated/email/types.gen.d.ts +3262 -0
  139. package/dist/generated/notification/client/client.gen.d.ts +2 -0
  140. package/dist/generated/notification/client/index.d.ts +10 -0
  141. package/dist/generated/notification/client/types.gen.d.ts +120 -0
  142. package/dist/generated/notification/client/utils.gen.d.ts +37 -0
  143. package/dist/generated/notification/client.gen.d.ts +12 -0
  144. package/dist/generated/notification/core/auth.gen.d.ts +25 -0
  145. package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
  146. package/dist/generated/notification/core/params.gen.d.ts +43 -0
  147. package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
  148. package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
  149. package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
  150. package/dist/generated/notification/core/types.gen.d.ts +83 -0
  151. package/dist/generated/notification/core/utils.gen.d.ts +19 -0
  152. package/dist/generated/notification/index.d.ts +2 -0
  153. package/dist/generated/notification/index.js +6 -0
  154. package/dist/generated/notification/sdk.gen.d.ts +127 -0
  155. package/dist/generated/notification/types.gen.d.ts +2084 -0
  156. package/dist/generated/properties/client/client.gen.d.ts +2 -0
  157. package/dist/generated/properties/client/index.d.ts +10 -0
  158. package/dist/generated/properties/client/types.gen.d.ts +120 -0
  159. package/dist/generated/properties/client/utils.gen.d.ts +37 -0
  160. package/dist/generated/properties/client.gen.d.ts +12 -0
  161. package/dist/generated/properties/core/auth.gen.d.ts +25 -0
  162. package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
  163. package/dist/generated/properties/core/params.gen.d.ts +43 -0
  164. package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
  165. package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
  166. package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
  167. package/dist/generated/properties/core/types.gen.d.ts +83 -0
  168. package/dist/generated/properties/core/utils.gen.d.ts +19 -0
  169. package/dist/generated/properties/index.d.ts +2 -0
  170. package/dist/generated/properties/index.js +6 -0
  171. package/dist/generated/properties/sdk.gen.d.ts +158 -0
  172. package/dist/generated/properties/types.gen.d.ts +1311 -0
  173. package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
  174. package/dist/generated/scheduled-action/client/index.d.ts +10 -0
  175. package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
  176. package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
  177. package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
  178. package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
  179. package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
  180. package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
  181. package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
  182. package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
  183. package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
  184. package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
  185. package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
  186. package/dist/generated/scheduled-action/index.d.ts +2 -0
  187. package/dist/generated/scheduled-action/index.js +6 -0
  188. package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
  189. package/dist/generated/scheduled-action/types.gen.d.ts +3099 -0
  190. package/dist/generated/search/client/client.gen.d.ts +2 -0
  191. package/dist/generated/search/client/index.d.ts +10 -0
  192. package/dist/generated/search/client/types.gen.d.ts +120 -0
  193. package/dist/generated/search/client/utils.gen.d.ts +37 -0
  194. package/dist/generated/search/client.gen.d.ts +12 -0
  195. package/dist/generated/search/core/auth.gen.d.ts +25 -0
  196. package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
  197. package/dist/generated/search/core/params.gen.d.ts +43 -0
  198. package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
  199. package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
  200. package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
  201. package/dist/generated/search/core/types.gen.d.ts +83 -0
  202. package/dist/generated/search/core/utils.gen.d.ts +19 -0
  203. package/dist/generated/search/index.d.ts +2 -0
  204. package/dist/generated/search/index.js +6 -0
  205. package/dist/generated/search/sdk.gen.d.ts +44 -0
  206. package/dist/generated/search/types.gen.d.ts +2532 -0
  207. package/dist/generated/static-files/client/client.gen.d.ts +2 -0
  208. package/dist/generated/static-files/client/index.d.ts +10 -0
  209. package/dist/generated/static-files/client/types.gen.d.ts +120 -0
  210. package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
  211. package/dist/generated/static-files/client.gen.d.ts +12 -0
  212. package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
  213. package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
  214. package/dist/generated/static-files/core/params.gen.d.ts +43 -0
  215. package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
  216. package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
  217. package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
  218. package/dist/generated/static-files/core/types.gen.d.ts +83 -0
  219. package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
  220. package/dist/generated/static-files/index.d.ts +2 -0
  221. package/dist/generated/static-files/index.js +842 -0
  222. package/dist/generated/static-files/sdk.gen.d.ts +43 -0
  223. package/dist/generated/static-files/types.gen.d.ts +220 -0
  224. package/dist/generated/storage/client/client.gen.d.ts +2 -0
  225. package/dist/generated/storage/client/index.d.ts +10 -0
  226. package/dist/generated/storage/client/types.gen.d.ts +120 -0
  227. package/dist/generated/storage/client/utils.gen.d.ts +37 -0
  228. package/dist/generated/storage/client.gen.d.ts +12 -0
  229. package/dist/generated/storage/core/auth.gen.d.ts +25 -0
  230. package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
  231. package/dist/generated/storage/core/params.gen.d.ts +43 -0
  232. package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
  233. package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
  234. package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
  235. package/dist/generated/storage/core/types.gen.d.ts +83 -0
  236. package/dist/generated/storage/core/utils.gen.d.ts +19 -0
  237. package/dist/generated/storage/index.d.ts +2 -0
  238. package/dist/generated/storage/index.js +6 -0
  239. package/dist/generated/storage/sdk.gen.d.ts +2285 -0
  240. package/dist/generated/storage/types.gen.d.ts +34546 -0
  241. package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
  242. package/dist/generated/unfurl/client/index.d.ts +10 -0
  243. package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
  244. package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
  245. package/dist/generated/unfurl/client.gen.d.ts +12 -0
  246. package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
  247. package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
  248. package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
  249. package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
  250. package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
  251. package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
  252. package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
  253. package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
  254. package/dist/generated/unfurl/index.d.ts +2 -0
  255. package/dist/generated/unfurl/index.js +6 -0
  256. package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
  257. package/dist/generated/unfurl/types.gen.d.ts +145 -0
  258. package/dist/src/calls/browser.d.ts +14 -0
  259. package/dist/src/calls/browser.js +102 -0
  260. package/dist/src/calls/common.d.ts +18 -0
  261. package/dist/src/calls/node.d.ts +24 -0
  262. package/dist/src/calls/node.js +145 -0
  263. package/dist/src/calls/telemetry.d.ts +5 -0
  264. package/dist/src/config.d.ts +71 -0
  265. package/dist/src/entities/account-managers/grant.d.ts +62 -0
  266. package/dist/src/entities/account-managers/namespace.d.ts +29 -0
  267. package/dist/src/entities/activity/entity.d.ts +7 -0
  268. package/dist/src/entities/activity/namespace.d.ts +58 -0
  269. package/dist/src/entities/activity/namespace.test.d.ts +1 -0
  270. package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
  271. package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
  272. package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
  273. package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
  274. package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
  275. package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
  276. package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
  277. package/dist/src/entities/agent-sessions/review.d.ts +114 -0
  278. package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
  279. package/dist/src/entities/agent-sessions/view.d.ts +11 -0
  280. package/dist/src/entities/agents/agent.d.ts +142 -0
  281. package/dist/src/entities/agents/namespace.d.ts +66 -0
  282. package/dist/src/entities/ai/namespace.d.ts +36 -0
  283. package/dist/src/entities/api-keys/api-key.d.ts +22 -0
  284. package/dist/src/entities/api-keys/namespace.d.ts +37 -0
  285. package/dist/src/entities/bots/bot.d.ts +143 -0
  286. package/dist/src/entities/bots/namespace.d.ts +50 -0
  287. package/dist/src/entities/bots/token.d.ts +39 -0
  288. package/dist/src/entities/calendar/booking-link.d.ts +55 -0
  289. package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
  290. package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
  291. package/dist/src/entities/calendar/booking.d.ts +97 -0
  292. package/dist/src/entities/calendar/calendar.d.ts +49 -0
  293. package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
  294. package/dist/src/entities/calendar/event.d.ts +283 -0
  295. package/dist/src/entities/calendar/event.test.d.ts +1 -0
  296. package/dist/src/entities/calendar/namespace.d.ts +334 -0
  297. package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
  298. package/dist/src/entities/calendar/replacement.d.ts +31 -0
  299. package/dist/src/entities/calls/call-record.d.ts +231 -0
  300. package/dist/src/entities/calls/connection.d.ts +59 -0
  301. package/dist/src/entities/calls/errors.d.ts +15 -0
  302. package/dist/src/entities/calls/message.d.ts +55 -0
  303. package/dist/src/entities/calls/namespace.d.ts +41 -0
  304. package/dist/src/entities/calls/participant.d.ts +22 -0
  305. package/dist/src/entities/canvases/canvas.d.ts +329 -0
  306. package/dist/src/entities/channels/access-request.d.ts +42 -0
  307. package/dist/src/entities/channels/activity.d.ts +40 -0
  308. package/dist/src/entities/channels/channel.d.ts +302 -0
  309. package/dist/src/entities/channels/labels.d.ts +73 -0
  310. package/dist/src/entities/channels/message.d.ts +153 -0
  311. package/dist/src/entities/channels/message.test.d.ts +1 -0
  312. package/dist/src/entities/channels/namespace.d.ts +82 -0
  313. package/dist/src/entities/channels/namespace.test.d.ts +1 -0
  314. package/dist/src/entities/channels/picture.d.ts +11 -0
  315. package/dist/src/entities/channels/post.d.ts +37 -0
  316. package/dist/src/entities/channels/post.test.d.ts +1 -0
  317. package/dist/src/entities/channels/share.d.ts +9 -0
  318. package/dist/src/entities/channels/share.test.d.ts +1 -0
  319. package/dist/src/entities/channels/thread.d.ts +64 -0
  320. package/dist/src/entities/chats/chat.d.ts +121 -0
  321. package/dist/src/entities/chats/generation.d.ts +55 -0
  322. package/dist/src/entities/chats/namespace.d.ts +35 -0
  323. package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
  324. package/dist/src/entities/connected-apps/connector.d.ts +59 -0
  325. package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
  326. package/dist/src/entities/crm/company.d.ts +154 -0
  327. package/dist/src/entities/crm/contact.d.ts +168 -0
  328. package/dist/src/entities/crm/namespace.d.ts +163 -0
  329. package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
  330. package/dist/src/entities/crm/pipeline.d.ts +426 -0
  331. package/dist/src/entities/crm/pipelines.d.ts +79 -0
  332. package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
  333. package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
  334. package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
  335. package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
  336. package/dist/src/entities/databases/column.d.ts +122 -0
  337. package/dist/src/entities/databases/database.d.ts +431 -0
  338. package/dist/src/entities/databases/namespace.d.ts +109 -0
  339. package/dist/src/entities/databases/query.d.ts +86 -0
  340. package/dist/src/entities/databases/row.d.ts +29 -0
  341. package/dist/src/entities/databases/saved-query.d.ts +151 -0
  342. package/dist/src/entities/databases/table.d.ts +124 -0
  343. package/dist/src/entities/databases/view.d.ts +72 -0
  344. package/dist/src/entities/databases/webhook.d.ts +39 -0
  345. package/dist/src/entities/documents/ai-edit.d.ts +54 -0
  346. package/dist/src/entities/documents/anchor.d.ts +39 -0
  347. package/dist/src/entities/documents/comment.d.ts +68 -0
  348. package/dist/src/entities/documents/create.test.d.ts +1 -0
  349. package/dist/src/entities/documents/document.d.ts +675 -0
  350. package/dist/src/entities/documents/markdown.d.ts +25 -0
  351. package/dist/src/entities/documents/namespace.d.ts +291 -0
  352. package/dist/src/entities/documents/office-files.d.ts +47 -0
  353. package/dist/src/entities/documents/skills.test.d.ts +1 -0
  354. package/dist/src/entities/documents/system-skill.d.ts +36 -0
  355. package/dist/src/entities/documents/text-comment.d.ts +41 -0
  356. package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
  357. package/dist/src/entities/documents/version.d.ts +26 -0
  358. package/dist/src/entities/email/attachment.d.ts +39 -0
  359. package/dist/src/entities/email/body-rox-compat.d.ts +22 -0
  360. package/dist/src/entities/email/draft.d.ts +164 -0
  361. package/dist/src/entities/email/filter.d.ts +44 -0
  362. package/dist/src/entities/email/label.d.ts +37 -0
  363. package/dist/src/entities/email/link.d.ts +35 -0
  364. package/dist/src/entities/email/message.d.ts +223 -0
  365. package/dist/src/entities/email/namespace.d.ts +235 -0
  366. package/dist/src/entities/email/namespace.test.d.ts +1 -0
  367. package/dist/src/entities/email/thread.d.ts +268 -0
  368. package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
  369. package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
  370. package/dist/src/entities/entity.d.ts +167 -0
  371. package/dist/src/entities/external-chat/chat.d.ts +173 -0
  372. package/dist/src/entities/external-chat/message.d.ts +54 -0
  373. package/dist/src/entities/external-chat/namespace.d.ts +22 -0
  374. package/dist/src/entities/external-chat/participant.d.ts +28 -0
  375. package/dist/src/entities/external-chat/send.d.ts +40 -0
  376. package/dist/src/entities/external-chat/upload.d.ts +25 -0
  377. package/dist/src/entities/favorites/namespace.d.ts +52 -0
  378. package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
  379. package/dist/src/entities/foreign/namespace.d.ts +54 -0
  380. package/dist/src/entities/forms/form.d.ts +319 -0
  381. package/dist/src/entities/forms/namespace.d.ts +30 -0
  382. package/dist/src/entities/forms/question.d.ts +65 -0
  383. package/dist/src/entities/forms/response.d.ts +52 -0
  384. package/dist/src/entities/forms/section.d.ts +31 -0
  385. package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
  386. package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
  387. package/dist/src/entities/harnesses/harness.d.ts +76 -0
  388. package/dist/src/entities/harnesses/namespace.d.ts +83 -0
  389. package/dist/src/entities/harnesses/pairing.d.ts +50 -0
  390. package/dist/src/entities/images/image.d.ts +88 -0
  391. package/dist/src/entities/images/namespace.d.ts +55 -0
  392. package/dist/src/entities/images/namespace.test.d.ts +1 -0
  393. package/dist/src/entities/imports/entry.d.ts +65 -0
  394. package/dist/src/entities/imports/namespace.d.ts +103 -0
  395. package/dist/src/entities/imports/namespace.test.d.ts +1 -0
  396. package/dist/src/entities/initiatives/initiative.d.ts +185 -0
  397. package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
  398. package/dist/src/entities/initiatives/namespace.d.ts +90 -0
  399. package/dist/src/entities/me/namespace.d.ts +68 -0
  400. package/dist/src/entities/meetings/meeting.d.ts +81 -0
  401. package/dist/src/entities/meetings/namespace.d.ts +38 -0
  402. package/dist/src/entities/memory/namespace.d.ts +49 -0
  403. package/dist/src/entities/memory/namespace.test.d.ts +1 -0
  404. package/dist/src/entities/messages/discussion.d.ts +84 -0
  405. package/dist/src/entities/messages/thread.d.ts +115 -0
  406. package/dist/src/entities/notifications/namespace.d.ts +66 -0
  407. package/dist/src/entities/notifications/notification.d.ts +78 -0
  408. package/dist/src/entities/notifications/notification.test.d.ts +1 -0
  409. package/dist/src/entities/passwords/item.d.ts +118 -0
  410. package/dist/src/entities/passwords/namespace.d.ts +45 -0
  411. package/dist/src/entities/pins/namespace.d.ts +42 -0
  412. package/dist/src/entities/projects/namespace.d.ts +45 -0
  413. package/dist/src/entities/projects/project.d.ts +108 -0
  414. package/dist/src/entities/properties/namespace.d.ts +105 -0
  415. package/dist/src/entities/properties/namespace.test.d.ts +1 -0
  416. package/dist/src/entities/properties/property-definition.d.ts +70 -0
  417. package/dist/src/entities/properties/property-option.d.ts +44 -0
  418. package/dist/src/entities/reference.d.ts +82 -0
  419. package/dist/src/entities/referrals/namespace.d.ts +40 -0
  420. package/dist/src/entities/routines/namespace.d.ts +239 -0
  421. package/dist/src/entities/routines/routine.d.ts +341 -0
  422. package/dist/src/entities/routines/suggestion.d.ts +38 -0
  423. package/dist/src/entities/saved-views/namespace.d.ts +58 -0
  424. package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
  425. package/dist/src/entities/search/exclusions.d.ts +6 -0
  426. package/dist/src/entities/search/namespace.d.ts +71 -0
  427. package/dist/src/entities/search/options.d.ts +30 -0
  428. package/dist/src/entities/search/types.d.ts +90 -0
  429. package/dist/src/entities/sharing/access.d.ts +120 -0
  430. package/dist/src/entities/sharing/permissions.d.ts +13 -0
  431. package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
  432. package/dist/src/entities/suggestions/namespace.d.ts +118 -0
  433. package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
  434. package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
  435. package/dist/src/entities/tasks/namespace.d.ts +77 -0
  436. package/dist/src/entities/tasks/task.d.ts +99 -0
  437. package/dist/src/entities/teams/invite.d.ts +33 -0
  438. package/dist/src/entities/teams/namespace.d.ts +23 -0
  439. package/dist/src/entities/teams/team.d.ts +129 -0
  440. package/dist/src/entities/ui/app-link.d.ts +24 -0
  441. package/dist/src/entities/ui/namespace.d.ts +75 -0
  442. package/dist/src/entities/unfurls/namespace.d.ts +24 -0
  443. package/dist/src/entities/users/namespace.d.ts +41 -0
  444. package/dist/src/entities/users/profile-picture.d.ts +29 -0
  445. package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
  446. package/dist/src/entities/users/user.d.ts +102 -0
  447. package/dist/src/entities/web/namespace.d.ts +67 -0
  448. package/dist/src/entities/web/namespace.test.d.ts +1 -0
  449. package/dist/src/entities/webhooks/namespace.d.ts +38 -0
  450. package/dist/src/entities/webhooks/webhook.d.ts +130 -0
  451. package/dist/src/entities/whatsapp/account.d.ts +24 -0
  452. package/dist/src/entities/whatsapp/chat.d.ts +62 -0
  453. package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
  454. package/dist/src/entities/workspace/items.d.ts +14 -0
  455. package/dist/src/entities/workspace/namespace.d.ts +96 -0
  456. package/dist/src/entities/workspace/query.d.ts +39 -0
  457. package/dist/src/entities/workspace/query.test.d.ts +1 -0
  458. package/dist/src/entities/workspace/types.d.ts +99 -0
  459. package/dist/src/events/hydrate/agentSession.d.ts +192 -0
  460. package/dist/src/events/hydrate/call.d.ts +101 -0
  461. package/dist/src/events/hydrate/channel.d.ts +55 -0
  462. package/dist/src/events/hydrate/document.d.ts +59 -0
  463. package/dist/src/events/hydrate/message.d.ts +70 -0
  464. package/dist/src/events/hydrate/user.d.ts +14 -0
  465. package/dist/src/events/receiver.d.ts +91 -0
  466. package/dist/src/events/types.d.ts +44 -0
  467. package/dist/src/events/verify.d.ts +13 -0
  468. package/dist/src/local-portmap.d.ts +8 -0
  469. package/dist/src/mentions.d.ts +42 -0
  470. package/dist/src/raw.d.ts +12 -0
  471. package/dist/src/rox.d.ts +268 -0
  472. package/dist/src/rox.js +23231 -0
  473. package/dist/src/utils/activity.d.ts +34 -0
  474. package/dist/src/utils/activity.test.d.ts +1 -0
  475. package/dist/src/utils/client.d.ts +62 -0
  476. package/dist/src/utils/concurrency.d.ts +5 -0
  477. package/dist/src/utils/index.d.ts +5 -0
  478. package/dist/src/utils/lazy.d.ts +37 -0
  479. package/dist/src/utils/options.d.ts +7 -0
  480. package/dist/src/utils/pagination.d.ts +28 -0
  481. package/dist/src/utils/unwrap.d.ts +48 -0
  482. package/dist/src/utils/verbs.d.ts +3 -0
  483. package/package.json +82 -4
@@ -0,0 +1,2084 @@
1
+ export type ClientOptions = {
2
+ baseUrl: `${string}://${string}` | (string & {});
3
+ };
4
+ /**
5
+ * Whose account an agent signs in to: the Postgres `agent_provider` enum of
6
+ * `provider_accounts.provider` and `harness_account_logins.provider`. New
7
+ * providers add a value there.
8
+ */
9
+ export type AgentProvider = 'claude';
10
+ /**
11
+ * Someone named the recipient in a prompt to an agent session.
12
+ */
13
+ export type AgentSessionMentionedMetadata = AgentSessionNotificationRef & {
14
+ /**
15
+ * The action carrying the prompt.
16
+ */
17
+ actionId: string;
18
+ /**
19
+ * Who wrote the prompt, absent when a bot acted on nobody's behalf.
20
+ */
21
+ mentionedBy?: string | null;
22
+ };
23
+ /**
24
+ * Flattened into each agent-session kind so the wire keeps these keys at the
25
+ * top level of the metadata, the way [`CommonChannelMetadata`] does.
26
+ */
27
+ export type AgentSessionNotificationRef = {
28
+ /**
29
+ * The magic-chip message for the turn in question, when one was posted.
30
+ */
31
+ announcementMessageId?: string | null;
32
+ /**
33
+ * The bot the session runs for. A string on the wire: system bots have
34
+ * fixed ids like `00000000-0000-0000-0000-00000000a2a2`, which are not
35
+ * RFC 4122 uuids and fail a `format: uuid` check on the client.
36
+ */
37
+ botId: string;
38
+ /**
39
+ * The bot's display name; agent notifications have no user sender, so
40
+ * this is who they read as being from.
41
+ */
42
+ botName: string;
43
+ /**
44
+ * The channel the session was opened from, when it was opened from a
45
+ * channel thread.
46
+ */
47
+ channelId?: string | null;
48
+ parent?: null | AgentSessionOriginParent;
49
+ /**
50
+ * The session; what a click opens.
51
+ */
52
+ sessionId: string;
53
+ /**
54
+ * The session's name at the time of the event.
55
+ */
56
+ sessionName: string;
57
+ /**
58
+ * The thread the session was opened from, when it was.
59
+ */
60
+ threadId?: string | null;
61
+ };
62
+ /**
63
+ * The session an agent-session notification is about, and where its magic
64
+ * chip lives when it was opened from a thread.
65
+ *
66
+ * The conversation an agent session was opened from: a channel, document,
67
+ * or initiative. Spelled like the message API's parent for client routing.
68
+ */
69
+ export type AgentSessionOriginParent = {
70
+ /**
71
+ * The parent entity id.
72
+ */
73
+ id: string;
74
+ /**
75
+ * `channel`, `document`, or `initiative`.
76
+ */
77
+ type: string;
78
+ };
79
+ /**
80
+ * An agent finished a turn with nothing queued behind it.
81
+ */
82
+ export type AgentSessionSettledMetadata = AgentSessionNotificationRef & {
83
+ /**
84
+ * Who prompted the turn, absent when a bot acted on nobody's behalf.
85
+ */
86
+ actor?: string | null;
87
+ /**
88
+ * The agent's last prose in the turn, whole; `None` when it wrote none.
89
+ */
90
+ excerpt?: string | null;
91
+ /**
92
+ * The ACP stop reason, or `error`.
93
+ */
94
+ stopReason: string;
95
+ /**
96
+ * The turn that ended.
97
+ */
98
+ turn: number;
99
+ };
100
+ /**
101
+ * An agent is blocked on a question only the session's owner can answer.
102
+ */
103
+ export type AgentSessionWaitingForInputMetadata = AgentSessionNotificationRef & {
104
+ /**
105
+ * The question, as the agent phrased it.
106
+ */
107
+ question: string;
108
+ /**
109
+ * The turn asking.
110
+ */
111
+ turn: number;
112
+ };
113
+ /**
114
+ * The account a team's Rox computer signed an agent in to is about to
115
+ * stop working, or has. Sent to whoever signed it in and to the team's
116
+ * admins and owner, who can sign it in again from Settings → Machines.
117
+ */
118
+ export type AgentSignInExpiryMetadata = {
119
+ /**
120
+ * The agent whose sign-in is running out.
121
+ */
122
+ agent: AgentProvider;
123
+ /**
124
+ * The computer's name when the notice was sent.
125
+ */
126
+ computerName: string;
127
+ /**
128
+ * When the sign-in expires or expired; absent when the agent rejected it.
129
+ */
130
+ expiresAt?: string | null;
131
+ /**
132
+ * The computer's harness, whose runtime row holds the sign-in.
133
+ */
134
+ harnessId: string;
135
+ /**
136
+ * How close the sign-in is to no longer working.
137
+ */
138
+ stage: AgentSignInExpiryStage;
139
+ };
140
+ /**
141
+ * How close a computer's agent sign-in is to no longer working.
142
+ */
143
+ export type AgentSignInExpiryStage = 'expires_soon' | 'expires_today' | 'expired';
144
+ export type AiResponseMetadata = {
145
+ messageId: string;
146
+ summary: string;
147
+ };
148
+ export type ApiUserNotification = Entity & {
149
+ /**
150
+ * When the notification was created.
151
+ */
152
+ created_at: string;
153
+ /**
154
+ * When the notification was deleted.
155
+ */
156
+ deleted_at?: string | null;
157
+ /**
158
+ * The notification ID.
159
+ */
160
+ id: string;
161
+ /**
162
+ * The notification event type string (e.g. "channel_mention").
163
+ * TODO make this a new type
164
+ */
165
+ notification_event_type: string;
166
+ /**
167
+ * Deserialized notification metadata.
168
+ */
169
+ notification_metadata: NotifEvent;
170
+ /**
171
+ * The user who owns this notification.
172
+ */
173
+ owner_id: string;
174
+ /**
175
+ * The user who triggered the notification.
176
+ */
177
+ sender_id?: string | null;
178
+ /**
179
+ * Whether the notification has been sent.
180
+ */
181
+ sent: boolean;
182
+ /**
183
+ * The authoritative notification lifecycle state.
184
+ */
185
+ state: NotificationState;
186
+ /**
187
+ * When the notification was last updated.
188
+ */
189
+ updated_at: string;
190
+ /**
191
+ * When the notification was viewed/seen.
192
+ */
193
+ viewed_at?: string | null;
194
+ };
195
+ /**
196
+ * Request body for bulk-fetching notifications by event item IDs.
197
+ */
198
+ export type BulkGetByEventItemIdsRequest = {
199
+ /**
200
+ * The event item IDs to filter notifications by.
201
+ */
202
+ eventItemIds: Array<string>;
203
+ };
204
+ export type BulkItem = {
205
+ item_id: string;
206
+ item_type: EntityType;
207
+ };
208
+ export type BulkRemoveItemsRequest = {
209
+ items: Array<BulkItem>;
210
+ };
211
+ export type BulkSetItemsRequest = {
212
+ items: Array<BulkItem>;
213
+ /**
214
+ * A future resume time. Omit to mute indefinitely.
215
+ */
216
+ snoozed_until?: string | null;
217
+ };
218
+ /**
219
+ * A channel member who sees a calendar event only through a channel share
220
+ * asked the person who shared it to add them as a guest. Sent to the sharer,
221
+ * with the requester as sender.
222
+ */
223
+ export type CalendarEventJoinRequestMetadata = {
224
+ /**
225
+ * The shared calendar event entity the request is for.
226
+ */
227
+ eventId: string;
228
+ /**
229
+ * Stable request identity, answered from the event's details.
230
+ */
231
+ requestId: string;
232
+ /**
233
+ * Event title when the request was made.
234
+ */
235
+ title: string;
236
+ };
237
+ /**
238
+ * A calendar event alarm came due. Like [`ReminderMetadata`], these are
239
+ * self-notifications: `sender_id` must stay `None` or the only recipient is
240
+ * filtered out. Everything the alert renders rides in here so the
241
+ * dispatcher never has to resolve the event again at display time.
242
+ */
243
+ export type CalendarEventReminderMetadata = {
244
+ /**
245
+ * Instance end, for timed events.
246
+ */
247
+ endsAt?: string | null;
248
+ /**
249
+ * The calendar event entity the alarm belongs to.
250
+ */
251
+ eventId: string;
252
+ /**
253
+ * Minutes before the start the alarm was configured to fire.
254
+ */
255
+ minutesBefore: number;
256
+ /**
257
+ * Stable occurrence key of the instance that is starting.
258
+ */
259
+ occurrenceKey: string;
260
+ /**
261
+ * Instance start date, for all-day events.
262
+ */
263
+ startDate?: string | null;
264
+ /**
265
+ * Instance start, for timed events.
266
+ */
267
+ startsAt?: string | null;
268
+ /**
269
+ * IANA zone for rendering local clock times, when known.
270
+ */
271
+ timeZone?: string | null;
272
+ /**
273
+ * Event display title at dispatch time.
274
+ */
275
+ title: string;
276
+ };
277
+ /**
278
+ * Metadata for a notification that a call has started in a channel.
279
+ *
280
+ * Mirrors the producer-side `CallStartedNotification` in the `call` crate:
281
+ * both serialize the same wire shape (snake_case fields) under the same
282
+ * `call_started` [`Notification::TYPE_NAME`]. This type is the read-side
283
+ * model used by [`crate::NotifEvent`]; the producer keeps its own type
284
+ * because it additionally builds the incoming-call APNS/VoIP push.
285
+ *
286
+ * Rows persisted before the type name was normalized used the kebab-case
287
+ * `call-started`; the [`crate::NotifEvent::CallStarted`] variant carries a
288
+ * `#[serde(alias = "call-started")]` so those rows still deserialize.
289
+ */
290
+ export type CallStartedMetadata = {
291
+ /**
292
+ * The name of the channel the call started in, when available.
293
+ */
294
+ channel_name?: string | null;
295
+ /**
296
+ * Profile picture URL of the user who started the call, when available.
297
+ */
298
+ sender_profile_picture_url?: string | null;
299
+ };
300
+ /**
301
+ * A person asked to join a channel the recipient participates in.
302
+ */
303
+ export type ChannelAccessRequestedMetadata = CommonChannelMetadata & {
304
+ /**
305
+ * The attempt to join, which is also this notification's id.
306
+ */
307
+ requestId: string;
308
+ /**
309
+ * Optional requester profile picture URL.
310
+ */
311
+ senderProfilePictureUrl?: string | null;
312
+ };
313
+ /**
314
+ * Metadata for when a user is invited to a channel.
315
+ */
316
+ export type ChannelInviteMetadata = {
317
+ /**
318
+ * The name of the channel
319
+ */
320
+ channelName?: string;
321
+ /**
322
+ * The user who sent the invitation
323
+ */
324
+ invitedBy: string;
325
+ /**
326
+ * Whether this is a direct message rather than a channel invitation.
327
+ * Older notification payloads retain channel-invitation wording.
328
+ */
329
+ isDirectMessage?: boolean;
330
+ /**
331
+ * Message content to show in the invite email, when the invite was triggered by a message.
332
+ */
333
+ messageContent?: string | null;
334
+ /**
335
+ * The sender's profile picture URL, if available.
336
+ */
337
+ senderProfilePictureUrl?: string | null;
338
+ };
339
+ export type ChannelMentionMetadata = CommonChannelMetadata & {
340
+ /**
341
+ * The message content
342
+ */
343
+ messageContent: string;
344
+ /**
345
+ * The message you were mentioned in
346
+ */
347
+ messageId: string;
348
+ /**
349
+ * Display name for non-user senders such as bots
350
+ */
351
+ senderDisplayName?: string | null;
352
+ senderProfilePictureUrl?: string | null;
353
+ /**
354
+ * the id of the thread
355
+ */
356
+ threadId?: string | null;
357
+ };
358
+ /**
359
+ * Metadata for a reaction added to one of the recipient's channel messages.
360
+ */
361
+ export type ChannelMessageReactionMetadata = CommonChannelMetadata & {
362
+ /**
363
+ * The emoji added by the reactor.
364
+ */
365
+ emoji: string;
366
+ /**
367
+ * The reacted-to message content.
368
+ */
369
+ messageContent: string;
370
+ /**
371
+ * The reacted-to message id.
372
+ */
373
+ messageId: string;
374
+ /**
375
+ * Optional reactor profile picture URL.
376
+ */
377
+ senderProfilePictureUrl?: string | null;
378
+ /**
379
+ * The thread root id when the reacted-to message is a reply.
380
+ */
381
+ threadId?: string | null;
382
+ };
383
+ export type ChannelMessageSendMetadata = CommonChannelMetadata & {
384
+ /**
385
+ * The content of the message
386
+ */
387
+ messageContent?: string;
388
+ /**
389
+ * The message id
390
+ */
391
+ messageId: string;
392
+ /**
393
+ * The user who sent the message, when sent by a user
394
+ */
395
+ sender?: string | null;
396
+ /**
397
+ * Display name for non-user senders such as bots
398
+ */
399
+ senderDisplayName?: string | null;
400
+ senderProfilePictureUrl?: string | null;
401
+ };
402
+ export type ChannelReplyMetadata = CommonChannelMetadata & {
403
+ /**
404
+ * The message content
405
+ */
406
+ messageContent: string;
407
+ /**
408
+ * The id of the new message
409
+ */
410
+ messageId: string;
411
+ /**
412
+ * Display name for non-user senders such as bots
413
+ */
414
+ senderDisplayName?: string | null;
415
+ senderProfilePictureUrl?: string | null;
416
+ /**
417
+ * The id of the thread that has the reply
418
+ */
419
+ threadId: string;
420
+ /**
421
+ * The user who sent the root message of the thread
422
+ */
423
+ threadParentSenderId?: string | null;
424
+ /**
425
+ * The sender id of the reply, when sent by a user
426
+ */
427
+ userId?: string | null;
428
+ };
429
+ export type ChannelType = 'public' | 'private' | 'directMessage' | 'team';
430
+ /**
431
+ * Identity of a document comment or its thread. Comments written before the
432
+ * shared message store carry the legacy numeric ids; comments in the shared
433
+ * store carry the message and root UUIDs.
434
+ */
435
+ export type CommentRef = number | string;
436
+ /**
437
+ * Notification sent when someone comments on a document the user owns.
438
+ */
439
+ export type CommentedOnDocumentMetadata = {
440
+ /**
441
+ * the comment id
442
+ */
443
+ commentId: CommentRef;
444
+ /**
445
+ * The name of the document.
446
+ */
447
+ documentName: string;
448
+ /**
449
+ * The file type of the document.
450
+ */
451
+ fileType?: string | null;
452
+ /**
453
+ * The owner of the document.
454
+ */
455
+ owner: string;
456
+ /**
457
+ * Public bot name when the author is an agent rather than a Rox user.
458
+ */
459
+ senderDisplayName?: string | null;
460
+ senderProfilePictureUrl?: string | null;
461
+ subType?: null | NotificationDocumentSubType;
462
+ /**
463
+ * the text of the comment
464
+ */
465
+ text: string;
466
+ /**
467
+ * the thread id
468
+ */
469
+ threadId: CommentRef;
470
+ };
471
+ /**
472
+ * Common metadata for notifications on channels
473
+ */
474
+ export type CommonChannelMetadata = {
475
+ channelName?: string;
476
+ channelType: ChannelType;
477
+ };
478
+ /**
479
+ * The agent teammate a computer was bought for, so its inviter hears about
480
+ * the agent rather than the machine.
481
+ */
482
+ export type ComputerSetupAgent = {
483
+ /**
484
+ * The agent's name.
485
+ */
486
+ name: string;
487
+ /**
488
+ * The agent's Rox user id, to open a DM with it.
489
+ */
490
+ userId: string;
491
+ };
492
+ /**
493
+ * A team's Rox computer finished first-time setup, or could not be set
494
+ * up. Sent to its buyer, who continues (or retries) from the setup flow.
495
+ */
496
+ export type ComputerSetupMetadata = {
497
+ agent?: null | ComputerSetupAgent;
498
+ /**
499
+ * The computer that was set up.
500
+ */
501
+ computerId: string;
502
+ /**
503
+ * The computer's name when the notice was sent.
504
+ */
505
+ computerName: string;
506
+ /**
507
+ * The computer's harness, once roxd has connected.
508
+ */
509
+ harnessId?: string | null;
510
+ /**
511
+ * Ready, or why setup failed.
512
+ */
513
+ outcome: ComputerSetupOutcome;
514
+ };
515
+ /**
516
+ * How a computer's first setup ended.
517
+ */
518
+ export type ComputerSetupOutcome = {
519
+ kind: 'ready';
520
+ } | {
521
+ /**
522
+ * Why, in the words the computer's status shows.
523
+ */
524
+ failureReason: string;
525
+ kind: 'failed';
526
+ };
527
+ /**
528
+ * Concrete schema type for [`RealtimeNotif`] with `serde_json::Value` metadata.
529
+ *
530
+ * Used for OpenAPI schema generation — serializes identically to
531
+ * `RealtimeNotif<serde_json::Value>`.
532
+ */
533
+ export type ConnGatewayNotificationPayload = RealtimeNotifTaggedContentValue;
534
+ export type CreateNotification = Entity & {
535
+ /**
536
+ * Custom metadata that may be needed for the notification
537
+ */
538
+ metadata?: unknown;
539
+ /**
540
+ * The type of notification
541
+ */
542
+ notification_event_type: string;
543
+ /**
544
+ * The service that created the notification
545
+ */
546
+ service_sender: string;
547
+ };
548
+ /**
549
+ * CRM discussion metadata. The notification entity identifies the company or
550
+ * contact; message and thread UUIDs select the discussion inside it.
551
+ */
552
+ export type CrmDiscussionMetadata = {
553
+ /**
554
+ * Canonical shared message UUID.
555
+ */
556
+ messageId: string;
557
+ /**
558
+ * Semantic reason selected by the message delivery domain.
559
+ */
560
+ reason: CrmDiscussionReason;
561
+ /**
562
+ * Company or contact display name.
563
+ */
564
+ recordName: string;
565
+ /**
566
+ * Public display name for a bot author.
567
+ */
568
+ senderDisplayName?: string | null;
569
+ /**
570
+ * Optional avatar for push notification attachments.
571
+ */
572
+ senderProfilePictureUrl?: string | null;
573
+ /**
574
+ * Posted Markdown content.
575
+ */
576
+ text: string;
577
+ /**
578
+ * Canonical discussion root UUID.
579
+ */
580
+ threadId: string;
581
+ };
582
+ /**
583
+ * Why a CRM discussion notification was delivered.
584
+ */
585
+ export type CrmDiscussionReason = 'mention' | 'reply' | 'owner';
586
+ /**
587
+ * Request to register or unregister a device for push notifications.
588
+ */
589
+ export type DeviceRequest = {
590
+ /**
591
+ * The device platform type (iOS or Android).
592
+ */
593
+ deviceType: DeviceType;
594
+ /**
595
+ * Whether this Android binary supports native Telecom incoming calls.
596
+ */
597
+ nativeCallCapable?: boolean;
598
+ /**
599
+ * The device push notification token.
600
+ */
601
+ token: string;
602
+ };
603
+ export type DeviceType = 'ios' | 'android' | 'iosvoip';
604
+ /**
605
+ * Someone mentioned a document in a channel
606
+ */
607
+ export type DocumentMentionMetadata = ChannelMentionMetadata & {
608
+ /**
609
+ * The name of the document
610
+ */
611
+ documentName: string;
612
+ /**
613
+ * The file type of the document
614
+ */
615
+ fileType?: string | null;
616
+ /**
617
+ * The owner of the document
618
+ */
619
+ owner: string;
620
+ subType?: null | NotificationDocumentSubType;
621
+ };
622
+ /**
623
+ * Empty response is required due to custom fetch forcing `response.json()`
624
+ */
625
+ export type EmptyResponse = {
626
+ [key: string]: unknown;
627
+ };
628
+ /**
629
+ * The Entity describes the minimum amount of information required to describe a unique thing in Macro
630
+ * This contains the type of the entity [EntityType] and the string id of that entity
631
+ */
632
+ export type Entity = {
633
+ /**
634
+ * The id of that entity
635
+ */
636
+ entity_id: string;
637
+ /**
638
+ * The type of entity we are describing
639
+ */
640
+ entity_type: EntityType;
641
+ };
642
+ /**
643
+ * A person granted you access to a shared entity.
644
+ */
645
+ export type EntityAccessGrantedMetadata = {
646
+ /**
647
+ * Requested or granted permission.
648
+ */
649
+ accessLevel: RequestedAccessLevel;
650
+ /**
651
+ * Shared item's name.
652
+ */
653
+ entityName: string;
654
+ /**
655
+ * Document file type for routing.
656
+ */
657
+ fileType?: string | null;
658
+ /**
659
+ * Stable request identity.
660
+ */
661
+ requestId: string;
662
+ /**
663
+ * Revision that generated this notification.
664
+ */
665
+ revision: number;
666
+ };
667
+ /**
668
+ * A person requested access to a shared entity.
669
+ */
670
+ export type EntityAccessRequestedMetadata = {
671
+ /**
672
+ * Requested or granted permission.
673
+ */
674
+ accessLevel: RequestedAccessLevel;
675
+ /**
676
+ * Shared item's name.
677
+ */
678
+ entityName: string;
679
+ /**
680
+ * Document file type for routing.
681
+ */
682
+ fileType?: string | null;
683
+ /**
684
+ * Stable request identity.
685
+ */
686
+ requestId: string;
687
+ /**
688
+ * Revision that generated this notification.
689
+ */
690
+ revision: number;
691
+ };
692
+ /**
693
+ * The type of an entity in Macro
694
+ */
695
+ export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'harness' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
696
+ /**
697
+ * A plain old json error response for use with axum.
698
+ * yup, thats it.
699
+ */
700
+ export type ErrorResponse = {
701
+ /**
702
+ * Message to explain failure
703
+ */
704
+ message: string;
705
+ };
706
+ /**
707
+ * A live message in an independently shared external chat.
708
+ */
709
+ export type ExternalChatMessageMetadata = {
710
+ /**
711
+ * The chat's name.
712
+ */
713
+ chatName: string;
714
+ /**
715
+ * Stable message id; retries use it as their notification id.
716
+ */
717
+ messageId: string;
718
+ /**
719
+ * The messaging service the chat lives in.
720
+ */
721
+ provider: ExternalChatProvider;
722
+ };
723
+ /**
724
+ * The messaging service an external chat lives in.
725
+ */
726
+ export type ExternalChatProvider = 'whatsapp';
727
+ /**
728
+ * The strongly typed response for listing user notifications.
729
+ */
730
+ export type GetAllUserNotificationsResponse = {
731
+ /**
732
+ * The list of items returned.
733
+ */
734
+ items: Array<ApiUserNotification>;
735
+ /**
736
+ * The next page cursor if it exists.
737
+ */
738
+ next_cursor?: string | null;
739
+ };
740
+ /**
741
+ * Response for listing disabled notification types.
742
+ */
743
+ export type GetNotificationTypePreferencesResponse = {
744
+ /**
745
+ * The notification types that the user has disabled.
746
+ */
747
+ disabled_types: Array<string>;
748
+ };
749
+ /**
750
+ * Metadata for a notification that a GitHub pull request check run completed.
751
+ */
752
+ export type GithubPrCheckRun = GithubPrNotificationCommon & {
753
+ /**
754
+ * The display name GitHub reported for the check run.
755
+ */
756
+ checkName: string;
757
+ /**
758
+ * The GitHub numeric id of the check run.
759
+ */
760
+ checkRunGithubId: number;
761
+ /**
762
+ * The raw GitHub check run status.
763
+ */
764
+ checkStatus: string;
765
+ /**
766
+ * The public GitHub URL for the check run.
767
+ */
768
+ checkUrl: string;
769
+ /**
770
+ * When GitHub marked the check run as complete.
771
+ */
772
+ completedAt: string;
773
+ /**
774
+ * The raw GitHub check run conclusion.
775
+ */
776
+ conclusion: string;
777
+ /**
778
+ * The normalized notification state for this check run.
779
+ */
780
+ state: GithubPrCheckRunState;
781
+ };
782
+ /**
783
+ * The normalized result state for a GitHub pull request check-run notification.
784
+ */
785
+ export type GithubPrCheckRunState = 'completed' | 'failed';
786
+ /**
787
+ * Metadata for a notification that a GitHub pull request was commented on.
788
+ */
789
+ export type GithubPrComment = GithubPrNotificationCommon & {
790
+ /**
791
+ * The GitHub numeric id of the comment, when available.
792
+ */
793
+ commentGithubId?: number | null;
794
+ /**
795
+ * The kind of comment that was posted.
796
+ */
797
+ commentKind: GithubPrCommentKind;
798
+ /**
799
+ * A truncated excerpt of the comment body.
800
+ */
801
+ commentSnippet: string;
802
+ /**
803
+ * The public GitHub URL for the comment, when available.
804
+ */
805
+ commentUrl?: string | null;
806
+ };
807
+ /**
808
+ * The kind of GitHub comment that triggered a [`GithubPrComment`] notification.
809
+ */
810
+ export type GithubPrCommentKind = 'issue' | 'review_comment';
811
+ /**
812
+ * The GitHub pull request webhook action that triggered the notification.
813
+ */
814
+ export type GithubPrEventAction = 'opened' | 'reopened' | 'closed';
815
+ /**
816
+ * The normalized lifecycle status for a GitHub pull request notification.
817
+ */
818
+ export type GithubPrEventStatus = 'open' | 'closed' | 'merged';
819
+ /**
820
+ * Metadata for a notification that the user was mentioned on a GitHub pull request.
821
+ */
822
+ export type GithubPrMention = GithubPrNotificationCommon & {
823
+ /**
824
+ * The GitHub numeric id of the comment or review containing the mention, when available.
825
+ */
826
+ commentGithubId?: number | null;
827
+ /**
828
+ * The public GitHub URL for the text containing the mention, when available.
829
+ */
830
+ commentUrl?: string | null;
831
+ /**
832
+ * Where the mention appeared.
833
+ */
834
+ location: GithubPrMentionLocation;
835
+ /**
836
+ * A truncated excerpt of the text containing the mention.
837
+ */
838
+ textSnippet: string;
839
+ };
840
+ /**
841
+ * Where in a GitHub pull request the user was mentioned.
842
+ */
843
+ export type GithubPrMentionLocation = 'pr_body' | 'comment' | 'review' | 'review_comment';
844
+ /**
845
+ * Fields shared by every GitHub pull request notification type.
846
+ *
847
+ * Embedded with `#[serde(flatten)]` so the wire shape keeps these keys at the
848
+ * top level of the metadata object.
849
+ */
850
+ export type GithubPrNotificationCommon = {
851
+ /**
852
+ * A compact label suitable for display in the UI.
853
+ */
854
+ displayName: string;
855
+ /**
856
+ * The source-specific internal foreign entity row id for this pull request.
857
+ */
858
+ foreignEntityId: string;
859
+ /**
860
+ * The external GitHub key, in `owner/repo/pull/number` format.
861
+ */
862
+ githubKey: string;
863
+ /**
864
+ * The GitHub pull request number.
865
+ */
866
+ number: number;
867
+ /**
868
+ * The GitHub repository owner or organization.
869
+ */
870
+ owner: string;
871
+ /**
872
+ * The GitHub repository name.
873
+ */
874
+ repo: string;
875
+ /**
876
+ * The GitHub avatar URL for the sender, when available.
877
+ */
878
+ senderGithubAvatarUrl?: string | null;
879
+ /**
880
+ * The GitHub login for the sender, when available.
881
+ */
882
+ senderGithubLogin?: string | null;
883
+ /**
884
+ * The stable GitHub numeric user id for the sender, serialized as a string.
885
+ */
886
+ senderGithubUserId?: string | null;
887
+ /**
888
+ * The GitHub pull request title. Falls back to `display_name` when GitHub has no title.
889
+ */
890
+ title: string;
891
+ /**
892
+ * The public GitHub URL for the pull request.
893
+ */
894
+ url: string;
895
+ };
896
+ /**
897
+ * Metadata for a notification that a review was submitted on the user's GitHub pull request.
898
+ */
899
+ export type GithubPrReview = GithubPrNotificationCommon & {
900
+ /**
901
+ * The GitHub numeric id of the review, when available.
902
+ */
903
+ reviewGithubId?: number | null;
904
+ /**
905
+ * A truncated excerpt of the review body, when any was written.
906
+ */
907
+ reviewSnippet?: string | null;
908
+ /**
909
+ * The public GitHub URL for the review, when available.
910
+ */
911
+ reviewUrl?: string | null;
912
+ /**
913
+ * The review decision state.
914
+ */
915
+ state: GithubPrReviewState;
916
+ };
917
+ /**
918
+ * The state of a submitted GitHub pull request review.
919
+ */
920
+ export type GithubPrReviewState = 'approved' | 'changes_requested' | 'commented';
921
+ /**
922
+ * Metadata for a GitHub pull request lifecycle notification.
923
+ */
924
+ export type GithubPrStatusChanged = GithubPrNotificationCommon & {
925
+ /**
926
+ * The webhook action that triggered this notification.
927
+ */
928
+ action: GithubPrEventAction;
929
+ /**
930
+ * The pull request base branch, when available.
931
+ */
932
+ baseBranch?: string | null;
933
+ /**
934
+ * The pull request head branch, when available.
935
+ */
936
+ headBranch?: string | null;
937
+ /**
938
+ * When the pull request was merged, when available.
939
+ */
940
+ mergedAt?: string | null;
941
+ previousStatus?: null | GithubPrEventStatus;
942
+ /**
943
+ * The current normalized pull request status.
944
+ */
945
+ status: GithubPrEventStatus;
946
+ };
947
+ /**
948
+ * Metadata for a notification that the user's review was requested on a GitHub pull request.
949
+ */
950
+ export type GithubReviewRequested = GithubPrNotificationCommon & {
951
+ /**
952
+ * The GitHub login of the requested reviewer, when available.
953
+ */
954
+ requestedReviewerGithubLogin?: string | null;
955
+ /**
956
+ * The stable GitHub numeric user id of the requested reviewer, serialized as a string.
957
+ */
958
+ requestedReviewerGithubUserId?: string | null;
959
+ };
960
+ /**
961
+ * Metadata for a notification that a linked inbox's grant has died and the
962
+ * inbox must be reconnected. Fanned out to the inbox owner and every delegate,
963
+ * since any of them holding the Google grant can restore sync.
964
+ */
965
+ export type InboxReauthRequiredMetadata = {
966
+ /**
967
+ * The address of the inbox that needs to be reconnected.
968
+ */
969
+ emailAddress: string;
970
+ };
971
+ /**
972
+ * Project discussion metadata. The notification entity identifies the initiative;
973
+ * message and thread UUIDs select the discussion inside that project.
974
+ */
975
+ export type InitiativeDiscussionMetadata = {
976
+ /**
977
+ * Canonical shared message UUID.
978
+ */
979
+ messageId: string;
980
+ /**
981
+ * Authenticated project owner.
982
+ */
983
+ owner: string;
984
+ /**
985
+ * Name displayed in the project header.
986
+ */
987
+ projectName: string;
988
+ /**
989
+ * Semantic reason selected by the message delivery domain.
990
+ */
991
+ reason: InitiativeDiscussionReason;
992
+ /**
993
+ * Public display name for a bot author.
994
+ */
995
+ senderDisplayName?: string | null;
996
+ /**
997
+ * Optional avatar for push notification attachments.
998
+ */
999
+ senderProfilePictureUrl?: string | null;
1000
+ /**
1001
+ * Posted Markdown content.
1002
+ */
1003
+ text: string;
1004
+ /**
1005
+ * Canonical discussion root UUID.
1006
+ */
1007
+ threadId: string;
1008
+ };
1009
+ /**
1010
+ * Why a project discussion notification was delivered.
1011
+ */
1012
+ export type InitiativeDiscussionReason = 'mention' | 'reply' | 'assignee' | 'owner';
1013
+ /**
1014
+ * Metadata for when a user is invited to a team.
1015
+ */
1016
+ export type InviteToTeamMetadata = {
1017
+ /**
1018
+ * The user who sent the invitation
1019
+ */
1020
+ invitedBy: string;
1021
+ /**
1022
+ * What the invitee gets by joining, as the team stood when the invite was sent.
1023
+ */
1024
+ inviteePlan?: InviteePlan;
1025
+ /**
1026
+ * The inviter's display name, when they have set one. It is user-provided, so it is shown
1027
+ * on one line, capped, and escaped; the email falls back to the inviter's address.
1028
+ */
1029
+ inviterName?: string | null;
1030
+ /**
1031
+ * Whether the invite creates an agent account.
1032
+ */
1033
+ isAgent?: boolean;
1034
+ /**
1035
+ * Whether this email reminds the invitee of an invite they have not answered.
1036
+ */
1037
+ reminder?: boolean;
1038
+ /**
1039
+ * Role/permission level in the team
1040
+ */
1041
+ role?: string | null;
1042
+ /**
1043
+ * The sender's profile picture URL, if available.
1044
+ */
1045
+ senderProfilePictureUrl?: string | null;
1046
+ /**
1047
+ * The unique identifier of the team
1048
+ */
1049
+ teamId: string;
1050
+ /**
1051
+ * The unique identifier of the team invite
1052
+ */
1053
+ teamInviteId: string;
1054
+ /**
1055
+ * The name of the team being invited to
1056
+ */
1057
+ teamName: string;
1058
+ };
1059
+ /**
1060
+ * What a team invitee gets by joining.
1061
+ */
1062
+ export type InviteePlan = 'free' | 'premium';
1063
+ /**
1064
+ * Metadata for when a item is shared with a user
1065
+ */
1066
+ export type ItemSharedMetadata = {
1067
+ /**
1068
+ * The name/title of the shared item (optional)
1069
+ */
1070
+ itemId: string;
1071
+ /**
1072
+ * The name/title of the shared item
1073
+ */
1074
+ itemName?: string | null;
1075
+ /**
1076
+ * The type of item being shared
1077
+ */
1078
+ itemType: EntityType;
1079
+ /**
1080
+ * Permission level granted (read, write, admin, etc.)
1081
+ */
1082
+ permissionLevel?: string | null;
1083
+ sharedBy: string;
1084
+ /**
1085
+ * List of user IDs that the item is shared with
1086
+ */
1087
+ userIds: Array<string>;
1088
+ };
1089
+ export type RoxUserIdStr = string;
1090
+ /**
1091
+ * Notification sent when a user is mentioned in a document comment.
1092
+ */
1093
+ export type MentionedInDocumentCommentMetadata = {
1094
+ /**
1095
+ * the comment id
1096
+ */
1097
+ commentId: CommentRef;
1098
+ /**
1099
+ * The name of the document.
1100
+ */
1101
+ documentName: string;
1102
+ /**
1103
+ * The file type of the document.
1104
+ */
1105
+ fileType?: string | null;
1106
+ /**
1107
+ * The mention ID.
1108
+ */
1109
+ mentionId: string;
1110
+ /**
1111
+ * The owner of the document.
1112
+ */
1113
+ owner: string;
1114
+ /**
1115
+ * Public bot name when the author is an agent rather than a Rox user.
1116
+ */
1117
+ senderDisplayName?: string | null;
1118
+ senderProfilePictureUrl?: string | null;
1119
+ subType?: null | NotificationDocumentSubType;
1120
+ /**
1121
+ * the text of the comment
1122
+ */
1123
+ text: string;
1124
+ /**
1125
+ * the thread id
1126
+ */
1127
+ threadId: CommentRef;
1128
+ };
1129
+ export type NewEmailMetadata = {
1130
+ sender?: string | null;
1131
+ snippet: string;
1132
+ subject: string;
1133
+ threadId: string;
1134
+ toEmail: string;
1135
+ };
1136
+ /**
1137
+ * Mirrors [`model_notifications::NotificationEvent`] but uses `tag` / `content`
1138
+ * as the serde adjacently-tagged field names so it can be deserialized from the
1139
+ * shape produced by [`UserNotificationRow::into_tagged`] +
1140
+ * [`UserNotificationRow::into_json`].
1141
+ *
1142
+ * Only includes variants whose metadata types implement the `Notification` trait.
1143
+ */
1144
+ export type NotifEvent = {
1145
+ /**
1146
+ * Someone mentioned you in a channel.
1147
+ */
1148
+ content: ChannelMentionMetadata;
1149
+ tag: 'channel_mention';
1150
+ } | {
1151
+ /**
1152
+ * Someone mentioned a document in a channel.
1153
+ */
1154
+ content: DocumentMentionMetadata;
1155
+ tag: 'document_mention';
1156
+ } | {
1157
+ /**
1158
+ * User was mentioned in a comment in a document
1159
+ */
1160
+ content: MentionedInDocumentCommentMetadata;
1161
+ tag: 'mentioned_in_document_comment';
1162
+ } | {
1163
+ /**
1164
+ * Someone replied to a document comment thread the user participated in.
1165
+ */
1166
+ content: RepliedToDocumentCommentThreadMetadata;
1167
+ tag: 'replied_to_document_comment_thread';
1168
+ } | {
1169
+ /**
1170
+ * Someone commented on a document the user owns.
1171
+ */
1172
+ content: CommentedOnDocumentMetadata;
1173
+ tag: 'commented_on_document';
1174
+ } | {
1175
+ /**
1176
+ * Someone requested more access to a shared entity.
1177
+ */
1178
+ content: EntityAccessRequestedMetadata;
1179
+ tag: 'entity_access_requested';
1180
+ } | {
1181
+ /**
1182
+ * An owner granted requested access.
1183
+ */
1184
+ content: EntityAccessGrantedMetadata;
1185
+ tag: 'entity_access_granted';
1186
+ } | {
1187
+ /**
1188
+ * Someone commented, replied, or mentioned the recipient on a project.
1189
+ */
1190
+ content: InitiativeDiscussionMetadata;
1191
+ tag: 'initiative_discussion';
1192
+ } | {
1193
+ /**
1194
+ * Someone commented, replied, or mentioned the recipient on a CRM company or contact.
1195
+ */
1196
+ content: CrmDiscussionMetadata;
1197
+ tag: 'crm_discussion';
1198
+ } | {
1199
+ /**
1200
+ * The user was invited to a channel.
1201
+ */
1202
+ content: ChannelInviteMetadata;
1203
+ tag: 'channel_invite';
1204
+ } | {
1205
+ /**
1206
+ * A user sent a message in a channel.
1207
+ */
1208
+ content: ChannelMessageSendMetadata;
1209
+ tag: 'channel_message_send';
1210
+ } | {
1211
+ /**
1212
+ * Someone replied to a thread in a channel that the user is part of.
1213
+ */
1214
+ content: ChannelReplyMetadata;
1215
+ tag: 'channel_message_reply';
1216
+ } | {
1217
+ /**
1218
+ * A call has started in a channel the user is a member of.
1219
+ *
1220
+ * The `call-started` alias keeps rows persisted before the type name
1221
+ * was normalized to snake_case (`call_started`) deserializable.
1222
+ */
1223
+ content: CallStartedMetadata;
1224
+ tag: 'call_started';
1225
+ } | {
1226
+ /**
1227
+ * A new email has been sent to the user.
1228
+ */
1229
+ content: NewEmailMetadata;
1230
+ tag: 'new_email';
1231
+ } | {
1232
+ /**
1233
+ * A linked inbox's grant died and must be reconnected.
1234
+ */
1235
+ content: InboxReauthRequiredMetadata;
1236
+ tag: 'inbox_reauth_required';
1237
+ } | {
1238
+ /**
1239
+ * A user was invited to a team.
1240
+ */
1241
+ content: InviteToTeamMetadata;
1242
+ tag: 'invite_to_team';
1243
+ } | {
1244
+ /**
1245
+ * A user was assigned to a task.
1246
+ */
1247
+ content: TaskAssignedMetadata;
1248
+ tag: 'task_assigned';
1249
+ } | {
1250
+ /**
1251
+ * A reminder the user set for themselves came due.
1252
+ */
1253
+ content: ReminderMetadata;
1254
+ tag: 'reminder';
1255
+ } | {
1256
+ /**
1257
+ * A live message in a shared external chat.
1258
+ */
1259
+ content: ExternalChatMessageMetadata;
1260
+ tag: 'external_chat_message';
1261
+ } | {
1262
+ /**
1263
+ * A calendar event alarm came due.
1264
+ */
1265
+ content: CalendarEventReminderMetadata;
1266
+ tag: 'calendar_event_reminder';
1267
+ } | {
1268
+ /**
1269
+ * An AI assistant responded to a chat.
1270
+ */
1271
+ content: AiResponseMetadata;
1272
+ tag: 'ai_response';
1273
+ } | {
1274
+ /**
1275
+ * A GitHub pull request changed lifecycle state.
1276
+ *
1277
+ * The `github_pr_event` alias keeps rows and queue messages persisted
1278
+ * before the rename deserializable.
1279
+ */
1280
+ content: GithubPrStatusChanged;
1281
+ tag: 'github_pr_status_changed';
1282
+ } | {
1283
+ /**
1284
+ * A GitHub pull request check run completed.
1285
+ */
1286
+ content: GithubPrCheckRun;
1287
+ tag: 'github_pr_check_run';
1288
+ } | {
1289
+ /**
1290
+ * The user's review was requested on a GitHub pull request.
1291
+ */
1292
+ content: GithubReviewRequested;
1293
+ tag: 'github_review_requested';
1294
+ } | {
1295
+ /**
1296
+ * A GitHub pull request was commented on.
1297
+ */
1298
+ content: GithubPrComment;
1299
+ tag: 'github_pr_comment';
1300
+ } | {
1301
+ /**
1302
+ * The user was mentioned on a GitHub pull request.
1303
+ */
1304
+ content: GithubPrMention;
1305
+ tag: 'github_pr_mention';
1306
+ } | {
1307
+ /**
1308
+ * A review was submitted on the user's GitHub pull request.
1309
+ */
1310
+ content: GithubPrReview;
1311
+ tag: 'github_pr_review';
1312
+ } | {
1313
+ /**
1314
+ * An agent finished a turn with nothing queued behind it.
1315
+ */
1316
+ content: AgentSessionSettledMetadata;
1317
+ tag: 'agent_session_settled';
1318
+ } | {
1319
+ /**
1320
+ * An agent is blocked on a question for the session's owner.
1321
+ */
1322
+ content: AgentSessionWaitingForInputMetadata;
1323
+ tag: 'agent_session_waiting_for_input';
1324
+ } | {
1325
+ /**
1326
+ * The user was named in a prompt to an agent session.
1327
+ */
1328
+ content: AgentSessionMentionedMetadata;
1329
+ tag: 'agent_session_mentioned';
1330
+ } | {
1331
+ /**
1332
+ * Someone reacted to one of the user's channel messages.
1333
+ */
1334
+ content: ChannelMessageReactionMetadata;
1335
+ tag: 'channel_message_reaction';
1336
+ } | {
1337
+ /**
1338
+ * A channel member asked to be added as a guest of an event the
1339
+ * user shared with the channel.
1340
+ */
1341
+ content: CalendarEventJoinRequestMetadata;
1342
+ tag: 'calendar_event_join_request';
1343
+ } | {
1344
+ /**
1345
+ * Someone asked to join a channel the user participates in.
1346
+ */
1347
+ content: ChannelAccessRequestedMetadata;
1348
+ tag: 'channel_access_requested';
1349
+ } | {
1350
+ /**
1351
+ * An agent asked for access to a vault item the user manages.
1352
+ */
1353
+ content: PasswordAccessRequestedMetadata;
1354
+ tag: 'password_access_requested';
1355
+ } | {
1356
+ /**
1357
+ * One of the user's routines finished a run, successfully or not.
1358
+ */
1359
+ content: RoutineRunFinishedMetadata;
1360
+ tag: 'routine_run_finished';
1361
+ } | {
1362
+ /**
1363
+ * An agent's sign-in on one of the team's Rox computers is about
1364
+ * to expire, expired, or was rejected.
1365
+ */
1366
+ content: AgentSignInExpiryMetadata;
1367
+ tag: 'agent_sign_in_expiry';
1368
+ } | {
1369
+ /**
1370
+ * A Rox computer the user bought finished first-time setup, or
1371
+ * could not be set up.
1372
+ */
1373
+ content: ComputerSetupMetadata;
1374
+ tag: 'computer_setup';
1375
+ } | {
1376
+ /**
1377
+ * A runtime's owner removed the user's access to it, and agents of
1378
+ * theirs living there stopped.
1379
+ */
1380
+ content: RuntimeAccessRemovedMetadata;
1381
+ tag: 'runtime_access_removed';
1382
+ };
1383
+ /**
1384
+ * the notification ids that we are bulk updating
1385
+ */
1386
+ export type NotificationBulkRequest = {
1387
+ /**
1388
+ * The ids of the notifications to handle
1389
+ */
1390
+ notificationIds: Array<string>;
1391
+ };
1392
+ /**
1393
+ * The sub type of a document in a notification.
1394
+ * Serializes as `{ "type": "task" }` matching the storage service pattern.
1395
+ */
1396
+ export type NotificationDocumentSubType = {
1397
+ type: 'task';
1398
+ } | {
1399
+ type: 'snippet';
1400
+ } | {
1401
+ type: 'skill';
1402
+ } | {
1403
+ type: 'initiative_description';
1404
+ };
1405
+ export type NotificationServiceApiVersion = 'v1';
1406
+ /**
1407
+ * The mutually exclusive lifecycle states of a user's notification.
1408
+ */
1409
+ export type NotificationState = 'unseen' | 'seen' | 'done';
1410
+ /**
1411
+ * newtype wrapper for the the typename of a Notification
1412
+ */
1413
+ export type NotificationTypeName = string;
1414
+ /**
1415
+ * An agent asked for access to a team vault item. Sent to the item's current
1416
+ * human creator and the team's current administrators, with the agent as
1417
+ * sender. Carries the item name and opaque ids only, never values.
1418
+ */
1419
+ export type PasswordAccessRequestedMetadata = {
1420
+ /**
1421
+ * Requested item.
1422
+ */
1423
+ itemId: string;
1424
+ /**
1425
+ * Item display name when the request was made.
1426
+ */
1427
+ itemName: string;
1428
+ /**
1429
+ * Request under review.
1430
+ */
1431
+ requestId: string;
1432
+ /**
1433
+ * Team owning the item.
1434
+ */
1435
+ teamId: string;
1436
+ };
1437
+ /**
1438
+ * the value we send as the payload in the ios notification
1439
+ * This data is accessible to the client
1440
+ */
1441
+ export type PushNotificationData = {
1442
+ navigation?: null | PushNotificationNavigation;
1443
+ /**
1444
+ * The id of the notification record (UserNotification.id)
1445
+ */
1446
+ notificationId: string;
1447
+ /**
1448
+ * Account that owns the receiving device, set during per-recipient delivery.
1449
+ */
1450
+ recipientId?: string | null;
1451
+ /**
1452
+ * The sender's profile picture URL, used by the Notification Service Extension
1453
+ * to download and attach as a rich notification image.
1454
+ */
1455
+ senderProfilePictureUrl?: string | null;
1456
+ };
1457
+ /**
1458
+ * Open a channel at a specific message.
1459
+ */
1460
+ export type PushNotificationNavigation = {
1461
+ /**
1462
+ * Channel containing the message.
1463
+ */
1464
+ channelId: string;
1465
+ /**
1466
+ * Message to highlight.
1467
+ */
1468
+ messageId: string;
1469
+ /**
1470
+ * Root of the message's thread; null identifies a top-level message.
1471
+ */
1472
+ threadId: string | null;
1473
+ type: 'channel';
1474
+ };
1475
+ /**
1476
+ * the value of the inner payload inside [ConnGatewayNotification]
1477
+ */
1478
+ export type RealtimeNotifTaggedContentValue = Entity & {
1479
+ /**
1480
+ * When the notification was created.
1481
+ */
1482
+ created_at: string;
1483
+ /**
1484
+ * When the notification was deleted.
1485
+ */
1486
+ deleted_at?: string | null;
1487
+ /**
1488
+ * The notification event type string (e.g. "channel_mention").
1489
+ * TODO make this a new type
1490
+ */
1491
+ notification_event_type: string;
1492
+ /**
1493
+ * The notification ID.
1494
+ */
1495
+ notification_id: string;
1496
+ /**
1497
+ * A notification metadata value tagged with the notification event type.
1498
+ */
1499
+ notification_metadata: {
1500
+ content: unknown;
1501
+ tag: NotificationTypeName;
1502
+ };
1503
+ sender_id?: null | RoxUserIdStr;
1504
+ /**
1505
+ * Whether the notification has been sent.
1506
+ */
1507
+ sent: boolean;
1508
+ /**
1509
+ * The authoritative lifecycle state, independent of viewing timestamps.
1510
+ */
1511
+ state: NotificationState;
1512
+ /**
1513
+ * When the notification was last updated.
1514
+ */
1515
+ updated_at: string;
1516
+ /**
1517
+ * When the notification was viewed/seen.
1518
+ */
1519
+ viewed_at?: string | null;
1520
+ };
1521
+ /**
1522
+ * Metadata for a reminder the user set for themselves coming due.
1523
+ *
1524
+ * There is no sender: a reminder is self-set, so the dispatcher sends it with
1525
+ * `sender_id: None` (a recipient who is also the sender is filtered out of
1526
+ * their own notification). Every formatter here must therefore work without
1527
+ * one.
1528
+ *
1529
+ * The associated entity, when there is one, lives on the notification row
1530
+ * rather than in here, and clients resolve its name from that — so the
1531
+ * dispatcher does not have to look up a name across five entity types.
1532
+ */
1533
+ export type ReminderMetadata = {
1534
+ /**
1535
+ * What the user asked to be reminded about.
1536
+ */
1537
+ description: string;
1538
+ /**
1539
+ * The reminder that fired.
1540
+ */
1541
+ reminderId: string;
1542
+ /**
1543
+ * Which firing this is — the occurrence the reminder came due for.
1544
+ *
1545
+ * What distinguishes two firings of the same recurring reminder, which are
1546
+ * otherwise identical: same id, same description. The collapse key is
1547
+ * built from it, so without it Tuesday's alert would replace Monday's
1548
+ * unread one on the lock screen.
1549
+ *
1550
+ * Optional because notifications written before recurring dispatch existed
1551
+ * have no such field, and they still have to read back.
1552
+ */
1553
+ scheduledFor?: string | null;
1554
+ };
1555
+ /**
1556
+ * Notification sent when someone replies to a document comment thread.
1557
+ */
1558
+ export type RepliedToDocumentCommentThreadMetadata = {
1559
+ /**
1560
+ * the comment id
1561
+ */
1562
+ commentId: CommentRef;
1563
+ /**
1564
+ * The name of the document.
1565
+ */
1566
+ documentName: string;
1567
+ /**
1568
+ * The file type of the document.
1569
+ */
1570
+ fileType?: string | null;
1571
+ /**
1572
+ * The owner of the document.
1573
+ */
1574
+ owner: string;
1575
+ /**
1576
+ * Public bot name when the author is an agent rather than a Rox user.
1577
+ */
1578
+ senderDisplayName?: string | null;
1579
+ senderProfilePictureUrl?: string | null;
1580
+ subType?: null | NotificationDocumentSubType;
1581
+ /**
1582
+ * the text of the comment
1583
+ */
1584
+ text: string;
1585
+ /**
1586
+ * the thread id
1587
+ */
1588
+ threadId: CommentRef;
1589
+ };
1590
+ /**
1591
+ * Permission level used by an access request, excluding ownership.
1592
+ */
1593
+ export type RequestedAccessLevel = 'view' | 'comment' | 'edit';
1594
+ /**
1595
+ * One of the recipient's routines finished a run. Every run notifies,
1596
+ * whether it succeeded or failed.
1597
+ */
1598
+ export type RoutineRunFinishedMetadata = {
1599
+ /**
1600
+ * How the run ended.
1601
+ */
1602
+ outcome: RoutineRunOutcome;
1603
+ /**
1604
+ * The routine that ran.
1605
+ */
1606
+ routineId: string;
1607
+ /**
1608
+ * The routine's name when it ran.
1609
+ */
1610
+ routineName: string;
1611
+ };
1612
+ /**
1613
+ * How a routine run ended, as its notification reports it.
1614
+ */
1615
+ export type RoutineRunOutcome = 'succeeded' | 'failed';
1616
+ /**
1617
+ * A runtime's owner removed the recipient's access to it, or lowered it to
1618
+ * Read, and agents the recipient keeps living there stopped.
1619
+ */
1620
+ export type RuntimeAccessRemovedMetadata = {
1621
+ /**
1622
+ * The recipient's agents living on the runtime, which stopped. Never
1623
+ * empty: without one there is nothing to tell them.
1624
+ */
1625
+ agents: Array<StoppedAgent>;
1626
+ /**
1627
+ * The runtime's name.
1628
+ */
1629
+ runtimeName: string;
1630
+ };
1631
+ /**
1632
+ * One of the recipient's agents that stopped with their runtime access.
1633
+ */
1634
+ export type StoppedAgent = {
1635
+ /**
1636
+ * The agent's bot id.
1637
+ */
1638
+ botId: string;
1639
+ /**
1640
+ * The agent's display name.
1641
+ */
1642
+ name: string;
1643
+ };
1644
+ /**
1645
+ * Metadata for when a user is assigned to a task
1646
+ */
1647
+ export type TaskAssignedMetadata = {
1648
+ /**
1649
+ * The user who assigned the task
1650
+ */
1651
+ assignedBy: string;
1652
+ senderProfilePictureUrl?: string | null;
1653
+ subType?: null | NotificationDocumentSubType;
1654
+ /**
1655
+ * The unique identifier of the task
1656
+ */
1657
+ taskId: string;
1658
+ /**
1659
+ * The name of the task (optional)
1660
+ */
1661
+ taskName?: string | null;
1662
+ };
1663
+ export type UnsubscribeItemPathParams = {
1664
+ item_id: string;
1665
+ item_type: EntityType;
1666
+ };
1667
+ export type UserUnsubscribe = {
1668
+ /**
1669
+ * The item id
1670
+ */
1671
+ item_id: string;
1672
+ /**
1673
+ * The item type
1674
+ */
1675
+ item_type: string;
1676
+ /**
1677
+ * The item still notifies the user when a message @mentions them directly.
1678
+ */
1679
+ mentions_only?: boolean;
1680
+ /**
1681
+ * None for permanent mutes; notifications resume automatically at this deadline.
1682
+ */
1683
+ snoozed_until?: string | null;
1684
+ };
1685
+ export type HealthHandlerData = {
1686
+ body?: never;
1687
+ path?: never;
1688
+ query?: never;
1689
+ url: '/health';
1690
+ };
1691
+ export type HealthHandlerResponses = {
1692
+ /**
1693
+ * health
1694
+ */
1695
+ 200: EmptyResponse;
1696
+ };
1697
+ export type HealthHandlerResponse = HealthHandlerResponses[keyof HealthHandlerResponses];
1698
+ export type GetUnsubscribesData = {
1699
+ body?: never;
1700
+ path?: never;
1701
+ query?: never;
1702
+ url: '/unsubscribe';
1703
+ };
1704
+ export type GetUnsubscribesErrors = {
1705
+ 401: ErrorResponse;
1706
+ 500: ErrorResponse;
1707
+ };
1708
+ export type GetUnsubscribesError = GetUnsubscribesErrors[keyof GetUnsubscribesErrors];
1709
+ export type GetUnsubscribesResponses = {
1710
+ 200: Array<UserUnsubscribe>;
1711
+ };
1712
+ export type GetUnsubscribesResponse = GetUnsubscribesResponses[keyof GetUnsubscribesResponses];
1713
+ export type UnsubscribeEmailData = {
1714
+ body?: never;
1715
+ path?: never;
1716
+ query?: never;
1717
+ url: '/unsubscribe/email';
1718
+ };
1719
+ export type UnsubscribeEmailErrors = {
1720
+ 404: ErrorResponse;
1721
+ 500: ErrorResponse;
1722
+ };
1723
+ export type UnsubscribeEmailError = UnsubscribeEmailErrors[keyof UnsubscribeEmailErrors];
1724
+ export type UnsubscribeEmailResponses = {
1725
+ 200: EmptyResponse;
1726
+ };
1727
+ export type UnsubscribeEmailResponse = UnsubscribeEmailResponses[keyof UnsubscribeEmailResponses];
1728
+ export type RemoveUnsubscribeItemData = {
1729
+ body?: never;
1730
+ path: {
1731
+ item_type: EntityType;
1732
+ item_id: string;
1733
+ };
1734
+ query?: never;
1735
+ url: '/unsubscribe/item/{item_type}/{item_id}';
1736
+ };
1737
+ export type RemoveUnsubscribeItemErrors = {
1738
+ 401: ErrorResponse;
1739
+ 500: ErrorResponse;
1740
+ };
1741
+ export type RemoveUnsubscribeItemError = RemoveUnsubscribeItemErrors[keyof RemoveUnsubscribeItemErrors];
1742
+ export type RemoveUnsubscribeItemResponses = {
1743
+ 200: EmptyResponse;
1744
+ };
1745
+ export type RemoveUnsubscribeItemResponse = RemoveUnsubscribeItemResponses[keyof RemoveUnsubscribeItemResponses];
1746
+ export type UnsubscribeItemData = {
1747
+ body?: never;
1748
+ path: {
1749
+ item_type: EntityType;
1750
+ item_id: string;
1751
+ };
1752
+ query?: {
1753
+ /**
1754
+ * A future resume time. Omit to mute indefinitely.
1755
+ */
1756
+ snoozed_until?: string | null;
1757
+ /**
1758
+ * Keep notifying for messages that @mention the user directly and silence
1759
+ * the rest. Channels only; cannot be combined with `snoozed_until`.
1760
+ */
1761
+ mentions_only?: boolean;
1762
+ };
1763
+ url: '/unsubscribe/item/{item_type}/{item_id}';
1764
+ };
1765
+ export type UnsubscribeItemErrors = {
1766
+ 400: ErrorResponse;
1767
+ 401: ErrorResponse;
1768
+ 500: ErrorResponse;
1769
+ };
1770
+ export type UnsubscribeItemError = UnsubscribeItemErrors[keyof UnsubscribeItemErrors];
1771
+ export type UnsubscribeItemResponses = {
1772
+ 200: EmptyResponse;
1773
+ };
1774
+ export type UnsubscribeItemResponse = UnsubscribeItemResponses[keyof UnsubscribeItemResponses];
1775
+ export type RemoveUnsubscribeItemsData = {
1776
+ body: BulkRemoveItemsRequest;
1777
+ path?: never;
1778
+ query?: never;
1779
+ url: '/unsubscribe/items';
1780
+ };
1781
+ export type RemoveUnsubscribeItemsErrors = {
1782
+ 400: ErrorResponse;
1783
+ 401: ErrorResponse;
1784
+ 500: ErrorResponse;
1785
+ };
1786
+ export type RemoveUnsubscribeItemsError = RemoveUnsubscribeItemsErrors[keyof RemoveUnsubscribeItemsErrors];
1787
+ export type RemoveUnsubscribeItemsResponses = {
1788
+ 200: EmptyResponse;
1789
+ };
1790
+ export type RemoveUnsubscribeItemsResponse = RemoveUnsubscribeItemsResponses[keyof RemoveUnsubscribeItemsResponses];
1791
+ export type UnsubscribeItemsData = {
1792
+ body: BulkSetItemsRequest;
1793
+ path?: never;
1794
+ query?: never;
1795
+ url: '/unsubscribe/items';
1796
+ };
1797
+ export type UnsubscribeItemsErrors = {
1798
+ 400: ErrorResponse;
1799
+ 401: ErrorResponse;
1800
+ 500: ErrorResponse;
1801
+ };
1802
+ export type UnsubscribeItemsError = UnsubscribeItemsErrors[keyof UnsubscribeItemsErrors];
1803
+ export type UnsubscribeItemsResponses = {
1804
+ 200: EmptyResponse;
1805
+ };
1806
+ export type UnsubscribeItemsResponse = UnsubscribeItemsResponses[keyof UnsubscribeItemsResponses];
1807
+ export type RemoveUnsubscribeAllData = {
1808
+ body?: never;
1809
+ path?: never;
1810
+ query?: never;
1811
+ url: '/unsubscribe/mute';
1812
+ };
1813
+ export type RemoveUnsubscribeAllErrors = {
1814
+ 401: ErrorResponse;
1815
+ 500: ErrorResponse;
1816
+ };
1817
+ export type RemoveUnsubscribeAllError = RemoveUnsubscribeAllErrors[keyof RemoveUnsubscribeAllErrors];
1818
+ export type RemoveUnsubscribeAllResponses = {
1819
+ 200: EmptyResponse;
1820
+ };
1821
+ export type RemoveUnsubscribeAllResponse = RemoveUnsubscribeAllResponses[keyof RemoveUnsubscribeAllResponses];
1822
+ export type UnsubscribeAllData = {
1823
+ body?: never;
1824
+ path?: never;
1825
+ query?: never;
1826
+ url: '/unsubscribe/mute';
1827
+ };
1828
+ export type UnsubscribeAllErrors = {
1829
+ 401: ErrorResponse;
1830
+ 500: ErrorResponse;
1831
+ };
1832
+ export type UnsubscribeAllError = UnsubscribeAllErrors[keyof UnsubscribeAllErrors];
1833
+ export type UnsubscribeAllResponses = {
1834
+ 200: EmptyResponse;
1835
+ };
1836
+ export type UnsubscribeAllResponse = UnsubscribeAllResponses[keyof UnsubscribeAllResponses];
1837
+ export type ListTypedNotificationsData = {
1838
+ body?: never;
1839
+ path?: never;
1840
+ query?: {
1841
+ /**
1842
+ * Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
1843
+ */
1844
+ states?: string;
1845
+ /**
1846
+ * Size limit per page.
1847
+ */
1848
+ limit?: number;
1849
+ /**
1850
+ * Cursor value. Base64 encoded timestamp and item id.
1851
+ */
1852
+ cursor?: string;
1853
+ };
1854
+ url: '/v1/user_notifications';
1855
+ };
1856
+ export type ListTypedNotificationsErrors = {
1857
+ 400: ErrorResponse;
1858
+ 401: ErrorResponse;
1859
+ 500: ErrorResponse;
1860
+ };
1861
+ export type ListTypedNotificationsError = ListTypedNotificationsErrors[keyof ListTypedNotificationsErrors];
1862
+ export type ListTypedNotificationsResponses = {
1863
+ 200: GetAllUserNotificationsResponse;
1864
+ };
1865
+ export type ListTypedNotificationsResponse = ListTypedNotificationsResponses[keyof ListTypedNotificationsResponses];
1866
+ export type BulkDeleteUserNotificationsV2Data = {
1867
+ body: NotificationBulkRequest;
1868
+ path?: never;
1869
+ query?: never;
1870
+ url: '/v1/user_notifications/bulk';
1871
+ };
1872
+ export type BulkDeleteUserNotificationsV2Errors = {
1873
+ 400: ErrorResponse;
1874
+ 401: ErrorResponse;
1875
+ 500: ErrorResponse;
1876
+ };
1877
+ export type BulkDeleteUserNotificationsV2Error = BulkDeleteUserNotificationsV2Errors[keyof BulkDeleteUserNotificationsV2Errors];
1878
+ export type BulkDeleteUserNotificationsV2Responses = {
1879
+ 200: unknown;
1880
+ };
1881
+ export type BulkMarkNotificationsDoneData = {
1882
+ body: NotificationBulkRequest;
1883
+ path?: never;
1884
+ query?: never;
1885
+ url: '/v1/user_notifications/bulk/done';
1886
+ };
1887
+ export type BulkMarkNotificationsDoneErrors = {
1888
+ 400: ErrorResponse;
1889
+ 401: ErrorResponse;
1890
+ 500: ErrorResponse;
1891
+ };
1892
+ export type BulkMarkNotificationsDoneError = BulkMarkNotificationsDoneErrors[keyof BulkMarkNotificationsDoneErrors];
1893
+ export type BulkMarkNotificationsDoneResponses = {
1894
+ 200: unknown;
1895
+ };
1896
+ export type BulkMarkNotificationsSeenData = {
1897
+ body: NotificationBulkRequest;
1898
+ path?: never;
1899
+ query?: never;
1900
+ url: '/v1/user_notifications/bulk/seen';
1901
+ };
1902
+ export type BulkMarkNotificationsSeenErrors = {
1903
+ 400: ErrorResponse;
1904
+ 401: ErrorResponse;
1905
+ 500: ErrorResponse;
1906
+ };
1907
+ export type BulkMarkNotificationsSeenError = BulkMarkNotificationsSeenErrors[keyof BulkMarkNotificationsSeenErrors];
1908
+ export type BulkMarkNotificationsSeenResponses = {
1909
+ 200: unknown;
1910
+ };
1911
+ export type BulkMarkNotificationsUndoneData = {
1912
+ body: NotificationBulkRequest;
1913
+ path?: never;
1914
+ query?: never;
1915
+ url: '/v1/user_notifications/bulk/undone';
1916
+ };
1917
+ export type BulkMarkNotificationsUndoneErrors = {
1918
+ 400: ErrorResponse;
1919
+ 401: ErrorResponse;
1920
+ 500: ErrorResponse;
1921
+ };
1922
+ export type BulkMarkNotificationsUndoneError = BulkMarkNotificationsUndoneErrors[keyof BulkMarkNotificationsUndoneErrors];
1923
+ export type BulkMarkNotificationsUndoneResponses = {
1924
+ 200: unknown;
1925
+ };
1926
+ export type BulkGetTypedNotificationsByEventItemIdsData = {
1927
+ body: BulkGetByEventItemIdsRequest;
1928
+ path?: never;
1929
+ query?: {
1930
+ /**
1931
+ * Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
1932
+ */
1933
+ states?: string;
1934
+ /**
1935
+ * Size limit per page. Default 20, max 500.
1936
+ */
1937
+ limit?: number;
1938
+ /**
1939
+ * Cursor value. Base64 encoded timestamp and item id.
1940
+ */
1941
+ cursor?: string;
1942
+ };
1943
+ url: '/v1/user_notifications/item/bulk';
1944
+ };
1945
+ export type BulkGetTypedNotificationsByEventItemIdsErrors = {
1946
+ 400: ErrorResponse;
1947
+ 401: ErrorResponse;
1948
+ 500: ErrorResponse;
1949
+ };
1950
+ export type BulkGetTypedNotificationsByEventItemIdsError = BulkGetTypedNotificationsByEventItemIdsErrors[keyof BulkGetTypedNotificationsByEventItemIdsErrors];
1951
+ export type BulkGetTypedNotificationsByEventItemIdsResponses = {
1952
+ 200: GetAllUserNotificationsResponse;
1953
+ };
1954
+ export type BulkGetTypedNotificationsByEventItemIdsResponse = BulkGetTypedNotificationsByEventItemIdsResponses[keyof BulkGetTypedNotificationsByEventItemIdsResponses];
1955
+ export type GetTypedNotificationsByEventItemIdData = {
1956
+ body?: never;
1957
+ path: {
1958
+ /**
1959
+ * The event item ID
1960
+ */
1961
+ event_item_id: string;
1962
+ };
1963
+ query?: {
1964
+ /**
1965
+ * Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
1966
+ */
1967
+ states?: string;
1968
+ /**
1969
+ * Size limit per page.
1970
+ */
1971
+ limit?: number;
1972
+ /**
1973
+ * Cursor value. Base64 encoded timestamp and item id.
1974
+ */
1975
+ cursor?: string;
1976
+ };
1977
+ url: '/v1/user_notifications/item/{event_item_id}';
1978
+ };
1979
+ export type GetTypedNotificationsByEventItemIdErrors = {
1980
+ 400: ErrorResponse;
1981
+ 401: ErrorResponse;
1982
+ 500: ErrorResponse;
1983
+ };
1984
+ export type GetTypedNotificationsByEventItemIdError = GetTypedNotificationsByEventItemIdErrors[keyof GetTypedNotificationsByEventItemIdErrors];
1985
+ export type GetTypedNotificationsByEventItemIdResponses = {
1986
+ 200: GetAllUserNotificationsResponse;
1987
+ };
1988
+ export type GetTypedNotificationsByEventItemIdResponse = GetTypedNotificationsByEventItemIdResponses[keyof GetTypedNotificationsByEventItemIdResponses];
1989
+ export type GetNotificationTypePreferencesData = {
1990
+ body?: never;
1991
+ path?: never;
1992
+ query?: never;
1993
+ url: '/v1/user_notifications/preferences';
1994
+ };
1995
+ export type GetNotificationTypePreferencesErrors = {
1996
+ 401: ErrorResponse;
1997
+ 500: ErrorResponse;
1998
+ };
1999
+ export type GetNotificationTypePreferencesError = GetNotificationTypePreferencesErrors[keyof GetNotificationTypePreferencesErrors];
2000
+ export type GetNotificationTypePreferencesResponses = {
2001
+ 200: GetNotificationTypePreferencesResponse;
2002
+ };
2003
+ export type GetNotificationTypePreferencesResponse2 = GetNotificationTypePreferencesResponses[keyof GetNotificationTypePreferencesResponses];
2004
+ export type DisableNotificationTypeData = {
2005
+ body?: never;
2006
+ path: {
2007
+ /**
2008
+ * The notification event type to disable
2009
+ */
2010
+ notification_event_type: string;
2011
+ };
2012
+ query?: never;
2013
+ url: '/v1/user_notifications/preferences/{notification_event_type}/disable';
2014
+ };
2015
+ export type DisableNotificationTypeErrors = {
2016
+ 400: ErrorResponse;
2017
+ 401: ErrorResponse;
2018
+ 500: ErrorResponse;
2019
+ };
2020
+ export type DisableNotificationTypeError = DisableNotificationTypeErrors[keyof DisableNotificationTypeErrors];
2021
+ export type DisableNotificationTypeResponses = {
2022
+ 200: unknown;
2023
+ };
2024
+ export type EnableNotificationTypeData = {
2025
+ body?: never;
2026
+ path: {
2027
+ /**
2028
+ * The notification event type to enable
2029
+ */
2030
+ notification_event_type: string;
2031
+ };
2032
+ query?: never;
2033
+ url: '/v1/user_notifications/preferences/{notification_event_type}/enable';
2034
+ };
2035
+ export type EnableNotificationTypeErrors = {
2036
+ 401: ErrorResponse;
2037
+ 500: ErrorResponse;
2038
+ };
2039
+ export type EnableNotificationTypeError = EnableNotificationTypeErrors[keyof EnableNotificationTypeErrors];
2040
+ export type EnableNotificationTypeResponses = {
2041
+ 200: unknown;
2042
+ };
2043
+ export type DeleteUserNotificationV2Data = {
2044
+ body?: never;
2045
+ path: {
2046
+ /**
2047
+ * ID of the notification
2048
+ */
2049
+ notification_id: string;
2050
+ };
2051
+ query?: never;
2052
+ url: '/v1/user_notifications/{notification_id}';
2053
+ };
2054
+ export type DeleteUserNotificationV2Errors = {
2055
+ 400: ErrorResponse;
2056
+ 401: ErrorResponse;
2057
+ 500: ErrorResponse;
2058
+ };
2059
+ export type DeleteUserNotificationV2Error = DeleteUserNotificationV2Errors[keyof DeleteUserNotificationV2Errors];
2060
+ export type DeleteUserNotificationV2Responses = {
2061
+ 200: unknown;
2062
+ };
2063
+ export type GetTypedNotificationByIdData = {
2064
+ body?: never;
2065
+ path: {
2066
+ /**
2067
+ * ID of the notification
2068
+ */
2069
+ notification_id: string;
2070
+ };
2071
+ query?: never;
2072
+ url: '/v1/user_notifications/{notification_id}';
2073
+ };
2074
+ export type GetTypedNotificationByIdErrors = {
2075
+ 400: ErrorResponse;
2076
+ 401: ErrorResponse;
2077
+ 404: ErrorResponse;
2078
+ 500: ErrorResponse;
2079
+ };
2080
+ export type GetTypedNotificationByIdError = GetTypedNotificationByIdErrors[keyof GetTypedNotificationByIdErrors];
2081
+ export type GetTypedNotificationByIdResponses = {
2082
+ 200: ApiUserNotification;
2083
+ };
2084
+ export type GetTypedNotificationByIdResponse = GetTypedNotificationByIdResponses[keyof GetTypedNotificationByIdResponses];