@easyedu/js-lsm-api 1.115.0 → 1.117.0

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

package/docs/IntegrationEventData.md

@@ -0,0 +1,42 @@
+
+# IntegrationEventData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portal` | [IntegrationEventPortal](IntegrationEventPortal.md)
+`learner` | [IntegrationEventLearner](IntegrationEventLearner.md)
+`course` | [IntegrationEventCourse](IntegrationEventCourse.md)
+`enrollment` | [IntegrationEventEnrollment](IntegrationEventEnrollment.md)
+`certificate` | [IntegrationEventCertificate](IntegrationEventCertificate.md)
+
+## Example
+
+```typescript
+import type { IntegrationEventData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portal": null,
+  "learner": null,
+  "course": null,
+  "enrollment": null,
+  "certificate": null,
+} satisfies IntegrationEventData
+
+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 IntegrationEventData
+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/IntegrationEventEnrollment.md

@@ -0,0 +1,44 @@
+
+# IntegrationEventEnrollment
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`occurrence` | string
+`enrollmentDateStart` | Date
+`enrollmentDateEnd` | Date
+`completedAt` | Date
+
+## Example
+
+```typescript
+import type { IntegrationEventEnrollment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "occurrence": null,
+  "enrollmentDateStart": null,
+  "enrollmentDateEnd": null,
+  "completedAt": null,
+} satisfies IntegrationEventEnrollment
+
+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 IntegrationEventEnrollment
+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/IntegrationEventLearner.md

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

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

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

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/PostZapierSubscription.md

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

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