@easyedu/js-lsm-api 1.62.0 → 1.63.0

package/.openapi-generator/FILES

@@ -16,6 +16,7 @@ docs/CourseShareApi.md
 docs/CriteriaBasedSelection.md
 docs/CriteriaBasedSelectionCriteria.md
 docs/CriteriaBasedSelectionDistribution.md
+docs/DispatchApi.md
 docs/DownloadSupportTicketAttachment200Response.md
 docs/EffectiveCertificateConfig.md
 docs/Essay.md
@@ -173,6 +174,7 @@ docs/MultipleAnswer1.md
 docs/NoAnswer.md
 docs/OtherApi.md
 docs/Paginated.md
+docs/PlayerApi.md
 docs/PortalApi.md
 docs/PortalSublicense.md
 docs/PortalSublicenseApi.md
@@ -284,8 +286,10 @@ src/apis/ContentApi.ts
 src/apis/CourseApi.ts
 src/apis/CourseCatalogApi.ts
 src/apis/CourseShareApi.ts
+src/apis/DispatchApi.ts
 src/apis/ModuleApi.ts
 src/apis/OtherApi.ts
+src/apis/PlayerApi.ts
 src/apis/PortalApi.ts
 src/apis/PortalSublicenseApi.ts
 src/apis/QuestionApi.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.62.0
+# @easyedu/js-lsm-api@1.63.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -124,6 +124,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *CourseShareApi* | [**putAcceptClone**](docs/CourseShareApi.md#putacceptclone) | **PUT** /course-shares/{shareId}/accept-clone | Accept an offer as a clone (deep copy into your portal)
 *CourseShareApi* | [**putAcceptMirror**](docs/CourseShareApi.md#putacceptmirror) | **PUT** /course-shares/{shareId}/accept-mirror | Accept an offer as a mirror (no copy, live link to source)
 *CourseShareApi* | [**putDeclineShare**](docs/CourseShareApi.md#putdeclineshare) | **PUT** /course-shares/{shareId}/decline | Decline an offer
+*DispatchApi* | [**getDispatchRollup**](docs/DispatchApi.md#getdispatchrollup) | **GET** /dispatch/sessions/{dispatchPackageId}/rollup | Get dispatch package rollup data
+*DispatchApi* | [**postDispatchLaunch**](docs/DispatchApi.md#postdispatchlaunch) | **POST** /dispatch/launch | Launch a dispatch package
 *ModuleApi* | [**getModule**](docs/ModuleApi.md#getmodule) | **GET** /courses/{courseId}/modules/{moduleId} | get a course module
 *ModuleApi* | [**getModuleList**](docs/ModuleApi.md#getmodulelist) | **GET** /courses/{courseId}/modules | get module list
 *ModuleApi* | [**postModule**](docs/ModuleApi.md#postmodule) | **POST** /courses/{courseId}/modules | Post a new module
@@ -131,6 +133,17 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *ModuleApi* | [**putModule**](docs/ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id
 *ModuleApi* | [**putModuleReorder**](docs/ModuleApi.md#putmodulereorder) | **PUT** /courses/{courseId}/modules/reorder | Reorder modules in a course
 *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
+*PlayerApi* | [**getDispatchScormPlayer**](docs/PlayerApi.md#getdispatchscormplayer) | **GET** /scorm/dispatch/session/{sessionId}/player | Dispatch SCORM player HTML page
+*PlayerApi* | [**getFileAsset**](docs/PlayerApi.md#getfileasset) | **GET** /file/{contentId}/asset | File asset
+*PlayerApi* | [**getFilePlayer**](docs/PlayerApi.md#getfileplayer) | **GET** /file/session/{sessionId}/player | File player HTML page
+*PlayerApi* | [**getImagePlayer**](docs/PlayerApi.md#getimageplayer) | **GET** /image/session/{sessionId}/player | Image player HTML page
+*PlayerApi* | [**getPdfAsset**](docs/PlayerApi.md#getpdfasset) | **GET** /pdf/{contentId}/asset | PDF asset
+*PlayerApi* | [**getPdfPlayer**](docs/PlayerApi.md#getpdfplayer) | **GET** /pdf/session/{sessionId}/player | PDF player HTML page
+*PlayerApi* | [**getQuizPlayer**](docs/PlayerApi.md#getquizplayer) | **GET** /quiz/session/{sessionId}/player | Quiz player HTML page
+*PlayerApi* | [**getScormAsset**](docs/PlayerApi.md#getscormasset) | **GET** /scorm/{contentId}/scorm/asset/{assetPath} | SCORM package asset
+*PlayerApi* | [**getScormPlayer**](docs/PlayerApi.md#getscormplayer) | **GET** /scorm/session/{sessionId}/player | SCORM player HTML page
+*PlayerApi* | [**getVideoAsset**](docs/PlayerApi.md#getvideoasset) | **GET** /video/{contentId}/asset | Video asset
+*PlayerApi* | [**getVideoPlayer**](docs/PlayerApi.md#getvideoplayer) | **GET** /video/session/{sessionId}/player | Video player HTML page
 *PortalApi* | [**deletePortalFavicon**](docs/PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon
 *PortalApi* | [**deletePortalLogo**](docs/PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo
 *PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
@@ -489,7 +502,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.62.0`
+- Package version: `1.63.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/DispatchApi.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 GetDispatchRollupRequest {
+    dispatchPackageId: string;
+}
+/**
+ *
+ */
+export declare class DispatchApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getDispatchRollup without sending the request
+     */
+    getDispatchRollupRequestOpts(requestParameters: GetDispatchRollupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get dispatch package rollup data
+     */
+    getDispatchRollupRaw(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Get dispatch package rollup data
+     */
+    getDispatchRollup(requestParameters: GetDispatchRollupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for postDispatchLaunch without sending the request
+     */
+    postDispatchLaunchRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Launch a dispatch package
+     */
+    postDispatchLaunchRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Launch a dispatch package
+     */
+    postDispatchLaunch(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}

package/dist/apis/DispatchApi.js

@@ -0,0 +1,104 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DispatchApi = void 0;
+const runtime = require("../runtime");
+/**
+ *
+ */
+class DispatchApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getDispatchRollup without sending the request
+     */
+    getDispatchRollupRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dispatchPackageId'] == null) {
+                throw new runtime.RequiredError('dispatchPackageId', 'Required parameter "dispatchPackageId" was null or undefined when calling getDispatchRollup().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/dispatch/sessions/{dispatchPackageId}/rollup`;
+            urlPath = urlPath.replace('{dispatchPackageId}', encodeURIComponent(String(requestParameters['dispatchPackageId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Get dispatch package rollup data
+     */
+    getDispatchRollupRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDispatchRollupRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Get dispatch package rollup data
+     */
+    getDispatchRollup(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.getDispatchRollupRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for postDispatchLaunch without sending the request
+     */
+    postDispatchLaunchRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/dispatch/launch`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Launch a dispatch package
+     */
+    postDispatchLaunchRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postDispatchLaunchRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Launch a dispatch package
+     */
+    postDispatchLaunch(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.postDispatchLaunchRaw(initOverrides);
+        });
+    }
+}
+exports.DispatchApi = DispatchApi;

package/dist/apis/PlayerApi.d.ts

@@ -0,0 +1,183 @@
+/**
+ * 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 declare class PlayerApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for getDispatchScormPlayer without sending the request
+     */
+    getDispatchScormPlayerRequestOpts(requestParameters: GetDispatchScormPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Dispatch SCORM player HTML page
+     */
+    getDispatchScormPlayerRaw(requestParameters: GetDispatchScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Dispatch SCORM player HTML page
+     */
+    getDispatchScormPlayer(requestParameters: GetDispatchScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getFileAsset without sending the request
+     */
+    getFileAssetRequestOpts(requestParameters: GetFileAssetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * File asset
+     */
+    getFileAssetRaw(requestParameters: GetFileAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * File asset
+     */
+    getFileAsset(requestParameters: GetFileAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getFilePlayer without sending the request
+     */
+    getFilePlayerRequestOpts(requestParameters: GetFilePlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * File player HTML page
+     */
+    getFilePlayerRaw(requestParameters: GetFilePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * File player HTML page
+     */
+    getFilePlayer(requestParameters: GetFilePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getImagePlayer without sending the request
+     */
+    getImagePlayerRequestOpts(requestParameters: GetImagePlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Image player HTML page
+     */
+    getImagePlayerRaw(requestParameters: GetImagePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Image player HTML page
+     */
+    getImagePlayer(requestParameters: GetImagePlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getPdfAsset without sending the request
+     */
+    getPdfAssetRequestOpts(requestParameters: GetPdfAssetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * PDF asset
+     */
+    getPdfAssetRaw(requestParameters: GetPdfAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * PDF asset
+     */
+    getPdfAsset(requestParameters: GetPdfAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getPdfPlayer without sending the request
+     */
+    getPdfPlayerRequestOpts(requestParameters: GetPdfPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * PDF player HTML page
+     */
+    getPdfPlayerRaw(requestParameters: GetPdfPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * PDF player HTML page
+     */
+    getPdfPlayer(requestParameters: GetPdfPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getQuizPlayer without sending the request
+     */
+    getQuizPlayerRequestOpts(requestParameters: GetQuizPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Quiz player HTML page
+     */
+    getQuizPlayerRaw(requestParameters: GetQuizPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Quiz player HTML page
+     */
+    getQuizPlayer(requestParameters: GetQuizPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getScormAsset without sending the request
+     */
+    getScormAssetRequestOpts(requestParameters: GetScormAssetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * SCORM package asset
+     */
+    getScormAssetRaw(requestParameters: GetScormAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * SCORM package asset
+     */
+    getScormAsset(requestParameters: GetScormAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getScormPlayer without sending the request
+     */
+    getScormPlayerRequestOpts(requestParameters: GetScormPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * SCORM player HTML page
+     */
+    getScormPlayerRaw(requestParameters: GetScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * SCORM player HTML page
+     */
+    getScormPlayer(requestParameters: GetScormPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getVideoAsset without sending the request
+     */
+    getVideoAssetRequestOpts(requestParameters: GetVideoAssetRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Video asset
+     */
+    getVideoAssetRaw(requestParameters: GetVideoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Video asset
+     */
+    getVideoAsset(requestParameters: GetVideoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getVideoPlayer without sending the request
+     */
+    getVideoPlayerRequestOpts(requestParameters: GetVideoPlayerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Video player HTML page
+     */
+    getVideoPlayerRaw(requestParameters: GetVideoPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Video player HTML page
+     */
+    getVideoPlayer(requestParameters: GetVideoPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}