@easyedu/js-lsm-api 1.62.0 → 1.64.0

package/src/apis/PlayerApi.ts

@@ -0,0 +1,559 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+
+export interface GetDispatchScormPlayerRequest {
+    sessionId: string;
+}
+
+export interface GetFileAssetRequest {
+    contentId: string;
+}
+
+export interface GetFilePlayerRequest {
+    sessionId: string;
+}
+
+export interface GetImagePlayerRequest {
+    sessionId: string;
+}
+
+export interface GetPdfAssetRequest {
+    contentId: string;
+}
+
+export interface GetPdfPlayerRequest {
+    sessionId: string;
+}
+
+export interface GetQuizPlayerRequest {
+    sessionId: string;
+}
+
+export interface GetScormAssetRequest {
+    contentId: string;
+    assetPath: string;
+}
+
+export interface GetScormPlayerRequest {
+    sessionId: string;
+}
+
+export interface GetVideoAssetRequest {
+    contentId: string;
+}
+
+export interface GetVideoPlayerRequest {
+    sessionId: string;
+}
+
+/**
+ * 
+ */
+export class PlayerApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getDispatchScormPlayer without sending the request
+     */
+    async getDispatchScormPlayerRequestOpts(requestParameters: GetDispatchScormPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getDispatchScormPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/scorm/dispatch/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Dispatch SCORM player HTML page
+     */
+    async getDispatchScormPlayerRaw(requestParameters: GetDispatchScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getDispatchScormPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Dispatch SCORM player HTML page
+     */
+    async getDispatchScormPlayer(requestParameters: GetDispatchScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getDispatchScormPlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getFileAsset without sending the request
+     */
+    async getFileAssetRequestOpts(requestParameters: GetFileAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getFileAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/file/{contentId}/asset`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * File asset
+     */
+    async getFileAssetRaw(requestParameters: GetFileAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getFileAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * File asset
+     */
+    async getFileAsset(requestParameters: GetFileAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getFileAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getFilePlayer without sending the request
+     */
+    async getFilePlayerRequestOpts(requestParameters: GetFilePlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getFilePlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/file/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * File player HTML page
+     */
+    async getFilePlayerRaw(requestParameters: GetFilePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getFilePlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * File player HTML page
+     */
+    async getFilePlayer(requestParameters: GetFilePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getFilePlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getImagePlayer without sending the request
+     */
+    async getImagePlayerRequestOpts(requestParameters: GetImagePlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getImagePlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/image/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Image player HTML page
+     */
+    async getImagePlayerRaw(requestParameters: GetImagePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getImagePlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Image player HTML page
+     */
+    async getImagePlayer(requestParameters: GetImagePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getImagePlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getPdfAsset without sending the request
+     */
+    async getPdfAssetRequestOpts(requestParameters: GetPdfAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getPdfAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/pdf/{contentId}/asset`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * PDF asset
+     */
+    async getPdfAssetRaw(requestParameters: GetPdfAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getPdfAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * PDF asset
+     */
+    async getPdfAsset(requestParameters: GetPdfAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getPdfAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getPdfPlayer without sending the request
+     */
+    async getPdfPlayerRequestOpts(requestParameters: GetPdfPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getPdfPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/pdf/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * PDF player HTML page
+     */
+    async getPdfPlayerRaw(requestParameters: GetPdfPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getPdfPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * PDF player HTML page
+     */
+    async getPdfPlayer(requestParameters: GetPdfPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getPdfPlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getQuizPlayer without sending the request
+     */
+    async getQuizPlayerRequestOpts(requestParameters: GetQuizPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getQuizPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/quiz/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Quiz player HTML page
+     */
+    async getQuizPlayerRaw(requestParameters: GetQuizPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getQuizPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Quiz player HTML page
+     */
+    async getQuizPlayer(requestParameters: GetQuizPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getQuizPlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getScormAsset without sending the request
+     */
+    async getScormAssetRequestOpts(requestParameters: GetScormAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getScormAsset().'
+            );
+        }
+
+        if (requestParameters['assetPath'] == null) {
+            throw new runtime.RequiredError(
+                'assetPath',
+                'Required parameter "assetPath" was null or undefined when calling getScormAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/scorm/{contentId}/scorm/asset/{assetPath}`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+        urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * SCORM package asset
+     */
+    async getScormAssetRaw(requestParameters: GetScormAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getScormAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * SCORM package asset
+     */
+    async getScormAsset(requestParameters: GetScormAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getScormAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getScormPlayer without sending the request
+     */
+    async getScormPlayerRequestOpts(requestParameters: GetScormPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getScormPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/scorm/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * SCORM player HTML page
+     */
+    async getScormPlayerRaw(requestParameters: GetScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getScormPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * SCORM player HTML page
+     */
+    async getScormPlayer(requestParameters: GetScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getScormPlayerRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getVideoAsset without sending the request
+     */
+    async getVideoAssetRequestOpts(requestParameters: GetVideoAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getVideoAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/video/{contentId}/asset`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Video asset
+     */
+    async getVideoAssetRaw(requestParameters: GetVideoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getVideoAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Video asset
+     */
+    async getVideoAsset(requestParameters: GetVideoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getVideoAssetRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getVideoPlayer without sending the request
+     */
+    async getVideoPlayerRequestOpts(requestParameters: GetVideoPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getVideoPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/video/session/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Video player HTML page
+     */
+    async getVideoPlayerRaw(requestParameters: GetVideoPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.getVideoPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Video player HTML page
+     */
+    async getVideoPlayer(requestParameters: GetVideoPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.getVideoPlayerRaw(requestParameters, initOverrides);
+    }
+
+}

package/src/apis/UserApi.ts

@@ -43,6 +43,16 @@ import {
     PostSendResetPasswordFromJSON,
     PostSendResetPasswordToJSON,
 } from '../models/PostSendResetPassword';
+import {
+    type PostSignupRequest,
+    PostSignupRequestFromJSON,
+    PostSignupRequestToJSON,
+} from '../models/PostSignupRequest';
+import {
+    type PostSignupRequestResponse,
+    PostSignupRequestResponseFromJSON,
+    PostSignupRequestResponseToJSON,
+} from '../models/PostSignupRequestResponse';
 import {
     type PutUser,
     PutUserFromJSON,
@@ -61,6 +71,10 @@ export interface PostLoginRequest {
     postLogin: PostLogin;
 }
 
+export interface PostSignupRequestRequest {
+    postSignupRequest: PostSignupRequest;
+}
+
 export interface PostUserAvatarUploadRequest {
     userId: string;
     file: Blob;
@@ -79,6 +93,10 @@ export interface SendResetPasswordRequest {
     postSendResetPassword: PostSendResetPassword;
 }
 
+export interface VerifySignupRequestRequest {
+    token: string;
+}
+
 /**
  * 
  */
@@ -331,6 +349,53 @@ export class UserApi extends runtime.BaseAPI {
         await this.postLogoutRaw(initOverrides);
     }
 
+    /**
+     * Creates request options for postSignupRequest without sending the request
+     */
+    async postSignupRequestRequestOpts(requestParameters: PostSignupRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postSignupRequest'] == null) {
+            throw new runtime.RequiredError(
+                'postSignupRequest',
+                'Required parameter "postSignupRequest" was null or undefined when calling postSignupRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/auth/signup-request`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostSignupRequestToJSON(requestParameters['postSignupRequest']),
+        };
+    }
+
+    /**
+     * Request a new organization signup
+     */
+    async postSignupRequestRaw(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostSignupRequestResponse>> {
+        const requestOptions = await this.postSignupRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostSignupRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Request a new organization signup
+     */
+    async postSignupRequest(requestParameters: PostSignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostSignupRequestResponse> {
+        const response = await this.postSignupRequestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postUserAvatarUpload without sending the request
      */
@@ -551,4 +616,51 @@ export class UserApi extends runtime.BaseAPI {
         await this.sendResetPasswordRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for verifySignupRequest without sending the request
+     */
+    async verifySignupRequestRequestOpts(requestParameters: VerifySignupRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['token'] == null) {
+            throw new runtime.RequiredError(
+                'token',
+                'Required parameter "token" was null or undefined when calling verifySignupRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['token'] != null) {
+            queryParameters['token'] = requestParameters['token'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/auth/signup/verify`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Verify a signup request and provision the portal
+     */
+    async verifySignupRequestRaw(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.verifySignupRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Verify a signup request and provision the portal
+     */
+    async verifySignupRequest(requestParameters: VerifySignupRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.verifySignupRequestRaw(requestParameters, initOverrides);
+    }
+
 }