@easyedu/js-lsm-api 1.116.0 → 1.117.0

package/docs/IntegrationApi.md

@@ -4,21 +4,95 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deleteCustomWebhookIntegration**](IntegrationApi.md#deletecustomwebhookintegration) | **DELETE** /integrations/webhooks/{webhookIntegrationId} | Delete a custom webhook destination |
 | [**deleteZapierSetup**](IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key |
+| [**deleteZapierSubscription**](IntegrationApi.md#deletezapiersubscription) | **DELETE** /integrations/zapier/subscriptions/{subscriptionId} | Unsubscribe a Zap from an Edaxu lifecycle event |
+| [**getCustomWebhookIntegrations**](IntegrationApi.md#getcustomwebhookintegrations) | **GET** /integrations/webhooks | List custom webhook destinations for the selected portal |
 | [**getZapierCourses**](IntegrationApi.md#getzapiercourses) | **GET** /integrations/zapier/courses | List published courses available to a Zapier connection |
+| [**getZapierEvents**](IntegrationApi.md#getzapierevents) | **GET** /integrations/zapier/events | List recent lifecycle events for Zapier trigger setup |
 | [**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 |
 | [**getZapierShopifyCourseMappings**](IntegrationApi.md#getzapiershopifycoursemappings) | **GET** /integrations/zapier/shopify/course-mappings | List Shopify variant-to-course mappings |
 | [**getZapierUsers**](IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address |
+| [**postCustomWebhookIntegration**](IntegrationApi.md#postcustomwebhookintegration) | **POST** /integrations/webhooks | Create a custom webhook destination for lifecycle events |
 | [**postZapierEnrollment**](IntegrationApi.md#postzapierenrollment) | **POST** /integrations/zapier/enrollments | Enroll an existing learner in a course |
 | [**postZapierSetup**](IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal |
 | [**postZapierShopifyCourseMapping**](IntegrationApi.md#postzapiershopifycoursemapping) | **POST** /integrations/zapier/shopify/course-mappings | Create or update a Shopify variant-to-course mapping |
 | [**postZapierShopifyEnrollment**](IntegrationApi.md#postzapiershopifyenrollment) | **POST** /integrations/zapier/shopify/enrollments | Find or invite a Shopify customer and enroll them using the purchased variant mapping |
+| [**postZapierSubscription**](IntegrationApi.md#postzapiersubscription) | **POST** /integrations/zapier/subscriptions | Subscribe a Zap to an Edaxu lifecycle event |
 | [**postZapierUser**](IntegrationApi.md#postzapieruser) | **POST** /integrations/zapier/users | Find or invite a learner to the connected portal |
+| [**putCustomWebhookIntegration**](IntegrationApi.md#putcustomwebhookintegration) | **PUT** /integrations/webhooks/{webhookIntegrationId} | Update a custom webhook destination |
 | [**putZapierSetup**](IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions |
 
 
 
+## deleteCustomWebhookIntegration
+
+> deleteCustomWebhookIntegration(webhookIntegrationId)
+
+Delete a custom webhook destination
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCustomWebhookIntegrationRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    webhookIntegrationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteCustomWebhookIntegrationRequest;
+
+  try {
+    const data = await api.deleteCustomWebhookIntegration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **webhookIntegrationId** | `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** | Custom webhook destination deleted |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Custom webhook destination 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)
+
+
 ## deleteZapierSetup
 
 > deleteZapierSetup(zapierIntegrationId)
@@ -86,6 +160,136 @@ 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)
 
 
+## deleteZapierSubscription
+
+> deleteZapierSubscription(subscriptionId, xAPIKEY, xPORTALSUBDOMAIN)
+
+Unsubscribe a Zap from an Edaxu lifecycle event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteZapierSubscriptionRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    subscriptionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string
+    xAPIKEY: xAPIKEY_example,
+    // string
+    xPORTALSUBDOMAIN: xPORTALSUBDOMAIN_example,
+  } satisfies DeleteZapierSubscriptionRequest;
+
+  try {
+    const data = await api.deleteZapierSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **subscriptionId** | `string` |  | [Defaults to `undefined`] |
+| **xAPIKEY** | `string` |  | [Defaults to `undefined`] |
+| **xPORTALSUBDOMAIN** | `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** | Subscription is inactive |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCustomWebhookIntegrations
+
+> Array<CustomWebhookIntegration> getCustomWebhookIntegrations()
+
+List custom webhook destinations for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCustomWebhookIntegrationsRequest } 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.getCustomWebhookIntegrations();
+    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
+
+[**Array<CustomWebhookIntegration>**](CustomWebhookIntegration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Custom webhook destinations |  -  |
+| **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)
+
+
 ## getZapierCourses
 
 > GetZapierCourses getZapierCourses(xAPIKEY, xPORTALSUBDOMAIN, page, pageSize, search)
@@ -165,6 +369,83 @@ 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)
 
 
+## getZapierEvents
+
+> Array<IntegrationEvent> getZapierEvents(xAPIKEY, xPORTALSUBDOMAIN, eventType, pageSize)
+
+List recent lifecycle events for Zapier trigger setup
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetZapierEventsRequest } 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,
+    // 'com.edaxu.enrollment.enrolled.v1' | 'com.edaxu.enrollment.completed.v1' | 'com.edaxu.certificate.issued.v1'
+    eventType: eventType_example,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetZapierEventsRequest;
+
+  try {
+    const data = await api.getZapierEvents(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`] |
+| **eventType** | `com.edaxu.enrollment.enrolled.v1`, `com.edaxu.enrollment.completed.v1`, `com.edaxu.certificate.issued.v1` |  | [Defaults to `undefined`] [Enum: com.edaxu.enrollment.enrolled.v1, com.edaxu.enrollment.completed.v1, com.edaxu.certificate.issued.v1] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `3`] |
+
+### Return type
+
+[**Array<IntegrationEvent>**](IntegrationEvent.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Recent matching events, newest first |  -  |
+| **400** | Unsupported event type |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key lacks the permission required for the event type |  -  |
+
+[[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)
@@ -439,6 +720,73 @@ 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)
 
 
+## postCustomWebhookIntegration
+
+> CustomWebhookIntegration postCustomWebhookIntegration(postCustomWebhookIntegration)
+
+Create a custom webhook destination for lifecycle events
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCustomWebhookIntegrationRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // PostCustomWebhookIntegration
+    postCustomWebhookIntegration: ...,
+  } satisfies PostCustomWebhookIntegrationRequest;
+
+  try {
+    const data = await api.postCustomWebhookIntegration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postCustomWebhookIntegration** | [PostCustomWebhookIntegration](PostCustomWebhookIntegration.md) |  | |
+
+### Return type
+
+[**CustomWebhookIntegration**](CustomWebhookIntegration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Custom webhook destination created |  -  |
+| **400** | Invalid destination, token, or event 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)
+
+
 ## postZapierEnrollment
 
 > ZapierEnrollment postZapierEnrollment(xAPIKEY, xPORTALSUBDOMAIN, postZapierEnrollment)
@@ -735,6 +1083,81 @@ 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)
 
 
+## postZapierSubscription
+
+> ZapierSubscription postZapierSubscription(xAPIKEY, xPORTALSUBDOMAIN, postZapierSubscription)
+
+Subscribe a Zap to an Edaxu lifecycle event
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierSubscriptionRequest } 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,
+    // PostZapierSubscription
+    postZapierSubscription: ...,
+  } satisfies PostZapierSubscriptionRequest;
+
+  try {
+    const data = await api.postZapierSubscription(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`] |
+| **postZapierSubscription** | [PostZapierSubscription](PostZapierSubscription.md) |  | |
+
+### Return type
+
+[**ZapierSubscription**](ZapierSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Existing matching subscription returned |  -  |
+| **201** | Zapier event subscription created |  -  |
+| **400** | Unsupported event type or target URL |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key lacks the permission required for the event type |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## postZapierUser
 
 > ZapierUser postZapierUser(xAPIKEY, xPORTALSUBDOMAIN, postZapierUser)
@@ -810,6 +1233,77 @@ 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)
 
 
+## putCustomWebhookIntegration
+
+> CustomWebhookIntegration putCustomWebhookIntegration(webhookIntegrationId, putCustomWebhookIntegration)
+
+Update a custom webhook destination
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCustomWebhookIntegrationRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new IntegrationApi();
+
+  const body = {
+    // string
+    webhookIntegrationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // PutCustomWebhookIntegration
+    putCustomWebhookIntegration: ...,
+  } satisfies PutCustomWebhookIntegrationRequest;
+
+  try {
+    const data = await api.putCustomWebhookIntegration(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **webhookIntegrationId** | `string` |  | [Defaults to `undefined`] |
+| **putCustomWebhookIntegration** | [PutCustomWebhookIntegration](PutCustomWebhookIntegration.md) |  | |
+
+### Return type
+
+[**CustomWebhookIntegration**](CustomWebhookIntegration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Custom webhook destination updated |  -  |
+| **400** | Invalid destination, token, event selection, or empty update |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Custom webhook destination 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)
+
+
 ## putZapierSetup
 
 > ZapierIntegration putZapierSetup(zapierIntegrationId, putZapierSetup)

package/docs/IntegrationEvent.md

@@ -0,0 +1,49 @@
+
+# IntegrationEvent
+
+A CloudEvents 1.0 structured JSON event emitted by Edaxu.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`specversion` | string
+`id` | string
+`source` | string
+`type` | string
+`time` | Date
+`subject` | string
+`datacontenttype` | string
+`data` | [IntegrationEventData](IntegrationEventData.md)
+
+## Example
+
+```typescript
+import type { IntegrationEvent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "specversion": null,
+  "id": null,
+  "source": null,
+  "type": null,
+  "time": null,
+  "subject": null,
+  "datacontenttype": null,
+  "data": null,
+} satisfies IntegrationEvent
+
+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 IntegrationEvent
+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/IntegrationEventCertificate.md

@@ -0,0 +1,46 @@
+
+# IntegrationEventCertificate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`issuanceType` | string
+`issuedAt` | Date
+`expiresAt` | Date
+`verificationUrl` | string
+`enrollmentId` | string
+
+## Example
+
+```typescript
+import type { IntegrationEventCertificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "issuanceType": null,
+  "issuedAt": null,
+  "expiresAt": null,
+  "verificationUrl": null,
+  "enrollmentId": null,
+} satisfies IntegrationEventCertificate
+
+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 IntegrationEventCertificate
+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/IntegrationEventCourse.md

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