@easyedu/js-lsm-api 1.65.0 → 1.66.0

package/src/models/GetCourse.ts

@@ -55,8 +55,38 @@ export interface GetCourse {
      * @memberof GetCourse
      */
     createdAt: number;
+    /**
+     * Course-level learner access policy.
+     * @type {GetCourseAccessPolicyTypeEnum}
+     * @memberof GetCourse
+     */
+    accessPolicyType: GetCourseAccessPolicyTypeEnum;
+    /**
+     * Number of access days from enrollment start when access_policy_type is duration_days.
+     * @type {number}
+     * @memberof GetCourse
+     */
+    accessDurationDays: number | null;
+    /**
+     * Fixed Unix timestamp when access expires when access_policy_type is fixed_end_date.
+     * @type {number}
+     * @memberof GetCourse
+     */
+    accessFixedEndAt: number | null;
 }
 
+
+/**
+ * @export
+ */
+export const GetCourseAccessPolicyTypeEnum = {
+    DurationDays: 'duration_days',
+    FixedEndDate: 'fixed_end_date',
+    NeverExpires: 'never_expires'
+} as const;
+export type GetCourseAccessPolicyTypeEnum = typeof GetCourseAccessPolicyTypeEnum[keyof typeof GetCourseAccessPolicyTypeEnum];
+
+
 /**
  * Check if a given object implements the GetCourse interface.
  */
@@ -67,6 +97,9 @@ export function instanceOfGetCourse(value: object): value is GetCourse {
     if (!('imageUrl' in value) || value['imageUrl'] === undefined) return false;
     if (!('published' in value) || value['published'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('accessPolicyType' in value) || value['accessPolicyType'] === undefined) return false;
+    if (!('accessDurationDays' in value) || value['accessDurationDays'] === undefined) return false;
+    if (!('accessFixedEndAt' in value) || value['accessFixedEndAt'] === undefined) return false;
     return true;
 }
 
@@ -86,6 +119,9 @@ export function GetCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'imageUrl': json['image_url'],
         'published': json['published'],
         'createdAt': json['created_at'],
+        'accessPolicyType': json['access_policy_type'],
+        'accessDurationDays': json['access_duration_days'],
+        'accessFixedEndAt': json['access_fixed_end_at'],
     };
 }
 
@@ -105,6 +141,9 @@ export function GetCourseToJSONTyped(value?: Omit<GetCourse, 'id'> | null, ignor
         'image_url': value['imageUrl'],
         'published': value['published'],
         'created_at': value['createdAt'],
+        'access_policy_type': value['accessPolicyType'],
+        'access_duration_days': value['accessDurationDays'],
+        'access_fixed_end_at': value['accessFixedEndAt'],
     };
 }
 

package/src/models/GetCourseEnrollment.ts

@@ -48,7 +48,7 @@ export interface GetCourseEnrollment {
      * @type {number}
      * @memberof GetCourseEnrollment
      */
-    enrollmentDateEnd: number;
+    enrollmentDateEnd: number | null;
     /**
      * Optional notes about the enrollment
      * @type {string}
@@ -65,11 +65,24 @@ export interface GetCourseEnrollment {
      * - Withdrawn: learner pulled out before completion
      * - Removed: admin-removed enrollment
      * - Archived: historical / read-only (e.g. course share revoked)
+     * - Suspended: access temporarily disabled by an admin
      * 
      * @type {GetCourseEnrollmentStatusEnum}
      * @memberof GetCourseEnrollment
      */
     status: GetCourseEnrollmentStatusEnum;
+    /**
+     * Derived learner access state for UI indicators and access decisions.
+     * @type {GetCourseEnrollmentAccessStateEnum}
+     * @memberof GetCourseEnrollment
+     */
+    accessState: GetCourseEnrollmentAccessStateEnum;
+    /**
+     * Whole days until access expiry; null for never-expiring or already inactive enrollments.
+     * @type {number}
+     * @memberof GetCourseEnrollment
+     */
+    daysUntilExpiry: number | null;
     /**
      * The role/type of the user in this enrollment
      * @type {GetCourseEnrollmentUserTypeEnum}
@@ -96,10 +109,26 @@ export const GetCourseEnrollmentStatusEnum = {
     Expired: 'Expired',
     Withdrawn: 'Withdrawn',
     Removed: 'Removed',
-    Archived: 'Archived'
+    Archived: 'Archived',
+    Suspended: 'Suspended'
 } as const;
 export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
 
+/**
+ * @export
+ */
+export const GetCourseEnrollmentAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+} as const;
+export type GetCourseEnrollmentAccessStateEnum = typeof GetCourseEnrollmentAccessStateEnum[keyof typeof GetCourseEnrollmentAccessStateEnum];
+
 /**
  * @export
  */
@@ -121,6 +150,8 @@ export function instanceOfGetCourseEnrollment(value: object): value is GetCourse
     if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
     if (!('notes' in value) || value['notes'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('accessState' in value) || value['accessState'] === undefined) return false;
+    if (!('daysUntilExpiry' in value) || value['daysUntilExpiry'] === undefined) return false;
     if (!('userType' in value) || value['userType'] === undefined) return false;
     if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
     return true;
@@ -143,6 +174,8 @@ export function GetCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
         'enrollmentDateEnd': json['enrollment_date_end'],
         'notes': json['notes'],
         'status': json['status'],
+        'accessState': json['access_state'],
+        'daysUntilExpiry': json['days_until_expiry'],
         'userType': json['user_type'],
         'completionDate': json['completion_date'],
     };
@@ -166,6 +199,8 @@ export function GetCourseEnrollmentToJSONTyped(value?: GetCourseEnrollment | nul
         'enrollment_date_end': value['enrollmentDateEnd'],
         'notes': value['notes'],
         'status': value['status'],
+        'access_state': value['accessState'],
+        'days_until_expiry': value['daysUntilExpiry'],
         'user_type': value['userType'],
         'completion_date': value['completionDate'],
     };

package/src/models/GetCourseEnrollmentListItem.ts

@@ -60,13 +60,25 @@ export interface GetCourseEnrollmentListItem {
      * @type {number}
      * @memberof GetCourseEnrollmentListItem
      */
-    enrollmentDateEnd: number;
+    enrollmentDateEnd: number | null;
     /**
      * Current status of the enrollment
      * @type {GetCourseEnrollmentListItemStatusEnum}
      * @memberof GetCourseEnrollmentListItem
      */
     status: GetCourseEnrollmentListItemStatusEnum;
+    /**
+     * Derived learner access state for UI indicators and access decisions.
+     * @type {GetCourseEnrollmentListItemAccessStateEnum}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    accessState: GetCourseEnrollmentListItemAccessStateEnum;
+    /**
+     * Whole days until access expiry; null for never-expiring or already inactive enrollments.
+     * @type {number}
+     * @memberof GetCourseEnrollmentListItem
+     */
+    daysUntilExpiry: number | null;
     /**
      * The role/type of the user in this enrollment
      * @type {GetCourseEnrollmentListItemUserTypeEnum}
@@ -93,10 +105,26 @@ export const GetCourseEnrollmentListItemStatusEnum = {
     Expired: 'Expired',
     Withdrawn: 'Withdrawn',
     Removed: 'Removed',
-    Archived: 'Archived'
+    Archived: 'Archived',
+    Suspended: 'Suspended'
 } as const;
 export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
 
+/**
+ * @export
+ */
+export const GetCourseEnrollmentListItemAccessStateEnum = {
+    Active: 'active',
+    CompletedReview: 'completed_review',
+    Expired: 'expired',
+    Suspended: 'suspended',
+    Failed: 'failed',
+    Withdrawn: 'withdrawn',
+    Removed: 'removed',
+    Archived: 'archived'
+} as const;
+export type GetCourseEnrollmentListItemAccessStateEnum = typeof GetCourseEnrollmentListItemAccessStateEnum[keyof typeof GetCourseEnrollmentListItemAccessStateEnum];
+
 /**
  * @export
  */
@@ -119,6 +147,8 @@ export function instanceOfGetCourseEnrollmentListItem(value: object): value is G
     if (!('enrollmentDateStart' in value) || value['enrollmentDateStart'] === undefined) return false;
     if (!('enrollmentDateEnd' in value) || value['enrollmentDateEnd'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('accessState' in value) || value['accessState'] === undefined) return false;
+    if (!('daysUntilExpiry' in value) || value['daysUntilExpiry'] === undefined) return false;
     if (!('userType' in value) || value['userType'] === undefined) return false;
     if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
     return true;
@@ -142,6 +172,8 @@ export function GetCourseEnrollmentListItemFromJSONTyped(json: any, ignoreDiscri
         'enrollmentDateStart': json['enrollment_date_start'],
         'enrollmentDateEnd': json['enrollment_date_end'],
         'status': json['status'],
+        'accessState': json['access_state'],
+        'daysUntilExpiry': json['days_until_expiry'],
         'userType': json['user_type'],
         'completionDate': json['completion_date'],
     };
@@ -166,6 +198,8 @@ export function GetCourseEnrollmentListItemToJSONTyped(value?: GetCourseEnrollme
         'enrollment_date_start': value['enrollmentDateStart'],
         'enrollment_date_end': value['enrollmentDateEnd'],
         'status': value['status'],
+        'access_state': value['accessState'],
+        'days_until_expiry': value['daysUntilExpiry'],
         'user_type': value['userType'],
         'completion_date': value['completionDate'],
     };

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/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'],
     };
 }