@studyfetch/sdk 1.18.0 → 1.19.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.19.0 (2025-07-21)
+
+Full Changelog: [v1.18.0...v1.19.0](https://github.com/GoStudyFetchGo/studyfetch-sdk/compare/v1.18.0...v1.19.0)
+
+### Features
+
+* **api:** api update ([7ad2574](https://github.com/GoStudyFetchGo/studyfetch-sdk/commit/7ad257440de49325c8df045ecd2213b2c7ba2a39))
+* **api:** manual updates ([98bf790](https://github.com/GoStudyFetchGo/studyfetch-sdk/commit/98bf7909ef746023dae51170cd7c78c7f7f8d8cf))
+
 ## 1.18.0 (2025-07-20)
 
 Full Changelog: [v1.17.0...v1.18.0](https://github.com/GoStudyFetchGo/studyfetch-sdk/compare/v1.17.0...v1.18.0)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyfetch/sdk",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "description": "The official TypeScript library for the Studyfetch SDK API",
   "author": "Studyfetch SDK <support@studyfetch.com>",
   "types": "./index.d.ts",

package/resources/v1/index.d.mts

@@ -10,6 +10,6 @@ export { Materials, type Material, type MaterialListResponse, type MaterialCreat
 export { Scenarios, type Scenario, type UpdateScenario, type ScenarioCreateParams, type ScenarioUpdateParams, type ScenarioSubmitAnswerParams, } from "./scenarios/index.mjs";
 export { Tests, type TestCreateParams, type TestRetakeParams, type TestSubmitParams, type TestSubmitAnswerParams, } from "./tests/index.mjs";
 export { Upload } from "./upload/index.mjs";
-export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.mjs";
+export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage/index.mjs";
 export { V1 } from "./v1.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/v1/index.d.ts

@@ -10,6 +10,6 @@ export { Materials, type Material, type MaterialListResponse, type MaterialCreat
 export { Scenarios, type Scenario, type UpdateScenario, type ScenarioCreateParams, type ScenarioUpdateParams, type ScenarioSubmitAnswerParams, } from "./scenarios/index.js";
 export { Tests, type TestCreateParams, type TestRetakeParams, type TestSubmitParams, type TestSubmitAnswerParams, } from "./tests/index.js";
 export { Upload } from "./upload/index.js";
-export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.js";
+export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage/index.js";
 export { V1 } from "./v1.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/v1/index.js

@@ -26,8 +26,8 @@ var index_6 = require("./tests/index.js");
 Object.defineProperty(exports, "Tests", { enumerable: true, get: function () { return index_6.Tests; } });
 var index_7 = require("./upload/index.js");
 Object.defineProperty(exports, "Upload", { enumerable: true, get: function () { return index_7.Upload; } });
-var usage_1 = require("./usage.js");
-Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return usage_1.Usage; } });
+var index_8 = require("./usage/index.js");
+Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return index_8.Usage; } });
 var v1_1 = require("./v1.js");
 Object.defineProperty(exports, "V1", { enumerable: true, get: function () { return v1_1.V1; } });
 //# sourceMappingURL=index.js.map

package/resources/v1/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAK6B;AAJ3B,qHAAA,gBAAgB,OAAA;AAKlB,iDAI8B;AAH5B,oGAAA,WAAW,OAAA;AAIb,yCAKsB;AAJpB,6FAAA,IAAI,OAAA;AAKN,8CASsB;AARpB,wGAAA,UAAU,OAAA;AASZ,0CAAwF;AAA/E,8FAAA,KAAK,OAAA;AACd,8CAAyG;AAAhG,wGAAA,UAAU,OAAA;AACnB,8CAUsB;AATpB,wGAAA,UAAU,OAAA;AAUZ,wCAA6G;AAApG,kGAAA,OAAO,OAAA;AAChB,8CAO2B;AANzB,kGAAA,SAAS,OAAA;AAOX,8CAO2B;AANzB,kGAAA,SAAS,OAAA;AAOX,0CAMuB;AALrB,8FAAA,KAAK,OAAA;AAMP,2CAAwC;AAA/B,+FAAA,MAAM,OAAA;AACf,oCAKiB;AAJf,8FAAA,KAAK,OAAA;AAKP,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/v1/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,4DAK6B;AAJ3B,qHAAA,gBAAgB,OAAA;AAKlB,iDAI8B;AAH5B,oGAAA,WAAW,OAAA;AAIb,yCAKsB;AAJpB,6FAAA,IAAI,OAAA;AAKN,8CASsB;AARpB,wGAAA,UAAU,OAAA;AASZ,0CAAwF;AAA/E,8FAAA,KAAK,OAAA;AACd,8CAAyG;AAAhG,wGAAA,UAAU,OAAA;AACnB,8CAUsB;AATpB,wGAAA,UAAU,OAAA;AAUZ,wCAA6G;AAApG,kGAAA,OAAO,OAAA;AAChB,8CAO2B;AANzB,kGAAA,SAAS,OAAA;AAOX,8CAO2B;AANzB,kGAAA,SAAS,OAAA;AAOX,0CAMuB;AALrB,8FAAA,KAAK,OAAA;AAMP,2CAAwC;AAA/B,+FAAA,MAAM,OAAA;AACf,0CAKuB;AAJrB,8FAAA,KAAK,OAAA;AAKP,8BAA0B;AAAjB,wFAAA,EAAE,OAAA"}

package/resources/v1/index.mjs

@@ -11,6 +11,6 @@ export { Materials, } from "./materials/index.mjs";
 export { Scenarios, } from "./scenarios/index.mjs";
 export { Tests, } from "./tests/index.mjs";
 export { Upload } from "./upload/index.mjs";
-export { Usage, } from "./usage.mjs";
+export { Usage, } from "./usage/index.mjs";
 export { V1 } from "./v1.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/v1/usage/analyst.d.mts

@@ -0,0 +1,54 @@
+import { APIResource } from "../../../core/resource.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Analyst extends APIResource {
+    /**
+     * Get test results for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.getTestQuestions();
+     * ```
+     */
+    getTestQuestions(options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get chat messages for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listChatMessages();
+     * ```
+     */
+    listChatMessages(options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get all events based on filters
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listEvents({
+     *   endDate: 'endDate',
+     *   eventType: 'material_created',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    listEvents(query: AnalystListEventsParams, options?: RequestOptions): APIPromise<void>;
+}
+export interface AnalystListEventsParams {
+    /**
+     * End date for filtering (ISO 8601)
+     */
+    endDate: string;
+    /**
+     * Type of usage event to filter
+     */
+    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';
+    /**
+     * Start date for filtering (ISO 8601)
+     */
+    startDate: string;
+}
+export declare namespace Analyst {
+    export { type AnalystListEventsParams as AnalystListEventsParams };
+}
+//# sourceMappingURL=analyst.d.mts.map

package/resources/v1/usage/analyst.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"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,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"}

package/resources/v1/usage/analyst.d.ts

@@ -0,0 +1,54 @@
+import { APIResource } from "../../../core/resource.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Analyst extends APIResource {
+    /**
+     * Get test results for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.getTestQuestions();
+     * ```
+     */
+    getTestQuestions(options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get chat messages for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listChatMessages();
+     * ```
+     */
+    listChatMessages(options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get all events based on filters
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listEvents({
+     *   endDate: 'endDate',
+     *   eventType: 'material_created',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    listEvents(query: AnalystListEventsParams, options?: RequestOptions): APIPromise<void>;
+}
+export interface AnalystListEventsParams {
+    /**
+     * End date for filtering (ISO 8601)
+     */
+    endDate: string;
+    /**
+     * Type of usage event to filter
+     */
+    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';
+    /**
+     * Start date for filtering (ISO 8601)
+     */
+    startDate: string;
+}
+export declare namespace Analyst {
+    export { type AnalystListEventsParams as AnalystListEventsParams };
+}
+//# sourceMappingURL=analyst.d.ts.map

package/resources/v1/usage/analyst.d.ts.map

@@ -0,0 +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"}

package/resources/v1/usage/analyst.js

@@ -0,0 +1,57 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analyst = void 0;
+const resource_1 = require("../../../core/resource.js");
+const headers_1 = require("../../../internal/headers.js");
+class Analyst extends resource_1.APIResource {
+    /**
+     * Get test results for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.getTestQuestions();
+     * ```
+     */
+    getTestQuestions(options) {
+        return this._client.get('/api/v1/usage-analyst/test-questions', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get chat messages for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listChatMessages();
+     * ```
+     */
+    listChatMessages(options) {
+        return this._client.get('/api/v1/usage-analyst/chat-messages', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get all events based on filters
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listEvents({
+     *   endDate: 'endDate',
+     *   eventType: 'material_created',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    listEvents(query, options) {
+        return this._client.get('/api/v1/usage-analyst/events', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+exports.Analyst = Analyst;
+//# sourceMappingURL=analyst.js.map

package/resources/v1/usage/analyst.js.map

@@ -0,0 +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"}

package/resources/v1/usage/analyst.mjs

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import { buildHeaders } from "../../../internal/headers.mjs";
+export class Analyst extends APIResource {
+    /**
+     * Get test results for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.getTestQuestions();
+     * ```
+     */
+    getTestQuestions(options) {
+        return this._client.get('/api/v1/usage-analyst/test-questions', {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get chat messages for users and groups in JWT
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listChatMessages();
+     * ```
+     */
+    listChatMessages(options) {
+        return this._client.get('/api/v1/usage-analyst/chat-messages', {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Get all events based on filters
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.analyst.listEvents({
+     *   endDate: 'endDate',
+     *   eventType: 'material_created',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    listEvents(query, options) {
+        return this._client.get('/api/v1/usage-analyst/events', {
+            query,
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+}
+//# sourceMappingURL=analyst.mjs.map

package/resources/v1/usage/analyst.mjs.map

@@ -0,0 +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"}

package/resources/v1/usage/index.d.mts

@@ -0,0 +1,3 @@
+export { Analyst, type AnalystListEventsParams } from "./analyst.mjs";
+export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/v1/usage/index.d.mts.map

@@ -0,0 +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"}

package/resources/v1/usage/index.d.ts

@@ -0,0 +1,3 @@
+export { Analyst, type AnalystListEventsParams } from "./analyst.js";
+export { Usage, type UsageGetStatsParams, type UsageGetSummaryParams, type UsageListEventsParams, } from "./usage.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/v1/usage/index.d.ts.map

@@ -0,0 +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"}

package/resources/v1/usage/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Usage = exports.Analyst = void 0;
+var analyst_1 = require("./analyst.js");
+Object.defineProperty(exports, "Analyst", { enumerable: true, get: function () { return analyst_1.Analyst; } });
+var usage_1 = require("./usage.js");
+Object.defineProperty(exports, "Usage", { enumerable: true, get: function () { return usage_1.Usage; } });
+//# sourceMappingURL=index.js.map

package/resources/v1/usage/index.js.map

@@ -0,0 +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"}

package/resources/v1/usage/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Analyst } from "./analyst.mjs";
+export { Usage, } from "./usage.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/v1/usage/index.mjs.map

@@ -0,0 +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"}

package/resources/v1/usage/usage.d.mts

@@ -0,0 +1,114 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as AnalystAPI from "./analyst.mjs";
+import { Analyst, AnalystListEventsParams } from "./analyst.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+export declare class Usage extends APIResource {
+    analyst: AnalystAPI.Analyst;
+    /**
+     * Get usage statistics
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.getStats();
+     * ```
+     */
+    getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get usage summary
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.getSummary({
+     *   endDate: 'endDate',
+     *   period: 'hourly',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get usage events
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.listEvents();
+     * ```
+     */
+    listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+}
+export interface UsageGetStatsParams {
+    /**
+     * End date for stats (ISO 8601)
+     */
+    endDate?: string;
+    /**
+     * Filter by group ID
+     */
+    groupId?: string;
+    /**
+     * Start date for stats (ISO 8601)
+     */
+    startDate?: string;
+    /**
+     * Filter by user ID
+     */
+    userId?: string;
+}
+export interface UsageGetSummaryParams {
+    /**
+     * End date for summary (ISO 8601)
+     */
+    endDate: string;
+    /**
+     * Summary period
+     */
+    period: 'hourly' | 'daily' | 'monthly';
+    /**
+     * Start date for summary (ISO 8601)
+     */
+    startDate: string;
+    /**
+     * Group results by
+     */
+    groupBy?: 'user' | 'group' | 'model' | 'endpoint';
+}
+export interface UsageListEventsParams {
+    /**
+     * End date for filtering (ISO 8601)
+     */
+    endDate?: string;
+    /**
+     * Filter by event type
+     */
+    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';
+    /**
+     * Filter by group ID
+     */
+    groupId?: string;
+    /**
+     * Number of results to return
+     */
+    limit?: number;
+    /**
+     * Offset for pagination
+     */
+    offset?: number;
+    /**
+     * Filter by resource ID
+     */
+    resourceId?: string;
+    /**
+     * Start date for filtering (ISO 8601)
+     */
+    startDate?: string;
+    /**
+     * Filter by user ID
+     */
+    userId?: string;
+}
+export declare namespace Usage {
+    export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
+    export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
+}
+//# sourceMappingURL=usage.d.mts.map

package/resources/v1/usage/usage.d.mts.map

@@ -0,0 +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"}

package/resources/v1/usage/usage.d.ts

@@ -0,0 +1,114 @@
+import { APIResource } from "../../../core/resource.js";
+import * as AnalystAPI from "./analyst.js";
+import { Analyst, AnalystListEventsParams } from "./analyst.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+export declare class Usage extends APIResource {
+    analyst: AnalystAPI.Analyst;
+    /**
+     * Get usage statistics
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.getStats();
+     * ```
+     */
+    getStats(query?: UsageGetStatsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get usage summary
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.getSummary({
+     *   endDate: 'endDate',
+     *   period: 'hourly',
+     *   startDate: 'startDate',
+     * });
+     * ```
+     */
+    getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Get usage events
+     *
+     * @example
+     * ```ts
+     * await client.v1.usage.listEvents();
+     * ```
+     */
+    listEvents(query?: UsageListEventsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+}
+export interface UsageGetStatsParams {
+    /**
+     * End date for stats (ISO 8601)
+     */
+    endDate?: string;
+    /**
+     * Filter by group ID
+     */
+    groupId?: string;
+    /**
+     * Start date for stats (ISO 8601)
+     */
+    startDate?: string;
+    /**
+     * Filter by user ID
+     */
+    userId?: string;
+}
+export interface UsageGetSummaryParams {
+    /**
+     * End date for summary (ISO 8601)
+     */
+    endDate: string;
+    /**
+     * Summary period
+     */
+    period: 'hourly' | 'daily' | 'monthly';
+    /**
+     * Start date for summary (ISO 8601)
+     */
+    startDate: string;
+    /**
+     * Group results by
+     */
+    groupBy?: 'user' | 'group' | 'model' | 'endpoint';
+}
+export interface UsageListEventsParams {
+    /**
+     * End date for filtering (ISO 8601)
+     */
+    endDate?: string;
+    /**
+     * Filter by event type
+     */
+    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';
+    /**
+     * Filter by group ID
+     */
+    groupId?: string;
+    /**
+     * Number of results to return
+     */
+    limit?: number;
+    /**
+     * Offset for pagination
+     */
+    offset?: number;
+    /**
+     * Filter by resource ID
+     */
+    resourceId?: string;
+    /**
+     * Start date for filtering (ISO 8601)
+     */
+    startDate?: string;
+    /**
+     * Filter by user ID
+     */
+    userId?: string;
+}
+export declare namespace Usage {
+    export { type UsageGetStatsParams as UsageGetStatsParams, type UsageGetSummaryParams as UsageGetSummaryParams, type UsageListEventsParams as UsageListEventsParams, };
+    export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
+}
+//# sourceMappingURL=usage.d.ts.map

package/resources/v1/usage/usage.d.ts.map

@@ -0,0 +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"}