@easyedu/js-lsm-api 1.129.0 → 1.131.0

package/docs/GetReportCatalog.md

@@ -0,0 +1,37 @@
+
+# GetReportCatalog
+
+Reports the caller may run in the selected portal.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`categories` | [Array<ReportCategory>](ReportCategory.md)
+`reports` | [Array<ReportDefinition>](ReportDefinition.md)
+
+## Example
+
+```typescript
+import type { GetReportCatalog } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "categories": null,
+  "reports": null,
+} satisfies GetReportCatalog
+
+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 GetReportCatalog
+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/GetReportQueryResult.md

@@ -0,0 +1,50 @@
+
+# GetReportQueryResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reportKey` | string
+`columns` | [Array<ReportColumn>](ReportColumn.md)
+`rows` | Array<{ [key: string]: any; }>
+`sort` | [ReportSort](ReportSort.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+`generatedAt` | number
+
+## Example
+
+```typescript
+import type { GetReportQueryResult } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reportKey": null,
+  "columns": null,
+  "rows": null,
+  "sort": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+  "generatedAt": null,
+} satisfies GetReportQueryResult
+
+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 GetReportQueryResult
+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/PostReportExport.md

@@ -0,0 +1,38 @@
+
+# PostReportExport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filters` | [ReportFilters](ReportFilters.md)
+`sort` | [ReportSort](ReportSort.md)
+`format` | string
+
+## Example
+
+```typescript
+import type { PostReportExport } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filters": null,
+  "sort": null,
+  "format": null,
+} satisfies PostReportExport
+
+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 PostReportExport
+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/PostReportQuery.md

@@ -0,0 +1,40 @@
+
+# PostReportQuery
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filters` | [ReportFilters](ReportFilters.md)
+`sort` | [ReportSort](ReportSort.md)
+`page` | number
+`pageSize` | number
+
+## Example
+
+```typescript
+import type { PostReportQuery } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filters": null,
+  "sort": null,
+  "page": null,
+  "pageSize": null,
+} satisfies PostReportQuery
+
+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 PostReportQuery
+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/ReportCategory.md

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

@@ -0,0 +1,39 @@
+
+# ReportColumn
+
+One column in a report result. Row objects are keyed by column key.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`label` | string
+`type` | string
+
+## Example
+
+```typescript
+import type { ReportColumn } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "label": null,
+  "type": null,
+} satisfies ReportColumn
+
+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 ReportColumn
+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/ReportDefinition.md

@@ -0,0 +1,48 @@
+
+# ReportDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`title` | string
+`description` | string
+`category` | string
+`permission` | string
+`columns` | [Array<ReportColumn>](ReportColumn.md)
+`filters` | [Array<ReportFilterDefinition>](ReportFilterDefinition.md)
+`defaultSort` | [ReportSort](ReportSort.md)
+
+## Example
+
+```typescript
+import type { ReportDefinition } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "title": null,
+  "description": null,
+  "category": null,
+  "permission": null,
+  "columns": null,
+  "filters": null,
+  "defaultSort": null,
+} satisfies ReportDefinition
+
+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 ReportDefinition
+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/ReportFilterDefinition.md

@@ -0,0 +1,45 @@
+
+# ReportFilterDefinition
+
+A filter accepted by a report. The key names the matching property in ReportFilters; a date_range filter maps to date_from and date_to. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`label` | string
+`type` | string
+`options` | [Array<ReportFilterOption>](ReportFilterOption.md)
+`defaultDays` | number
+`defaultValue` | number
+
+## Example
+
+```typescript
+import type { ReportFilterDefinition } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "label": null,
+  "type": null,
+  "options": null,
+  "defaultDays": null,
+  "defaultValue": null,
+} satisfies ReportFilterDefinition
+
+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 ReportFilterDefinition
+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/ReportFilterOption.md

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

@@ -0,0 +1,59 @@
+
+# ReportFilters
+
+Report filters. Only filters listed in the report definition may be supplied; any other non-null filter is rejected with HTTP 400. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`userType` | string
+`company` | string
+`status` | string
+`teamPortalId` | string
+`courseId` | string
+`tagId` | string
+`managerId` | string
+`dateFrom` | Date
+`dateTo` | Date
+`inactiveDays` | number
+`expiresWithinDays` | number
+`firstCourseStarted` | string
+
+## Example
+
+```typescript
+import type { ReportFilters } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "userType": null,
+  "company": null,
+  "status": null,
+  "teamPortalId": null,
+  "courseId": null,
+  "tagId": null,
+  "managerId": null,
+  "dateFrom": null,
+  "dateTo": null,
+  "inactiveDays": null,
+  "expiresWithinDays": null,
+  "firstCourseStarted": null,
+} satisfies ReportFilters
+
+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 ReportFilters
+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/ReportSort.md

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