@easyedu/js-lsm-api 1.102.0 → 1.104.0

package/dist/models/GetChatUsage.d.ts

@@ -0,0 +1,59 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ChatDailyUsage } from './ChatDailyUsage';
+import type { ChatModelUsage } from './ChatModelUsage';
+import type { ChatUsageTotals } from './ChatUsageTotals';
+/**
+ *
+ * @export
+ * @interface GetChatUsage
+ */
+export interface GetChatUsage {
+    /**
+     *
+     * @type {number}
+     * @memberof GetChatUsage
+     */
+    from: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetChatUsage
+     */
+    to: number;
+    /**
+     *
+     * @type {ChatUsageTotals}
+     * @memberof GetChatUsage
+     */
+    totals: ChatUsageTotals;
+    /**
+     *
+     * @type {Array<ChatDailyUsage>}
+     * @memberof GetChatUsage
+     */
+    daily: Array<ChatDailyUsage>;
+    /**
+     *
+     * @type {Array<ChatModelUsage>}
+     * @memberof GetChatUsage
+     */
+    modelUsage: Array<ChatModelUsage>;
+}
+/**
+ * Check if a given object implements the GetChatUsage interface.
+ */
+export declare function instanceOfGetChatUsage(value: object): value is GetChatUsage;
+export declare function GetChatUsageFromJSON(json: any): GetChatUsage;
+export declare function GetChatUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChatUsage;
+export declare function GetChatUsageToJSON(json: any): GetChatUsage;
+export declare function GetChatUsageToJSONTyped(value?: GetChatUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetChatUsage.js

@@ -0,0 +1,69 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetChatUsage = instanceOfGetChatUsage;
+exports.GetChatUsageFromJSON = GetChatUsageFromJSON;
+exports.GetChatUsageFromJSONTyped = GetChatUsageFromJSONTyped;
+exports.GetChatUsageToJSON = GetChatUsageToJSON;
+exports.GetChatUsageToJSONTyped = GetChatUsageToJSONTyped;
+const ChatDailyUsage_1 = require("./ChatDailyUsage");
+const ChatModelUsage_1 = require("./ChatModelUsage");
+const ChatUsageTotals_1 = require("./ChatUsageTotals");
+/**
+ * Check if a given object implements the GetChatUsage interface.
+ */
+function instanceOfGetChatUsage(value) {
+    if (!('from' in value) || value['from'] === undefined)
+        return false;
+    if (!('to' in value) || value['to'] === undefined)
+        return false;
+    if (!('totals' in value) || value['totals'] === undefined)
+        return false;
+    if (!('daily' in value) || value['daily'] === undefined)
+        return false;
+    if (!('modelUsage' in value) || value['modelUsage'] === undefined)
+        return false;
+    return true;
+}
+function GetChatUsageFromJSON(json) {
+    return GetChatUsageFromJSONTyped(json, false);
+}
+function GetChatUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'from': json['from'],
+        'to': json['to'],
+        'totals': (0, ChatUsageTotals_1.ChatUsageTotalsFromJSON)(json['totals']),
+        'daily': (json['daily'].map(ChatDailyUsage_1.ChatDailyUsageFromJSON)),
+        'modelUsage': (json['model_usage'].map(ChatModelUsage_1.ChatModelUsageFromJSON)),
+    };
+}
+function GetChatUsageToJSON(json) {
+    return GetChatUsageToJSONTyped(json, false);
+}
+function GetChatUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'from': value['from'],
+        'to': value['to'],
+        'totals': (0, ChatUsageTotals_1.ChatUsageTotalsToJSON)(value['totals']),
+        'daily': (value['daily'].map(ChatDailyUsage_1.ChatDailyUsageToJSON)),
+        'model_usage': (value['modelUsage'].map(ChatModelUsage_1.ChatModelUsageToJSON)),
+    };
+}

package/dist/models/GetCourseVersionProgression.d.ts

@@ -13,7 +13,7 @@ import type { GetCourseVersionItemProgression } from './GetCourseVersionItemProg
 import type { CourseProgressionMode } from './CourseProgressionMode';
 import type { GetCourseVersionSectionProgression } from './GetCourseVersionSectionProgression';
 /**
- * Learner-specific completion and lock state for an enrollment-pinned course version.
+ * Learner-specific live completion state, or isolated sandbox completion state during an authorized course preview.
  * @export
  * @interface GetCourseVersionProgression
  */

package/dist/models/PostCourseVersionItemSession.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Start or resume a learner attempt for an exact course resource version.
+ * Start or resume a learner attempt, or an isolated sandbox preview attempt, for an exact course resource version.
  * @export
  * @interface PostCourseVersionItemSession
  */

package/dist/models/PutChatSettings.d.ts

@@ -0,0 +1,32 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PutChatSettings
+ */
+export interface PutChatSettings {
+    /**
+     *
+     * @type {number}
+     * @memberof PutChatSettings
+     */
+    learnerDailyMessageLimit: number;
+}
+/**
+ * Check if a given object implements the PutChatSettings interface.
+ */
+export declare function instanceOfPutChatSettings(value: object): value is PutChatSettings;
+export declare function PutChatSettingsFromJSON(json: any): PutChatSettings;
+export declare function PutChatSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutChatSettings;
+export declare function PutChatSettingsToJSON(json: any): PutChatSettings;
+export declare function PutChatSettingsToJSONTyped(value?: PutChatSettings | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutChatSettings.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutChatSettings = instanceOfPutChatSettings;
+exports.PutChatSettingsFromJSON = PutChatSettingsFromJSON;
+exports.PutChatSettingsFromJSONTyped = PutChatSettingsFromJSONTyped;
+exports.PutChatSettingsToJSON = PutChatSettingsToJSON;
+exports.PutChatSettingsToJSONTyped = PutChatSettingsToJSONTyped;
+/**
+ * Check if a given object implements the PutChatSettings interface.
+ */
+function instanceOfPutChatSettings(value) {
+    if (!('learnerDailyMessageLimit' in value) || value['learnerDailyMessageLimit'] === undefined)
+        return false;
+    return true;
+}
+function PutChatSettingsFromJSON(json) {
+    return PutChatSettingsFromJSONTyped(json, false);
+}
+function PutChatSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'learnerDailyMessageLimit': json['learner_daily_message_limit'],
+    };
+}
+function PutChatSettingsToJSON(json) {
+    return PutChatSettingsToJSONTyped(json, false);
+}
+function PutChatSettingsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'learner_daily_message_limit': value['learnerDailyMessageLimit'],
+    };
+}

package/dist/models/index.d.ts

@@ -1,3 +1,7 @@
+export * from './AdminChatMessage';
+export * from './AdminConversationDetail';
+export * from './AdminConversationList';
+export * from './AdminConversationSummary';
 export * from './ArtifactConflict';
 export * from './BadgeIssuer';
 export * from './Certificate';
@@ -20,6 +24,13 @@ export * from './CertificatePublic';
 export * from './CertificateRenewalPolicy';
 export * from './CertificateTemplate';
 export * from './CertificateTemplateVersion';
+export * from './ChatDailyUsage';
+export * from './ChatModelUsage';
+export * from './ChatQuota';
+export * from './ChatQuotaExceeded';
+export * from './ChatTurnUsage';
+export * from './ChatUsageTotals';
+export * from './ChatUserIdentity';
 export * from './ContentLaunchMode';
 export * from './ContentLibraryVersionStatus';
 export * from './CourseCatalog';
@@ -39,6 +50,8 @@ export * from './GetCertificateTemplateList';
 export * from './GetChangelogEntry';
 export * from './GetChangelogList';
 export * from './GetChatMessage';
+export * from './GetChatSettings';
+export * from './GetChatUsage';
 export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
@@ -218,6 +231,7 @@ export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
 export * from './PutCertificateTemplate';
 export * from './PutCertificateTemplateDraft';
+export * from './PutChatSettings';
 export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';

package/dist/models/index.js

@@ -16,6 +16,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /* tslint:disable */
 /* eslint-disable */
+__exportStar(require("./AdminChatMessage"), exports);
+__exportStar(require("./AdminConversationDetail"), exports);
+__exportStar(require("./AdminConversationList"), exports);
+__exportStar(require("./AdminConversationSummary"), exports);
 __exportStar(require("./ArtifactConflict"), exports);
 __exportStar(require("./BadgeIssuer"), exports);
 __exportStar(require("./Certificate"), exports);
@@ -38,6 +42,13 @@ __exportStar(require("./CertificatePublic"), exports);
 __exportStar(require("./CertificateRenewalPolicy"), exports);
 __exportStar(require("./CertificateTemplate"), exports);
 __exportStar(require("./CertificateTemplateVersion"), exports);
+__exportStar(require("./ChatDailyUsage"), exports);
+__exportStar(require("./ChatModelUsage"), exports);
+__exportStar(require("./ChatQuota"), exports);
+__exportStar(require("./ChatQuotaExceeded"), exports);
+__exportStar(require("./ChatTurnUsage"), exports);
+__exportStar(require("./ChatUsageTotals"), exports);
+__exportStar(require("./ChatUserIdentity"), exports);
 __exportStar(require("./ContentLaunchMode"), exports);
 __exportStar(require("./ContentLibraryVersionStatus"), exports);
 __exportStar(require("./CourseCatalog"), exports);
@@ -57,6 +68,8 @@ __exportStar(require("./GetCertificateTemplateList"), exports);
 __exportStar(require("./GetChangelogEntry"), exports);
 __exportStar(require("./GetChangelogList"), exports);
 __exportStar(require("./GetChatMessage"), exports);
+__exportStar(require("./GetChatSettings"), exports);
+__exportStar(require("./GetChatUsage"), exports);
 __exportStar(require("./GetContentLibraryVersion"), exports);
 __exportStar(require("./GetConversation"), exports);
 __exportStar(require("./GetConversationList"), exports);
@@ -236,6 +249,7 @@ __exportStar(require("./PutBadgeIssuer"), exports);
 __exportStar(require("./PutCertificateConfig"), exports);
 __exportStar(require("./PutCertificateTemplate"), exports);
 __exportStar(require("./PutCertificateTemplateDraft"), exports);
+__exportStar(require("./PutChatSettings"), exports);
 __exportStar(require("./PutCourse"), exports);
 __exportStar(require("./PutCourseCatalog"), exports);
 __exportStar(require("./PutCourseEnrollment"), exports);

package/docs/AdminChatMessage.md

@@ -0,0 +1,40 @@
+
+# AdminChatMessage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`role` | string
+`content` | string
+`createdAt` | number
+`usage` | [ChatTurnUsage](ChatTurnUsage.md)
+
+## Example
+
+```typescript
+import type { AdminChatMessage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "role": null,
+  "content": null,
+  "createdAt": null,
+  "usage": null,
+} satisfies AdminChatMessage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdminChatMessage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AdminConversationDetail.md

@@ -0,0 +1,52 @@
+
+# AdminConversationDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`user` | [ChatUserIdentity](ChatUserIdentity.md)
+`title` | string
+`createdAt` | number
+`updatedAt` | number
+`messageCount` | number
+`model` | string
+`usage` | [ChatUsageTotals](ChatUsageTotals.md)
+`modelUsage` | [Array<ChatModelUsage>](ChatModelUsage.md)
+`messages` | [Array<AdminChatMessage>](AdminChatMessage.md)
+
+## Example
+
+```typescript
+import type { AdminConversationDetail } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "user": null,
+  "title": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "messageCount": null,
+  "model": null,
+  "usage": null,
+  "modelUsage": null,
+  "messages": null,
+} satisfies AdminConversationDetail
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdminConversationDetail
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AdminConversationList.md

@@ -0,0 +1,42 @@
+
+# AdminConversationList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<AdminConversationSummary>](AdminConversationSummary.md)
+
+## Example
+
+```typescript
+import type { AdminConversationList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+  "items": null,
+} satisfies AdminConversationList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdminConversationList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AdminConversationSummary.md

@@ -0,0 +1,50 @@
+
+# AdminConversationSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`user` | [ChatUserIdentity](ChatUserIdentity.md)
+`title` | string
+`createdAt` | number
+`updatedAt` | number
+`messageCount` | number
+`model` | string
+`usage` | [ChatUsageTotals](ChatUsageTotals.md)
+`modelUsage` | [Array<ChatModelUsage>](ChatModelUsage.md)
+
+## Example
+
+```typescript
+import type { AdminConversationSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "user": null,
+  "title": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "messageCount": null,
+  "model": null,
+  "usage": null,
+  "modelUsage": null,
+} satisfies AdminConversationSummary
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AdminConversationSummary
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+