@easyedu/js-lsm-api 1.103.0 → 1.105.0

package/dist/models/GetPortalInvitationSummary.d.ts

@@ -0,0 +1,102 @@
+/**
+ * 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.
+ */
+/**
+ * Invitation lifecycle and latest email delivery state for a portal user.
+ * @export
+ * @interface GetPortalInvitationSummary
+ */
+export interface GetPortalInvitationSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    id: string;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    status: GetPortalInvitationSummaryStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    invitedAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    expiresAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    acceptedAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof GetPortalInvitationSummary
+     */
+    lastSentAt?: number | null;
+    /**
+     *
+     * @type {GetPortalInvitationSummaryLatestDeliveryStatusEnum}
+     * @memberof GetPortalInvitationSummary
+     */
+    latestDeliveryStatus?: GetPortalInvitationSummaryLatestDeliveryStatusEnum | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof GetPortalInvitationSummary
+     */
+    canResend: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortalInvitationSummary
+     */
+    resendBlockedReason?: string | null;
+}
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryStatusEnum: {
+    readonly Pending: "pending";
+    readonly Expired: "expired";
+    readonly Accepted: "accepted";
+};
+export type GetPortalInvitationSummaryStatusEnum = typeof GetPortalInvitationSummaryStatusEnum[keyof typeof GetPortalInvitationSummaryStatusEnum];
+/**
+ * @export
+ */
+export declare const GetPortalInvitationSummaryLatestDeliveryStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Accepted: "accepted";
+    readonly Delivered: "delivered";
+    readonly Deferred: "deferred";
+    readonly Failed: "failed";
+    readonly Complained: "complained";
+};
+export type GetPortalInvitationSummaryLatestDeliveryStatusEnum = typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum[keyof typeof GetPortalInvitationSummaryLatestDeliveryStatusEnum];
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+export declare function instanceOfGetPortalInvitationSummary(value: object): value is GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSON(json: any): GetPortalInvitationSummary;
+export declare function GetPortalInvitationSummaryToJSONTyped(value?: GetPortalInvitationSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPortalInvitationSummary.js

@@ -0,0 +1,95 @@
+"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.GetPortalInvitationSummaryLatestDeliveryStatusEnum = exports.GetPortalInvitationSummaryStatusEnum = void 0;
+exports.instanceOfGetPortalInvitationSummary = instanceOfGetPortalInvitationSummary;
+exports.GetPortalInvitationSummaryFromJSON = GetPortalInvitationSummaryFromJSON;
+exports.GetPortalInvitationSummaryFromJSONTyped = GetPortalInvitationSummaryFromJSONTyped;
+exports.GetPortalInvitationSummaryToJSON = GetPortalInvitationSummaryToJSON;
+exports.GetPortalInvitationSummaryToJSONTyped = GetPortalInvitationSummaryToJSONTyped;
+/**
+ * @export
+ */
+exports.GetPortalInvitationSummaryStatusEnum = {
+    Pending: 'pending',
+    Expired: 'expired',
+    Accepted: 'accepted'
+};
+/**
+ * @export
+ */
+exports.GetPortalInvitationSummaryLatestDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+};
+/**
+ * Check if a given object implements the GetPortalInvitationSummary interface.
+ */
+function instanceOfGetPortalInvitationSummary(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('invitedAt' in value) || value['invitedAt'] === undefined)
+        return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined)
+        return false;
+    if (!('canResend' in value) || value['canResend'] === undefined)
+        return false;
+    return true;
+}
+function GetPortalInvitationSummaryFromJSON(json) {
+    return GetPortalInvitationSummaryFromJSONTyped(json, false);
+}
+function GetPortalInvitationSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'status': json['status'],
+        'invitedAt': json['invited_at'],
+        'expiresAt': json['expires_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'lastSentAt': json['last_sent_at'] == null ? undefined : json['last_sent_at'],
+        'latestDeliveryStatus': json['latest_delivery_status'] == null ? undefined : json['latest_delivery_status'],
+        'canResend': json['can_resend'],
+        'resendBlockedReason': json['resend_blocked_reason'] == null ? undefined : json['resend_blocked_reason'],
+    };
+}
+function GetPortalInvitationSummaryToJSON(json) {
+    return GetPortalInvitationSummaryToJSONTyped(json, false);
+}
+function GetPortalInvitationSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'status': value['status'],
+        'invited_at': value['invitedAt'],
+        'expires_at': value['expiresAt'],
+        'accepted_at': value['acceptedAt'],
+        'last_sent_at': value['lastSentAt'],
+        'latest_delivery_status': value['latestDeliveryStatus'],
+        'can_resend': value['canResend'],
+        'resend_blocked_reason': value['resendBlockedReason'],
+    };
+}

package/dist/models/GetPortalUser.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { GetPortalInvitationSummary } from './GetPortalInvitationSummary';
 /**
  * A user with their portal access information
  * @export
@@ -51,6 +52,12 @@ export interface GetPortalUser {
      * @memberof GetPortalUser
      */
     isActive: boolean;
+    /**
+     *
+     * @type {GetPortalInvitationSummary}
+     * @memberof GetPortalUser
+     */
+    invitation?: GetPortalInvitationSummary | null;
 }
 /**
  * Check if a given object implements the GetPortalUser interface.

package/dist/models/GetPortalUser.js

@@ -18,6 +18,7 @@ exports.GetPortalUserFromJSON = GetPortalUserFromJSON;
 exports.GetPortalUserFromJSONTyped = GetPortalUserFromJSONTyped;
 exports.GetPortalUserToJSON = GetPortalUserToJSON;
 exports.GetPortalUserToJSONTyped = GetPortalUserToJSONTyped;
+const GetPortalInvitationSummary_1 = require("./GetPortalInvitationSummary");
 /**
  * Check if a given object implements the GetPortalUser interface.
  */
@@ -50,6 +51,7 @@ function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
         'lastName': json['last_name'],
         'role': json['role'],
         'isActive': json['is_active'],
+        'invitation': json['invitation'] == null ? undefined : (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryFromJSON)(json['invitation']),
     };
 }
 function GetPortalUserToJSON(json) {
@@ -66,5 +68,6 @@ function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
         'last_name': value['lastName'],
         'role': value['role'],
         'is_active': value['isActive'],
+        'invitation': (0, GetPortalInvitationSummary_1.GetPortalInvitationSummaryToJSON)(value['invitation']),
     };
 }

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';
@@ -81,6 +94,7 @@ export * from './GetLibraryQuizVersion';
 export * from './GetPermission';
 export * from './GetPortal';
 export * from './GetPortalFaviconUpload';
+export * from './GetPortalInvitationSummary';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalUser';
@@ -218,6 +232,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);
@@ -99,6 +112,7 @@ __exportStar(require("./GetLibraryQuizVersion"), exports);
 __exportStar(require("./GetPermission"), exports);
 __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalFaviconUpload"), exports);
+__exportStar(require("./GetPortalInvitationSummary"), exports);
 __exportStar(require("./GetPortalList"), exports);
 __exportStar(require("./GetPortalLogoUpload"), exports);
 __exportStar(require("./GetPortalUser"), exports);
@@ -236,6 +250,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)
+
+