@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,674 @@
1
+ import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
2
+ import type { AgentSetupData, AgentSetupErrors, AgentSetupResponses, AppleLoginData, AppleLoginErrors, AppleLoginResponses, CancelCodexLoginData, CancelCodexLoginResponses, CancelTeamComputerData, CancelTeamComputerResponses, ChangePlanData, ChangePlanErrors, ChangePlanResponses, CheckGithubLinkStatusData, CheckGithubLinkStatusErrors, CheckGithubLinkStatusResponses, CheckGmailLinkStatusData, CheckGmailLinkStatusErrors, CheckGmailLinkStatusResponses, ClaimHandleData, ClaimHandleErrors, ClaimHandleResponses, ClearTeamRuntimePresetsData, ClearTeamRuntimePresetsErrors, ClearTeamRuntimePresetsResponses, CompleteTeamComputerSetupData, CompleteTeamComputerSetupErrors, CompleteTeamComputerSetupResponses, ConfigureCodexData, ConfigureCodexResponses, CreateAiCreditCheckoutData, CreateAiCreditCheckoutErrors, CreateAiCreditCheckoutResponses, CreateCheckoutSessionV2Data, CreateCheckoutSessionV2Errors, CreateCheckoutSessionV2Responses, CreateGtmInviteLinkData, CreateGtmInviteLinkErrors, CreateGtmInviteLinkResponses, CreateInProgressLinkData, CreateInProgressLinkErrors, CreateInProgressLinkResponses, CreateMergeRequestData, CreateMergeRequestErrors, CreateMergeRequestResponses, CreatePortalSessionData, CreatePortalSessionErrors, CreatePortalSessionResponses, CreateProfilePictureUploadData, CreateProfilePictureUploadErrors, CreateProfilePictureUploadResponses, CreateTeamAgentData, CreateTeamAgentErrors, CreateTeamAgentResponses, CreateTeamData, CreateTeamErrors, CreateTeamInviteLinkData, CreateTeamInviteLinkErrors, CreateTeamInviteLinkResponses, CreateTeamResponses, DeleteAgentApiKeyData, DeleteAgentApiKeyErrors, DeleteAgentApiKeyResponses, DeleteCursorApiKeyData, DeleteCursorApiKeyErrors, DeleteCursorApiKeyResponses, DeleteGithubLinkData, DeleteGithubLinkErrors, DeleteGithubLinkResponses, DeleteTeamAgentData, DeleteTeamAgentErrors, DeleteTeamAgentResponses, DeleteTeamData, DeleteTeamErrors, DeleteTeamInviteHandlerData, DeleteTeamInviteHandlerErrors, DeleteTeamInviteHandlerResponses, DeleteTeamInviteLinkData, DeleteTeamInviteLinkErrors, DeleteTeamInviteLinkResponses, DeleteTeamResponses, DeleteUserData, DeleteUserErrors, DeleteUserResponses, DisableTeamMemberData, DisableTeamMemberErrors, DisableTeamMemberResponses, DisconnectCodexData, DisconnectCodexResponses, EmailConnectionProvidersData, EmailConnectionProvidersErrors, EmailConnectionProvidersResponses, EnableTeamMemberData, EnableTeamMemberErrors, EnableTeamMemberResponses, EnrichGithubPullRequestsData, EnrichGithubPullRequestsErrors, EnrichGithubPullRequestsResponses, GenerateEmailLinkData, GenerateEmailLinkErrors, GenerateEmailLinkResponses, GetAgentApiKeyData, GetAgentApiKeyErrors, GetAgentApiKeyResponses, GetAiBillingPlansData, GetAiBillingPlansResponses, GetAiBillingSummaryData, GetAiBillingSummaryErrors, GetAiBillingSummaryResponses, GetCodexConnectionData, GetCodexConnectionResponses, GetCursorApiKeyData, GetCursorApiKeyErrors, GetCursorApiKeyResponses, GetGithubPullRequestMergeabilityData, GetGithubPullRequestMergeabilityErrors, GetGithubPullRequestMergeabilityResponses, GetGtmInviteOfferData, GetGtmInviteOfferErrors, GetGtmInviteOfferResponses, GetLegacyUserPermissionsData, GetLegacyUserPermissionsErrors, GetLegacyUserPermissionsResponses, GetPermissionsData, GetPermissionsErrors, GetPermissionsResponses, GetReferralCodeData, GetReferralCodeErrors, GetReferralCodeResponses, GetSubscriptionStatusData, GetSubscriptionStatusErrors, GetSubscriptionStatusResponses, GetSystemStatusData, GetSystemStatusErrors, GetSystemStatusResponses, GetTeamAgentVoiceData, GetTeamAgentVoiceErrors, GetTeamAgentVoiceResponses, GetTeamByInviteLinkData, GetTeamByInviteLinkErrors, GetTeamByInviteLinkResponses, GetTeamData, GetTeamErrors, GetTeamInviteLinkData, GetTeamInviteLinkErrors, GetTeamInviteLinkResponses, GetTeamInvitesData, GetTeamInvitesErrors, GetTeamInvitesResponses, GetTeamResponses, GetTrialEligibilityData, GetTrialEligibilityErrors, GetTrialEligibilityResponses, GetUserInfoData, GetUserInfoErrors, GetUserInfoResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserLanguageData, GetUserLanguageErrors, GetUserLanguageResponses, GetUserLinkExistsData, GetUserLinkExistsErrors, GetUserLinkExistsResponses, GetUserNameData, GetUserNameErrors, GetUserNameResponses, GetUserNamesData, GetUserNamesErrors, GetUserNamesResponses, GetUserNamesWithEmailData, GetUserNamesWithEmailErrors, GetUserNamesWithEmailResponses, GetUserOrganizationData, GetUserOrganizationErrors, GetUserOrganizationResponses, GetUserPermissionsData, GetUserPermissionsErrors, GetUserPermissionsResponses, GetUserQuotaData, GetUserQuotaErrors, GetUserQuotaResponses, GetUserTeamsData, GetUserTeamsErrors, GetUserTeamsResponses, HealthHandlerData, HealthHandlerResponses, InitGithubLinkData, InitGithubLinkErrors, InitGithubLinkResponses, InitGmailLinkData, InitGmailLinkErrors, InitGmailLinkResponses, InitOutlookLinkData, InitOutlookLinkErrors, InitOutlookLinkResponses, InviteToTeamData, InviteToTeamErrors, InviteToTeamResponses, JoinTeamByInviteLinkData, JoinTeamByInviteLinkErrors, JoinTeamByInviteLinkResponses, JoinTeamData, JoinTeamErrors, JoinTeamResponses, ListCodexEnvironmentsData, ListCodexEnvironmentsResponses, ListCursorModelsData, ListCursorModelsErrors, ListCursorModelsResponses, ListGtmInviteLinksData, ListGtmInviteLinksErrors, ListGtmInviteLinksResponses, ListSystemStatusHistoryData, ListSystemStatusHistoryErrors, ListSystemStatusHistoryResponses, ListTeamAgentsData, ListTeamAgentsErrors, ListTeamAgentsResponses, ListTeamComputerOffersData, ListTeamComputerOffersErrors, ListTeamComputerOffersResponses, ListTeamComputersData, ListTeamComputersErrors, ListTeamComputersResponses, LogoutData, LogoutResponses, MacroApiTokenData, MacroApiTokenErrors, RoxApiTokenResponses, MergeGithubPullRequestData, MergeGithubPullRequestErrors, MergeGithubPullRequestResponses, Oauth2CallbackData, Oauth2CallbackErrors, Oauth2CallbackResponses, OauthRedirectData, OauthRedirectErrors, OauthRedirectResponses, PasswordLoginData, PasswordLoginErrors, PasswordLoginResponses, PasswordlessCallbackData, PasswordlessCallbackErrors, PasswordlessCallbackResponses, PasswordlessLoginData, PasswordlessLoginErrors, PasswordlessLoginResponses, PatchTeamCrmSettingsData, PatchTeamCrmSettingsErrors, PatchTeamCrmSettingsResponses, PatchTeamData, PatchTeamErrors, PatchTeamMemberPlanData, PatchTeamMemberPlanErrors, PatchTeamMemberPlanResponses, PatchTeamResponses, PatchUserGroupData, PatchUserGroupErrors, PatchUserGroupResponses, PatchUserOnboardingData, PatchUserOnboardingErrors, PatchUserOnboardingResponses, PatchUserTutorialData, PatchUserTutorialErrors, PatchUserTutorialResponses, PollCodexLoginData, PollCodexLoginResponses, PostProfilePicturesData, PostProfilePicturesErrors, PostProfilePicturesResponses, PurchaseAiCreditsData, PurchaseAiCreditsErrors, PurchaseAiCreditsResponses, PurchaseTeamComputerData, PurchaseTeamComputerErrors, PurchaseTeamComputerResponses, PutAgentApiKeyData, PutAgentApiKeyErrors, PutAgentApiKeyResponses, PutCursorApiKeyData, PutCursorApiKeyErrors, PutCursorApiKeyResponses, PutCursorDefaultModelData, PutCursorDefaultModelErrors, PutCursorDefaultModelResponses, PutProfilePictureData, PutProfilePictureErrors, PutProfilePictureFileData, PutProfilePictureFileErrors, PutProfilePictureFileResponses, PutProfilePictureResponses, PutUserLanguageData, PutUserLanguageErrors, PutUserLanguageResponses, PutUserNameData, PutUserNameErrors, PutUserNameResponses, RedeemGtmInviteLinkData, RedeemGtmInviteLinkErrors, RedeemGtmInviteLinkResponses, RefreshData, RefreshErrors, RefreshResponses, RejectInvitationData, RejectInvitationErrors, RejectInvitationResponses, ReleaseTeamComputerData, ReleaseTeamComputerErrors, ReleaseTeamComputerResponses, RemoveUserFromTeamData, RemoveUserFromTeamErrors, RemoveUserFromTeamResponses, ResendFusionauthVerifyUserEmailData, ResendFusionauthVerifyUserEmailErrors, ResendFusionauthVerifyUserEmailResponses, ResolveGtmInviteLinkData, ResolveGtmInviteLinkErrors, ResolveGtmInviteLinkResponses, RestoreTeamComputerData, RestoreTeamComputerErrors, RestoreTeamComputerResponses, RetryTeamComputerData, RetryTeamComputerErrors, RetryTeamComputerResponses, RevokeGtmInviteLinkData, RevokeGtmInviteLinkErrors, RevokeGtmInviteLinkResponses, SendMobileWelcomeEmailData, SendMobileWelcomeEmailErrors, SendMobileWelcomeEmailResponses, SendReferralCodeData, SendReferralCodeErrors, SendReferralCodeResponses, SendTeamDomainNoticeData, SendTeamDomainNoticeErrors, SendTeamDomainNoticeResponses, SessionCreationData, SessionCreationErrors, SessionCreationResponses, SessionLoginData, SessionLoginErrors, SessionLoginResponses, SetGithubPullRequestDraftData, SetGithubPullRequestDraftErrors, SetGithubPullRequestDraftResponses, SetGithubPullRequestStateData, SetGithubPullRequestStateErrors, SetGithubPullRequestStateResponses, SetSystemStatusData, SetSystemStatusErrors, SetSystemStatusResponses, SetTeamAgentVoiceData, SetTeamAgentVoiceErrors, SetTeamAgentVoiceResponses, SetTeamComputerPowerData, SetTeamComputerPowerResponses, SetTeamRuntimePresetsData, SetTeamRuntimePresetsErrors, SetTeamRuntimePresetsResponses, SsoLoginData, SsoLoginErrors, SsoLoginResponses, StartCodexLoginData, StartCodexLoginResponses, ToggleTeamAutoJoinDomainData, ToggleTeamAutoJoinDomainErrors, ToggleTeamAutoJoinDomainResponses, ToggleTeamNonAdminInvitesData, ToggleTeamNonAdminInvitesErrors, ToggleTeamNonAdminInvitesResponses, UndoCancelTeamComputerData, UndoCancelTeamComputerResponses, UpdateAiBillingAutoReloadData, UpdateAiBillingAutoReloadErrors, UpdateAiBillingAutoReloadResponses, UpdateAiBillingOverageData, UpdateAiBillingOverageErrors, UpdateAiBillingOverageResponses, VerifyEmailLinkData, VerifyEmailLinkErrors, VerifyEmailLinkResponses, VerifyFusionauthUserEmailData, VerifyFusionauthUserEmailErrors, VerifyFusionauthUserEmailResponses, VerifyMergeRequestData, VerifyMergeRequestErrors, VerifyMergeRequestResponses } from './types.gen';
3
+ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
4
+ /**
5
+ * You can provide a client instance returned by `createClient()` instead of
6
+ * individual options. This might be also useful if you want to implement a
7
+ * custom client.
8
+ */
9
+ client?: Client;
10
+ /**
11
+ * You can pass arbitrary values through the `meta` object. This can be
12
+ * used to access values that aren't defined as part of the SDK function.
13
+ */
14
+ meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
15
+ };
16
+ declare class HeyApiClient {
17
+ protected client: Client;
18
+ constructor(args?: {
19
+ client?: Client;
20
+ });
21
+ }
22
+ declare class HeyApiRegistry<T> {
23
+ private readonly defaultKey;
24
+ private readonly instances;
25
+ get(key?: string): T;
26
+ set(value: T, key?: string): void;
27
+ }
28
+ export declare class Sdk extends HeyApiClient {
29
+ static readonly __registry: HeyApiRegistry<Sdk>;
30
+ constructor(args?: {
31
+ client?: Client;
32
+ key?: string;
33
+ });
34
+ /**
35
+ * Forgets the agent's API key. Does not revoke it at the provider; succeeds
36
+ * when there was none.
37
+ */
38
+ deleteAgentApiKey<ThrowOnError extends boolean = false>(options: Options<DeleteAgentApiKeyData, ThrowOnError>): RequestResult<DeleteAgentApiKeyResponses, DeleteAgentApiKeyErrors, ThrowOnError>;
39
+ /**
40
+ * The agent's API key, if it has one, and whether its plan allows one.
41
+ */
42
+ getAgentApiKey<ThrowOnError extends boolean = false>(options: Options<GetAgentApiKeyData, ThrowOnError>): RequestResult<GetAgentApiKeyResponses, GetAgentApiKeyErrors, ThrowOnError>;
43
+ /**
44
+ * Registers or replaces the agent's API key, for its model's provider.
45
+ * Only in-memory agents on an Anthropic or OpenAI model, on a paid plan.
46
+ */
47
+ putAgentApiKey<ThrowOnError extends boolean = false>(options: Options<PutAgentApiKeyData, ThrowOnError>): RequestResult<PutAgentApiKeyResponses, PutAgentApiKeyErrors, ThrowOnError>;
48
+ /**
49
+ * Turn automatic credit reloads on with the given
50
+ * thresholds, or off. Payer only. Enabling settles right away, so a balance
51
+ * already under the minimum reloads immediately.
52
+ */
53
+ updateAiBillingAutoReload<ThrowOnError extends boolean = false>(options: Options<UpdateAiBillingAutoReloadData, ThrowOnError>): RequestResult<UpdateAiBillingAutoReloadResponses, UpdateAiBillingAutoReloadErrors, ThrowOnError>;
54
+ /**
55
+ * Start a Stripe Checkout for a credit pack. Payer only.
56
+ */
57
+ createAiCreditCheckout<ThrowOnError extends boolean = false>(options: Options<CreateAiCreditCheckoutData, ThrowOnError>): RequestResult<CreateAiCreditCheckoutResponses, CreateAiCreditCheckoutErrors, ThrowOnError>;
58
+ /**
59
+ * Buy a credit pack now, charged to the payer's card on file. Any paid team
60
+ * member may buy, within the team's monthly credit limit.
61
+ */
62
+ purchaseAiCredits<ThrowOnError extends boolean = false>(options: Options<PurchaseAiCreditsData, ThrowOnError>): RequestResult<PurchaseAiCreditsResponses, PurchaseAiCreditsErrors, ThrowOnError>;
63
+ /**
64
+ * Retired direct-usage opt-in. Enabling is rejected; disabling remains supported.
65
+ */
66
+ updateAiBillingOverage<ThrowOnError extends boolean = false>(options: Options<UpdateAiBillingOverageData, ThrowOnError>): RequestResult<UpdateAiBillingOverageResponses, UpdateAiBillingOverageErrors, ThrowOnError>;
67
+ /**
68
+ * The plan catalog, credit packs, overage cap bounds, and automatic reload
69
+ * defaults and bounds.
70
+ */
71
+ getAiBillingPlans<ThrowOnError extends boolean = false>(options?: Options<GetAiBillingPlansData, ThrowOnError>): RequestResult<GetAiBillingPlansResponses, unknown, ThrowOnError>;
72
+ /**
73
+ * The caller's current-period AI usage, credits, and overage settings.
74
+ *
75
+ * Runs a settlement first so the position reflects any credits or overage
76
+ * that were waiting to be booked.
77
+ */
78
+ getAiBillingSummary<ThrowOnError extends boolean = false>(options?: Options<GetAiBillingSummaryData, ThrowOnError>): RequestResult<GetAiBillingSummaryResponses, GetAiBillingSummaryErrors, ThrowOnError>;
79
+ disconnectCodex<ThrowOnError extends boolean = false>(options?: Options<DisconnectCodexData, ThrowOnError>): RequestResult<DisconnectCodexResponses, unknown, ThrowOnError>;
80
+ getCodexConnection<ThrowOnError extends boolean = false>(options?: Options<GetCodexConnectionData, ThrowOnError>): RequestResult<GetCodexConnectionResponses, unknown, ThrowOnError>;
81
+ configureCodex<ThrowOnError extends boolean = false>(options: Options<ConfigureCodexData, ThrowOnError>): RequestResult<ConfigureCodexResponses, unknown, ThrowOnError>;
82
+ listCodexEnvironments<ThrowOnError extends boolean = false>(options?: Options<ListCodexEnvironmentsData, ThrowOnError>): RequestResult<ListCodexEnvironmentsResponses, unknown, ThrowOnError>;
83
+ startCodexLogin<ThrowOnError extends boolean = false>(options?: Options<StartCodexLoginData, ThrowOnError>): RequestResult<StartCodexLoginResponses, unknown, ThrowOnError>;
84
+ cancelCodexLogin<ThrowOnError extends boolean = false>(options: Options<CancelCodexLoginData, ThrowOnError>): RequestResult<CancelCodexLoginResponses, unknown, ThrowOnError>;
85
+ pollCodexLogin<ThrowOnError extends boolean = false>(options: Options<PollCodexLoginData, ThrowOnError>): RequestResult<PollCodexLoginResponses, unknown, ThrowOnError>;
86
+ /**
87
+ * Forgets the caller's Cursor API key.
88
+ *
89
+ * This does **not** revoke the key at Cursor — it keeps working everywhere
90
+ * else it is used, and only Cursor can revoke it. Any UI offering this has to
91
+ * say so rather than implying otherwise.
92
+ *
93
+ * Deleting when there is nothing to delete succeeds: the caller's intent is
94
+ * "I should have no key registered", and that is already true.
95
+ */
96
+ deleteCursorApiKey<ThrowOnError extends boolean = false>(options?: Options<DeleteCursorApiKeyData, ThrowOnError>): RequestResult<DeleteCursorApiKeyResponses, DeleteCursorApiKeyErrors, ThrowOnError>;
97
+ /**
98
+ * Whether the caller has a Cursor API key registered.
99
+ *
100
+ * Never returns the key, or any part of it. There is no screen that needs one,
101
+ * and a masked key still leaks its length and alphabet.
102
+ */
103
+ getCursorApiKey<ThrowOnError extends boolean = false>(options?: Options<GetCursorApiKeyData, ThrowOnError>): RequestResult<GetCursorApiKeyResponses, GetCursorApiKeyErrors, ThrowOnError>;
104
+ /**
105
+ * Registers or replaces the caller's Cursor API key.
106
+ *
107
+ * The key is validated on shape alone — this cannot distinguish a live key
108
+ * from forty random characters behind the right prefix. Confirming it against
109
+ * Cursor's `GET /v1/me` is the obvious improvement, and is what would let this
110
+ * report the connected account rather than only that a key exists.
111
+ */
112
+ putCursorApiKey<ThrowOnError extends boolean = false>(options: Options<PutCursorApiKeyData, ThrowOnError>): RequestResult<PutCursorApiKeyResponses, PutCursorApiKeyErrors, ThrowOnError>;
113
+ /**
114
+ * Choose the model, and optionally the effort, this user's `@cursor` sessions
115
+ * start on.
116
+ *
117
+ * Stores the id and effort value only; the other parameters are resolved from
118
+ * Cursor's own variants at session start. Saving a model without an effort
119
+ * clears the previous effort, which belonged to the previous model. Not
120
+ * validated against the live model list here — the settings controls offer
121
+ * only real values, and a stale id or effort degrades to the deployment or
122
+ * model default at spawn rather than failing, so a round trip to Cursor on
123
+ * every save would buy nothing.
124
+ */
125
+ putCursorDefaultModel<ThrowOnError extends boolean = false>(options: Options<PutCursorDefaultModelData, ThrowOnError>): RequestResult<PutCursorDefaultModelResponses, PutCursorDefaultModelErrors, ThrowOnError>;
126
+ /**
127
+ * List the models the caller's Cursor account offers.
128
+ *
129
+ * Reached only from the settings dropdown, so it decrypts the user's own key
130
+ * and asks Cursor directly — the list is per-account and changes, so there is
131
+ * nothing to cache statically. Reuses the harness's Cursor client rather than
132
+ * reimplementing the `/v1/models` parse, keeping one source of truth for what
133
+ * a model is.
134
+ */
135
+ listCursorModels<ThrowOnError extends boolean = false>(options?: Options<ListCursorModelsData, ThrowOnError>): RequestResult<ListCursorModelsResponses, ListCursorModelsErrors, ThrowOnError>;
136
+ /**
137
+ * Verifies the user's primary email for FusionAuth
138
+ */
139
+ verifyFusionauthUserEmail<ThrowOnError extends boolean = false>(options: Options<VerifyFusionauthUserEmailData, ThrowOnError>): RequestResult<VerifyFusionauthUserEmailResponses, VerifyFusionauthUserEmailErrors, ThrowOnError>;
140
+ /**
141
+ * Resend the user's primary email verification for FusionAuth
142
+ */
143
+ resendFusionauthVerifyUserEmail<ThrowOnError extends boolean = false>(options: Options<ResendFusionauthVerifyUserEmailData, ThrowOnError>): RequestResult<ResendFusionauthVerifyUserEmailResponses, ResendFusionauthVerifyUserEmailErrors, ThrowOnError>;
144
+ /**
145
+ * Generates an email link for the user to verify their email address.
146
+ */
147
+ generateEmailLink<ThrowOnError extends boolean = false>(options: Options<GenerateEmailLinkData, ThrowOnError>): RequestResult<GenerateEmailLinkResponses, GenerateEmailLinkErrors, ThrowOnError>;
148
+ /**
149
+ * Verifies the user's email for a user profile
150
+ */
151
+ verifyEmailLink<ThrowOnError extends boolean = false>(options: Options<VerifyEmailLinkData, ThrowOnError>): RequestResult<VerifyEmailLinkResponses, VerifyEmailLinkErrors, ThrowOnError>;
152
+ /**
153
+ * Converts a GitHub pull request to a draft, or marks it ready for review,
154
+ * as the authenticated user with their own GitHub grant.
155
+ */
156
+ setGithubPullRequestDraft<ThrowOnError extends boolean = false>(options: Options<SetGithubPullRequestDraftData, ThrowOnError>): RequestResult<SetGithubPullRequestDraftResponses, SetGithubPullRequestDraftErrors, ThrowOnError>;
157
+ /**
158
+ * Enriches GitHub pull request references with live GitHub data for the authenticated user.
159
+ */
160
+ enrichGithubPullRequests<ThrowOnError extends boolean = false>(options: Options<EnrichGithubPullRequestsData, ThrowOnError>): RequestResult<EnrichGithubPullRequestsResponses, EnrichGithubPullRequestsErrors, ThrowOnError>;
161
+ /**
162
+ * Merges a GitHub pull request as the authenticated user, with their own
163
+ * GitHub grant. GitHub applies the user's permissions and the repository's
164
+ * branch protections; a refusal is returned with GitHub's message.
165
+ */
166
+ mergeGithubPullRequest<ThrowOnError extends boolean = false>(options: Options<MergeGithubPullRequestData, ThrowOnError>): RequestResult<MergeGithubPullRequestResponses, MergeGithubPullRequestErrors, ThrowOnError>;
167
+ /**
168
+ * Reads whether each GitHub pull request merges cleanly into its base, as
169
+ * the authenticated user sees it. Pull requests the user cannot see are
170
+ * left out.
171
+ */
172
+ getGithubPullRequestMergeability<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestMergeabilityData, ThrowOnError>): RequestResult<GetGithubPullRequestMergeabilityResponses, GetGithubPullRequestMergeabilityErrors, ThrowOnError>;
173
+ /**
174
+ * Closes a GitHub pull request, or reopens it, as the authenticated user
175
+ * with their own GitHub grant.
176
+ */
177
+ setGithubPullRequestState<ThrowOnError extends boolean = false>(options: Options<SetGithubPullRequestStateData, ThrowOnError>): RequestResult<SetGithubPullRequestStateResponses, SetGithubPullRequestStateErrors, ThrowOnError>;
178
+ /**
179
+ * Lists invite links, newest first. Rox staff only.
180
+ */
181
+ listGtmInviteLinks<ThrowOnError extends boolean = false>(options?: Options<ListGtmInviteLinksData, ThrowOnError>): RequestResult<ListGtmInviteLinksResponses, ListGtmInviteLinksErrors, ThrowOnError>;
182
+ /**
183
+ * Creates an invite link. Rox staff only.
184
+ */
185
+ createGtmInviteLink<ThrowOnError extends boolean = false>(options: Options<CreateGtmInviteLinkData, ThrowOnError>): RequestResult<CreateGtmInviteLinkResponses, CreateGtmInviteLinkErrors, ThrowOnError>;
186
+ /**
187
+ * Revokes an invite link nobody has signed up through. Rox staff only.
188
+ */
189
+ revokeGtmInviteLink<ThrowOnError extends boolean = false>(options: Options<RevokeGtmInviteLinkData, ThrowOnError>): RequestResult<RevokeGtmInviteLinkResponses, RevokeGtmInviteLinkErrors, ThrowOnError>;
190
+ /**
191
+ * The promotion the signed-in user's account holds from an invite link, if
192
+ * they redeemed one and have not started a paid subscription yet.
193
+ */
194
+ getGtmInviteOffer<ThrowOnError extends boolean = false>(options?: Options<GetGtmInviteOfferData, ThrowOnError>): RequestResult<GetGtmInviteOfferResponses, GetGtmInviteOfferErrors, ThrowOnError>;
195
+ /**
196
+ * Resolves an invite link for the public welcome page and counts the open.
197
+ *
198
+ * Unauthenticated: the recipient has no account yet. Only the first name and
199
+ * whether the link is still usable are exposed.
200
+ */
201
+ resolveGtmInviteLink<ThrowOnError extends boolean = false>(options: Options<ResolveGtmInviteLinkData, ThrowOnError>): RequestResult<ResolveGtmInviteLinkResponses, ResolveGtmInviteLinkErrors, ThrowOnError>;
202
+ /**
203
+ * Attributes the signed-in user's account to the invite link they opened and
204
+ * grants them its offer. Idempotent for the same account.
205
+ */
206
+ redeemGtmInviteLink<ThrowOnError extends boolean = false>(options: Options<RedeemGtmInviteLinkData, ThrowOnError>): RequestResult<RedeemGtmInviteLinkResponses, RedeemGtmInviteLinkErrors, ThrowOnError>;
207
+ /**
208
+ * Health check
209
+ */
210
+ healthHandler<ThrowOnError extends boolean = false>(options?: Options<HealthHandlerData, ThrowOnError>): RequestResult<HealthHandlerResponses, unknown, ThrowOnError>;
211
+ /**
212
+ * Generates a macro-api-token using the user's macro-access-token
213
+ * You can either have your access token in the cookies or in the request
214
+ * headers
215
+ * Authorization: Bearer <access_token>
216
+ * This returns a new macro-api-token
217
+ */
218
+ macroApiToken<ThrowOnError extends boolean = false>(options: Options<MacroApiTokenData, ThrowOnError>): RequestResult<RoxApiTokenResponses, MacroApiTokenErrors, ThrowOnError>;
219
+ /**
220
+ * Refreshes a JWT token
221
+ * You can either have your access token and refresh token in the cookies or in the request
222
+ * headers
223
+ * Authorization: Bearer <access_token>
224
+ * x-macro-refresh-token: <refresh_token>
225
+ * This returns the cookies with the new access and refresh token
226
+ */
227
+ refresh<ThrowOnError extends boolean = false>(options?: Options<RefreshData, ThrowOnError>): RequestResult<RefreshResponses, RefreshErrors, ThrowOnError>;
228
+ /**
229
+ * Initiates a link for a user
230
+ */
231
+ createInProgressLink<ThrowOnError extends boolean = false>(options?: Options<CreateInProgressLinkData, ThrowOnError>): RequestResult<CreateInProgressLinkResponses, CreateInProgressLinkErrors, ThrowOnError>;
232
+ emailConnectionProviders<ThrowOnError extends boolean = false>(options?: Options<EmailConnectionProvidersData, ThrowOnError>): RequestResult<EmailConnectionProvidersResponses, EmailConnectionProvidersErrors, ThrowOnError>;
233
+ /**
234
+ * Deletes a github link for a user
235
+ */
236
+ deleteGithubLink<ThrowOnError extends boolean = false>(options?: Options<DeleteGithubLinkData, ThrowOnError>): RequestResult<DeleteGithubLinkResponses, DeleteGithubLinkErrors, ThrowOnError>;
237
+ /**
238
+ * Initiates a link for a user
239
+ */
240
+ initGithubLink<ThrowOnError extends boolean = false>(options: Options<InitGithubLinkData, ThrowOnError>): RequestResult<InitGithubLinkResponses, InitGithubLinkErrors, ThrowOnError>;
241
+ /**
242
+ * Checks whether the authenticated user's GitHub link token is valid.
243
+ */
244
+ checkGithubLinkStatus<ThrowOnError extends boolean = false>(options?: Options<CheckGithubLinkStatusData, ThrowOnError>): RequestResult<CheckGithubLinkStatusResponses, CheckGithubLinkStatusErrors, ThrowOnError>;
245
+ /**
246
+ * Initiates a Gmail link for a user
247
+ */
248
+ initGmailLink<ThrowOnError extends boolean = false>(options: Options<InitGmailLinkData, ThrowOnError>): RequestResult<InitGmailLinkResponses, InitGmailLinkErrors, ThrowOnError>;
249
+ /**
250
+ * Checks whether the authenticated user's gmail link is valid.
251
+ */
252
+ checkGmailLinkStatus<ThrowOnError extends boolean = false>(options?: Options<CheckGmailLinkStatusData, ThrowOnError>): RequestResult<CheckGmailLinkStatusResponses, CheckGmailLinkStatusErrors, ThrowOnError>;
253
+ /**
254
+ * Initiates a Microsoft Outlook account link for an authenticated user.
255
+ */
256
+ initOutlookLink<ThrowOnError extends boolean = false>(options?: Options<InitOutlookLinkData, ThrowOnError>): RequestResult<InitOutlookLinkResponses, InitOutlookLinkErrors, ThrowOnError>;
257
+ /**
258
+ * Completes the apple login flow
259
+ */
260
+ appleLogin<ThrowOnError extends boolean = false>(options: Options<AppleLoginData, ThrowOnError>): RequestResult<AppleLoginResponses, AppleLoginErrors, ThrowOnError>;
261
+ /**
262
+ * Performs a password login
263
+ */
264
+ passwordLogin<ThrowOnError extends boolean = false>(options: Options<PasswordLoginData, ThrowOnError>): RequestResult<PasswordLoginResponses, PasswordLoginErrors, ThrowOnError>;
265
+ /**
266
+ * Initiates a passwordless login
267
+ */
268
+ passwordlessLogin<ThrowOnError extends boolean = false>(options: Options<PasswordlessLoginData, ThrowOnError>): RequestResult<PasswordlessLoginResponses, PasswordlessLoginErrors, ThrowOnError>;
269
+ /**
270
+ * Initiates an SSO login
271
+ */
272
+ ssoLogin<ThrowOnError extends boolean = false>(options: Options<SsoLoginData, ThrowOnError>): RequestResult<SsoLoginResponses, SsoLoginErrors, ThrowOnError>;
273
+ /**
274
+ * Initiates a passwordless login
275
+ */
276
+ logout<ThrowOnError extends boolean = false>(options?: Options<LogoutData, ThrowOnError>): RequestResult<LogoutResponses, unknown, ThrowOnError>;
277
+ /**
278
+ * Creates a merge request used to verify the user's email address in order to merge their
279
+ * accounts.
280
+ * This is different than generate_email_link which is used to verify a new email address to add a
281
+ * new profile to a user's account.
282
+ */
283
+ createMergeRequest<ThrowOnError extends boolean = false>(options: Options<CreateMergeRequestData, ThrowOnError>): RequestResult<CreateMergeRequestResponses, CreateMergeRequestErrors, ThrowOnError>;
284
+ /**
285
+ * Verifies the merge request
286
+ */
287
+ verifyMergeRequest<ThrowOnError extends boolean = false>(options: Options<VerifyMergeRequestData, ThrowOnError>): RequestResult<VerifyMergeRequestResponses, VerifyMergeRequestErrors, ThrowOnError>;
288
+ /**
289
+ * Emails a mobile lead a link to continue onboarding on desktop and enrolls
290
+ * them in the Loops welcome sequence. No-ops if the address was already
291
+ * captured, and rejects blocked addresses.
292
+ */
293
+ sendMobileWelcomeEmail<ThrowOnError extends boolean = false>(options: Options<SendMobileWelcomeEmailData, ThrowOnError>): RequestResult<SendMobileWelcomeEmailResponses, SendMobileWelcomeEmailErrors, ThrowOnError>;
294
+ /**
295
+ * Handles oauth redirect
296
+ */
297
+ passwordlessCallback<ThrowOnError extends boolean = false>(options: Options<PasswordlessCallbackData, ThrowOnError>): RequestResult<PasswordlessCallbackResponses, PasswordlessCallbackErrors, ThrowOnError>;
298
+ /**
299
+ * Handles oauth redirect
300
+ */
301
+ oauthRedirect<ThrowOnError extends boolean = false>(options?: Options<OauthRedirectData, ThrowOnError>): RequestResult<OauthRedirectResponses, OauthRedirectErrors, ThrowOnError>;
302
+ /**
303
+ * Custom OAuth2 callback
304
+ */
305
+ oauth2Callback<ThrowOnError extends boolean = false>(options: Options<Oauth2CallbackData, ThrowOnError>): RequestResult<Oauth2CallbackResponses, Oauth2CallbackErrors, ThrowOnError>;
306
+ /**
307
+ * Gets all permissions
308
+ */
309
+ getPermissions<ThrowOnError extends boolean = false>(options?: Options<GetPermissionsData, ThrowOnError>): RequestResult<GetPermissionsResponses, GetPermissionsErrors, ThrowOnError>;
310
+ /**
311
+ * Gets a list of the users permissions
312
+ */
313
+ getUserPermissions<ThrowOnError extends boolean = false>(options?: Options<GetUserPermissionsData, ThrowOnError>): RequestResult<GetUserPermissionsResponses, GetUserPermissionsErrors, ThrowOnError>;
314
+ /**
315
+ * Handler for `GET /referral-code`.
316
+ *
317
+ * Returns the authenticated user's referral code.
318
+ */
319
+ getReferralCode<ThrowOnError extends boolean = false>(options?: Options<GetReferralCodeData, ThrowOnError>): RequestResult<GetReferralCodeResponses, GetReferralCodeErrors, ThrowOnError>;
320
+ /**
321
+ * Handler for `POST /referral/send`.
322
+ *
323
+ * Sends a referral code via email to a user
324
+ */
325
+ sendReferralCode<ThrowOnError extends boolean = false>(options: Options<SendReferralCodeData, ThrowOnError>): RequestResult<SendReferralCodeResponses, SendReferralCodeErrors, ThrowOnError>;
326
+ /**
327
+ * Refreshes a JWT token
328
+ */
329
+ sessionCreation<ThrowOnError extends boolean = false>(options?: Options<SessionCreationData, ThrowOnError>): RequestResult<SessionCreationResponses, SessionCreationErrors, ThrowOnError>;
330
+ /**
331
+ * Performs a login via session code
332
+ */
333
+ sessionLogin<ThrowOnError extends boolean = false>(options: Options<SessionLoginData, ThrowOnError>): RequestResult<SessionLoginResponses, SessionLoginErrors, ThrowOnError>;
334
+ /**
335
+ * The status every user sees. Public: the banner shows wherever the app
336
+ * runs, signed in or not.
337
+ */
338
+ getSystemStatus<ThrowOnError extends boolean = false>(options?: Options<GetSystemStatusData, ThrowOnError>): RequestResult<GetSystemStatusResponses, GetSystemStatusErrors, ThrowOnError>;
339
+ /**
340
+ * Sets the status every user sees and pushes it to every open app. Macro
341
+ * staff only.
342
+ *
343
+ * Authenticate with a Rox session, or from a script with a personal API
344
+ * key (Settings → API keys) in the `x-macro-user-api-key` header. The body
345
+ * is the new status:
346
+ *
347
+ * - `{"status": "operational"}` clears the banner. It takes no message.
348
+ * - `{"status": "degraded", "message": "Search is slow to update."}`
349
+ * - `{"status": "major_outage", "message": "Rox is unavailable. We're on it."}`
350
+ *
351
+ * Messages are trimmed and must be 1–500 characters. Every call is kept in
352
+ * the history, even when it repeats the current status.
353
+ */
354
+ setSystemStatus<ThrowOnError extends boolean = false>(options: Options<SetSystemStatusData, ThrowOnError>): RequestResult<SetSystemStatusResponses, SetSystemStatusErrors, ThrowOnError>;
355
+ /**
356
+ * Recent status updates, newest first, with who set each. Rox staff only.
357
+ */
358
+ listSystemStatusHistory<ThrowOnError extends boolean = false>(options?: Options<ListSystemStatusHistoryData, ThrowOnError>): RequestResult<ListSystemStatusHistoryResponses, ListSystemStatusHistoryErrors, ThrowOnError>;
359
+ /**
360
+ * Deletes a team.
361
+ * This will update all team members roles and cancel your subscription for the team.
362
+ * This action is **irreversible** and you will not be able to recover the team afterwards.
363
+ */
364
+ deleteTeam<ThrowOnError extends boolean = false>(options?: Options<DeleteTeamData, ThrowOnError>): RequestResult<DeleteTeamResponses, DeleteTeamErrors, ThrowOnError>;
365
+ /**
366
+ * Gets a team by ID.
367
+ */
368
+ getTeam<ThrowOnError extends boolean = false>(options?: Options<GetTeamData, ThrowOnError>): RequestResult<GetTeamResponses, GetTeamErrors, ThrowOnError>;
369
+ /**
370
+ * Updates a team.
371
+ */
372
+ patchTeam<ThrowOnError extends boolean = false>(options: Options<PatchTeamData, ThrowOnError>): RequestResult<PatchTeamResponses, PatchTeamErrors, ThrowOnError>;
373
+ /**
374
+ * Creates a new team.
375
+ */
376
+ createTeam<ThrowOnError extends boolean = false>(options: Options<CreateTeamData, ThrowOnError>): RequestResult<CreateTeamResponses, CreateTeamErrors, ThrowOnError>;
377
+ /**
378
+ * Toggles automatic domain joining for the team. When the team has no
379
+ * auto-join domain, sets it to the team owner's email domain — rejected
380
+ * with a 400 when that domain is a generic email provider domain (e.g.
381
+ * gmail.com). When one is already set, removes it. New users whose email
382
+ * domain matches a team's auto-join domain are added to that team on
383
+ * signup. Requires the caller to be an Admin or Owner of the team.
384
+ */
385
+ toggleTeamAutoJoinDomain<ThrowOnError extends boolean = false>(options?: Options<ToggleTeamAutoJoinDomainData, ThrowOnError>): RequestResult<ToggleTeamAutoJoinDomainResponses, ToggleTeamAutoJoinDomainErrors, ThrowOnError>;
386
+ /**
387
+ * The team's computers, oldest first.
388
+ */
389
+ listTeamComputers<ThrowOnError extends boolean = false>(options?: Options<ListTeamComputersData, ThrowOnError>): RequestResult<ListTeamComputersResponses, ListTeamComputersErrors, ThrowOnError>;
390
+ /**
391
+ * Buy a computer for the team, billed on the team subscription. An error
392
+ * means nothing was charged; 202 means the charge is still being confirmed.
393
+ */
394
+ purchaseTeamComputer<ThrowOnError extends boolean = false>(options: Options<PurchaseTeamComputerData, ThrowOnError>): RequestResult<PurchaseTeamComputerResponses, PurchaseTeamComputerErrors, ThrowOnError>;
395
+ /**
396
+ * Every size with its price and availability.
397
+ */
398
+ listTeamComputerOffers<ThrowOnError extends boolean = false>(options?: Options<ListTeamComputerOffersData, ThrowOnError>): RequestResult<ListTeamComputerOffersResponses, ListTeamComputerOffersErrors, ThrowOnError>;
399
+ /**
400
+ * Keep a computer that was canceled at period end.
401
+ */
402
+ undoCancelTeamComputer<ThrowOnError extends boolean = false>(options: Options<UndoCancelTeamComputerData, ThrowOnError>): RequestResult<UndoCancelTeamComputerResponses, unknown, ThrowOnError>;
403
+ /**
404
+ * Stop billing at the end of the current period.
405
+ */
406
+ cancelTeamComputer<ThrowOnError extends boolean = false>(options: Options<CancelTeamComputerData, ThrowOnError>): RequestResult<CancelTeamComputerResponses, unknown, ThrowOnError>;
407
+ /**
408
+ * Turn a computer on or off. A computer that is off keeps its disk and stays billed.
409
+ */
410
+ setTeamComputerPower<ThrowOnError extends boolean = false>(options: Options<SetTeamComputerPowerData, ThrowOnError>): RequestResult<SetTeamComputerPowerResponses, unknown, ThrowOnError>;
411
+ /**
412
+ * Stop billing and destroy the computer now, without a refund.
413
+ */
414
+ releaseTeamComputer<ThrowOnError extends boolean = false>(options: Options<ReleaseTeamComputerData, ThrowOnError>): RequestResult<ReleaseTeamComputerResponses, ReleaseTeamComputerErrors, ThrowOnError>;
415
+ /**
416
+ * Keep a computer whose billing ended, during retention: re-adds its
417
+ * billing item (the rest of the period is invoiced now) and keeps the
418
+ * stopped computer and its disk.
419
+ */
420
+ restoreTeamComputer<ThrowOnError extends boolean = false>(options: Options<RestoreTeamComputerData, ThrowOnError>): RequestResult<RestoreTeamComputerResponses, RestoreTeamComputerErrors, ThrowOnError>;
421
+ /**
422
+ * Retry a failed computer without changing billing.
423
+ */
424
+ retryTeamComputer<ThrowOnError extends boolean = false>(options: Options<RetryTeamComputerData, ThrowOnError>): RequestResult<RetryTeamComputerResponses, RetryTeamComputerErrors, ThrowOnError>;
425
+ /**
426
+ * Mark the guided setup after buying the computer finished. Idempotent;
427
+ * allowed to the team's owner and admins, like Claude sign-in.
428
+ */
429
+ completeTeamComputerSetup<ThrowOnError extends boolean = false>(options: Options<CompleteTeamComputerSetupData, ThrowOnError>): RequestResult<CompleteTeamComputerSetupResponses, CompleteTeamComputerSetupErrors, ThrowOnError>;
430
+ /**
431
+ * Legacy compatibility endpoint for team admins and owners. Enabling
432
+ * is a no-op; disabling is rejected. CRM records remain available.
433
+ * Each member manages mailbox contribution through `/crm/email-privacy`;
434
+ * this endpoint does not enroll mailboxes, backfill emails, or purge records.
435
+ */
436
+ patchTeamCrmSettings<ThrowOnError extends boolean = false>(options: Options<PatchTeamCrmSettingsData, ThrowOnError>): RequestResult<PatchTeamCrmSettingsResponses, PatchTeamCrmSettingsErrors, ThrowOnError>;
437
+ /**
438
+ * Emails the caller's contacts on the team's auto-join domain that the team
439
+ * exists, so they can sign up and join. Contacts already on Rox, on the
440
+ * team, invited, or emailed before are skipped, and a team emails at most 25
441
+ * people in total. Call it after sending the team's invites. Requires the
442
+ * caller to be an Admin or Owner of the team.
443
+ */
444
+ sendTeamDomainNotice<ThrowOnError extends boolean = false>(options?: Options<SendTeamDomainNoticeData, ThrowOnError>): RequestResult<SendTeamDomainNoticeResponses, SendTeamDomainNoticeErrors, ThrowOnError>;
445
+ /**
446
+ * Invites a user to a team.
447
+ */
448
+ inviteToTeam<ThrowOnError extends boolean = false>(options: Options<InviteToTeamData, ThrowOnError>): RequestResult<InviteToTeamResponses, InviteToTeamErrors, ThrowOnError>;
449
+ /**
450
+ * Turns off the team's invite link. Requires a team admin or owner.
451
+ */
452
+ deleteTeamInviteLink<ThrowOnError extends boolean = false>(options?: Options<DeleteTeamInviteLinkData, ThrowOnError>): RequestResult<DeleteTeamInviteLinkResponses, DeleteTeamInviteLinkErrors, ThrowOnError>;
453
+ /**
454
+ * Gets the team's invite link. Anyone who may invite people to the team may
455
+ * see it.
456
+ */
457
+ getTeamInviteLink<ThrowOnError extends boolean = false>(options?: Options<GetTeamInviteLinkData, ThrowOnError>): RequestResult<GetTeamInviteLinkResponses, GetTeamInviteLinkErrors, ThrowOnError>;
458
+ /**
459
+ * Creates the team's invite link, replacing any existing one. Anyone who may
460
+ * invite people may create the first link; replacing one requires a team
461
+ * admin or owner.
462
+ */
463
+ createTeamInviteLink<ThrowOnError extends boolean = false>(options?: Options<CreateTeamInviteLinkData, ThrowOnError>): RequestResult<CreateTeamInviteLinkResponses, CreateTeamInviteLinkErrors, ThrowOnError>;
464
+ /**
465
+ * Joins the team an invite link belongs to.
466
+ */
467
+ joinTeamByInviteLink<ThrowOnError extends boolean = false>(options: Options<JoinTeamByInviteLinkData, ThrowOnError>): RequestResult<JoinTeamByInviteLinkResponses, JoinTeamByInviteLinkErrors, ThrowOnError>;
468
+ /**
469
+ * Gets the team an invite link joins, so the user can see it before joining.
470
+ */
471
+ getTeamByInviteLink<ThrowOnError extends boolean = false>(options: Options<GetTeamByInviteLinkData, ThrowOnError>): RequestResult<GetTeamByInviteLinkResponses, GetTeamByInviteLinkErrors, ThrowOnError>;
472
+ /**
473
+ * Deletes a team invite from a team.
474
+ */
475
+ deleteTeamInviteHandler<ThrowOnError extends boolean = false>(options: Options<DeleteTeamInviteHandlerData, ThrowOnError>): RequestResult<DeleteTeamInviteHandlerResponses, DeleteTeamInviteHandlerErrors, ThrowOnError>;
476
+ /**
477
+ * Gets all invites for a team.
478
+ */
479
+ getTeamInvites<ThrowOnError extends boolean = false>(options?: Options<GetTeamInvitesData, ThrowOnError>): RequestResult<GetTeamInvitesResponses, GetTeamInvitesErrors, ThrowOnError>;
480
+ /**
481
+ * Rejects an invitation to join a team.
482
+ */
483
+ rejectInvitation<ThrowOnError extends boolean = false>(options: Options<RejectInvitationData, ThrowOnError>): RequestResult<RejectInvitationResponses, RejectInvitationErrors, ThrowOnError>;
484
+ /**
485
+ * Joins a team by accepting an invite.
486
+ */
487
+ joinTeam<ThrowOnError extends boolean = false>(options: Options<JoinTeamData, ThrowOnError>): RequestResult<JoinTeamResponses, JoinTeamErrors, ThrowOnError>;
488
+ /**
489
+ * Disables a team member and revokes their server-side harness records.
490
+ */
491
+ disableTeamMember<ThrowOnError extends boolean = false>(options: Options<DisableTeamMemberData, ThrowOnError>): RequestResult<DisableTeamMemberResponses, DisableTeamMemberErrors, ThrowOnError>;
492
+ /**
493
+ * Re-enables a previously disabled team member.
494
+ */
495
+ enableTeamMember<ThrowOnError extends boolean = false>(options: Options<EnableTeamMemberData, ThrowOnError>): RequestResult<EnableTeamMemberResponses, EnableTeamMemberErrors, ThrowOnError>;
496
+ /**
497
+ * Moves one team member's seat between paid plans.
498
+ *
499
+ * Team admins and owners only. The team's subscription is re-billed for
500
+ * the seat at once (prorated); the member's tier role and individual AI
501
+ * allowance follow immediately.
502
+ */
503
+ patchTeamMemberPlan<ThrowOnError extends boolean = false>(options: Options<PatchTeamMemberPlanData, ThrowOnError>): RequestResult<PatchTeamMemberPlanResponses, PatchTeamMemberPlanErrors, ThrowOnError>;
504
+ /**
505
+ * Toggles whether non-admin members may invite users to the team. Teams
506
+ * start with this on (any member can invite); turning it off restricts
507
+ * inviting to team admins and owners. Requires the caller to be an Admin
508
+ * or Owner of the team.
509
+ */
510
+ toggleTeamNonAdminInvites<ThrowOnError extends boolean = false>(options?: Options<ToggleTeamNonAdminInvitesData, ThrowOnError>): RequestResult<ToggleTeamNonAdminInvitesResponses, ToggleTeamNonAdminInvitesErrors, ThrowOnError>;
511
+ /**
512
+ * Removes a user from a team.
513
+ */
514
+ removeUserFromTeam<ThrowOnError extends boolean = false>(options: Options<RemoveUserFromTeamData, ThrowOnError>): RequestResult<RemoveUserFromTeamResponses, RemoveUserFromTeamErrors, ThrowOnError>;
515
+ /**
516
+ * Clears a team's runtime allowlist, restoring the default local presets.
517
+ */
518
+ clearTeamRuntimePresets<ThrowOnError extends boolean = false>(options?: Options<ClearTeamRuntimePresetsData, ThrowOnError>): RequestResult<ClearTeamRuntimePresetsResponses, ClearTeamRuntimePresetsErrors, ThrowOnError>;
519
+ /**
520
+ * Replaces the exhaustive set of local runtime presets allowed for a team.
521
+ */
522
+ setTeamRuntimePresets<ThrowOnError extends boolean = false>(options: Options<SetTeamRuntimePresetsData, ThrowOnError>): RequestResult<SetTeamRuntimePresetsResponses, SetTeamRuntimePresetsErrors, ThrowOnError>;
523
+ /**
524
+ * Gets all teams for the authenticated user.
525
+ */
526
+ getUserTeams<ThrowOnError extends boolean = false>(options?: Options<GetUserTeamsData, ThrowOnError>): RequestResult<GetUserTeamsResponses, GetUserTeamsErrors, ThrowOnError>;
527
+ /**
528
+ * Gets all of a user's invitations.
529
+ */
530
+ getUserInvites<ThrowOnError extends boolean = false>(options?: Options<GetUserInvitesData, ThrowOnError>): RequestResult<GetUserInvitesResponses, GetUserInvitesErrors, ThrowOnError>;
531
+ /**
532
+ * The caller's team's agents, with their computers' status.
533
+ */
534
+ listTeamAgents<ThrowOnError extends boolean = false>(options?: Options<ListTeamAgentsData, ThrowOnError>): RequestResult<ListTeamAgentsResponses, ListTeamAgentsErrors, ThrowOnError>;
535
+ /**
536
+ * Invite an agent teammate and buy its computer. Requires a team admin or
537
+ * owner using their own credential. The agent comes back `provisioning`.
538
+ */
539
+ createTeamAgent<ThrowOnError extends boolean = false>(options: Options<CreateTeamAgentData, ThrowOnError>): RequestResult<CreateTeamAgentResponses, CreateTeamAgentErrors, ThrowOnError>;
540
+ /**
541
+ * Remove an agent teammate: release its computer, take it off the team and
542
+ * delete its repository and account. Requires a team admin or owner.
543
+ */
544
+ deleteTeamAgent<ThrowOnError extends boolean = false>(options: Options<DeleteTeamAgentData, ThrowOnError>): RequestResult<DeleteTeamAgentResponses, DeleteTeamAgentErrors, ThrowOnError>;
545
+ /**
546
+ * The agent's call voice, as committed in its workspace repository.
547
+ * Requires a team admin or owner.
548
+ */
549
+ getTeamAgentVoice<ThrowOnError extends boolean = false>(options: Options<GetTeamAgentVoiceData, ThrowOnError>): RequestResult<GetTeamAgentVoiceResponses, GetTeamAgentVoiceErrors, ThrowOnError>;
550
+ /**
551
+ * Change the agent's call voice: a commit to its workspace repository that
552
+ * its next call picks up. Requires a team admin or owner.
553
+ */
554
+ setTeamAgentVoice<ThrowOnError extends boolean = false>(options: Options<SetTeamAgentVoiceData, ThrowOnError>): RequestResult<SetTeamAgentVoiceResponses, SetTeamAgentVoiceErrors, ThrowOnError>;
555
+ /**
556
+ * Finishes an agent's signup: joins the team that invited it and mints its
557
+ * SDK token.
558
+ *
559
+ * Safe to repeat until the agent confirms it saved the token: a reload replaces
560
+ * the key, and a failed join stays pending for the next attempt.
561
+ */
562
+ agentSetup<ThrowOnError extends boolean = false>(options?: Options<AgentSetupData, ThrowOnError>): RequestResult<AgentSetupResponses, AgentSetupErrors, ThrowOnError>;
563
+ /**
564
+ * Retrieves user names in bulk
565
+ */
566
+ getUserNames<ThrowOnError extends boolean = false>(options: Options<GetUserNamesData, ThrowOnError>): RequestResult<GetUserNamesResponses, GetUserNamesErrors, ThrowOnError>;
567
+ /**
568
+ * Gets names for passed user profile ids, falling back to the requesting user's email contact names
569
+ */
570
+ getUserNamesWithEmail<ThrowOnError extends boolean = false>(options: Options<GetUserNamesWithEmailData, ThrowOnError>): RequestResult<GetUserNamesWithEmailResponses, GetUserNamesWithEmailErrors, ThrowOnError>;
571
+ /**
572
+ * Updates the user's group.
573
+ */
574
+ patchUserGroup<ThrowOnError extends boolean = false>(options: Options<PatchUserGroupData, ThrowOnError>): RequestResult<PatchUserGroupResponses, PatchUserGroupErrors, ThrowOnError>;
575
+ /**
576
+ * Claims a handle once for this account. Existing usernames are unchanged
577
+ * until this endpoint is called; a taken handle is never replaced with a suffix.
578
+ */
579
+ claimHandle<ThrowOnError extends boolean = false>(options: Options<ClaimHandleData, ThrowOnError>): RequestResult<ClaimHandleResponses, ClaimHandleErrors, ThrowOnError>;
580
+ /**
581
+ * Get the caller's interface language.
582
+ */
583
+ getUserLanguage<ThrowOnError extends boolean = false>(options?: Options<GetUserLanguageData, ThrowOnError>): RequestResult<GetUserLanguageResponses, GetUserLanguageErrors, ThrowOnError>;
584
+ /**
585
+ * Set the caller's interface language, or clear it to follow their team's,
586
+ * else their browser's.
587
+ */
588
+ putUserLanguage<ThrowOnError extends boolean = false>(options: Options<PutUserLanguageData, ThrowOnError>): RequestResult<PutUserLanguageResponses, PutUserLanguageErrors, ThrowOnError>;
589
+ /**
590
+ * Gets the calling user's info which matches what was given in the **deprecated**
591
+ * getUserPermissions query in our graphql api.
592
+ * This will eventually be removed and optimized to use smaller calls that grab
593
+ * what is needed for various parts of the UI.
594
+ */
595
+ getLegacyUserPermissions<ThrowOnError extends boolean = false>(options?: Options<GetLegacyUserPermissionsData, ThrowOnError>): RequestResult<GetLegacyUserPermissionsResponses, GetLegacyUserPermissionsErrors, ThrowOnError>;
596
+ /**
597
+ * Returns whether or not a given idp link exists for a user
598
+ */
599
+ getUserLinkExists<ThrowOnError extends boolean = false>(options: Options<GetUserLinkExistsData, ThrowOnError>): RequestResult<GetUserLinkExistsResponses, GetUserLinkExistsErrors, ThrowOnError>;
600
+ /**
601
+ * Deletes the user who calls this endpoint
602
+ */
603
+ deleteUser<ThrowOnError extends boolean = false>(options?: Options<DeleteUserData, ThrowOnError>): RequestResult<DeleteUserResponses, DeleteUserErrors, ThrowOnError>;
604
+ /**
605
+ * Gets the calling user's info
606
+ */
607
+ getUserInfo<ThrowOnError extends boolean = false>(options?: Options<GetUserInfoData, ThrowOnError>): RequestResult<GetUserInfoResponses, GetUserInfoErrors, ThrowOnError>;
608
+ /**
609
+ * Retrieves the name of a particular user.
610
+ */
611
+ getUserName<ThrowOnError extends boolean = false>(options?: Options<GetUserNameData, ThrowOnError>): RequestResult<GetUserNameResponses, GetUserNameErrors, ThrowOnError>;
612
+ /**
613
+ * Sets the name of a particular user
614
+ */
615
+ putUserName<ThrowOnError extends boolean = false>(options?: Options<PutUserNameData, ThrowOnError>): RequestResult<PutUserNameResponses, PutUserNameErrors, ThrowOnError>;
616
+ /**
617
+ * Updates the user's onboarding.
618
+ */
619
+ patchUserOnboarding<ThrowOnError extends boolean = false>(options: Options<PatchUserOnboardingData, ThrowOnError>): RequestResult<PatchUserOnboardingResponses, PatchUserOnboardingErrors, ThrowOnError>;
620
+ /**
621
+ * Retrieves the users organization if present.
622
+ * Returns NO_CONTENT if the user is a not part of an organization.
623
+ */
624
+ getUserOrganization<ThrowOnError extends boolean = false>(options?: Options<GetUserOrganizationData, ThrowOnError>): RequestResult<GetUserOrganizationResponses, GetUserOrganizationErrors, ThrowOnError>;
625
+ /**
626
+ * Sets the profile picture URL for a particular user
627
+ */
628
+ putProfilePicture<ThrowOnError extends boolean = false>(options: Options<PutProfilePictureData, ThrowOnError>): RequestResult<PutProfilePictureResponses, PutProfilePictureErrors, ThrowOnError>;
629
+ /**
630
+ * Reserves storage for a new profile picture. Static file storage has no
631
+ * RoxDB, so it cannot check API keys; this route lets key holders upload.
632
+ */
633
+ createProfilePictureUpload<ThrowOnError extends boolean = false>(options: Options<CreateProfilePictureUploadData, ThrowOnError>): RequestResult<CreateProfilePictureUploadResponses, CreateProfilePictureUploadErrors, ThrowOnError>;
634
+ /**
635
+ * Sets the caller's profile picture to an image they uploaded.
636
+ */
637
+ putProfilePictureFile<ThrowOnError extends boolean = false>(options: Options<PutProfilePictureFileData, ThrowOnError>): RequestResult<PutProfilePictureFileResponses, PutProfilePictureFileErrors, ThrowOnError>;
638
+ /**
639
+ * Retrieves profile picture URLs for a list of users
640
+ */
641
+ postProfilePictures<ThrowOnError extends boolean = false>(options: Options<PostProfilePicturesData, ThrowOnError>): RequestResult<PostProfilePicturesResponses, PostProfilePicturesErrors, ThrowOnError>;
642
+ /**
643
+ * Retrieves the users quota.
644
+ * Returns NO_CONTENT if the user is a premium user with no quota.
645
+ */
646
+ getUserQuota<ThrowOnError extends boolean = false>(options?: Options<GetUserQuotaData, ThrowOnError>): RequestResult<GetUserQuotaResponses, GetUserQuotaErrors, ThrowOnError>;
647
+ /**
648
+ * Creates a Stripe checkout session for the user to subscribe.
649
+ */
650
+ createCheckoutSessionV2<ThrowOnError extends boolean = false>(options: Options<CreateCheckoutSessionV2Data, ThrowOnError>): RequestResult<CreateCheckoutSessionV2Responses, CreateCheckoutSessionV2Errors, ThrowOnError>;
651
+ /**
652
+ * Read subscription state for the authenticated user's seat.
653
+ */
654
+ getSubscriptionStatus<ThrowOnError extends boolean = false>(options?: Options<GetSubscriptionStatusData, ThrowOnError>): RequestResult<GetSubscriptionStatusResponses, GetSubscriptionStatusErrors, ThrowOnError>;
655
+ /**
656
+ * Changes the caller's paid plan. Upgrades are prorated immediately;
657
+ * downgrades retain the active plan until renewal. Selecting the active plan
658
+ * cancels a pending downgrade without charging or resetting usage.
659
+ */
660
+ changePlan<ThrowOnError extends boolean = false>(options: Options<ChangePlanData, ThrowOnError>): RequestResult<ChangePlanResponses, ChangePlanErrors, ThrowOnError>;
661
+ /**
662
+ * Creates a Stripe billing portal session.
663
+ */
664
+ createPortalSession<ThrowOnError extends boolean = false>(options: Options<CreatePortalSessionData, ThrowOnError>): RequestResult<CreatePortalSessionResponses, CreatePortalSessionErrors, ThrowOnError>;
665
+ /**
666
+ * Read the caller's eligibility; checkout revalidates before granting a trial.
667
+ */
668
+ getTrialEligibility<ThrowOnError extends boolean = false>(options?: Options<GetTrialEligibilityData, ThrowOnError>): RequestResult<GetTrialEligibilityResponses, GetTrialEligibilityErrors, ThrowOnError>;
669
+ /**
670
+ * Updates the user's tutorialComplete flag.
671
+ */
672
+ patchUserTutorial<ThrowOnError extends boolean = false>(options: Options<PatchUserTutorialData, ThrowOnError>): RequestResult<PatchUserTutorialResponses, PatchUserTutorialErrors, ThrowOnError>;
673
+ }
674
+ export {};