@easyedu/js-lsm-api 1.118.0 → 1.120.0

package/docs/PostDispatchTokenExchange.md

@@ -0,0 +1,34 @@
+
+# PostDispatchTokenExchange
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+
+## Example
+
+```typescript
+import type { PostDispatchTokenExchange } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+} satisfies PostDispatchTokenExchange
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostDispatchTokenExchange
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutHostedScormStatus.md

@@ -0,0 +1,34 @@
+
+# PutHostedScormStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`active` | boolean
+
+## Example
+
+```typescript
+import type { PutHostedScormStatus } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "active": null,
+} satisfies PutHostedScormStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutHostedScormStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormGetValueResponse.md

@@ -9,6 +9,8 @@ Name | Type
 ------------ | -------------
 `success` | boolean
 `value` | string
+`errorCode` | string
+`diagnostic` | string
 
 ## Example
 
@@ -19,6 +21,8 @@ import type { ScormGetValueResponse } from '@easyedu/js-lsm-api'
 const example = {
   "success": null,
   "value": null,
+  "errorCode": null,
+  "diagnostic": null,
 } satisfies ScormGetValueResponse
 
 console.log(example)

package/docs/ScormNavigationDelivery.md

@@ -0,0 +1,43 @@
+
+# ScormNavigationDelivery
+
+Activity selected exclusively by the sequencing engine
+
+## Properties
+
+Name | Type
+------------ | -------------
+`activityIdentifier` | string
+`trackingUuid` | string
+`launchUrl` | string
+`title` | string
+`activityType` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationDelivery } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "activityIdentifier": null,
+  "trackingUuid": null,
+  "launchUrl": null,
+  "title": null,
+  "activityType": null,
+} satisfies ScormNavigationDelivery
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormNavigationDelivery
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormNavigationRequest.md

@@ -0,0 +1,37 @@
+
+# ScormNavigationRequest
+
+A SCORM 2004 navigation request
+
+## Properties
+
+Name | Type
+------------ | -------------
+`request` | string
+`targetIdentifier` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationRequest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "request": null,
+  "targetIdentifier": null,
+} satisfies ScormNavigationRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormNavigationRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormNavigationResponse.md

@@ -0,0 +1,47 @@
+
+# ScormNavigationResponse
+
+Result of a SCORM 2004 sequencing transition
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`delivery` | [ScormNavigationDelivery](ScormNavigationDelivery.md)
+`sequencingEnded` | boolean
+`suspended` | boolean
+`valid` | [ScormNavigationValidity](ScormNavigationValidity.md)
+`errorCode` | string
+`diagnostic` | string
+
+## Example
+
+```typescript
+import type { ScormNavigationResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "delivery": null,
+  "sequencingEnded": null,
+  "suspended": null,
+  "valid": null,
+  "errorCode": null,
+  "diagnostic": null,
+} satisfies ScormNavigationResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormNavigationResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormNavigationValidity.md

@@ -0,0 +1,55 @@
+
+# ScormNavigationValidity
+
+Navigation requests valid in the resulting sequencing state
+
+## Properties
+
+Name | Type
+------------ | -------------
+`start` | boolean
+`resumeAll` | boolean
+`_continue` | boolean
+`previous` | boolean
+`exit` | boolean
+`exitAll` | boolean
+`abandon` | boolean
+`abandonAll` | boolean
+`suspendAll` | boolean
+`choiceTargets` | Array<string>
+`jumpTargets` | Array<string>
+
+## Example
+
+```typescript
+import type { ScormNavigationValidity } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "start": null,
+  "resumeAll": null,
+  "_continue": null,
+  "previous": null,
+  "exit": null,
+  "exitAll": null,
+  "abandon": null,
+  "abandonAll": null,
+  "suspendAll": null,
+  "choiceTargets": null,
+  "jumpTargets": null,
+} satisfies ScormNavigationValidity
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormNavigationValidity
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormRuntimeResponse.md

@@ -0,0 +1,39 @@
+
+# ScormRuntimeResponse
+
+Typed result of a SCORM runtime API operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`errorCode` | string
+`diagnostic` | string
+
+## Example
+
+```typescript
+import type { ScormRuntimeResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "errorCode": null,
+  "diagnostic": null,
+} satisfies ScormRuntimeResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormRuntimeResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScormSetValueResponse.md

@@ -8,6 +8,8 @@ Response from setting a SCORM CMI data element value
 Name | Type
 ------------ | -------------
 `success` | boolean
+`errorCode` | string
+`diagnostic` | string
 
 ## Example
 
@@ -17,6 +19,8 @@ import type { ScormSetValueResponse } from '@easyedu/js-lsm-api'
 // TODO: Update the object below with actual values
 const example = {
   "success": null,
+  "errorCode": null,
+  "diagnostic": null,
 } satisfies ScormSetValueResponse
 
 console.log(example)

package/docs/ScormTerminateResponse.md

@@ -0,0 +1,44 @@
+
+# ScormTerminateResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`errorCode` | string
+`diagnostic` | string
+`delivery` | [ScormNavigationDelivery](ScormNavigationDelivery.md)
+`sequencingEnded` | boolean
+`suspended` | boolean
+
+## Example
+
+```typescript
+import type { ScormTerminateResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "errorCode": null,
+  "diagnostic": null,
+  "delivery": null,
+  "sequencingEnded": null,
+  "suspended": null,
+} satisfies ScormTerminateResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScormTerminateResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.118.0",
+  "version": "1.120.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CourseApi.ts

@@ -88,6 +88,16 @@ import {
     GetCourseVersionSectionFromJSON,
     GetCourseVersionSectionToJSON,
 } from '../models/GetCourseVersionSection';
+import {
+    type GetHostedScormRegistrationList,
+    GetHostedScormRegistrationListFromJSON,
+    GetHostedScormRegistrationListToJSON,
+} from '../models/GetHostedScormRegistrationList';
+import {
+    type HostedScormAccessPolicy,
+    HostedScormAccessPolicyFromJSON,
+    HostedScormAccessPolicyToJSON,
+} from '../models/HostedScormAccessPolicy';
 import {
     type PostClearSessions,
     PostClearSessionsFromJSON,
@@ -193,6 +203,11 @@ import {
     PutCourseVersionSectionFromJSON,
     PutCourseVersionSectionToJSON,
 } from '../models/PutCourseVersionSection';
+import {
+    type PutHostedScormStatus,
+    PutHostedScormStatusFromJSON,
+    PutHostedScormStatusToJSON,
+} from '../models/PutHostedScormStatus';
 
 export interface DeleteCourseRequest {
     courseId: string;
@@ -299,6 +314,13 @@ export interface GetCourseVersionProgressionRequest {
     preview?: boolean;
 }
 
+export interface GetHostedScormExportRegistrationsRequest {
+    courseId: string;
+    exportId: string;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface GetPortalCourseExportsRequest {
     page?: number;
     pageSize?: number;
@@ -424,6 +446,18 @@ export interface PutCourseVersionSectionRequest {
     putCourseVersionSection: PutCourseVersionSection;
 }
 
+export interface PutHostedScormExportAccessRequest {
+    courseId: string;
+    exportId: string;
+    hostedScormAccessPolicy: HostedScormAccessPolicy;
+}
+
+export interface PutHostedScormExportStatusRequest {
+    courseId: string;
+    exportId: string;
+    putHostedScormStatus: PutHostedScormStatus;
+}
+
 /**
  * 
  */
@@ -1452,6 +1486,67 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getHostedScormExportRegistrations without sending the request
+     */
+    async getHostedScormExportRegistrationsRequestOpts(requestParameters: GetHostedScormExportRegistrationsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getHostedScormExportRegistrations().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling getHostedScormExportRegistrations().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/registrations`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List hosted SCORM learner registrations
+     */
+    async getHostedScormExportRegistrationsRaw(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetHostedScormRegistrationList>> {
+        const requestOptions = await this.getHostedScormExportRegistrationsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetHostedScormRegistrationListFromJSON(jsonValue));
+    }
+
+    /**
+     * List hosted SCORM learner registrations
+     */
+    async getHostedScormExportRegistrations(requestParameters: GetHostedScormExportRegistrationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetHostedScormRegistrationList> {
+        const response = await this.getHostedScormExportRegistrationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getPortalCourseExports without sending the request
      */
@@ -2752,6 +2847,132 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putHostedScormExportAccess without sending the request
+     */
+    async putHostedScormExportAccessRequestOpts(requestParameters: PutHostedScormExportAccessRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        if (requestParameters['hostedScormAccessPolicy'] == null) {
+            throw new runtime.RequiredError(
+                'hostedScormAccessPolicy',
+                'Required parameter "hostedScormAccessPolicy" was null or undefined when calling putHostedScormExportAccess().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/access`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: HostedScormAccessPolicyToJSON(requestParameters['hostedScormAccessPolicy']),
+        };
+    }
+
+    /**
+     * Update mutable access controls for a hosted SCORM export
+     */
+    async putHostedScormExportAccessRaw(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        const requestOptions = await this.putHostedScormExportAccessRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Update mutable access controls for a hosted SCORM export
+     */
+    async putHostedScormExportAccess(requestParameters: PutHostedScormExportAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.putHostedScormExportAccessRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putHostedScormExportStatus without sending the request
+     */
+    async putHostedScormExportStatusRequestOpts(requestParameters: PutHostedScormExportStatusRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        if (requestParameters['exportId'] == null) {
+            throw new runtime.RequiredError(
+                'exportId',
+                'Required parameter "exportId" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        if (requestParameters['putHostedScormStatus'] == null) {
+            throw new runtime.RequiredError(
+                'putHostedScormStatus',
+                'Required parameter "putHostedScormStatus" was null or undefined when calling putHostedScormExportStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/exports/{exportId}/status`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{exportId}', encodeURIComponent(String(requestParameters['exportId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutHostedScormStatusToJSON(requestParameters['putHostedScormStatus']),
+        };
+    }
+
+    /**
+     * Revoke or reactivate a hosted SCORM export
+     */
+    async putHostedScormExportStatusRaw(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
+        const requestOptions = await this.putHostedScormExportStatusRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseExportFromJSON(jsonValue));
+    }
+
+    /**
+     * Revoke or reactivate a hosted SCORM export
+     */
+    async putHostedScormExportStatus(requestParameters: PutHostedScormExportStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {
+        const response = await this.putHostedScormExportStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }
 
 /**