@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/src/models/GetCourseVersionModule.ts

@@ -0,0 +1,126 @@
+/* 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 { GetCourseVersionItem } from './GetCourseVersionItem';
+import {
+    GetCourseVersionItemFromJSON,
+    GetCourseVersionItemFromJSONTyped,
+    GetCourseVersionItemToJSON,
+    GetCourseVersionItemToJSONTyped,
+} from './GetCourseVersionItem';
+import type { RichTextDocument } from './RichTextDocument';
+import {
+    RichTextDocumentFromJSON,
+    RichTextDocumentFromJSONTyped,
+    RichTextDocumentToJSON,
+    RichTextDocumentToJSONTyped,
+} from './RichTextDocument';
+
+/**
+ * 
+ * @export
+ * @interface GetCourseVersionModule
+ */
+export interface GetCourseVersionModule {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCourseVersionModule
+     */
+    description: string;
+    /**
+     * 
+     * @type {RichTextDocument}
+     * @memberof GetCourseVersionModule
+     */
+    descriptionRich: RichTextDocument;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetCourseVersionModule
+     */
+    displayOrder: number;
+    /**
+     * 
+     * @type {Array<GetCourseVersionItem>}
+     * @memberof GetCourseVersionModule
+     */
+    items: Array<GetCourseVersionItem>;
+}
+
+/**
+ * Check if a given object implements the GetCourseVersionModule interface.
+ */
+export function instanceOfGetCourseVersionModule(value: object): value is GetCourseVersionModule {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('descriptionRich' in value) || value['descriptionRich'] === undefined) return false;
+    if (!('displayOrder' in value) || value['displayOrder'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseVersionModuleFromJSON(json: any): GetCourseVersionModule {
+    return GetCourseVersionModuleFromJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseVersionModule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'description': json['description'],
+        'descriptionRich': RichTextDocumentFromJSON(json['description_rich']),
+        'displayOrder': json['display_order'],
+        'items': ((json['items'] as Array<any>).map(GetCourseVersionItemFromJSON)),
+    };
+}
+
+export function GetCourseVersionModuleToJSON(json: any): GetCourseVersionModule {
+    return GetCourseVersionModuleToJSONTyped(json, false);
+}
+
+export function GetCourseVersionModuleToJSONTyped(value?: GetCourseVersionModule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'description': value['description'],
+        'description_rich': RichTextDocumentToJSON(value['descriptionRich']),
+        'display_order': value['displayOrder'],
+        'items': ((value['items'] as Array<any>).map(GetCourseVersionItemToJSON)),
+    };
+}
+

package/src/models/GetEmailAssetUpload.ts

@@ -0,0 +1,93 @@
+/* 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 GetEmailAssetUpload
+ */
+export interface GetEmailAssetUpload {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    assetId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    publicUrl: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailAssetUpload
+     */
+    status: string;
+}
+
+/**
+ * Check if a given object implements the GetEmailAssetUpload interface.
+ */
+export function instanceOfGetEmailAssetUpload(value: object): value is GetEmailAssetUpload {
+    if (!('assetId' in value) || value['assetId'] === undefined) return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('publicUrl' in value) || value['publicUrl'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailAssetUploadFromJSON(json: any): GetEmailAssetUpload {
+    return GetEmailAssetUploadFromJSONTyped(json, false);
+}
+
+export function GetEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'assetId': json['asset_id'],
+        'uploadUrl': json['upload_url'],
+        'publicUrl': json['public_url'],
+        'status': json['status'],
+    };
+}
+
+export function GetEmailAssetUploadToJSON(json: any): GetEmailAssetUpload {
+    return GetEmailAssetUploadToJSONTyped(json, false);
+}
+
+export function GetEmailAssetUploadToJSONTyped(value?: GetEmailAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'asset_id': value['assetId'],
+        'upload_url': value['uploadUrl'],
+        'public_url': value['publicUrl'],
+        'status': value['status'],
+    };
+}
+

package/src/models/GetEmailDelivery.ts

@@ -0,0 +1,192 @@
+/* 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 GetEmailDelivery
+ */
+export interface GetEmailDelivery {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateKey: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    templateVersionId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    recipient: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof GetEmailDelivery
+     */
+    isTest: boolean;
+    /**
+     * 
+     * @type {GetEmailDeliveryStatusEnum}
+     * @memberof GetEmailDelivery
+     */
+    status: GetEmailDeliveryStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    attempts: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    providerMessageId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorCode?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailDelivery
+     */
+    lastErrorMessage?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    acceptedAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    deliveredAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDelivery
+     */
+    failedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetEmailDeliveryStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Accepted: 'accepted',
+    Delivered: 'delivered',
+    Deferred: 'deferred',
+    Failed: 'failed',
+    Complained: 'complained'
+} as const;
+export type GetEmailDeliveryStatusEnum = typeof GetEmailDeliveryStatusEnum[keyof typeof GetEmailDeliveryStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetEmailDelivery interface.
+ */
+export function instanceOfGetEmailDelivery(value: object): value is GetEmailDelivery {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('templateKey' in value) || value['templateKey'] === undefined) return false;
+    if (!('recipient' in value) || value['recipient'] === undefined) return false;
+    if (!('isTest' in value) || value['isTest'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('attempts' in value) || value['attempts'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailDeliveryFromJSON(json: any): GetEmailDelivery {
+    return GetEmailDeliveryFromJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDelivery {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'templateKey': json['template_key'],
+        'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
+        'recipient': json['recipient'],
+        'isTest': json['is_test'],
+        'status': json['status'],
+        'attempts': json['attempts'],
+        'providerMessageId': json['provider_message_id'] == null ? undefined : json['provider_message_id'],
+        'lastErrorCode': json['last_error_code'] == null ? undefined : json['last_error_code'],
+        'lastErrorMessage': json['last_error_message'] == null ? undefined : json['last_error_message'],
+        'createdAt': json['created_at'],
+        'acceptedAt': json['accepted_at'] == null ? undefined : json['accepted_at'],
+        'deliveredAt': json['delivered_at'] == null ? undefined : json['delivered_at'],
+        'failedAt': json['failed_at'] == null ? undefined : json['failed_at'],
+    };
+}
+
+export function GetEmailDeliveryToJSON(json: any): GetEmailDelivery {
+    return GetEmailDeliveryToJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryToJSONTyped(value?: GetEmailDelivery | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'template_key': value['templateKey'],
+        'template_version_id': value['templateVersionId'],
+        'recipient': value['recipient'],
+        'is_test': value['isTest'],
+        'status': value['status'],
+        'attempts': value['attempts'],
+        'provider_message_id': value['providerMessageId'],
+        'last_error_code': value['lastErrorCode'],
+        'last_error_message': value['lastErrorMessage'],
+        'created_at': value['createdAt'],
+        'accepted_at': value['acceptedAt'],
+        'delivered_at': value['deliveredAt'],
+        'failed_at': value['failedAt'],
+    };
+}
+

package/src/models/GetEmailDeliveryList.ts

@@ -0,0 +1,101 @@
+/* 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 { GetEmailDelivery } from './GetEmailDelivery';
+import {
+    GetEmailDeliveryFromJSON,
+    GetEmailDeliveryFromJSONTyped,
+    GetEmailDeliveryToJSON,
+    GetEmailDeliveryToJSONTyped,
+} from './GetEmailDelivery';
+
+/**
+ * 
+ * @export
+ * @interface GetEmailDeliveryList
+ */
+export interface GetEmailDeliveryList {
+    /**
+     * 
+     * @type {Array<GetEmailDelivery>}
+     * @memberof GetEmailDeliveryList
+     */
+    items: Array<GetEmailDelivery>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    total: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    page: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetEmailDeliveryList
+     */
+    pageSize: number;
+}
+
+/**
+ * Check if a given object implements the GetEmailDeliveryList interface.
+ */
+export function instanceOfGetEmailDeliveryList(value: object): value is GetEmailDeliveryList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailDeliveryListFromJSON(json: any): GetEmailDeliveryList {
+    return GetEmailDeliveryListFromJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailDeliveryList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(GetEmailDeliveryFromJSON)),
+        'total': json['total'],
+        'page': json['page'],
+        'pageSize': json['page_size'],
+    };
+}
+
+export function GetEmailDeliveryListToJSON(json: any): GetEmailDeliveryList {
+    return GetEmailDeliveryListToJSONTyped(json, false);
+}
+
+export function GetEmailDeliveryListToJSONTyped(value?: GetEmailDeliveryList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(GetEmailDeliveryToJSON)),
+        'total': value['total'],
+        'page': value['page'],
+        'page_size': value['pageSize'],
+    };
+}
+

package/src/models/GetEmailTemplate.ts

@@ -0,0 +1,137 @@
+/* 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 { EmailTemplateDefinition } from './EmailTemplateDefinition';
+import {
+    EmailTemplateDefinitionFromJSON,
+    EmailTemplateDefinitionFromJSONTyped,
+    EmailTemplateDefinitionToJSON,
+    EmailTemplateDefinitionToJSONTyped,
+} from './EmailTemplateDefinition';
+import type { EmailTemplateVersion } from './EmailTemplateVersion';
+import {
+    EmailTemplateVersionFromJSON,
+    EmailTemplateVersionFromJSONTyped,
+    EmailTemplateVersionToJSON,
+    EmailTemplateVersionToJSONTyped,
+} from './EmailTemplateVersion';
+
+/**
+ * 
+ * @export
+ * @interface GetEmailTemplate
+ */
+export interface GetEmailTemplate {
+    /**
+     * 
+     * @type {EmailTemplateDefinition}
+     * @memberof GetEmailTemplate
+     */
+    definition: EmailTemplateDefinition;
+    /**
+     * 
+     * @type {GetEmailTemplateEffectiveSourceEnum}
+     * @memberof GetEmailTemplate
+     */
+    effectiveSource: GetEmailTemplateEffectiveSourceEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetEmailTemplate
+     */
+    effectiveSourcePortalId?: string | null;
+    /**
+     * 
+     * @type {EmailTemplateVersion}
+     * @memberof GetEmailTemplate
+     */
+    effectiveVersion: EmailTemplateVersion;
+    /**
+     * 
+     * @type {EmailTemplateVersion}
+     * @memberof GetEmailTemplate
+     */
+    draftVersion?: EmailTemplateVersion | null;
+    /**
+     * 
+     * @type {Array<EmailTemplateVersion>}
+     * @memberof GetEmailTemplate
+     */
+    versions: Array<EmailTemplateVersion>;
+}
+
+
+/**
+ * @export
+ */
+export const GetEmailTemplateEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type GetEmailTemplateEffectiveSourceEnum = typeof GetEmailTemplateEffectiveSourceEnum[keyof typeof GetEmailTemplateEffectiveSourceEnum];
+
+
+/**
+ * Check if a given object implements the GetEmailTemplate interface.
+ */
+export function instanceOfGetEmailTemplate(value: object): value is GetEmailTemplate {
+    if (!('definition' in value) || value['definition'] === undefined) return false;
+    if (!('effectiveSource' in value) || value['effectiveSource'] === undefined) return false;
+    if (!('effectiveVersion' in value) || value['effectiveVersion'] === undefined) return false;
+    if (!('versions' in value) || value['versions'] === undefined) return false;
+    return true;
+}
+
+export function GetEmailTemplateFromJSON(json: any): GetEmailTemplate {
+    return GetEmailTemplateFromJSONTyped(json, false);
+}
+
+export function GetEmailTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetEmailTemplate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'definition': EmailTemplateDefinitionFromJSON(json['definition']),
+        'effectiveSource': json['effective_source'],
+        'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
+        'effectiveVersion': EmailTemplateVersionFromJSON(json['effective_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : EmailTemplateVersionFromJSON(json['draft_version']),
+        'versions': ((json['versions'] as Array<any>).map(EmailTemplateVersionFromJSON)),
+    };
+}
+
+export function GetEmailTemplateToJSON(json: any): GetEmailTemplate {
+    return GetEmailTemplateToJSONTyped(json, false);
+}
+
+export function GetEmailTemplateToJSONTyped(value?: GetEmailTemplate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'definition': EmailTemplateDefinitionToJSON(value['definition']),
+        'effective_source': value['effectiveSource'],
+        'effective_source_portal_id': value['effectiveSourcePortalId'],
+        'effective_version': EmailTemplateVersionToJSON(value['effectiveVersion']),
+        'draft_version': EmailTemplateVersionToJSON(value['draftVersion']),
+        'versions': ((value['versions'] as Array<any>).map(EmailTemplateVersionToJSON)),
+    };
+}
+