@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/src/models/PutCourseVersionItem.ts

@@ -0,0 +1,140 @@
+/* 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 { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
+/**
+ * 
+ * @export
+ * @interface PutCourseVersionItem
+ */
+export interface PutCourseVersionItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCourseVersionItem
+     */
+    contentLibraryVersionId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutCourseVersionItem
+     */
+    displayName?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutCourseVersionItem
+     */
+    displayOrder?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutCourseVersionItem
+     */
+    isVisible?: boolean;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof PutCourseVersionItem
+     */
+    launchMode?: ContentLaunchMode;
+    /**
+     * 
+     * @type {number}
+     * @memberof PutCourseVersionItem
+     */
+    maxAttempts?: number;
+    /**
+     * 
+     * @type {PutCourseVersionItemScoreRollupStrategyEnum}
+     * @memberof PutCourseVersionItem
+     */
+    scoreRollupStrategy?: PutCourseVersionItemScoreRollupStrategyEnum;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PutCourseVersionItem
+     */
+    settings?: { [key: string]: any; };
+}
+
+
+/**
+ * @export
+ */
+export const PutCourseVersionItemScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type PutCourseVersionItemScoreRollupStrategyEnum = typeof PutCourseVersionItemScoreRollupStrategyEnum[keyof typeof PutCourseVersionItemScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the PutCourseVersionItem interface.
+ */
+export function instanceOfPutCourseVersionItem(value: object): value is PutCourseVersionItem {
+    return true;
+}
+
+export function PutCourseVersionItemFromJSON(json: any): PutCourseVersionItem {
+    return PutCourseVersionItemFromJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCourseVersionItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_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 PutCourseVersionItemToJSON(json: any): PutCourseVersionItem {
+    return PutCourseVersionItemToJSONTyped(json, false);
+}
+
+export function PutCourseVersionItemToJSONTyped(value?: PutCourseVersionItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_library_version_id': value['contentLibraryVersionId'],
+        '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/src/models/PutEmailTemplateDraft.ts

@@ -0,0 +1,107 @@
+/* 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 PutEmailTemplateDraft
+ */
+export interface PutEmailTemplateDraft {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    subjectTemplate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    preheaderTemplate?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    fromNameTemplate?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    replyTo?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PutEmailTemplateDraft
+     */
+    designDocument: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof PutEmailTemplateDraft
+     */
+    changeNotes?: string | null;
+}
+
+/**
+ * Check if a given object implements the PutEmailTemplateDraft interface.
+ */
+export function instanceOfPutEmailTemplateDraft(value: object): value is PutEmailTemplateDraft {
+    if (!('subjectTemplate' in value) || value['subjectTemplate'] === undefined) return false;
+    if (!('designDocument' in value) || value['designDocument'] === undefined) return false;
+    return true;
+}
+
+export function PutEmailTemplateDraftFromJSON(json: any): PutEmailTemplateDraft {
+    return PutEmailTemplateDraftFromJSONTyped(json, false);
+}
+
+export function PutEmailTemplateDraftFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutEmailTemplateDraft {
+    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 PutEmailTemplateDraftToJSON(json: any): PutEmailTemplateDraft {
+    return PutEmailTemplateDraftToJSONTyped(json, false);
+}
+
+export function PutEmailTemplateDraftToJSONTyped(value?: PutEmailTemplateDraft | null, ignoreDiscriminator: boolean = false): any {
+    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/src/models/PutResource.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 PutResource
+ */
+export interface PutResource {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutResource
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutResource
+     */
+    description?: string;
+}
+
+/**
+ * Check if a given object implements the PutResource interface.
+ */
+export function instanceOfPutResource(value: object): value is PutResource {
+    return true;
+}
+
+export function PutResourceFromJSON(json: any): PutResource {
+    return PutResourceFromJSONTyped(json, false);
+}
+
+export function PutResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+    };
+}
+
+export function PutResourceToJSON(json: any): PutResource {
+    return PutResourceToJSONTyped(json, false);
+}
+
+export function PutResourceToJSONTyped(value?: PutResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+    };
+}
+

package/src/models/PutResourceVersion.ts

@@ -0,0 +1,97 @@
+/* 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 { RichTextInput } from './RichTextInput';
+import {
+    RichTextInputFromJSON,
+    RichTextInputFromJSONTyped,
+    RichTextInputToJSON,
+    RichTextInputToJSONTyped,
+} from './RichTextInput';
+
+/**
+ * 
+ * @export
+ * @interface PutResourceVersion
+ */
+export interface PutResourceVersion {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutResourceVersion
+     */
+    changeNotes?: string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof PutResourceVersion
+     */
+    metadata?: { [key: string]: any; };
+    /**
+     * 
+     * @type {string}
+     * @memberof PutResourceVersion
+     */
+    linkUrl?: string | null;
+    /**
+     * 
+     * @type {RichTextInput}
+     * @memberof PutResourceVersion
+     */
+    richText?: RichTextInput | null;
+}
+
+/**
+ * Check if a given object implements the PutResourceVersion interface.
+ */
+export function instanceOfPutResourceVersion(value: object): value is PutResourceVersion {
+    return true;
+}
+
+export function PutResourceVersionFromJSON(json: any): PutResourceVersion {
+    return PutResourceVersionFromJSONTyped(json, false);
+}
+
+export function PutResourceVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutResourceVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+        'linkUrl': json['link_url'] == null ? undefined : json['link_url'],
+        'richText': json['rich_text'] == null ? undefined : RichTextInputFromJSON(json['rich_text']),
+    };
+}
+
+export function PutResourceVersionToJSON(json: any): PutResourceVersion {
+    return PutResourceVersionToJSONTyped(json, false);
+}
+
+export function PutResourceVersionToJSONTyped(value?: PutResourceVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'change_notes': value['changeNotes'],
+        'metadata': value['metadata'],
+        'link_url': value['linkUrl'],
+        'rich_text': RichTextInputToJSON(value['richText']),
+    };
+}
+

package/src/models/ResourceType.ts

@@ -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.
+ */
+
+
+/**
+ * Resource payload type.
+ * @export
+ */
+export const ResourceType = {
+    Scorm: 'scorm',
+    Video: 'video',
+    Audio: 'audio',
+    Image: 'image',
+    Pdf: 'pdf',
+    Powerpoint: 'powerpoint',
+    File: 'file',
+    Link: 'link',
+    RichText: 'rich_text'
+} as const;
+export type ResourceType = typeof ResourceType[keyof typeof ResourceType];
+
+
+export function instanceOfResourceType(value: any): boolean {
+    for (const key in ResourceType) {
+        if (Object.prototype.hasOwnProperty.call(ResourceType, key)) {
+            if (ResourceType[key as keyof typeof ResourceType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ResourceTypeFromJSON(json: any): ResourceType {
+    return ResourceTypeFromJSONTyped(json, false);
+}
+
+export function ResourceTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResourceType {
+    return json as ResourceType;
+}
+
+export function ResourceTypeToJSON(value?: ResourceType | null): any {
+    return value as any;
+}
+
+export function ResourceTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): ResourceType {
+    return value as ResourceType;
+}
+

package/src/models/index.ts

@@ -8,12 +8,17 @@ export * from './ContentAttemptRollupScore';
 export * from './ContentAttemptScore';
 export * from './ContentAttemptSettings';
 export * from './ContentLaunchMode';
+export * from './ContentLibraryVersionStatus';
 export * from './CourseCatalog';
 export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
 export * from './EffectiveCertificateConfig';
+export * from './EmailTemplateDefinition';
+export * from './EmailTemplateScope';
+export * from './EmailTemplateVariable';
+export * from './EmailTemplateVersion';
 export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
@@ -32,6 +37,7 @@ export * from './GetContentInstructorBasicReporting';
 export * from './GetContentInstructorBasicReportingContentInfo';
 export * from './GetContentInstructorBasicReportingEngagement';
 export * from './GetContentInstructorBasicReportingPerformance';
+export * from './GetContentLibraryVersion';
 export * from './GetContentList';
 export * from './GetContentSession';
 export * from './GetContentSessionDetail';
@@ -62,6 +68,18 @@ export * from './GetCourseStudentReportingCourseInfo';
 export * from './GetCourseStudentReportingEngagement';
 export * from './GetCourseStudentReportingModulesInner';
 export * from './GetCourseStudentReportingPerformance';
+export * from './GetCourseVersion';
+export * from './GetCourseVersionItem';
+export * from './GetCourseVersionItemLaunch';
+export * from './GetCourseVersionItemSession';
+export * from './GetCourseVersionList';
+export * from './GetCourseVersionModule';
+export * from './GetEmailAssetUpload';
+export * from './GetEmailDelivery';
+export * from './GetEmailDeliveryList';
+export * from './GetEmailTemplate';
+export * from './GetEmailTemplateList';
+export * from './GetEmailTemplatePreview';
 export * from './GetManualQuestionSelectionItem';
 export * from './GetManualQuestionSelectionList';
 export * from './GetModule';
@@ -139,6 +157,11 @@ export * from './GetQuizResultsQuestionsInnerStudentAnswer';
 export * from './GetQuizResultsScore';
 export * from './GetQuizResultsTiming';
 export * from './GetQuizStatistics';
+export * from './GetResource';
+export * from './GetResourceList';
+export * from './GetResourceUsage';
+export * from './GetResourceUsageCoursesInner';
+export * from './GetResourceVersionUpload';
 export * from './GetRichTextAssetUpload';
 export * from './GetRole';
 export * from './GetScormApiLogItem';
@@ -202,12 +225,20 @@ export * from './PostConversation';
 export * from './PostConversationResponse';
 export * from './PostCourse';
 export * from './PostCourseCatalog';
+export * from './PostCourseDraft';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
 export * from './PostCourseResume';
+export * from './PostCourseVersionItem';
+export * from './PostCourseVersionItemSession';
+export * from './PostCourseVersionPublish';
 export * from './PostDuplicate';
 export * from './PostDuplicate1';
 export * from './PostDuplicate2';
+export * from './PostEmailAssetComplete';
+export * from './PostEmailAssetUpload';
+export * from './PostEmailTemplatePreview';
+export * from './PostEmailTemplateTestSend';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostMessage';
@@ -236,6 +267,10 @@ export * from './PostQuizQuestions';
 export * from './PostQuizQuestionsQuestionsInner';
 export * from './PostQuizSettings';
 export * from './PostResetPassword';
+export * from './PostResource';
+export * from './PostResourceVersion';
+export * from './PostResourceVersionComplete';
+export * from './PostResourceVersionUpload';
 export * from './PostRevokeCertificate';
 export * from './PostRichTextAssetComplete';
 export * from './PostRichTextAssetUpload';
@@ -256,6 +291,8 @@ export * from './PutContentVersion';
 export * from './PutCourse';
 export * from './PutCourseCatalog';
 export * from './PutCourseEnrollment';
+export * from './PutCourseVersionItem';
+export * from './PutEmailTemplateDraft';
 export * from './PutModule';
 export * from './PutModuleReorder';
 export * from './PutPortalBranding';
@@ -272,6 +309,8 @@ export * from './PutQuizAnswerResponseNextQuestion';
 export * from './PutQuizAnswerResponseNextQuestionAnswerChoicesInner';
 export * from './PutQuizAnswerResponseProgress';
 export * from './PutQuizSettings';
+export * from './PutResource';
+export * from './PutResourceVersion';
 export * from './PutRole';
 export * from './PutRolePermissions';
 export * from './PutSupportTicket';
@@ -279,6 +318,7 @@ export * from './PutUser';
 export * from './QuizContent';
 export * from './QuizContentAssignment';
 export * from './QuizContentSettings';
+export * from './ResourceType';
 export * from './RichTextAsset';
 export * from './RichTextDocument';
 export * from './RichTextInput';