@easyedu/js-lsm-api 1.115.0 → 1.116.0

package/docs/IntegrationApi.md

@@ -5,9 +5,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**deleteZapierSetup**](IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key |
+| [**getZapierCourses**](IntegrationApi.md#getzapiercourses) | **GET** /integrations/zapier/courses | List published courses available to a Zapier connection |
 | [**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 |
+| [**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 |
+| [**postZapierUser**](IntegrationApi.md#postzapieruser) | **POST** /integrations/zapier/users | Find or invite a learner to the connected portal |
 | [**putZapierSetup**](IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions |
 
 
@@ -79,6 +86,85 @@ 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)
 
 
+## getZapierCourses
+
+> GetZapierCourses getZapierCourses(xAPIKEY, xPORTALSUBDOMAIN, page, pageSize, search)
+
+List published courses available to a Zapier connection
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IntegrationApi,
+} 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 = {
+    // 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.getZapierCourses(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`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `100`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetZapierCourses**](GetZapierCourses.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **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)
+
+
 ## getZapierMe
 
 > GetZapierMe getZapierMe(xAPIKEY, xPORTALSUBDOMAIN)
@@ -207,6 +293,229 @@ 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)
 
 
+## 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)
+
+
+## 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)
@@ -274,6 +583,233 @@ 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)
 
 
+## 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)
+
+
+## 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)
+
+
 ## putZapierSetup
 
 > ZapierIntegration putZapierSetup(zapierIntegrationId, putZapierSetup)

package/docs/PostZapierEnrollment.md

@@ -0,0 +1,46 @@
+
+# PostZapierEnrollment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`userId` | string
+`idempotencyKey` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`notes` | string
+`reEnrollmentMode` | string
+
+## Example
+
+```typescript
+import type { PostZapierEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "userId": null,
+  "idempotencyKey": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "notes": null,
+  "reEnrollmentMode": null,
+} satisfies PostZapierEnrollment
+
+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 PostZapierEnrollment
+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/PostZapierShopifyCourseMapping.md

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

@@ -0,0 +1,54 @@
+
+# PostZapierShopifyEnrollment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`shopDomain` | string
+`orderId` | string
+`lineItemId` | string
+`variantId` | string
+`email` | string
+`firstName` | string
+`lastName` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`notes` | string
+`reEnrollmentMode` | string
+
+## Example
+
+```typescript
+import type { PostZapierShopifyEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "shopDomain": null,
+  "orderId": null,
+  "lineItemId": null,
+  "variantId": null,
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "notes": null,
+  "reEnrollmentMode": null,
+} satisfies PostZapierShopifyEnrollment
+
+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 PostZapierShopifyEnrollment
+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)
+
+