@easyedu/js-lsm-api 1.127.0 → 1.129.0

package/dist/models/PostVerifyManifest.js

@@ -0,0 +1,80 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostVerifyManifest = instanceOfPostVerifyManifest;
+exports.PostVerifyManifestFromJSON = PostVerifyManifestFromJSON;
+exports.PostVerifyManifestFromJSONTyped = PostVerifyManifestFromJSONTyped;
+exports.PostVerifyManifestToJSON = PostVerifyManifestToJSON;
+exports.PostVerifyManifestToJSONTyped = PostVerifyManifestToJSONTyped;
+const PostVerifyManifestResourcesInner_1 = require("./PostVerifyManifestResourcesInner");
+const PostVerifyManifestItemsInner_1 = require("./PostVerifyManifestItemsInner");
+/**
+ * Check if a given object implements the PostVerifyManifest interface.
+ */
+function instanceOfPostVerifyManifest(value) {
+    if (!('valid' in value) || value['valid'] === undefined)
+        return false;
+    if (!('errors' in value) || value['errors'] === undefined)
+        return false;
+    if (!('warnings' in value) || value['warnings'] === undefined)
+        return false;
+    return true;
+}
+function PostVerifyManifestFromJSON(json) {
+    return PostVerifyManifestFromJSONTyped(json, false);
+}
+function PostVerifyManifestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'valid': json['valid'],
+        'errors': json['errors'],
+        'warnings': json['warnings'],
+        'scormVersion': json['scorm_version'] == null ? undefined : json['scorm_version'],
+        'identifier': json['identifier'] == null ? undefined : json['identifier'],
+        'version': json['version'] == null ? undefined : json['version'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'schema': json['schema'] == null ? undefined : json['schema'],
+        'schemaVersion': json['schema_version'] == null ? undefined : json['schema_version'],
+        'defaultOrganization': json['default_organization'] == null ? undefined : json['default_organization'],
+        'items': json['items'] == null ? undefined : (json['items'].map(PostVerifyManifestItemsInner_1.PostVerifyManifestItemsInnerFromJSON)),
+        'resources': json['resources'] == null ? undefined : (json['resources'].map(PostVerifyManifestResourcesInner_1.PostVerifyManifestResourcesInnerFromJSON)),
+        'entryPoints': json['entry_points'] == null ? undefined : json['entry_points'],
+    };
+}
+function PostVerifyManifestToJSON(json) {
+    return PostVerifyManifestToJSONTyped(json, false);
+}
+function PostVerifyManifestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'valid': value['valid'],
+        'errors': value['errors'],
+        'warnings': value['warnings'],
+        'scorm_version': value['scormVersion'],
+        'identifier': value['identifier'],
+        'version': value['version'],
+        'title': value['title'],
+        'schema': value['schema'],
+        'schema_version': value['schemaVersion'],
+        'default_organization': value['defaultOrganization'],
+        'items': value['items'] == null ? undefined : (value['items'].map(PostVerifyManifestItemsInner_1.PostVerifyManifestItemsInnerToJSON)),
+        'resources': value['resources'] == null ? undefined : (value['resources'].map(PostVerifyManifestResourcesInner_1.PostVerifyManifestResourcesInnerToJSON)),
+        'entry_points': value['entryPoints'],
+    };
+}

package/dist/models/PostVerifyManifestItemsInner.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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
+ * @interface PostVerifyManifestItemsInner
+ */
+export interface PostVerifyManifestItemsInner {
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    identifier?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    identifierRef?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    masteryScore?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    maxTimeAllowed?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    timeLimitAction?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    dataFromLms?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestItemsInner
+     */
+    minNormalizedMeasure?: string | null;
+}
+/**
+ * Check if a given object implements the PostVerifyManifestItemsInner interface.
+ */
+export declare function instanceOfPostVerifyManifestItemsInner(value: object): value is PostVerifyManifestItemsInner;
+export declare function PostVerifyManifestItemsInnerFromJSON(json: any): PostVerifyManifestItemsInner;
+export declare function PostVerifyManifestItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostVerifyManifestItemsInner;
+export declare function PostVerifyManifestItemsInnerToJSON(json: any): PostVerifyManifestItemsInner;
+export declare function PostVerifyManifestItemsInnerToJSONTyped(value?: PostVerifyManifestItemsInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostVerifyManifestItemsInner.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostVerifyManifestItemsInner = instanceOfPostVerifyManifestItemsInner;
+exports.PostVerifyManifestItemsInnerFromJSON = PostVerifyManifestItemsInnerFromJSON;
+exports.PostVerifyManifestItemsInnerFromJSONTyped = PostVerifyManifestItemsInnerFromJSONTyped;
+exports.PostVerifyManifestItemsInnerToJSON = PostVerifyManifestItemsInnerToJSON;
+exports.PostVerifyManifestItemsInnerToJSONTyped = PostVerifyManifestItemsInnerToJSONTyped;
+/**
+ * Check if a given object implements the PostVerifyManifestItemsInner interface.
+ */
+function instanceOfPostVerifyManifestItemsInner(value) {
+    return true;
+}
+function PostVerifyManifestItemsInnerFromJSON(json) {
+    return PostVerifyManifestItemsInnerFromJSONTyped(json, false);
+}
+function PostVerifyManifestItemsInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'identifier': json['identifier'] == null ? undefined : json['identifier'],
+        'identifierRef': json['identifier_ref'] == null ? undefined : json['identifier_ref'],
+        'title': json['title'] == null ? undefined : json['title'],
+        'masteryScore': json['mastery_score'] == null ? undefined : json['mastery_score'],
+        'maxTimeAllowed': json['max_time_allowed'] == null ? undefined : json['max_time_allowed'],
+        'timeLimitAction': json['time_limit_action'] == null ? undefined : json['time_limit_action'],
+        'dataFromLms': json['data_from_lms'] == null ? undefined : json['data_from_lms'],
+        'minNormalizedMeasure': json['min_normalized_measure'] == null ? undefined : json['min_normalized_measure'],
+    };
+}
+function PostVerifyManifestItemsInnerToJSON(json) {
+    return PostVerifyManifestItemsInnerToJSONTyped(json, false);
+}
+function PostVerifyManifestItemsInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'identifier': value['identifier'],
+        'identifier_ref': value['identifierRef'],
+        'title': value['title'],
+        'mastery_score': value['masteryScore'],
+        'max_time_allowed': value['maxTimeAllowed'],
+        'time_limit_action': value['timeLimitAction'],
+        'data_from_lms': value['dataFromLms'],
+        'min_normalized_measure': value['minNormalizedMeasure'],
+    };
+}

package/dist/models/PostVerifyManifestResourcesInner.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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
+ * @interface PostVerifyManifestResourcesInner
+ */
+export interface PostVerifyManifestResourcesInner {
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestResourcesInner
+     */
+    identifier?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestResourcesInner
+     */
+    resourceType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestResourcesInner
+     */
+    scormType?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostVerifyManifestResourcesInner
+     */
+    href?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof PostVerifyManifestResourcesInner
+     */
+    files?: Array<string>;
+}
+/**
+ * Check if a given object implements the PostVerifyManifestResourcesInner interface.
+ */
+export declare function instanceOfPostVerifyManifestResourcesInner(value: object): value is PostVerifyManifestResourcesInner;
+export declare function PostVerifyManifestResourcesInnerFromJSON(json: any): PostVerifyManifestResourcesInner;
+export declare function PostVerifyManifestResourcesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostVerifyManifestResourcesInner;
+export declare function PostVerifyManifestResourcesInnerToJSON(json: any): PostVerifyManifestResourcesInner;
+export declare function PostVerifyManifestResourcesInnerToJSONTyped(value?: PostVerifyManifestResourcesInner | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostVerifyManifestResourcesInner.js

@@ -0,0 +1,56 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostVerifyManifestResourcesInner = instanceOfPostVerifyManifestResourcesInner;
+exports.PostVerifyManifestResourcesInnerFromJSON = PostVerifyManifestResourcesInnerFromJSON;
+exports.PostVerifyManifestResourcesInnerFromJSONTyped = PostVerifyManifestResourcesInnerFromJSONTyped;
+exports.PostVerifyManifestResourcesInnerToJSON = PostVerifyManifestResourcesInnerToJSON;
+exports.PostVerifyManifestResourcesInnerToJSONTyped = PostVerifyManifestResourcesInnerToJSONTyped;
+/**
+ * Check if a given object implements the PostVerifyManifestResourcesInner interface.
+ */
+function instanceOfPostVerifyManifestResourcesInner(value) {
+    return true;
+}
+function PostVerifyManifestResourcesInnerFromJSON(json) {
+    return PostVerifyManifestResourcesInnerFromJSONTyped(json, false);
+}
+function PostVerifyManifestResourcesInnerFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'identifier': json['identifier'] == null ? undefined : json['identifier'],
+        'resourceType': json['resource_type'] == null ? undefined : json['resource_type'],
+        'scormType': json['scorm_type'] == null ? undefined : json['scorm_type'],
+        'href': json['href'] == null ? undefined : json['href'],
+        'files': json['files'] == null ? undefined : json['files'],
+    };
+}
+function PostVerifyManifestResourcesInnerToJSON(json) {
+    return PostVerifyManifestResourcesInnerToJSONTyped(json, false);
+}
+function PostVerifyManifestResourcesInnerToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'identifier': value['identifier'],
+        'resource_type': value['resourceType'],
+        'scorm_type': value['scormType'],
+        'href': value['href'],
+        'files': value['files'],
+    };
+}

package/dist/models/index.d.ts

@@ -155,6 +155,7 @@ export * from './GetResourceUsageCoursesInner';
 export * from './GetResourceVersionUpload';
 export * from './GetRichTextAssetUpload';
 export * from './GetRole';
+export * from './GetSignupSlugAvailability';
 export * from './GetSupportTicket';
 export * from './GetSupportTicketAttachment';
 export * from './GetSupportTicketComment';
@@ -287,6 +288,9 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './PostVerifyManifest';
+export * from './PostVerifyManifestItemsInner';
+export * from './PostVerifyManifestResourcesInner';
 export * from './PostZapierEnrollment';
 export * from './PostZapierSetup';
 export * from './PostZapierSetupResponse';

package/dist/models/index.js

@@ -173,6 +173,7 @@ __exportStar(require("./GetResourceUsageCoursesInner"), exports);
 __exportStar(require("./GetResourceVersionUpload"), exports);
 __exportStar(require("./GetRichTextAssetUpload"), exports);
 __exportStar(require("./GetRole"), exports);
+__exportStar(require("./GetSignupSlugAvailability"), exports);
 __exportStar(require("./GetSupportTicket"), exports);
 __exportStar(require("./GetSupportTicketAttachment"), exports);
 __exportStar(require("./GetSupportTicketComment"), exports);
@@ -305,6 +306,9 @@ __exportStar(require("./PostSignupRequest"), exports);
 __exportStar(require("./PostSignupRequestResponse"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
 __exportStar(require("./PostSupportTicketComment"), exports);
+__exportStar(require("./PostVerifyManifest"), exports);
+__exportStar(require("./PostVerifyManifestItemsInner"), exports);
+__exportStar(require("./PostVerifyManifestResourcesInner"), exports);
 __exportStar(require("./PostZapierEnrollment"), exports);
 __exportStar(require("./PostZapierSetup"), exports);
 __exportStar(require("./PostZapierSetupResponse"), exports);

package/docs/GetSignupSlugAvailability.md

@@ -0,0 +1,36 @@
+
+# GetSignupSlugAvailability
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`slug` | string
+`available` | boolean
+
+## Example
+
+```typescript
+import type { GetSignupSlugAvailability } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "slug": null,
+  "available": null,
+} satisfies GetSignupSlugAvailability
+
+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 GetSignupSlugAvailability
+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/PostSignupRequest.md

@@ -11,6 +11,7 @@ Name | Type
 `email` | string
 `password` | string
 `organization` | string
+`slug` | string
 `jobRole` | string
 `learnerCount` | number
 
@@ -26,6 +27,7 @@ const example = {
   "email": null,
   "password": null,
   "organization": null,
+  "slug": null,
   "jobRole": null,
   "learnerCount": null,
 } satisfies PostSignupRequest

package/docs/PostVerifyManifest.md

@@ -0,0 +1,59 @@
+
+# PostVerifyManifest
+
+Response from parsing and verifying a SCORM manifest
+
+## Properties
+
+Name | Type
+------------ | -------------
+`valid` | boolean
+`errors` | Array<string>
+`warnings` | Array<string>
+`scormVersion` | string
+`identifier` | string
+`version` | string
+`title` | string
+`schema` | string
+`schemaVersion` | string
+`defaultOrganization` | string
+`items` | [Array<PostVerifyManifestItemsInner>](PostVerifyManifestItemsInner.md)
+`resources` | [Array<PostVerifyManifestResourcesInner>](PostVerifyManifestResourcesInner.md)
+`entryPoints` | Array<string>
+
+## Example
+
+```typescript
+import type { PostVerifyManifest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "valid": null,
+  "errors": null,
+  "warnings": null,
+  "scormVersion": null,
+  "identifier": null,
+  "version": null,
+  "title": null,
+  "schema": null,
+  "schemaVersion": null,
+  "defaultOrganization": null,
+  "items": null,
+  "resources": null,
+  "entryPoints": null,
+} satisfies PostVerifyManifest
+
+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 PostVerifyManifest
+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/PostVerifyManifestItemsInner.md

@@ -0,0 +1,48 @@
+
+# PostVerifyManifestItemsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identifier` | string
+`identifierRef` | string
+`title` | string
+`masteryScore` | string
+`maxTimeAllowed` | string
+`timeLimitAction` | string
+`dataFromLms` | string
+`minNormalizedMeasure` | string
+
+## Example
+
+```typescript
+import type { PostVerifyManifestItemsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identifier": null,
+  "identifierRef": null,
+  "title": null,
+  "masteryScore": null,
+  "maxTimeAllowed": null,
+  "timeLimitAction": null,
+  "dataFromLms": null,
+  "minNormalizedMeasure": null,
+} satisfies PostVerifyManifestItemsInner
+
+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 PostVerifyManifestItemsInner
+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/PostVerifyManifestResourcesInner.md

@@ -0,0 +1,42 @@
+
+# PostVerifyManifestResourcesInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identifier` | string
+`resourceType` | string
+`scormType` | string
+`href` | string
+`files` | Array<string>
+
+## Example
+
+```typescript
+import type { PostVerifyManifestResourcesInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identifier": null,
+  "resourceType": null,
+  "scormType": null,
+  "href": null,
+  "files": null,
+} satisfies PostVerifyManifestResourcesInner
+
+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 PostVerifyManifestResourcesInner
+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/ScormToolsApi.md

@@ -0,0 +1,78 @@
+# ScormToolsApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**verifyScormManifest**](ScormToolsApi.md#verifyscormmanifest) | **POST** /scorm/tools/verify-manifest | Parse and verify a SCORM manifest |
+
+
+
+## verifyScormManifest
+
+> PostVerifyManifest verifyScormManifest(body)
+
+Parse and verify a SCORM manifest
+
+Public endpoint that takes raw imsmanifest.xml content and returns only parsed values derived from the submitted manifest, plus validation warnings. Request body is limited to 1 MiB.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ScormToolsApi,
+} from '@easyedu/js-lsm-api';
+import type { VerifyScormManifestRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ScormToolsApi();
+
+  const body = {
+    // string
+    body: body_example,
+  } satisfies VerifyScormManifestRequest;
+
+  try {
+    const data = await api.verifyScormManifest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **body** | `string` |  | |
+
+### Return type
+
+[**PostVerifyManifest**](PostVerifyManifest.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/xml`, `text/xml`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Manifest parsed (check valid field for success) |  -  |
+| **400** | Request body is empty |  -  |
+| **413** | Request body exceeds 1 MiB |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+