@studyfetch/sdk 1.18.0 → 1.20.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 (86) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/package.json +1 -1
  3. package/resources/v1/components.d.mts +0 -5
  4. package/resources/v1/components.d.mts.map +1 -1
  5. package/resources/v1/components.d.ts +0 -5
  6. package/resources/v1/components.d.ts.map +1 -1
  7. package/resources/v1/components.js +0 -1
  8. package/resources/v1/components.js.map +1 -1
  9. package/resources/v1/components.mjs +0 -1
  10. package/resources/v1/components.mjs.map +1 -1
  11. package/resources/v1/index.d.mts +2 -2
  12. package/resources/v1/index.d.mts.map +1 -1
  13. package/resources/v1/index.d.ts +2 -2
  14. package/resources/v1/index.d.ts.map +1 -1
  15. package/resources/v1/index.js +2 -2
  16. package/resources/v1/index.js.map +1 -1
  17. package/resources/v1/index.mjs +1 -1
  18. package/resources/v1/index.mjs.map +1 -1
  19. package/resources/v1/materials/index.d.mts +1 -1
  20. package/resources/v1/materials/index.d.mts.map +1 -1
  21. package/resources/v1/materials/index.d.ts +1 -1
  22. package/resources/v1/materials/index.d.ts.map +1 -1
  23. package/resources/v1/materials/index.js.map +1 -1
  24. package/resources/v1/materials/index.mjs.map +1 -1
  25. package/resources/v1/materials/materials.d.mts +24 -3
  26. package/resources/v1/materials/materials.d.mts.map +1 -1
  27. package/resources/v1/materials/materials.d.ts +24 -3
  28. package/resources/v1/materials/materials.d.ts.map +1 -1
  29. package/resources/v1/materials/materials.js +5 -2
  30. package/resources/v1/materials/materials.js.map +1 -1
  31. package/resources/v1/materials/materials.mjs +5 -2
  32. package/resources/v1/materials/materials.mjs.map +1 -1
  33. package/resources/v1/usage/analyst.d.mts +54 -0
  34. package/resources/v1/usage/analyst.d.mts.map +1 -0
  35. package/resources/v1/usage/analyst.d.ts +54 -0
  36. package/resources/v1/usage/analyst.d.ts.map +1 -0
  37. package/resources/v1/usage/analyst.js +57 -0
  38. package/resources/v1/usage/analyst.js.map +1 -0
  39. package/resources/v1/usage/analyst.mjs +53 -0
  40. package/resources/v1/usage/analyst.mjs.map +1 -0
  41. package/resources/v1/usage/index.d.mts +3 -0
  42. package/resources/v1/usage/index.d.mts.map +1 -0
  43. package/resources/v1/usage/index.d.ts +3 -0
  44. package/resources/v1/usage/index.d.ts.map +1 -0
  45. package/resources/v1/usage/index.js +9 -0
  46. package/resources/v1/usage/index.js.map +1 -0
  47. package/resources/v1/usage/index.mjs +4 -0
  48. package/resources/v1/usage/index.mjs.map +1 -0
  49. package/resources/v1/usage/usage.d.mts +114 -0
  50. package/resources/v1/usage/usage.d.mts.map +1 -0
  51. package/resources/v1/usage/usage.d.ts +114 -0
  52. package/resources/v1/usage/usage.d.ts.map +1 -0
  53. package/resources/v1/usage/usage.js +67 -0
  54. package/resources/v1/usage/usage.js.map +1 -0
  55. package/resources/v1/usage/usage.mjs +62 -0
  56. package/resources/v1/usage/usage.mjs.map +1 -0
  57. package/resources/v1/usage.d.mts +1 -109
  58. package/resources/v1/usage.d.mts.map +1 -1
  59. package/resources/v1/usage.d.ts +1 -109
  60. package/resources/v1/usage.d.ts.map +1 -1
  61. package/resources/v1/usage.js +2 -55
  62. package/resources/v1/usage.js.map +1 -1
  63. package/resources/v1/usage.mjs +1 -53
  64. package/resources/v1/usage.mjs.map +1 -1
  65. package/resources/v1/v1.d.mts +4 -4
  66. package/resources/v1/v1.d.mts.map +1 -1
  67. package/resources/v1/v1.d.ts +4 -4
  68. package/resources/v1/v1.d.ts.map +1 -1
  69. package/resources/v1/v1.js +2 -2
  70. package/resources/v1/v1.js.map +1 -1
  71. package/resources/v1/v1.mjs +2 -2
  72. package/resources/v1/v1.mjs.map +1 -1
  73. package/src/resources/v1/components.ts +0 -6
  74. package/src/resources/v1/index.ts +2 -1
  75. package/src/resources/v1/materials/index.ts +1 -0
  76. package/src/resources/v1/materials/materials.ts +29 -2
  77. package/src/resources/v1/usage/analyst.ts +102 -0
  78. package/src/resources/v1/usage/index.ts +9 -0
  79. package/src/resources/v1/usage/usage.ts +188 -0
  80. package/src/resources/v1/usage.ts +1 -178
  81. package/src/resources/v1/v1.ts +4 -2
  82. package/src/version.ts +1 -1
  83. package/version.d.mts +1 -1
  84. package/version.d.ts +1 -1
  85. package/version.js +1 -1
  86. package/version.mjs +1 -1
@@ -0,0 +1,54 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import { APIPromise } from "../../../core/api-promise.js";
3
+ import { RequestOptions } from "../../../internal/request-options.js";
4
+ export declare class Analyst extends APIResource {
5
+ /**
6
+ * Get test results for users and groups in JWT
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * await client.v1.usage.analyst.getTestQuestions();
11
+ * ```
12
+ */
13
+ getTestQuestions(options?: RequestOptions): APIPromise<void>;
14
+ /**
15
+ * Get chat messages for users and groups in JWT
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * await client.v1.usage.analyst.listChatMessages();
20
+ * ```
21
+ */
22
+ listChatMessages(options?: RequestOptions): APIPromise<void>;
23
+ /**
24
+ * Get all events based on filters
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * await client.v1.usage.analyst.listEvents({
29
+ * endDate: 'endDate',
30
+ * eventType: 'material_created',
31
+ * startDate: 'startDate',
32
+ * });
33
+ * ```
34
+ */
35
+ listEvents(query: AnalystListEventsParams, options?: RequestOptions): APIPromise<void>;
36
+ }
37
+ export interface AnalystListEventsParams {
38
+ /**
39
+ * End date for filtering (ISO 8601)
40
+ */
41
+ endDate: string;
42
+ /**
43
+ * Type of usage event to filter
44
+ */
45
+ 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' | 'assignment_grader_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
46
+ /**
47
+ * Start date for filtering (ISO 8601)
48
+ */
49
+ startDate: string;
50
+ }
51
+ export declare namespace Analyst {
52
+ export { type AnalystListEventsParams as AnalystListEventsParams };
53
+ }
54
+ //# sourceMappingURL=analyst.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"analyst.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/usage/analyst.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO5D;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO5D;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAK,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAOvF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;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,0BAA0B,GAC1B,UAAU,GACV,WAAW,GACX,WAAW,GACX,YAAY,GACZ,qBAAqB,CAAC;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACpE"}
@@ -0,0 +1,57 @@
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
+ exports.Analyst = void 0;
5
+ const resource_1 = require("../../../core/resource.js");
6
+ const headers_1 = require("../../../internal/headers.js");
7
+ class Analyst extends resource_1.APIResource {
8
+ /**
9
+ * Get test results for users and groups in JWT
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * await client.v1.usage.analyst.getTestQuestions();
14
+ * ```
15
+ */
16
+ getTestQuestions(options) {
17
+ return this._client.get('/api/v1/usage-analyst/test-questions', {
18
+ ...options,
19
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
20
+ });
21
+ }
22
+ /**
23
+ * Get chat messages for users and groups in JWT
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * await client.v1.usage.analyst.listChatMessages();
28
+ * ```
29
+ */
30
+ listChatMessages(options) {
31
+ return this._client.get('/api/v1/usage-analyst/chat-messages', {
32
+ ...options,
33
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
34
+ });
35
+ }
36
+ /**
37
+ * Get all events based on filters
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * await client.v1.usage.analyst.listEvents({
42
+ * endDate: 'endDate',
43
+ * eventType: 'material_created',
44
+ * startDate: 'startDate',
45
+ * });
46
+ * ```
47
+ */
48
+ listEvents(query, options) {
49
+ return this._client.get('/api/v1/usage-analyst/events', {
50
+ query,
51
+ ...options,
52
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
53
+ });
54
+ }
55
+ }
56
+ exports.Analyst = Analyst;
57
+ //# sourceMappingURL=analyst.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"analyst.js","sourceRoot":"","sources":["../../../src/resources/v1/usage/analyst.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,0DAAyD;AAGzD,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAA8B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;YACtD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAlDD,0BAkDC"}
@@ -0,0 +1,53 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import { buildHeaders } from "../../../internal/headers.mjs";
4
+ export class Analyst extends APIResource {
5
+ /**
6
+ * Get test results for users and groups in JWT
7
+ *
8
+ * @example
9
+ * ```ts
10
+ * await client.v1.usage.analyst.getTestQuestions();
11
+ * ```
12
+ */
13
+ getTestQuestions(options) {
14
+ return this._client.get('/api/v1/usage-analyst/test-questions', {
15
+ ...options,
16
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
17
+ });
18
+ }
19
+ /**
20
+ * Get chat messages for users and groups in JWT
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * await client.v1.usage.analyst.listChatMessages();
25
+ * ```
26
+ */
27
+ listChatMessages(options) {
28
+ return this._client.get('/api/v1/usage-analyst/chat-messages', {
29
+ ...options,
30
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
31
+ });
32
+ }
33
+ /**
34
+ * Get all events based on filters
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * await client.v1.usage.analyst.listEvents({
39
+ * endDate: 'endDate',
40
+ * eventType: 'material_created',
41
+ * startDate: 'startDate',
42
+ * });
43
+ * ```
44
+ */
45
+ listEvents(query, options) {
46
+ return this._client.get('/api/v1/usage-analyst/events', {
47
+ query,
48
+ ...options,
49
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
50
+ });
51
+ }
52
+ }
53
+ //# sourceMappingURL=analyst.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"analyst.mjs","sourceRoot":"","sources":["../../../src/resources/v1/usage/analyst.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,gBAAgB,CAAC,OAAwB;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE;YAC7D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAA8B,EAAE,OAAwB;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,8BAA8B,EAAE;YACtD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
@@ -0,0 +1,3 @@
1
+ export { Analyst, type AnalystListEventsParams } from "./analyst.mjs";
2
+ export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.mjs";
3
+ //# sourceMappingURL=index.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/usage/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,uBAAuB,EAAE;OACzC,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B"}
@@ -0,0 +1,3 @@
1
+ export { Analyst, type AnalystListEventsParams } from "./analyst.js";
2
+ export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.js";
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/usage/index.ts"],"names":[],"mappings":"OAEO,EAAE,OAAO,EAAE,KAAK,uBAAuB,EAAE;OACzC,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,GAC3B"}
@@ -0,0 +1,9 @@
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
+ exports.Usage = exports.Analyst = void 0;
5
+ var analyst_1 = require("./analyst.js");
6
+ Object.defineProperty(exports, "Analyst", { enumerable: true, get: function () { return analyst_1.Analyst; } });
7
+ var usage_1 = require("./usage.js");
8
+ Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return usage_1.Usage; } });
9
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/v1/usage/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAAkE;AAAzD,kGAAA,OAAO,OAAA;AAChB,oCAKiB;AAJf,8FAAA,KAAK,OAAA"}
@@ -0,0 +1,4 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ export { Analyst } from "./analyst.mjs";
3
+ export { Usage, } from "./usage.mjs";
4
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/v1/usage/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,OAAO,EAAgC;OACzC,EACL,KAAK,GAIN"}
@@ -0,0 +1,114 @@
1
+ import { APIResource } from "../../../core/resource.mjs";
2
+ import * as AnalystAPI from "./analyst.mjs";
3
+ import { Analyst, AnalystListEventsParams } from "./analyst.mjs";
4
+ import { APIPromise } from "../../../core/api-promise.mjs";
5
+ import { RequestOptions } from "../../../internal/request-options.mjs";
6
+ export declare class Usage extends APIResource {
7
+ analyst: AnalystAPI.Analyst;
8
+ /**
9
+ * Get usage statistics
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * await client.v1.usage.getStats();
14
+ * ```
15
+ */
16
+ getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
17
+ /**
18
+ * Get usage summary
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * await client.v1.usage.getSummary({
23
+ * endDate: 'endDate',
24
+ * period: 'hourly',
25
+ * startDate: 'startDate',
26
+ * });
27
+ * ```
28
+ */
29
+ getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
30
+ /**
31
+ * Get usage events
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * await client.v1.usage.listEvents();
36
+ * ```
37
+ */
38
+ listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
39
+ }
40
+ export interface UsageGetStatsParams {
41
+ /**
42
+ * End date for stats (ISO 8601)
43
+ */
44
+ endDate?: string;
45
+ /**
46
+ * Filter by group ID
47
+ */
48
+ groupId?: string;
49
+ /**
50
+ * Start date for stats (ISO 8601)
51
+ */
52
+ startDate?: string;
53
+ /**
54
+ * Filter by user ID
55
+ */
56
+ userId?: string;
57
+ }
58
+ export interface UsageGetSummaryParams {
59
+ /**
60
+ * End date for summary (ISO 8601)
61
+ */
62
+ endDate: string;
63
+ /**
64
+ * Summary period
65
+ */
66
+ period: 'hourly' | 'daily' | 'monthly';
67
+ /**
68
+ * Start date for summary (ISO 8601)
69
+ */
70
+ startDate: string;
71
+ /**
72
+ * Group results by
73
+ */
74
+ groupBy?: 'user' | 'group' | 'model' | 'endpoint';
75
+ }
76
+ export interface UsageListEventsParams {
77
+ /**
78
+ * End date for filtering (ISO 8601)
79
+ */
80
+ endDate?: string;
81
+ /**
82
+ * Filter by event type
83
+ */
84
+ 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' | 'assignment_grader_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
85
+ /**
86
+ * Filter by group ID
87
+ */
88
+ groupId?: string;
89
+ /**
90
+ * Number of results to return
91
+ */
92
+ limit?: number;
93
+ /**
94
+ * Offset for pagination
95
+ */
96
+ offset?: number;
97
+ /**
98
+ * Filter by resource ID
99
+ */
100
+ resourceId?: string;
101
+ /**
102
+ * Start date for filtering (ISO 8601)
103
+ */
104
+ startDate?: string;
105
+ /**
106
+ * Filter by user ID
107
+ */
108
+ userId?: string;
109
+ }
110
+ export declare namespace Usage {
111
+ export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
112
+ export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
113
+ }
114
+ //# sourceMappingURL=usage.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../../src/resources/v1/usage/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,uBAAuB,EAAE;OACpC,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;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;CAOpB;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,0BAA0B,GAC1B,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;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACxF"}
@@ -0,0 +1,114 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import * as AnalystAPI from "./analyst.js";
3
+ import { Analyst, AnalystListEventsParams } from "./analyst.js";
4
+ import { APIPromise } from "../../../core/api-promise.js";
5
+ import { RequestOptions } from "../../../internal/request-options.js";
6
+ export declare class Usage extends APIResource {
7
+ analyst: AnalystAPI.Analyst;
8
+ /**
9
+ * Get usage statistics
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * await client.v1.usage.getStats();
14
+ * ```
15
+ */
16
+ getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
17
+ /**
18
+ * Get usage summary
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * await client.v1.usage.getSummary({
23
+ * endDate: 'endDate',
24
+ * period: 'hourly',
25
+ * startDate: 'startDate',
26
+ * });
27
+ * ```
28
+ */
29
+ getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
30
+ /**
31
+ * Get usage events
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * await client.v1.usage.listEvents();
36
+ * ```
37
+ */
38
+ listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
39
+ }
40
+ export interface UsageGetStatsParams {
41
+ /**
42
+ * End date for stats (ISO 8601)
43
+ */
44
+ endDate?: string;
45
+ /**
46
+ * Filter by group ID
47
+ */
48
+ groupId?: string;
49
+ /**
50
+ * Start date for stats (ISO 8601)
51
+ */
52
+ startDate?: string;
53
+ /**
54
+ * Filter by user ID
55
+ */
56
+ userId?: string;
57
+ }
58
+ export interface UsageGetSummaryParams {
59
+ /**
60
+ * End date for summary (ISO 8601)
61
+ */
62
+ endDate: string;
63
+ /**
64
+ * Summary period
65
+ */
66
+ period: 'hourly' | 'daily' | 'monthly';
67
+ /**
68
+ * Start date for summary (ISO 8601)
69
+ */
70
+ startDate: string;
71
+ /**
72
+ * Group results by
73
+ */
74
+ groupBy?: 'user' | 'group' | 'model' | 'endpoint';
75
+ }
76
+ export interface UsageListEventsParams {
77
+ /**
78
+ * End date for filtering (ISO 8601)
79
+ */
80
+ endDate?: string;
81
+ /**
82
+ * Filter by event type
83
+ */
84
+ 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' | 'assignment_grader_create' | 'api_call' | 'cache_hit' | 'sso_login' | 'sso_logout' | 'student_performance';
85
+ /**
86
+ * Filter by group ID
87
+ */
88
+ groupId?: string;
89
+ /**
90
+ * Number of results to return
91
+ */
92
+ limit?: number;
93
+ /**
94
+ * Offset for pagination
95
+ */
96
+ offset?: number;
97
+ /**
98
+ * Filter by resource ID
99
+ */
100
+ resourceId?: string;
101
+ /**
102
+ * Start date for filtering (ISO 8601)
103
+ */
104
+ startDate?: string;
105
+ /**
106
+ * Filter by user ID
107
+ */
108
+ userId?: string;
109
+ }
110
+ export declare namespace Usage {
111
+ export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
112
+ export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
113
+ }
114
+ //# sourceMappingURL=usage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../src/resources/v1/usage/usage.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAAE,uBAAuB,EAAE;OACpC,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;;;;;;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;CAOpB;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,0BAA0B,GAC1B,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;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,uBAAuB,IAAI,uBAAuB,EAAE,CAAC;CACxF"}
@@ -0,0 +1,67 @@
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
+ exports.Usage = void 0;
5
+ const tslib_1 = require("../../../internal/tslib.js");
6
+ const resource_1 = require("../../../core/resource.js");
7
+ const AnalystAPI = tslib_1.__importStar(require("./analyst.js"));
8
+ const analyst_1 = require("./analyst.js");
9
+ const headers_1 = require("../../../internal/headers.js");
10
+ class Usage extends resource_1.APIResource {
11
+ constructor() {
12
+ super(...arguments);
13
+ this.analyst = new AnalystAPI.Analyst(this._client);
14
+ }
15
+ /**
16
+ * Get usage statistics
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * await client.v1.usage.getStats();
21
+ * ```
22
+ */
23
+ getStats(query = {}, options) {
24
+ return this._client.get('/api/v1/usage/stats', {
25
+ query,
26
+ ...options,
27
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
28
+ });
29
+ }
30
+ /**
31
+ * Get usage summary
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * await client.v1.usage.getSummary({
36
+ * endDate: 'endDate',
37
+ * period: 'hourly',
38
+ * startDate: 'startDate',
39
+ * });
40
+ * ```
41
+ */
42
+ getSummary(query, options) {
43
+ return this._client.get('/api/v1/usage/summary', {
44
+ query,
45
+ ...options,
46
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
47
+ });
48
+ }
49
+ /**
50
+ * Get usage events
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * await client.v1.usage.listEvents();
55
+ * ```
56
+ */
57
+ listEvents(query = {}, options) {
58
+ return this._client.get('/api/v1/usage/events', {
59
+ query,
60
+ ...options,
61
+ headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
62
+ });
63
+ }
64
+ }
65
+ exports.Usage = Usage;
66
+ Usage.Analyst = analyst_1.Analyst;
67
+ //# sourceMappingURL=usage.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usage.js","sourceRoot":"","sources":["../../../src/resources/v1/usage/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAA6D;AAE7D,0DAAyD;AAGzD,MAAa,KAAM,SAAQ,sBAAW;IAAtC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwDrE,CAAC;IAtDC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgD,EAAE,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC/C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC9C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAzDD,sBAyDC;AA+GD,KAAK,CAAC,OAAO,GAAG,iBAAO,CAAC"}
@@ -0,0 +1,62 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../../../core/resource.mjs";
3
+ import * as AnalystAPI from "./analyst.mjs";
4
+ import { Analyst } from "./analyst.mjs";
5
+ import { buildHeaders } from "../../../internal/headers.mjs";
6
+ export class Usage extends APIResource {
7
+ constructor() {
8
+ super(...arguments);
9
+ this.analyst = new AnalystAPI.Analyst(this._client);
10
+ }
11
+ /**
12
+ * Get usage statistics
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * await client.v1.usage.getStats();
17
+ * ```
18
+ */
19
+ getStats(query = {}, options) {
20
+ return this._client.get('/api/v1/usage/stats', {
21
+ query,
22
+ ...options,
23
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
24
+ });
25
+ }
26
+ /**
27
+ * Get usage summary
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * await client.v1.usage.getSummary({
32
+ * endDate: 'endDate',
33
+ * period: 'hourly',
34
+ * startDate: 'startDate',
35
+ * });
36
+ * ```
37
+ */
38
+ getSummary(query, options) {
39
+ return this._client.get('/api/v1/usage/summary', {
40
+ query,
41
+ ...options,
42
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
43
+ });
44
+ }
45
+ /**
46
+ * Get usage events
47
+ *
48
+ * @example
49
+ * ```ts
50
+ * await client.v1.usage.listEvents();
51
+ * ```
52
+ */
53
+ listEvents(query = {}, options) {
54
+ return this._client.get('/api/v1/usage/events', {
55
+ query,
56
+ ...options,
57
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
58
+ });
59
+ }
60
+ }
61
+ Usage.Analyst = Analyst;
62
+ //# sourceMappingURL=usage.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"usage.mjs","sourceRoot":"","sources":["../../../src/resources/v1/usage/usage.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,OAAO,EAA2B;OAEpC,EAAE,YAAY,EAAE;AAGvB,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwDrE,CAAC;IAtDC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAgD,EAAE,EAAE,OAAwB;QACnF,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE;YAC7C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAA4B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE;YAC/C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC9C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA+GD,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC"}