@easyedu/js-lsm-api 1.31.0 → 1.33.0

package/dist/apis/UserApi.js

@@ -30,19 +30,28 @@ const index_1 = require("../models/index");
  */
 class UserApi extends runtime.BaseAPI {
     /**
-     * Check if a user is logged in
+     * Creates request options for getAuthCheck without sending the request
      */
-    getAuthCheckRaw(initOverrides) {
+    getAuthCheckRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/auth/check`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Check if a user is logged in
+     */
+    getAuthCheckRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAuthCheckRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -55,9 +64,9 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a user by id
+     * Creates request options for getUser without sending the request
      */
-    getUserRaw(requestParameters, initOverrides) {
+    getUserRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['userId'] == null) {
                 throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getUser().');
@@ -66,12 +75,21 @@ class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             let urlPath = `/users/{userId}`;
             urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a user by id
+     */
+    getUserRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getUserRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetUserFromJSON)(jsonValue));
         });
     }
@@ -85,9 +103,9 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Post a new login
+     * Creates request options for postLogin without sending the request
      */
-    postLoginRaw(requestParameters, initOverrides) {
+    postLoginRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postLogin'] == null) {
                 throw new runtime.RequiredError('postLogin', 'Required parameter "postLogin" was null or undefined when calling postLogin().');
@@ -96,13 +114,22 @@ class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/login`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.PostLoginToJSON)(requestParameters['postLogin']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Post a new login
+     */
+    postLoginRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLoginRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.LoginResFromJSON)(jsonValue));
         });
     }
@@ -116,19 +143,28 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Logout a user
+     * Creates request options for postLogout without sending the request
      */
-    postLogoutRaw(initOverrides) {
+    postLogoutRequestOpts() {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
             let urlPath = `/auth/logout`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Logout a user
+     */
+    postLogoutRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postLogoutRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -141,9 +177,9 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Update a user by id
+     * Creates request options for putUser without sending the request
      */
-    putUserRaw(requestParameters, initOverrides) {
+    putUserRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['userId'] == null) {
                 throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putUser().');
@@ -156,13 +192,22 @@ class UserApi extends runtime.BaseAPI {
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/users/{userId}`;
             urlPath = urlPath.replace(`{${"userId"}}`, encodeURIComponent(String(requestParameters['userId'])));
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'PUT',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.PutUserToJSON)(requestParameters['putUser']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Update a user by id
+     */
+    putUserRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putUserRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetUserFromJSON)(jsonValue));
         });
     }
@@ -176,9 +221,9 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Reset a users password
+     * Creates request options for resetPassword without sending the request
      */
-    resetPasswordRaw(requestParameters, initOverrides) {
+    resetPasswordRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postResetPassword'] == null) {
                 throw new runtime.RequiredError('postResetPassword', 'Required parameter "postResetPassword" was null or undefined when calling resetPassword().');
@@ -187,13 +232,22 @@ class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/reset-password`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.PostResetPasswordToJSON)(requestParameters['postResetPassword']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Reset a users password
+     */
+    resetPasswordRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.resetPasswordRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -206,9 +260,9 @@ class UserApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Send a reset password email
+     * Creates request options for sendResetPassword without sending the request
      */
-    sendResetPasswordRaw(requestParameters, initOverrides) {
+    sendResetPasswordRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['postSendResetPassword'] == null) {
                 throw new runtime.RequiredError('postSendResetPassword', 'Required parameter "postSendResetPassword" was null or undefined when calling sendResetPassword().');
@@ -217,13 +271,22 @@ class UserApi extends runtime.BaseAPI {
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
             let urlPath = `/auth/send-reset-password`;
-            const response = yield this.request({
+            return {
                 path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.PostSendResetPasswordToJSON)(requestParameters['postSendResetPassword']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Send a reset password email
+     */
+    sendResetPasswordRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.sendResetPasswordRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }

package/dist/apis/index.d.ts

@@ -6,4 +6,5 @@ export * from './PortalApi';
 export * from './QuestionApi';
 export * from './QuizApi';
 export * from './ReportingApi';
+export * from './RoleApi';
 export * from './UserApi';

package/dist/apis/index.js

@@ -24,4 +24,5 @@ __exportStar(require("./PortalApi"), exports);
 __exportStar(require("./QuestionApi"), exports);
 __exportStar(require("./QuizApi"), exports);
 __exportStar(require("./ReportingApi"), exports);
+__exportStar(require("./RoleApi"), exports);
 __exportStar(require("./UserApi"), exports);

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

@@ -69,7 +69,8 @@ export interface ListContentSessionsRequest {
     contentId: string;
     moduleId: string;
     courseId: string;
-    sessionType?: ListContentSessionsSessionTypeEnum;
+    environment?: ListContentSessionsEnvironmentEnum;
+    userId?: string;
     page?: number;
     pageSize?: number;
 }
@@ -121,6 +122,10 @@ export interface VerifyScormManifestRequest {
  *
  */
 export declare class ContentApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for commitScormSession without sending the request
+     */
+    commitScormSessionRequestOpts(requestParameters: CommitScormSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Commit/persist SCORM CMI data changes to the database
      * Commit SCORM session data
@@ -131,6 +136,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Commit SCORM session data
      */
     commitScormSession(requestParameters: CommitScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getContent without sending the request
+     */
+    getContentRequestOpts(requestParameters: GetContentRequest): Promise<runtime.RequestOpts>;
     /**
      * get content
      */
@@ -139,6 +148,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * get content
      */
     getContent(requestParameters: GetContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
+    /**
+     * Creates request options for getContentList without sending the request
+     */
+    getContentListRequestOpts(requestParameters: GetContentListRequest): Promise<runtime.RequestOpts>;
     /**
      * get content list
      */
@@ -147,6 +160,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * get content list
      */
     getContentList(requestParameters: GetContentListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentList>;
+    /**
+     * Creates request options for getContentSession without sending the request
+     */
+    getContentSessionRequestOpts(requestParameters: GetContentSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * get content session
      */
@@ -155,6 +172,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * get content session
      */
     getContentSession(requestParameters: GetContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSession>;
+    /**
+     * Creates request options for getContentSessionDetail without sending the request
+     */
+    getContentSessionDetailRequestOpts(requestParameters: GetContentSessionDetailRequest): Promise<runtime.RequestOpts>;
     /**
      * Get detailed information about a specific content session
      * Get content session details (instructor only)
@@ -165,6 +186,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get content session details (instructor only)
      */
     getContentSessionDetail(requestParameters: GetContentSessionDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionDetail>;
+    /**
+     * Creates request options for getContentVersion without sending the request
+     */
+    getContentVersionRequestOpts(requestParameters: GetContentVersionRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns detailed information about a specific version of the content, including sandbox launch URL and SCORM-specific data (package info and table of contents) if applicable.
      * Get details of a specific content version
@@ -175,6 +200,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get details of a specific content version
      */
     getContentVersion(requestParameters: GetContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
+    /**
+     * Creates request options for getContentVersionList without sending the request
+     */
+    getContentVersionListRequestOpts(requestParameters: GetContentVersionListRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns a paginated list of all versions for the specified content. Returns an empty array if the content has no versions.
      * Get all versions of a content
@@ -185,6 +214,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get all versions of a content
      */
     getContentVersionList(requestParameters: GetContentVersionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersionList>;
+    /**
+     * Creates request options for getScormApiLogs without sending the request
+     */
+    getScormApiLogsRequestOpts(requestParameters: GetScormApiLogsRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a paginated history of all SCORM API calls made during this session for debugging and troubleshooting
      * Get SCORM API call logs (instructor only)
@@ -195,6 +228,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get SCORM API call logs (instructor only)
      */
     getScormApiLogs(requestParameters: GetScormApiLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormApiLogs>;
+    /**
+     * Creates request options for getScormPackage without sending the request
+     */
+    getScormPackageRequestOpts(requestParameters: GetScormPackageRequest): Promise<runtime.RequestOpts>;
     /**
      * Returns package information and table of contents for a SCORM package
      * Get details of a SCORM package
@@ -205,6 +242,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get details of a SCORM package
      */
     getScormPackage(requestParameters: GetScormPackageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormPackage>;
+    /**
+     * Creates request options for getScormSessionData without sending the request
+     */
+    getScormSessionDataRequestOpts(requestParameters: GetScormSessionDataRequest): Promise<runtime.RequestOpts>;
     /**
      * Get detailed SCORM session data including CMI data dump for debugging
      * Get SCORM session data (instructor only)
@@ -215,6 +256,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get SCORM session data (instructor only)
      */
     getScormSessionData(requestParameters: GetScormSessionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetScormSessionData>;
+    /**
+     * Creates request options for getScormValue without sending the request
+     */
+    getScormValueRequestOpts(requestParameters: GetScormValueRequest): Promise<runtime.RequestOpts>;
     /**
      * Retrieve the value of a specific SCORM CMI data element from the session
      * Get a SCORM CMI data element value
@@ -225,6 +270,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Get a SCORM CMI data element value
      */
     getScormValue(requestParameters: GetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse>;
+    /**
+     * Creates request options for initializeScormSession without sending the request
+     */
+    initializeScormSessionRequestOpts(requestParameters: InitializeScormSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Initialize a SCORM session for content playback
      * Initialize a SCORM session
@@ -235,6 +284,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Initialize a SCORM session
      */
     initializeScormSession(requestParameters: InitializeScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for listContentSessions without sending the request
+     */
+    listContentSessionsRequestOpts(requestParameters: ListContentSessionsRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a paginated list of all content sessions for a specific content item
      * List content sessions (instructor only)
@@ -245,6 +298,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * List content sessions (instructor only)
      */
     listContentSessions(requestParameters: ListContentSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentSessionList>;
+    /**
+     * Creates request options for postContentProcess without sending the request
+     */
+    postContentProcessRequestOpts(requestParameters: PostContentProcessRequest): Promise<runtime.RequestOpts>;
     /**
      * Post a new content process
      */
@@ -253,6 +310,11 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Post a new content process
      */
     postContentProcess(requestParameters: PostContentProcessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
+    /**
+     * Creates request options for postContentQuiz without sending the request
+     * @deprecated
+     */
+    postContentQuizRequestOpts(requestParameters: PostContentQuizRequest): Promise<runtime.RequestOpts>;
     /**
      * Create a new quiz content
      * @deprecated
@@ -263,6 +325,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * @deprecated
      */
     postContentQuiz(requestParameters: PostContentQuizRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
+    /**
+     * Creates request options for postContentSession without sending the request
+     */
+    postContentSessionRequestOpts(requestParameters: PostContentSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Post a new content session
      */
@@ -271,6 +337,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Post a new content session
      */
     postContentSession(requestParameters: PostContentSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContentSession>;
+    /**
+     * Creates request options for postContentUpload without sending the request
+     */
+    postContentUploadRequestOpts(requestParameters: PostContentUploadRequest): Promise<runtime.RequestOpts>;
     /**
      * Post a new content upload
      */
@@ -279,6 +349,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Post a new content upload
      */
     postContentUpload(requestParameters: PostContentUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentUpload>;
+    /**
+     * Creates request options for putContent without sending the request
+     */
+    putContentRequestOpts(requestParameters: PutContentRequest): Promise<runtime.RequestOpts>;
     /**
      * Update content by id
      */
@@ -287,6 +361,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Update content by id
      */
     putContent(requestParameters: PutContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContent>;
+    /**
+     * Creates request options for putContentVersion without sending the request
+     */
+    putContentVersionRequestOpts(requestParameters: PutContentVersionRequest): Promise<runtime.RequestOpts>;
     /**
      * Activates this version by setting is_active to true. Automatically deactivates all other versions of the same content. Only setting is_active to true is allowed.
      * Update a content version
@@ -297,6 +375,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Update a content version
      */
     putContentVersion(requestParameters: PutContentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentVersion>;
+    /**
+     * Creates request options for setScormValue without sending the request
+     */
+    setScormValueRequestOpts(requestParameters: SetScormValueRequest): Promise<runtime.RequestOpts>;
     /**
      * Update the value of a specific SCORM CMI data element in the session
      * Set a SCORM CMI data element value
@@ -307,6 +389,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Set a SCORM CMI data element value
      */
     setScormValue(requestParameters: SetScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormSetValueResponse>;
+    /**
+     * Creates request options for terminateScormSession without sending the request
+     */
+    terminateScormSessionRequestOpts(requestParameters: TerminateScormSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Terminate the SCORM session and finalize all data
      * Terminate a SCORM session
@@ -317,6 +403,10 @@ export declare class ContentApi extends runtime.BaseAPI {
      * Terminate a SCORM session
      */
     terminateScormSession(requestParameters: TerminateScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for verifyScormManifest without sending the request
+     */
+    verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts>;
     /**
      * Takes raw imsmanifest.xml content and returns the parsed manifest structure with validation warnings
      * Parse and verify a SCORM manifest
@@ -331,11 +421,11 @@ export declare class ContentApi extends runtime.BaseAPI {
 /**
  * @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
  */