@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.
- package/.openapi-generator/FILES +24 -0
- package/README.md +21 -2
- package/dist/apis/IntegrationApi.d.ts +125 -0
- package/dist/apis/IntegrationApi.js +330 -1
- package/dist/esm/apis/IntegrationApi.d.ts +125 -0
- package/dist/esm/apis/IntegrationApi.js +329 -0
- package/dist/esm/models/CustomWebhookIntegration.d.ts +83 -0
- package/dist/esm/models/CustomWebhookIntegration.js +79 -0
- package/dist/esm/models/IntegrationEvent.d.ts +98 -0
- package/dist/esm/models/IntegrationEvent.js +92 -0
- package/dist/esm/models/IntegrationEventCertificate.d.ts +78 -0
- package/dist/esm/models/IntegrationEventCertificate.js +76 -0
- package/dist/esm/models/IntegrationEventCourse.d.ts +38 -0
- package/dist/esm/models/IntegrationEventCourse.js +47 -0
- package/dist/esm/models/IntegrationEventData.d.ts +61 -0
- package/dist/esm/models/IntegrationEventData.js +64 -0
- package/dist/esm/models/IntegrationEventEnrollment.d.ts +71 -0
- package/dist/esm/models/IntegrationEventEnrollment.js +71 -0
- package/dist/esm/models/IntegrationEventLearner.d.ts +50 -0
- package/dist/esm/models/IntegrationEventLearner.js +55 -0
- package/dist/esm/models/IntegrationEventPortal.d.ts +44 -0
- package/dist/esm/models/IntegrationEventPortal.js +51 -0
- package/dist/esm/models/PostCustomWebhookIntegration.d.ts +65 -0
- package/dist/esm/models/PostCustomWebhookIntegration.js +65 -0
- package/dist/esm/models/PostZapierSubscription.d.ts +53 -0
- package/dist/esm/models/PostZapierSubscription.js +57 -0
- package/dist/esm/models/PutCustomWebhookIntegration.d.ts +65 -0
- package/dist/esm/models/PutCustomWebhookIntegration.js +57 -0
- package/dist/esm/models/ZapierSubscription.d.ts +53 -0
- package/dist/esm/models/ZapierSubscription.js +59 -0
- package/dist/esm/models/index.d.ts +12 -0
- package/dist/esm/models/index.js +12 -0
- package/dist/models/CustomWebhookIntegration.d.ts +83 -0
- package/dist/models/CustomWebhookIntegration.js +87 -0
- package/dist/models/IntegrationEvent.d.ts +98 -0
- package/dist/models/IntegrationEvent.js +100 -0
- package/dist/models/IntegrationEventCertificate.d.ts +78 -0
- package/dist/models/IntegrationEventCertificate.js +84 -0
- package/dist/models/IntegrationEventCourse.d.ts +38 -0
- package/dist/models/IntegrationEventCourse.js +54 -0
- package/dist/models/IntegrationEventData.d.ts +61 -0
- package/dist/models/IntegrationEventData.js +71 -0
- package/dist/models/IntegrationEventEnrollment.d.ts +71 -0
- package/dist/models/IntegrationEventEnrollment.js +79 -0
- package/dist/models/IntegrationEventLearner.d.ts +50 -0
- package/dist/models/IntegrationEventLearner.js +62 -0
- package/dist/models/IntegrationEventPortal.d.ts +44 -0
- package/dist/models/IntegrationEventPortal.js +58 -0
- package/dist/models/PostCustomWebhookIntegration.d.ts +65 -0
- package/dist/models/PostCustomWebhookIntegration.js +73 -0
- package/dist/models/PostZapierSubscription.d.ts +53 -0
- package/dist/models/PostZapierSubscription.js +65 -0
- package/dist/models/PutCustomWebhookIntegration.d.ts +65 -0
- package/dist/models/PutCustomWebhookIntegration.js +65 -0
- package/dist/models/ZapierSubscription.d.ts +53 -0
- package/dist/models/ZapierSubscription.js +67 -0
- package/dist/models/index.d.ts +12 -0
- package/dist/models/index.js +12 -0
- package/docs/CustomWebhookIntegration.md +48 -0
- package/docs/IntegrationApi.md +494 -0
- package/docs/IntegrationEvent.md +49 -0
- package/docs/IntegrationEventCertificate.md +46 -0
- package/docs/IntegrationEventCourse.md +36 -0
- package/docs/IntegrationEventData.md +42 -0
- package/docs/IntegrationEventEnrollment.md +44 -0
- package/docs/IntegrationEventLearner.md +40 -0
- package/docs/IntegrationEventPortal.md +38 -0
- package/docs/PostCustomWebhookIntegration.md +42 -0
- package/docs/PostZapierSubscription.md +38 -0
- package/docs/PutCustomWebhookIntegration.md +42 -0
- package/docs/ZapierSubscription.md +38 -0
- package/package.json +1 -1
- package/src/apis/IntegrationApi.ts +464 -0
- package/src/models/CustomWebhookIntegration.ts +141 -0
- package/src/models/IntegrationEvent.ts +165 -0
- package/src/models/IntegrationEventCertificate.ts +133 -0
- package/src/models/IntegrationEventCourse.ts +75 -0
- package/src/models/IntegrationEventData.ts +138 -0
- package/src/models/IntegrationEventEnrollment.ts +123 -0
- package/src/models/IntegrationEventLearner.ts +93 -0
- package/src/models/IntegrationEventPortal.ts +84 -0
- package/src/models/PostCustomWebhookIntegration.ts +113 -0
- package/src/models/PostZapierSubscription.ts +95 -0
- package/src/models/PutCustomWebhookIntegration.ts +109 -0
- package/src/models/ZapierSubscription.ts +96 -0
- package/src/models/index.ts +12 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -53,6 +53,7 @@ docs/CourseProgressionMode.md
|
|
|
53
53
|
docs/CourseShare.md
|
|
54
54
|
docs/CourseShareAcceptError.md
|
|
55
55
|
docs/CourseShareApi.md
|
|
56
|
+
docs/CustomWebhookIntegration.md
|
|
56
57
|
docs/DispatchApi.md
|
|
57
58
|
docs/EffectiveCertificateConfig.md
|
|
58
59
|
docs/EmailTemplateApi.md
|
|
@@ -180,6 +181,13 @@ docs/GetZapierSetup.md
|
|
|
180
181
|
docs/GetZapierShopifyCourseMappings.md
|
|
181
182
|
docs/GetZapierUsers.md
|
|
182
183
|
docs/IntegrationApi.md
|
|
184
|
+
docs/IntegrationEvent.md
|
|
185
|
+
docs/IntegrationEventCertificate.md
|
|
186
|
+
docs/IntegrationEventCourse.md
|
|
187
|
+
docs/IntegrationEventData.md
|
|
188
|
+
docs/IntegrationEventEnrollment.md
|
|
189
|
+
docs/IntegrationEventLearner.md
|
|
190
|
+
docs/IntegrationEventPortal.md
|
|
183
191
|
docs/LearnerExperienceApi.md
|
|
184
192
|
docs/LearnerExperienceVersion.md
|
|
185
193
|
docs/LibraryQuizCriteriaPreviewQuestion.md
|
|
@@ -236,6 +244,7 @@ docs/PostCourseVersionItemSession.md
|
|
|
236
244
|
docs/PostCourseVersionPublish.md
|
|
237
245
|
docs/PostCourseVersionSection.md
|
|
238
246
|
docs/PostCourseVersionSectionDuplicate.md
|
|
247
|
+
docs/PostCustomWebhookIntegration.md
|
|
239
248
|
docs/PostDuplicate.md
|
|
240
249
|
docs/PostEmailAssetComplete.md
|
|
241
250
|
docs/PostEmailAssetUpload.md
|
|
@@ -282,6 +291,7 @@ docs/PostZapierSetupResponse.md
|
|
|
282
291
|
docs/PostZapierShopifyCourseMapping.md
|
|
283
292
|
docs/PostZapierShopifyEnrollment.md
|
|
284
293
|
docs/PostZapierShopifyEnrollmentResponse.md
|
|
294
|
+
docs/PostZapierSubscription.md
|
|
285
295
|
docs/PostZapierUser.md
|
|
286
296
|
docs/ProgressionGateError.md
|
|
287
297
|
docs/ProgressionLockReason.md
|
|
@@ -299,6 +309,7 @@ docs/PutCourseVersionDraft.md
|
|
|
299
309
|
docs/PutCourseVersionItem.md
|
|
300
310
|
docs/PutCourseVersionOutlineEntryMove.md
|
|
301
311
|
docs/PutCourseVersionSection.md
|
|
312
|
+
docs/PutCustomWebhookIntegration.md
|
|
302
313
|
docs/PutEmailTemplateDraft.md
|
|
303
314
|
docs/PutLearnerExperienceDraft.md
|
|
304
315
|
docs/PutLibraryQuiz.md
|
|
@@ -353,6 +364,7 @@ docs/ZapierCourse.md
|
|
|
353
364
|
docs/ZapierEnrollment.md
|
|
354
365
|
docs/ZapierIntegration.md
|
|
355
366
|
docs/ZapierShopifyCourseMapping.md
|
|
367
|
+
docs/ZapierSubscription.md
|
|
356
368
|
docs/ZapierUser.md
|
|
357
369
|
package.json
|
|
358
370
|
src/apis/CertificateApi.ts
|
|
@@ -424,6 +436,7 @@ src/models/CourseCatalog.ts
|
|
|
424
436
|
src/models/CourseProgressionMode.ts
|
|
425
437
|
src/models/CourseShare.ts
|
|
426
438
|
src/models/CourseShareAcceptError.ts
|
|
439
|
+
src/models/CustomWebhookIntegration.ts
|
|
427
440
|
src/models/EffectiveCertificateConfig.ts
|
|
428
441
|
src/models/EmailTemplateDefinition.ts
|
|
429
442
|
src/models/EmailTemplateScope.ts
|
|
@@ -548,6 +561,13 @@ src/models/GetZapierMe.ts
|
|
|
548
561
|
src/models/GetZapierSetup.ts
|
|
549
562
|
src/models/GetZapierShopifyCourseMappings.ts
|
|
550
563
|
src/models/GetZapierUsers.ts
|
|
564
|
+
src/models/IntegrationEvent.ts
|
|
565
|
+
src/models/IntegrationEventCertificate.ts
|
|
566
|
+
src/models/IntegrationEventCourse.ts
|
|
567
|
+
src/models/IntegrationEventData.ts
|
|
568
|
+
src/models/IntegrationEventEnrollment.ts
|
|
569
|
+
src/models/IntegrationEventLearner.ts
|
|
570
|
+
src/models/IntegrationEventPortal.ts
|
|
551
571
|
src/models/LearnerExperienceVersion.ts
|
|
552
572
|
src/models/LibraryQuizCriteriaPreviewQuestion.ts
|
|
553
573
|
src/models/LibraryQuizCriterion.ts
|
|
@@ -599,6 +619,7 @@ src/models/PostCourseVersionItemSession.ts
|
|
|
599
619
|
src/models/PostCourseVersionPublish.ts
|
|
600
620
|
src/models/PostCourseVersionSection.ts
|
|
601
621
|
src/models/PostCourseVersionSectionDuplicate.ts
|
|
622
|
+
src/models/PostCustomWebhookIntegration.ts
|
|
602
623
|
src/models/PostDuplicate.ts
|
|
603
624
|
src/models/PostEmailAssetComplete.ts
|
|
604
625
|
src/models/PostEmailAssetUpload.ts
|
|
@@ -645,6 +666,7 @@ src/models/PostZapierSetupResponse.ts
|
|
|
645
666
|
src/models/PostZapierShopifyCourseMapping.ts
|
|
646
667
|
src/models/PostZapierShopifyEnrollment.ts
|
|
647
668
|
src/models/PostZapierShopifyEnrollmentResponse.ts
|
|
669
|
+
src/models/PostZapierSubscription.ts
|
|
648
670
|
src/models/PostZapierUser.ts
|
|
649
671
|
src/models/ProgressionGateError.ts
|
|
650
672
|
src/models/ProgressionLockReason.ts
|
|
@@ -662,6 +684,7 @@ src/models/PutCourseVersionDraft.ts
|
|
|
662
684
|
src/models/PutCourseVersionItem.ts
|
|
663
685
|
src/models/PutCourseVersionOutlineEntryMove.ts
|
|
664
686
|
src/models/PutCourseVersionSection.ts
|
|
687
|
+
src/models/PutCustomWebhookIntegration.ts
|
|
665
688
|
src/models/PutEmailTemplateDraft.ts
|
|
666
689
|
src/models/PutLearnerExperienceDraft.ts
|
|
667
690
|
src/models/PutLibraryQuiz.ts
|
|
@@ -708,6 +731,7 @@ src/models/ZapierCourse.ts
|
|
|
708
731
|
src/models/ZapierEnrollment.ts
|
|
709
732
|
src/models/ZapierIntegration.ts
|
|
710
733
|
src/models/ZapierShopifyCourseMapping.ts
|
|
734
|
+
src/models/ZapierSubscription.ts
|
|
711
735
|
src/models/ZapierUser.ts
|
|
712
736
|
src/models/index.ts
|
|
713
737
|
src/runtime.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.117.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -273,17 +273,24 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
273
273
|
*EmailTemplateApi* | [**putSystemEmailAssetFile**](docs/EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image
|
|
274
274
|
*EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
|
|
275
275
|
*EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
|
|
276
|
+
*IntegrationApi* | [**deleteCustomWebhookIntegration**](docs/IntegrationApi.md#deletecustomwebhookintegration) | **DELETE** /integrations/webhooks/{webhookIntegrationId} | Delete a custom webhook destination
|
|
276
277
|
*IntegrationApi* | [**deleteZapierSetup**](docs/IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key
|
|
278
|
+
*IntegrationApi* | [**deleteZapierSubscription**](docs/IntegrationApi.md#deletezapiersubscription) | **DELETE** /integrations/zapier/subscriptions/{subscriptionId} | Unsubscribe a Zap from an Edaxu lifecycle event
|
|
279
|
+
*IntegrationApi* | [**getCustomWebhookIntegrations**](docs/IntegrationApi.md#getcustomwebhookintegrations) | **GET** /integrations/webhooks | List custom webhook destinations for the selected portal
|
|
277
280
|
*IntegrationApi* | [**getZapierCourses**](docs/IntegrationApi.md#getzapiercourses) | **GET** /integrations/zapier/courses | List published courses available to a Zapier connection
|
|
281
|
+
*IntegrationApi* | [**getZapierEvents**](docs/IntegrationApi.md#getzapierevents) | **GET** /integrations/zapier/events | List recent lifecycle events for Zapier trigger setup
|
|
278
282
|
*IntegrationApi* | [**getZapierMe**](docs/IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions
|
|
279
283
|
*IntegrationApi* | [**getZapierSetup**](docs/IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal
|
|
280
284
|
*IntegrationApi* | [**getZapierShopifyCourseMappings**](docs/IntegrationApi.md#getzapiershopifycoursemappings) | **GET** /integrations/zapier/shopify/course-mappings | List Shopify variant-to-course mappings
|
|
281
285
|
*IntegrationApi* | [**getZapierUsers**](docs/IntegrationApi.md#getzapierusers) | **GET** /integrations/zapier/users | Find a learner by exact email address
|
|
286
|
+
*IntegrationApi* | [**postCustomWebhookIntegration**](docs/IntegrationApi.md#postcustomwebhookintegration) | **POST** /integrations/webhooks | Create a custom webhook destination for lifecycle events
|
|
282
287
|
*IntegrationApi* | [**postZapierEnrollment**](docs/IntegrationApi.md#postzapierenrollment) | **POST** /integrations/zapier/enrollments | Enroll an existing learner in a course
|
|
283
288
|
*IntegrationApi* | [**postZapierSetup**](docs/IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal
|
|
284
289
|
*IntegrationApi* | [**postZapierShopifyCourseMapping**](docs/IntegrationApi.md#postzapiershopifycoursemapping) | **POST** /integrations/zapier/shopify/course-mappings | Create or update a Shopify variant-to-course mapping
|
|
285
290
|
*IntegrationApi* | [**postZapierShopifyEnrollment**](docs/IntegrationApi.md#postzapiershopifyenrollment) | **POST** /integrations/zapier/shopify/enrollments | Find or invite a Shopify customer and enroll them using the purchased variant mapping
|
|
291
|
+
*IntegrationApi* | [**postZapierSubscription**](docs/IntegrationApi.md#postzapiersubscription) | **POST** /integrations/zapier/subscriptions | Subscribe a Zap to an Edaxu lifecycle event
|
|
286
292
|
*IntegrationApi* | [**postZapierUser**](docs/IntegrationApi.md#postzapieruser) | **POST** /integrations/zapier/users | Find or invite a learner to the connected portal
|
|
293
|
+
*IntegrationApi* | [**putCustomWebhookIntegration**](docs/IntegrationApi.md#putcustomwebhookintegration) | **PUT** /integrations/webhooks/{webhookIntegrationId} | Update a custom webhook destination
|
|
287
294
|
*IntegrationApi* | [**putZapierSetup**](docs/IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions
|
|
288
295
|
*LearnerExperienceApi* | [**deleteLearnerExperienceDraft**](docs/LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft
|
|
289
296
|
*LearnerExperienceApi* | [**getCurrentLearnerDashboard**](docs/LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data
|
|
@@ -435,6 +442,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
435
442
|
- [CourseProgressionMode](docs/CourseProgressionMode.md)
|
|
436
443
|
- [CourseShare](docs/CourseShare.md)
|
|
437
444
|
- [CourseShareAcceptError](docs/CourseShareAcceptError.md)
|
|
445
|
+
- [CustomWebhookIntegration](docs/CustomWebhookIntegration.md)
|
|
438
446
|
- [EffectiveCertificateConfig](docs/EffectiveCertificateConfig.md)
|
|
439
447
|
- [EmailTemplateDefinition](docs/EmailTemplateDefinition.md)
|
|
440
448
|
- [EmailTemplateScope](docs/EmailTemplateScope.md)
|
|
@@ -559,6 +567,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
559
567
|
- [GetZapierSetup](docs/GetZapierSetup.md)
|
|
560
568
|
- [GetZapierShopifyCourseMappings](docs/GetZapierShopifyCourseMappings.md)
|
|
561
569
|
- [GetZapierUsers](docs/GetZapierUsers.md)
|
|
570
|
+
- [IntegrationEvent](docs/IntegrationEvent.md)
|
|
571
|
+
- [IntegrationEventCertificate](docs/IntegrationEventCertificate.md)
|
|
572
|
+
- [IntegrationEventCourse](docs/IntegrationEventCourse.md)
|
|
573
|
+
- [IntegrationEventData](docs/IntegrationEventData.md)
|
|
574
|
+
- [IntegrationEventEnrollment](docs/IntegrationEventEnrollment.md)
|
|
575
|
+
- [IntegrationEventLearner](docs/IntegrationEventLearner.md)
|
|
576
|
+
- [IntegrationEventPortal](docs/IntegrationEventPortal.md)
|
|
562
577
|
- [LearnerExperienceVersion](docs/LearnerExperienceVersion.md)
|
|
563
578
|
- [LibraryQuizCriteriaPreviewQuestion](docs/LibraryQuizCriteriaPreviewQuestion.md)
|
|
564
579
|
- [LibraryQuizCriterion](docs/LibraryQuizCriterion.md)
|
|
@@ -610,6 +625,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
610
625
|
- [PostCourseVersionPublish](docs/PostCourseVersionPublish.md)
|
|
611
626
|
- [PostCourseVersionSection](docs/PostCourseVersionSection.md)
|
|
612
627
|
- [PostCourseVersionSectionDuplicate](docs/PostCourseVersionSectionDuplicate.md)
|
|
628
|
+
- [PostCustomWebhookIntegration](docs/PostCustomWebhookIntegration.md)
|
|
613
629
|
- [PostDuplicate](docs/PostDuplicate.md)
|
|
614
630
|
- [PostEmailAssetComplete](docs/PostEmailAssetComplete.md)
|
|
615
631
|
- [PostEmailAssetUpload](docs/PostEmailAssetUpload.md)
|
|
@@ -656,6 +672,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
656
672
|
- [PostZapierShopifyCourseMapping](docs/PostZapierShopifyCourseMapping.md)
|
|
657
673
|
- [PostZapierShopifyEnrollment](docs/PostZapierShopifyEnrollment.md)
|
|
658
674
|
- [PostZapierShopifyEnrollmentResponse](docs/PostZapierShopifyEnrollmentResponse.md)
|
|
675
|
+
- [PostZapierSubscription](docs/PostZapierSubscription.md)
|
|
659
676
|
- [PostZapierUser](docs/PostZapierUser.md)
|
|
660
677
|
- [ProgressionGateError](docs/ProgressionGateError.md)
|
|
661
678
|
- [ProgressionLockReason](docs/ProgressionLockReason.md)
|
|
@@ -673,6 +690,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
673
690
|
- [PutCourseVersionItem](docs/PutCourseVersionItem.md)
|
|
674
691
|
- [PutCourseVersionOutlineEntryMove](docs/PutCourseVersionOutlineEntryMove.md)
|
|
675
692
|
- [PutCourseVersionSection](docs/PutCourseVersionSection.md)
|
|
693
|
+
- [PutCustomWebhookIntegration](docs/PutCustomWebhookIntegration.md)
|
|
676
694
|
- [PutEmailTemplateDraft](docs/PutEmailTemplateDraft.md)
|
|
677
695
|
- [PutLearnerExperienceDraft](docs/PutLearnerExperienceDraft.md)
|
|
678
696
|
- [PutLibraryQuiz](docs/PutLibraryQuiz.md)
|
|
@@ -719,6 +737,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
719
737
|
- [ZapierEnrollment](docs/ZapierEnrollment.md)
|
|
720
738
|
- [ZapierIntegration](docs/ZapierIntegration.md)
|
|
721
739
|
- [ZapierShopifyCourseMapping](docs/ZapierShopifyCourseMapping.md)
|
|
740
|
+
- [ZapierSubscription](docs/ZapierSubscription.md)
|
|
722
741
|
- [ZapierUser](docs/ZapierUser.md)
|
|
723
742
|
|
|
724
743
|
### Authorization
|
|
@@ -733,7 +752,7 @@ and is automatically generated by the
|
|
|
733
752
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
734
753
|
|
|
735
754
|
- API version: `1.0.0`
|
|
736
|
-
- Package version: `1.
|
|
755
|
+
- Package version: `1.117.0`
|
|
737
756
|
- Generator version: `7.22.0`
|
|
738
757
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
739
758
|
|
|
@@ -10,26 +10,40 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
+
import { type CustomWebhookIntegration } from '../models/CustomWebhookIntegration';
|
|
13
14
|
import { type GetZapierCourses } from '../models/GetZapierCourses';
|
|
14
15
|
import { type GetZapierMe } from '../models/GetZapierMe';
|
|
15
16
|
import { type GetZapierSetup } from '../models/GetZapierSetup';
|
|
16
17
|
import { type GetZapierShopifyCourseMappings } from '../models/GetZapierShopifyCourseMappings';
|
|
17
18
|
import { type GetZapierUsers } from '../models/GetZapierUsers';
|
|
19
|
+
import { type IntegrationEvent } from '../models/IntegrationEvent';
|
|
20
|
+
import { type PostCustomWebhookIntegration } from '../models/PostCustomWebhookIntegration';
|
|
18
21
|
import { type PostZapierEnrollment } from '../models/PostZapierEnrollment';
|
|
19
22
|
import { type PostZapierSetup } from '../models/PostZapierSetup';
|
|
20
23
|
import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
|
|
21
24
|
import { type PostZapierShopifyCourseMapping } from '../models/PostZapierShopifyCourseMapping';
|
|
22
25
|
import { type PostZapierShopifyEnrollment } from '../models/PostZapierShopifyEnrollment';
|
|
23
26
|
import { type PostZapierShopifyEnrollmentResponse } from '../models/PostZapierShopifyEnrollmentResponse';
|
|
27
|
+
import { type PostZapierSubscription } from '../models/PostZapierSubscription';
|
|
24
28
|
import { type PostZapierUser } from '../models/PostZapierUser';
|
|
29
|
+
import { type PutCustomWebhookIntegration } from '../models/PutCustomWebhookIntegration';
|
|
25
30
|
import { type PutZapierSetup } from '../models/PutZapierSetup';
|
|
26
31
|
import { type ZapierEnrollment } from '../models/ZapierEnrollment';
|
|
27
32
|
import { type ZapierIntegration } from '../models/ZapierIntegration';
|
|
28
33
|
import { type ZapierShopifyCourseMapping } from '../models/ZapierShopifyCourseMapping';
|
|
34
|
+
import { type ZapierSubscription } from '../models/ZapierSubscription';
|
|
29
35
|
import { type ZapierUser } from '../models/ZapierUser';
|
|
36
|
+
export interface DeleteCustomWebhookIntegrationRequest {
|
|
37
|
+
webhookIntegrationId: string;
|
|
38
|
+
}
|
|
30
39
|
export interface DeleteZapierSetupRequest {
|
|
31
40
|
zapierIntegrationId: string;
|
|
32
41
|
}
|
|
42
|
+
export interface DeleteZapierSubscriptionRequest {
|
|
43
|
+
subscriptionId: string;
|
|
44
|
+
xAPIKEY: string;
|
|
45
|
+
xPORTALSUBDOMAIN: string;
|
|
46
|
+
}
|
|
33
47
|
export interface GetZapierCoursesRequest {
|
|
34
48
|
xAPIKEY: string;
|
|
35
49
|
xPORTALSUBDOMAIN: string;
|
|
@@ -37,6 +51,12 @@ export interface GetZapierCoursesRequest {
|
|
|
37
51
|
pageSize?: number;
|
|
38
52
|
search?: string;
|
|
39
53
|
}
|
|
54
|
+
export interface GetZapierEventsRequest {
|
|
55
|
+
xAPIKEY: string;
|
|
56
|
+
xPORTALSUBDOMAIN: string;
|
|
57
|
+
eventType: GetZapierEventsEventTypeEnum;
|
|
58
|
+
pageSize?: number;
|
|
59
|
+
}
|
|
40
60
|
export interface GetZapierMeRequest {
|
|
41
61
|
xAPIKEY: string;
|
|
42
62
|
xPORTALSUBDOMAIN: string;
|
|
@@ -51,6 +71,9 @@ export interface GetZapierUsersRequest {
|
|
|
51
71
|
xPORTALSUBDOMAIN: string;
|
|
52
72
|
email: string;
|
|
53
73
|
}
|
|
74
|
+
export interface PostCustomWebhookIntegrationRequest {
|
|
75
|
+
postCustomWebhookIntegration: PostCustomWebhookIntegration;
|
|
76
|
+
}
|
|
54
77
|
export interface PostZapierEnrollmentRequest {
|
|
55
78
|
xAPIKEY: string;
|
|
56
79
|
xPORTALSUBDOMAIN: string;
|
|
@@ -69,11 +92,20 @@ export interface PostZapierShopifyEnrollmentRequest {
|
|
|
69
92
|
xPORTALSUBDOMAIN: string;
|
|
70
93
|
postZapierShopifyEnrollment: PostZapierShopifyEnrollment;
|
|
71
94
|
}
|
|
95
|
+
export interface PostZapierSubscriptionRequest {
|
|
96
|
+
xAPIKEY: string;
|
|
97
|
+
xPORTALSUBDOMAIN: string;
|
|
98
|
+
postZapierSubscription: PostZapierSubscription;
|
|
99
|
+
}
|
|
72
100
|
export interface PostZapierUserRequest {
|
|
73
101
|
xAPIKEY: string;
|
|
74
102
|
xPORTALSUBDOMAIN: string;
|
|
75
103
|
postZapierUser: PostZapierUser;
|
|
76
104
|
}
|
|
105
|
+
export interface PutCustomWebhookIntegrationRequest {
|
|
106
|
+
webhookIntegrationId: string;
|
|
107
|
+
putCustomWebhookIntegration: PutCustomWebhookIntegration;
|
|
108
|
+
}
|
|
77
109
|
export interface PutZapierSetupRequest {
|
|
78
110
|
zapierIntegrationId: string;
|
|
79
111
|
putZapierSetup: PutZapierSetup;
|
|
@@ -82,6 +114,18 @@ export interface PutZapierSetupRequest {
|
|
|
82
114
|
*
|
|
83
115
|
*/
|
|
84
116
|
export declare class IntegrationApi extends runtime.BaseAPI {
|
|
117
|
+
/**
|
|
118
|
+
* Creates request options for deleteCustomWebhookIntegration without sending the request
|
|
119
|
+
*/
|
|
120
|
+
deleteCustomWebhookIntegrationRequestOpts(requestParameters: DeleteCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
|
|
121
|
+
/**
|
|
122
|
+
* Delete a custom webhook destination
|
|
123
|
+
*/
|
|
124
|
+
deleteCustomWebhookIntegrationRaw(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
125
|
+
/**
|
|
126
|
+
* Delete a custom webhook destination
|
|
127
|
+
*/
|
|
128
|
+
deleteCustomWebhookIntegration(requestParameters: DeleteCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
85
129
|
/**
|
|
86
130
|
* Creates request options for deleteZapierSetup without sending the request
|
|
87
131
|
*/
|
|
@@ -94,6 +138,30 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
94
138
|
* Revoke a Zapier connection and its API key
|
|
95
139
|
*/
|
|
96
140
|
deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
141
|
+
/**
|
|
142
|
+
* Creates request options for deleteZapierSubscription without sending the request
|
|
143
|
+
*/
|
|
144
|
+
deleteZapierSubscriptionRequestOpts(requestParameters: DeleteZapierSubscriptionRequest): Promise<runtime.RequestOpts>;
|
|
145
|
+
/**
|
|
146
|
+
* Unsubscribe a Zap from an Edaxu lifecycle event
|
|
147
|
+
*/
|
|
148
|
+
deleteZapierSubscriptionRaw(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
149
|
+
/**
|
|
150
|
+
* Unsubscribe a Zap from an Edaxu lifecycle event
|
|
151
|
+
*/
|
|
152
|
+
deleteZapierSubscription(requestParameters: DeleteZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
153
|
+
/**
|
|
154
|
+
* Creates request options for getCustomWebhookIntegrations without sending the request
|
|
155
|
+
*/
|
|
156
|
+
getCustomWebhookIntegrationsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
157
|
+
/**
|
|
158
|
+
* List custom webhook destinations for the selected portal
|
|
159
|
+
*/
|
|
160
|
+
getCustomWebhookIntegrationsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomWebhookIntegration>>>;
|
|
161
|
+
/**
|
|
162
|
+
* List custom webhook destinations for the selected portal
|
|
163
|
+
*/
|
|
164
|
+
getCustomWebhookIntegrations(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomWebhookIntegration>>;
|
|
97
165
|
/**
|
|
98
166
|
* Creates request options for getZapierCourses without sending the request
|
|
99
167
|
*/
|
|
@@ -106,6 +174,18 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
106
174
|
* List published courses available to a Zapier connection
|
|
107
175
|
*/
|
|
108
176
|
getZapierCourses(requestParameters: GetZapierCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierCourses>;
|
|
177
|
+
/**
|
|
178
|
+
* Creates request options for getZapierEvents without sending the request
|
|
179
|
+
*/
|
|
180
|
+
getZapierEventsRequestOpts(requestParameters: GetZapierEventsRequest): Promise<runtime.RequestOpts>;
|
|
181
|
+
/**
|
|
182
|
+
* List recent lifecycle events for Zapier trigger setup
|
|
183
|
+
*/
|
|
184
|
+
getZapierEventsRaw(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IntegrationEvent>>>;
|
|
185
|
+
/**
|
|
186
|
+
* List recent lifecycle events for Zapier trigger setup
|
|
187
|
+
*/
|
|
188
|
+
getZapierEvents(requestParameters: GetZapierEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IntegrationEvent>>;
|
|
109
189
|
/**
|
|
110
190
|
* Creates request options for getZapierMe without sending the request
|
|
111
191
|
*/
|
|
@@ -154,6 +234,18 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
154
234
|
* Find a learner by exact email address
|
|
155
235
|
*/
|
|
156
236
|
getZapierUsers(requestParameters: GetZapierUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierUsers>;
|
|
237
|
+
/**
|
|
238
|
+
* Creates request options for postCustomWebhookIntegration without sending the request
|
|
239
|
+
*/
|
|
240
|
+
postCustomWebhookIntegrationRequestOpts(requestParameters: PostCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
|
|
241
|
+
/**
|
|
242
|
+
* Create a custom webhook destination for lifecycle events
|
|
243
|
+
*/
|
|
244
|
+
postCustomWebhookIntegrationRaw(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>>;
|
|
245
|
+
/**
|
|
246
|
+
* Create a custom webhook destination for lifecycle events
|
|
247
|
+
*/
|
|
248
|
+
postCustomWebhookIntegration(requestParameters: PostCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration>;
|
|
157
249
|
/**
|
|
158
250
|
* Creates request options for postZapierEnrollment without sending the request
|
|
159
251
|
*/
|
|
@@ -202,6 +294,18 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
202
294
|
* Find or invite a Shopify customer and enroll them using the purchased variant mapping
|
|
203
295
|
*/
|
|
204
296
|
postZapierShopifyEnrollment(requestParameters: PostZapierShopifyEnrollmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierShopifyEnrollmentResponse>;
|
|
297
|
+
/**
|
|
298
|
+
* Creates request options for postZapierSubscription without sending the request
|
|
299
|
+
*/
|
|
300
|
+
postZapierSubscriptionRequestOpts(requestParameters: PostZapierSubscriptionRequest): Promise<runtime.RequestOpts>;
|
|
301
|
+
/**
|
|
302
|
+
* Subscribe a Zap to an Edaxu lifecycle event
|
|
303
|
+
*/
|
|
304
|
+
postZapierSubscriptionRaw(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierSubscription>>;
|
|
305
|
+
/**
|
|
306
|
+
* Subscribe a Zap to an Edaxu lifecycle event
|
|
307
|
+
*/
|
|
308
|
+
postZapierSubscription(requestParameters: PostZapierSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierSubscription>;
|
|
205
309
|
/**
|
|
206
310
|
* Creates request options for postZapierUser without sending the request
|
|
207
311
|
*/
|
|
@@ -214,6 +318,18 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
214
318
|
* Find or invite a learner to the connected portal
|
|
215
319
|
*/
|
|
216
320
|
postZapierUser(requestParameters: PostZapierUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierUser>;
|
|
321
|
+
/**
|
|
322
|
+
* Creates request options for putCustomWebhookIntegration without sending the request
|
|
323
|
+
*/
|
|
324
|
+
putCustomWebhookIntegrationRequestOpts(requestParameters: PutCustomWebhookIntegrationRequest): Promise<runtime.RequestOpts>;
|
|
325
|
+
/**
|
|
326
|
+
* Update a custom webhook destination
|
|
327
|
+
*/
|
|
328
|
+
putCustomWebhookIntegrationRaw(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomWebhookIntegration>>;
|
|
329
|
+
/**
|
|
330
|
+
* Update a custom webhook destination
|
|
331
|
+
*/
|
|
332
|
+
putCustomWebhookIntegration(requestParameters: PutCustomWebhookIntegrationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomWebhookIntegration>;
|
|
217
333
|
/**
|
|
218
334
|
* Creates request options for putZapierSetup without sending the request
|
|
219
335
|
*/
|
|
@@ -227,3 +343,12 @@ export declare class IntegrationApi extends runtime.BaseAPI {
|
|
|
227
343
|
*/
|
|
228
344
|
putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
|
|
229
345
|
}
|
|
346
|
+
/**
|
|
347
|
+
* @export
|
|
348
|
+
*/
|
|
349
|
+
export declare const GetZapierEventsEventTypeEnum: {
|
|
350
|
+
readonly ComEdaxuEnrollmentEnrolledV1: "com.edaxu.enrollment.enrolled.v1";
|
|
351
|
+
readonly ComEdaxuEnrollmentCompletedV1: "com.edaxu.enrollment.completed.v1";
|
|
352
|
+
readonly ComEdaxuCertificateIssuedV1: "com.edaxu.certificate.issued.v1";
|
|
353
|
+
};
|
|
354
|
+
export type GetZapierEventsEventTypeEnum = typeof GetZapierEventsEventTypeEnum[keyof typeof GetZapierEventsEventTypeEnum];
|