@easyedu/js-lsm-api 1.114.0 → 1.115.0

package/dist/models/PostZapierSetupResponse.js

@@ -0,0 +1,55 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostZapierSetupResponse = instanceOfPostZapierSetupResponse;
+exports.PostZapierSetupResponseFromJSON = PostZapierSetupResponseFromJSON;
+exports.PostZapierSetupResponseFromJSONTyped = PostZapierSetupResponseFromJSONTyped;
+exports.PostZapierSetupResponseToJSON = PostZapierSetupResponseToJSON;
+exports.PostZapierSetupResponseToJSONTyped = PostZapierSetupResponseToJSONTyped;
+const ZapierIntegration_1 = require("./ZapierIntegration");
+/**
+ * Check if a given object implements the PostZapierSetupResponse interface.
+ */
+function instanceOfPostZapierSetupResponse(value) {
+    if (!('integration' in value) || value['integration'] === undefined)
+        return false;
+    if (!('apiKey' in value) || value['apiKey'] === undefined)
+        return false;
+    return true;
+}
+function PostZapierSetupResponseFromJSON(json) {
+    return PostZapierSetupResponseFromJSONTyped(json, false);
+}
+function PostZapierSetupResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'integration': (0, ZapierIntegration_1.ZapierIntegrationFromJSON)(json['integration']),
+        'apiKey': json['api_key'],
+    };
+}
+function PostZapierSetupResponseToJSON(json) {
+    return PostZapierSetupResponseToJSONTyped(json, false);
+}
+function PostZapierSetupResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'integration': (0, ZapierIntegration_1.ZapierIntegrationToJSON)(value['integration']),
+        'api_key': value['apiKey'],
+    };
+}

package/dist/models/PutZapierSetup.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PutZapierSetup
+ */
+export interface PutZapierSetup {
+    /**
+     *
+     * @type {string}
+     * @memberof PutZapierSetup
+     */
+    name?: string;
+    /**
+     *
+     * @type {Set<string>}
+     * @memberof PutZapierSetup
+     */
+    permissionKeys?: Set<string>;
+}
+/**
+ * Check if a given object implements the PutZapierSetup interface.
+ */
+export declare function instanceOfPutZapierSetup(value: object): value is PutZapierSetup;
+export declare function PutZapierSetupFromJSON(json: any): PutZapierSetup;
+export declare function PutZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutZapierSetup;
+export declare function PutZapierSetupToJSON(json: any): PutZapierSetup;
+export declare function PutZapierSetupToJSONTyped(value?: PutZapierSetup | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutZapierSetup.js

@@ -0,0 +1,50 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutZapierSetup = instanceOfPutZapierSetup;
+exports.PutZapierSetupFromJSON = PutZapierSetupFromJSON;
+exports.PutZapierSetupFromJSONTyped = PutZapierSetupFromJSONTyped;
+exports.PutZapierSetupToJSON = PutZapierSetupToJSON;
+exports.PutZapierSetupToJSONTyped = PutZapierSetupToJSONTyped;
+/**
+ * Check if a given object implements the PutZapierSetup interface.
+ */
+function instanceOfPutZapierSetup(value) {
+    return true;
+}
+function PutZapierSetupFromJSON(json) {
+    return PutZapierSetupFromJSONTyped(json, false);
+}
+function PutZapierSetupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'permissionKeys': json['permission_keys'] == null ? undefined : new Set(json['permission_keys']),
+    };
+}
+function PutZapierSetupToJSON(json) {
+    return PutZapierSetupToJSONTyped(json, false);
+}
+function PutZapierSetupToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'permission_keys': value['permissionKeys'] == null ? undefined : Array.from(value['permissionKeys']),
+    };
+}

package/dist/models/ZapierIntegration.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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.
+ */
+/**
+ * A portal-scoped Zapier connection. The API key secret is never included here.
+ * @export
+ * @interface ZapierIntegration
+ */
+export interface ZapierIntegration {
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    portalSubdomain: string;
+    /**
+     * Non-secret prefix used to identify the key.
+     * @type {string}
+     * @memberof ZapierIntegration
+     */
+    keyPrefix: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof ZapierIntegration
+     */
+    permissionKeys: Array<string>;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    createdAt: number;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    updatedAt: number;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    lastUsedAt?: number | null;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof ZapierIntegration
+     */
+    revokedAt?: number | null;
+}
+/**
+ * Check if a given object implements the ZapierIntegration interface.
+ */
+export declare function instanceOfZapierIntegration(value: object): value is ZapierIntegration;
+export declare function ZapierIntegrationFromJSON(json: any): ZapierIntegration;
+export declare function ZapierIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierIntegration;
+export declare function ZapierIntegrationToJSON(json: any): ZapierIntegration;
+export declare function ZapierIntegrationToJSONTyped(value?: ZapierIntegration | null, ignoreDiscriminator?: boolean): any;

package/dist/models/ZapierIntegration.js

@@ -0,0 +1,86 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfZapierIntegration = instanceOfZapierIntegration;
+exports.ZapierIntegrationFromJSON = ZapierIntegrationFromJSON;
+exports.ZapierIntegrationFromJSONTyped = ZapierIntegrationFromJSONTyped;
+exports.ZapierIntegrationToJSON = ZapierIntegrationToJSON;
+exports.ZapierIntegrationToJSONTyped = ZapierIntegrationToJSONTyped;
+/**
+ * Check if a given object implements the ZapierIntegration interface.
+ */
+function instanceOfZapierIntegration(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('portalId' in value) || value['portalId'] === undefined)
+        return false;
+    if (!('portalName' in value) || value['portalName'] === undefined)
+        return false;
+    if (!('portalSubdomain' in value) || value['portalSubdomain'] === undefined)
+        return false;
+    if (!('keyPrefix' in value) || value['keyPrefix'] === undefined)
+        return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function ZapierIntegrationFromJSON(json) {
+    return ZapierIntegrationFromJSONTyped(json, false);
+}
+function ZapierIntegrationFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'portalId': json['portal_id'],
+        'portalName': json['portal_name'],
+        'portalSubdomain': json['portal_subdomain'],
+        'keyPrefix': json['key_prefix'],
+        'permissionKeys': json['permission_keys'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'lastUsedAt': json['last_used_at'] == null ? undefined : json['last_used_at'],
+        'revokedAt': json['revoked_at'] == null ? undefined : json['revoked_at'],
+    };
+}
+function ZapierIntegrationToJSON(json) {
+    return ZapierIntegrationToJSONTyped(json, false);
+}
+function ZapierIntegrationToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'portal_id': value['portalId'],
+        'portal_name': value['portalName'],
+        'portal_subdomain': value['portalSubdomain'],
+        'key_prefix': value['keyPrefix'],
+        'permission_keys': value['permissionKeys'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'last_used_at': value['lastUsedAt'],
+        'revoked_at': value['revokedAt'],
+    };
+}

package/dist/models/index.d.ts

@@ -159,6 +159,8 @@ export * from './GetUserCourseListItemCourse';
 export * from './GetUserCourseListItemEnrollment';
 export * from './GetUserCourseListItemProgress';
 export * from './GetUserRole';
+export * from './GetZapierMe';
+export * from './GetZapierSetup';
 export * from './LearnerExperienceVersion';
 export * from './LibraryQuizCriteriaPreviewQuestion';
 export * from './LibraryQuizCriterion';
@@ -250,6 +252,8 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './PostZapierSetup';
+export * from './PostZapierSetupResponse';
 export * from './ProgressionGateError';
 export * from './ProgressionLockReason';
 export * from './PutAttemptAllowance';
@@ -287,6 +291,7 @@ export * from './PutRole';
 export * from './PutRolePermissions';
 export * from './PutSupportTicket';
 export * from './PutUser';
+export * from './PutZapierSetup';
 export * from './QuestionImportCommitResult';
 export * from './QuestionImportDraft';
 export * from './QuestionImportDuplicate';
@@ -307,3 +312,4 @@ export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';
+export * from './ZapierIntegration';

package/dist/models/index.js

@@ -177,6 +177,8 @@ __exportStar(require("./GetUserCourseListItemCourse"), exports);
 __exportStar(require("./GetUserCourseListItemEnrollment"), exports);
 __exportStar(require("./GetUserCourseListItemProgress"), exports);
 __exportStar(require("./GetUserRole"), exports);
+__exportStar(require("./GetZapierMe"), exports);
+__exportStar(require("./GetZapierSetup"), exports);
 __exportStar(require("./LearnerExperienceVersion"), exports);
 __exportStar(require("./LibraryQuizCriteriaPreviewQuestion"), exports);
 __exportStar(require("./LibraryQuizCriterion"), exports);
@@ -268,6 +270,8 @@ __exportStar(require("./PostSignupRequest"), exports);
 __exportStar(require("./PostSignupRequestResponse"), exports);
 __exportStar(require("./PostSupportTicket"), exports);
 __exportStar(require("./PostSupportTicketComment"), exports);
+__exportStar(require("./PostZapierSetup"), exports);
+__exportStar(require("./PostZapierSetupResponse"), exports);
 __exportStar(require("./ProgressionGateError"), exports);
 __exportStar(require("./ProgressionLockReason"), exports);
 __exportStar(require("./PutAttemptAllowance"), exports);
@@ -305,6 +309,7 @@ __exportStar(require("./PutRole"), exports);
 __exportStar(require("./PutRolePermissions"), exports);
 __exportStar(require("./PutSupportTicket"), exports);
 __exportStar(require("./PutUser"), exports);
+__exportStar(require("./PutZapierSetup"), exports);
 __exportStar(require("./QuestionImportCommitResult"), exports);
 __exportStar(require("./QuestionImportDraft"), exports);
 __exportStar(require("./QuestionImportDuplicate"), exports);
@@ -325,3 +330,4 @@ __exportStar(require("./SupportTicketUser"), exports);
 __exportStar(require("./UpdateSelectedPortalResponse"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseHostPortal"), exports);
 __exportStar(require("./UpdateSelectedPortalResponseSelectedPortal"), exports);
+__exportStar(require("./ZapierIntegration"), exports);

package/docs/GetZapierMe.md

@@ -0,0 +1,44 @@
+
+# GetZapierMe
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`integrationId` | string
+`integrationName` | string
+`portalId` | string
+`portalName` | string
+`portalSubdomain` | string
+`permissionKeys` | Array<string>
+
+## Example
+
+```typescript
+import type { GetZapierMe } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "integrationId": null,
+  "integrationName": null,
+  "portalId": null,
+  "portalName": null,
+  "portalSubdomain": null,
+  "permissionKeys": null,
+} satisfies GetZapierMe
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetZapierMe
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetZapierSetup.md

@@ -0,0 +1,36 @@
+
+# GetZapierSetup
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`availablePermissions` | [Array<GetPermission>](GetPermission.md)
+`integrations` | [Array<ZapierIntegration>](ZapierIntegration.md)
+
+## Example
+
+```typescript
+import type { GetZapierSetup } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "availablePermissions": null,
+  "integrations": null,
+} satisfies GetZapierSetup
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetZapierSetup
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+