@easyedu/js-lsm-api 1.114.0 → 1.115.0

package/dist/esm/models/PutZapierSetup.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PutZapierSetup interface.
+ */
+export function instanceOfPutZapierSetup(value) {
+    return true;
+}
+export function PutZapierSetupFromJSON(json) {
+    return PutZapierSetupFromJSONTyped(json, false);
+}
+export 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']),
+    };
+}
+export function PutZapierSetupToJSON(json) {
+    return PutZapierSetupToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/ZapierIntegration.js

@@ -0,0 +1,79 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ZapierIntegration interface.
+ */
+export 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;
+}
+export function ZapierIntegrationFromJSON(json) {
+    return ZapierIntegrationFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function ZapierIntegrationToJSON(json) {
+    return ZapierIntegrationToJSONTyped(json, false);
+}
+export 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/esm/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/esm/models/index.js

@@ -161,6 +161,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';
@@ -252,6 +254,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';
@@ -289,6 +293,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';
@@ -309,3 +314,4 @@ export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';
+export * from './ZapierIntegration';

package/dist/models/GetZapierMe.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 GetZapierMe
+ */
+export interface GetZapierMe {
+    /**
+     *
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    integrationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    integrationName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetZapierMe
+     */
+    portalSubdomain: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof GetZapierMe
+     */
+    permissionKeys: Array<string>;
+}
+/**
+ * Check if a given object implements the GetZapierMe interface.
+ */
+export declare function instanceOfGetZapierMe(value: object): value is GetZapierMe;
+export declare function GetZapierMeFromJSON(json: any): GetZapierMe;
+export declare function GetZapierMeFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierMe;
+export declare function GetZapierMeToJSON(json: any): GetZapierMe;
+export declare function GetZapierMeToJSONTyped(value?: GetZapierMe | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetZapierMe.js

@@ -0,0 +1,70 @@
+"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.instanceOfGetZapierMe = instanceOfGetZapierMe;
+exports.GetZapierMeFromJSON = GetZapierMeFromJSON;
+exports.GetZapierMeFromJSONTyped = GetZapierMeFromJSONTyped;
+exports.GetZapierMeToJSON = GetZapierMeToJSON;
+exports.GetZapierMeToJSONTyped = GetZapierMeToJSONTyped;
+/**
+ * Check if a given object implements the GetZapierMe interface.
+ */
+function instanceOfGetZapierMe(value) {
+    if (!('integrationId' in value) || value['integrationId'] === undefined)
+        return false;
+    if (!('integrationName' in value) || value['integrationName'] === 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 (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    return true;
+}
+function GetZapierMeFromJSON(json) {
+    return GetZapierMeFromJSONTyped(json, false);
+}
+function GetZapierMeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'integrationId': json['integration_id'],
+        'integrationName': json['integration_name'],
+        'portalId': json['portal_id'],
+        'portalName': json['portal_name'],
+        'portalSubdomain': json['portal_subdomain'],
+        'permissionKeys': json['permission_keys'],
+    };
+}
+function GetZapierMeToJSON(json) {
+    return GetZapierMeToJSONTyped(json, false);
+}
+function GetZapierMeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'integration_id': value['integrationId'],
+        'integration_name': value['integrationName'],
+        'portal_id': value['portalId'],
+        'portal_name': value['portalName'],
+        'portal_subdomain': value['portalSubdomain'],
+        'permission_keys': value['permissionKeys'],
+    };
+}

package/dist/models/GetZapierSetup.d.ts

@@ -0,0 +1,40 @@
+/**
+ * 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 type { GetPermission } from './GetPermission';
+import type { ZapierIntegration } from './ZapierIntegration';
+/**
+ *
+ * @export
+ * @interface GetZapierSetup
+ */
+export interface GetZapierSetup {
+    /**
+     *
+     * @type {Array<GetPermission>}
+     * @memberof GetZapierSetup
+     */
+    availablePermissions: Array<GetPermission>;
+    /**
+     *
+     * @type {Array<ZapierIntegration>}
+     * @memberof GetZapierSetup
+     */
+    integrations: Array<ZapierIntegration>;
+}
+/**
+ * Check if a given object implements the GetZapierSetup interface.
+ */
+export declare function instanceOfGetZapierSetup(value: object): value is GetZapierSetup;
+export declare function GetZapierSetupFromJSON(json: any): GetZapierSetup;
+export declare function GetZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierSetup;
+export declare function GetZapierSetupToJSON(json: any): GetZapierSetup;
+export declare function GetZapierSetupToJSONTyped(value?: GetZapierSetup | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetZapierSetup.js

@@ -0,0 +1,56 @@
+"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.instanceOfGetZapierSetup = instanceOfGetZapierSetup;
+exports.GetZapierSetupFromJSON = GetZapierSetupFromJSON;
+exports.GetZapierSetupFromJSONTyped = GetZapierSetupFromJSONTyped;
+exports.GetZapierSetupToJSON = GetZapierSetupToJSON;
+exports.GetZapierSetupToJSONTyped = GetZapierSetupToJSONTyped;
+const GetPermission_1 = require("./GetPermission");
+const ZapierIntegration_1 = require("./ZapierIntegration");
+/**
+ * Check if a given object implements the GetZapierSetup interface.
+ */
+function instanceOfGetZapierSetup(value) {
+    if (!('availablePermissions' in value) || value['availablePermissions'] === undefined)
+        return false;
+    if (!('integrations' in value) || value['integrations'] === undefined)
+        return false;
+    return true;
+}
+function GetZapierSetupFromJSON(json) {
+    return GetZapierSetupFromJSONTyped(json, false);
+}
+function GetZapierSetupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'availablePermissions': (json['available_permissions'].map(GetPermission_1.GetPermissionFromJSON)),
+        'integrations': (json['integrations'].map(ZapierIntegration_1.ZapierIntegrationFromJSON)),
+    };
+}
+function GetZapierSetupToJSON(json) {
+    return GetZapierSetupToJSONTyped(json, false);
+}
+function GetZapierSetupToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'available_permissions': (value['availablePermissions'].map(GetPermission_1.GetPermissionToJSON)),
+        'integrations': (value['integrations'].map(ZapierIntegration_1.ZapierIntegrationToJSON)),
+    };
+}

package/dist/models/PostZapierSetup.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 PostZapierSetup
+ */
+export interface PostZapierSetup {
+    /**
+     *
+     * @type {string}
+     * @memberof PostZapierSetup
+     */
+    name: string;
+    /**
+     *
+     * @type {Set<string>}
+     * @memberof PostZapierSetup
+     */
+    permissionKeys: Set<string>;
+}
+/**
+ * Check if a given object implements the PostZapierSetup interface.
+ */
+export declare function instanceOfPostZapierSetup(value: object): value is PostZapierSetup;
+export declare function PostZapierSetupFromJSON(json: any): PostZapierSetup;
+export declare function PostZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetup;
+export declare function PostZapierSetupToJSON(json: any): PostZapierSetup;
+export declare function PostZapierSetupToJSONTyped(value?: PostZapierSetup | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostZapierSetup.js

@@ -0,0 +1,54 @@
+"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.instanceOfPostZapierSetup = instanceOfPostZapierSetup;
+exports.PostZapierSetupFromJSON = PostZapierSetupFromJSON;
+exports.PostZapierSetupFromJSONTyped = PostZapierSetupFromJSONTyped;
+exports.PostZapierSetupToJSON = PostZapierSetupToJSON;
+exports.PostZapierSetupToJSONTyped = PostZapierSetupToJSONTyped;
+/**
+ * Check if a given object implements the PostZapierSetup interface.
+ */
+function instanceOfPostZapierSetup(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined)
+        return false;
+    return true;
+}
+function PostZapierSetupFromJSON(json) {
+    return PostZapierSetupFromJSONTyped(json, false);
+}
+function PostZapierSetupFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'permissionKeys': new Set(json['permission_keys']),
+    };
+}
+function PostZapierSetupToJSON(json) {
+    return PostZapierSetupToJSONTyped(json, false);
+}
+function PostZapierSetupToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'permission_keys': Array.from(value['permissionKeys']),
+    };
+}

package/dist/models/PostZapierSetupResponse.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 type { ZapierIntegration } from './ZapierIntegration';
+/**
+ * A newly created Zapier connection. The API key is returned only once.
+ * @export
+ * @interface PostZapierSetupResponse
+ */
+export interface PostZapierSetupResponse {
+    /**
+     *
+     * @type {ZapierIntegration}
+     * @memberof PostZapierSetupResponse
+     */
+    integration: ZapierIntegration;
+    /**
+     *
+     * @type {string}
+     * @memberof PostZapierSetupResponse
+     */
+    apiKey: string;
+}
+/**
+ * Check if a given object implements the PostZapierSetupResponse interface.
+ */
+export declare function instanceOfPostZapierSetupResponse(value: object): value is PostZapierSetupResponse;
+export declare function PostZapierSetupResponseFromJSON(json: any): PostZapierSetupResponse;
+export declare function PostZapierSetupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetupResponse;
+export declare function PostZapierSetupResponseToJSON(json: any): PostZapierSetupResponse;
+export declare function PostZapierSetupResponseToJSONTyped(value?: PostZapierSetupResponse | null, ignoreDiscriminator?: boolean): any;