@easyedu/js-lsm-api 1.113.0 → 1.115.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 +16 -0
- package/README.md +14 -2
- package/dist/apis/IntegrationApi.d.ts +97 -0
- package/dist/apis/IntegrationApi.js +242 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/IntegrationApi.d.ts +97 -0
- package/dist/esm/apis/IntegrationApi.js +238 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ChatFeatureUsage.d.ts +47 -0
- package/dist/esm/models/ChatFeatureUsage.js +55 -0
- package/dist/esm/models/GetChatUsage.d.ts +7 -0
- package/dist/esm/models/GetChatUsage.js +5 -0
- package/dist/esm/models/GetZapierMe.d.ts +62 -0
- package/dist/esm/models/GetZapierMe.js +63 -0
- package/dist/esm/models/GetZapierSetup.d.ts +40 -0
- package/dist/esm/models/GetZapierSetup.js +49 -0
- package/dist/esm/models/PostZapierSetup.d.ts +38 -0
- package/dist/esm/models/PostZapierSetup.js +47 -0
- package/dist/esm/models/PostZapierSetupResponse.d.ts +39 -0
- package/dist/esm/models/PostZapierSetupResponse.js +48 -0
- package/dist/esm/models/PutZapierSetup.d.ts +38 -0
- package/dist/esm/models/PutZapierSetup.js +43 -0
- package/dist/esm/models/ZapierIntegration.d.ts +92 -0
- package/dist/esm/models/ZapierIntegration.js +79 -0
- package/dist/esm/models/index.d.ts +7 -0
- package/dist/esm/models/index.js +7 -0
- package/dist/models/ChatFeatureUsage.d.ts +47 -0
- package/dist/models/ChatFeatureUsage.js +63 -0
- package/dist/models/GetChatUsage.d.ts +7 -0
- package/dist/models/GetChatUsage.js +5 -0
- package/dist/models/GetZapierMe.d.ts +62 -0
- package/dist/models/GetZapierMe.js +70 -0
- package/dist/models/GetZapierSetup.d.ts +40 -0
- package/dist/models/GetZapierSetup.js +56 -0
- package/dist/models/PostZapierSetup.d.ts +38 -0
- package/dist/models/PostZapierSetup.js +54 -0
- package/dist/models/PostZapierSetupResponse.d.ts +39 -0
- package/dist/models/PostZapierSetupResponse.js +55 -0
- package/dist/models/PutZapierSetup.d.ts +38 -0
- package/dist/models/PutZapierSetup.js +50 -0
- package/dist/models/ZapierIntegration.d.ts +92 -0
- package/dist/models/ZapierIntegration.js +86 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/docs/ChatFeatureUsage.md +36 -0
- package/docs/GetChatUsage.md +2 -0
- package/docs/GetZapierMe.md +44 -0
- package/docs/GetZapierSetup.md +36 -0
- package/docs/IntegrationApi.md +346 -0
- package/docs/PostZapierSetup.md +36 -0
- package/docs/PostZapierSetupResponse.md +37 -0
- package/docs/PutZapierSetup.md +36 -0
- package/docs/ZapierIntegration.md +55 -0
- package/package.json +1 -1
- package/src/apis/IntegrationApi.ts +312 -0
- package/src/apis/index.ts +1 -0
- package/src/models/ChatFeatureUsage.ts +94 -0
- package/src/models/GetChatUsage.ts +16 -0
- package/src/models/GetZapierMe.ts +111 -0
- package/src/models/GetZapierSetup.ts +90 -0
- package/src/models/PostZapierSetup.ts +75 -0
- package/src/models/PostZapierSetupResponse.ts +83 -0
- package/src/models/PutZapierSetup.ts +73 -0
- package/src/models/ZapierIntegration.ts +154 -0
- package/src/models/index.ts +7 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -33,6 +33,7 @@ docs/CertificateTemplateVersion.md
|
|
|
33
33
|
docs/ChangelogApi.md
|
|
34
34
|
docs/ChatApi.md
|
|
35
35
|
docs/ChatDailyUsage.md
|
|
36
|
+
docs/ChatFeatureUsage.md
|
|
36
37
|
docs/ChatModelUsage.md
|
|
37
38
|
docs/ChatQuota.md
|
|
38
39
|
docs/ChatQuotaExceeded.md
|
|
@@ -173,6 +174,9 @@ docs/GetUserCourseListItemCourse.md
|
|
|
173
174
|
docs/GetUserCourseListItemEnrollment.md
|
|
174
175
|
docs/GetUserCourseListItemProgress.md
|
|
175
176
|
docs/GetUserRole.md
|
|
177
|
+
docs/GetZapierMe.md
|
|
178
|
+
docs/GetZapierSetup.md
|
|
179
|
+
docs/IntegrationApi.md
|
|
176
180
|
docs/LearnerExperienceApi.md
|
|
177
181
|
docs/LearnerExperienceVersion.md
|
|
178
182
|
docs/LibraryQuizCriteriaPreviewQuestion.md
|
|
@@ -269,6 +273,8 @@ docs/PostSignupRequest.md
|
|
|
269
273
|
docs/PostSignupRequestResponse.md
|
|
270
274
|
docs/PostSupportTicket.md
|
|
271
275
|
docs/PostSupportTicketComment.md
|
|
276
|
+
docs/PostZapierSetup.md
|
|
277
|
+
docs/PostZapierSetupResponse.md
|
|
272
278
|
docs/ProgressionGateError.md
|
|
273
279
|
docs/ProgressionLockReason.md
|
|
274
280
|
docs/PutAttemptAllowance.md
|
|
@@ -306,6 +312,7 @@ docs/PutRole.md
|
|
|
306
312
|
docs/PutRolePermissions.md
|
|
307
313
|
docs/PutSupportTicket.md
|
|
308
314
|
docs/PutUser.md
|
|
315
|
+
docs/PutZapierSetup.md
|
|
309
316
|
docs/QuestionApi.md
|
|
310
317
|
docs/QuestionImportApi.md
|
|
311
318
|
docs/QuestionImportCommitResult.md
|
|
@@ -334,6 +341,7 @@ docs/UpdateSelectedPortalResponse.md
|
|
|
334
341
|
docs/UpdateSelectedPortalResponseHostPortal.md
|
|
335
342
|
docs/UpdateSelectedPortalResponseSelectedPortal.md
|
|
336
343
|
docs/UserApi.md
|
|
344
|
+
docs/ZapierIntegration.md
|
|
337
345
|
package.json
|
|
338
346
|
src/apis/CertificateApi.ts
|
|
339
347
|
src/apis/CertificateTemplateApi.ts
|
|
@@ -346,6 +354,7 @@ src/apis/CourseCatalogApi.ts
|
|
|
346
354
|
src/apis/CourseShareApi.ts
|
|
347
355
|
src/apis/DispatchApi.ts
|
|
348
356
|
src/apis/EmailTemplateApi.ts
|
|
357
|
+
src/apis/IntegrationApi.ts
|
|
349
358
|
src/apis/LearnerExperienceApi.ts
|
|
350
359
|
src/apis/OtherApi.ts
|
|
351
360
|
src/apis/PlayerApi.ts
|
|
@@ -388,6 +397,7 @@ src/models/CertificateRenewalPolicy.ts
|
|
|
388
397
|
src/models/CertificateTemplate.ts
|
|
389
398
|
src/models/CertificateTemplateVersion.ts
|
|
390
399
|
src/models/ChatDailyUsage.ts
|
|
400
|
+
src/models/ChatFeatureUsage.ts
|
|
391
401
|
src/models/ChatModelUsage.ts
|
|
392
402
|
src/models/ChatQuota.ts
|
|
393
403
|
src/models/ChatQuotaExceeded.ts
|
|
@@ -521,6 +531,8 @@ src/models/GetUserCourseListItemCourse.ts
|
|
|
521
531
|
src/models/GetUserCourseListItemEnrollment.ts
|
|
522
532
|
src/models/GetUserCourseListItemProgress.ts
|
|
523
533
|
src/models/GetUserRole.ts
|
|
534
|
+
src/models/GetZapierMe.ts
|
|
535
|
+
src/models/GetZapierSetup.ts
|
|
524
536
|
src/models/LearnerExperienceVersion.ts
|
|
525
537
|
src/models/LibraryQuizCriteriaPreviewQuestion.ts
|
|
526
538
|
src/models/LibraryQuizCriterion.ts
|
|
@@ -612,6 +624,8 @@ src/models/PostSignupRequest.ts
|
|
|
612
624
|
src/models/PostSignupRequestResponse.ts
|
|
613
625
|
src/models/PostSupportTicket.ts
|
|
614
626
|
src/models/PostSupportTicketComment.ts
|
|
627
|
+
src/models/PostZapierSetup.ts
|
|
628
|
+
src/models/PostZapierSetupResponse.ts
|
|
615
629
|
src/models/ProgressionGateError.ts
|
|
616
630
|
src/models/ProgressionLockReason.ts
|
|
617
631
|
src/models/PutAttemptAllowance.ts
|
|
@@ -649,6 +663,7 @@ src/models/PutRole.ts
|
|
|
649
663
|
src/models/PutRolePermissions.ts
|
|
650
664
|
src/models/PutSupportTicket.ts
|
|
651
665
|
src/models/PutUser.ts
|
|
666
|
+
src/models/PutZapierSetup.ts
|
|
652
667
|
src/models/QuestionImportCommitResult.ts
|
|
653
668
|
src/models/QuestionImportDraft.ts
|
|
654
669
|
src/models/QuestionImportDuplicate.ts
|
|
@@ -669,6 +684,7 @@ src/models/SupportTicketUser.ts
|
|
|
669
684
|
src/models/UpdateSelectedPortalResponse.ts
|
|
670
685
|
src/models/UpdateSelectedPortalResponseHostPortal.ts
|
|
671
686
|
src/models/UpdateSelectedPortalResponseSelectedPortal.ts
|
|
687
|
+
src/models/ZapierIntegration.ts
|
|
672
688
|
src/models/index.ts
|
|
673
689
|
src/runtime.ts
|
|
674
690
|
tsconfig.esm.json
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @easyedu/js-lsm-api@1.
|
|
1
|
+
# @easyedu/js-lsm-api@1.115.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
|
|
4
4
|
|
|
@@ -273,6 +273,11 @@ 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* | [**deleteZapierSetup**](docs/IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key
|
|
277
|
+
*IntegrationApi* | [**getZapierMe**](docs/IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions
|
|
278
|
+
*IntegrationApi* | [**getZapierSetup**](docs/IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal
|
|
279
|
+
*IntegrationApi* | [**postZapierSetup**](docs/IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal
|
|
280
|
+
*IntegrationApi* | [**putZapierSetup**](docs/IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions
|
|
276
281
|
*LearnerExperienceApi* | [**deleteLearnerExperienceDraft**](docs/LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft
|
|
277
282
|
*LearnerExperienceApi* | [**getCurrentLearnerDashboard**](docs/LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data
|
|
278
283
|
*LearnerExperienceApi* | [**getEffectiveLearnerExperience**](docs/LearnerExperienceApi.md#geteffectivelearnerexperience) | **GET** /learner-experience/effective | Get the effective published learner experience for the authenticated user
|
|
@@ -408,6 +413,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
408
413
|
- [CertificateTemplate](docs/CertificateTemplate.md)
|
|
409
414
|
- [CertificateTemplateVersion](docs/CertificateTemplateVersion.md)
|
|
410
415
|
- [ChatDailyUsage](docs/ChatDailyUsage.md)
|
|
416
|
+
- [ChatFeatureUsage](docs/ChatFeatureUsage.md)
|
|
411
417
|
- [ChatModelUsage](docs/ChatModelUsage.md)
|
|
412
418
|
- [ChatQuota](docs/ChatQuota.md)
|
|
413
419
|
- [ChatQuotaExceeded](docs/ChatQuotaExceeded.md)
|
|
@@ -541,6 +547,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
541
547
|
- [GetUserCourseListItemEnrollment](docs/GetUserCourseListItemEnrollment.md)
|
|
542
548
|
- [GetUserCourseListItemProgress](docs/GetUserCourseListItemProgress.md)
|
|
543
549
|
- [GetUserRole](docs/GetUserRole.md)
|
|
550
|
+
- [GetZapierMe](docs/GetZapierMe.md)
|
|
551
|
+
- [GetZapierSetup](docs/GetZapierSetup.md)
|
|
544
552
|
- [LearnerExperienceVersion](docs/LearnerExperienceVersion.md)
|
|
545
553
|
- [LibraryQuizCriteriaPreviewQuestion](docs/LibraryQuizCriteriaPreviewQuestion.md)
|
|
546
554
|
- [LibraryQuizCriterion](docs/LibraryQuizCriterion.md)
|
|
@@ -632,6 +640,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
632
640
|
- [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
|
|
633
641
|
- [PostSupportTicket](docs/PostSupportTicket.md)
|
|
634
642
|
- [PostSupportTicketComment](docs/PostSupportTicketComment.md)
|
|
643
|
+
- [PostZapierSetup](docs/PostZapierSetup.md)
|
|
644
|
+
- [PostZapierSetupResponse](docs/PostZapierSetupResponse.md)
|
|
635
645
|
- [ProgressionGateError](docs/ProgressionGateError.md)
|
|
636
646
|
- [ProgressionLockReason](docs/ProgressionLockReason.md)
|
|
637
647
|
- [PutAttemptAllowance](docs/PutAttemptAllowance.md)
|
|
@@ -669,6 +679,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
669
679
|
- [PutRolePermissions](docs/PutRolePermissions.md)
|
|
670
680
|
- [PutSupportTicket](docs/PutSupportTicket.md)
|
|
671
681
|
- [PutUser](docs/PutUser.md)
|
|
682
|
+
- [PutZapierSetup](docs/PutZapierSetup.md)
|
|
672
683
|
- [QuestionImportCommitResult](docs/QuestionImportCommitResult.md)
|
|
673
684
|
- [QuestionImportDraft](docs/QuestionImportDraft.md)
|
|
674
685
|
- [QuestionImportDuplicate](docs/QuestionImportDuplicate.md)
|
|
@@ -689,6 +700,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
689
700
|
- [UpdateSelectedPortalResponse](docs/UpdateSelectedPortalResponse.md)
|
|
690
701
|
- [UpdateSelectedPortalResponseHostPortal](docs/UpdateSelectedPortalResponseHostPortal.md)
|
|
691
702
|
- [UpdateSelectedPortalResponseSelectedPortal](docs/UpdateSelectedPortalResponseSelectedPortal.md)
|
|
703
|
+
- [ZapierIntegration](docs/ZapierIntegration.md)
|
|
692
704
|
|
|
693
705
|
### Authorization
|
|
694
706
|
|
|
@@ -702,7 +714,7 @@ and is automatically generated by the
|
|
|
702
714
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
703
715
|
|
|
704
716
|
- API version: `1.0.0`
|
|
705
|
-
- Package version: `1.
|
|
717
|
+
- Package version: `1.115.0`
|
|
706
718
|
- Generator version: `7.22.0`
|
|
707
719
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
708
720
|
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type GetZapierMe } from '../models/GetZapierMe';
|
|
14
|
+
import { type GetZapierSetup } from '../models/GetZapierSetup';
|
|
15
|
+
import { type PostZapierSetup } from '../models/PostZapierSetup';
|
|
16
|
+
import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
|
|
17
|
+
import { type PutZapierSetup } from '../models/PutZapierSetup';
|
|
18
|
+
import { type ZapierIntegration } from '../models/ZapierIntegration';
|
|
19
|
+
export interface DeleteZapierSetupRequest {
|
|
20
|
+
zapierIntegrationId: string;
|
|
21
|
+
}
|
|
22
|
+
export interface GetZapierMeRequest {
|
|
23
|
+
xAPIKEY: string;
|
|
24
|
+
xPORTALSUBDOMAIN: string;
|
|
25
|
+
}
|
|
26
|
+
export interface PostZapierSetupRequest {
|
|
27
|
+
postZapierSetup: PostZapierSetup;
|
|
28
|
+
}
|
|
29
|
+
export interface PutZapierSetupRequest {
|
|
30
|
+
zapierIntegrationId: string;
|
|
31
|
+
putZapierSetup: PutZapierSetup;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class IntegrationApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for deleteZapierSetup without sending the request
|
|
39
|
+
*/
|
|
40
|
+
deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
41
|
+
/**
|
|
42
|
+
* Revoke a Zapier connection and its API key
|
|
43
|
+
*/
|
|
44
|
+
deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
45
|
+
/**
|
|
46
|
+
* Revoke a Zapier connection and its API key
|
|
47
|
+
*/
|
|
48
|
+
deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for getZapierMe without sending the request
|
|
51
|
+
*/
|
|
52
|
+
getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
55
|
+
*/
|
|
56
|
+
getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>>;
|
|
57
|
+
/**
|
|
58
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
59
|
+
*/
|
|
60
|
+
getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates request options for getZapierSetup without sending the request
|
|
63
|
+
*/
|
|
64
|
+
getZapierSetupRequestOpts(): Promise<runtime.RequestOpts>;
|
|
65
|
+
/**
|
|
66
|
+
* List Zapier connections and permissions available to the selected portal
|
|
67
|
+
*/
|
|
68
|
+
getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>>;
|
|
69
|
+
/**
|
|
70
|
+
* List Zapier connections and permissions available to the selected portal
|
|
71
|
+
*/
|
|
72
|
+
getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for postZapierSetup without sending the request
|
|
75
|
+
*/
|
|
76
|
+
postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* Create a Zapier connection and API key for the selected portal
|
|
79
|
+
*/
|
|
80
|
+
postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>>;
|
|
81
|
+
/**
|
|
82
|
+
* Create a Zapier connection and API key for the selected portal
|
|
83
|
+
*/
|
|
84
|
+
postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates request options for putZapierSetup without sending the request
|
|
87
|
+
*/
|
|
88
|
+
putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
89
|
+
/**
|
|
90
|
+
* Update a Zapier connection\'s name or permissions
|
|
91
|
+
*/
|
|
92
|
+
putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>>;
|
|
93
|
+
/**
|
|
94
|
+
* Update a Zapier connection\'s name or permissions
|
|
95
|
+
*/
|
|
96
|
+
putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
|
|
97
|
+
}
|
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* LMS API
|
|
6
|
+
* LMS API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.IntegrationApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const GetZapierMe_1 = require("../models/GetZapierMe");
|
|
28
|
+
const GetZapierSetup_1 = require("../models/GetZapierSetup");
|
|
29
|
+
const PostZapierSetup_1 = require("../models/PostZapierSetup");
|
|
30
|
+
const PostZapierSetupResponse_1 = require("../models/PostZapierSetupResponse");
|
|
31
|
+
const PutZapierSetup_1 = require("../models/PutZapierSetup");
|
|
32
|
+
const ZapierIntegration_1 = require("../models/ZapierIntegration");
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
class IntegrationApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for deleteZapierSetup without sending the request
|
|
39
|
+
*/
|
|
40
|
+
deleteZapierSetupRequestOpts(requestParameters) {
|
|
41
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
42
|
+
if (requestParameters['zapierIntegrationId'] == null) {
|
|
43
|
+
throw new runtime.RequiredError('zapierIntegrationId', 'Required parameter "zapierIntegrationId" was null or undefined when calling deleteZapierSetup().');
|
|
44
|
+
}
|
|
45
|
+
const queryParameters = {};
|
|
46
|
+
const headerParameters = {};
|
|
47
|
+
let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
|
|
48
|
+
urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
|
|
49
|
+
return {
|
|
50
|
+
path: urlPath,
|
|
51
|
+
method: 'DELETE',
|
|
52
|
+
headers: headerParameters,
|
|
53
|
+
query: queryParameters,
|
|
54
|
+
};
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Revoke a Zapier connection and its API key
|
|
59
|
+
*/
|
|
60
|
+
deleteZapierSetupRaw(requestParameters, initOverrides) {
|
|
61
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
+
const requestOptions = yield this.deleteZapierSetupRequestOpts(requestParameters);
|
|
63
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
64
|
+
return new runtime.VoidApiResponse(response);
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Revoke a Zapier connection and its API key
|
|
69
|
+
*/
|
|
70
|
+
deleteZapierSetup(requestParameters, initOverrides) {
|
|
71
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
72
|
+
yield this.deleteZapierSetupRaw(requestParameters, initOverrides);
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* Creates request options for getZapierMe without sending the request
|
|
77
|
+
*/
|
|
78
|
+
getZapierMeRequestOpts(requestParameters) {
|
|
79
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
80
|
+
if (requestParameters['xAPIKEY'] == null) {
|
|
81
|
+
throw new runtime.RequiredError('xAPIKEY', 'Required parameter "xAPIKEY" was null or undefined when calling getZapierMe().');
|
|
82
|
+
}
|
|
83
|
+
if (requestParameters['xPORTALSUBDOMAIN'] == null) {
|
|
84
|
+
throw new runtime.RequiredError('xPORTALSUBDOMAIN', 'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierMe().');
|
|
85
|
+
}
|
|
86
|
+
const queryParameters = {};
|
|
87
|
+
const headerParameters = {};
|
|
88
|
+
if (requestParameters['xAPIKEY'] != null) {
|
|
89
|
+
headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
|
|
90
|
+
}
|
|
91
|
+
if (requestParameters['xPORTALSUBDOMAIN'] != null) {
|
|
92
|
+
headerParameters['X-PORTAL-SUBDOMAIN'] = String(requestParameters['xPORTALSUBDOMAIN']);
|
|
93
|
+
}
|
|
94
|
+
let urlPath = `/integrations/zapier/me`;
|
|
95
|
+
return {
|
|
96
|
+
path: urlPath,
|
|
97
|
+
method: 'GET',
|
|
98
|
+
headers: headerParameters,
|
|
99
|
+
query: queryParameters,
|
|
100
|
+
};
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
105
|
+
*/
|
|
106
|
+
getZapierMeRaw(requestParameters, initOverrides) {
|
|
107
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
108
|
+
const requestOptions = yield this.getZapierMeRequestOpts(requestParameters);
|
|
109
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
110
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetZapierMe_1.GetZapierMeFromJSON)(jsonValue));
|
|
111
|
+
});
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
115
|
+
*/
|
|
116
|
+
getZapierMe(requestParameters, initOverrides) {
|
|
117
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
118
|
+
const response = yield this.getZapierMeRaw(requestParameters, initOverrides);
|
|
119
|
+
return yield response.value();
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Creates request options for getZapierSetup without sending the request
|
|
124
|
+
*/
|
|
125
|
+
getZapierSetupRequestOpts() {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
127
|
+
const queryParameters = {};
|
|
128
|
+
const headerParameters = {};
|
|
129
|
+
let urlPath = `/integrations/zapier/setup`;
|
|
130
|
+
return {
|
|
131
|
+
path: urlPath,
|
|
132
|
+
method: 'GET',
|
|
133
|
+
headers: headerParameters,
|
|
134
|
+
query: queryParameters,
|
|
135
|
+
};
|
|
136
|
+
});
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* List Zapier connections and permissions available to the selected portal
|
|
140
|
+
*/
|
|
141
|
+
getZapierSetupRaw(initOverrides) {
|
|
142
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
143
|
+
const requestOptions = yield this.getZapierSetupRequestOpts();
|
|
144
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
145
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetZapierSetup_1.GetZapierSetupFromJSON)(jsonValue));
|
|
146
|
+
});
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* List Zapier connections and permissions available to the selected portal
|
|
150
|
+
*/
|
|
151
|
+
getZapierSetup(initOverrides) {
|
|
152
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
+
const response = yield this.getZapierSetupRaw(initOverrides);
|
|
154
|
+
return yield response.value();
|
|
155
|
+
});
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Creates request options for postZapierSetup without sending the request
|
|
159
|
+
*/
|
|
160
|
+
postZapierSetupRequestOpts(requestParameters) {
|
|
161
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
162
|
+
if (requestParameters['postZapierSetup'] == null) {
|
|
163
|
+
throw new runtime.RequiredError('postZapierSetup', 'Required parameter "postZapierSetup" was null or undefined when calling postZapierSetup().');
|
|
164
|
+
}
|
|
165
|
+
const queryParameters = {};
|
|
166
|
+
const headerParameters = {};
|
|
167
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
168
|
+
let urlPath = `/integrations/zapier/setup`;
|
|
169
|
+
return {
|
|
170
|
+
path: urlPath,
|
|
171
|
+
method: 'POST',
|
|
172
|
+
headers: headerParameters,
|
|
173
|
+
query: queryParameters,
|
|
174
|
+
body: (0, PostZapierSetup_1.PostZapierSetupToJSON)(requestParameters['postZapierSetup']),
|
|
175
|
+
};
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Create a Zapier connection and API key for the selected portal
|
|
180
|
+
*/
|
|
181
|
+
postZapierSetupRaw(requestParameters, initOverrides) {
|
|
182
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
183
|
+
const requestOptions = yield this.postZapierSetupRequestOpts(requestParameters);
|
|
184
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
185
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostZapierSetupResponse_1.PostZapierSetupResponseFromJSON)(jsonValue));
|
|
186
|
+
});
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Create a Zapier connection and API key for the selected portal
|
|
190
|
+
*/
|
|
191
|
+
postZapierSetup(requestParameters, initOverrides) {
|
|
192
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
193
|
+
const response = yield this.postZapierSetupRaw(requestParameters, initOverrides);
|
|
194
|
+
return yield response.value();
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Creates request options for putZapierSetup without sending the request
|
|
199
|
+
*/
|
|
200
|
+
putZapierSetupRequestOpts(requestParameters) {
|
|
201
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
202
|
+
if (requestParameters['zapierIntegrationId'] == null) {
|
|
203
|
+
throw new runtime.RequiredError('zapierIntegrationId', 'Required parameter "zapierIntegrationId" was null or undefined when calling putZapierSetup().');
|
|
204
|
+
}
|
|
205
|
+
if (requestParameters['putZapierSetup'] == null) {
|
|
206
|
+
throw new runtime.RequiredError('putZapierSetup', 'Required parameter "putZapierSetup" was null or undefined when calling putZapierSetup().');
|
|
207
|
+
}
|
|
208
|
+
const queryParameters = {};
|
|
209
|
+
const headerParameters = {};
|
|
210
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
211
|
+
let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
|
|
212
|
+
urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
|
|
213
|
+
return {
|
|
214
|
+
path: urlPath,
|
|
215
|
+
method: 'PUT',
|
|
216
|
+
headers: headerParameters,
|
|
217
|
+
query: queryParameters,
|
|
218
|
+
body: (0, PutZapierSetup_1.PutZapierSetupToJSON)(requestParameters['putZapierSetup']),
|
|
219
|
+
};
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Update a Zapier connection\'s name or permissions
|
|
224
|
+
*/
|
|
225
|
+
putZapierSetupRaw(requestParameters, initOverrides) {
|
|
226
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
227
|
+
const requestOptions = yield this.putZapierSetupRequestOpts(requestParameters);
|
|
228
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
229
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, ZapierIntegration_1.ZapierIntegrationFromJSON)(jsonValue));
|
|
230
|
+
});
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Update a Zapier connection\'s name or permissions
|
|
234
|
+
*/
|
|
235
|
+
putZapierSetup(requestParameters, initOverrides) {
|
|
236
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
237
|
+
const response = yield this.putZapierSetupRaw(requestParameters, initOverrides);
|
|
238
|
+
return yield response.value();
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
exports.IntegrationApi = IntegrationApi;
|
package/dist/apis/index.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export * from './CourseCatalogApi';
|
|
|
9
9
|
export * from './CourseShareApi';
|
|
10
10
|
export * from './DispatchApi';
|
|
11
11
|
export * from './EmailTemplateApi';
|
|
12
|
+
export * from './IntegrationApi';
|
|
12
13
|
export * from './LearnerExperienceApi';
|
|
13
14
|
export * from './OtherApi';
|
|
14
15
|
export * from './PlayerApi';
|
package/dist/apis/index.js
CHANGED
|
@@ -27,6 +27,7 @@ __exportStar(require("./CourseCatalogApi"), exports);
|
|
|
27
27
|
__exportStar(require("./CourseShareApi"), exports);
|
|
28
28
|
__exportStar(require("./DispatchApi"), exports);
|
|
29
29
|
__exportStar(require("./EmailTemplateApi"), exports);
|
|
30
|
+
__exportStar(require("./IntegrationApi"), exports);
|
|
30
31
|
__exportStar(require("./LearnerExperienceApi"), exports);
|
|
31
32
|
__exportStar(require("./OtherApi"), exports);
|
|
32
33
|
__exportStar(require("./PlayerApi"), exports);
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LMS API
|
|
3
|
+
* LMS API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import { type GetZapierMe } from '../models/GetZapierMe';
|
|
14
|
+
import { type GetZapierSetup } from '../models/GetZapierSetup';
|
|
15
|
+
import { type PostZapierSetup } from '../models/PostZapierSetup';
|
|
16
|
+
import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
|
|
17
|
+
import { type PutZapierSetup } from '../models/PutZapierSetup';
|
|
18
|
+
import { type ZapierIntegration } from '../models/ZapierIntegration';
|
|
19
|
+
export interface DeleteZapierSetupRequest {
|
|
20
|
+
zapierIntegrationId: string;
|
|
21
|
+
}
|
|
22
|
+
export interface GetZapierMeRequest {
|
|
23
|
+
xAPIKEY: string;
|
|
24
|
+
xPORTALSUBDOMAIN: string;
|
|
25
|
+
}
|
|
26
|
+
export interface PostZapierSetupRequest {
|
|
27
|
+
postZapierSetup: PostZapierSetup;
|
|
28
|
+
}
|
|
29
|
+
export interface PutZapierSetupRequest {
|
|
30
|
+
zapierIntegrationId: string;
|
|
31
|
+
putZapierSetup: PutZapierSetup;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare class IntegrationApi extends runtime.BaseAPI {
|
|
37
|
+
/**
|
|
38
|
+
* Creates request options for deleteZapierSetup without sending the request
|
|
39
|
+
*/
|
|
40
|
+
deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
41
|
+
/**
|
|
42
|
+
* Revoke a Zapier connection and its API key
|
|
43
|
+
*/
|
|
44
|
+
deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
45
|
+
/**
|
|
46
|
+
* Revoke a Zapier connection and its API key
|
|
47
|
+
*/
|
|
48
|
+
deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates request options for getZapierMe without sending the request
|
|
51
|
+
*/
|
|
52
|
+
getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts>;
|
|
53
|
+
/**
|
|
54
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
55
|
+
*/
|
|
56
|
+
getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>>;
|
|
57
|
+
/**
|
|
58
|
+
* Test a Zapier API key and return its portal and enabled permissions
|
|
59
|
+
*/
|
|
60
|
+
getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe>;
|
|
61
|
+
/**
|
|
62
|
+
* Creates request options for getZapierSetup without sending the request
|
|
63
|
+
*/
|
|
64
|
+
getZapierSetupRequestOpts(): Promise<runtime.RequestOpts>;
|
|
65
|
+
/**
|
|
66
|
+
* List Zapier connections and permissions available to the selected portal
|
|
67
|
+
*/
|
|
68
|
+
getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>>;
|
|
69
|
+
/**
|
|
70
|
+
* List Zapier connections and permissions available to the selected portal
|
|
71
|
+
*/
|
|
72
|
+
getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for postZapierSetup without sending the request
|
|
75
|
+
*/
|
|
76
|
+
postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* Create a Zapier connection and API key for the selected portal
|
|
79
|
+
*/
|
|
80
|
+
postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>>;
|
|
81
|
+
/**
|
|
82
|
+
* Create a Zapier connection and API key for the selected portal
|
|
83
|
+
*/
|
|
84
|
+
postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse>;
|
|
85
|
+
/**
|
|
86
|
+
* Creates request options for putZapierSetup without sending the request
|
|
87
|
+
*/
|
|
88
|
+
putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts>;
|
|
89
|
+
/**
|
|
90
|
+
* Update a Zapier connection\'s name or permissions
|
|
91
|
+
*/
|
|
92
|
+
putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>>;
|
|
93
|
+
/**
|
|
94
|
+
* Update a Zapier connection\'s name or permissions
|
|
95
|
+
*/
|
|
96
|
+
putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
|
|
97
|
+
}
|