@easyedu/js-lsm-api 1.128.0 → 1.130.0

package/dist/models/PostDemoRequestResponse.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.instanceOfPostDemoRequestResponse = instanceOfPostDemoRequestResponse;
+exports.PostDemoRequestResponseFromJSON = PostDemoRequestResponseFromJSON;
+exports.PostDemoRequestResponseFromJSONTyped = PostDemoRequestResponseFromJSONTyped;
+exports.PostDemoRequestResponseToJSON = PostDemoRequestResponseToJSON;
+exports.PostDemoRequestResponseToJSONTyped = PostDemoRequestResponseToJSONTyped;
+/**
+ * Check if a given object implements the PostDemoRequestResponse interface.
+ */
+function instanceOfPostDemoRequestResponse(value) {
+    if (!('requestId' in value) || value['requestId'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+function PostDemoRequestResponseFromJSON(json) {
+    return PostDemoRequestResponseFromJSONTyped(json, false);
+}
+function PostDemoRequestResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'requestId': json['request_id'],
+        'message': json['message'],
+    };
+}
+function PostDemoRequestResponseToJSON(json) {
+    return PostDemoRequestResponseToJSONTyped(json, false);
+}
+function PostDemoRequestResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'request_id': value['requestId'],
+        'message': value['message'],
+    };
+}

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';
@@ -241,6 +242,8 @@ export * from './PostCourseVersionPublish';
 export * from './PostCourseVersionSection';
 export * from './PostCourseVersionSectionDuplicate';
 export * from './PostCustomWebhookIntegration';
+export * from './PostDemoRequest';
+export * from './PostDemoRequestResponse';
 export * from './PostDispatchItemLaunch';
 export * from './PostDispatchItemLaunchResponse';
 export * from './PostDispatchLaunch';

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);
@@ -259,6 +260,8 @@ __exportStar(require("./PostCourseVersionPublish"), exports);
 __exportStar(require("./PostCourseVersionSection"), exports);
 __exportStar(require("./PostCourseVersionSectionDuplicate"), exports);
 __exportStar(require("./PostCustomWebhookIntegration"), exports);
+__exportStar(require("./PostDemoRequest"), exports);
+__exportStar(require("./PostDemoRequestResponse"), exports);
 __exportStar(require("./PostDispatchItemLaunch"), exports);
 __exportStar(require("./PostDispatchItemLaunchResponse"), exports);
 __exportStar(require("./PostDispatchLaunch"), 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/MarketingApi.md

@@ -0,0 +1,78 @@
+# MarketingApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**postDemoRequest**](MarketingApi.md#postdemorequest) | **POST** /mktg/demo-requests | Save a demo or sales inquiry and notify sales |
+
+
+
+## postDemoRequest
+
+> PostDemoRequestResponse postDemoRequest(postDemoRequest)
+
+Save a demo or sales inquiry and notify sales
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MarketingApi,
+} from '@easyedu/js-lsm-api';
+import type { PostDemoRequestRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new MarketingApi();
+
+  const body = {
+    // PostDemoRequest
+    postDemoRequest: ...,
+  } satisfies PostDemoRequestRequest;
+
+  try {
+    const data = await api.postDemoRequest(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postDemoRequest** | [PostDemoRequest](PostDemoRequest.md) |  | |
+
+### Return type
+
+[**PostDemoRequestResponse**](PostDemoRequestResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Request saved and sales notification queued; unchanged retries return the same result |  -  |
+| **400** | Invalid request |  -  |
+| **409** | Submission ID already used with different details |  -  |
+| **413** | Request exceeds the 16 KiB body limit |  -  |
+| **500** | Request could not be saved or notification queued; retry with the same submission ID |  -  |
+
+[[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/PostDemoRequest.md

@@ -0,0 +1,50 @@
+
+# PostDemoRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`submissionId` | string
+`fullName` | string
+`email` | string
+`organization` | string
+`learnerRange` | string
+`message` | string
+`inquiryType` | string
+`sourcePath` | string
+`sourceCta` | string
+
+## Example
+
+```typescript
+import type { PostDemoRequest } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "submissionId": null,
+  "fullName": null,
+  "email": null,
+  "organization": null,
+  "learnerRange": null,
+  "message": null,
+  "inquiryType": null,
+  "sourcePath": null,
+  "sourceCta": null,
+} satisfies PostDemoRequest
+
+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 PostDemoRequest
+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/PostDemoRequestResponse.md

@@ -0,0 +1,36 @@
+
+# PostDemoRequestResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`requestId` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { PostDemoRequestResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "requestId": null,
+  "message": null,
+} satisfies PostDemoRequestResponse
+
+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 PostDemoRequestResponse
+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.130.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/MarketingApi.ts

@@ -0,0 +1,83 @@
+/* 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 PostDemoRequest,
+    PostDemoRequestFromJSON,
+    PostDemoRequestToJSON,
+} from '../models/PostDemoRequest';
+import {
+    type PostDemoRequestResponse,
+    PostDemoRequestResponseFromJSON,
+    PostDemoRequestResponseToJSON,
+} from '../models/PostDemoRequestResponse';
+
+export interface PostDemoRequestRequest {
+    postDemoRequest: PostDemoRequest;
+}
+
+/**
+ * 
+ */
+export class MarketingApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for postDemoRequest without sending the request
+     */
+    async postDemoRequestRequestOpts(requestParameters: PostDemoRequestRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['postDemoRequest'] == null) {
+            throw new runtime.RequiredError(
+                'postDemoRequest',
+                'Required parameter "postDemoRequest" was null or undefined when calling postDemoRequest().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/mktg/demo-requests`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostDemoRequestToJSON(requestParameters['postDemoRequest']),
+        };
+    }
+
+    /**
+     * Save a demo or sales inquiry and notify sales
+     */
+    async postDemoRequestRaw(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostDemoRequestResponse>> {
+        const requestOptions = await this.postDemoRequestRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostDemoRequestResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Save a demo or sales inquiry and notify sales
+     */
+    async postDemoRequest(requestParameters: PostDemoRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostDemoRequestResponse> {
+        const response = await this.postDemoRequestRaw(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

@@ -13,6 +13,7 @@ export * from './DispatchApi';
 export * from './EmailTemplateApi';
 export * from './IntegrationApi';
 export * from './LearnerExperienceApi';
+export * from './MarketingApi';
 export * from './OtherApi';
 export * from './PlayerApi';
 export * from './PortalApi';

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'],
+    };
+}
+