@easyedu/js-lsm-api 1.89.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/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'],

package/src/models/GetResourceSession.ts

@@ -0,0 +1,270 @@
+/* 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 { ResourceSessionEnvironment } from './ResourceSessionEnvironment';
+import {
+    ResourceSessionEnvironmentFromJSON,
+    ResourceSessionEnvironmentFromJSONTyped,
+    ResourceSessionEnvironmentToJSON,
+    ResourceSessionEnvironmentToJSONTyped,
+} from './ResourceSessionEnvironment';
+import type { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
+/**
+ * A user-owned session pinned to an immutable Content Library resource version.
+ * @export
+ * @interface GetResourceSession
+ */
+export interface GetResourceSession {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    userId: string;
+    /**
+     * 
+     * @type {ResourceSessionEnvironment}
+     * @memberof GetResourceSession
+     */
+    environment: ResourceSessionEnvironment;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    courseVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    itemId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryItemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    contentLibraryVersionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    resourceName: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof GetResourceSession
+     */
+    resourceType: ResourceType;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof GetResourceSession
+     */
+    launchMode?: ContentLaunchMode | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    launchUrl?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    attemptNumber: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetResourceSession
+     */
+    isCurrent: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    completionStatus: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetResourceSession
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    scoreRaw?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    initializedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    terminatedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetResourceSession
+     */
+    completedAt?: number | null;
+}
+
+
+
+/**
+ * Check if a given object implements the GetResourceSession interface.
+ */
+export function instanceOfGetResourceSession(value: object): value is GetResourceSession {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('environment' in value) || value['environment'] === undefined) return false;
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined) return false;
+    if (!('contentLibraryVersionId' in value) || value['contentLibraryVersionId'] === undefined) return false;
+    if (!('resourceName' in value) || value['resourceName'] === undefined) return false;
+    if (!('resourceType' in value) || value['resourceType'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('isCurrent' in value) || value['isCurrent'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function GetResourceSessionFromJSON(json: any): GetResourceSession {
+    return GetResourceSessionFromJSONTyped(json, false);
+}
+
+export function GetResourceSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetResourceSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'userId': json['user_id'],
+        'environment': ResourceSessionEnvironmentFromJSON(json['environment']),
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'courseVersionId': json['course_version_id'] == null ? undefined : json['course_version_id'],
+        'itemId': json['item_id'] == null ? undefined : json['item_id'],
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'],
+        'resourceName': json['resource_name'],
+        'resourceType': ResourceTypeFromJSON(json['resource_type']),
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'launchUrl': json['launch_url'] == null ? undefined : json['launch_url'],
+        'attemptNumber': json['attempt_number'],
+        'isCurrent': json['is_current'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'initializedAt': json['initialized_at'] == null ? undefined : json['initialized_at'],
+        'terminatedAt': json['terminated_at'] == null ? undefined : json['terminated_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'completedAt': json['completed_at'] == null ? undefined : json['completed_at'],
+    };
+}
+
+export function GetResourceSessionToJSON(json: any): GetResourceSession {
+    return GetResourceSessionToJSONTyped(json, false);
+}
+
+export function GetResourceSessionToJSONTyped(value?: GetResourceSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'user_id': value['userId'],
+        'environment': ResourceSessionEnvironmentToJSON(value['environment']),
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'resource_name': value['resourceName'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'launch_url': value['launchUrl'],
+        'attempt_number': value['attemptNumber'],
+        'is_current': value['isCurrent'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'initialized_at': value['initializedAt'],
+        'terminated_at': value['terminatedAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'completed_at': value['completedAt'],
+    };
+}
+