@easyedu/js-lsm-api 1.113.0 → 1.115.0

package/src/models/GetZapierSetup.ts

@@ -0,0 +1,90 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { GetPermission } from './GetPermission';
+import {
+    GetPermissionFromJSON,
+    GetPermissionFromJSONTyped,
+    GetPermissionToJSON,
+    GetPermissionToJSONTyped,
+} from './GetPermission';
+import type { ZapierIntegration } from './ZapierIntegration';
+import {
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationFromJSONTyped,
+    ZapierIntegrationToJSON,
+    ZapierIntegrationToJSONTyped,
+} 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 function instanceOfGetZapierSetup(value: object): value is GetZapierSetup {
+    if (!('availablePermissions' in value) || value['availablePermissions'] === undefined) return false;
+    if (!('integrations' in value) || value['integrations'] === undefined) return false;
+    return true;
+}
+
+export function GetZapierSetupFromJSON(json: any): GetZapierSetup {
+    return GetZapierSetupFromJSONTyped(json, false);
+}
+
+export function GetZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetZapierSetup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'availablePermissions': ((json['available_permissions'] as Array<any>).map(GetPermissionFromJSON)),
+        'integrations': ((json['integrations'] as Array<any>).map(ZapierIntegrationFromJSON)),
+    };
+}
+
+export function GetZapierSetupToJSON(json: any): GetZapierSetup {
+    return GetZapierSetupToJSONTyped(json, false);
+}
+
+export function GetZapierSetupToJSONTyped(value?: GetZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'available_permissions': ((value['availablePermissions'] as Array<any>).map(GetPermissionToJSON)),
+        'integrations': ((value['integrations'] as Array<any>).map(ZapierIntegrationToJSON)),
+    };
+}
+

package/src/models/PostZapierSetup.ts

@@ -0,0 +1,75 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfPostZapierSetup(value: object): value is PostZapierSetup {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('permissionKeys' in value) || value['permissionKeys'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSetupFromJSON(json: any): PostZapierSetup {
+    return PostZapierSetupFromJSONTyped(json, false);
+}
+
+export function PostZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'permissionKeys': new Set(json['permission_keys']),
+    };
+}
+
+export function PostZapierSetupToJSON(json: any): PostZapierSetup {
+    return PostZapierSetupToJSONTyped(json, false);
+}
+
+export function PostZapierSetupToJSONTyped(value?: PostZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'permission_keys': Array.from(value['permissionKeys'] as Set<any>),
+    };
+}
+

package/src/models/PostZapierSetupResponse.ts

@@ -0,0 +1,83 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+import type { ZapierIntegration } from './ZapierIntegration';
+import {
+    ZapierIntegrationFromJSON,
+    ZapierIntegrationFromJSONTyped,
+    ZapierIntegrationToJSON,
+    ZapierIntegrationToJSONTyped,
+} 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 function instanceOfPostZapierSetupResponse(value: object): value is PostZapierSetupResponse {
+    if (!('integration' in value) || value['integration'] === undefined) return false;
+    if (!('apiKey' in value) || value['apiKey'] === undefined) return false;
+    return true;
+}
+
+export function PostZapierSetupResponseFromJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseFromJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostZapierSetupResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'integration': ZapierIntegrationFromJSON(json['integration']),
+        'apiKey': json['api_key'],
+    };
+}
+
+export function PostZapierSetupResponseToJSON(json: any): PostZapierSetupResponse {
+    return PostZapierSetupResponseToJSONTyped(json, false);
+}
+
+export function PostZapierSetupResponseToJSONTyped(value?: PostZapierSetupResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'integration': ZapierIntegrationToJSON(value['integration']),
+        'api_key': value['apiKey'],
+    };
+}
+

package/src/models/PutZapierSetup.ts

@@ -0,0 +1,73 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @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 function instanceOfPutZapierSetup(value: object): value is PutZapierSetup {
+    return true;
+}
+
+export function PutZapierSetupFromJSON(json: any): PutZapierSetup {
+    return PutZapierSetupFromJSONTyped(json, false);
+}
+
+export function PutZapierSetupFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutZapierSetup {
+    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: any): PutZapierSetup {
+    return PutZapierSetupToJSONTyped(json, false);
+}
+
+export function PutZapierSetupToJSONTyped(value?: PutZapierSetup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'permission_keys': value['permissionKeys'] == null ? undefined : Array.from(value['permissionKeys'] as Set<any>),
+    };
+}
+

package/src/models/ZapierIntegration.ts

@@ -0,0 +1,154 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 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 function instanceOfZapierIntegration(value: object): value is ZapierIntegration {
+    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: any): ZapierIntegration {
+    return ZapierIntegrationFromJSONTyped(json, false);
+}
+
+export function ZapierIntegrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ZapierIntegration {
+    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: any): ZapierIntegration {
+    return ZapierIntegrationToJSONTyped(json, false);
+}
+
+export function ZapierIntegrationToJSONTyped(value?: ZapierIntegration | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/index.ts

@@ -27,6 +27,7 @@ export * from './CertificateRenewalPolicy';
 export * from './CertificateTemplate';
 export * from './CertificateTemplateVersion';
 export * from './ChatDailyUsage';
+export * from './ChatFeatureUsage';
 export * from './ChatModelUsage';
 export * from './ChatQuota';
 export * from './ChatQuotaExceeded';
@@ -160,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';
@@ -251,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';
@@ -288,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';
@@ -308,3 +314,4 @@ export * from './SupportTicketUser';
 export * from './UpdateSelectedPortalResponse';
 export * from './UpdateSelectedPortalResponseHostPortal';
 export * from './UpdateSelectedPortalResponseSelectedPortal';
+export * from './ZapierIntegration';