@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/dist/esm/models/PostCourseVersionItem.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 type { ContentLaunchMode } from './ContentLaunchMode';
+/**
+ *
+ * @export
+ * @interface PostCourseVersionItem
+ */
+export interface PostCourseVersionItem {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryItemId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    contentLibraryVersionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    moduleId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionItem
+     */
+    displayName?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    displayOrder?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostCourseVersionItem
+     */
+    isVisible?: boolean;
+    /**
+     *
+     * @type {ContentLaunchMode}
+     * @memberof PostCourseVersionItem
+     */
+    launchMode?: ContentLaunchMode;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCourseVersionItem
+     */
+    maxAttempts?: number;
+    /**
+     *
+     * @type {PostCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof PostCourseVersionItem
+     */
+    scoreRollupStrategy?: PostCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PostCourseVersionItem
+     */
+    settings?: {
+        [key: string]: any;
+    };
+}
+/**
+ * @export
+ */
+export declare const PostCourseVersionItemScoreRollupStrategyEnum: {
+    readonly Latest: "Latest";
+    readonly Best: "Best";
+};
+export type PostCourseVersionItemScoreRollupStrategyEnum = typeof PostCourseVersionItemScoreRollupStrategyEnum[keyof typeof PostCourseVersionItemScoreRollupStrategyEnum];
+/**
+ * Check if a given object implements the PostCourseVersionItem interface.
+ */
+export declare function instanceOfPostCourseVersionItem(value: object): value is PostCourseVersionItem;
+export declare function PostCourseVersionItemFromJSON(json: any): PostCourseVersionItem;
+export declare function PostCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItem;
+export declare function PostCourseVersionItemToJSON(json: any): PostCourseVersionItem;
+export declare function PostCourseVersionItemToJSONTyped(value?: PostCourseVersionItem | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseVersionItem.js

@@ -0,0 +1,71 @@
+/* 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 { ContentLaunchModeFromJSON, ContentLaunchModeToJSON, } from './ContentLaunchMode';
+/**
+ * @export
+ */
+export const PostCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+};
+/**
+ * Check if a given object implements the PostCourseVersionItem interface.
+ */
+export function instanceOfPostCourseVersionItem(value) {
+    if (!('contentLibraryItemId' in value) || value['contentLibraryItemId'] === undefined)
+        return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined)
+        return false;
+    return true;
+}
+export function PostCourseVersionItemFromJSON(json) {
+    return PostCourseVersionItemFromJSONTyped(json, false);
+}
+export function PostCourseVersionItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'contentLibraryItemId': json['content_library_item_id'],
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
+        'moduleId': json['module_id'],
+        'displayName': json['display_name'] == null ? undefined : json['display_name'],
+        'displayOrder': json['display_order'] == null ? undefined : json['display_order'],
+        'isVisible': json['is_visible'] == null ? undefined : json['is_visible'],
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
+        'maxAttempts': json['max_attempts'] == null ? undefined : json['max_attempts'],
+        'scoreRollupStrategy': json['score_rollup_strategy'] == null ? undefined : json['score_rollup_strategy'],
+        'settings': json['settings'] == null ? undefined : json['settings'],
+    };
+}
+export function PostCourseVersionItemToJSON(json) {
+    return PostCourseVersionItemToJSONTyped(json, false);
+}
+export function PostCourseVersionItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'content_library_item_id': value['contentLibraryItemId'],
+        'content_library_version_id': value['contentLibraryVersionId'],
+        'module_id': value['moduleId'],
+        'display_name': value['displayName'],
+        'display_order': value['displayOrder'],
+        'is_visible': value['isVisible'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
+        'max_attempts': value['maxAttempts'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+        'settings': value['settings'],
+    };
+}

package/dist/esm/models/PostCourseVersionItemSession.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ * Start or resume a learner attempt for an exact course resource version.
+ * @export
+ * @interface PostCourseVersionItemSession
+ */
+export interface PostCourseVersionItemSession {
+    /**
+     * Create a new attempt instead of returning the current attempt.
+     * @type {boolean}
+     * @memberof PostCourseVersionItemSession
+     */
+    retake?: boolean;
+}
+/**
+ * Check if a given object implements the PostCourseVersionItemSession interface.
+ */
+export declare function instanceOfPostCourseVersionItemSession(value: object): value is PostCourseVersionItemSession;
+export declare function PostCourseVersionItemSessionFromJSON(json: any): PostCourseVersionItemSession;
+export declare function PostCourseVersionItemSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionItemSession;
+export declare function PostCourseVersionItemSessionToJSON(json: any): PostCourseVersionItemSession;
+export declare function PostCourseVersionItemSessionToJSONTyped(value?: PostCourseVersionItemSession | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseVersionItemSession.js

@@ -0,0 +1,41 @@
+/* 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 PostCourseVersionItemSession interface.
+ */
+export function instanceOfPostCourseVersionItemSession(value) {
+    return true;
+}
+export function PostCourseVersionItemSessionFromJSON(json) {
+    return PostCourseVersionItemSessionFromJSONTyped(json, false);
+}
+export function PostCourseVersionItemSessionFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'retake': json['retake'] == null ? undefined : json['retake'],
+    };
+}
+export function PostCourseVersionItemSessionToJSON(json) {
+    return PostCourseVersionItemSessionToJSONTyped(json, false);
+}
+export function PostCourseVersionItemSessionToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'retake': value['retake'],
+    };
+}

package/dist/esm/models/PostCourseVersionPublish.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 PostCourseVersionPublish
+ */
+export interface PostCourseVersionPublish {
+    /**
+     *
+     * @type {string}
+     * @memberof PostCourseVersionPublish
+     */
+    changeNotes?: string;
+}
+/**
+ * Check if a given object implements the PostCourseVersionPublish interface.
+ */
+export declare function instanceOfPostCourseVersionPublish(value: object): value is PostCourseVersionPublish;
+export declare function PostCourseVersionPublishFromJSON(json: any): PostCourseVersionPublish;
+export declare function PostCourseVersionPublishFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCourseVersionPublish;
+export declare function PostCourseVersionPublishToJSON(json: any): PostCourseVersionPublish;
+export declare function PostCourseVersionPublishToJSONTyped(value?: PostCourseVersionPublish | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCourseVersionPublish.js

@@ -0,0 +1,41 @@
+/* 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 PostCourseVersionPublish interface.
+ */
+export function instanceOfPostCourseVersionPublish(value) {
+    return true;
+}
+export function PostCourseVersionPublishFromJSON(json) {
+    return PostCourseVersionPublishFromJSONTyped(json, false);
+}
+export function PostCourseVersionPublishFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PostCourseVersionPublishToJSON(json) {
+    return PostCourseVersionPublishToJSONTyped(json, false);
+}
+export function PostCourseVersionPublishToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'change_notes': value['changeNotes'],
+    };
+}

package/dist/esm/models/PostEmailAssetComplete.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 PostEmailAssetComplete
+ */
+export interface PostEmailAssetComplete {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailAssetComplete
+     */
+    checksumSha256: string;
+}
+/**
+ * Check if a given object implements the PostEmailAssetComplete interface.
+ */
+export declare function instanceOfPostEmailAssetComplete(value: object): value is PostEmailAssetComplete;
+export declare function PostEmailAssetCompleteFromJSON(json: any): PostEmailAssetComplete;
+export declare function PostEmailAssetCompleteFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetComplete;
+export declare function PostEmailAssetCompleteToJSON(json: any): PostEmailAssetComplete;
+export declare function PostEmailAssetCompleteToJSONTyped(value?: PostEmailAssetComplete | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailAssetComplete.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 PostEmailAssetComplete interface.
+ */
+export function instanceOfPostEmailAssetComplete(value) {
+    if (!('checksumSha256' in value) || value['checksumSha256'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailAssetCompleteFromJSON(json) {
+    return PostEmailAssetCompleteFromJSONTyped(json, false);
+}
+export function PostEmailAssetCompleteFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'checksumSha256': json['checksum_sha256'],
+    };
+}
+export function PostEmailAssetCompleteToJSON(json) {
+    return PostEmailAssetCompleteToJSONTyped(json, false);
+}
+export function PostEmailAssetCompleteToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'checksum_sha256': value['checksumSha256'],
+    };
+}

package/dist/esm/models/PostEmailAssetUpload.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 PostEmailAssetUpload
+ */
+export interface PostEmailAssetUpload {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailAssetUpload
+     */
+    filename: string;
+    /**
+     *
+     * @type {PostEmailAssetUploadContentTypeEnum}
+     * @memberof PostEmailAssetUpload
+     */
+    contentType: PostEmailAssetUploadContentTypeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PostEmailAssetUpload
+     */
+    byteSize: number;
+}
+/**
+ * @export
+ */
+export declare const PostEmailAssetUploadContentTypeEnum: {
+    readonly ImagePng: "image/png";
+    readonly ImageJpeg: "image/jpeg";
+    readonly ImageWebp: "image/webp";
+    readonly ImageGif: "image/gif";
+};
+export type PostEmailAssetUploadContentTypeEnum = typeof PostEmailAssetUploadContentTypeEnum[keyof typeof PostEmailAssetUploadContentTypeEnum];
+/**
+ * Check if a given object implements the PostEmailAssetUpload interface.
+ */
+export declare function instanceOfPostEmailAssetUpload(value: object): value is PostEmailAssetUpload;
+export declare function PostEmailAssetUploadFromJSON(json: any): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadToJSON(json: any): PostEmailAssetUpload;
+export declare function PostEmailAssetUploadToJSONTyped(value?: PostEmailAssetUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailAssetUpload.js

@@ -0,0 +1,60 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const PostEmailAssetUploadContentTypeEnum = {
+    ImagePng: 'image/png',
+    ImageJpeg: 'image/jpeg',
+    ImageWebp: 'image/webp',
+    ImageGif: 'image/gif'
+};
+/**
+ * Check if a given object implements the PostEmailAssetUpload interface.
+ */
+export function instanceOfPostEmailAssetUpload(value) {
+    if (!('filename' in value) || value['filename'] === undefined)
+        return false;
+    if (!('contentType' in value) || value['contentType'] === undefined)
+        return false;
+    if (!('byteSize' in value) || value['byteSize'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailAssetUploadFromJSON(json) {
+    return PostEmailAssetUploadFromJSONTyped(json, false);
+}
+export function PostEmailAssetUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'filename': json['filename'],
+        'contentType': json['content_type'],
+        'byteSize': json['byte_size'],
+    };
+}
+export function PostEmailAssetUploadToJSON(json) {
+    return PostEmailAssetUploadToJSONTyped(json, false);
+}
+export function PostEmailAssetUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'filename': value['filename'],
+        'content_type': value['contentType'],
+        'byte_size': value['byteSize'],
+    };
+}

package/dist/esm/models/PostEmailTemplatePreview.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 PostEmailTemplatePreview
+ */
+export interface PostEmailTemplatePreview {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    subjectTemplate: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    preheaderTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    fromNameTemplate?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    replyTo?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: any; }}
+     * @memberof PostEmailTemplatePreview
+     */
+    designDocument: {
+        [key: string]: any;
+    };
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplatePreview
+     */
+    changeNotes?: string | null;
+}
+/**
+ * Check if a given object implements the PostEmailTemplatePreview interface.
+ */
+export declare function instanceOfPostEmailTemplatePreview(value: object): value is PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewFromJSON(json: any): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewToJSON(json: any): PostEmailTemplatePreview;
+export declare function PostEmailTemplatePreviewToJSONTyped(value?: PostEmailTemplatePreview | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostEmailTemplatePreview.js

@@ -0,0 +1,55 @@
+/* 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 PostEmailTemplatePreview interface.
+ */
+export function instanceOfPostEmailTemplatePreview(value) {
+    if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined)
+        return false;
+    if (!('designDocument' in value) || value['designDocument'] === undefined)
+        return false;
+    return true;
+}
+export function PostEmailTemplatePreviewFromJSON(json) {
+    return PostEmailTemplatePreviewFromJSONTyped(json, false);
+}
+export function PostEmailTemplatePreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'subjectTemplate': json['subject_template'],
+        'preheaderTemplate': json['preheader_template'] == null ? undefined : json['preheader_template'],
+        'fromNameTemplate': json['from_name_template'] == null ? undefined : json['from_name_template'],
+        'replyTo': json['reply_to'] == null ? undefined : json['reply_to'],
+        'designDocument': json['design_document'],
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+    };
+}
+export function PostEmailTemplatePreviewToJSON(json) {
+    return PostEmailTemplatePreviewToJSONTyped(json, false);
+}
+export function PostEmailTemplatePreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'subject_template': value['subjectTemplate'],
+        'preheader_template': value['preheaderTemplate'],
+        'from_name_template': value['fromNameTemplate'],
+        'reply_to': value['replyTo'],
+        'design_document': value['designDocument'],
+        'change_notes': value['changeNotes'],
+    };
+}

package/dist/esm/models/PostEmailTemplateTestSend.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 PostEmailTemplateTestSend
+ */
+export interface PostEmailTemplateTestSend {
+    /**
+     *
+     * @type {string}
+     * @memberof PostEmailTemplateTestSend
+     */
+    recipient: string;
+}
+/**
+ * Check if a given object implements the PostEmailTemplateTestSend interface.
+ */
+export declare function instanceOfPostEmailTemplateTestSend(value: object): value is PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendFromJSON(json: any): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendToJSON(json: any): PostEmailTemplateTestSend;
+export declare function PostEmailTemplateTestSendToJSONTyped(value?: PostEmailTemplateTestSend | null, ignoreDiscriminator?: boolean): any;