@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/dist/apis/PlayerApi.d.ts

@@ -10,6 +10,17 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type ScormGetValueResponse } from '../models/ScormGetValueResponse';
+import { type ScormSetValueRequest } from '../models/ScormSetValueRequest';
+import { type ScormSetValueResponse } from '../models/ScormSetValueResponse';
+export interface CommitResourceScormSessionRequest {
+    sessionId: string;
+}
+export interface GetCourseVersionResourceAssetRequest {
+    courseVersionId: string;
+    itemId: string;
+    assetPath: string;
+}
 export interface GetDispatchScormPlayerRequest {
     sessionId: string;
 }
@@ -31,6 +42,13 @@ export interface GetPdfPlayerRequest {
 export interface GetQuizPlayerRequest {
     sessionId: string;
 }
+export interface GetResourceScormValueRequest {
+    sessionId: string;
+    key: string;
+}
+export interface GetResourceSessionPlayerRequest {
+    sessionId: string;
+}
 export interface GetScormAssetRequest {
     contentId: string;
     assetPath: string;
@@ -44,10 +62,44 @@ export interface GetVideoAssetRequest {
 export interface GetVideoPlayerRequest {
     sessionId: string;
 }
+export interface InitializeResourceScormSessionRequest {
+    sessionId: string;
+}
+export interface SetResourceScormValueRequest {
+    sessionId: string;
+    scormSetValueRequest: ScormSetValueRequest;
+}
+export interface TerminateResourceScormSessionRequest {
+    sessionId: string;
+}
 /**
  *
  */
 export declare class PlayerApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for commitResourceScormSession without sending the request
+     */
+    commitResourceScormSessionRequestOpts(requestParameters: CommitResourceScormSessionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    commitResourceScormSessionRaw(requestParameters: CommitResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    commitResourceScormSession(requestParameters: CommitResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCourseVersionResourceAsset without sending the request
+     */
+    getCourseVersionResourceAssetRequestOpts(requestParameters: GetCourseVersionResourceAssetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    getCourseVersionResourceAssetRaw(requestParameters: GetCourseVersionResourceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    getCourseVersionResourceAsset(requestParameters: GetCourseVersionResourceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
     /**
      * Creates request options for getDispatchScormPlayer without sending the request
      */
@@ -132,6 +184,30 @@ export declare class PlayerApi extends runtime.BaseAPI {
      * Quiz player HTML page
      */
     getQuizPlayer(requestParameters: GetQuizPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getResourceScormValue without sending the request
+     */
+    getResourceScormValueRequestOpts(requestParameters: GetResourceScormValueRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    getResourceScormValueRaw(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormGetValueResponse>>;
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
+    /**
+     * Creates request options for getResourceSessionPlayer without sending the request
+     */
+    getResourceSessionPlayerRequestOpts(requestParameters: GetResourceSessionPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Serve the player for a version-pinned reusable resource session
+     */
+    getResourceSessionPlayerRaw(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Serve the player for a version-pinned reusable resource session
+     */
+    getResourceSessionPlayer(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
     /**
      * Creates request options for getScormAsset without sending the request
      */
@@ -180,4 +256,40 @@ export declare class PlayerApi extends runtime.BaseAPI {
      * Video player HTML page
      */
     getVideoPlayer(requestParameters: GetVideoPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for initializeResourceScormSession without sending the request
+     */
+    initializeResourceScormSessionRequestOpts(requestParameters: InitializeResourceScormSessionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    initializeResourceScormSessionRaw(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for setResourceScormValue without sending the request
+     */
+    setResourceScormValueRequestOpts(requestParameters: SetResourceScormValueRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    setResourceScormValueRaw(requestParameters: SetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormSetValueResponse>>;
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    setResourceScormValue(requestParameters: SetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormSetValueResponse>;
+    /**
+     * Creates request options for terminateResourceScormSession without sending the request
+     */
+    terminateResourceScormSessionRequestOpts(requestParameters: TerminateResourceScormSessionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    terminateResourceScormSessionRaw(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }

package/dist/apis/PlayerApi.js

@@ -24,10 +24,98 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlayerApi = void 0;
 const runtime = require("../runtime");
+const ScormGetValueResponse_1 = require("../models/ScormGetValueResponse");
+const ScormSetValueRequest_1 = require("../models/ScormSetValueRequest");
+const ScormSetValueResponse_1 = require("../models/ScormSetValueResponse");
 /**
  *
  */
 class PlayerApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for commitResourceScormSession without sending the request
+     */
+    commitResourceScormSessionRequestOpts(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 commitResourceScormSession().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/commit`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    commitResourceScormSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.commitResourceScormSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    commitResourceScormSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitResourceScormSessionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getCourseVersionResourceAsset without sending the request
+     */
+    getCourseVersionResourceAssetRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['courseVersionId'] == null) {
+                throw new runtime.RequiredError('courseVersionId', 'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionResourceAsset().');
+            }
+            if (requestParameters['itemId'] == null) {
+                throw new runtime.RequiredError('itemId', 'Required parameter "itemId" was null or undefined when calling getCourseVersionResourceAsset().');
+            }
+            if (requestParameters['assetPath'] == null) {
+                throw new runtime.RequiredError('assetPath', 'Required parameter "assetPath" was null or undefined when calling getCourseVersionResourceAsset().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath}`;
+            urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+            urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+            urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    getCourseVersionResourceAssetRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCourseVersionResourceAssetRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    getCourseVersionResourceAsset(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCourseVersionResourceAssetRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getDispatchScormPlayer without sending the request
      */
@@ -294,6 +382,95 @@ class PlayerApi extends runtime.BaseAPI {
             yield this.getQuizPlayerRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getResourceScormValue without sending the request
+     */
+    getResourceScormValueRequestOpts(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 getResourceScormValue().');
+            }
+            if (requestParameters['key'] == null) {
+                throw new runtime.RequiredError('key', 'Required parameter "key" was null or undefined when calling getResourceScormValue().');
+            }
+            const queryParameters = {};
+            if (requestParameters['key'] != null) {
+                queryParameters['key'] = requestParameters['key'];
+            }
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/get-value`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    getResourceScormValueRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceScormValueRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormGetValueResponse_1.ScormGetValueResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    getResourceScormValue(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceScormValueRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getResourceSessionPlayer without sending the request
+     */
+    getResourceSessionPlayerRequestOpts(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 getResourceSessionPlayer().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/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 version-pinned reusable resource session
+     */
+    getResourceSessionPlayerRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionPlayerRequestOpts(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 version-pinned reusable resource session
+     */
+    getResourceSessionPlayer(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionPlayerRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getScormAsset without sending the request
      */
@@ -450,5 +627,125 @@ class PlayerApi extends runtime.BaseAPI {
             yield this.getVideoPlayerRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for initializeResourceScormSession without sending the request
+     */
+    initializeResourceScormSessionRequestOpts(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 initializeResourceScormSession().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/initialize`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    initializeResourceScormSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.initializeResourceScormSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    initializeResourceScormSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for setResourceScormValue without sending the request
+     */
+    setResourceScormValueRequestOpts(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 setResourceScormValue().');
+            }
+            if (requestParameters['scormSetValueRequest'] == null) {
+                throw new runtime.RequiredError('scormSetValueRequest', 'Required parameter "scormSetValueRequest" was null or undefined when calling setResourceScormValue().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/resource/sessions/{sessionId}/set-value`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, ScormSetValueRequest_1.ScormSetValueRequestToJSON)(requestParameters['scormSetValueRequest']),
+            };
+        });
+    }
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    setResourceScormValueRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.setResourceScormValueRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ScormSetValueResponse_1.ScormSetValueResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    setResourceScormValue(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.setResourceScormValueRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for terminateResourceScormSession without sending the request
+     */
+    terminateResourceScormSessionRequestOpts(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 terminateResourceScormSession().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/terminate`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    terminateResourceScormSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.terminateResourceScormSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    terminateResourceScormSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.terminateResourceScormSessionRaw(requestParameters, initOverrides);
+        });
+    }
 }
 exports.PlayerApi = PlayerApi;

package/dist/apis/index.d.ts

@@ -1,10 +1,12 @@
 export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
+export * from './ContentLibraryApi';
 export * from './CourseApi';
 export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
+export * from './EmailTemplateApi';
 export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PlayerApi';

package/dist/apis/index.js

@@ -19,10 +19,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CertificateApi"), exports);
 __exportStar(require("./ChatApi"), exports);
 __exportStar(require("./ContentApi"), exports);
+__exportStar(require("./ContentLibraryApi"), exports);
 __exportStar(require("./CourseApi"), exports);
 __exportStar(require("./CourseCatalogApi"), exports);
 __exportStar(require("./CourseShareApi"), exports);
 __exportStar(require("./DispatchApi"), exports);
+__exportStar(require("./EmailTemplateApi"), exports);
 __exportStar(require("./ModuleApi"), exports);
 __exportStar(require("./OtherApi"), exports);
 __exportStar(require("./PlayerApi"), exports);