@easyedu/js-lsm-api 1.127.0 → 1.129.0

package/docs/UserApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteUserAvatar**](UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo |
 | [**getAuthCheck**](UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in |
 | [**getCurrentUserPermissions**](UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions |
+| [**getSignupSlugAvailability**](UserApi.md#getsignupslugavailability) | **GET** /auth/signup/slug-availability | Check whether a learner subdomain is available |
 | [**getUser**](UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id |
 | [**getUserCourses**](UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user |
 | [**getUserEnrollments**](UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments |
@@ -205,6 +206,72 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getSignupSlugAvailability
+
+> GetSignupSlugAvailability getSignupSlugAvailability(slug)
+
+Check whether a learner subdomain is available
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { GetSignupSlugAvailabilityRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string
+    slug: slug_example,
+  } satisfies GetSignupSlugAvailabilityRequest;
+
+  try {
+    const data = await api.getSignupSlugAvailability(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **slug** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetSignupSlugAvailability**](GetSignupSlugAvailability.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Current availability; does not reserve the address |  -  |
+| **400** | Invalid or reserved subdomain |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getUser
 
 > GetUser getUser(userId)
@@ -621,6 +688,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | signup request accepted |  -  |
 | **400** | signup request validation error |  -  |
+| **409** | Learner subdomain is already in use |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -957,6 +1025,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **303** | signup verified and redirected to portal signin |  -  |
 | **400** | invalid or expired signup verification token |  -  |
+| **409** | Saved learner subdomain was claimed before verification; submit signup again with another address |  -  |
 
 [[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.127.0",
+  "version": "1.129.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/ScormToolsApi.ts

@@ -0,0 +1,80 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type PostVerifyManifest,
+    PostVerifyManifestFromJSON,
+    PostVerifyManifestToJSON,
+} from '../models/PostVerifyManifest';
+
+export interface VerifyScormManifestRequest {
+    body: string;
+}
+
+/**
+ * 
+ */
+export class ScormToolsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for verifyScormManifest without sending the request
+     */
+    async verifyScormManifestRequestOpts(requestParameters: VerifyScormManifestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError(
+                'body',
+                'Required parameter "body" was null or undefined when calling verifyScormManifest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/xml';
+
+
+        let urlPath = `/scorm/tools/verify-manifest`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'] as any,
+        };
+    }
+
+    /**
+     * 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.
+     * Parse and verify a SCORM manifest
+     */
+    async verifyScormManifestRaw(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostVerifyManifest>> {
+        const requestOptions = await this.verifyScormManifestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostVerifyManifestFromJSON(jsonValue));
+    }
+
+    /**
+     * 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.
+     * Parse and verify a SCORM manifest
+     */
+    async verifyScormManifest(requestParameters: VerifyScormManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostVerifyManifest> {
+        const response = await this.verifyScormManifestRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/UserApi.ts

@@ -18,6 +18,11 @@ import {
     GetCourseEnrollmentListFromJSON,
     GetCourseEnrollmentListToJSON,
 } from '../models/GetCourseEnrollmentList';
+import {
+    type GetSignupSlugAvailability,
+    GetSignupSlugAvailabilityFromJSON,
+    GetSignupSlugAvailabilityToJSON,
+} from '../models/GetSignupSlugAvailability';
 import {
     type GetUser,
     GetUserFromJSON,
@@ -73,6 +78,10 @@ export interface DeleteUserAvatarRequest {
     userId: string;
 }
 
+export interface GetSignupSlugAvailabilityRequest {
+    slug: string;
+}
+
 export interface GetUserRequest {
     userId: string;
 }
@@ -250,6 +259,54 @@ export class UserApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getSignupSlugAvailability without sending the request
+     */
+    async getSignupSlugAvailabilityRequestOpts(requestParameters: GetSignupSlugAvailabilityRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['slug'] == null) {
+            throw new runtime.RequiredError(
+                'slug',
+                'Required parameter "slug" was null or undefined when calling getSignupSlugAvailability().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['slug'] != null) {
+            queryParameters['slug'] = requestParameters['slug'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/auth/signup/slug-availability`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Check whether a learner subdomain is available
+     */
+    async getSignupSlugAvailabilityRaw(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSignupSlugAvailability>> {
+        const requestOptions = await this.getSignupSlugAvailabilityRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSignupSlugAvailabilityFromJSON(jsonValue));
+    }
+
+    /**
+     * Check whether a learner subdomain is available
+     */
+    async getSignupSlugAvailability(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSignupSlugAvailability> {
+        const response = await this.getSignupSlugAvailabilityRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getUser without sending the request
      */

package/src/apis/index.ts

@@ -22,6 +22,7 @@ export * from './QuestionImportApi';
 export * from './ReportingApi';
 export * from './RichTextApi';
 export * from './RoleApi';
+export * from './ScormToolsApi';
 export * from './SupportTicketApi';
 export * from './SystemApi';
 export * from './UserApi';

package/src/models/GetSignupSlugAvailability.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface GetSignupSlugAvailability
+ */
+export interface GetSignupSlugAvailability {
+    /**
+     * Normalized subdomain checked.
+     * @type {string}
+     * @memberof GetSignupSlugAvailability
+     */
+    slug: string;
+    /**
+     * Whether the subdomain is currently unused. This check does not reserve it.
+     * @type {boolean}
+     * @memberof GetSignupSlugAvailability
+     */
+    available: boolean;
+}
+
+/**
+ * Check if a given object implements the GetSignupSlugAvailability interface.
+ */
+export function instanceOfGetSignupSlugAvailability(value: object): value is GetSignupSlugAvailability {
+    if (!('slug' in value) || value['slug'] === undefined) return false;
+    if (!('available' in value) || value['available'] === undefined) return false;
+    return true;
+}
+
+export function GetSignupSlugAvailabilityFromJSON(json: any): GetSignupSlugAvailability {
+    return GetSignupSlugAvailabilityFromJSONTyped(json, false);
+}
+
+export function GetSignupSlugAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSignupSlugAvailability {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'slug': json['slug'],
+        'available': json['available'],
+    };
+}
+
+export function GetSignupSlugAvailabilityToJSON(json: any): GetSignupSlugAvailability {
+    return GetSignupSlugAvailabilityToJSONTyped(json, false);
+}
+
+export function GetSignupSlugAvailabilityToJSONTyped(value?: GetSignupSlugAvailability | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'slug': value['slug'],
+        'available': value['available'],
+    };
+}
+

package/src/models/PostSignupRequest.ts

@@ -49,6 +49,12 @@ export interface PostSignupRequest {
      * @memberof PostSignupRequest
      */
     organization: string;
+    /**
+     * Requested learner subdomain, without the domain suffix. Must be available and not reserved. If omitted, it is derived from the organization. Availability does not reserve the address; verification checks again and never substitutes another address.
+     * @type {string}
+     * @memberof PostSignupRequest
+     */
+    slug?: string;
     /**
      * Signup/onboarding role supplied by the user; not an LMS RBAC role.
      * @type {string}
@@ -92,6 +98,7 @@ export function PostSignupRequestFromJSONTyped(json: any, ignoreDiscriminator: b
         'email': json['email'],
         'password': json['password'],
         'organization': json['organization'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
         'jobRole': json['job_role'],
         'learnerCount': json['learner_count'],
     };
@@ -113,6 +120,7 @@ export function PostSignupRequestToJSONTyped(value?: PostSignupRequest | null, i
         'email': value['email'],
         'password': value['password'],
         'organization': value['organization'],
+        'slug': value['slug'],
         'job_role': value['jobRole'],
         'learner_count': value['learnerCount'],
     };

package/src/models/PostVerifyManifest.ts

@@ -0,0 +1,179 @@
+/* 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 { PostVerifyManifestResourcesInner } from './PostVerifyManifestResourcesInner';
+import {
+    PostVerifyManifestResourcesInnerFromJSON,
+    PostVerifyManifestResourcesInnerFromJSONTyped,
+    PostVerifyManifestResourcesInnerToJSON,
+    PostVerifyManifestResourcesInnerToJSONTyped,
+} from './PostVerifyManifestResourcesInner';
+import type { PostVerifyManifestItemsInner } from './PostVerifyManifestItemsInner';
+import {
+    PostVerifyManifestItemsInnerFromJSON,
+    PostVerifyManifestItemsInnerFromJSONTyped,
+    PostVerifyManifestItemsInnerToJSON,
+    PostVerifyManifestItemsInnerToJSONTyped,
+} from './PostVerifyManifestItemsInner';
+
+/**
+ * Response from parsing and verifying a SCORM manifest
+ * @export
+ * @interface PostVerifyManifest
+ */
+export interface PostVerifyManifest {
+    /**
+     * Whether the manifest parsed successfully
+     * @type {boolean}
+     * @memberof PostVerifyManifest
+     */
+    valid: boolean;
+    /**
+     * Parse errors that prevented successful parsing
+     * @type {Array<string>}
+     * @memberof PostVerifyManifest
+     */
+    errors: Array<string>;
+    /**
+     * Non-fatal issues or potential problems detected
+     * @type {Array<string>}
+     * @memberof PostVerifyManifest
+     */
+    warnings: Array<string>;
+    /**
+     * Detected SCORM version (e.g., "1.2", "2004 4th Edition")
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    scormVersion?: string | null;
+    /**
+     * Manifest identifier attribute
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    identifier?: string | null;
+    /**
+     * Manifest version attribute
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    version?: string | null;
+    /**
+     * Organization title (course title)
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    title?: string | null;
+    /**
+     * Metadata schema (e.g., "ADL SCORM")
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    schema?: string | null;
+    /**
+     * Metadata schema version
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    schemaVersion?: string | null;
+    /**
+     * Default organization identifier
+     * @type {string}
+     * @memberof PostVerifyManifest
+     */
+    defaultOrganization?: string | null;
+    /**
+     * List of items (SCOs) from the organization
+     * @type {Array<PostVerifyManifestItemsInner>}
+     * @memberof PostVerifyManifest
+     */
+    items?: Array<PostVerifyManifestItemsInner>;
+    /**
+     * List of resources from the manifest
+     * @type {Array<PostVerifyManifestResourcesInner>}
+     * @memberof PostVerifyManifest
+     */
+    resources?: Array<PostVerifyManifestResourcesInner>;
+    /**
+     * List of SCO entry point URLs
+     * @type {Array<string>}
+     * @memberof PostVerifyManifest
+     */
+    entryPoints?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the PostVerifyManifest interface.
+ */
+export function instanceOfPostVerifyManifest(value: object): value is PostVerifyManifest {
+    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;
+}
+
+export function PostVerifyManifestFromJSON(json: any): PostVerifyManifest {
+    return PostVerifyManifestFromJSONTyped(json, false);
+}
+
+export function PostVerifyManifestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostVerifyManifest {
+    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'] as Array<any>).map(PostVerifyManifestItemsInnerFromJSON)),
+        'resources': json['resources'] == null ? undefined : ((json['resources'] as Array<any>).map(PostVerifyManifestResourcesInnerFromJSON)),
+        'entryPoints': json['entry_points'] == null ? undefined : json['entry_points'],
+    };
+}
+
+export function PostVerifyManifestToJSON(json: any): PostVerifyManifest {
+    return PostVerifyManifestToJSONTyped(json, false);
+}
+
+export function PostVerifyManifestToJSONTyped(value?: PostVerifyManifest | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(PostVerifyManifestItemsInnerToJSON)),
+        'resources': value['resources'] == null ? undefined : ((value['resources'] as Array<any>).map(PostVerifyManifestResourcesInnerToJSON)),
+        'entry_points': value['entryPoints'],
+    };
+}
+

package/src/models/PostVerifyManifestItemsInner.ts

@@ -0,0 +1,121 @@
+/* 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';
+/**
+ * 
+ * @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 function instanceOfPostVerifyManifestItemsInner(value: object): value is PostVerifyManifestItemsInner {
+    return true;
+}
+
+export function PostVerifyManifestItemsInnerFromJSON(json: any): PostVerifyManifestItemsInner {
+    return PostVerifyManifestItemsInnerFromJSONTyped(json, false);
+}
+
+export function PostVerifyManifestItemsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostVerifyManifestItemsInner {
+    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'],
+    };
+}
+
+export function PostVerifyManifestItemsInnerToJSON(json: any): PostVerifyManifestItemsInner {
+    return PostVerifyManifestItemsInnerToJSONTyped(json, false);
+}
+
+export function PostVerifyManifestItemsInnerToJSONTyped(value?: PostVerifyManifestItemsInner | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+    };
+}
+