@easyedu/js-lsm-api 1.115.0 → 1.117.0

package/docs/IntegrationApi.md

@@ -4,14 +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)
@@ -79,11 +160,11 @@ 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)
 
 
-## getZapierMe
+## deleteZapierSubscription
 
-> GetZapierMe getZapierMe(xAPIKEY, xPORTALSUBDOMAIN)
+> deleteZapierSubscription(subscriptionId, xAPIKEY, xPORTALSUBDOMAIN)
 
-Test a Zapier API key and return its portal and enabled permissions
+Unsubscribe a Zap from an Edaxu lifecycle event
 
 ### Example
 
@@ -92,21 +173,23 @@ import {
   Configuration,
   IntegrationApi,
 } from '@easyedu/js-lsm-api';
-import type { GetZapierMeRequest } 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 GetZapierMeRequest;
+  } satisfies DeleteZapierSubscriptionRequest;
 
   try {
-    const data = await api.getZapierMe(body);
+    const data = await api.deleteZapierSubscription(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -122,12 +205,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **subscriptionId** | `string` |  | [Defaults to `undefined`] |
 | **xAPIKEY** | `string` |  | [Defaults to `undefined`] |
 | **xPORTALSUBDOMAIN** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**GetZapierMe**](GetZapierMe.md)
+`void` (Empty response body)
 
 ### Authorization
 
@@ -136,24 +220,23 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: Not defined
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Connected Zapier account details |  -  |
+| **204** | Subscription is inactive |  -  |
 | **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
+## getCustomWebhookIntegrations
 
-> GetZapierSetup getZapierSetup()
+> Array<CustomWebhookIntegration> getCustomWebhookIntegrations()
 
-List Zapier connections and permissions available to the selected portal
+List custom webhook destinations for the selected portal
 
 ### Example
 
@@ -162,14 +245,14 @@ import {
   Configuration,
   IntegrationApi,
 } from '@easyedu/js-lsm-api';
-import type { GetZapierSetupRequest } 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.getZapierSetup();
+    const data = await api.getCustomWebhookIntegrations();
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -186,7 +269,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**GetZapierSetup**](GetZapierSetup.md)
+[**Array<CustomWebhookIntegration>**](CustomWebhookIntegration.md)
 
 ### Authorization
 
@@ -201,17 +284,17 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Zapier setup details |  -  |
+| **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)
 
 
-## postZapierSetup
+## getZapierCourses
 
-> PostZapierSetupResponse postZapierSetup(postZapierSetup)
+> GetZapierCourses getZapierCourses(xAPIKEY, xPORTALSUBDOMAIN, page, pageSize, search)
 
-Create a Zapier connection and API key for the selected portal
+List published courses available to a Zapier connection
 
 ### Example
 
@@ -220,19 +303,27 @@ import {
   Configuration,
   IntegrationApi,
 } from '@easyedu/js-lsm-api';
-import type { PostZapierSetupRequest } from '@easyedu/js-lsm-api';
+import type { GetZapierCoursesRequest } 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;
+    // string
+    xAPIKEY: xAPIKEY_example,
+    // string
+    xPORTALSUBDOMAIN: xPORTALSUBDOMAIN_example,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string (optional)
+    search: search_example,
+  } satisfies GetZapierCoursesRequest;
 
   try {
-    const data = await api.postZapierSetup(body);
+    const data = await api.getZapierCourses(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -248,11 +339,15 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **postZapierSetup** | [PostZapierSetup](PostZapierSetup.md) |  | |
+| **xAPIKEY** | `string` |  | [Defaults to `undefined`] |
+| **xPORTALSUBDOMAIN** | `string` |  | [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `100`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-[**PostZapierSetupResponse**](PostZapierSetupResponse.md)
+[**GetZapierCourses**](GetZapierCourses.md)
 
 ### Authorization
 
@@ -260,16 +355,951 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
+- **Content-Type**: Not defined
 - **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 |  -  |
+| **200** | Published courses available to the connection |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key does not have course:list |  -  |
+
+[[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)
+
+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)
+
+
+## getZapierShopifyCourseMappings
+
+> GetZapierShopifyCourseMappings getZapierShopifyCourseMappings(xAPIKEY, xPORTALSUBDOMAIN, shopDomain)
+
+List Shopify variant-to-course mappings
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetZapierShopifyCourseMappingsRequest } 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,
+    // string (optional)
+    shopDomain: shopDomain_example,
+  } satisfies GetZapierShopifyCourseMappingsRequest;
+
+  try {
+    const data = await api.getZapierShopifyCourseMappings(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`] |
+| **shopDomain** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetZapierShopifyCourseMappings**](GetZapierShopifyCourseMappings.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Shopify course mappings for the connected portal |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key does not have course:list |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getZapierUsers
+
+> GetZapierUsers getZapierUsers(xAPIKEY, xPORTALSUBDOMAIN, email)
+
+Find a learner by exact email address
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { GetZapierUsersRequest } 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,
+    // string
+    email: email_example,
+  } satisfies GetZapierUsersRequest;
+
+  try {
+    const data = await api.getZapierUsers(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`] |
+| **email** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetZapierUsers**](GetZapierUsers.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Zero or one exact learner match |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key does not have user:read_any |  -  |
+
+[[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)
+
+Enroll an existing learner in a course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierEnrollmentRequest } 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,
+    // PostZapierEnrollment
+    postZapierEnrollment: ...,
+  } satisfies PostZapierEnrollmentRequest;
+
+  try {
+    const data = await api.postZapierEnrollment(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`] |
+| **postZapierEnrollment** | [PostZapierEnrollment](PostZapierEnrollment.md) |  | |
+
+### Return type
+
+[**ZapierEnrollment**](ZapierEnrollment.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 idempotent enrollment result returned |  -  |
+| **201** | Learner enrolled |  -  |
+| **400** | Invalid enrollment input |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key does not have enrollment:create |  -  |
+| **404** | Course or learner not found in the connected portal |  -  |
+| **409** | Enrollment conflicts with the current course or portal state |  -  |
+
+[[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)
+
+
+## postZapierShopifyCourseMapping
+
+> ZapierShopifyCourseMapping postZapierShopifyCourseMapping(xAPIKEY, xPORTALSUBDOMAIN, postZapierShopifyCourseMapping)
+
+Create or update a Shopify variant-to-course mapping
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierShopifyCourseMappingRequest } 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,
+    // PostZapierShopifyCourseMapping
+    postZapierShopifyCourseMapping: ...,
+  } satisfies PostZapierShopifyCourseMappingRequest;
+
+  try {
+    const data = await api.postZapierShopifyCourseMapping(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`] |
+| **postZapierShopifyCourseMapping** | [PostZapierShopifyCourseMapping](PostZapierShopifyCourseMapping.md) |  | |
+
+### Return type
+
+[**ZapierShopifyCourseMapping**](ZapierShopifyCourseMapping.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Mapping created or updated |  -  |
+| **400** | Invalid Shopify mapping |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key lacks a required permission |  -  |
+| **404** | Course not found in the connected portal |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postZapierShopifyEnrollment
+
+> PostZapierShopifyEnrollmentResponse postZapierShopifyEnrollment(xAPIKEY, xPORTALSUBDOMAIN, postZapierShopifyEnrollment)
+
+Find or invite a Shopify customer and enroll them using the purchased variant mapping
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierShopifyEnrollmentRequest } 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,
+    // PostZapierShopifyEnrollment
+    postZapierShopifyEnrollment: ...,
+  } satisfies PostZapierShopifyEnrollmentRequest;
+
+  try {
+    const data = await api.postZapierShopifyEnrollment(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`] |
+| **postZapierShopifyEnrollment** | [PostZapierShopifyEnrollment](PostZapierShopifyEnrollment.md) |  | |
+
+### Return type
+
+[**PostZapierShopifyEnrollmentResponse**](PostZapierShopifyEnrollmentResponse.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 idempotent Shopify enrollment result returned |  -  |
+| **201** | Shopify customer enrolled |  -  |
+| **400** | Invalid Shopify order data |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key lacks a required permission |  -  |
+| **404** | Shopify variant mapping or course not found |  -  |
+| **409** | Enrollment conflicts with the current course or portal state |  -  |
+
+[[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)
+
+Find or invite a learner to the connected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} from '@easyedu/js-lsm-api';
+import type { PostZapierUserRequest } 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,
+    // PostZapierUser
+    postZapierUser: ...,
+  } satisfies PostZapierUserRequest;
+
+  try {
+    const data = await api.postZapierUser(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`] |
+| **postZapierUser** | [PostZapierUser](PostZapierUser.md) |  | |
+
+### Return type
+
+[**ZapierUser**](ZapierUser.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 learner returned |  -  |
+| **201** | Learner created and invitation queued |  -  |
+| **401** | Missing, invalid, or revoked API key |  -  |
+| **403** | The API key does not have portal:invite_user |  -  |
+| **409** | Email belongs to another portal in the hosted organization |  -  |
+
+[[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)