@easyedu/js-lsm-api 1.89.0 → 1.91.0

package/dist/apis/PlayerApi.js

@@ -22,8 +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");
@@ -427,6 +432,225 @@ class PlayerApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getResourceSession without sending the request
+     */
+    getResourceSessionRequestOpts(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 getResourceSession().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get a resource session
+     */
+    getResourceSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get a resource session
+     */
+    getResourceSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getResourceSessionAsset without sending the request
+     */
+    getResourceSessionAssetRequestOpts(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 getResourceSessionAsset().');
+            }
+            if (requestParameters['assetPath'] == null) {
+                throw new runtime.RequiredError('assetPath', 'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Stream an asset pinned to a resource session
+     */
+    getResourceSessionAssetRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionAssetRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Stream an asset pinned to a resource session
+     */
+    getResourceSessionAsset(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getResourceSessionAssetRaw(requestParameters, initOverrides);
+            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
+     */
+    getResourceSessionListRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['userId'] != null) {
+                queryParameters['user_id'] = requestParameters['userId'];
+            }
+            if (requestParameters['resourceId'] != null) {
+                queryParameters['resource_id'] = requestParameters['resourceId'];
+            }
+            if (requestParameters['versionId'] != null) {
+                queryParameters['version_id'] = requestParameters['versionId'];
+            }
+            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'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['pageSize'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            let urlPath = `/resource/sessions`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List resource sessions for the selected portal
+     */
+    getResourceSessionListRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getResourceSessionListRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSessionList_1.GetResourceSessionListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List resource sessions for the selected portal
+     */
+    getResourceSessionList() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getResourceSessionListRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getResourceSessionPlayer without sending the request
      */
@@ -471,6 +695,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
      */
@@ -665,6 +982,45 @@ class PlayerApi extends runtime.BaseAPI {
             yield this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for postResourceSessionComplete without sending the request
+     */
+    postResourceSessionCompleteRequestOpts(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 postResourceSessionComplete().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/resource/sessions/{sessionId}/complete`;
+            urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Complete a non-SCORM resource session
+     */
+    postResourceSessionCompleteRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postResourceSessionCompleteRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetResourceSession_1.GetResourceSessionFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Complete a non-SCORM resource session
+     */
+    postResourceSessionComplete(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for setResourceScormValue without sending the request
      */
@@ -749,3 +1105,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/esm/apis/ContentLibraryApi.d.ts

@@ -13,11 +13,13 @@ import * as runtime from '../runtime';
 import { type GetContentLibraryVersion } from '../models/GetContentLibraryVersion';
 import { type GetResource } from '../models/GetResource';
 import { type GetResourceList } from '../models/GetResourceList';
+import { type GetResourceSession } from '../models/GetResourceSession';
 import { type GetResourceUsage } from '../models/GetResourceUsage';
 import { type GetResourceVersionUpload } from '../models/GetResourceVersionUpload';
 import { type PostResource } from '../models/PostResource';
 import { type PostResourceVersion } from '../models/PostResourceVersion';
 import { type PostResourceVersionComplete } from '../models/PostResourceVersionComplete';
+import { type PostResourceVersionSession } from '../models/PostResourceVersionSession';
 import { type PostResourceVersionUpload } from '../models/PostResourceVersionUpload';
 import { type PutResource } from '../models/PutResource';
 import { type PutResourceVersion } from '../models/PutResourceVersion';
@@ -67,6 +69,11 @@ export interface PostResourceVersionPublishRequest {
     resourceId: string;
     versionId: string;
 }
+export interface PostResourceVersionSessionRequest {
+    resourceId: string;
+    versionId: string;
+    postResourceVersionSession?: PostResourceVersionSession;
+}
 export interface PostResourceVersionUploadRequest {
     resourceId: string;
     versionId: string;
@@ -227,6 +234,18 @@ export declare class ContentLibraryApi extends runtime.BaseAPI {
      * Publish an immutable resource version
      */
     postResourceVersionPublish(requestParameters: PostResourceVersionPublishRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentLibraryVersion>;
+    /**
+     * Creates request options for postResourceVersionSession without sending the request
+     */
+    postResourceVersionSessionRequestOpts(requestParameters: PostResourceVersionSessionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    postResourceVersionSessionRaw(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>>;
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    postResourceVersionSession(requestParameters: PostResourceVersionSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession>;
     /**
      * Creates request options for postResourceVersionUpload without sending the request
      */

package/dist/esm/apis/ContentLibraryApi.js

@@ -24,11 +24,13 @@ import * as runtime from '../runtime';
 import { GetContentLibraryVersionFromJSON, } from '../models/GetContentLibraryVersion';
 import { GetResourceFromJSON, } from '../models/GetResource';
 import { GetResourceListFromJSON, } from '../models/GetResourceList';
+import { GetResourceSessionFromJSON, } from '../models/GetResourceSession';
 import { GetResourceUsageFromJSON, } from '../models/GetResourceUsage';
 import { GetResourceVersionUploadFromJSON, } from '../models/GetResourceVersionUpload';
 import { PostResourceToJSON, } from '../models/PostResource';
 import { PostResourceVersionToJSON, } from '../models/PostResourceVersion';
 import { PostResourceVersionCompleteToJSON, } from '../models/PostResourceVersionComplete';
+import { PostResourceVersionSessionToJSON, } from '../models/PostResourceVersionSession';
 import { PostResourceVersionUploadToJSON, } from '../models/PostResourceVersionUpload';
 import { PutResourceToJSON, } from '../models/PutResource';
 import { PutResourceVersionToJSON, } from '../models/PutResourceVersion';
@@ -502,6 +504,51 @@ export class ContentLibraryApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for postResourceVersionSession without sending the request
+     */
+    postResourceVersionSessionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['resourceId'] == null) {
+                throw new runtime.RequiredError('resourceId', 'Required parameter "resourceId" was null or undefined when calling postResourceVersionSession().');
+            }
+            if (requestParameters['versionId'] == null) {
+                throw new runtime.RequiredError('versionId', 'Required parameter "versionId" was null or undefined when calling postResourceVersionSession().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/content-library/resources/{resourceId}/versions/{versionId}/sessions`;
+            urlPath = urlPath.replace('{resourceId}', encodeURIComponent(String(requestParameters['resourceId'])));
+            urlPath = urlPath.replace('{versionId}', encodeURIComponent(String(requestParameters['versionId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostResourceVersionSessionToJSON(requestParameters['postResourceVersionSession']),
+            };
+        });
+    }
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    postResourceVersionSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postResourceVersionSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Start or resume a demo session for an exact resource version
+     */
+    postResourceVersionSession(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postResourceVersionSessionRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for postResourceVersionUpload without sending the request
      */