@easyedu/js-lsm-api 1.30.0 → 1.32.0

package/dist/apis/UserApi.js

@@ -36,8 +36,9 @@ class UserApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
+            let urlPath = `/auth/check`;
             const response = yield this.request({
-                path: `/auth/check`,
+                path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -63,8 +64,10 @@ class UserApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
+            let urlPath = `/users/{userId}`;
+            urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
             const response = yield this.request({
-                path: `/users/{userId}`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
+                path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
@@ -92,8 +95,9 @@ class UserApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/auth/login`;
             const response = yield this.request({
-                path: `/auth/login`,
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
@@ -118,8 +122,9 @@ class UserApi extends runtime.BaseAPI {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
+            let urlPath = `/auth/logout`;
             const response = yield this.request({
-                path: `/auth/logout`,
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
@@ -149,8 +154,10 @@ class UserApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/users/{userId}`;
+            urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
             const response = yield this.request({
-                path: `/users/{userId}`.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId']))),
+                path: urlPath,
                 method: 'PUT',
                 headers: headerParameters,
                 query: queryParameters,
@@ -179,8 +186,9 @@ class UserApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/auth/reset-password`;
             const response = yield this.request({
-                path: `/auth/reset-password`,
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
@@ -208,8 +216,9 @@ class UserApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/auth/send-reset-password`;
             const response = yield this.request({
-                path: `/auth/send-reset-password`,
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,

package/dist/esm/apis/ContentApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PutContent, PutContentVersion } from '../models/index';
+import type { GetContent, GetContentList, GetContentSession, GetContentSessionDetail, GetContentSessionList, GetContentUpload, GetContentVersion, GetContentVersionList, GetScormApiLogs, GetScormPackage, GetScormSessionData, PostContentQuiz, PostContentSession, PostContentUpload, PostVerifyManifest, PutContent, PutContentVersion, ScormGetValueResponse, ScormSetValueRequest, ScormSetValueResponse } from '../models/index';
+export interface CommitScormSessionRequest {
+    scormSessionId: string;
+}
 export interface GetContentRequest {
     contentId: string;
     moduleId: string;
@@ -55,11 +58,19 @@ export interface GetScormPackageRequest {
 export interface GetScormSessionDataRequest {
     scormSessionId: string;
 }
+export interface GetScormValueRequest {
+    scormSessionId: string;
+    key: string;
+}
+export interface InitializeScormSessionRequest {
+    scormSessionId: string;
+}
 export interface ListContentSessionsRequest {
     contentId: string;
     moduleId: string;
     courseId: string;
-    sessionType?: ListContentSessionsSessionTypeEnum;
+    environment?: ListContentSessionsEnvironmentEnum;
+    userId?: string;
     page?: number;
     pageSize?: number;
 }
@@ -77,6 +88,7 @@ export interface PostContentSessionRequest {
     contentId: string;
     moduleId: string;
     courseId: string;
+    environment?: PostContentSessionEnvironmentEnum;
 }
 export interface PostContentUploadRequest {
     moduleId: string;
@@ -96,10 +108,30 @@ export interface PutContentVersionRequest {
     versionId: string;
     putContentVersion: PutContentVersion;
 }
+export interface SetScormValueRequest {
+    scormSessionId: string;
+    scormSetValueRequest: ScormSetValueRequest;
+}
+export interface TerminateScormSessionRequest {
+    scormSessionId: string;
+}
+export interface VerifyScormManifestRequest {
+    body: string;
+}
 /**
  *
  */
 export declare class ContentApi extends runtime.BaseAPI {
+    /**
+     * Commit/persist SCORM CMI data changes to the database
+     * Commit SCORM session data
+     */
+    commitScormSessionRaw(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Commit/persist SCORM CMI data changes to the database
+     * Commit SCORM session data
+     */
+    commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * get content
      */
@@ -184,6 +216,26 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get SCORM session data (instructor only)
      */
     getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData>;
+    /**
+     * Retrieve the value of a specific SCORM CMI data element from the session
+     * Get a SCORM CMI data element value
+     */
+    getScormValueRaw(requestParameters: GetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormGetValueResponse>>;
+    /**
+     * Retrieve the value of a specific SCORM CMI data element from the session
+     * Get a SCORM CMI data element value
+     */
+    getScormValue(requestParameters: GetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
+    /**
+     * Initialize a SCORM session for content playback
+     * Initialize a SCORM session
+     */
+    initializeScormSessionRaw(requestParameters: InitializeScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Initialize a SCORM session for content playback
+     * Initialize a SCORM session
+     */
+    initializeScormSession(requestParameters: InitializeScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Get a paginated list of all content sessions for a specific content item
      * List content sessions (instructor only)
@@ -246,12 +298,50 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Update a content version
      */
     putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
+    /**
+     * Update the value of a specific SCORM CMI data element in the session
+     * Set a SCORM CMI data element value
+     */
+    setScormValueRaw(requestParameters: SetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormSetValueResponse>>;
+    /**
+     * Update the value of a specific SCORM CMI data element in the session
+     * Set a SCORM CMI data element value
+     */
+    setScormValue(requestParameters: SetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormSetValueResponse>;
+    /**
+     * Terminate the SCORM session and finalize all data
+     * Terminate a SCORM session
+     */
+    terminateScormSessionRaw(requestParameters: TerminateScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Terminate the SCORM session and finalize all data
+     * Terminate a SCORM session
+     */
+    terminateScormSession(requestParameters: TerminateScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
+     * Parse and verify a SCORM manifest
+     */
+    verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>>;
+    /**
+     * Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
+     * Parse and verify a SCORM manifest
+     */
+    verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest>;
 }
 /**
  * @export
  */
-export declare const ListContentSessionsSessionTypeEnum: {
+export declare const ListContentSessionsEnvironmentEnum: {
     readonly Sandbox: "SANDBOX";
     readonly Live: "LIVE";
 };
-export type ListContentSessionsSessionTypeEnum = typeof ListContentSessionsSessionTypeEnum[keyof typeof ListContentSessionsSessionTypeEnum];
+export type ListContentSessionsEnvironmentEnum = typeof ListContentSessionsEnvironmentEnum[keyof typeof ListContentSessionsEnvironmentEnum];
+/**
+ * @export
+ */
+export declare const PostContentSessionEnvironmentEnum: {
+    readonly Sandbox: "sandbox";
+    readonly Live: "live";
+};
+export type PostContentSessionEnvironmentEnum = typeof PostContentSessionEnvironmentEnum[keyof typeof PostContentSessionEnvironmentEnum];