@easyedu/js-lsm-api 1.88.0 → 1.90.0

package/src/apis/PlayerApi.ts

@@ -13,6 +13,21 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type GetResourceSession,
+    GetResourceSessionFromJSON,
+    GetResourceSessionToJSON,
+} from '../models/GetResourceSession';
+import {
+    type GetResourceSessionList,
+    GetResourceSessionListFromJSON,
+    GetResourceSessionListToJSON,
+} from '../models/GetResourceSessionList';
+import {
+    type ResourceSessionEnvironment,
+    ResourceSessionEnvironmentFromJSON,
+    ResourceSessionEnvironmentToJSON,
+} from '../models/ResourceSessionEnvironment';
 import {
     type ScormGetValueResponse,
     ScormGetValueResponseFromJSON,
@@ -72,6 +87,28 @@ export interface GetResourceScormValueRequest {
     key: string;
 }
 
+export interface GetResourceSessionRequest {
+    sessionId: string;
+}
+
+export interface GetResourceSessionAssetRequest {
+    sessionId: string;
+    assetPath: string;
+}
+
+export interface GetResourceSessionListRequest {
+    userId?: string;
+    resourceId?: string;
+    versionId?: string;
+    courseId?: string;
+    environment?: ResourceSessionEnvironment;
+    completionStatus?: string;
+    createdFrom?: number;
+    createdTo?: number;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface GetResourceSessionPlayerRequest {
     sessionId: string;
 }
@@ -97,6 +134,10 @@ export interface InitializeResourceScormSessionRequest {
     sessionId: string;
 }
 
+export interface PostResourceSessionCompleteRequest {
+    sessionId: string;
+}
+
 export interface SetResourceScormValueRequest {
     sessionId: string;
     scormSetValueRequest: ScormSetValueRequest;
@@ -580,6 +621,181 @@ export class PlayerApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getResourceSession without sending the request
+     */
+    async getResourceSessionRequestOpts(requestParameters: GetResourceSessionRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a resource session
+     */
+    async getResourceSessionRaw(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
+        const requestOptions = await this.getResourceSessionRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a resource session
+     */
+    async getResourceSession(requestParameters: GetResourceSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
+        const response = await this.getResourceSessionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getResourceSessionAsset without sending the request
+     */
+    async getResourceSessionAssetRequestOpts(requestParameters: GetResourceSessionAssetRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getResourceSessionAsset().'
+            );
+        }
+
+        if (requestParameters['assetPath'] == null) {
+            throw new runtime.RequiredError(
+                'assetPath',
+                'Required parameter "assetPath" was null or undefined when calling getResourceSessionAsset().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/asset/{assetPath}`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+        urlPath = urlPath.replace('{assetPath}', encodeURIComponent(String(requestParameters['assetPath'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Stream an asset pinned to a resource session
+     */
+    async getResourceSessionAssetRaw(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.getResourceSessionAssetRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Stream an asset pinned to a resource session
+     */
+    async getResourceSessionAsset(requestParameters: GetResourceSessionAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.getResourceSessionAssetRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getResourceSessionList without sending the request
+     */
+    async getResourceSessionListRequestOpts(requestParameters: GetResourceSessionListRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['user_id'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['resourceId'] != null) {
+            queryParameters['resource_id'] = requestParameters['resourceId'];
+        }
+
+        if (requestParameters['versionId'] != null) {
+            queryParameters['version_id'] = requestParameters['versionId'];
+        }
+
+        if (requestParameters['courseId'] != null) {
+            queryParameters['course_id'] = requestParameters['courseId'];
+        }
+
+        if (requestParameters['environment'] != null) {
+            queryParameters['environment'] = requestParameters['environment'];
+        }
+
+        if (requestParameters['completionStatus'] != null) {
+            queryParameters['completion_status'] = requestParameters['completionStatus'];
+        }
+
+        if (requestParameters['createdFrom'] != null) {
+            queryParameters['created_from'] = requestParameters['createdFrom'];
+        }
+
+        if (requestParameters['createdTo'] != null) {
+            queryParameters['created_to'] = requestParameters['createdTo'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List resource sessions for the selected portal
+     */
+    async getResourceSessionListRaw(requestParameters: GetResourceSessionListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSessionList>> {
+        const requestOptions = await this.getResourceSessionListRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionListFromJSON(jsonValue));
+    }
+
+    /**
+     * List resource sessions for the selected portal
+     */
+    async getResourceSessionList(requestParameters: GetResourceSessionListRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSessionList> {
+        const response = await this.getResourceSessionListRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getResourceSessionPlayer without sending the request
      */
@@ -857,6 +1073,51 @@ export class PlayerApi extends runtime.BaseAPI {
         await this.initializeResourceScormSessionRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for postResourceSessionComplete without sending the request
+     */
+    async postResourceSessionCompleteRequestOpts(requestParameters: PostResourceSessionCompleteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling postResourceSessionComplete().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/resource/sessions/{sessionId}/complete`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Complete a non-SCORM resource session
+     */
+    async postResourceSessionCompleteRaw(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
+        const requestOptions = await this.postResourceSessionCompleteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Complete a non-SCORM resource session
+     */
+    async postResourceSessionComplete(requestParameters: PostResourceSessionCompleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
+        const response = await this.postResourceSessionCompleteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for setResourceScormValue without sending the request
      */

package/src/models/CertificateCanvasImageElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasImageElement {
      * @memberof CertificateCanvasImageElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasImageElementTypeEnum}
-     * @memberof CertificateCanvasImageElement
-     */
-    type: CertificateCanvasImageElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -70,14 +64,6 @@ export interface CertificateCanvasImageElement {
 }
 
 
-/**
- * @export
- */
-export const CertificateCanvasImageElementTypeEnum = {
-    Image: 'image'
-} as const;
-export type CertificateCanvasImageElementTypeEnum = typeof CertificateCanvasImageElementTypeEnum[keyof typeof CertificateCanvasImageElementTypeEnum];
-
 /**
  * @export
  */
@@ -94,7 +80,6 @@ export type CertificateCanvasImageElementFitEnum = typeof CertificateCanvasImage
  */
 export function instanceOfCertificateCanvasImageElement(value: object): value is CertificateCanvasImageElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -114,7 +99,6 @@ export function CertificateCanvasImageElementFromJSONTyped(json: any, ignoreDisc
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -136,7 +120,6 @@ export function CertificateCanvasImageElementToJSONTyped(value?: CertificateCanv
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/CertificateCanvasLineElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasLineElement {
      * @memberof CertificateCanvasLineElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasLineElementTypeEnum}
-     * @memberof CertificateCanvasLineElement
-     */
-    type: CertificateCanvasLineElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -69,22 +63,11 @@ export interface CertificateCanvasLineElement {
     strokeWidth: number;
 }
 
-
-/**
- * @export
- */
-export const CertificateCanvasLineElementTypeEnum = {
-    Line: 'line'
-} as const;
-export type CertificateCanvasLineElementTypeEnum = typeof CertificateCanvasLineElementTypeEnum[keyof typeof CertificateCanvasLineElementTypeEnum];
-
-
 /**
  * Check if a given object implements the CertificateCanvasLineElement interface.
  */
 export function instanceOfCertificateCanvasLineElement(value: object): value is CertificateCanvasLineElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -105,7 +88,6 @@ export function CertificateCanvasLineElementFromJSONTyped(json: any, ignoreDiscr
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -127,7 +109,6 @@ export function CertificateCanvasLineElementToJSONTyped(value?: CertificateCanva
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/CertificateCanvasPortalLogoElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasPortalLogoElement {
      * @memberof CertificateCanvasPortalLogoElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasPortalLogoElementTypeEnum}
-     * @memberof CertificateCanvasPortalLogoElement
-     */
-    type: CertificateCanvasPortalLogoElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -57,22 +51,11 @@ export interface CertificateCanvasPortalLogoElement {
     height: number;
 }
 
-
-/**
- * @export
- */
-export const CertificateCanvasPortalLogoElementTypeEnum = {
-    PortalLogo: 'portal_logo'
-} as const;
-export type CertificateCanvasPortalLogoElementTypeEnum = typeof CertificateCanvasPortalLogoElementTypeEnum[keyof typeof CertificateCanvasPortalLogoElementTypeEnum];
-
-
 /**
  * Check if a given object implements the CertificateCanvasPortalLogoElement interface.
  */
 export function instanceOfCertificateCanvasPortalLogoElement(value: object): value is CertificateCanvasPortalLogoElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -91,7 +74,6 @@ export function CertificateCanvasPortalLogoElementFromJSONTyped(json: any, ignor
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -111,7 +93,6 @@ export function CertificateCanvasPortalLogoElementToJSONTyped(value?: Certificat
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/CertificateCanvasShapeElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasShapeElement {
      * @memberof CertificateCanvasShapeElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasShapeElementTypeEnum}
-     * @memberof CertificateCanvasShapeElement
-     */
-    type: CertificateCanvasShapeElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -75,22 +69,11 @@ export interface CertificateCanvasShapeElement {
     strokeWidth: number;
 }
 
-
-/**
- * @export
- */
-export const CertificateCanvasShapeElementTypeEnum = {
-    Shape: 'shape'
-} as const;
-export type CertificateCanvasShapeElementTypeEnum = typeof CertificateCanvasShapeElementTypeEnum[keyof typeof CertificateCanvasShapeElementTypeEnum];
-
-
 /**
  * Check if a given object implements the CertificateCanvasShapeElement interface.
  */
 export function instanceOfCertificateCanvasShapeElement(value: object): value is CertificateCanvasShapeElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -112,7 +95,6 @@ export function CertificateCanvasShapeElementFromJSONTyped(json: any, ignoreDisc
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -135,7 +117,6 @@ export function CertificateCanvasShapeElementToJSONTyped(value?: CertificateCanv
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/CertificateCanvasTextElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasTextElement {
      * @memberof CertificateCanvasTextElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasTextElementTypeEnum}
-     * @memberof CertificateCanvasTextElement
-     */
-    type: CertificateCanvasTextElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -88,14 +82,6 @@ export interface CertificateCanvasTextElement {
 }
 
 
-/**
- * @export
- */
-export const CertificateCanvasTextElementTypeEnum = {
-    Text: 'text'
-} as const;
-export type CertificateCanvasTextElementTypeEnum = typeof CertificateCanvasTextElementTypeEnum[keyof typeof CertificateCanvasTextElementTypeEnum];
-
 /**
  * @export
  */
@@ -120,7 +106,6 @@ export type CertificateCanvasTextElementAlignEnum = typeof CertificateCanvasText
  */
 export function instanceOfCertificateCanvasTextElement(value: object): value is CertificateCanvasTextElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -143,7 +128,6 @@ export function CertificateCanvasTextElementFromJSONTyped(json: any, ignoreDiscr
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -168,7 +152,6 @@ export function CertificateCanvasTextElementToJSONTyped(value?: CertificateCanva
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/CertificateCanvasVerificationQrElement.ts

@@ -25,12 +25,6 @@ export interface CertificateCanvasVerificationQrElement {
      * @memberof CertificateCanvasVerificationQrElement
      */
     id: string;
-    /**
-     * 
-     * @type {CertificateCanvasVerificationQrElementTypeEnum}
-     * @memberof CertificateCanvasVerificationQrElement
-     */
-    type: CertificateCanvasVerificationQrElementTypeEnum;
     /**
      * 
      * @type {number}
@@ -57,22 +51,11 @@ export interface CertificateCanvasVerificationQrElement {
     height: number;
 }
 
-
-/**
- * @export
- */
-export const CertificateCanvasVerificationQrElementTypeEnum = {
-    VerificationQr: 'verification_qr'
-} as const;
-export type CertificateCanvasVerificationQrElementTypeEnum = typeof CertificateCanvasVerificationQrElementTypeEnum[keyof typeof CertificateCanvasVerificationQrElementTypeEnum];
-
-
 /**
  * Check if a given object implements the CertificateCanvasVerificationQrElement interface.
  */
 export function instanceOfCertificateCanvasVerificationQrElement(value: object): value is CertificateCanvasVerificationQrElement {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
     if (!('x' in value) || value['x'] === undefined) return false;
     if (!('y' in value) || value['y'] === undefined) return false;
     if (!('width' in value) || value['width'] === undefined) return false;
@@ -91,7 +74,6 @@ export function CertificateCanvasVerificationQrElementFromJSONTyped(json: any, i
     return {
         
         'id': json['id'],
-        'type': json['type'],
         'x': json['x'],
         'y': json['y'],
         'width': json['width'],
@@ -111,7 +93,6 @@ export function CertificateCanvasVerificationQrElementToJSONTyped(value?: Certif
     return {
         
         'id': value['id'],
-        'type': value['type'],
         'x': value['x'],
         'y': value['y'],
         'width': value['width'],

package/src/models/GetCourseVersionItemSession.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
+import {
+    ResourceSessionEnvironmentFromJSON,
+    ResourceSessionEnvironmentFromJSONTyped,
+    ResourceSessionEnvironmentToJSON,
+    ResourceSessionEnvironmentToJSONTyped,
+} from './ResourceSessionEnvironment';
 import type { ResourceType } from './ResourceType';
 import {
     ResourceTypeFromJSON,
@@ -40,6 +47,12 @@ export interface GetCourseVersionItemSession {
      * @memberof GetCourseVersionItemSession
      */
     id: string;
+    /**
+     * 
+     * @type {ResourceSessionEnvironment}
+     * @memberof GetCourseVersionItemSession
+     */
+    environment: ResourceSessionEnvironment;
     /**
      * 
      * @type {string}
@@ -139,6 +152,7 @@ export interface GetCourseVersionItemSession {
  */
 export function instanceOfGetCourseVersionItemSession(value: object): value is GetCourseVersionItemSession {
     if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('environment' in value) || value['environment'] === undefined) return false;
     if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
     if (!('itemId' in value) || value['itemId'] === undefined) return false;
     if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
@@ -166,6 +180,7 @@ export function GetCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscri
     return {
         
         'id': json['id'],
+        'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
         'courseVersionId': json['course_version_id'],
         'itemId': json['item_id'],
         'contentLibraryItemId': json['content_library_item_id'],
@@ -196,6 +211,7 @@ export function GetCourseVersionItemSessionToJSONTyped(value?: GetCourseVersionI
     return {
         
         'id': value['id'],
+        'environment': ResourceSessionEnvironmentToJSON(value['environment']),
         'course_version_id': value['courseVersionId'],
         'item_id': value['itemId'],
         'content_library_item_id': value['contentLibraryItemId'],