@easyedu/js-lsm-api 1.114.0 → 1.116.0

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

package/docs/PostZapierShopifyEnrollmentResponse.md

@@ -0,0 +1,38 @@
+
+# PostZapierShopifyEnrollmentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enrollment` | [ZapierEnrollment](ZapierEnrollment.md)
+`user` | [ZapierUser](ZapierUser.md)
+`mapping` | [ZapierShopifyCourseMapping](ZapierShopifyCourseMapping.md)
+
+## Example
+
+```typescript
+import type { PostZapierShopifyEnrollmentResponse } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enrollment": null,
+  "user": null,
+  "mapping": null,
+} satisfies PostZapierShopifyEnrollmentResponse
+
+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 PostZapierShopifyEnrollmentResponse
+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/PostZapierUser.md

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

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

@@ -0,0 +1,48 @@
+
+# ZapierEnrollment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`courseId` | string
+`userId` | string
+`status` | string
+`enrollmentDateStart` | number
+`enrollmentDateEnd` | number
+`created` | boolean
+`idempotentReplay` | boolean
+
+## Example
+
+```typescript
+import type { ZapierEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "courseId": null,
+  "userId": null,
+  "status": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "created": null,
+  "idempotentReplay": null,
+} satisfies ZapierEnrollment
+
+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 ZapierEnrollment
+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/docs/ZapierShopifyCourseMapping.md

@@ -0,0 +1,46 @@
+
+# ZapierShopifyCourseMapping
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`shopDomain` | string
+`variantId` | string
+`productId` | string
+`course` | [ZapierCourse](ZapierCourse.md)
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { ZapierShopifyCourseMapping } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "shopDomain": null,
+  "variantId": null,
+  "productId": null,
+  "course": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies ZapierShopifyCourseMapping
+
+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 ZapierShopifyCourseMapping
+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/ZapierUser.md

@@ -0,0 +1,42 @@
+
+# ZapierUser
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`firstName` | string
+`lastName` | string
+`created` | boolean
+
+## Example
+
+```typescript
+import type { ZapierUser } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+  "created": null,
+} satisfies ZapierUser
+
+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 ZapierUser
+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.116.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {