@easyedu/js-lsm-api 1.90.0 → 1.92.0

package/dist/apis/PlayerApi.d.ts

@@ -11,8 +11,12 @@
  */
 import * as runtime from '../runtime';
 import { type GetResourceSession } from '../models/GetResourceSession';
+import { type GetResourceSessionDiagnostics } from '../models/GetResourceSessionDiagnostics';
 import { type GetResourceSessionList } from '../models/GetResourceSessionList';
+import { type GetResourceSessionScormApiLogs } from '../models/GetResourceSessionScormApiLogs';
+import { type GetResourceSessionScormData } from '../models/GetResourceSessionScormData';
 import { type ResourceSessionEnvironment } from '../models/ResourceSessionEnvironment';
+import { type ResourceType } from '../models/ResourceType';
 import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
 import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
 import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
@@ -36,6 +40,9 @@ export interface GetFilePlayerRequest {
 export interface GetImagePlayerRequest {
     sessionId: string;
 }
+export interface GetLibraryQuizSessionPlayerRequest {
+    sessionId: string;
+}
 export interface GetPdfAssetRequest {
     contentId: string;
 }
@@ -56,21 +63,46 @@ export interface GetResourceSessionAssetRequest {
     sessionId: string;
     assetPath: string;
 }
+export interface GetResourceSessionDiagnosticsRequest {
+    sessionId: string;
+}
 export interface GetResourceSessionListRequest {
     userId?: string;
     resourceId?: string;
     versionId?: string;
     courseId?: string;
+    courseVersionId?: string;
+    itemId?: string;
+    resourceType?: ResourceType;
     environment?: ResourceSessionEnvironment;
-    completionStatus?: string;
+    completionStatus?: GetResourceSessionListCompletionStatusEnum;
+    gradeStatus?: GetResourceSessionListGradeStatusEnum;
+    isCurrent?: boolean;
+    attemptNumber?: number;
     createdFrom?: number;
     createdTo?: number;
+    updatedFrom?: number;
+    updatedTo?: number;
+    hasScormErrors?: boolean;
+    sortBy?: GetResourceSessionListSortByEnum;
+    sortDirection?: GetResourceSessionListSortDirectionEnum;
     page?: number;
     pageSize?: number;
 }
 export interface GetResourceSessionPlayerRequest {
     sessionId: string;
 }
+export interface GetResourceSessionScormApiLogsRequest {
+    sessionId: string;
+    method?: GetResourceSessionScormApiLogsMethodEnum;
+    element?: string;
+    errorsOnly?: boolean;
+    page?: number;
+    pageSize?: number;
+}
+export interface GetResourceSessionScormDataRequest {
+    sessionId: string;
+}
 export interface GetScormAssetRequest {
     contentId: string;
     assetPath: string;
@@ -173,6 +205,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
      * Image player HTML page
      */
     getImagePlayer(requestParameters: GetImagePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getLibraryQuizSessionPlayer without sending the request
+     */
+    getLibraryQuizSessionPlayerRequestOpts(requestParameters: GetLibraryQuizSessionPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    getLibraryQuizSessionPlayerRaw(requestParameters: GetLibraryQuizSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    getLibraryQuizSessionPlayer(requestParameters: GetLibraryQuizSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
      * Creates request options for getPdfAsset without sending the request
      */
@@ -245,6 +289,18 @@ export declare class PlayerApi extends runtime.BaseAPI {
      * Stream an asset pinned to a resource session
      */
     getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getResourceSessionDiagnostics without sending the request
+     */
+    getResourceSessionDiagnosticsRequestOpts(requestParameters: GetResourceSessionDiagnosticsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get administrator diagnostics for a resource session
+     */
+    getResourceSessionDiagnosticsRaw(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionDiagnostics>>;
+    /**
+     * Get administrator diagnostics for a resource session
+     */
+    getResourceSessionDiagnostics(requestParameters: GetResourceSessionDiagnosticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionDiagnostics>;
     /**
      * Creates request options for getResourceSessionList without sending the request
      */
@@ -269,6 +325,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
      * Serve the player for a version-pinned reusable resource session
      */
     getResourceSessionPlayer(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getResourceSessionScormApiLogs without sending the request
+     */
+    getResourceSessionScormApiLogsRequestOpts(requestParameters: GetResourceSessionScormApiLogsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get SCORM runtime logs for a resource session
+     */
+    getResourceSessionScormApiLogsRaw(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormApiLogs>>;
+    /**
+     * Get SCORM runtime logs for a resource session
+     */
+    getResourceSessionScormApiLogs(requestParameters: GetResourceSessionScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormApiLogs>;
+    /**
+     * Creates request options for getResourceSessionScormData without sending the request
+     */
+    getResourceSessionScormDataRequestOpts(requestParameters: GetResourceSessionScormDataRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get SCORM CMI data for a resource session
+     */
+    getResourceSessionScormDataRaw(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionScormData>>;
+    /**
+     * Get SCORM CMI data for a resource session
+     */
+    getResourceSessionScormData(requestParameters: GetResourceSessionScormDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionScormData>;
     /**
      * Creates request options for getScormAsset without sending the request
      */
@@ -366,3 +446,52 @@ export declare class PlayerApi extends runtime.BaseAPI {
      */
     terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetResourceSessionListCompletionStatusEnum: {
+    readonly NotAttempted: "not_attempted";
+    readonly InProgress: "in_progress";
+    readonly Completed: "completed";
+};
+export type GetResourceSessionListCompletionStatusEnum = typeof GetResourceSessionListCompletionStatusEnum[keyof typeof GetResourceSessionListCompletionStatusEnum];
+/**
+ * @export
+ */
+export declare const GetResourceSessionListGradeStatusEnum: {
+    readonly Ungraded: "ungraded";
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+    readonly PointsEarned: "points_earned";
+    readonly PercentageEarned: "percentage_earned";
+    readonly NotApplicable: "not_applicable";
+};
+export type GetResourceSessionListGradeStatusEnum = typeof GetResourceSessionListGradeStatusEnum[keyof typeof GetResourceSessionListGradeStatusEnum];
+/**
+ * @export
+ */
+export declare const GetResourceSessionListSortByEnum: {
+    readonly CreatedAt: "created_at";
+    readonly UpdatedAt: "updated_at";
+    readonly AttemptNumber: "attempt_number";
+};
+export type GetResourceSessionListSortByEnum = typeof GetResourceSessionListSortByEnum[keyof typeof GetResourceSessionListSortByEnum];
+/**
+ * @export
+ */
+export declare const GetResourceSessionListSortDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GetResourceSessionListSortDirectionEnum = typeof GetResourceSessionListSortDirectionEnum[keyof typeof GetResourceSessionListSortDirectionEnum];
+/**
+ * @export
+ */
+export declare const GetResourceSessionScormApiLogsMethodEnum: {
+    readonly Initialize: "Initialize";
+    readonly GetValue: "GetValue";
+    readonly SetValue: "SetValue";
+    readonly Commit: "Commit";
+    readonly Terminate: "Terminate";
+};
+export type GetResourceSessionScormApiLogsMethodEnum = typeof GetResourceSessionScormApiLogsMethodEnum[keyof typeof GetResourceSessionScormApiLogsMethodEnum];

package/dist/apis/PlayerApi.js

@@ -22,10 +22,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlayerApi = void 0;
+exports.GetResourceSessionScormApiLogsMethodEnum = exports.GetResourceSessionListSortDirectionEnum = exports.GetResourceSessionListSortByEnum = exports.GetResourceSessionListGradeStatusEnum = exports.GetResourceSessionListCompletionStatusEnum = exports.PlayerApi = void 0;
 const runtime = require("../runtime");
 const GetResourceSession_1 = require("../models/GetResourceSession");
+const GetResourceSessionDiagnostics_1 = require("../models/GetResourceSessionDiagnostics");
 const GetResourceSessionList_1 = require("../models/GetResourceSessionList");
+const GetResourceSessionScormApiLogs_1 = require("../models/GetResourceSessionScormApiLogs");
+const GetResourceSessionScormData_1 = require("../models/GetResourceSessionScormData");
 const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
 const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
 const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
@@ -270,6 +273,50 @@ class PlayerApi extends runtime.BaseAPI {
             yield this.getImagePlayerRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getLibraryQuizSessionPlayer without sending the request
+     */
+    getLibraryQuizSessionPlayerRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getLibraryQuizSessionPlayer().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/quiz/sessions/{sessionId}/player`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    getLibraryQuizSessionPlayerRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getLibraryQuizSessionPlayerRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            if (this.isJsonMime(response.headers.get('content-type'))) {
+                return new runtime.JSONApiResponse(response);
+            }
+            else {
+                return new runtime.TextApiResponse(response);
+            }
+        });
+    }
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    getLibraryQuizSessionPlayer(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getLibraryQuizSessionPlayerRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getPdfAsset without sending the request
      */
@@ -511,6 +558,45 @@ class PlayerApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getResourceSessionDiagnostics without sending the request
+     */
+    getResourceSessionDiagnosticsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionDiagnostics().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/diagnostics`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get administrator diagnostics for a resource session
+     */
+    getResourceSessionDiagnosticsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionDiagnosticsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionDiagnostics_1.GetResourceSessionDiagnosticsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get administrator diagnostics for a resource session
+     */
+    getResourceSessionDiagnostics(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionDiagnosticsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getResourceSessionList without sending the request
      */
@@ -529,18 +615,51 @@ class PlayerApi extends runtime.BaseAPI {
             if (requestParameters['courseId'] != null) {
                 queryParameters['course_id'] = requestParameters['courseId'];
             }
+            if (requestParameters['courseVersionId'] != null) {
+                queryParameters['course_version_id'] = requestParameters['courseVersionId'];
+            }
+            if (requestParameters['itemId'] != null) {
+                queryParameters['item_id'] = requestParameters['itemId'];
+            }
+            if (requestParameters['resourceType'] != null) {
+                queryParameters['resource_type'] = requestParameters['resourceType'];
+            }
             if (requestParameters['environment'] != null) {
                 queryParameters['environment'] = requestParameters['environment'];
             }
             if (requestParameters['completionStatus'] != null) {
                 queryParameters['completion_status'] = requestParameters['completionStatus'];
             }
+            if (requestParameters['gradeStatus'] != null) {
+                queryParameters['grade_status'] = requestParameters['gradeStatus'];
+            }
+            if (requestParameters['isCurrent'] != null) {
+                queryParameters['is_current'] = requestParameters['isCurrent'];
+            }
+            if (requestParameters['attemptNumber'] != null) {
+                queryParameters['attempt_number'] = requestParameters['attemptNumber'];
+            }
             if (requestParameters['createdFrom'] != null) {
                 queryParameters['created_from'] = requestParameters['createdFrom'];
             }
             if (requestParameters['createdTo'] != null) {
                 queryParameters['created_to'] = requestParameters['createdTo'];
             }
+            if (requestParameters['updatedFrom'] != null) {
+                queryParameters['updated_from'] = requestParameters['updatedFrom'];
+            }
+            if (requestParameters['updatedTo'] != null) {
+                queryParameters['updated_to'] = requestParameters['updatedTo'];
+            }
+            if (requestParameters['hasScormErrors'] != null) {
+                queryParameters['has_scorm_errors'] = requestParameters['hasScormErrors'];
+            }
+            if (requestParameters['sortBy'] != null) {
+                queryParameters['sort_by'] = requestParameters['sortBy'];
+            }
+            if (requestParameters['sortDirection'] != null) {
+                queryParameters['sort_direction'] = requestParameters['sortDirection'];
+            }
             if (requestParameters['page'] != null) {
                 queryParameters['page'] = requestParameters['page'];
             }
@@ -620,6 +739,99 @@ class PlayerApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getResourceSessionScormApiLogs without sending the request
+     */
+    getResourceSessionScormApiLogsRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormApiLogs().');
+            }
+            const queryParameters = {};
+            if (requestParameters['method'] != null) {
+                queryParameters['method'] = requestParameters['method'];
+            }
+            if (requestParameters['element'] != null) {
+                queryParameters['element'] = requestParameters['element'];
+            }
+            if (requestParameters['errorsOnly'] != null) {
+                queryParameters['errors_only'] = requestParameters['errorsOnly'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/api-logs`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get SCORM runtime logs for a resource session
+     */
+    getResourceSessionScormApiLogsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionScormApiLogsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionScormApiLogs_1.GetResourceSessionScormApiLogsFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get SCORM runtime logs for a resource session
+     */
+    getResourceSessionScormApiLogs(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionScormApiLogsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getResourceSessionScormData without sending the request
+     */
+    getResourceSessionScormDataRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['sessionId'] == null) {
+                throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getResourceSessionScormData().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/scorm-data`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get SCORM CMI data for a resource session
+     */
+    getResourceSessionScormDataRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionScormDataRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionScormData_1.GetResourceSessionScormDataFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get SCORM CMI data for a resource session
+     */
+    getResourceSessionScormData(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionScormDataRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getScormAsset without sending the request
      */
@@ -937,3 +1149,47 @@ class PlayerApi extends runtime.BaseAPI {
     }
 }
 exports.PlayerApi = PlayerApi;
+/**
+ * @export
+ */
+exports.GetResourceSessionListCompletionStatusEnum = {
+    NotAttempted: 'not_attempted',
+    InProgress: 'in_progress',
+    Completed: 'completed'
+};
+/**
+ * @export
+ */
+exports.GetResourceSessionListGradeStatusEnum = {
+    Ungraded: 'ungraded',
+    Passed: 'passed',
+    Failed: 'failed',
+    PointsEarned: 'points_earned',
+    PercentageEarned: 'percentage_earned',
+    NotApplicable: 'not_applicable'
+};
+/**
+ * @export
+ */
+exports.GetResourceSessionListSortByEnum = {
+    CreatedAt: 'created_at',
+    UpdatedAt: 'updated_at',
+    AttemptNumber: 'attempt_number'
+};
+/**
+ * @export
+ */
+exports.GetResourceSessionListSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
+/**
+ * @export
+ */
+exports.GetResourceSessionScormApiLogsMethodEnum = {
+    Initialize: 'Initialize',
+    GetValue: 'GetValue',
+    SetValue: 'SetValue',
+    Commit: 'Commit',
+    Terminate: 'Terminate'
+};

package/dist/apis/index.d.ts

@@ -3,6 +3,7 @@ export * from './CertificateTemplateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './ContentLibraryApi';
+export * from './ContentLibraryQuizApi';
 export * from './CourseApi';
 export * from './CourseCatalogApi';
 export * from './CourseShareApi';

package/dist/apis/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./CertificateTemplateApi"), exports);
 __exportStar(require("./ChatApi"), exports);
 __exportStar(require("./ContentApi"), exports);
 __exportStar(require("./ContentLibraryApi"), exports);
+__exportStar(require("./ContentLibraryQuizApi"), exports);
 __exportStar(require("./CourseApi"), exports);
 __exportStar(require("./CourseCatalogApi"), exports);
 __exportStar(require("./CourseShareApi"), exports);