@studyfetch/sdk 1.1.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (552) hide show
  1. package/CHANGELOG.md +36 -15
  2. package/README.md +62 -17
  3. package/client.d.mts +1 -4
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +1 -4
  6. package/client.d.ts.map +1 -1
  7. package/client.js +3 -16
  8. package/client.js.map +1 -1
  9. package/client.mjs +3 -16
  10. package/client.mjs.map +1 -1
  11. package/internal/qs/formats.d.mts +7 -0
  12. package/internal/qs/formats.d.mts.map +1 -0
  13. package/internal/qs/formats.d.ts +7 -0
  14. package/internal/qs/formats.d.ts.map +1 -0
  15. package/internal/qs/formats.js +13 -0
  16. package/internal/qs/formats.js.map +1 -0
  17. package/internal/qs/formats.mjs +9 -0
  18. package/internal/qs/formats.mjs.map +1 -0
  19. package/internal/qs/index.d.mts +10 -0
  20. package/internal/qs/index.d.mts.map +1 -0
  21. package/internal/qs/index.d.ts +10 -0
  22. package/internal/qs/index.d.ts.map +1 -0
  23. package/internal/qs/index.js +14 -0
  24. package/internal/qs/index.js.map +1 -0
  25. package/internal/qs/index.mjs +10 -0
  26. package/internal/qs/index.mjs.map +1 -0
  27. package/internal/qs/stringify.d.mts +3 -0
  28. package/internal/qs/stringify.d.mts.map +1 -0
  29. package/internal/qs/stringify.d.ts +3 -0
  30. package/internal/qs/stringify.d.ts.map +1 -0
  31. package/internal/qs/stringify.js +277 -0
  32. package/internal/qs/stringify.js.map +1 -0
  33. package/internal/qs/stringify.mjs +274 -0
  34. package/internal/qs/stringify.mjs.map +1 -0
  35. package/internal/qs/types.d.mts +57 -0
  36. package/internal/qs/types.d.mts.map +1 -0
  37. package/internal/qs/types.d.ts +57 -0
  38. package/internal/qs/types.d.ts.map +1 -0
  39. package/internal/qs/types.js +3 -0
  40. package/internal/qs/types.js.map +1 -0
  41. package/internal/qs/types.mjs +2 -0
  42. package/internal/qs/types.mjs.map +1 -0
  43. package/internal/qs/utils.d.mts +15 -0
  44. package/internal/qs/utils.d.mts.map +1 -0
  45. package/internal/qs/utils.d.ts +15 -0
  46. package/internal/qs/utils.d.ts.map +1 -0
  47. package/internal/qs/utils.js +230 -0
  48. package/internal/qs/utils.js.map +1 -0
  49. package/internal/qs/utils.mjs +217 -0
  50. package/internal/qs/utils.mjs.map +1 -0
  51. package/internal/utils/log.d.mts.map +1 -1
  52. package/internal/utils/log.d.ts.map +1 -1
  53. package/internal/utils/log.js +2 -1
  54. package/internal/utils/log.js.map +1 -1
  55. package/internal/utils/log.mjs +2 -1
  56. package/internal/utils/log.mjs.map +1 -1
  57. package/package.json +1 -1
  58. package/resources/v1/admin/admin.d.mts +6 -0
  59. package/resources/v1/admin/admin.d.mts.map +1 -1
  60. package/resources/v1/admin/admin.d.ts +6 -0
  61. package/resources/v1/admin/admin.d.ts.map +1 -1
  62. package/resources/v1/admin/admin.js +6 -0
  63. package/resources/v1/admin/admin.js.map +1 -1
  64. package/resources/v1/admin/admin.mjs +6 -0
  65. package/resources/v1/admin/admin.mjs.map +1 -1
  66. package/resources/v1/admin/models.d.mts +6 -0
  67. package/resources/v1/admin/models.d.mts.map +1 -1
  68. package/resources/v1/admin/models.d.ts +6 -0
  69. package/resources/v1/admin/models.d.ts.map +1 -1
  70. package/resources/v1/admin/models.js +6 -0
  71. package/resources/v1/admin/models.js.map +1 -1
  72. package/resources/v1/admin/models.mjs +6 -0
  73. package/resources/v1/admin/models.mjs.map +1 -1
  74. package/resources/v1/admin/organization-invites.d.mts +26 -0
  75. package/resources/v1/admin/organization-invites.d.mts.map +1 -1
  76. package/resources/v1/admin/organization-invites.d.ts +26 -0
  77. package/resources/v1/admin/organization-invites.d.ts.map +1 -1
  78. package/resources/v1/admin/organization-invites.js +26 -0
  79. package/resources/v1/admin/organization-invites.js.map +1 -1
  80. package/resources/v1/admin/organization-invites.mjs +26 -0
  81. package/resources/v1/admin/organization-invites.mjs.map +1 -1
  82. package/resources/v1/admin/organizations/models/excluded.d.mts +16 -0
  83. package/resources/v1/admin/organizations/models/excluded.d.mts.map +1 -1
  84. package/resources/v1/admin/organizations/models/excluded.d.ts +16 -0
  85. package/resources/v1/admin/organizations/models/excluded.d.ts.map +1 -1
  86. package/resources/v1/admin/organizations/models/excluded.js +16 -0
  87. package/resources/v1/admin/organizations/models/excluded.js.map +1 -1
  88. package/resources/v1/admin/organizations/models/excluded.mjs +16 -0
  89. package/resources/v1/admin/organizations/models/excluded.mjs.map +1 -1
  90. package/resources/v1/admin/organizations/organizations.d.mts +6 -0
  91. package/resources/v1/admin/organizations/organizations.d.mts.map +1 -1
  92. package/resources/v1/admin/organizations/organizations.d.ts +6 -0
  93. package/resources/v1/admin/organizations/organizations.d.ts.map +1 -1
  94. package/resources/v1/admin/organizations/organizations.js +6 -0
  95. package/resources/v1/admin/organizations/organizations.js.map +1 -1
  96. package/resources/v1/admin/organizations/organizations.mjs +6 -0
  97. package/resources/v1/admin/organizations/organizations.mjs.map +1 -1
  98. package/resources/v1/audio-recaps/audio-recaps.d.mts +24 -0
  99. package/resources/v1/audio-recaps/audio-recaps.d.mts.map +1 -1
  100. package/resources/v1/audio-recaps/audio-recaps.d.ts +24 -0
  101. package/resources/v1/audio-recaps/audio-recaps.d.ts.map +1 -1
  102. package/resources/v1/audio-recaps/audio-recaps.js +24 -0
  103. package/resources/v1/audio-recaps/audio-recaps.js.map +1 -1
  104. package/resources/v1/audio-recaps/audio-recaps.mjs +24 -0
  105. package/resources/v1/audio-recaps/audio-recaps.mjs.map +1 -1
  106. package/resources/v1/audio-recaps/sections.d.mts +21 -0
  107. package/resources/v1/audio-recaps/sections.d.mts.map +1 -1
  108. package/resources/v1/audio-recaps/sections.d.ts +21 -0
  109. package/resources/v1/audio-recaps/sections.d.ts.map +1 -1
  110. package/resources/v1/audio-recaps/sections.js +18 -0
  111. package/resources/v1/audio-recaps/sections.js.map +1 -1
  112. package/resources/v1/audio-recaps/sections.mjs +18 -0
  113. package/resources/v1/audio-recaps/sections.mjs.map +1 -1
  114. package/resources/v1/auth/auth.d.mts +108 -7
  115. package/resources/v1/auth/auth.d.mts.map +1 -1
  116. package/resources/v1/auth/auth.d.ts +108 -7
  117. package/resources/v1/auth/auth.d.ts.map +1 -1
  118. package/resources/v1/auth/auth.js +80 -8
  119. package/resources/v1/auth/auth.js.map +1 -1
  120. package/resources/v1/auth/auth.mjs +80 -8
  121. package/resources/v1/auth/auth.mjs.map +1 -1
  122. package/resources/v1/auth/index.d.mts +2 -2
  123. package/resources/v1/auth/index.d.mts.map +1 -1
  124. package/resources/v1/auth/index.d.ts +2 -2
  125. package/resources/v1/auth/index.d.ts.map +1 -1
  126. package/resources/v1/auth/index.js.map +1 -1
  127. package/resources/v1/auth/index.mjs.map +1 -1
  128. package/resources/v1/auth/login.d.mts +60 -3
  129. package/resources/v1/auth/login.d.mts.map +1 -1
  130. package/resources/v1/auth/login.d.ts +60 -3
  131. package/resources/v1/auth/login.d.ts.map +1 -1
  132. package/resources/v1/auth/login.js +34 -1
  133. package/resources/v1/auth/login.js.map +1 -1
  134. package/resources/v1/auth/login.mjs +34 -1
  135. package/resources/v1/auth/login.mjs.map +1 -1
  136. package/resources/v1/auth/number-2fa.d.mts +63 -1
  137. package/resources/v1/auth/number-2fa.d.mts.map +1 -1
  138. package/resources/v1/auth/number-2fa.d.ts +63 -1
  139. package/resources/v1/auth/number-2fa.d.ts.map +1 -1
  140. package/resources/v1/auth/number-2fa.js +52 -6
  141. package/resources/v1/auth/number-2fa.js.map +1 -1
  142. package/resources/v1/auth/number-2fa.mjs +52 -6
  143. package/resources/v1/auth/number-2fa.mjs.map +1 -1
  144. package/resources/v1/auth/organization-invites.d.mts +6 -0
  145. package/resources/v1/auth/organization-invites.d.mts.map +1 -1
  146. package/resources/v1/auth/organization-invites.d.ts +6 -0
  147. package/resources/v1/auth/organization-invites.d.ts.map +1 -1
  148. package/resources/v1/auth/organization-invites.js +6 -0
  149. package/resources/v1/auth/organization-invites.js.map +1 -1
  150. package/resources/v1/auth/organization-invites.mjs +6 -0
  151. package/resources/v1/auth/organization-invites.mjs.map +1 -1
  152. package/resources/v1/chat/chat.d.mts +131 -6
  153. package/resources/v1/chat/chat.d.mts.map +1 -1
  154. package/resources/v1/chat/chat.d.ts +131 -6
  155. package/resources/v1/chat/chat.d.ts.map +1 -1
  156. package/resources/v1/chat/chat.js +55 -13
  157. package/resources/v1/chat/chat.js.map +1 -1
  158. package/resources/v1/chat/chat.mjs +55 -13
  159. package/resources/v1/chat/chat.mjs.map +1 -1
  160. package/resources/v1/chat/index.d.mts +1 -1
  161. package/resources/v1/chat/index.d.mts.map +1 -1
  162. package/resources/v1/chat/index.d.ts +1 -1
  163. package/resources/v1/chat/index.d.ts.map +1 -1
  164. package/resources/v1/chat/sessions.d.mts +14 -0
  165. package/resources/v1/chat/sessions.d.mts.map +1 -1
  166. package/resources/v1/chat/sessions.d.ts +14 -0
  167. package/resources/v1/chat/sessions.d.ts.map +1 -1
  168. package/resources/v1/chat/sessions.js +14 -0
  169. package/resources/v1/chat/sessions.js.map +1 -1
  170. package/resources/v1/chat/sessions.mjs +14 -0
  171. package/resources/v1/chat/sessions.mjs.map +1 -1
  172. package/resources/v1/chat/test.d.mts +12 -0
  173. package/resources/v1/chat/test.d.mts.map +1 -1
  174. package/resources/v1/chat/test.d.ts +12 -0
  175. package/resources/v1/chat/test.d.ts.map +1 -1
  176. package/resources/v1/chat/test.js +12 -0
  177. package/resources/v1/chat/test.js.map +1 -1
  178. package/resources/v1/chat/test.mjs +12 -0
  179. package/resources/v1/chat/test.mjs.map +1 -1
  180. package/resources/v1/components.d.mts +461 -7
  181. package/resources/v1/components.d.mts.map +1 -1
  182. package/resources/v1/components.d.ts +461 -7
  183. package/resources/v1/components.d.ts.map +1 -1
  184. package/resources/v1/components.js +77 -25
  185. package/resources/v1/components.js.map +1 -1
  186. package/resources/v1/components.mjs +77 -25
  187. package/resources/v1/components.mjs.map +1 -1
  188. package/resources/v1/embed/component.d.mts +31 -0
  189. package/resources/v1/embed/component.d.mts.map +1 -1
  190. package/resources/v1/embed/component.d.ts +31 -0
  191. package/resources/v1/embed/component.d.ts.map +1 -1
  192. package/resources/v1/embed/component.js +23 -1
  193. package/resources/v1/embed/component.js.map +1 -1
  194. package/resources/v1/embed/component.mjs +23 -1
  195. package/resources/v1/embed/component.mjs.map +1 -1
  196. package/resources/v1/embed/embed.d.mts +32 -6
  197. package/resources/v1/embed/embed.d.mts.map +1 -1
  198. package/resources/v1/embed/embed.d.ts +32 -6
  199. package/resources/v1/embed/embed.d.ts.map +1 -1
  200. package/resources/v1/embed/embed.js +27 -11
  201. package/resources/v1/embed/embed.js.map +1 -1
  202. package/resources/v1/embed/embed.mjs +27 -11
  203. package/resources/v1/embed/embed.mjs.map +1 -1
  204. package/resources/v1/embed/index.d.mts +1 -1
  205. package/resources/v1/embed/index.d.mts.map +1 -1
  206. package/resources/v1/embed/index.d.ts +1 -1
  207. package/resources/v1/embed/index.d.ts.map +1 -1
  208. package/resources/v1/embed/index.js.map +1 -1
  209. package/resources/v1/embed/index.mjs.map +1 -1
  210. package/resources/v1/explainers.d.mts +21 -2
  211. package/resources/v1/explainers.d.mts.map +1 -1
  212. package/resources/v1/explainers.d.ts +21 -2
  213. package/resources/v1/explainers.d.ts.map +1 -1
  214. package/resources/v1/explainers.js +19 -1
  215. package/resources/v1/explainers.js.map +1 -1
  216. package/resources/v1/explainers.mjs +19 -1
  217. package/resources/v1/explainers.mjs.map +1 -1
  218. package/resources/v1/flashcards.d.mts +242 -16
  219. package/resources/v1/flashcards.d.mts.map +1 -1
  220. package/resources/v1/flashcards.d.ts +242 -16
  221. package/resources/v1/flashcards.d.ts.map +1 -1
  222. package/resources/v1/flashcards.js +78 -21
  223. package/resources/v1/flashcards.js.map +1 -1
  224. package/resources/v1/flashcards.mjs +78 -21
  225. package/resources/v1/flashcards.mjs.map +1 -1
  226. package/resources/v1/folders.d.mts +93 -4
  227. package/resources/v1/folders.d.mts.map +1 -1
  228. package/resources/v1/folders.d.ts +93 -4
  229. package/resources/v1/folders.d.ts.map +1 -1
  230. package/resources/v1/folders.js +72 -9
  231. package/resources/v1/folders.js.map +1 -1
  232. package/resources/v1/folders.mjs +72 -9
  233. package/resources/v1/folders.mjs.map +1 -1
  234. package/resources/v1/index.d.mts +12 -11
  235. package/resources/v1/index.d.mts.map +1 -1
  236. package/resources/v1/index.d.ts +12 -11
  237. package/resources/v1/index.d.ts.map +1 -1
  238. package/resources/v1/index.js +3 -1
  239. package/resources/v1/index.js.map +1 -1
  240. package/resources/v1/index.mjs +5 -4
  241. package/resources/v1/index.mjs.map +1 -1
  242. package/resources/v1/materials/bulk.d.mts +6 -0
  243. package/resources/v1/materials/bulk.d.mts.map +1 -1
  244. package/resources/v1/materials/bulk.d.ts +6 -0
  245. package/resources/v1/materials/bulk.d.ts.map +1 -1
  246. package/resources/v1/materials/bulk.js +6 -0
  247. package/resources/v1/materials/bulk.js.map +1 -1
  248. package/resources/v1/materials/bulk.mjs +6 -0
  249. package/resources/v1/materials/bulk.mjs.map +1 -1
  250. package/resources/v1/materials/index.d.mts +2 -2
  251. package/resources/v1/materials/index.d.mts.map +1 -1
  252. package/resources/v1/materials/index.d.ts +2 -2
  253. package/resources/v1/materials/index.d.ts.map +1 -1
  254. package/resources/v1/materials/index.js.map +1 -1
  255. package/resources/v1/materials/index.mjs +2 -2
  256. package/resources/v1/materials/index.mjs.map +1 -1
  257. package/resources/v1/materials/materials.d.mts +310 -7
  258. package/resources/v1/materials/materials.d.mts.map +1 -1
  259. package/resources/v1/materials/materials.d.ts +310 -7
  260. package/resources/v1/materials/materials.d.ts.map +1 -1
  261. package/resources/v1/materials/materials.js +84 -15
  262. package/resources/v1/materials/materials.js.map +1 -1
  263. package/resources/v1/materials/materials.mjs +85 -16
  264. package/resources/v1/materials/materials.mjs.map +1 -1
  265. package/resources/v1/materials/test.d.mts +28 -4
  266. package/resources/v1/materials/test.d.mts.map +1 -1
  267. package/resources/v1/materials/test.d.ts +28 -4
  268. package/resources/v1/materials/test.d.ts.map +1 -1
  269. package/resources/v1/materials/test.js +31 -7
  270. package/resources/v1/materials/test.js.map +1 -1
  271. package/resources/v1/materials/test.mjs +31 -7
  272. package/resources/v1/materials/test.mjs.map +1 -1
  273. package/resources/v1/materials/upload.d.mts +188 -3
  274. package/resources/v1/materials/upload.d.mts.map +1 -1
  275. package/resources/v1/materials/upload.d.ts +188 -3
  276. package/resources/v1/materials/upload.d.ts.map +1 -1
  277. package/resources/v1/materials/upload.js +42 -11
  278. package/resources/v1/materials/upload.js.map +1 -1
  279. package/resources/v1/materials/upload.mjs +42 -11
  280. package/resources/v1/materials/upload.mjs.map +1 -1
  281. package/resources/v1/organizations/api-keys.d.mts +32 -1
  282. package/resources/v1/organizations/api-keys.d.mts.map +1 -1
  283. package/resources/v1/organizations/api-keys.d.ts +32 -1
  284. package/resources/v1/organizations/api-keys.d.ts.map +1 -1
  285. package/resources/v1/organizations/api-keys.js +24 -1
  286. package/resources/v1/organizations/api-keys.js.map +1 -1
  287. package/resources/v1/organizations/api-keys.mjs +24 -1
  288. package/resources/v1/organizations/api-keys.mjs.map +1 -1
  289. package/resources/v1/organizations/index.d.mts +1 -1
  290. package/resources/v1/organizations/index.d.mts.map +1 -1
  291. package/resources/v1/organizations/index.d.ts +1 -1
  292. package/resources/v1/organizations/index.d.ts.map +1 -1
  293. package/resources/v1/organizations/index.js.map +1 -1
  294. package/resources/v1/organizations/index.mjs.map +1 -1
  295. package/resources/v1/organizations/logo/logo.d.mts +6 -0
  296. package/resources/v1/organizations/logo/logo.d.mts.map +1 -1
  297. package/resources/v1/organizations/logo/logo.d.ts +6 -0
  298. package/resources/v1/organizations/logo/logo.d.ts.map +1 -1
  299. package/resources/v1/organizations/logo/logo.js +6 -0
  300. package/resources/v1/organizations/logo/logo.js.map +1 -1
  301. package/resources/v1/organizations/logo/logo.mjs +6 -0
  302. package/resources/v1/organizations/logo/logo.mjs.map +1 -1
  303. package/resources/v1/organizations/logo/upload.d.mts +12 -0
  304. package/resources/v1/organizations/logo/upload.d.mts.map +1 -1
  305. package/resources/v1/organizations/logo/upload.d.ts +12 -0
  306. package/resources/v1/organizations/logo/upload.d.ts.map +1 -1
  307. package/resources/v1/organizations/logo/upload.js +12 -0
  308. package/resources/v1/organizations/logo/upload.js.map +1 -1
  309. package/resources/v1/organizations/logo/upload.mjs +12 -0
  310. package/resources/v1/organizations/logo/upload.mjs.map +1 -1
  311. package/resources/v1/organizations/organizations.d.mts +14 -2
  312. package/resources/v1/organizations/organizations.d.mts.map +1 -1
  313. package/resources/v1/organizations/organizations.d.ts +14 -2
  314. package/resources/v1/organizations/organizations.d.ts.map +1 -1
  315. package/resources/v1/organizations/organizations.js +12 -0
  316. package/resources/v1/organizations/organizations.js.map +1 -1
  317. package/resources/v1/organizations/organizations.mjs +12 -0
  318. package/resources/v1/organizations/organizations.mjs.map +1 -1
  319. package/resources/v1/organizations/profile/models.d.mts +6 -0
  320. package/resources/v1/organizations/profile/models.d.mts.map +1 -1
  321. package/resources/v1/organizations/profile/models.d.ts +6 -0
  322. package/resources/v1/organizations/profile/models.d.ts.map +1 -1
  323. package/resources/v1/organizations/profile/models.js +6 -0
  324. package/resources/v1/organizations/profile/models.js.map +1 -1
  325. package/resources/v1/organizations/profile/models.mjs +6 -0
  326. package/resources/v1/organizations/profile/models.mjs.map +1 -1
  327. package/resources/v1/organizations/profile/profile.d.mts +14 -0
  328. package/resources/v1/organizations/profile/profile.d.mts.map +1 -1
  329. package/resources/v1/organizations/profile/profile.d.ts +14 -0
  330. package/resources/v1/organizations/profile/profile.d.ts.map +1 -1
  331. package/resources/v1/organizations/profile/profile.js +14 -0
  332. package/resources/v1/organizations/profile/profile.js.map +1 -1
  333. package/resources/v1/organizations/profile/profile.mjs +14 -0
  334. package/resources/v1/organizations/profile/profile.mjs.map +1 -1
  335. package/resources/v1/organizations/profile/team.d.mts +40 -0
  336. package/resources/v1/organizations/profile/team.d.mts.map +1 -1
  337. package/resources/v1/organizations/profile/team.d.ts +40 -0
  338. package/resources/v1/organizations/profile/team.d.ts.map +1 -1
  339. package/resources/v1/organizations/profile/team.js +40 -0
  340. package/resources/v1/organizations/profile/team.js.map +1 -1
  341. package/resources/v1/organizations/profile/team.mjs +40 -0
  342. package/resources/v1/organizations/profile/team.mjs.map +1 -1
  343. package/resources/v1/organizations/team/invite.d.mts +14 -0
  344. package/resources/v1/organizations/team/invite.d.mts.map +1 -1
  345. package/resources/v1/organizations/team/invite.d.ts +14 -0
  346. package/resources/v1/organizations/team/invite.d.ts.map +1 -1
  347. package/resources/v1/organizations/team/invite.js +14 -0
  348. package/resources/v1/organizations/team/invite.js.map +1 -1
  349. package/resources/v1/organizations/team/invite.mjs +14 -0
  350. package/resources/v1/organizations/team/invite.mjs.map +1 -1
  351. package/resources/v1/organizations/team/team.d.mts +42 -0
  352. package/resources/v1/organizations/team/team.d.mts.map +1 -1
  353. package/resources/v1/organizations/team/team.d.ts +42 -0
  354. package/resources/v1/organizations/team/team.d.ts.map +1 -1
  355. package/resources/v1/organizations/team/team.js +42 -0
  356. package/resources/v1/organizations/team/team.js.map +1 -1
  357. package/resources/v1/organizations/team/team.mjs +42 -0
  358. package/resources/v1/organizations/team/team.mjs.map +1 -1
  359. package/resources/v1/organizations/theme.d.mts +12 -0
  360. package/resources/v1/organizations/theme.d.mts.map +1 -1
  361. package/resources/v1/organizations/theme.d.ts +12 -0
  362. package/resources/v1/organizations/theme.d.ts.map +1 -1
  363. package/resources/v1/organizations/theme.js +12 -0
  364. package/resources/v1/organizations/theme.js.map +1 -1
  365. package/resources/v1/organizations/theme.mjs +12 -0
  366. package/resources/v1/organizations/theme.mjs.map +1 -1
  367. package/resources/v1/organizations/usage.d.mts +8 -0
  368. package/resources/v1/organizations/usage.d.mts.map +1 -1
  369. package/resources/v1/organizations/usage.d.ts +8 -0
  370. package/resources/v1/organizations/usage.d.ts.map +1 -1
  371. package/resources/v1/organizations/usage.js +8 -0
  372. package/resources/v1/organizations/usage.js.map +1 -1
  373. package/resources/v1/organizations/usage.mjs +8 -0
  374. package/resources/v1/organizations/usage.mjs.map +1 -1
  375. package/resources/v1/scenarios/component.d.mts +33 -1
  376. package/resources/v1/scenarios/component.d.mts.map +1 -1
  377. package/resources/v1/scenarios/component.d.ts +33 -1
  378. package/resources/v1/scenarios/component.d.ts.map +1 -1
  379. package/resources/v1/scenarios/component.js +29 -1
  380. package/resources/v1/scenarios/component.js.map +1 -1
  381. package/resources/v1/scenarios/component.mjs +29 -1
  382. package/resources/v1/scenarios/component.mjs.map +1 -1
  383. package/resources/v1/scenarios/index.d.mts +2 -2
  384. package/resources/v1/scenarios/index.d.mts.map +1 -1
  385. package/resources/v1/scenarios/index.d.ts +2 -2
  386. package/resources/v1/scenarios/index.d.ts.map +1 -1
  387. package/resources/v1/scenarios/index.js.map +1 -1
  388. package/resources/v1/scenarios/index.mjs.map +1 -1
  389. package/resources/v1/scenarios/scenarios.d.mts +63 -4
  390. package/resources/v1/scenarios/scenarios.d.mts.map +1 -1
  391. package/resources/v1/scenarios/scenarios.d.ts +63 -4
  392. package/resources/v1/scenarios/scenarios.d.ts.map +1 -1
  393. package/resources/v1/scenarios/scenarios.js +58 -2
  394. package/resources/v1/scenarios/scenarios.js.map +1 -1
  395. package/resources/v1/scenarios/scenarios.mjs +58 -2
  396. package/resources/v1/scenarios/scenarios.mjs.map +1 -1
  397. package/resources/v1/scenarios/sessions.d.mts +12 -0
  398. package/resources/v1/scenarios/sessions.d.mts.map +1 -1
  399. package/resources/v1/scenarios/sessions.d.ts +12 -0
  400. package/resources/v1/scenarios/sessions.d.ts.map +1 -1
  401. package/resources/v1/scenarios/sessions.js +12 -0
  402. package/resources/v1/scenarios/sessions.js.map +1 -1
  403. package/resources/v1/scenarios/sessions.mjs +12 -0
  404. package/resources/v1/scenarios/sessions.mjs.map +1 -1
  405. package/resources/v1/scenarios/submissions/user.d.mts +12 -0
  406. package/resources/v1/scenarios/submissions/user.d.mts.map +1 -1
  407. package/resources/v1/scenarios/submissions/user.d.ts +12 -0
  408. package/resources/v1/scenarios/submissions/user.d.ts.map +1 -1
  409. package/resources/v1/scenarios/submissions/user.js +12 -0
  410. package/resources/v1/scenarios/submissions/user.js.map +1 -1
  411. package/resources/v1/scenarios/submissions/user.mjs +12 -0
  412. package/resources/v1/scenarios/submissions/user.mjs.map +1 -1
  413. package/resources/v1/tests/component.d.mts +6 -0
  414. package/resources/v1/tests/component.d.mts.map +1 -1
  415. package/resources/v1/tests/component.d.ts +6 -0
  416. package/resources/v1/tests/component.d.ts.map +1 -1
  417. package/resources/v1/tests/component.js +6 -0
  418. package/resources/v1/tests/component.js.map +1 -1
  419. package/resources/v1/tests/component.mjs +6 -0
  420. package/resources/v1/tests/component.mjs.map +1 -1
  421. package/resources/v1/tests/index.d.mts +1 -1
  422. package/resources/v1/tests/index.d.mts.map +1 -1
  423. package/resources/v1/tests/index.d.ts +1 -1
  424. package/resources/v1/tests/index.d.ts.map +1 -1
  425. package/resources/v1/tests/index.js.map +1 -1
  426. package/resources/v1/tests/index.mjs +1 -1
  427. package/resources/v1/tests/index.mjs.map +1 -1
  428. package/resources/v1/tests/tests.d.mts +98 -4
  429. package/resources/v1/tests/tests.d.mts.map +1 -1
  430. package/resources/v1/tests/tests.d.ts +98 -4
  431. package/resources/v1/tests/tests.d.ts.map +1 -1
  432. package/resources/v1/tests/tests.js +61 -4
  433. package/resources/v1/tests/tests.js.map +1 -1
  434. package/resources/v1/tests/tests.mjs +61 -4
  435. package/resources/v1/tests/tests.mjs.map +1 -1
  436. package/resources/v1/upload/component.d.mts +38 -0
  437. package/resources/v1/upload/component.d.mts.map +1 -0
  438. package/resources/v1/upload/component.d.ts +38 -0
  439. package/resources/v1/upload/component.d.ts.map +1 -0
  440. package/resources/v1/upload/component.js +63 -0
  441. package/resources/v1/upload/component.js.map +1 -0
  442. package/resources/v1/upload/component.mjs +59 -0
  443. package/resources/v1/upload/component.mjs.map +1 -0
  444. package/resources/v1/upload/index.d.mts +3 -0
  445. package/resources/v1/upload/index.d.mts.map +1 -0
  446. package/resources/v1/upload/index.d.ts +3 -0
  447. package/resources/v1/upload/index.d.ts.map +1 -0
  448. package/resources/v1/upload/index.js +9 -0
  449. package/resources/v1/upload/index.js.map +1 -0
  450. package/resources/v1/upload/index.mjs +4 -0
  451. package/resources/v1/upload/index.mjs.map +1 -0
  452. package/resources/v1/upload/upload.d.mts +10 -0
  453. package/resources/v1/upload/upload.d.mts.map +1 -0
  454. package/resources/v1/upload/upload.d.ts +10 -0
  455. package/resources/v1/upload/upload.d.ts.map +1 -0
  456. package/resources/v1/upload/upload.js +17 -0
  457. package/resources/v1/upload/upload.js.map +1 -0
  458. package/resources/v1/upload/upload.mjs +12 -0
  459. package/resources/v1/upload/upload.mjs.map +1 -0
  460. package/resources/v1/upload.d.mts +2 -0
  461. package/resources/v1/upload.d.mts.map +1 -0
  462. package/resources/v1/upload.d.ts +2 -0
  463. package/resources/v1/upload.d.ts.map +1 -0
  464. package/resources/v1/upload.js +6 -0
  465. package/resources/v1/upload.js.map +1 -0
  466. package/resources/v1/upload.mjs +3 -0
  467. package/resources/v1/upload.mjs.map +1 -0
  468. package/resources/v1/usage.d.mts +285 -9
  469. package/resources/v1/usage.d.mts.map +1 -1
  470. package/resources/v1/usage.d.ts +285 -9
  471. package/resources/v1/usage.d.ts.map +1 -1
  472. package/resources/v1/usage.js +76 -13
  473. package/resources/v1/usage.js.map +1 -1
  474. package/resources/v1/usage.mjs +76 -13
  475. package/resources/v1/usage.mjs.map +1 -1
  476. package/resources/v1/v1.d.mts +26 -22
  477. package/resources/v1/v1.d.mts.map +1 -1
  478. package/resources/v1/v1.d.ts +26 -22
  479. package/resources/v1/v1.d.ts.map +1 -1
  480. package/resources/v1/v1.js +4 -0
  481. package/resources/v1/v1.js.map +1 -1
  482. package/resources/v1/v1.mjs +7 -3
  483. package/resources/v1/v1.mjs.map +1 -1
  484. package/src/client.ts +4 -19
  485. package/src/internal/qs/LICENSE.md +13 -0
  486. package/src/internal/qs/README.md +3 -0
  487. package/src/internal/qs/formats.ts +10 -0
  488. package/src/internal/qs/index.ts +13 -0
  489. package/src/internal/qs/stringify.ts +385 -0
  490. package/src/internal/qs/types.ts +71 -0
  491. package/src/internal/qs/utils.ts +265 -0
  492. package/src/internal/utils/log.ts +1 -0
  493. package/src/resources/v1/admin/admin.ts +6 -0
  494. package/src/resources/v1/admin/models.ts +6 -0
  495. package/src/resources/v1/admin/organization-invites.ts +26 -0
  496. package/src/resources/v1/admin/organizations/models/excluded.ts +16 -0
  497. package/src/resources/v1/admin/organizations/organizations.ts +6 -0
  498. package/src/resources/v1/audio-recaps/audio-recaps.ts +24 -0
  499. package/src/resources/v1/audio-recaps/sections.ts +21 -0
  500. package/src/resources/v1/auth/auth.ts +132 -13
  501. package/src/resources/v1/auth/index.ts +4 -2
  502. package/src/resources/v1/auth/login.ts +68 -5
  503. package/src/resources/v1/auth/number-2fa.ts +77 -11
  504. package/src/resources/v1/auth/organization-invites.ts +6 -0
  505. package/src/resources/v1/chat/chat.ts +166 -19
  506. package/src/resources/v1/chat/index.ts +1 -1
  507. package/src/resources/v1/chat/sessions.ts +14 -0
  508. package/src/resources/v1/chat/test.ts +12 -0
  509. package/src/resources/v1/components.ts +588 -33
  510. package/src/resources/v1/embed/component.ts +34 -1
  511. package/src/resources/v1/embed/embed.ts +34 -21
  512. package/src/resources/v1/embed/index.ts +1 -1
  513. package/src/resources/v1/explainers.ts +27 -2
  514. package/src/resources/v1/flashcards.ts +292 -31
  515. package/src/resources/v1/folders.ts +111 -9
  516. package/src/resources/v1/index.ts +45 -15
  517. package/src/resources/v1/materials/bulk.ts +6 -0
  518. package/src/resources/v1/materials/index.ts +16 -2
  519. package/src/resources/v1/materials/materials.ts +395 -20
  520. package/src/resources/v1/materials/test.ts +31 -7
  521. package/src/resources/v1/materials/upload.ts +245 -11
  522. package/src/resources/v1/organizations/api-keys.ts +35 -1
  523. package/src/resources/v1/organizations/index.ts +1 -1
  524. package/src/resources/v1/organizations/logo/logo.ts +6 -0
  525. package/src/resources/v1/organizations/logo/upload.ts +12 -0
  526. package/src/resources/v1/organizations/organizations.ts +14 -2
  527. package/src/resources/v1/organizations/profile/models.ts +6 -0
  528. package/src/resources/v1/organizations/profile/profile.ts +14 -0
  529. package/src/resources/v1/organizations/profile/team.ts +40 -0
  530. package/src/resources/v1/organizations/team/invite.ts +14 -0
  531. package/src/resources/v1/organizations/team/team.ts +42 -0
  532. package/src/resources/v1/organizations/theme.ts +12 -0
  533. package/src/resources/v1/organizations/usage.ts +8 -0
  534. package/src/resources/v1/scenarios/component.ts +37 -1
  535. package/src/resources/v1/scenarios/index.ts +2 -2
  536. package/src/resources/v1/scenarios/scenarios.ts +73 -4
  537. package/src/resources/v1/scenarios/sessions.ts +12 -0
  538. package/src/resources/v1/scenarios/submissions/user.ts +12 -0
  539. package/src/resources/v1/tests/component.ts +6 -0
  540. package/src/resources/v1/tests/index.ts +7 -1
  541. package/src/resources/v1/tests/tests.ts +116 -4
  542. package/src/resources/v1/upload/component.ts +65 -0
  543. package/src/resources/v1/upload/index.ts +4 -0
  544. package/src/resources/v1/upload/upload.ts +15 -0
  545. package/src/resources/v1/upload.ts +3 -0
  546. package/src/resources/v1/usage.ts +431 -16
  547. package/src/resources/v1/v1.ts +98 -20
  548. package/src/version.ts +1 -1
  549. package/version.d.mts +1 -1
  550. package/version.d.ts +1 -1
  551. package/version.js +1 -1
  552. package/version.mjs +1 -1
@@ -0,0 +1,12 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import * as ComponentAPI from "./component.mjs";
4
+ import { Component } from "./component.mjs";
5
+ export class Upload extends APIResource {
6
+ constructor() {
7
+ super(...arguments);
8
+ this.component = new ComponentAPI.Component(this._client);
9
+ }
10
+ }
11
+ Upload.Component = Component;
12
+ //# sourceMappingURL=upload.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"upload.mjs","sourceRoot":"","sources":["../../../src/resources/v1/upload/upload.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,EAAE,SAAS,EAAE;AAEpB,MAAM,OAAO,MAAO,SAAQ,WAAW;IAAvC;;QACE,cAAS,GAA2B,IAAI,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC;CAAA;AAED,MAAM,CAAC,SAAS,GAAG,SAAS,CAAC"}
@@ -0,0 +1,2 @@
1
+ export * from "./upload/index.mjs";
2
+ //# sourceMappingURL=upload.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"upload.d.mts","sourceRoot":"","sources":["../../src/resources/v1/upload.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from "./upload/index.js";
2
+ //# sourceMappingURL=upload.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../src/resources/v1/upload.ts"],"names":[],"mappings":""}
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ const tslib_1 = require("../../internal/tslib.js");
5
+ tslib_1.__exportStar(require("./upload/index.js"), exports);
6
+ //# sourceMappingURL=upload.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/resources/v1/upload.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAA+B"}
@@ -0,0 +1,3 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export * from "./upload/index.mjs";
3
+ //# sourceMappingURL=upload.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"upload.mjs","sourceRoot":"","sources":["../../src/resources/v1/upload.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
@@ -2,18 +2,294 @@ import { APIResource } from "../../core/resource.mjs";
2
2
  import { APIPromise } from "../../core/api-promise.mjs";
3
3
  import { RequestOptions } from "../../internal/request-options.mjs";
4
4
  export declare class Usage extends APIResource {
5
- chat(body: UsageChatParams, options?: RequestOptions): APIPromise<void>;
6
- listEvents(options?: RequestOptions): APIPromise<void>;
7
- performance(options?: RequestOptions): APIPromise<void>;
8
- retrieveStats(options?: RequestOptions): APIPromise<void>;
9
- retrieveSummary(options?: RequestOptions): APIPromise<void>;
10
- track(body: UsageTrackParams, options?: RequestOptions): APIPromise<void>;
5
+ /**
6
+ * Get usage statistics
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * await client.v1.usage.getStats();
11
+ * ```
12
+ */
13
+ getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
14
+ /**
15
+ * Get usage summary
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * await client.v1.usage.getSummary({
20
+ * endDate: 'endDate',
21
+ * period: 'hourly',
22
+ * startDate: 'startDate',
23
+ * });
24
+ * ```
25
+ */
26
+ getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
27
+ /**
28
+ * Get usage events
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * await client.v1.usage.listEvents();
33
+ * ```
34
+ */
35
+ listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
36
+ /**
37
+ * Track chat usage
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * await client.v1.usage.trackChat({
42
+ * inputTokens: 0,
43
+ * model: 'openai:gpt-4.1',
44
+ * outputTokens: 0,
45
+ * sessionId: 'sessionId',
46
+ * });
47
+ * ```
48
+ */
49
+ trackChat(body: UsageTrackChatParams, options?: RequestOptions): APIPromise<void>;
50
+ /**
51
+ * Track general usage event
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * await client.v1.usage.trackEvent({
56
+ * eventType: 'material_created',
57
+ * });
58
+ * ```
59
+ */
60
+ trackEvent(body: UsageTrackEventParams, options?: RequestOptions): APIPromise<void>;
61
+ /**
62
+ * Track performance metrics
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * await client.v1.usage.trackPerformance();
67
+ * ```
68
+ */
69
+ trackPerformance(body: UsageTrackPerformanceParams, options?: RequestOptions): APIPromise<void>;
11
70
  }
12
- export interface UsageChatParams {
71
+ export interface UsageGetStatsParams {
72
+ /**
73
+ * End date for stats (ISO 8601)
74
+ */
75
+ endDate?: string;
76
+ /**
77
+ * Filter by group ID
78
+ */
79
+ groupId?: string;
80
+ /**
81
+ * Start date for stats (ISO 8601)
82
+ */
83
+ startDate?: string;
84
+ /**
85
+ * Filter by user ID
86
+ */
87
+ userId?: string;
13
88
  }
14
- export interface UsageTrackParams {
89
+ export interface UsageGetSummaryParams {
90
+ /**
91
+ * End date for summary (ISO 8601)
92
+ */
93
+ endDate: string;
94
+ /**
95
+ * Summary period
96
+ */
97
+ period: 'hourly' | 'daily' | 'monthly';
98
+ /**
99
+ * Start date for summary (ISO 8601)
100
+ */
101
+ startDate: string;
102
+ /**
103
+ * Group results by
104
+ */
105
+ groupBy?: 'user' | 'group' | 'model' | 'endpoint';
106
+ }
107
+ export interface UsageListEventsParams {
108
+ /**
109
+ * End date for filtering (ISO 8601)
110
+ */
111
+ endDate?: string;
112
+ /**
113
+ * Filter by event type
114
+ */
115
+ eventType?: 'material_created' | 'material_uploaded' | 'material_processed' | 'material_deleted' | 'component_created' | 'component_accessed' | 'component_deleted' | 'component_usage' | 'chat_message_sent' | 'chat_session_started' | 'chat_session_ended' | 'test_created' | 'test_started' | 'test_completed' | 'test_question_answered' | 'test_retaken' | 'audio_recap_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
116
+ /**
117
+ * Filter by group ID
118
+ */
119
+ groupId?: string;
120
+ /**
121
+ * Number of results to return
122
+ */
123
+ limit?: number;
124
+ /**
125
+ * Offset for pagination
126
+ */
127
+ offset?: number;
128
+ /**
129
+ * Filter by resource ID
130
+ */
131
+ resourceId?: string;
132
+ /**
133
+ * Start date for filtering (ISO 8601)
134
+ */
135
+ startDate?: string;
136
+ /**
137
+ * Filter by user ID
138
+ */
139
+ userId?: string;
140
+ }
141
+ export interface UsageTrackChatParams {
142
+ /**
143
+ * Number of input tokens
144
+ */
145
+ inputTokens: number;
146
+ /**
147
+ * AI model used
148
+ */
149
+ model: 'openai:gpt-4.1' | 'openai:gpt-4o' | 'openai:gpt-4o-mini' | 'openai:gpt-4' | 'openai:gpt-3.5-turbo' | 'openai:o1' | 'openai:o1-mini' | 'openai:o3-mini' | 'anthropic:claude-3-opus' | 'anthropic:claude-3-sonnet' | 'anthropic:claude-3-haiku' | 'google:gemini-pro' | 'meta:llama-3';
150
+ /**
151
+ * Number of output tokens
152
+ */
153
+ outputTokens: number;
154
+ /**
155
+ * Chat session ID
156
+ */
157
+ sessionId: string;
158
+ /**
159
+ * Component ID
160
+ */
161
+ componentId?: string;
162
+ /**
163
+ * Group ID
164
+ */
165
+ groupId?: string;
166
+ /**
167
+ * Additional metadata
168
+ */
169
+ metadata?: unknown;
170
+ /**
171
+ * Number of reasoning tokens
172
+ */
173
+ reasoningTokens?: number;
174
+ /**
175
+ * User ID
176
+ */
177
+ userId?: string;
178
+ }
179
+ export interface UsageTrackEventParams {
180
+ /**
181
+ * Type of usage event
182
+ */
183
+ eventType: 'material_created' | 'material_uploaded' | 'material_processed' | 'material_deleted' | 'component_created' | 'component_accessed' | 'component_deleted' | 'component_usage' | 'chat_message_sent' | 'chat_session_started' | 'chat_session_ended' | 'test_created' | 'test_started' | 'test_completed' | 'test_question_answered' | 'test_retaken' | 'audio_recap_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
184
+ /**
185
+ * Whether response was served from cache
186
+ */
187
+ cacheHit?: boolean;
188
+ /**
189
+ * Component name
190
+ */
191
+ componentName?: string;
192
+ /**
193
+ * Component type
194
+ */
195
+ componentType?: string;
196
+ /**
197
+ * Size of content in bytes
198
+ */
199
+ contentSize?: number;
200
+ /**
201
+ * API endpoint accessed
202
+ */
203
+ endpoint?: string;
204
+ /**
205
+ * File size in bytes
206
+ */
207
+ fileSize?: number;
208
+ /**
209
+ * File MIME type
210
+ */
211
+ fileType?: string;
212
+ /**
213
+ * Group ID for collaborative sessions
214
+ */
215
+ groupId?: string;
216
+ /**
217
+ * Number of input tokens
218
+ */
219
+ inputTokens?: number;
220
+ /**
221
+ * Client IP address
222
+ */
223
+ ipAddress?: string;
224
+ /**
225
+ * Additional metadata
226
+ */
227
+ metadata?: unknown;
228
+ /**
229
+ * HTTP method used
230
+ */
231
+ method?: string;
232
+ /**
233
+ * AI model used
234
+ */
235
+ model?: 'openai:gpt-4.1' | 'openai:gpt-4o' | 'openai:gpt-4o-mini' | 'openai:gpt-4' | 'openai:gpt-3.5-turbo' | 'openai:o1' | 'openai:o1-mini' | 'openai:o3-mini' | 'anthropic:claude-3-opus' | 'anthropic:claude-3-sonnet' | 'anthropic:claude-3-haiku' | 'google:gemini-pro' | 'meta:llama-3';
236
+ /**
237
+ * Number of output tokens
238
+ */
239
+ outputTokens?: number;
240
+ /**
241
+ * Performance metrics data
242
+ */
243
+ performanceData?: unknown;
244
+ /**
245
+ * Number of reasoning tokens
246
+ */
247
+ reasoningTokens?: number;
248
+ /**
249
+ * Resource ID being accessed
250
+ */
251
+ resourceId?: string;
252
+ /**
253
+ * Type of resource
254
+ */
255
+ resourceType?: string;
256
+ /**
257
+ * Response time in milliseconds
258
+ */
259
+ responseTime?: number;
260
+ /**
261
+ * Session ID
262
+ */
263
+ sessionId?: string;
264
+ /**
265
+ * HTTP status code
266
+ */
267
+ statusCode?: number;
268
+ /**
269
+ * Total number of tokens
270
+ */
271
+ totalTokens?: number;
272
+ /**
273
+ * Client user agent
274
+ */
275
+ userAgent?: string;
276
+ /**
277
+ * User ID
278
+ */
279
+ userId?: string;
280
+ }
281
+ export interface UsageTrackPerformanceParams {
282
+ componentId?: string;
283
+ metrics?: UsageTrackPerformanceParams.Metrics;
284
+ }
285
+ export declare namespace UsageTrackPerformanceParams {
286
+ interface Metrics {
287
+ interactionTime?: number;
288
+ loadTime?: number;
289
+ renderTime?: number;
290
+ }
15
291
  }
16
292
  export declare namespace Usage {
17
- export { type UsageChatParams as UsageChatParams, type UsageTrackParams as UsageTrackParams };
293
+ export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, type UsageTrackChatParams as UsageTrackChatParams, type UsageTrackEventParams as UsageTrackEventParams, type UsageTrackPerformanceParams as UsageTrackPerformanceParams, };
18
294
  }
19
295
  //# sourceMappingURL=usage.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,IAAI,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQvE,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtD,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOvD,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOzD,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO3D,KAAK,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO1E;AAED,MAAM,WAAW,eAAe;CAAG;AAEnC,MAAM,WAAW,gBAAgB;CAAG;AAEpC,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,CAAC;CAC/F"}
1
+ {"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQxG;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAK,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQpF;;;;;;;OAOG;IACH,UAAU,CACR,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQjF;;;;;;;;;OASG;IACH,UAAU,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQnF;;;;;;;OAOG;IACH,gBAAgB,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOhG;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,CAAC;CACnD;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EACN,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,wBAAwB,GACxB,cAAc,GACd,oBAAoB,GACpB,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EACD,gBAAgB,GAChB,eAAe,GACf,oBAAoB,GACpB,cAAc,GACd,sBAAsB,GACtB,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,yBAAyB,GACzB,2BAA2B,GAC3B,0BAA0B,GAC1B,mBAAmB,GACnB,cAAc,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,EACL,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,kBAAkB,GAClB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,mBAAmB,GACnB,sBAAsB,GACtB,oBAAoB,GACpB,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,wBAAwB,GACxB,cAAc,GACd,oBAAoB,GACpB,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EACF,gBAAgB,GAChB,eAAe,GACf,oBAAoB,GACpB,cAAc,GACd,sBAAsB,GACtB,WAAW,GACX,gBAAgB,GAChB,gBAAgB,GAChB,yBAAyB,GACzB,2BAA2B,GAC3B,0BAA0B,GAC1B,mBAAmB,GACnB,cAAc,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,OAAO,CAAC,EAAE,2BAA2B,CAAC,OAAO,CAAC;CAC/C;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,OAAO;QACtB,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}
@@ -2,18 +2,294 @@ import { APIResource } from "../../core/resource.js";
2
2
  import { APIPromise } from "../../core/api-promise.js";
3
3
  import { RequestOptions } from "../../internal/request-options.js";
4
4
  export declare class Usage extends APIResource {
5
- chat(body: UsageChatParams, options?: RequestOptions): APIPromise<void>;
6
- listEvents(options?: RequestOptions): APIPromise<void>;
7
- performance(options?: RequestOptions): APIPromise<void>;
8
- retrieveStats(options?: RequestOptions): APIPromise<void>;
9
- retrieveSummary(options?: RequestOptions): APIPromise<void>;
10
- track(body: UsageTrackParams, options?: RequestOptions): APIPromise<void>;
5
+ /**
6
+ * Get usage statistics
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * await client.v1.usage.getStats();
11
+ * ```
12
+ */
13
+ getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
14
+ /**
15
+ * Get usage summary
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * await client.v1.usage.getSummary({
20
+ * endDate: 'endDate',
21
+ * period: 'hourly',
22
+ * startDate: 'startDate',
23
+ * });
24
+ * ```
25
+ */
26
+ getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
27
+ /**
28
+ * Get usage events
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * await client.v1.usage.listEvents();
33
+ * ```
34
+ */
35
+ listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
36
+ /**
37
+ * Track chat usage
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * await client.v1.usage.trackChat({
42
+ * inputTokens: 0,
43
+ * model: 'openai:gpt-4.1',
44
+ * outputTokens: 0,
45
+ * sessionId: 'sessionId',
46
+ * });
47
+ * ```
48
+ */
49
+ trackChat(body: UsageTrackChatParams, options?: RequestOptions): APIPromise<void>;
50
+ /**
51
+ * Track general usage event
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * await client.v1.usage.trackEvent({
56
+ * eventType: 'material_created',
57
+ * });
58
+ * ```
59
+ */
60
+ trackEvent(body: UsageTrackEventParams, options?: RequestOptions): APIPromise<void>;
61
+ /**
62
+ * Track performance metrics
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * await client.v1.usage.trackPerformance();
67
+ * ```
68
+ */
69
+ trackPerformance(body: UsageTrackPerformanceParams, options?: RequestOptions): APIPromise<void>;
11
70
  }
12
- export interface UsageChatParams {
71
+ export interface UsageGetStatsParams {
72
+ /**
73
+ * End date for stats (ISO 8601)
74
+ */
75
+ endDate?: string;
76
+ /**
77
+ * Filter by group ID
78
+ */
79
+ groupId?: string;
80
+ /**
81
+ * Start date for stats (ISO 8601)
82
+ */
83
+ startDate?: string;
84
+ /**
85
+ * Filter by user ID
86
+ */
87
+ userId?: string;
13
88
  }
14
- export interface UsageTrackParams {
89
+ export interface UsageGetSummaryParams {
90
+ /**
91
+ * End date for summary (ISO 8601)
92
+ */
93
+ endDate: string;
94
+ /**
95
+ * Summary period
96
+ */
97
+ period: 'hourly' | 'daily' | 'monthly';
98
+ /**
99
+ * Start date for summary (ISO 8601)
100
+ */
101
+ startDate: string;
102
+ /**
103
+ * Group results by
104
+ */
105
+ groupBy?: 'user' | 'group' | 'model' | 'endpoint';
106
+ }
107
+ export interface UsageListEventsParams {
108
+ /**
109
+ * End date for filtering (ISO 8601)
110
+ */
111
+ endDate?: string;
112
+ /**
113
+ * Filter by event type
114
+ */
115
+ eventType?: 'material_created' | 'material_uploaded' | 'material_processed' | 'material_deleted' | 'component_created' | 'component_accessed' | 'component_deleted' | 'component_usage' | 'chat_message_sent' | 'chat_session_started' | 'chat_session_ended' | 'test_created' | 'test_started' | 'test_completed' | 'test_question_answered' | 'test_retaken' | 'audio_recap_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
116
+ /**
117
+ * Filter by group ID
118
+ */
119
+ groupId?: string;
120
+ /**
121
+ * Number of results to return
122
+ */
123
+ limit?: number;
124
+ /**
125
+ * Offset for pagination
126
+ */
127
+ offset?: number;
128
+ /**
129
+ * Filter by resource ID
130
+ */
131
+ resourceId?: string;
132
+ /**
133
+ * Start date for filtering (ISO 8601)
134
+ */
135
+ startDate?: string;
136
+ /**
137
+ * Filter by user ID
138
+ */
139
+ userId?: string;
140
+ }
141
+ export interface UsageTrackChatParams {
142
+ /**
143
+ * Number of input tokens
144
+ */
145
+ inputTokens: number;
146
+ /**
147
+ * AI model used
148
+ */
149
+ model: 'openai:gpt-4.1' | 'openai:gpt-4o' | 'openai:gpt-4o-mini' | 'openai:gpt-4' | 'openai:gpt-3.5-turbo' | 'openai:o1' | 'openai:o1-mini' | 'openai:o3-mini' | 'anthropic:claude-3-opus' | 'anthropic:claude-3-sonnet' | 'anthropic:claude-3-haiku' | 'google:gemini-pro' | 'meta:llama-3';
150
+ /**
151
+ * Number of output tokens
152
+ */
153
+ outputTokens: number;
154
+ /**
155
+ * Chat session ID
156
+ */
157
+ sessionId: string;
158
+ /**
159
+ * Component ID
160
+ */
161
+ componentId?: string;
162
+ /**
163
+ * Group ID
164
+ */
165
+ groupId?: string;
166
+ /**
167
+ * Additional metadata
168
+ */
169
+ metadata?: unknown;
170
+ /**
171
+ * Number of reasoning tokens
172
+ */
173
+ reasoningTokens?: number;
174
+ /**
175
+ * User ID
176
+ */
177
+ userId?: string;
178
+ }
179
+ export interface UsageTrackEventParams {
180
+ /**
181
+ * Type of usage event
182
+ */
183
+ eventType: 'material_created' | 'material_uploaded' | 'material_processed' | 'material_deleted' | 'component_created' | 'component_accessed' | 'component_deleted' | 'component_usage' | 'chat_message_sent' | 'chat_session_started' | 'chat_session_ended' | 'test_created' | 'test_started' | 'test_completed' | 'test_question_answered' | 'test_retaken' | 'audio_recap_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
184
+ /**
185
+ * Whether response was served from cache
186
+ */
187
+ cacheHit?: boolean;
188
+ /**
189
+ * Component name
190
+ */
191
+ componentName?: string;
192
+ /**
193
+ * Component type
194
+ */
195
+ componentType?: string;
196
+ /**
197
+ * Size of content in bytes
198
+ */
199
+ contentSize?: number;
200
+ /**
201
+ * API endpoint accessed
202
+ */
203
+ endpoint?: string;
204
+ /**
205
+ * File size in bytes
206
+ */
207
+ fileSize?: number;
208
+ /**
209
+ * File MIME type
210
+ */
211
+ fileType?: string;
212
+ /**
213
+ * Group ID for collaborative sessions
214
+ */
215
+ groupId?: string;
216
+ /**
217
+ * Number of input tokens
218
+ */
219
+ inputTokens?: number;
220
+ /**
221
+ * Client IP address
222
+ */
223
+ ipAddress?: string;
224
+ /**
225
+ * Additional metadata
226
+ */
227
+ metadata?: unknown;
228
+ /**
229
+ * HTTP method used
230
+ */
231
+ method?: string;
232
+ /**
233
+ * AI model used
234
+ */
235
+ model?: 'openai:gpt-4.1' | 'openai:gpt-4o' | 'openai:gpt-4o-mini' | 'openai:gpt-4' | 'openai:gpt-3.5-turbo' | 'openai:o1' | 'openai:o1-mini' | 'openai:o3-mini' | 'anthropic:claude-3-opus' | 'anthropic:claude-3-sonnet' | 'anthropic:claude-3-haiku' | 'google:gemini-pro' | 'meta:llama-3';
236
+ /**
237
+ * Number of output tokens
238
+ */
239
+ outputTokens?: number;
240
+ /**
241
+ * Performance metrics data
242
+ */
243
+ performanceData?: unknown;
244
+ /**
245
+ * Number of reasoning tokens
246
+ */
247
+ reasoningTokens?: number;
248
+ /**
249
+ * Resource ID being accessed
250
+ */
251
+ resourceId?: string;
252
+ /**
253
+ * Type of resource
254
+ */
255
+ resourceType?: string;
256
+ /**
257
+ * Response time in milliseconds
258
+ */
259
+ responseTime?: number;
260
+ /**
261
+ * Session ID
262
+ */
263
+ sessionId?: string;
264
+ /**
265
+ * HTTP status code
266
+ */
267
+ statusCode?: number;
268
+ /**
269
+ * Total number of tokens
270
+ */
271
+ totalTokens?: number;
272
+ /**
273
+ * Client user agent
274
+ */
275
+ userAgent?: string;
276
+ /**
277
+ * User ID
278
+ */
279
+ userId?: string;
280
+ }
281
+ export interface UsageTrackPerformanceParams {
282
+ componentId?: string;
283
+ metrics?: UsageTrackPerformanceParams.Metrics;
284
+ }
285
+ export declare namespace UsageTrackPerformanceParams {
286
+ interface Metrics {
287
+ interactionTime?: number;
288
+ loadTime?: number;
289
+ renderTime?: number;
290
+ }
15
291
  }
16
292
  export declare namespace Usage {
17
- export { type UsageChatParams as UsageChatParams, type UsageTrackParams as UsageTrackParams };
293
+ export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, type UsageTrackChatParams as UsageTrackChatParams, type UsageTrackEventParams as UsageTrackEventParams, type UsageTrackPerformanceParams as UsageTrackPerformanceParams, };
18
294
  }
19
295
  //# sourceMappingURL=usage.d.ts.map