@easyedu/js-lsm-api 1.116.0 → 1.117.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/.openapi-generator/FILES +24 -0
  2. package/README.md +21 -2
  3. package/dist/apis/IntegrationApi.d.ts +125 -0
  4. package/dist/apis/IntegrationApi.js +330 -1
  5. package/dist/esm/apis/IntegrationApi.d.ts +125 -0
  6. package/dist/esm/apis/IntegrationApi.js +329 -0
  7. package/dist/esm/models/CustomWebhookIntegration.d.ts +83 -0
  8. package/dist/esm/models/CustomWebhookIntegration.js +79 -0
  9. package/dist/esm/models/IntegrationEvent.d.ts +98 -0
  10. package/dist/esm/models/IntegrationEvent.js +92 -0
  11. package/dist/esm/models/IntegrationEventCertificate.d.ts +78 -0
  12. package/dist/esm/models/IntegrationEventCertificate.js +76 -0
  13. package/dist/esm/models/IntegrationEventCourse.d.ts +38 -0
  14. package/dist/esm/models/IntegrationEventCourse.js +47 -0
  15. package/dist/esm/models/IntegrationEventData.d.ts +61 -0
  16. package/dist/esm/models/IntegrationEventData.js +64 -0
  17. package/dist/esm/models/IntegrationEventEnrollment.d.ts +71 -0
  18. package/dist/esm/models/IntegrationEventEnrollment.js +71 -0
  19. package/dist/esm/models/IntegrationEventLearner.d.ts +50 -0
  20. package/dist/esm/models/IntegrationEventLearner.js +55 -0
  21. package/dist/esm/models/IntegrationEventPortal.d.ts +44 -0
  22. package/dist/esm/models/IntegrationEventPortal.js +51 -0
  23. package/dist/esm/models/PostCustomWebhookIntegration.d.ts +65 -0
  24. package/dist/esm/models/PostCustomWebhookIntegration.js +65 -0
  25. package/dist/esm/models/PostZapierSubscription.d.ts +53 -0
  26. package/dist/esm/models/PostZapierSubscription.js +57 -0
  27. package/dist/esm/models/PutCustomWebhookIntegration.d.ts +65 -0
  28. package/dist/esm/models/PutCustomWebhookIntegration.js +57 -0
  29. package/dist/esm/models/ZapierSubscription.d.ts +53 -0
  30. package/dist/esm/models/ZapierSubscription.js +59 -0
  31. package/dist/esm/models/index.d.ts +12 -0
  32. package/dist/esm/models/index.js +12 -0
  33. package/dist/models/CustomWebhookIntegration.d.ts +83 -0
  34. package/dist/models/CustomWebhookIntegration.js +87 -0
  35. package/dist/models/IntegrationEvent.d.ts +98 -0
  36. package/dist/models/IntegrationEvent.js +100 -0
  37. package/dist/models/IntegrationEventCertificate.d.ts +78 -0
  38. package/dist/models/IntegrationEventCertificate.js +84 -0
  39. package/dist/models/IntegrationEventCourse.d.ts +38 -0
  40. package/dist/models/IntegrationEventCourse.js +54 -0
  41. package/dist/models/IntegrationEventData.d.ts +61 -0
  42. package/dist/models/IntegrationEventData.js +71 -0
  43. package/dist/models/IntegrationEventEnrollment.d.ts +71 -0
  44. package/dist/models/IntegrationEventEnrollment.js +79 -0
  45. package/dist/models/IntegrationEventLearner.d.ts +50 -0
  46. package/dist/models/IntegrationEventLearner.js +62 -0
  47. package/dist/models/IntegrationEventPortal.d.ts +44 -0
  48. package/dist/models/IntegrationEventPortal.js +58 -0
  49. package/dist/models/PostCustomWebhookIntegration.d.ts +65 -0
  50. package/dist/models/PostCustomWebhookIntegration.js +73 -0
  51. package/dist/models/PostZapierSubscription.d.ts +53 -0
  52. package/dist/models/PostZapierSubscription.js +65 -0
  53. package/dist/models/PutCustomWebhookIntegration.d.ts +65 -0
  54. package/dist/models/PutCustomWebhookIntegration.js +65 -0
  55. package/dist/models/ZapierSubscription.d.ts +53 -0
  56. package/dist/models/ZapierSubscription.js +67 -0
  57. package/dist/models/index.d.ts +12 -0
  58. package/dist/models/index.js +12 -0
  59. package/docs/CustomWebhookIntegration.md +48 -0
  60. package/docs/IntegrationApi.md +494 -0
  61. package/docs/IntegrationEvent.md +49 -0
  62. package/docs/IntegrationEventCertificate.md +46 -0
  63. package/docs/IntegrationEventCourse.md +36 -0
  64. package/docs/IntegrationEventData.md +42 -0
  65. package/docs/IntegrationEventEnrollment.md +44 -0
  66. package/docs/IntegrationEventLearner.md +40 -0
  67. package/docs/IntegrationEventPortal.md +38 -0
  68. package/docs/PostCustomWebhookIntegration.md +42 -0
  69. package/docs/PostZapierSubscription.md +38 -0
  70. package/docs/PutCustomWebhookIntegration.md +42 -0
  71. package/docs/ZapierSubscription.md +38 -0
  72. package/package.json +1 -1
  73. package/src/apis/IntegrationApi.ts +464 -0
  74. package/src/models/CustomWebhookIntegration.ts +141 -0
  75. package/src/models/IntegrationEvent.ts +165 -0
  76. package/src/models/IntegrationEventCertificate.ts +133 -0
  77. package/src/models/IntegrationEventCourse.ts +75 -0
  78. package/src/models/IntegrationEventData.ts +138 -0
  79. package/src/models/IntegrationEventEnrollment.ts +123 -0
  80. package/src/models/IntegrationEventLearner.ts +93 -0
  81. package/src/models/IntegrationEventPortal.ts +84 -0
  82. package/src/models/PostCustomWebhookIntegration.ts +113 -0
  83. package/src/models/PostZapierSubscription.ts +95 -0
  84. package/src/models/PutCustomWebhookIntegration.ts +109 -0
  85. package/src/models/ZapierSubscription.ts +96 -0
  86. package/src/models/index.ts +12 -0
@@ -0,0 +1,42 @@
1
+
2
+ # IntegrationEventData
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `portal` | [IntegrationEventPortal](IntegrationEventPortal.md)
10
+ `learner` | [IntegrationEventLearner](IntegrationEventLearner.md)
11
+ `course` | [IntegrationEventCourse](IntegrationEventCourse.md)
12
+ `enrollment` | [IntegrationEventEnrollment](IntegrationEventEnrollment.md)
13
+ `certificate` | [IntegrationEventCertificate](IntegrationEventCertificate.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { IntegrationEventData } from '@easyedu/js-lsm-api'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "portal": null,
23
+ "learner": null,
24
+ "course": null,
25
+ "enrollment": null,
26
+ "certificate": null,
27
+ } satisfies IntegrationEventData
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventData
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,44 @@
1
+
2
+ # IntegrationEventEnrollment
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `status` | string
11
+ `occurrence` | string
12
+ `enrollmentDateStart` | Date
13
+ `enrollmentDateEnd` | Date
14
+ `completedAt` | Date
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { IntegrationEventEnrollment } from '@easyedu/js-lsm-api'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "id": null,
24
+ "status": null,
25
+ "occurrence": null,
26
+ "enrollmentDateStart": null,
27
+ "enrollmentDateEnd": null,
28
+ "completedAt": null,
29
+ } satisfies IntegrationEventEnrollment
30
+
31
+ console.log(example)
32
+
33
+ // Convert the instance to a JSON string
34
+ const exampleJSON: string = JSON.stringify(example)
35
+ console.log(exampleJSON)
36
+
37
+ // Parse the JSON string back to an object
38
+ const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventEnrollment
39
+ console.log(exampleParsed)
40
+ ```
41
+
42
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
+
44
+
@@ -0,0 +1,40 @@
1
+
2
+ # IntegrationEventLearner
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `email` | string
11
+ `firstName` | string
12
+ `lastName` | string
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { IntegrationEventLearner } from '@easyedu/js-lsm-api'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "id": null,
22
+ "email": null,
23
+ "firstName": null,
24
+ "lastName": null,
25
+ } satisfies IntegrationEventLearner
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventLearner
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,38 @@
1
+
2
+ # IntegrationEventPortal
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `name` | string
11
+ `subdomain` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IntegrationEventPortal } from '@easyedu/js-lsm-api'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "id": null,
21
+ "name": null,
22
+ "subdomain": null,
23
+ } satisfies IntegrationEventPortal
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as IntegrationEventPortal
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,42 @@
1
+
2
+ # PostCustomWebhookIntegration
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `targetUrl` | string
11
+ `bearerToken` | string
12
+ `eventTypes` | Set<string>
13
+ `enabled` | boolean
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { PostCustomWebhookIntegration } from '@easyedu/js-lsm-api'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "name": null,
23
+ "targetUrl": null,
24
+ "bearerToken": null,
25
+ "eventTypes": null,
26
+ "enabled": null,
27
+ } satisfies PostCustomWebhookIntegration
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as PostCustomWebhookIntegration
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,38 @@
1
+
2
+ # PostZapierSubscription
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `eventType` | string
10
+ `targetUrl` | string
11
+ `zapId` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { PostZapierSubscription } from '@easyedu/js-lsm-api'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "eventType": null,
21
+ "targetUrl": null,
22
+ "zapId": null,
23
+ } satisfies PostZapierSubscription
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as PostZapierSubscription
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -0,0 +1,42 @@
1
+
2
+ # PutCustomWebhookIntegration
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `name` | string
10
+ `targetUrl` | string
11
+ `bearerToken` | string
12
+ `eventTypes` | Set<string>
13
+ `enabled` | boolean
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { PutCustomWebhookIntegration } from '@easyedu/js-lsm-api'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "name": null,
23
+ "targetUrl": null,
24
+ "bearerToken": null,
25
+ "eventTypes": null,
26
+ "enabled": null,
27
+ } satisfies PutCustomWebhookIntegration
28
+
29
+ console.log(example)
30
+
31
+ // Convert the instance to a JSON string
32
+ const exampleJSON: string = JSON.stringify(example)
33
+ console.log(exampleJSON)
34
+
35
+ // Parse the JSON string back to an object
36
+ const exampleParsed = JSON.parse(exampleJSON) as PutCustomWebhookIntegration
37
+ console.log(exampleParsed)
38
+ ```
39
+
40
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
41
+
42
+
@@ -0,0 +1,38 @@
1
+
2
+ # ZapierSubscription
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | string
10
+ `eventType` | string
11
+ `createdAt` | Date
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { ZapierSubscription } from '@easyedu/js-lsm-api'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "id": null,
21
+ "eventType": null,
22
+ "createdAt": null,
23
+ } satisfies ZapierSubscription
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as ZapierSubscription
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.116.0",
3
+ "version": "1.117.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {