@easyedu/js-lsm-api 1.116.0 → 1.118.0

package/docs/IntegrationEventData.md

@@ -0,0 +1,46 @@
+
+# IntegrationEventData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portal` | [IntegrationEventPortal](IntegrationEventPortal.md)
+`learner` | [IntegrationEventLearner](IntegrationEventLearner.md)
+`user` | [IntegrationEventUser](IntegrationEventUser.md)
+`course` | [IntegrationEventCourse](IntegrationEventCourse.md)
+`enrollment` | [IntegrationEventEnrollment](IntegrationEventEnrollment.md)
+`certificate` | [IntegrationEventCertificate](IntegrationEventCertificate.md)
+`invitation` | [IntegrationEventInvitation](IntegrationEventInvitation.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,
+  "user": null,
+  "course": null,
+  "enrollment": null,
+  "certificate": null,
+  "invitation": 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/IntegrationEventInvitation.md

@@ -0,0 +1,45 @@
+
+# IntegrationEventInvitation
+
+Portal invitation lifecycle details for the affected user.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`invitedAt` | Date
+`expiresAt` | Date
+`acceptedAt` | Date
+`invitedBy` | [IntegrationEventUser](IntegrationEventUser.md)
+
+## Example
+
+```typescript
+import type { IntegrationEventInvitation } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "invitedAt": null,
+  "expiresAt": null,
+  "acceptedAt": null,
+  "invitedBy": null,
+} satisfies IntegrationEventInvitation
+
+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 IntegrationEventInvitation
+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/IntegrationEventUser.md

@@ -0,0 +1,41 @@
+
+# IntegrationEventUser
+
+User affected by a portal membership lifecycle event.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`email` | string
+`firstName` | string
+`lastName` | string
+
+## Example
+
+```typescript
+import type { IntegrationEventUser } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "email": null,
+  "firstName": null,
+  "lastName": null,
+} satisfies IntegrationEventUser
+
+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 IntegrationEventUser
+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/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/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/ZapierSubscription.md

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