@easyedu/js-lsm-api 1.128.0 → 1.129.0

package/.openapi-generator/FILES

@@ -170,6 +170,7 @@ docs/GetResourceUsageCoursesInner.md
 docs/GetResourceVersionUpload.md
 docs/GetRichTextAssetUpload.md
 docs/GetRole.md
+docs/GetSignupSlugAvailability.md
 docs/GetSupportTicket.md
 docs/GetSupportTicketAttachment.md
 docs/GetSupportTicketComment.md
@@ -587,6 +588,7 @@ src/models/GetResourceUsageCoursesInner.ts
 src/models/GetResourceVersionUpload.ts
 src/models/GetRichTextAssetUpload.ts
 src/models/GetRole.ts
+src/models/GetSignupSlugAvailability.ts
 src/models/GetSupportTicket.ts
 src/models/GetSupportTicketAttachment.ts
 src/models/GetSupportTicketComment.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.128.0
+# @easyedu/js-lsm-api@1.129.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -398,6 +398,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *UserApi* | [**deleteUserAvatar**](docs/UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo
 *UserApi* | [**getAuthCheck**](docs/UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in
 *UserApi* | [**getCurrentUserPermissions**](docs/UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions
+*UserApi* | [**getSignupSlugAvailability**](docs/UserApi.md#getsignupslugavailability) | **GET** /auth/signup/slug-availability | Check whether a learner subdomain is available
 *UserApi* | [**getUser**](docs/UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id
 *UserApi* | [**getUserCourses**](docs/UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user
 *UserApi* | [**getUserEnrollments**](docs/UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments
@@ -570,6 +571,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetResourceVersionUpload](docs/GetResourceVersionUpload.md)
 - [GetRichTextAssetUpload](docs/GetRichTextAssetUpload.md)
 - [GetRole](docs/GetRole.md)
+- [GetSignupSlugAvailability](docs/GetSignupSlugAvailability.md)
 - [GetSupportTicket](docs/GetSupportTicket.md)
 - [GetSupportTicketAttachment](docs/GetSupportTicketAttachment.md)
 - [GetSupportTicketComment](docs/GetSupportTicketComment.md)
@@ -799,7 +801,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.128.0`
+- Package version: `1.129.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/UserApi.d.ts

@@ -11,6 +11,7 @@
  */
 import * as runtime from '../runtime';
 import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
+import { type GetSignupSlugAvailability } from '../models/GetSignupSlugAvailability';
 import { type GetUser } from '../models/GetUser';
 import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
 import { type GetUserCourseList } from '../models/GetUserCourseList';
@@ -24,6 +25,9 @@ import { type PutUser } from '../models/PutUser';
 export interface DeleteUserAvatarRequest {
     userId: string;
 }
+export interface GetSignupSlugAvailabilityRequest {
+    slug: string;
+}
 export interface GetUserRequest {
     userId: string;
 }
@@ -109,6 +113,18 @@ export declare class UserApi extends runtime.BaseAPI {
      * Get the current user\'s permissions
      */
     getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Creates request options for getSignupSlugAvailability without sending the request
+     */
+    getSignupSlugAvailabilityRequestOpts(requestParameters: GetSignupSlugAvailabilityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailabilityRaw(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSignupSlugAvailability>>;
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailability(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSignupSlugAvailability>;
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/apis/UserApi.js

@@ -25,6 +25,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetUserEnrollmentsTypeEnum = exports.GetUserCoursesOrderDirectionEnum = exports.GetUserCoursesOrderByEnum = exports.UserApi = void 0;
 const runtime = require("../runtime");
 const GetCourseEnrollmentList_1 = require("../models/GetCourseEnrollmentList");
+const GetSignupSlugAvailability_1 = require("../models/GetSignupSlugAvailability");
 const GetUser_1 = require("../models/GetUser");
 const GetUserAvatarUpload_1 = require("../models/GetUserAvatarUpload");
 const GetUserCourseList_1 = require("../models/GetUserCourseList");
@@ -148,6 +149,47 @@ class UserApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getSignupSlugAvailability without sending the request
+     */
+    getSignupSlugAvailabilityRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getSignupSlugAvailability().');
+            }
+            const queryParameters = {};
+            if (requestParameters['slug'] != null) {
+                queryParameters['slug'] = requestParameters['slug'];
+            }
+            const headerParameters = {};
+            let urlPath = `/auth/signup/slug-availability`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailabilityRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSignupSlugAvailabilityRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetSignupSlugAvailability_1.GetSignupSlugAvailabilityFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailability(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSignupSlugAvailabilityRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/esm/apis/UserApi.d.ts

@@ -11,6 +11,7 @@
  */
 import * as runtime from '../runtime';
 import { type GetCourseEnrollmentList } from '../models/GetCourseEnrollmentList';
+import { type GetSignupSlugAvailability } from '../models/GetSignupSlugAvailability';
 import { type GetUser } from '../models/GetUser';
 import { type GetUserAvatarUpload } from '../models/GetUserAvatarUpload';
 import { type GetUserCourseList } from '../models/GetUserCourseList';
@@ -24,6 +25,9 @@ import { type PutUser } from '../models/PutUser';
 export interface DeleteUserAvatarRequest {
     userId: string;
 }
+export interface GetSignupSlugAvailabilityRequest {
+    slug: string;
+}
 export interface GetUserRequest {
     userId: string;
 }
@@ -109,6 +113,18 @@ export declare class UserApi extends runtime.BaseAPI {
      * Get the current user\'s permissions
      */
     getCurrentUserPermissions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Creates request options for getSignupSlugAvailability without sending the request
+     */
+    getSignupSlugAvailabilityRequestOpts(requestParameters: GetSignupSlugAvailabilityRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailabilityRaw(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSignupSlugAvailability>>;
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailability(requestParameters: GetSignupSlugAvailabilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSignupSlugAvailability>;
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/esm/apis/UserApi.js

@@ -22,6 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import * as runtime from '../runtime';
 import { GetCourseEnrollmentListFromJSON, } from '../models/GetCourseEnrollmentList';
+import { GetSignupSlugAvailabilityFromJSON, } from '../models/GetSignupSlugAvailability';
 import { GetUserFromJSON, } from '../models/GetUser';
 import { GetUserAvatarUploadFromJSON, } from '../models/GetUserAvatarUpload';
 import { GetUserCourseListFromJSON, } from '../models/GetUserCourseList';
@@ -145,6 +146,47 @@ export class UserApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getSignupSlugAvailability without sending the request
+     */
+    getSignupSlugAvailabilityRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['slug'] == null) {
+                throw new runtime.RequiredError('slug', 'Required parameter "slug" was null or undefined when calling getSignupSlugAvailability().');
+            }
+            const queryParameters = {};
+            if (requestParameters['slug'] != null) {
+                queryParameters['slug'] = requestParameters['slug'];
+            }
+            const headerParameters = {};
+            let urlPath = `/auth/signup/slug-availability`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailabilityRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSignupSlugAvailabilityRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetSignupSlugAvailabilityFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Check whether a learner subdomain is available
+     */
+    getSignupSlugAvailability(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getSignupSlugAvailabilityRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getUser without sending the request
      */

package/dist/esm/models/GetSignupSlugAvailability.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 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 declare function instanceOfGetSignupSlugAvailability(value: object): value is GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityFromJSON(json: any): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityToJSON(json: any): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityToJSONTyped(value?: GetSignupSlugAvailability | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetSignupSlugAvailability.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the GetSignupSlugAvailability interface.
+ */
+export function instanceOfGetSignupSlugAvailability(value) {
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('available' in value) || value['available'] === undefined)
+        return false;
+    return true;
+}
+export function GetSignupSlugAvailabilityFromJSON(json) {
+    return GetSignupSlugAvailabilityFromJSONTyped(json, false);
+}
+export function GetSignupSlugAvailabilityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'slug': json['slug'],
+        'available': json['available'],
+    };
+}
+export function GetSignupSlugAvailabilityToJSON(json) {
+    return GetSignupSlugAvailabilityToJSONTyped(json, false);
+}
+export function GetSignupSlugAvailabilityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'slug': value['slug'],
+        'available': value['available'],
+    };
+}

package/dist/esm/models/PostSignupRequest.d.ts

@@ -45,6 +45,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}

package/dist/esm/models/PostSignupRequest.js

@@ -44,6 +44,7 @@ export function PostSignupRequestFromJSONTyped(json, ignoreDiscriminator) {
         'email': json['email'],
         'password': json['password'],
         'organization': json['organization'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
         'jobRole': json['job_role'],
         'learnerCount': json['learner_count'],
     };
@@ -61,6 +62,7 @@ export function PostSignupRequestToJSONTyped(value, ignoreDiscriminator = false)
         'email': value['email'],
         'password': value['password'],
         'organization': value['organization'],
+        'slug': value['slug'],
         'job_role': value['jobRole'],
         'learner_count': value['learnerCount'],
     };

package/dist/esm/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';

package/dist/esm/models/index.js

@@ -157,6 +157,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';

package/dist/models/GetSignupSlugAvailability.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 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 declare function instanceOfGetSignupSlugAvailability(value: object): value is GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityFromJSON(json: any): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityToJSON(json: any): GetSignupSlugAvailability;
+export declare function GetSignupSlugAvailabilityToJSONTyped(value?: GetSignupSlugAvailability | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetSignupSlugAvailability.js

@@ -0,0 +1,54 @@
+"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.instanceOfGetSignupSlugAvailability = instanceOfGetSignupSlugAvailability;
+exports.GetSignupSlugAvailabilityFromJSON = GetSignupSlugAvailabilityFromJSON;
+exports.GetSignupSlugAvailabilityFromJSONTyped = GetSignupSlugAvailabilityFromJSONTyped;
+exports.GetSignupSlugAvailabilityToJSON = GetSignupSlugAvailabilityToJSON;
+exports.GetSignupSlugAvailabilityToJSONTyped = GetSignupSlugAvailabilityToJSONTyped;
+/**
+ * Check if a given object implements the GetSignupSlugAvailability interface.
+ */
+function instanceOfGetSignupSlugAvailability(value) {
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('available' in value) || value['available'] === undefined)
+        return false;
+    return true;
+}
+function GetSignupSlugAvailabilityFromJSON(json) {
+    return GetSignupSlugAvailabilityFromJSONTyped(json, false);
+}
+function GetSignupSlugAvailabilityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'slug': json['slug'],
+        'available': json['available'],
+    };
+}
+function GetSignupSlugAvailabilityToJSON(json) {
+    return GetSignupSlugAvailabilityToJSONTyped(json, false);
+}
+function GetSignupSlugAvailabilityToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'slug': value['slug'],
+        'available': value['available'],
+    };
+}

package/dist/models/PostSignupRequest.d.ts

@@ -45,6 +45,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}

package/dist/models/PostSignupRequest.js

@@ -51,6 +51,7 @@ function PostSignupRequestFromJSONTyped(json, ignoreDiscriminator) {
         'email': json['email'],
         'password': json['password'],
         'organization': json['organization'],
+        'slug': json['slug'] == null ? undefined : json['slug'],
         'jobRole': json['job_role'],
         'learnerCount': json['learner_count'],
     };
@@ -68,6 +69,7 @@ function PostSignupRequestToJSONTyped(value, ignoreDiscriminator = false) {
         'email': value['email'],
         'password': value['password'],
         'organization': value['organization'],
+        'slug': value['slug'],
         'job_role': value['jobRole'],
         'learner_count': value['learnerCount'],
     };

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';

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);

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/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.128.0",
+  "version": "1.129.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

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/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/index.ts

@@ -157,6 +157,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';