@easyedu/js-lsm-api 1.129.0 → 1.130.0

package/dist/models/PostDemoRequest.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 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 PostDemoRequest
+ */
+export interface PostDemoRequest {
+    /**
+     * Stable for retries of the same submission; use a new UUID when details change.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    submissionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    fullName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    email: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    organization: string;
+    /**
+     *
+     * @type {PostDemoRequestLearnerRangeEnum}
+     * @memberof PostDemoRequest
+     */
+    learnerRange?: PostDemoRequestLearnerRangeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    message?: string;
+    /**
+     *
+     * @type {PostDemoRequestInquiryTypeEnum}
+     * @memberof PostDemoRequest
+     */
+    inquiryType?: PostDemoRequestInquiryTypeEnum;
+    /**
+     * Originating site pathname; query strings and fragments are removed.
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourcePath?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequest
+     */
+    sourceCta?: string;
+}
+/**
+ * @export
+ */
+export declare const PostDemoRequestLearnerRangeEnum: {
+    readonly _150: "1-50";
+    readonly _511000: "51-1000";
+    readonly _10013000: "1001-3000";
+    readonly _3001: "3001+";
+};
+export type PostDemoRequestLearnerRangeEnum = typeof PostDemoRequestLearnerRangeEnum[keyof typeof PostDemoRequestLearnerRangeEnum];
+/**
+ * @export
+ */
+export declare const PostDemoRequestInquiryTypeEnum: {
+    readonly Demo: "demo";
+    readonly Enterprise: "enterprise";
+    readonly Migration: "migration";
+    readonly Sales: "sales";
+};
+export type PostDemoRequestInquiryTypeEnum = typeof PostDemoRequestInquiryTypeEnum[keyof typeof PostDemoRequestInquiryTypeEnum];
+/**
+ * Check if a given object implements the PostDemoRequest interface.
+ */
+export declare function instanceOfPostDemoRequest(value: object): value is PostDemoRequest;
+export declare function PostDemoRequestFromJSON(json: any): PostDemoRequest;
+export declare function PostDemoRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequest;
+export declare function PostDemoRequestToJSON(json: any): PostDemoRequest;
+export declare function PostDemoRequestToJSONTyped(value?: PostDemoRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostDemoRequest.js

@@ -0,0 +1,91 @@
+"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.PostDemoRequestInquiryTypeEnum = exports.PostDemoRequestLearnerRangeEnum = void 0;
+exports.instanceOfPostDemoRequest = instanceOfPostDemoRequest;
+exports.PostDemoRequestFromJSON = PostDemoRequestFromJSON;
+exports.PostDemoRequestFromJSONTyped = PostDemoRequestFromJSONTyped;
+exports.PostDemoRequestToJSON = PostDemoRequestToJSON;
+exports.PostDemoRequestToJSONTyped = PostDemoRequestToJSONTyped;
+/**
+ * @export
+ */
+exports.PostDemoRequestLearnerRangeEnum = {
+    _150: '1-50',
+    _511000: '51-1000',
+    _10013000: '1001-3000',
+    _3001: '3001+'
+};
+/**
+ * @export
+ */
+exports.PostDemoRequestInquiryTypeEnum = {
+    Demo: 'demo',
+    Enterprise: 'enterprise',
+    Migration: 'migration',
+    Sales: 'sales'
+};
+/**
+ * Check if a given object implements the PostDemoRequest interface.
+ */
+function instanceOfPostDemoRequest(value) {
+    if (!('submissionId' in value) || value['submissionId'] === undefined)
+        return false;
+    if (!('fullName' in value) || value['fullName'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('organization' in value) || value['organization'] === undefined)
+        return false;
+    return true;
+}
+function PostDemoRequestFromJSON(json) {
+    return PostDemoRequestFromJSONTyped(json, false);
+}
+function PostDemoRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'submissionId': json['submission_id'],
+        'fullName': json['full_name'],
+        'email': json['email'],
+        'organization': json['organization'],
+        'learnerRange': json['learner_range'] == null ? undefined : json['learner_range'],
+        'message': json['message'] == null ? undefined : json['message'],
+        'inquiryType': json['inquiry_type'] == null ? undefined : json['inquiry_type'],
+        'sourcePath': json['source_path'] == null ? undefined : json['source_path'],
+        'sourceCta': json['source_cta'] == null ? undefined : json['source_cta'],
+    };
+}
+function PostDemoRequestToJSON(json) {
+    return PostDemoRequestToJSONTyped(json, false);
+}
+function PostDemoRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'submission_id': value['submissionId'],
+        'full_name': value['fullName'],
+        'email': value['email'],
+        'organization': value['organization'],
+        'learner_range': value['learnerRange'],
+        'message': value['message'],
+        'inquiry_type': value['inquiryType'],
+        'source_path': value['sourcePath'],
+        'source_cta': value['sourceCta'],
+    };
+}

package/dist/models/PostDemoRequestResponse.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 PostDemoRequestResponse
+ */
+export interface PostDemoRequestResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    requestId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostDemoRequestResponse
+     */
+    message: string;
+}
+/**
+ * Check if a given object implements the PostDemoRequestResponse interface.
+ */
+export declare function instanceOfPostDemoRequestResponse(value: object): value is PostDemoRequestResponse;
+export declare function PostDemoRequestResponseFromJSON(json: any): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseToJSON(json: any): PostDemoRequestResponse;
+export declare function PostDemoRequestResponseToJSONTyped(value?: PostDemoRequestResponse | null, ignoreDiscriminator?: boolean): any;

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

@@ -242,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

@@ -260,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.129.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/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';