@easyedu/js-lsm-api 1.102.0 → 1.104.0

package/src/apis/ChatApi.ts

@@ -13,11 +13,41 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type AdminConversationDetail,
+    AdminConversationDetailFromJSON,
+    AdminConversationDetailToJSON,
+} from '../models/AdminConversationDetail';
+import {
+    type AdminConversationList,
+    AdminConversationListFromJSON,
+    AdminConversationListToJSON,
+} from '../models/AdminConversationList';
+import {
+    type ChatQuota,
+    ChatQuotaFromJSON,
+    ChatQuotaToJSON,
+} from '../models/ChatQuota';
+import {
+    type ChatQuotaExceeded,
+    ChatQuotaExceededFromJSON,
+    ChatQuotaExceededToJSON,
+} from '../models/ChatQuotaExceeded';
 import {
     type GetChatMessage,
     GetChatMessageFromJSON,
     GetChatMessageToJSON,
 } from '../models/GetChatMessage';
+import {
+    type GetChatSettings,
+    GetChatSettingsFromJSON,
+    GetChatSettingsToJSON,
+} from '../models/GetChatSettings';
+import {
+    type GetChatUsage,
+    GetChatUsageFromJSON,
+    GetChatUsageToJSON,
+} from '../models/GetChatUsage';
 import {
     type GetConversationList,
     GetConversationListFromJSON,
@@ -43,11 +73,36 @@ import {
     PostMessageResponseFromJSON,
     PostMessageResponseToJSON,
 } from '../models/PostMessageResponse';
+import {
+    type PutChatSettings,
+    PutChatSettingsFromJSON,
+    PutChatSettingsToJSON,
+} from '../models/PutChatSettings';
 
 export interface DeleteConversationRequest {
     conversationId: string;
 }
 
+export interface GetChatAdminConversationRequest {
+    conversationId: string;
+}
+
+export interface GetChatAdminConversationsRequest {
+    page?: number;
+    pageSize?: number;
+    userId?: string;
+    model?: string;
+    createdFrom?: number;
+    createdTo?: number;
+}
+
+export interface GetChatAdminUsageRequest {
+    userId?: string;
+    model?: string;
+    from?: number;
+    to?: number;
+}
+
 export interface GetConversationMessagesRequest {
     conversationId: string;
 }
@@ -66,6 +121,10 @@ export interface PostMessageRequest {
     postMessage: PostMessage;
 }
 
+export interface PutChatAdminSettingsRequest {
+    putChatSettings: PutChatSettings;
+}
+
 /**
  * 
  */
@@ -115,6 +174,239 @@ export class ChatApi extends runtime.BaseAPI {
         await this.deleteConversationRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for getChatAdminConversation without sending the request
+     */
+    async getChatAdminConversationRequestOpts(requestParameters: GetChatAdminConversationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['conversationId'] == null) {
+            throw new runtime.RequiredError(
+                'conversationId',
+                'Required parameter "conversationId" was null or undefined when calling getChatAdminConversation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/chat/admin/conversations/{conversationId}`;
+        urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a conversation transcript from the selected portal
+     */
+    async getChatAdminConversationRaw(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationDetail>> {
+        const requestOptions = await this.getChatAdminConversationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminConversationDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a conversation transcript from the selected portal
+     */
+    async getChatAdminConversation(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationDetail> {
+        const response = await this.getChatAdminConversationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getChatAdminConversations without sending the request
+     */
+    async getChatAdminConversationsRequestOpts(requestParameters: GetChatAdminConversationsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['userId'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['createdFrom'] != null) {
+            queryParameters['createdFrom'] = requestParameters['createdFrom'];
+        }
+
+        if (requestParameters['createdTo'] != null) {
+            queryParameters['createdTo'] = requestParameters['createdTo'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/chat/admin/conversations`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List conversations in the selected portal
+     */
+    async getChatAdminConversationsRaw(requestParameters: GetChatAdminConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationList>> {
+        const requestOptions = await this.getChatAdminConversationsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminConversationListFromJSON(jsonValue));
+    }
+
+    /**
+     * List conversations in the selected portal
+     */
+    async getChatAdminConversations(requestParameters: GetChatAdminConversationsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationList> {
+        const response = await this.getChatAdminConversationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getChatAdminSettings without sending the request
+     */
+    async getChatAdminSettingsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/chat/admin/settings`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get chatbot settings for the selected portal
+     */
+    async getChatAdminSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>> {
+        const requestOptions = await this.getChatAdminSettingsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetChatSettingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Get chatbot settings for the selected portal
+     */
+    async getChatAdminSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings> {
+        const response = await this.getChatAdminSettingsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getChatAdminUsage without sending the request
+     */
+    async getChatAdminUsageRequestOpts(requestParameters: GetChatAdminUsageRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['userId'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = requestParameters['from'];
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = requestParameters['to'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/chat/admin/usage`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get chatbot usage analytics for the selected portal
+     */
+    async getChatAdminUsageRaw(requestParameters: GetChatAdminUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatUsage>> {
+        const requestOptions = await this.getChatAdminUsageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetChatUsageFromJSON(jsonValue));
+    }
+
+    /**
+     * Get chatbot usage analytics for the selected portal
+     */
+    async getChatAdminUsage(requestParameters: GetChatAdminUsageRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatUsage> {
+        const response = await this.getChatAdminUsageRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getChatQuota without sending the request
+     */
+    async getChatQuotaRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/chat/quota`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get the current user\'s chat quota
+     */
+    async getChatQuotaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatQuota>> {
+        const requestOptions = await this.getChatQuotaRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ChatQuotaFromJSON(jsonValue));
+    }
+
+    /**
+     * Get the current user\'s chat quota
+     */
+    async getChatQuota(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatQuota> {
+        const response = await this.getChatQuotaRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getConversationMessages without sending the request
      */
@@ -307,4 +599,51 @@ export class ChatApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putChatAdminSettings without sending the request
+     */
+    async putChatAdminSettingsRequestOpts(requestParameters: PutChatAdminSettingsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['putChatSettings'] == null) {
+            throw new runtime.RequiredError(
+                'putChatSettings',
+                'Required parameter "putChatSettings" was null or undefined when calling putChatAdminSettings().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/chat/admin/settings`;
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutChatSettingsToJSON(requestParameters['putChatSettings']),
+        };
+    }
+
+    /**
+     * Update chatbot settings for the selected portal
+     */
+    async putChatAdminSettingsRaw(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>> {
+        const requestOptions = await this.putChatAdminSettingsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetChatSettingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Update chatbot settings for the selected portal
+     */
+    async putChatAdminSettings(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings> {
+        const response = await this.putChatAdminSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/apis/ContentLibraryQuizApi.ts

@@ -196,6 +196,7 @@ export interface PostCourseLibraryQuizSessionRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
     postCourseLibraryQuizSession?: PostCourseLibraryQuizSession;
 }
 
@@ -888,6 +889,10 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';
@@ -908,7 +913,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
     }
 
     /**
-     * Start or resume a live attempt for a course-pinned quiz version
+     * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
      */
     async postCourseLibraryQuizSessionRaw(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetLibraryQuizSession>> {
         const requestOptions = await this.postCourseLibraryQuizSessionRequestOpts(requestParameters);
@@ -918,7 +923,7 @@ export class ContentLibraryQuizApi extends runtime.BaseAPI {
     }
 
     /**
-     * Start or resume a live attempt for a course-pinned quiz version
+     * Start or resume a live or sandbox-preview attempt for a course-pinned quiz version
      */
     async postCourseLibraryQuizSession(requestParameters: PostCourseLibraryQuizSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetLibraryQuizSession> {
         const response = await this.postCourseLibraryQuizSessionRaw(requestParameters, initOverrides);

package/src/apis/CourseApi.ts

@@ -279,12 +279,14 @@ export interface GetCourseListRequest {
 export interface GetCourseVersionRequest {
     courseId: string;
     courseVersionId: string;
+    preview?: boolean;
 }
 
 export interface GetCourseVersionItemLaunchRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
 }
 
 export interface GetCourseVersionListRequest {
@@ -294,6 +296,7 @@ export interface GetCourseVersionListRequest {
 export interface GetCourseVersionProgressionRequest {
     courseId: string;
     courseVersionId: string;
+    preview?: boolean;
 }
 
 export interface PostCourseRequest {
@@ -351,6 +354,7 @@ export interface PostCourseVersionItemSessionRequest {
     courseId: string;
     courseVersionId: string;
     itemId: string;
+    preview?: boolean;
     postCourseVersionItemSession?: PostCourseVersionItemSession;
 }
 
@@ -1237,6 +1241,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1297,6 +1305,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -1396,6 +1408,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -2027,6 +2043,10 @@ export class CourseApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['preview'] != null) {
+            queryParameters['preview'] = requestParameters['preview'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         headerParameters['Content-Type'] = 'application/json';

package/src/models/AdminChatMessage.ts

@@ -0,0 +1,100 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { ChatTurnUsage } from './ChatTurnUsage';
+import {
+    ChatTurnUsageFromJSON,
+    ChatTurnUsageFromJSONTyped,
+    ChatTurnUsageToJSON,
+    ChatTurnUsageToJSONTyped,
+} from './ChatTurnUsage';
+
+/**
+ * 
+ * @export
+ * @interface AdminChatMessage
+ */
+export interface AdminChatMessage {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminChatMessage
+     */
+    role: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminChatMessage
+     */
+    content: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof AdminChatMessage
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {ChatTurnUsage}
+     * @memberof AdminChatMessage
+     */
+    usage?: ChatTurnUsage | null;
+}
+
+/**
+ * Check if a given object implements the AdminChatMessage interface.
+ */
+export function instanceOfAdminChatMessage(value: object): value is AdminChatMessage {
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('content' in value) || value['content'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function AdminChatMessageFromJSON(json: any): AdminChatMessage {
+    return AdminChatMessageFromJSONTyped(json, false);
+}
+
+export function AdminChatMessageFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminChatMessage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'role': json['role'],
+        'content': json['content'],
+        'createdAt': json['created_at'],
+        'usage': json['usage'] == null ? undefined : ChatTurnUsageFromJSON(json['usage']),
+    };
+}
+
+export function AdminChatMessageToJSON(json: any): AdminChatMessage {
+    return AdminChatMessageToJSONTyped(json, false);
+}
+
+export function AdminChatMessageToJSONTyped(value?: AdminChatMessage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'role': value['role'],
+        'content': value['content'],
+        'created_at': value['createdAt'],
+        'usage': ChatTurnUsageToJSON(value['usage']),
+    };
+}
+