@studyfetch/sdk 1.33.0 → 1.35.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.
- package/CHANGELOG.md +35 -0
- package/README.md +1 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +4 -5
- package/resources/v1/assignment-grader/assignment-grader.d.mts +313 -0
- package/resources/v1/assignment-grader/assignment-grader.d.mts.map +1 -0
- package/resources/v1/assignment-grader/assignment-grader.d.ts +313 -0
- package/resources/v1/assignment-grader/assignment-grader.d.ts.map +1 -0
- package/resources/v1/assignment-grader/assignment-grader.js +87 -0
- package/resources/v1/assignment-grader/assignment-grader.js.map +1 -0
- package/resources/v1/assignment-grader/assignment-grader.mjs +82 -0
- package/resources/v1/assignment-grader/assignment-grader.mjs.map +1 -0
- package/resources/v1/assignment-grader/index.d.mts +3 -0
- package/resources/v1/assignment-grader/index.d.mts.map +1 -0
- package/resources/v1/assignment-grader/index.d.ts +3 -0
- package/resources/v1/assignment-grader/index.d.ts.map +1 -0
- package/resources/v1/assignment-grader/index.js +9 -0
- package/resources/v1/assignment-grader/index.js.map +1 -0
- package/resources/v1/assignment-grader/index.mjs +4 -0
- package/resources/v1/assignment-grader/index.mjs.map +1 -0
- package/resources/v1/assignment-grader/rubric-templates.d.mts +238 -0
- package/resources/v1/assignment-grader/rubric-templates.d.mts.map +1 -0
- package/resources/v1/assignment-grader/rubric-templates.d.ts +238 -0
- package/resources/v1/assignment-grader/rubric-templates.d.ts.map +1 -0
- package/resources/v1/assignment-grader/rubric-templates.js +68 -0
- package/resources/v1/assignment-grader/rubric-templates.js.map +1 -0
- package/resources/v1/assignment-grader/rubric-templates.mjs +64 -0
- package/resources/v1/assignment-grader/rubric-templates.mjs.map +1 -0
- package/resources/v1/assignment-grader.d.mts +1 -152
- package/resources/v1/assignment-grader.d.mts.map +1 -1
- package/resources/v1/assignment-grader.d.ts +1 -152
- package/resources/v1/assignment-grader.d.ts.map +1 -1
- package/resources/v1/assignment-grader.js +2 -62
- package/resources/v1/assignment-grader.js.map +1 -1
- package/resources/v1/assignment-grader.mjs +1 -60
- package/resources/v1/assignment-grader.mjs.map +1 -1
- package/resources/v1/chat-analytics.d.mts +316 -0
- package/resources/v1/chat-analytics.d.mts.map +1 -0
- package/resources/v1/chat-analytics.d.ts +316 -0
- package/resources/v1/chat-analytics.d.ts.map +1 -0
- package/resources/v1/chat-analytics.js +50 -0
- package/resources/v1/chat-analytics.js.map +1 -0
- package/resources/v1/chat-analytics.mjs +46 -0
- package/resources/v1/chat-analytics.mjs.map +1 -0
- package/resources/v1/components.d.mts +184 -10
- package/resources/v1/components.d.mts.map +1 -1
- package/resources/v1/components.d.ts +184 -10
- package/resources/v1/components.d.ts.map +1 -1
- package/resources/v1/components.js.map +1 -1
- package/resources/v1/components.mjs.map +1 -1
- package/resources/v1/folders.d.mts +528 -21
- package/resources/v1/folders.d.mts.map +1 -1
- package/resources/v1/folders.d.ts +528 -21
- package/resources/v1/folders.d.ts.map +1 -1
- package/resources/v1/folders.js +25 -39
- package/resources/v1/folders.js.map +1 -1
- package/resources/v1/folders.mjs +25 -39
- package/resources/v1/folders.mjs.map +1 -1
- package/resources/v1/index.d.mts +7 -5
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +7 -5
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js +13 -9
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +5 -3
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/materials/index.d.mts +3 -3
- package/resources/v1/materials/index.d.mts.map +1 -1
- package/resources/v1/materials/index.d.ts +3 -3
- package/resources/v1/materials/index.d.ts.map +1 -1
- package/resources/v1/materials/index.js.map +1 -1
- package/resources/v1/materials/index.mjs.map +1 -1
- package/resources/v1/materials/materials.d.mts +548 -92
- package/resources/v1/materials/materials.d.mts.map +1 -1
- package/resources/v1/materials/materials.d.ts +548 -92
- package/resources/v1/materials/materials.d.ts.map +1 -1
- package/resources/v1/materials/materials.js +36 -34
- package/resources/v1/materials/materials.js.map +1 -1
- package/resources/v1/materials/materials.mjs +36 -34
- package/resources/v1/materials/materials.mjs.map +1 -1
- package/resources/v1/materials/test.d.mts +29 -30
- package/resources/v1/materials/test.d.mts.map +1 -1
- package/resources/v1/materials/test.d.ts +29 -30
- package/resources/v1/materials/test.d.ts.map +1 -1
- package/resources/v1/materials/test.js +14 -15
- package/resources/v1/materials/test.js.map +1 -1
- package/resources/v1/materials/test.mjs +14 -15
- package/resources/v1/materials/test.mjs.map +1 -1
- package/resources/v1/materials/upload.d.mts +312 -23
- package/resources/v1/materials/upload.d.mts.map +1 -1
- package/resources/v1/materials/upload.d.ts +312 -23
- package/resources/v1/materials/upload.d.ts.map +1 -1
- package/resources/v1/materials/upload.js +9 -9
- package/resources/v1/materials/upload.js.map +1 -1
- package/resources/v1/materials/upload.mjs +9 -9
- package/resources/v1/materials/upload.mjs.map +1 -1
- package/resources/v1/usage-analyst.d.mts +99 -0
- package/resources/v1/usage-analyst.d.mts.map +1 -0
- package/resources/v1/usage-analyst.d.ts +99 -0
- package/resources/v1/usage-analyst.d.ts.map +1 -0
- package/resources/v1/{usage/analyst.js → usage-analyst.js} +9 -9
- package/resources/v1/usage-analyst.js.map +1 -0
- package/resources/v1/{usage/analyst.mjs → usage-analyst.mjs} +7 -7
- package/resources/v1/usage-analyst.mjs.map +1 -0
- package/resources/v1/usage.d.mts +109 -1
- package/resources/v1/usage.d.mts.map +1 -1
- package/resources/v1/usage.d.ts +109 -1
- package/resources/v1/usage.d.ts.map +1 -1
- package/resources/v1/usage.js +55 -2
- package/resources/v1/usage.js.map +1 -1
- package/resources/v1/usage.mjs +53 -1
- package/resources/v1/usage.mjs.map +1 -1
- package/resources/v1/v1.d.mts +20 -12
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +20 -12
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js +14 -6
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +15 -7
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +2 -0
- package/src/resources/v1/assignment-grader/assignment-grader.ts +421 -0
- package/src/resources/v1/assignment-grader/index.ts +16 -0
- package/src/resources/v1/assignment-grader/rubric-templates.ts +305 -0
- package/src/resources/v1/assignment-grader.ts +1 -196
- package/src/resources/v1/chat-analytics.ts +413 -0
- package/src/resources/v1/components.ts +265 -10
- package/src/resources/v1/folders.ts +659 -51
- package/src/resources/v1/index.ts +48 -11
- package/src/resources/v1/materials/index.ts +23 -14
- package/src/resources/v1/materials/materials.ts +824 -216
- package/src/resources/v1/materials/test.ts +38 -39
- package/src/resources/v1/materials/upload.ts +411 -30
- package/src/resources/v1/{usage/analyst.ts → usage-analyst.ts} +24 -23
- package/src/resources/v1/usage.ts +179 -1
- package/src/resources/v1/v1.ts +106 -29
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/v1/usage/analyst.d.mts +0 -99
- package/resources/v1/usage/analyst.d.mts.map +0 -1
- package/resources/v1/usage/analyst.d.ts +0 -99
- package/resources/v1/usage/analyst.d.ts.map +0 -1
- package/resources/v1/usage/analyst.js.map +0 -1
- package/resources/v1/usage/analyst.mjs.map +0 -1
- package/resources/v1/usage/index.d.mts +0 -3
- package/resources/v1/usage/index.d.mts.map +0 -1
- package/resources/v1/usage/index.d.ts +0 -3
- package/resources/v1/usage/index.d.ts.map +0 -1
- package/resources/v1/usage/index.js +0 -9
- package/resources/v1/usage/index.js.map +0 -1
- package/resources/v1/usage/index.mjs +0 -4
- package/resources/v1/usage/index.mjs.map +0 -1
- package/resources/v1/usage/usage.d.mts +0 -114
- package/resources/v1/usage/usage.d.mts.map +0 -1
- package/resources/v1/usage/usage.d.ts +0 -114
- package/resources/v1/usage/usage.d.ts.map +0 -1
- package/resources/v1/usage/usage.js +0 -67
- package/resources/v1/usage/usage.js.map +0 -1
- package/resources/v1/usage/usage.mjs +0 -62
- package/resources/v1/usage/usage.mjs.map +0 -1
- package/src/resources/v1/usage/index.ts +0 -15
- package/src/resources/v1/usage/usage.ts +0 -200
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
export declare class UsageAnalyst extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Get test results with full question data for user or group
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* await client.v1.usageAnalyst.getTestQuestions();
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
getTestQuestions(query?: UsageAnalystGetTestQuestionsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
|
|
14
|
+
/**
|
|
15
|
+
* Get all chat messages from sessions for user or group
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const response =
|
|
20
|
+
* await client.v1.usageAnalyst.listChatMessages();
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
listChatMessages(query?: UsageAnalystListChatMessagesParams | null | undefined, options?: RequestOptions): APIPromise<UsageAnalystListChatMessagesResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* Get all events based on filters
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* await client.v1.usageAnalyst.listEvents({
|
|
30
|
+
* endDate: 'endDate',
|
|
31
|
+
* eventType: 'material_created',
|
|
32
|
+
* startDate: 'startDate',
|
|
33
|
+
* });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
listEvents(query: UsageAnalystListEventsParams, options?: RequestOptions): APIPromise<void>;
|
|
37
|
+
}
|
|
38
|
+
export interface UsageAnalystListChatMessagesResponse {
|
|
39
|
+
messages?: Array<UsageAnalystListChatMessagesResponse.Message>;
|
|
40
|
+
sessionCount?: number;
|
|
41
|
+
total?: number;
|
|
42
|
+
}
|
|
43
|
+
export declare namespace UsageAnalystListChatMessagesResponse {
|
|
44
|
+
interface Message {
|
|
45
|
+
componentId?: string;
|
|
46
|
+
content?: string;
|
|
47
|
+
createdAt?: string;
|
|
48
|
+
metadata?: unknown;
|
|
49
|
+
role?: 'user' | 'assistant' | 'system';
|
|
50
|
+
sessionId?: string;
|
|
51
|
+
userId?: string;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
export interface UsageAnalystGetTestQuestionsParams {
|
|
55
|
+
/**
|
|
56
|
+
* Array of group IDs to filter
|
|
57
|
+
*/
|
|
58
|
+
groupIds?: Array<string>;
|
|
59
|
+
/**
|
|
60
|
+
* User ID to get test results for
|
|
61
|
+
*/
|
|
62
|
+
userId?: string;
|
|
63
|
+
}
|
|
64
|
+
export interface UsageAnalystListChatMessagesParams {
|
|
65
|
+
/**
|
|
66
|
+
* Array of group IDs to filter
|
|
67
|
+
*/
|
|
68
|
+
groupIds?: Array<string>;
|
|
69
|
+
/**
|
|
70
|
+
* User ID to get chat messages for
|
|
71
|
+
*/
|
|
72
|
+
userId?: string;
|
|
73
|
+
}
|
|
74
|
+
export interface UsageAnalystListEventsParams {
|
|
75
|
+
/**
|
|
76
|
+
* End date for filtering (ISO 8601)
|
|
77
|
+
*/
|
|
78
|
+
endDate: string;
|
|
79
|
+
/**
|
|
80
|
+
* Type of usage event to filter
|
|
81
|
+
*/
|
|
82
|
+
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' | 'chat_feedback' | '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';
|
|
83
|
+
/**
|
|
84
|
+
* Start date for filtering (ISO 8601)
|
|
85
|
+
*/
|
|
86
|
+
startDate: string;
|
|
87
|
+
/**
|
|
88
|
+
* Array of group IDs to filter
|
|
89
|
+
*/
|
|
90
|
+
groupIds?: Array<string>;
|
|
91
|
+
/**
|
|
92
|
+
* Array of user IDs to filter
|
|
93
|
+
*/
|
|
94
|
+
userIds?: Array<string>;
|
|
95
|
+
}
|
|
96
|
+
export declare namespace UsageAnalyst {
|
|
97
|
+
export { type UsageAnalystListChatMessagesResponse as UsageAnalystListChatMessagesResponse, type UsageAnalystGetTestQuestionsParams as UsageAnalystGetTestQuestionsParams, type UsageAnalystListChatMessagesParams as UsageAnalystListChatMessagesParams, type UsageAnalystListEventsParams as UsageAnalystListEventsParams, };
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=usage-analyst.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage-analyst.d.mts","sourceRoot":"","sources":["../../src/resources/v1/usage-analyst.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,gBAAgB,CACd,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;OAQG;IACH,gBAAgB,CACd,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAK,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO5F;AAED,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,OAAO,CAAC,CAAC;IAE/D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,OAAO;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEvC,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;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,eAAe,GACf,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;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -0,0 +1,99 @@
|
|
|
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 UsageAnalyst extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Get test results with full question data for user or group
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* await client.v1.usageAnalyst.getTestQuestions();
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
getTestQuestions(query?: UsageAnalystGetTestQuestionsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
|
|
14
|
+
/**
|
|
15
|
+
* Get all chat messages from sessions for user or group
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* const response =
|
|
20
|
+
* await client.v1.usageAnalyst.listChatMessages();
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
listChatMessages(query?: UsageAnalystListChatMessagesParams | null | undefined, options?: RequestOptions): APIPromise<UsageAnalystListChatMessagesResponse>;
|
|
24
|
+
/**
|
|
25
|
+
* Get all events based on filters
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* ```ts
|
|
29
|
+
* await client.v1.usageAnalyst.listEvents({
|
|
30
|
+
* endDate: 'endDate',
|
|
31
|
+
* eventType: 'material_created',
|
|
32
|
+
* startDate: 'startDate',
|
|
33
|
+
* });
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
listEvents(query: UsageAnalystListEventsParams, options?: RequestOptions): APIPromise<void>;
|
|
37
|
+
}
|
|
38
|
+
export interface UsageAnalystListChatMessagesResponse {
|
|
39
|
+
messages?: Array<UsageAnalystListChatMessagesResponse.Message>;
|
|
40
|
+
sessionCount?: number;
|
|
41
|
+
total?: number;
|
|
42
|
+
}
|
|
43
|
+
export declare namespace UsageAnalystListChatMessagesResponse {
|
|
44
|
+
interface Message {
|
|
45
|
+
componentId?: string;
|
|
46
|
+
content?: string;
|
|
47
|
+
createdAt?: string;
|
|
48
|
+
metadata?: unknown;
|
|
49
|
+
role?: 'user' | 'assistant' | 'system';
|
|
50
|
+
sessionId?: string;
|
|
51
|
+
userId?: string;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
export interface UsageAnalystGetTestQuestionsParams {
|
|
55
|
+
/**
|
|
56
|
+
* Array of group IDs to filter
|
|
57
|
+
*/
|
|
58
|
+
groupIds?: Array<string>;
|
|
59
|
+
/**
|
|
60
|
+
* User ID to get test results for
|
|
61
|
+
*/
|
|
62
|
+
userId?: string;
|
|
63
|
+
}
|
|
64
|
+
export interface UsageAnalystListChatMessagesParams {
|
|
65
|
+
/**
|
|
66
|
+
* Array of group IDs to filter
|
|
67
|
+
*/
|
|
68
|
+
groupIds?: Array<string>;
|
|
69
|
+
/**
|
|
70
|
+
* User ID to get chat messages for
|
|
71
|
+
*/
|
|
72
|
+
userId?: string;
|
|
73
|
+
}
|
|
74
|
+
export interface UsageAnalystListEventsParams {
|
|
75
|
+
/**
|
|
76
|
+
* End date for filtering (ISO 8601)
|
|
77
|
+
*/
|
|
78
|
+
endDate: string;
|
|
79
|
+
/**
|
|
80
|
+
* Type of usage event to filter
|
|
81
|
+
*/
|
|
82
|
+
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' | 'chat_feedback' | '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';
|
|
83
|
+
/**
|
|
84
|
+
* Start date for filtering (ISO 8601)
|
|
85
|
+
*/
|
|
86
|
+
startDate: string;
|
|
87
|
+
/**
|
|
88
|
+
* Array of group IDs to filter
|
|
89
|
+
*/
|
|
90
|
+
groupIds?: Array<string>;
|
|
91
|
+
/**
|
|
92
|
+
* Array of user IDs to filter
|
|
93
|
+
*/
|
|
94
|
+
userIds?: Array<string>;
|
|
95
|
+
}
|
|
96
|
+
export declare namespace UsageAnalyst {
|
|
97
|
+
export { type UsageAnalystListChatMessagesResponse as UsageAnalystListChatMessagesResponse, type UsageAnalystGetTestQuestionsParams as UsageAnalystGetTestQuestionsParams, type UsageAnalystListChatMessagesParams as UsageAnalystListChatMessagesParams, type UsageAnalystListEventsParams as UsageAnalystListEventsParams, };
|
|
98
|
+
}
|
|
99
|
+
//# sourceMappingURL=usage-analyst.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage-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,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,gBAAgB,CACd,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;OAQG;IACH,gBAAgB,CACd,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oCAAoC,CAAC;IAInD;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAK,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAO5F;AAED,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,EAAE,KAAK,CAAC,oCAAoC,CAAC,OAAO,CAAC,CAAC;IAE/D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,oCAAoC,CAAC;IACpD,UAAiB,OAAO;QACtB,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEvC,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;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,eAAe,GACf,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;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.
|
|
5
|
-
const resource_1 = require("
|
|
6
|
-
const headers_1 = require("
|
|
7
|
-
class
|
|
4
|
+
exports.UsageAnalyst = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const headers_1 = require("../../internal/headers.js");
|
|
7
|
+
class UsageAnalyst extends resource_1.APIResource {
|
|
8
8
|
/**
|
|
9
9
|
* Get test results with full question data for user or group
|
|
10
10
|
*
|
|
11
11
|
* @example
|
|
12
12
|
* ```ts
|
|
13
|
-
* await client.v1.
|
|
13
|
+
* await client.v1.usageAnalyst.getTestQuestions();
|
|
14
14
|
* ```
|
|
15
15
|
*/
|
|
16
16
|
getTestQuestions(query = {}, options) {
|
|
@@ -26,7 +26,7 @@ class Analyst extends resource_1.APIResource {
|
|
|
26
26
|
* @example
|
|
27
27
|
* ```ts
|
|
28
28
|
* const response =
|
|
29
|
-
* await client.v1.
|
|
29
|
+
* await client.v1.usageAnalyst.listChatMessages();
|
|
30
30
|
* ```
|
|
31
31
|
*/
|
|
32
32
|
listChatMessages(query = {}, options) {
|
|
@@ -37,7 +37,7 @@ class Analyst extends resource_1.APIResource {
|
|
|
37
37
|
*
|
|
38
38
|
* @example
|
|
39
39
|
* ```ts
|
|
40
|
-
* await client.v1.
|
|
40
|
+
* await client.v1.usageAnalyst.listEvents({
|
|
41
41
|
* endDate: 'endDate',
|
|
42
42
|
* eventType: 'material_created',
|
|
43
43
|
* startDate: 'startDate',
|
|
@@ -52,5 +52,5 @@ class Analyst extends resource_1.APIResource {
|
|
|
52
52
|
});
|
|
53
53
|
}
|
|
54
54
|
}
|
|
55
|
-
exports.
|
|
56
|
-
//# sourceMappingURL=analyst.js.map
|
|
55
|
+
exports.UsageAnalyst = UsageAnalyst;
|
|
56
|
+
//# sourceMappingURL=usage-analyst.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage-analyst.js","sourceRoot":"","sources":["../../src/resources/v1/usage-analyst.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAGtD,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;OAOG;IACH,gBAAgB,CACd,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,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;;;;;;;;OAQG;IACH,gBAAgB,CACd,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAmC,EAAE,OAAwB;QACtE,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;AAvDD,oCAuDC"}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
import { APIResource } from "
|
|
3
|
-
import { buildHeaders } from "
|
|
4
|
-
export class
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
|
+
export class UsageAnalyst extends APIResource {
|
|
5
5
|
/**
|
|
6
6
|
* Get test results with full question data for user or group
|
|
7
7
|
*
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
|
-
* await client.v1.
|
|
10
|
+
* await client.v1.usageAnalyst.getTestQuestions();
|
|
11
11
|
* ```
|
|
12
12
|
*/
|
|
13
13
|
getTestQuestions(query = {}, options) {
|
|
@@ -23,7 +23,7 @@ export class Analyst extends APIResource {
|
|
|
23
23
|
* @example
|
|
24
24
|
* ```ts
|
|
25
25
|
* const response =
|
|
26
|
-
* await client.v1.
|
|
26
|
+
* await client.v1.usageAnalyst.listChatMessages();
|
|
27
27
|
* ```
|
|
28
28
|
*/
|
|
29
29
|
listChatMessages(query = {}, options) {
|
|
@@ -34,7 +34,7 @@ export class Analyst extends APIResource {
|
|
|
34
34
|
*
|
|
35
35
|
* @example
|
|
36
36
|
* ```ts
|
|
37
|
-
* await client.v1.
|
|
37
|
+
* await client.v1.usageAnalyst.listEvents({
|
|
38
38
|
* endDate: 'endDate',
|
|
39
39
|
* eventType: 'material_created',
|
|
40
40
|
* startDate: 'startDate',
|
|
@@ -49,4 +49,4 @@ export class Analyst extends APIResource {
|
|
|
49
49
|
});
|
|
50
50
|
}
|
|
51
51
|
}
|
|
52
|
-
//# sourceMappingURL=analyst.mjs.map
|
|
52
|
+
//# sourceMappingURL=usage-analyst.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage-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,YAAa,SAAQ,WAAW;IAC3C;;;;;;;OAOG;IACH,gBAAgB,CACd,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sCAAsC,EAAE;YAC9D,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;;;;;;;;OAQG;IACH,gBAAgB,CACd,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,KAAmC,EAAE,OAAwB;QACtE,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"}
|
package/resources/v1/usage.d.mts
CHANGED
|
@@ -1,2 +1,110 @@
|
|
|
1
|
-
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
export declare class Usage extends APIResource {
|
|
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
|
+
export interface UsageGetStatsParams {
|
|
38
|
+
/**
|
|
39
|
+
* End date for stats (ISO 8601)
|
|
40
|
+
*/
|
|
41
|
+
endDate?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Filter by group ID
|
|
44
|
+
*/
|
|
45
|
+
groupId?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Start date for stats (ISO 8601)
|
|
48
|
+
*/
|
|
49
|
+
startDate?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Filter by user ID
|
|
52
|
+
*/
|
|
53
|
+
userId?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface UsageGetSummaryParams {
|
|
56
|
+
/**
|
|
57
|
+
* End date for summary (ISO 8601)
|
|
58
|
+
*/
|
|
59
|
+
endDate: string;
|
|
60
|
+
/**
|
|
61
|
+
* Summary period
|
|
62
|
+
*/
|
|
63
|
+
period: 'hourly' | 'daily' | 'monthly';
|
|
64
|
+
/**
|
|
65
|
+
* Start date for summary (ISO 8601)
|
|
66
|
+
*/
|
|
67
|
+
startDate: string;
|
|
68
|
+
/**
|
|
69
|
+
* Group results by
|
|
70
|
+
*/
|
|
71
|
+
groupBy?: 'user' | 'group' | 'model' | 'endpoint';
|
|
72
|
+
}
|
|
73
|
+
export interface UsageListEventsParams {
|
|
74
|
+
/**
|
|
75
|
+
* End date for filtering (ISO 8601)
|
|
76
|
+
*/
|
|
77
|
+
endDate?: string;
|
|
78
|
+
/**
|
|
79
|
+
* Filter by event type
|
|
80
|
+
*/
|
|
81
|
+
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' | 'chat_feedback' | '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';
|
|
82
|
+
/**
|
|
83
|
+
* Filter by group ID
|
|
84
|
+
*/
|
|
85
|
+
groupId?: string;
|
|
86
|
+
/**
|
|
87
|
+
* Number of results to return
|
|
88
|
+
*/
|
|
89
|
+
limit?: number;
|
|
90
|
+
/**
|
|
91
|
+
* Offset for pagination
|
|
92
|
+
*/
|
|
93
|
+
offset?: number;
|
|
94
|
+
/**
|
|
95
|
+
* Filter by resource ID
|
|
96
|
+
*/
|
|
97
|
+
resourceId?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Start date for filtering (ISO 8601)
|
|
100
|
+
*/
|
|
101
|
+
startDate?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Filter by user ID
|
|
104
|
+
*/
|
|
105
|
+
userId?: string;
|
|
106
|
+
}
|
|
107
|
+
export declare namespace Usage {
|
|
108
|
+
export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
|
|
109
|
+
}
|
|
2
110
|
//# sourceMappingURL=usage.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usage.d.mts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":""}
|
|
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;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,eAAe,GACf,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;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,GACpD,CAAC;CACH"}
|
package/resources/v1/usage.d.ts
CHANGED
|
@@ -1,2 +1,110 @@
|
|
|
1
|
-
|
|
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 Usage extends APIResource {
|
|
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
|
+
export interface UsageGetStatsParams {
|
|
38
|
+
/**
|
|
39
|
+
* End date for stats (ISO 8601)
|
|
40
|
+
*/
|
|
41
|
+
endDate?: string;
|
|
42
|
+
/**
|
|
43
|
+
* Filter by group ID
|
|
44
|
+
*/
|
|
45
|
+
groupId?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Start date for stats (ISO 8601)
|
|
48
|
+
*/
|
|
49
|
+
startDate?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Filter by user ID
|
|
52
|
+
*/
|
|
53
|
+
userId?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface UsageGetSummaryParams {
|
|
56
|
+
/**
|
|
57
|
+
* End date for summary (ISO 8601)
|
|
58
|
+
*/
|
|
59
|
+
endDate: string;
|
|
60
|
+
/**
|
|
61
|
+
* Summary period
|
|
62
|
+
*/
|
|
63
|
+
period: 'hourly' | 'daily' | 'monthly';
|
|
64
|
+
/**
|
|
65
|
+
* Start date for summary (ISO 8601)
|
|
66
|
+
*/
|
|
67
|
+
startDate: string;
|
|
68
|
+
/**
|
|
69
|
+
* Group results by
|
|
70
|
+
*/
|
|
71
|
+
groupBy?: 'user' | 'group' | 'model' | 'endpoint';
|
|
72
|
+
}
|
|
73
|
+
export interface UsageListEventsParams {
|
|
74
|
+
/**
|
|
75
|
+
* End date for filtering (ISO 8601)
|
|
76
|
+
*/
|
|
77
|
+
endDate?: string;
|
|
78
|
+
/**
|
|
79
|
+
* Filter by event type
|
|
80
|
+
*/
|
|
81
|
+
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' | 'chat_feedback' | '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';
|
|
82
|
+
/**
|
|
83
|
+
* Filter by group ID
|
|
84
|
+
*/
|
|
85
|
+
groupId?: string;
|
|
86
|
+
/**
|
|
87
|
+
* Number of results to return
|
|
88
|
+
*/
|
|
89
|
+
limit?: number;
|
|
90
|
+
/**
|
|
91
|
+
* Offset for pagination
|
|
92
|
+
*/
|
|
93
|
+
offset?: number;
|
|
94
|
+
/**
|
|
95
|
+
* Filter by resource ID
|
|
96
|
+
*/
|
|
97
|
+
resourceId?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Start date for filtering (ISO 8601)
|
|
100
|
+
*/
|
|
101
|
+
startDate?: string;
|
|
102
|
+
/**
|
|
103
|
+
* Filter by user ID
|
|
104
|
+
*/
|
|
105
|
+
userId?: string;
|
|
106
|
+
}
|
|
107
|
+
export declare namespace Usage {
|
|
108
|
+
export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
|
|
109
|
+
}
|
|
2
110
|
//# sourceMappingURL=usage.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"usage.d.ts","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;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,eAAe,GACf,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;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,GACpD,CAAC;CACH"}
|
package/resources/v1/usage.js
CHANGED
|
@@ -1,6 +1,59 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
|
|
5
|
-
|
|
4
|
+
exports.Usage = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const headers_1 = require("../../internal/headers.js");
|
|
7
|
+
class Usage extends resource_1.APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Get usage statistics
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* await client.v1.usage.getStats();
|
|
14
|
+
* ```
|
|
15
|
+
*/
|
|
16
|
+
getStats(query = {}, options) {
|
|
17
|
+
return this._client.get('/api/v1/usage/stats', {
|
|
18
|
+
query,
|
|
19
|
+
...options,
|
|
20
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
21
|
+
});
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Get usage summary
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* await client.v1.usage.getSummary({
|
|
29
|
+
* endDate: 'endDate',
|
|
30
|
+
* period: 'hourly',
|
|
31
|
+
* startDate: 'startDate',
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
getSummary(query, options) {
|
|
36
|
+
return this._client.get('/api/v1/usage/summary', {
|
|
37
|
+
query,
|
|
38
|
+
...options,
|
|
39
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Get usage events
|
|
44
|
+
*
|
|
45
|
+
* @example
|
|
46
|
+
* ```ts
|
|
47
|
+
* await client.v1.usage.listEvents();
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
listEvents(query = {}, options) {
|
|
51
|
+
return this._client.get('/api/v1/usage/events', {
|
|
52
|
+
query,
|
|
53
|
+
...options,
|
|
54
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
exports.Usage = Usage;
|
|
6
59
|
//# sourceMappingURL=usage.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,
|
|
1
|
+
{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../src/resources/v1/usage.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAGtD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;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;AAvDD,sBAuDC"}
|
package/resources/v1/usage.mjs
CHANGED
|
@@ -1,3 +1,55 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
-
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../../internal/headers.mjs";
|
|
4
|
+
export class Usage extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Get usage statistics
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* await client.v1.usage.getStats();
|
|
11
|
+
* ```
|
|
12
|
+
*/
|
|
13
|
+
getStats(query = {}, options) {
|
|
14
|
+
return this._client.get('/api/v1/usage/stats', {
|
|
15
|
+
query,
|
|
16
|
+
...options,
|
|
17
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Get usage summary
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* await client.v1.usage.getSummary({
|
|
26
|
+
* endDate: 'endDate',
|
|
27
|
+
* period: 'hourly',
|
|
28
|
+
* startDate: 'startDate',
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
getSummary(query, options) {
|
|
33
|
+
return this._client.get('/api/v1/usage/summary', {
|
|
34
|
+
query,
|
|
35
|
+
...options,
|
|
36
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Get usage events
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* await client.v1.usage.listEvents();
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
listEvents(query = {}, options) {
|
|
48
|
+
return this._client.get('/api/v1/usage/events', {
|
|
49
|
+
query,
|
|
50
|
+
...options,
|
|
51
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
}
|
|
3
55
|
//# sourceMappingURL=usage.mjs.map
|