@easyedu/js-lsm-api 1.114.0 → 1.115.0

package/.openapi-generator/FILES

@@ -174,6 +174,9 @@ docs/GetUserCourseListItemCourse.md
 docs/GetUserCourseListItemEnrollment.md
 docs/GetUserCourseListItemProgress.md
 docs/GetUserRole.md
+docs/GetZapierMe.md
+docs/GetZapierSetup.md
+docs/IntegrationApi.md
 docs/LearnerExperienceApi.md
 docs/LearnerExperienceVersion.md
 docs/LibraryQuizCriteriaPreviewQuestion.md
@@ -270,6 +273,8 @@ docs/PostSignupRequest.md
 docs/PostSignupRequestResponse.md
 docs/PostSupportTicket.md
 docs/PostSupportTicketComment.md
+docs/PostZapierSetup.md
+docs/PostZapierSetupResponse.md
 docs/ProgressionGateError.md
 docs/ProgressionLockReason.md
 docs/PutAttemptAllowance.md
@@ -307,6 +312,7 @@ docs/PutRole.md
 docs/PutRolePermissions.md
 docs/PutSupportTicket.md
 docs/PutUser.md
+docs/PutZapierSetup.md
 docs/QuestionApi.md
 docs/QuestionImportApi.md
 docs/QuestionImportCommitResult.md
@@ -335,6 +341,7 @@ docs/UpdateSelectedPortalResponse.md
 docs/UpdateSelectedPortalResponseHostPortal.md
 docs/UpdateSelectedPortalResponseSelectedPortal.md
 docs/UserApi.md
+docs/ZapierIntegration.md
 package.json
 src/apis/CertificateApi.ts
 src/apis/CertificateTemplateApi.ts
@@ -347,6 +354,7 @@ src/apis/CourseCatalogApi.ts
 src/apis/CourseShareApi.ts
 src/apis/DispatchApi.ts
 src/apis/EmailTemplateApi.ts
+src/apis/IntegrationApi.ts
 src/apis/LearnerExperienceApi.ts
 src/apis/OtherApi.ts
 src/apis/PlayerApi.ts
@@ -523,6 +531,8 @@ src/models/GetUserCourseListItemCourse.ts
 src/models/GetUserCourseListItemEnrollment.ts
 src/models/GetUserCourseListItemProgress.ts
 src/models/GetUserRole.ts
+src/models/GetZapierMe.ts
+src/models/GetZapierSetup.ts
 src/models/LearnerExperienceVersion.ts
 src/models/LibraryQuizCriteriaPreviewQuestion.ts
 src/models/LibraryQuizCriterion.ts
@@ -614,6 +624,8 @@ src/models/PostSignupRequest.ts
 src/models/PostSignupRequestResponse.ts
 src/models/PostSupportTicket.ts
 src/models/PostSupportTicketComment.ts
+src/models/PostZapierSetup.ts
+src/models/PostZapierSetupResponse.ts
 src/models/ProgressionGateError.ts
 src/models/ProgressionLockReason.ts
 src/models/PutAttemptAllowance.ts
@@ -651,6 +663,7 @@ src/models/PutRole.ts
 src/models/PutRolePermissions.ts
 src/models/PutSupportTicket.ts
 src/models/PutUser.ts
+src/models/PutZapierSetup.ts
 src/models/QuestionImportCommitResult.ts
 src/models/QuestionImportDraft.ts
 src/models/QuestionImportDuplicate.ts
@@ -671,6 +684,7 @@ src/models/SupportTicketUser.ts
 src/models/UpdateSelectedPortalResponse.ts
 src/models/UpdateSelectedPortalResponseHostPortal.ts
 src/models/UpdateSelectedPortalResponseSelectedPortal.ts
+src/models/ZapierIntegration.ts
 src/models/index.ts
 src/runtime.ts
 tsconfig.esm.json

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.114.0
+# @easyedu/js-lsm-api@1.115.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -273,6 +273,11 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *EmailTemplateApi* | [**putSystemEmailAssetFile**](docs/EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image
 *EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
 *EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
+*IntegrationApi* | [**deleteZapierSetup**](docs/IntegrationApi.md#deletezapiersetup) | **DELETE** /integrations/zapier/setup/{zapierIntegrationId} | Revoke a Zapier connection and its API key
+*IntegrationApi* | [**getZapierMe**](docs/IntegrationApi.md#getzapierme) | **GET** /integrations/zapier/me | Test a Zapier API key and return its portal and enabled permissions
+*IntegrationApi* | [**getZapierSetup**](docs/IntegrationApi.md#getzapiersetup) | **GET** /integrations/zapier/setup | List Zapier connections and permissions available to the selected portal
+*IntegrationApi* | [**postZapierSetup**](docs/IntegrationApi.md#postzapiersetup) | **POST** /integrations/zapier/setup | Create a Zapier connection and API key for the selected portal
+*IntegrationApi* | [**putZapierSetup**](docs/IntegrationApi.md#putzapiersetup) | **PUT** /integrations/zapier/setup/{zapierIntegrationId} | Update a Zapier connection\'s name or permissions
 *LearnerExperienceApi* | [**deleteLearnerExperienceDraft**](docs/LearnerExperienceApi.md#deletelearnerexperiencedraft) | **DELETE** /learner-experience/draft | Discard the selected portal\'s learner experience draft
 *LearnerExperienceApi* | [**getCurrentLearnerDashboard**](docs/LearnerExperienceApi.md#getcurrentlearnerdashboard) | **GET** /users/current/dashboard | Get the authenticated learner\'s resolved dashboard and personalized data
 *LearnerExperienceApi* | [**getEffectiveLearnerExperience**](docs/LearnerExperienceApi.md#geteffectivelearnerexperience) | **GET** /learner-experience/effective | Get the effective published learner experience for the authenticated user
@@ -542,6 +547,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetUserCourseListItemEnrollment](docs/GetUserCourseListItemEnrollment.md)
 - [GetUserCourseListItemProgress](docs/GetUserCourseListItemProgress.md)
 - [GetUserRole](docs/GetUserRole.md)
+- [GetZapierMe](docs/GetZapierMe.md)
+- [GetZapierSetup](docs/GetZapierSetup.md)
 - [LearnerExperienceVersion](docs/LearnerExperienceVersion.md)
 - [LibraryQuizCriteriaPreviewQuestion](docs/LibraryQuizCriteriaPreviewQuestion.md)
 - [LibraryQuizCriterion](docs/LibraryQuizCriterion.md)
@@ -633,6 +640,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PostSignupRequestResponse](docs/PostSignupRequestResponse.md)
 - [PostSupportTicket](docs/PostSupportTicket.md)
 - [PostSupportTicketComment](docs/PostSupportTicketComment.md)
+- [PostZapierSetup](docs/PostZapierSetup.md)
+- [PostZapierSetupResponse](docs/PostZapierSetupResponse.md)
 - [ProgressionGateError](docs/ProgressionGateError.md)
 - [ProgressionLockReason](docs/ProgressionLockReason.md)
 - [PutAttemptAllowance](docs/PutAttemptAllowance.md)
@@ -670,6 +679,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [PutRolePermissions](docs/PutRolePermissions.md)
 - [PutSupportTicket](docs/PutSupportTicket.md)
 - [PutUser](docs/PutUser.md)
+- [PutZapierSetup](docs/PutZapierSetup.md)
 - [QuestionImportCommitResult](docs/QuestionImportCommitResult.md)
 - [QuestionImportDraft](docs/QuestionImportDraft.md)
 - [QuestionImportDuplicate](docs/QuestionImportDuplicate.md)
@@ -690,6 +700,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [UpdateSelectedPortalResponse](docs/UpdateSelectedPortalResponse.md)
 - [UpdateSelectedPortalResponseHostPortal](docs/UpdateSelectedPortalResponseHostPortal.md)
 - [UpdateSelectedPortalResponseSelectedPortal](docs/UpdateSelectedPortalResponseSelectedPortal.md)
+- [ZapierIntegration](docs/ZapierIntegration.md)
 
 ### Authorization
 
@@ -703,7 +714,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.114.0`
+- Package version: `1.115.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/IntegrationApi.d.ts

@@ -0,0 +1,97 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type GetZapierMe } from '../models/GetZapierMe';
+import { type GetZapierSetup } from '../models/GetZapierSetup';
+import { type PostZapierSetup } from '../models/PostZapierSetup';
+import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
+import { type PutZapierSetup } from '../models/PutZapierSetup';
+import { type ZapierIntegration } from '../models/ZapierIntegration';
+export interface DeleteZapierSetupRequest {
+    zapierIntegrationId: string;
+}
+export interface GetZapierMeRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+}
+export interface PostZapierSetupRequest {
+    postZapierSetup: PostZapierSetup;
+}
+export interface PutZapierSetupRequest {
+    zapierIntegrationId: string;
+    putZapierSetup: PutZapierSetup;
+}
+/**
+ *
+ */
+export declare class IntegrationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteZapierSetup without sending the request
+     */
+    deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getZapierMe without sending the request
+     */
+    getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe>;
+    /**
+     * Creates request options for getZapierSetup without sending the request
+     */
+    getZapierSetupRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>>;
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup>;
+    /**
+     * Creates request options for postZapierSetup without sending the request
+     */
+    postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>>;
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse>;
+    /**
+     * Creates request options for putZapierSetup without sending the request
+     */
+    putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
+}

package/dist/apis/IntegrationApi.js

@@ -0,0 +1,242 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntegrationApi = void 0;
+const runtime = require("../runtime");
+const GetZapierMe_1 = require("../models/GetZapierMe");
+const GetZapierSetup_1 = require("../models/GetZapierSetup");
+const PostZapierSetup_1 = require("../models/PostZapierSetup");
+const PostZapierSetupResponse_1 = require("../models/PostZapierSetupResponse");
+const PutZapierSetup_1 = require("../models/PutZapierSetup");
+const ZapierIntegration_1 = require("../models/ZapierIntegration");
+/**
+ *
+ */
+class IntegrationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteZapierSetup without sending the request
+     */
+    deleteZapierSetupRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['zapierIntegrationId'] == null) {
+                throw new runtime.RequiredError('zapierIntegrationId', 'Required parameter "zapierIntegrationId" was null or undefined when calling deleteZapierSetup().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
+            urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
+            return {
+                path: urlPath,
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetupRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deleteZapierSetupRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetup(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deleteZapierSetupRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for getZapierMe without sending the request
+     */
+    getZapierMeRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['xAPIKEY'] == null) {
+                throw new runtime.RequiredError('xAPIKEY', 'Required parameter "xAPIKEY" was null or undefined when calling getZapierMe().');
+            }
+            if (requestParameters['xPORTALSUBDOMAIN'] == null) {
+                throw new runtime.RequiredError('xPORTALSUBDOMAIN', 'Required parameter "xPORTALSUBDOMAIN" was null or undefined when calling getZapierMe().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (requestParameters['xAPIKEY'] != null) {
+                headerParameters['X-API-KEY'] = String(requestParameters['xAPIKEY']);
+            }
+            if (requestParameters['xPORTALSUBDOMAIN'] != null) {
+                headerParameters['X-PORTAL-SUBDOMAIN'] = String(requestParameters['xPORTALSUBDOMAIN']);
+            }
+            let urlPath = `/integrations/zapier/me`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMeRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getZapierMeRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetZapierMe_1.GetZapierMeFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMe(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getZapierMeRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getZapierSetup without sending the request
+     */
+    getZapierSetupRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/integrations/zapier/setup`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetupRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getZapierSetupRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetZapierSetup_1.GetZapierSetupFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetup(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getZapierSetupRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for postZapierSetup without sending the request
+     */
+    postZapierSetupRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postZapierSetup'] == null) {
+                throw new runtime.RequiredError('postZapierSetup', 'Required parameter "postZapierSetup" was null or undefined when calling postZapierSetup().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/integrations/zapier/setup`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, PostZapierSetup_1.PostZapierSetupToJSON)(requestParameters['postZapierSetup']),
+            };
+        });
+    }
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetupRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postZapierSetupRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, PostZapierSetupResponse_1.PostZapierSetupResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetup(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postZapierSetupRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for putZapierSetup without sending the request
+     */
+    putZapierSetupRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['zapierIntegrationId'] == null) {
+                throw new runtime.RequiredError('zapierIntegrationId', 'Required parameter "zapierIntegrationId" was null or undefined when calling putZapierSetup().');
+            }
+            if (requestParameters['putZapierSetup'] == null) {
+                throw new runtime.RequiredError('putZapierSetup', 'Required parameter "putZapierSetup" was null or undefined when calling putZapierSetup().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            let urlPath = `/integrations/zapier/setup/{zapierIntegrationId}`;
+            urlPath = urlPath.replace('{zapierIntegrationId}', encodeURIComponent(String(requestParameters['zapierIntegrationId'])));
+            return {
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, PutZapierSetup_1.PutZapierSetupToJSON)(requestParameters['putZapierSetup']),
+            };
+        });
+    }
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetupRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.putZapierSetupRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, ZapierIntegration_1.ZapierIntegrationFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetup(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putZapierSetupRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.IntegrationApi = IntegrationApi;

package/dist/apis/index.d.ts

@@ -9,6 +9,7 @@ export * from './CourseCatalogApi';
 export * from './CourseShareApi';
 export * from './DispatchApi';
 export * from './EmailTemplateApi';
+export * from './IntegrationApi';
 export * from './LearnerExperienceApi';
 export * from './OtherApi';
 export * from './PlayerApi';

package/dist/apis/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./CourseCatalogApi"), exports);
 __exportStar(require("./CourseShareApi"), exports);
 __exportStar(require("./DispatchApi"), exports);
 __exportStar(require("./EmailTemplateApi"), exports);
+__exportStar(require("./IntegrationApi"), exports);
 __exportStar(require("./LearnerExperienceApi"), exports);
 __exportStar(require("./OtherApi"), exports);
 __exportStar(require("./PlayerApi"), exports);

package/dist/esm/apis/IntegrationApi.d.ts

@@ -0,0 +1,97 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { type GetZapierMe } from '../models/GetZapierMe';
+import { type GetZapierSetup } from '../models/GetZapierSetup';
+import { type PostZapierSetup } from '../models/PostZapierSetup';
+import { type PostZapierSetupResponse } from '../models/PostZapierSetupResponse';
+import { type PutZapierSetup } from '../models/PutZapierSetup';
+import { type ZapierIntegration } from '../models/ZapierIntegration';
+export interface DeleteZapierSetupRequest {
+    zapierIntegrationId: string;
+}
+export interface GetZapierMeRequest {
+    xAPIKEY: string;
+    xPORTALSUBDOMAIN: string;
+}
+export interface PostZapierSetupRequest {
+    postZapierSetup: PostZapierSetup;
+}
+export interface PutZapierSetupRequest {
+    zapierIntegrationId: string;
+    putZapierSetup: PutZapierSetup;
+}
+/**
+ *
+ */
+export declare class IntegrationApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deleteZapierSetup without sending the request
+     */
+    deleteZapierSetupRequestOpts(requestParameters: DeleteZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetupRaw(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Revoke a Zapier connection and its API key
+     */
+    deleteZapierSetup(requestParameters: DeleteZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getZapierMe without sending the request
+     */
+    getZapierMeRequestOpts(requestParameters: GetZapierMeRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMeRaw(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierMe>>;
+    /**
+     * Test a Zapier API key and return its portal and enabled permissions
+     */
+    getZapierMe(requestParameters: GetZapierMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierMe>;
+    /**
+     * Creates request options for getZapierSetup without sending the request
+     */
+    getZapierSetupRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetupRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetZapierSetup>>;
+    /**
+     * List Zapier connections and permissions available to the selected portal
+     */
+    getZapierSetup(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetZapierSetup>;
+    /**
+     * Creates request options for postZapierSetup without sending the request
+     */
+    postZapierSetupRequestOpts(requestParameters: PostZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetupRaw(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostZapierSetupResponse>>;
+    /**
+     * Create a Zapier connection and API key for the selected portal
+     */
+    postZapierSetup(requestParameters: PostZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostZapierSetupResponse>;
+    /**
+     * Creates request options for putZapierSetup without sending the request
+     */
+    putZapierSetupRequestOpts(requestParameters: PutZapierSetupRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetupRaw(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZapierIntegration>>;
+    /**
+     * Update a Zapier connection\'s name or permissions
+     */
+    putZapierSetup(requestParameters: PutZapierSetupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZapierIntegration>;
+}