@easyedu/js-lsm-api 1.113.0 → 1.115.0

package/dist/models/index.d.ts

@@ -25,6 +25,7 @@ export * from './CertificateRenewalPolicy';
 export * from './CertificateTemplate';
 export * from './CertificateTemplateVersion';
 export * from './ChatDailyUsage';
+export * from './ChatFeatureUsage';
 export * from './ChatModelUsage';
 export * from './ChatQuota';
 export * from './ChatQuotaExceeded';
@@ -158,6 +159,8 @@ export * from './GetUserCourseListItemCourse';
 export * from './GetUserCourseListItemEnrollment';
 export * from './GetUserCourseListItemProgress';
 export * from './GetUserRole';
+export * from './GetZapierMe';
+export * from './GetZapierSetup';
 export * from './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -249,6 +252,8 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './PostZapierSetup';
+export * from './PostZapierSetupResponse';
 export * from './ProgressionGateError';
 export * from './ProgressionLockReason';
 export * from './PutAttemptAllowance';
@@ -286,6 +291,7 @@ export * from './PutRole';
 export * from './PutRolePermissions';
 export * from './PutSupportTicket';
 export * from './PutUser';
+export * from './PutZapierSetup';
 export * from './QuestionImportCommitResult';
 export * from './QuestionImportDraft';
 export * from './QuestionImportDuplicate';
@@ -306,3 +312,4 @@ export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';
+export * from './ZapierIntegration';

package/dist/models/index.js

@@ -43,6 +43,7 @@ __exportStar(require("./CertificateRenewalPolicy"), exports);
 __exportStar(require("./CertificateTemplate"), exports);
 __exportStar(require("./CertificateTemplateVersion"), exports);
 __exportStar(require("./ChatDailyUsage"), exports);
+__exportStar(require("./ChatFeatureUsage"), exports);
 __exportStar(require("./ChatModelUsage"), exports);
 __exportStar(require("./ChatQuota"), exports);
 __exportStar(require("./ChatQuotaExceeded"), exports);
@@ -176,6 +177,8 @@ __exportStar(require("./GetUserCourseListItemCourse"), exports);
 __exportStar(require("./GetUserCourseListItemEnrollment"), exports);
 __exportStar(require("./GetUserCourseListItemProgress"), exports);
 __exportStar(require("./GetUserRole"), exports);
+__exportStar(require("./GetZapierMe"), exports);
+__exportStar(require("./GetZapierSetup"), exports);
 __exportStar(require("./LearnerExperienceVersion"), exports);
 __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
 __exportStar(require("./LibraryQuizCriterion"), exports);
@@ -267,6 +270,8 @@ __exportStar(require("./PostSignupRequest"), exports);
 __exportStar(require("./PostSignupRequestResponse"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
 __exportStar(require("./PostSupportTicketComment"), exports);
+__exportStar(require("./PostZapierSetup"), exports);
+__exportStar(require("./PostZapierSetupResponse"), exports);
 __exportStar(require("./ProgressionGateError"), exports);
 __exportStar(require("./ProgressionLockReason"), exports);
 __exportStar(require("./PutAttemptAllowance"), exports);
@@ -304,6 +309,7 @@ __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
 __exportStar(require("./PutSupportTicket"), exports);
 __exportStar(require("./PutUser"), exports);
+__exportStar(require("./PutZapierSetup"), exports);
 __exportStar(require("./QuestionImportCommitResult"), exports);
 __exportStar(require("./QuestionImportDraft"), exports);
 __exportStar(require("./QuestionImportDuplicate"), exports);
@@ -324,3 +330,4 @@ __exportStar(require("./SupportTicketUser"), exports);
 __exportStar(require("./UpdateSelectedPortalResponse"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseSelectedPortal"), exports);
+__exportStar(require("./ZapierIntegration"), exports);

package/docs/ChatFeatureUsage.md

@@ -0,0 +1,36 @@
+
+# ChatFeatureUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`feature` | string
+`usage` | [ChatUsageTotals](ChatUsageTotals.md)
+
+## Example
+
+```typescript
+import type { ChatFeatureUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "feature": null,
+  "usage": null,
+} satisfies ChatFeatureUsage
+
+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 ChatFeatureUsage
+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/GetChatUsage.md

@@ -11,6 +11,7 @@ Name | Type
 `totals` | [ChatUsageTotals](ChatUsageTotals.md)
 `daily` | [Array<ChatDailyUsage>](ChatDailyUsage.md)
 `modelUsage` | [Array<ChatModelUsage>](ChatModelUsage.md)
+`featureUsage` | [Array<ChatFeatureUsage>](ChatFeatureUsage.md)
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "totals": null,
   "daily": null,
   "modelUsage": null,
+  "featureUsage": null,
 } satisfies GetChatUsage
 
 console.log(example)

package/docs/GetZapierMe.md

@@ -0,0 +1,44 @@
+
+# GetZapierMe
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`integrationId` | string
+`integrationName` | string
+`portalId` | string
+`portalName` | string
+`portalSubdomain` | string
+`permissionKeys` | Array<string>
+
+## Example
+
+```typescript
+import type { GetZapierMe } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "integrationId": null,
+  "integrationName": null,
+  "portalId": null,
+  "portalName": null,
+  "portalSubdomain": null,
+  "permissionKeys": null,
+} satisfies GetZapierMe
+
+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 GetZapierMe
+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/GetZapierSetup.md

@@ -0,0 +1,36 @@
+
+# GetZapierSetup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`availablePermissions` | [Array<GetPermission>](GetPermission.md)
+`integrations` | [Array<ZapierIntegration>](ZapierIntegration.md)
+
+## Example
+
+```typescript
+import type { GetZapierSetup } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "availablePermissions": null,
+  "integrations": null,
+} satisfies GetZapierSetup
+
+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 GetZapierSetup
+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/IntegrationApi.md

@@ -0,0 +1,346 @@
+# IntegrationApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteZapierSetup**](IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key |
+| [**getZapierMe**](IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions |
+| [**getZapierSetup**](IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal |
+| [**postZapierSetup**](IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal |
+| [**putZapierSetup**](IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions |
+
+
+
+## deleteZapierSetup
+
+> deleteZapierSetup(zapierIntegrationId)
+
+Revoke a Zapier connection and its API key
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteZapierSetupRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    zapierIntegrationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteZapierSetupRequest;
+
+  try {
+    const data = await api.deleteZapierSetup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zapierIntegrationId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Zapier connection revoked |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Zapier connection not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getZapierMe
+
+> GetZapierMe getZapierMe(xAPIKEY, xPORTALSUBDOMAIN)
+
+Test a Zapier API key and return its portal and enabled permissions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetZapierMeRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    xAPIKEY: xAPIKEY_example,
+    // string
+    xPORTALSUBDOMAIN: xPORTALSUBDOMAIN_example,
+  } satisfies GetZapierMeRequest;
+
+  try {
+    const data = await api.getZapierMe(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xAPIKEY** | `string` |  | [Defaults to `undefined`] |
+| **xPORTALSUBDOMAIN** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetZapierMe**](GetZapierMe.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Connected Zapier account details |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | API key does not belong to the supplied portal subdomain |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getZapierSetup
+
+> GetZapierSetup getZapierSetup()
+
+List Zapier connections and permissions available to the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetZapierSetupRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  try {
+    const data = await api.getZapierSetup();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetZapierSetup**](GetZapierSetup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zapier setup details |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postZapierSetup
+
+> PostZapierSetupResponse postZapierSetup(postZapierSetup)
+
+Create a Zapier connection and API key for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierSetupRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // PostZapierSetup
+    postZapierSetup: ...,
+  } satisfies PostZapierSetupRequest;
+
+  try {
+    const data = await api.postZapierSetup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postZapierSetup** | [PostZapierSetup](PostZapierSetup.md) |  | |
+
+### Return type
+
+[**PostZapierSetupResponse**](PostZapierSetupResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Zapier connection created; the API key is returned only once |  -  |
+| **400** | Invalid name or permission selection |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putZapierSetup
+
+> ZapierIntegration putZapierSetup(zapierIntegrationId, putZapierSetup)
+
+Update a Zapier connection\'s name or permissions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PutZapierSetupRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    zapierIntegrationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PutZapierSetup
+    putZapierSetup: ...,
+  } satisfies PutZapierSetupRequest;
+
+  try {
+    const data = await api.putZapierSetup(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **zapierIntegrationId** | `string` |  | [Defaults to `undefined`] |
+| **putZapierSetup** | [PutZapierSetup](PutZapierSetup.md) |  | |
+
+### Return type
+
+[**ZapierIntegration**](ZapierIntegration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zapier connection updated |  -  |
+| **400** | Invalid name or permission selection |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Zapier connection not found |  -  |
+
+[[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/PostZapierSetup.md

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

@@ -0,0 +1,37 @@
+
+# PostZapierSetupResponse
+
+A newly created Zapier connection. The API key is returned only once.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`integration` | [ZapierIntegration](ZapierIntegration.md)
+`apiKey` | string
+
+## Example
+
+```typescript
+import type { PostZapierSetupResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "integration": null,
+  "apiKey": null,
+} satisfies PostZapierSetupResponse
+
+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 PostZapierSetupResponse
+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/PutZapierSetup.md

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