@easyedu/js-lsm-api 1.124.0 → 1.126.0

package/src/models/GetCourse.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { ContentLibraryTag } from './ContentLibraryTag';
+import {
+    ContentLibraryTagFromJSON,
+    ContentLibraryTagFromJSONTyped,
+    ContentLibraryTagToJSON,
+    ContentLibraryTagToJSONTyped,
+} from './ContentLibraryTag';
+
 /**
  * 
  * @export
@@ -73,6 +81,12 @@ export interface GetCourse {
      * @memberof GetCourse
      */
     accessFixedEndAt: number | null;
+    /**
+     * 
+     * @type {Array<ContentLibraryTag>}
+     * @memberof GetCourse
+     */
+    tags: Array<ContentLibraryTag>;
 }
 
 
@@ -100,6 +114,7 @@ export function instanceOfGetCourse(value: object): value is GetCourse {
     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;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
     return true;
 }
 
@@ -122,6 +137,7 @@ export function GetCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'accessPolicyType': json['access_policy_type'],
         'accessDurationDays': json['access_duration_days'],
         'accessFixedEndAt': json['access_fixed_end_at'],
+        'tags': ((json['tags'] as Array<any>).map(ContentLibraryTagFromJSON)),
     };
 }
 
@@ -144,6 +160,7 @@ export function GetCourseToJSONTyped(value?: Omit<GetCourse, 'id'> | null, ignor
         'access_policy_type': value['accessPolicyType'],
         'access_duration_days': value['accessDurationDays'],
         'access_fixed_end_at': value['accessFixedEndAt'],
+        'tags': ((value['tags'] as Array<any>).map(ContentLibraryTagToJSON)),
     };
 }
 

package/src/models/PostCourse.ts

@@ -51,6 +51,12 @@ export interface PostCourse {
      * @memberof PostCourse
      */
     accessFixedEndAt?: number | null;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PostCourse
+     */
+    tags?: Set<string>;
 }
 
 
@@ -89,6 +95,7 @@ export function PostCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         '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'],
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
     };
 }
 
@@ -108,6 +115,7 @@ export function PostCourseToJSONTyped(value?: PostCourse | null, ignoreDiscrimin
         'access_policy_type': value['accessPolicyType'],
         'access_duration_days': value['accessDurationDays'],
         'access_fixed_end_at': value['accessFixedEndAt'],
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags'] as Set<any>),
     };
 }
 

package/src/models/PostCourseEnrollment.ts

@@ -44,15 +44,19 @@ export interface PostCourseEnrollment {
      */
     notes?: string | null;
     /**
-     * The role/type of the user in this enrollment
+     * The role/type of this enrollment. A user may have one current Student and
+     * one current Instructor enrollment for the same course. Assign both roles
+     * with two requests, one for each user_type.
+     * 
      * @type {PostCourseEnrollmentUserTypeEnum}
      * @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.
+     * How to handle a user with a prior terminal enrollment of the requested
+     * user_type for this course. restart creates a new enrollment period; resume
+     * reopens the latest terminal enrollment of that type. A current enrollment
+     * of the same type always conflicts.
      * 
      * @type {PostCourseEnrollmentReEnrollmentModeEnum}
      * @memberof PostCourseEnrollment

package/src/models/PostPortalCertificateTemplate.ts

@@ -0,0 +1,106 @@
+/* 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 { CertificateCanvasDocument } from './CertificateCanvasDocument';
+import {
+    CertificateCanvasDocumentFromJSON,
+    CertificateCanvasDocumentFromJSONTyped,
+    CertificateCanvasDocumentToJSON,
+    CertificateCanvasDocumentToJSONTyped,
+} from './CertificateCanvasDocument';
+
+/**
+ * 
+ * @export
+ * @interface PostPortalCertificateTemplate
+ */
+export interface PostPortalCertificateTemplate {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostPortalCertificateTemplate
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostPortalCertificateTemplate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostPortalCertificateTemplate
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {CertificateCanvasDocument}
+     * @memberof PostPortalCertificateTemplate
+     */
+    designDocument?: CertificateCanvasDocument;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PostPortalCertificateTemplate
+     */
+    tags?: Set<string>;
+}
+
+/**
+ * Check if a given object implements the PostPortalCertificateTemplate interface.
+ */
+export function instanceOfPostPortalCertificateTemplate(value: object): value is PostPortalCertificateTemplate {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostPortalCertificateTemplateFromJSON(json: any): PostPortalCertificateTemplate {
+    return PostPortalCertificateTemplateFromJSONTyped(json, false);
+}
+
+export function PostPortalCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortalCertificateTemplate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'designDocument': json['design_document'] == null ? undefined : CertificateCanvasDocumentFromJSON(json['design_document']),
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+    };
+}
+
+export function PostPortalCertificateTemplateToJSON(json: any): PostPortalCertificateTemplate {
+    return PostPortalCertificateTemplateToJSONTyped(json, false);
+}
+
+export function PostPortalCertificateTemplateToJSONTyped(value?: PostPortalCertificateTemplate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'design_document': CertificateCanvasDocumentToJSON(value['designDocument']),
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags'] as Set<any>),
+    };
+}
+

package/src/models/PutCourse.ts

@@ -61,6 +61,12 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     accessFixedEndAt?: number | null;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PutCourse
+     */
+    tags?: Set<string>;
 }
 
 
@@ -99,6 +105,7 @@ export function PutCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         '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'],
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
     };
 }
 
@@ -119,6 +126,7 @@ export function PutCourseToJSONTyped(value?: Omit<PutCourse, 'id'> | null, ignor
         'access_policy_type': value['accessPolicyType'],
         'access_duration_days': value['accessDurationDays'],
         'access_fixed_end_at': value['accessFixedEndAt'],
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags'] as Set<any>),
     };
 }
 

package/src/models/PutCourseEnrollment.ts

@@ -28,12 +28,6 @@ export interface PutCourseEnrollment {
      * @memberof PutCourseEnrollment
      */
     status?: PutCourseEnrollmentStatusEnum;
-    /**
-     * The role/type of the user in this enrollment
-     * @type {PutCourseEnrollmentUserTypeEnum}
-     * @memberof PutCourseEnrollment
-     */
-    userType?: PutCourseEnrollmentUserTypeEnum;
     /**
      * End date of the enrollment (Unix timestamp)
      * @type {number}
@@ -78,15 +72,6 @@ export const PutCourseEnrollmentStatusEnum = {
 } as const;
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 
-/**
- * @export
- */
-export const PutCourseEnrollmentUserTypeEnum = {
-    Student: 'Student',
-    Instructor: 'Instructor'
-} as const;
-export type PutCourseEnrollmentUserTypeEnum = typeof PutCourseEnrollmentUserTypeEnum[keyof typeof PutCourseEnrollmentUserTypeEnum];
-
 
 /**
  * Check if a given object implements the PutCourseEnrollment interface.
@@ -106,7 +91,6 @@ export function PutCourseEnrollmentFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         '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'],
@@ -126,7 +110,6 @@ export function PutCourseEnrollmentToJSONTyped(value?: PutCourseEnrollment | nul
     return {
         
         'status': value['status'],
-        'user_type': value['userType'],
         'enrollment_date_end': value['enrollmentDateEnd'],
         'extension_days': value['extensionDays'],
         'notes': value['notes'],

package/src/models/PutPortalCertificateTemplate.ts

@@ -0,0 +1,89 @@
+/* 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 PutPortalCertificateTemplate
+ */
+export interface PutPortalCertificateTemplate {
+    /**
+     * 
+     * @type {string}
+     * @memberof PutPortalCertificateTemplate
+     */
+    name?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PutPortalCertificateTemplate
+     */
+    description?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PutPortalCertificateTemplate
+     */
+    isDefault?: boolean;
+    /**
+     * 
+     * @type {Set<string>}
+     * @memberof PutPortalCertificateTemplate
+     */
+    tags?: Set<string>;
+}
+
+/**
+ * Check if a given object implements the PutPortalCertificateTemplate interface.
+ */
+export function instanceOfPutPortalCertificateTemplate(value: object): value is PutPortalCertificateTemplate {
+    return true;
+}
+
+export function PutPortalCertificateTemplateFromJSON(json: any): PutPortalCertificateTemplate {
+    return PutPortalCertificateTemplateFromJSONTyped(json, false);
+}
+
+export function PutPortalCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalCertificateTemplate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+    };
+}
+
+export function PutPortalCertificateTemplateToJSON(json: any): PutPortalCertificateTemplate {
+    return PutPortalCertificateTemplateToJSONTyped(json, false);
+}
+
+export function PutPortalCertificateTemplateToJSONTyped(value?: PutPortalCertificateTemplate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags'] as Set<any>),
+    };
+}
+

package/src/models/index.ts

@@ -265,6 +265,7 @@ export * from './PostOfferCatalogResponse';
 export * from './PostOfferCourse';
 export * from './PostOfferCourseResponse';
 export * from './PostPortal';
+export * from './PostPortalCertificateTemplate';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
 export * from './PostQuestionAnswerChoicesInner';
@@ -324,6 +325,7 @@ export * from './PutLibraryQuizSessionGrade';
 export * from './PutLibraryQuizSessionOverride';
 export * from './PutLibraryQuizVersion';
 export * from './PutPortalBranding';
+export * from './PutPortalCertificateTemplate';
 export * from './PutPortalSublicense';
 export * from './PutPortalUserFieldValues';
 export * from './PutQuestion';