@easyedu/js-lsm-api 1.65.0 → 1.67.0

package/src/models/PostContentSession.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
 /**
  * A content session
  * @export
@@ -37,6 +45,12 @@ export interface PostContentSession {
      * @memberof PostContentSession
      */
     launchUrl: string;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof PostContentSession
+     */
+    launchMode: ContentLaunchMode;
     /**
      * The date and time the content session was created
      * @type {number}
@@ -51,6 +65,8 @@ export interface PostContentSession {
     playerSessionId?: string | null;
 }
 
+
+
 /**
  * Check if a given object implements the PostContentSession interface.
  */
@@ -58,6 +74,7 @@ export function instanceOfPostContentSession(value: object): value is PostConten
     if (!('contentId' in value) || value['contentId'] === undefined) return false;
     if (!('userId' in value) || value['userId'] === undefined) return false;
     if (!('launchUrl' in value) || value['launchUrl'] === undefined) return false;
+    if (!('launchMode' in value) || value['launchMode'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     return true;
 }
@@ -75,6 +92,7 @@ export function PostContentSessionFromJSONTyped(json: any, ignoreDiscriminator:
         'contentId': json['content_id'],
         'userId': json['user_id'],
         'launchUrl': json['launch_url'],
+        'launchMode': ContentLaunchModeFromJSON(json['launch_mode']),
         'createdAt': json['created_at'],
         'playerSessionId': json['player_session_id'] == null ? undefined : json['player_session_id'],
     };
@@ -94,6 +112,7 @@ export function PostContentSessionToJSONTyped(value?: PostContentSession | null,
         'content_id': value['contentId'],
         'user_id': value['userId'],
         'launch_url': value['launchUrl'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
         'created_at': value['createdAt'],
         'player_session_id': value['playerSessionId'],
     };

package/src/models/PostCourse.ts

@@ -31,8 +31,40 @@ export interface PostCourse {
      * @memberof PostCourse
      */
     description: string;
+    /**
+     * Course-level learner access policy. If omitted, new courses default to
+     * duration_days with 90 days.
+     * 
+     * @type {PostCourseAccessPolicyTypeEnum}
+     * @memberof PostCourse
+     */
+    accessPolicyType?: PostCourseAccessPolicyTypeEnum;
+    /**
+     * Number of access days from enrollment start when access_policy_type is duration_days.
+     * @type {number}
+     * @memberof PostCourse
+     */
+    accessDurationDays?: number | null;
+    /**
+     * Fixed Unix timestamp when access expires when access_policy_type is fixed_end_date.
+     * @type {number}
+     * @memberof PostCourse
+     */
+    accessFixedEndAt?: number | null;
 }
 
+
+/**
+ * @export
+ */
+export const PostCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+} as const;
+export type PostCourseAccessPolicyTypeEnum = typeof PostCourseAccessPolicyTypeEnum[keyof typeof PostCourseAccessPolicyTypeEnum];
+
+
 /**
  * Check if a given object implements the PostCourse interface.
  */
@@ -54,6 +86,9 @@ export function PostCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'name': json['name'],
         'description': json['description'],
+        'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
+        'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
+        'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
     };
 }
 
@@ -70,6 +105,9 @@ export function PostCourseToJSONTyped(value?: PostCourse | null, ignoreDiscrimin
         
         'name': value['name'],
         'description': value['description'],
+        'access_policy_type': value['accessPolicyType'],
+        'access_duration_days': value['accessDurationDays'],
+        'access_fixed_end_at': value['accessFixedEndAt'],
     };
 }
 

package/src/models/PostCourseEnrollment.ts

@@ -30,7 +30,7 @@ export interface PostCourseEnrollment {
      * @type {number}
      * @memberof PostCourseEnrollment
      */
-    enrollmentDateStart: number;
+    enrollmentDateStart?: number;
     /**
      * End date of the enrollment (Unix timestamp)
      * @type {number}
@@ -49,6 +49,15 @@ export interface PostCourseEnrollment {
      * @memberof PostCourseEnrollment
      */
     userType?: PostCourseEnrollmentUserTypeEnum | null;
+    /**
+     * How to handle a learner with a prior terminal enrollment for this course.
+     * restart creates a new enrollment period; resume reopens the latest terminal
+     * enrollment. Active enrollments always conflict.
+     * 
+     * @type {PostCourseEnrollmentReEnrollmentModeEnum}
+     * @memberof PostCourseEnrollment
+     */
+    reEnrollmentMode?: PostCourseEnrollmentReEnrollmentModeEnum | null;
 }
 
 
@@ -61,13 +70,21 @@ export const PostCourseEnrollmentUserTypeEnum = {
 } as const;
 export type PostCourseEnrollmentUserTypeEnum = typeof PostCourseEnrollmentUserTypeEnum[keyof typeof PostCourseEnrollmentUserTypeEnum];
 
+/**
+ * @export
+ */
+export const PostCourseEnrollmentReEnrollmentModeEnum = {
+    Restart: 'restart',
+    Resume: 'resume'
+} as const;
+export type PostCourseEnrollmentReEnrollmentModeEnum = typeof PostCourseEnrollmentReEnrollmentModeEnum[keyof typeof PostCourseEnrollmentReEnrollmentModeEnum];
+
 
 /**
  * Check if a given object implements the PostCourseEnrollment interface.
  */
 export function instanceOfPostCourseEnrollment(value: object): value is PostCourseEnrollment {
     if (!('userId' in value) || value['userId'] === undefined) return false;
-    if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
     return true;
 }
 
@@ -82,10 +99,11 @@ export function PostCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'userId': json['user_id'],
-        'enrollmentDateStart': json['enrollment_date_start'],
+        'enrollmentDateStart': json['enrollment_date_start'] == null ? undefined : json['enrollment_date_start'],
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
         'notes': json['notes'] == null ? undefined : json['notes'],
         'userType': json['user_type'] == null ? undefined : json['user_type'],
+        'reEnrollmentMode': json['re_enrollment_mode'] == null ? undefined : json['re_enrollment_mode'],
     };
 }
 
@@ -105,6 +123,7 @@ export function PostCourseEnrollmentToJSONTyped(value?: PostCourseEnrollment | n
         'enrollment_date_end': value['enrollmentDateEnd'],
         'notes': value['notes'],
         'user_type': value['userType'],
+        're_enrollment_mode': value['reEnrollmentMode'],
     };
 }
 

package/src/models/PutContent.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContentLaunchMode } from './ContentLaunchMode';
+import {
+    ContentLaunchModeFromJSON,
+    ContentLaunchModeFromJSONTyped,
+    ContentLaunchModeToJSON,
+    ContentLaunchModeToJSONTyped,
+} from './ContentLaunchMode';
+
 /**
  * 
  * @export
@@ -31,8 +39,16 @@ export interface PutContent {
      * @memberof PutContent
      */
     published?: boolean;
+    /**
+     * 
+     * @type {ContentLaunchMode}
+     * @memberof PutContent
+     */
+    launchMode?: ContentLaunchMode;
 }
 
+
+
 /**
  * Check if a given object implements the PutContent interface.
  */
@@ -52,6 +68,7 @@ export function PutContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         
         'name': json['name'] == null ? undefined : json['name'],
         'published': json['published'] == null ? undefined : json['published'],
+        'launchMode': json['launch_mode'] == null ? undefined : ContentLaunchModeFromJSON(json['launch_mode']),
     };
 }
 
@@ -68,6 +85,7 @@ export function PutContentToJSONTyped(value?: PutContent | null, ignoreDiscrimin
         
         'name': value['name'],
         'published': value['published'],
+        'launch_mode': ContentLaunchModeToJSON(value['launchMode']),
     };
 }
 

package/src/models/PutCourse.ts

@@ -43,8 +43,38 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     published?: boolean;
+    /**
+     * Course-level learner access policy.
+     * @type {PutCourseAccessPolicyTypeEnum}
+     * @memberof PutCourse
+     */
+    accessPolicyType?: PutCourseAccessPolicyTypeEnum;
+    /**
+     * Number of access days from enrollment start when access_policy_type is duration_days.
+     * @type {number}
+     * @memberof PutCourse
+     */
+    accessDurationDays?: number | null;
+    /**
+     * Fixed Unix timestamp when access expires when access_policy_type is fixed_end_date.
+     * @type {number}
+     * @memberof PutCourse
+     */
+    accessFixedEndAt?: number | null;
 }
 
+
+/**
+ * @export
+ */
+export const PutCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+} as const;
+export type PutCourseAccessPolicyTypeEnum = typeof PutCourseAccessPolicyTypeEnum[keyof typeof PutCourseAccessPolicyTypeEnum];
+
+
 /**
  * Check if a given object implements the PutCourse interface.
  */
@@ -66,6 +96,9 @@ export function PutCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'published': json['published'] == null ? undefined : json['published'],
+        'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
+        'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
+        'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
     };
 }
 
@@ -83,6 +116,9 @@ export function PutCourseToJSONTyped(value?: Omit<PutCourse, 'id'> | null, ignor
         'name': value['name'],
         'description': value['description'],
         'published': value['published'],
+        'access_policy_type': value['accessPolicyType'],
+        'access_duration_days': value['accessDurationDays'],
+        'access_fixed_end_at': value['accessFixedEndAt'],
     };
 }
 

package/src/models/PutCourseEnrollment.ts

@@ -39,7 +39,13 @@ export interface PutCourseEnrollment {
      * @type {number}
      * @memberof PutCourseEnrollment
      */
-    enrollmentDateEnd?: number;
+    enrollmentDateEnd?: number | null;
+    /**
+     * Add this many days to the current end date, or to now if the enrollment is already expired.
+     * @type {number}
+     * @memberof PutCourseEnrollment
+     */
+    extensionDays?: number;
     /**
      * Optional notes about the enrollment
      * @type {string}
@@ -58,7 +64,8 @@ export const PutCourseEnrollmentStatusEnum = {
     Failed: 'Failed',
     Withdrawn: 'Withdrawn',
     Removed: 'Removed',
-    Archived: 'Archived'
+    Archived: 'Archived',
+    Suspended: 'Suspended'
 } as const;
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 
@@ -92,6 +99,7 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
         'status': json['status'] == null ? undefined : json['status'],
         'userType': json['user_type'] == null ? undefined : json['user_type'],
         'enrollmentDateEnd': json['enrollment_date_end'] == null ? undefined : json['enrollment_date_end'],
+        'extensionDays': json['extension_days'] == null ? undefined : json['extension_days'],
         'notes': json['notes'] == null ? undefined : json['notes'],
     };
 }
@@ -110,6 +118,7 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
         'status': value['status'],
         'user_type': value['userType'],
         'enrollment_date_end': value['enrollmentDateEnd'],
+        'extension_days': value['extensionDays'],
         'notes': value['notes'],
     };
 }

package/src/models/index.ts

@@ -3,12 +3,12 @@
 export * from './Certificate';
 export * from './CertificateConfig';
 export * from './CertificatePublic';
+export * from './ContentLaunchMode';
 export * from './CourseCatalog';
 export * from './CourseShare';
 export * from './CriteriaBasedSelection';
 export * from './CriteriaBasedSelectionCriteria';
 export * from './CriteriaBasedSelectionDistribution';
-export * from './DownloadSupportTicketAttachment200Response';
 export * from './EffectiveCertificateConfig';
 export * from './Essay';
 export * from './Essay1';

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

@@ -1,32 +0,0 @@
-/**
- * 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 DownloadSupportTicketAttachment200Response
- */
-export interface DownloadSupportTicketAttachment200Response {
-    /**
-     *
-     * @type {string}
-     * @memberof DownloadSupportTicketAttachment200Response
-     */
-    downloadUrl: string;
-}
-/**
- * Check if a given object implements the DownloadSupportTicketAttachment200Response interface.
- */
-export declare function instanceOfDownloadSupportTicketAttachment200Response(value: object): value is DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseFromJSON(json: any): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseToJSON(json: any): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseToJSONTyped(value?: DownloadSupportTicketAttachment200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DownloadSupportTicketAttachment200Response.js

@@ -1,43 +0,0 @@
-/* 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 DownloadSupportTicketAttachment200Response interface.
- */
-export function instanceOfDownloadSupportTicketAttachment200Response(value) {
-    if (!('downloadUrl' in value) || value['downloadUrl'] === undefined)
-        return false;
-    return true;
-}
-export function DownloadSupportTicketAttachment200ResponseFromJSON(json) {
-    return DownloadSupportTicketAttachment200ResponseFromJSONTyped(json, false);
-}
-export function DownloadSupportTicketAttachment200ResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'downloadUrl': json['download_url'],
-    };
-}
-export function DownloadSupportTicketAttachment200ResponseToJSON(json) {
-    return DownloadSupportTicketAttachment200ResponseToJSONTyped(json, false);
-}
-export function DownloadSupportTicketAttachment200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'download_url': value['downloadUrl'],
-    };
-}

package/dist/models/DownloadSupportTicketAttachment200Response.d.ts

@@ -1,32 +0,0 @@
-/**
- * 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 DownloadSupportTicketAttachment200Response
- */
-export interface DownloadSupportTicketAttachment200Response {
-    /**
-     *
-     * @type {string}
-     * @memberof DownloadSupportTicketAttachment200Response
-     */
-    downloadUrl: string;
-}
-/**
- * Check if a given object implements the DownloadSupportTicketAttachment200Response interface.
- */
-export declare function instanceOfDownloadSupportTicketAttachment200Response(value: object): value is DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseFromJSON(json: any): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseToJSON(json: any): DownloadSupportTicketAttachment200Response;
-export declare function DownloadSupportTicketAttachment200ResponseToJSONTyped(value?: DownloadSupportTicketAttachment200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DownloadSupportTicketAttachment200Response.js

@@ -1,50 +0,0 @@
-"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.instanceOfDownloadSupportTicketAttachment200Response = instanceOfDownloadSupportTicketAttachment200Response;
-exports.DownloadSupportTicketAttachment200ResponseFromJSON = DownloadSupportTicketAttachment200ResponseFromJSON;
-exports.DownloadSupportTicketAttachment200ResponseFromJSONTyped = DownloadSupportTicketAttachment200ResponseFromJSONTyped;
-exports.DownloadSupportTicketAttachment200ResponseToJSON = DownloadSupportTicketAttachment200ResponseToJSON;
-exports.DownloadSupportTicketAttachment200ResponseToJSONTyped = DownloadSupportTicketAttachment200ResponseToJSONTyped;
-/**
- * Check if a given object implements the DownloadSupportTicketAttachment200Response interface.
- */
-function instanceOfDownloadSupportTicketAttachment200Response(value) {
-    if (!('downloadUrl' in value) || value['downloadUrl'] === undefined)
-        return false;
-    return true;
-}
-function DownloadSupportTicketAttachment200ResponseFromJSON(json) {
-    return DownloadSupportTicketAttachment200ResponseFromJSONTyped(json, false);
-}
-function DownloadSupportTicketAttachment200ResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'downloadUrl': json['download_url'],
-    };
-}
-function DownloadSupportTicketAttachment200ResponseToJSON(json) {
-    return DownloadSupportTicketAttachment200ResponseToJSONTyped(json, false);
-}
-function DownloadSupportTicketAttachment200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'download_url': value['downloadUrl'],
-    };
-}

package/src/models/DownloadSupportTicketAttachment200Response.ts

@@ -1,66 +0,0 @@
-/* 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 DownloadSupportTicketAttachment200Response
- */
-export interface DownloadSupportTicketAttachment200Response {
-    /**
-     * 
-     * @type {string}
-     * @memberof DownloadSupportTicketAttachment200Response
-     */
-    downloadUrl: string;
-}
-
-/**
- * Check if a given object implements the DownloadSupportTicketAttachment200Response interface.
- */
-export function instanceOfDownloadSupportTicketAttachment200Response(value: object): value is DownloadSupportTicketAttachment200Response {
-    if (!('downloadUrl' in value) || value['downloadUrl'] === undefined) return false;
-    return true;
-}
-
-export function DownloadSupportTicketAttachment200ResponseFromJSON(json: any): DownloadSupportTicketAttachment200Response {
-    return DownloadSupportTicketAttachment200ResponseFromJSONTyped(json, false);
-}
-
-export function DownloadSupportTicketAttachment200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DownloadSupportTicketAttachment200Response {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'downloadUrl': json['download_url'],
-    };
-}
-
-export function DownloadSupportTicketAttachment200ResponseToJSON(json: any): DownloadSupportTicketAttachment200Response {
-    return DownloadSupportTicketAttachment200ResponseToJSONTyped(json, false);
-}
-
-export function DownloadSupportTicketAttachment200ResponseToJSONTyped(value?: DownloadSupportTicketAttachment200Response | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'download_url': value['downloadUrl'],
-    };
-}
-