@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/src/apis/PlayerApi.ts

@@ -13,6 +13,31 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type ScormGetValueResponse,
+    ScormGetValueResponseFromJSON,
+    ScormGetValueResponseToJSON,
+} from '../models/ScormGetValueResponse';
+import {
+    type ScormSetValueRequest,
+    ScormSetValueRequestFromJSON,
+    ScormSetValueRequestToJSON,
+} from '../models/ScormSetValueRequest';
+import {
+    type ScormSetValueResponse,
+    ScormSetValueResponseFromJSON,
+    ScormSetValueResponseToJSON,
+} from '../models/ScormSetValueResponse';
+
+export interface CommitResourceScormSessionRequest {
+    sessionId: string;
+}
+
+export interface GetCourseVersionResourceAssetRequest {
+    courseVersionId: string;
+    itemId: string;
+    assetPath: string;
+}
 
 export interface GetDispatchScormPlayerRequest {
     sessionId: string;
@@ -42,6 +67,15 @@ export interface GetQuizPlayerRequest {
     sessionId: string;
 }
 
+export interface GetResourceScormValueRequest {
+    sessionId: string;
+    key: string;
+}
+
+export interface GetResourceSessionPlayerRequest {
+    sessionId: string;
+}
+
 export interface GetScormAssetRequest {
     contentId: string;
     assetPath: string;
@@ -59,11 +93,129 @@ export interface GetVideoPlayerRequest {
     sessionId: string;
 }
 
+export interface InitializeResourceScormSessionRequest {
+    sessionId: string;
+}
+
+export interface SetResourceScormValueRequest {
+    sessionId: string;
+    scormSetValueRequest: ScormSetValueRequest;
+}
+
+export interface TerminateResourceScormSessionRequest {
+    sessionId: string;
+}
+
 /**
  * 
  */
 export class PlayerApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for commitResourceScormSession without sending the request
+     */
+    async commitResourceScormSessionRequestOpts(requestParameters: CommitResourceScormSessionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling commitResourceScormSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/commit`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    async commitResourceScormSessionRaw(requestParameters: CommitResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.commitResourceScormSessionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Commit a reusable SCORM resource session
+     */
+    async commitResourceScormSession(requestParameters: CommitResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.commitResourceScormSessionRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for getCourseVersionResourceAsset without sending the request
+     */
+    async getCourseVersionResourceAssetRequestOpts(requestParameters: GetCourseVersionResourceAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling getCourseVersionResourceAsset().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling getCourseVersionResourceAsset().'
+            );
+        }
+
+        if (requestParameters['assetPath'] == null) {
+            throw new runtime.RequiredError(
+                'assetPath',
+                'Required parameter "assetPath" was null or undefined when calling getCourseVersionResourceAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath}`;
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    async getCourseVersionResourceAssetRaw(requestParameters: GetCourseVersionResourceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.getCourseVersionResourceAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Stream an asset from an exact course and resource version
+     */
+    async getCourseVersionResourceAsset(requestParameters: GetCourseVersionResourceAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.getCourseVersionResourceAssetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getDispatchScormPlayer without sending the request
      */
@@ -372,6 +524,111 @@ export class PlayerApi extends runtime.BaseAPI {
         await this.getQuizPlayerRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for getResourceScormValue without sending the request
+     */
+    async getResourceScormValueRequestOpts(requestParameters: GetResourceScormValueRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceScormValue().'
+            );
+        }
+
+        if (requestParameters['key'] == null) {
+            throw new runtime.RequiredError(
+                'key',
+                'Required parameter "key" was null or undefined when calling getResourceScormValue().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['key'] != null) {
+            queryParameters['key'] = requestParameters['key'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/get-value`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    async getResourceScormValueRaw(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormGetValueResponse>> {
+        const requestOptions = await this.getResourceScormValueRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScormGetValueResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Read a CMI value from a reusable SCORM resource session
+     */
+    async getResourceScormValue(requestParameters: GetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormGetValueResponse> {
+        const response = await this.getResourceScormValueRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getResourceSessionPlayer without sending the request
+     */
+    async getResourceSessionPlayerRequestOpts(requestParameters: GetResourceSessionPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceSessionPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Serve the player for a version-pinned reusable resource session
+     */
+    async getResourceSessionPlayerRaw(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.getResourceSessionPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Serve the player for a version-pinned reusable resource session
+     */
+    async getResourceSessionPlayer(requestParameters: GetResourceSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.getResourceSessionPlayerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getScormAsset without sending the request
      */
@@ -556,4 +813,147 @@ export class PlayerApi extends runtime.BaseAPI {
         await this.getVideoPlayerRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for initializeResourceScormSession without sending the request
+     */
+    async initializeResourceScormSessionRequestOpts(requestParameters: InitializeResourceScormSessionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling initializeResourceScormSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/initialize`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    async initializeResourceScormSessionRaw(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.initializeResourceScormSessionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Initialize a reusable SCORM resource session
+     */
+    async initializeResourceScormSession(requestParameters: InitializeResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for setResourceScormValue without sending the request
+     */
+    async setResourceScormValueRequestOpts(requestParameters: SetResourceScormValueRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling setResourceScormValue().'
+            );
+        }
+
+        if (requestParameters['scormSetValueRequest'] == null) {
+            throw new runtime.RequiredError(
+                'scormSetValueRequest',
+                'Required parameter "scormSetValueRequest" was null or undefined when calling setResourceScormValue().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/resource/sessions/{sessionId}/set-value`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ScormSetValueRequestToJSON(requestParameters['scormSetValueRequest']),
+        };
+    }
+
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    async setResourceScormValueRaw(requestParameters: SetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ScormSetValueResponse>> {
+        const requestOptions = await this.setResourceScormValueRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ScormSetValueResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Store a CMI value in a reusable SCORM resource session
+     */
+    async setResourceScormValue(requestParameters: SetResourceScormValueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ScormSetValueResponse> {
+        const response = await this.setResourceScormValueRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for terminateResourceScormSession without sending the request
+     */
+    async terminateResourceScormSessionRequestOpts(requestParameters: TerminateResourceScormSessionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling terminateResourceScormSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/terminate`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    async terminateResourceScormSessionRaw(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.terminateResourceScormSessionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Terminate a reusable SCORM resource session
+     */
+    async terminateResourceScormSession(requestParameters: TerminateResourceScormSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.terminateResourceScormSessionRaw(requestParameters, initOverrides);
+    }
+
 }

package/src/apis/index.ts

@@ -3,10 +3,12 @@
 export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
+export * from './ContentLibraryApi';
 export * from './CourseApi';
 export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
+export * from './EmailTemplateApi';
 export * from './ModuleApi';
 export * from './OtherApi';
 export * from './PlayerApi';

package/src/models/ContentLibraryVersionStatus.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+/**
+ * Lifecycle state of an immutable Content Library version.
+ * @export
+ */
+export const ContentLibraryVersionStatus = {
+    Draft: 'draft',
+    Published: 'published',
+    Archived: 'archived'
+} as const;
+export type ContentLibraryVersionStatus = typeof ContentLibraryVersionStatus[keyof typeof ContentLibraryVersionStatus];
+
+
+export function instanceOfContentLibraryVersionStatus(value: any): boolean {
+    for (const key in ContentLibraryVersionStatus) {
+        if (Object.prototype.hasOwnProperty.call(ContentLibraryVersionStatus, key)) {
+            if (ContentLibraryVersionStatus[key as keyof typeof ContentLibraryVersionStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ContentLibraryVersionStatusFromJSON(json: any): ContentLibraryVersionStatus {
+    return ContentLibraryVersionStatusFromJSONTyped(json, false);
+}
+
+export function ContentLibraryVersionStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLibraryVersionStatus {
+    return json as ContentLibraryVersionStatus;
+}
+
+export function ContentLibraryVersionStatusToJSON(value?: ContentLibraryVersionStatus | null): any {
+    return value as any;
+}
+
+export function ContentLibraryVersionStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): ContentLibraryVersionStatus {
+    return value as ContentLibraryVersionStatus;
+}
+

package/src/models/EmailTemplateDefinition.ts

@@ -0,0 +1,128 @@
+/* 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 { mapValues } from '../runtime';
+import type { EmailTemplateVariable } from './EmailTemplateVariable';
+import {
+    EmailTemplateVariableFromJSON,
+    EmailTemplateVariableFromJSONTyped,
+    EmailTemplateVariableToJSON,
+    EmailTemplateVariableToJSONTyped,
+} from './EmailTemplateVariable';
+import type { EmailTemplateScope } from './EmailTemplateScope';
+import {
+    EmailTemplateScopeFromJSON,
+    EmailTemplateScopeFromJSONTyped,
+    EmailTemplateScopeToJSON,
+    EmailTemplateScopeToJSONTyped,
+} from './EmailTemplateScope';
+
+/**
+ * 
+ * @export
+ * @interface EmailTemplateDefinition
+ */
+export interface EmailTemplateDefinition {
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    key: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    displayName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof EmailTemplateDefinition
+     */
+    description: string;
+    /**
+     * 
+     * @type {EmailTemplateScope}
+     * @memberof EmailTemplateDefinition
+     */
+    scope: EmailTemplateScope;
+    /**
+     * 
+     * @type {Array<EmailTemplateVariable>}
+     * @memberof EmailTemplateDefinition
+     */
+    variables: Array<EmailTemplateVariable>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof EmailTemplateDefinition
+     */
+    requiredBlockTypes: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the EmailTemplateDefinition interface.
+ */
+export function instanceOfEmailTemplateDefinition(value: object): value is EmailTemplateDefinition {
+    if (!('key' in value) || value['key'] === undefined) return false;
+    if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('scope' in value) || value['scope'] === undefined) return false;
+    if (!('variables' in value) || value['variables'] === undefined) return false;
+    if (!('requiredBlockTypes' in value) || value['requiredBlockTypes'] === undefined) return false;
+    return true;
+}
+
+export function EmailTemplateDefinitionFromJSON(json: any): EmailTemplateDefinition {
+    return EmailTemplateDefinitionFromJSONTyped(json, false);
+}
+
+export function EmailTemplateDefinitionFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateDefinition {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'key': json['key'],
+        'displayName': json['display_name'],
+        'description': json['description'],
+        'scope': EmailTemplateScopeFromJSON(json['scope']),
+        'variables': ((json['variables'] as Array<any>).map(EmailTemplateVariableFromJSON)),
+        'requiredBlockTypes': json['required_block_types'],
+    };
+}
+
+export function EmailTemplateDefinitionToJSON(json: any): EmailTemplateDefinition {
+    return EmailTemplateDefinitionToJSONTyped(json, false);
+}
+
+export function EmailTemplateDefinitionToJSONTyped(value?: EmailTemplateDefinition | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'key': value['key'],
+        'display_name': value['displayName'],
+        'description': value['description'],
+        'scope': EmailTemplateScopeToJSON(value['scope']),
+        'variables': ((value['variables'] as Array<any>).map(EmailTemplateVariableToJSON)),
+        'required_block_types': value['requiredBlockTypes'],
+    };
+}
+

package/src/models/EmailTemplateScope.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const EmailTemplateScope = {
+    PlatformOnly: 'platform_only',
+    PortalOverridable: 'portal_overridable'
+} as const;
+export type EmailTemplateScope = typeof EmailTemplateScope[keyof typeof EmailTemplateScope];
+
+
+export function instanceOfEmailTemplateScope(value: any): boolean {
+    for (const key in EmailTemplateScope) {
+        if (Object.prototype.hasOwnProperty.call(EmailTemplateScope, key)) {
+            if (EmailTemplateScope[key as keyof typeof EmailTemplateScope] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function EmailTemplateScopeFromJSON(json: any): EmailTemplateScope {
+    return EmailTemplateScopeFromJSONTyped(json, false);
+}
+
+export function EmailTemplateScopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): EmailTemplateScope {
+    return json as EmailTemplateScope;
+}
+
+export function EmailTemplateScopeToJSON(value?: EmailTemplateScope | null): any {
+    return value as any;
+}
+
+export function EmailTemplateScopeToJSONTyped(value: any, ignoreDiscriminator: boolean): EmailTemplateScope {
+    return value as EmailTemplateScope;
+}
+