@easyedu/js-lsm-api 1.114.0 → 1.115.0

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

package/docs/ZapierIntegration.md

@@ -0,0 +1,55 @@
+
+# ZapierIntegration
+
+A portal-scoped Zapier connection. The API key secret is never included here.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`portalId` | string
+`portalName` | string
+`portalSubdomain` | string
+`keyPrefix` | string
+`permissionKeys` | Array<string>
+`createdAt` | number
+`updatedAt` | number
+`lastUsedAt` | number
+`revokedAt` | number
+
+## Example
+
+```typescript
+import type { ZapierIntegration } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "portalId": null,
+  "portalName": null,
+  "portalSubdomain": null,
+  "keyPrefix": null,
+  "permissionKeys": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+} satisfies ZapierIntegration
+
+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 ZapierIntegration
+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.114.0",
+  "version": "1.115.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {