@easyedu/js-lsm-api 1.55.0 → 1.57.0

package/src/apis/PortalApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   GetPortal,
+  GetPortalFaviconUpload,
   GetPortalList,
   GetPortalLogoUpload,
   GetPortalUserList,
@@ -26,6 +27,8 @@ import type {
 import {
     GetPortalFromJSON,
     GetPortalToJSON,
+    GetPortalFaviconUploadFromJSON,
+    GetPortalFaviconUploadToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
     GetPortalLogoUploadFromJSON,
@@ -40,6 +43,10 @@ import {
     PutPortalBrandingToJSON,
 } from '../models/index';
 
+export interface DeletePortalFaviconRequest {
+    portalId: string;
+}
+
 export interface DeletePortalLogoRequest {
     portalId: string;
 }
@@ -66,6 +73,11 @@ export interface PostPortalRequest {
     postPortal: PostPortal;
 }
 
+export interface PostPortalFaviconUploadRequest {
+    portalId: string;
+    file: Blob;
+}
+
 export interface PostPortalLogoUploadRequest {
     portalId: string;
     file: Blob;
@@ -85,6 +97,50 @@ export interface UpdateSelectedPortalRequest {
  */
 export class PortalApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    async deletePortalFaviconRequestOpts(requestParameters: DeletePortalFaviconRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling deletePortalFavicon().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/portals/{portalId}/branding/favicon`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove the portal favicon
+     */
+    async deletePortalFaviconRaw(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deletePortalFaviconRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the portal favicon
+     */
+    async deletePortalFavicon(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deletePortalFaviconRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -377,6 +433,79 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    async postPortalFaviconUploadRequestOpts(requestParameters: PostPortalFaviconUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling postPortalFaviconUpload().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postPortalFaviconUpload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+
+        let urlPath = `/portals/{portalId}/branding/favicon`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a favicon image for portal branding
+     */
+    async postPortalFaviconUploadRaw(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalFaviconUpload>> {
+        const requestOptions = await this.postPortalFaviconUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFaviconUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a favicon image for portal branding
+     */
+    async postPortalFaviconUpload(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalFaviconUpload> {
+        const response = await this.postPortalFaviconUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */

package/src/models/GetCourseEnrollment.ts

@@ -56,7 +56,16 @@ export interface GetCourseEnrollment {
      */
     notes: string | null;
     /**
-     * Current status of the enrollment
+     * Current status of the enrollment.
+     * - Enrolled: registered, no progress yet
+     * - InProgress: learner has started at least one content session
+     * - Completed: finished successfully
+     * - Failed: finished but did not pass
+     * - Expired: enrollment_date_end passed before completion
+     * - Withdrawn: learner pulled out before completion
+     * - Removed: admin-removed enrollment
+     * - Archived: historical / read-only (e.g. course share revoked)
+     * 
      * @type {GetCourseEnrollmentStatusEnum}
      * @memberof GetCourseEnrollment
      */
@@ -81,8 +90,13 @@ export interface GetCourseEnrollment {
  */
 export const GetCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 } as const;
 export type GetCourseEnrollmentStatusEnum = typeof GetCourseEnrollmentStatusEnum[keyof typeof GetCourseEnrollmentStatusEnum];
 

package/src/models/GetCourseEnrollmentListItem.ts

@@ -87,8 +87,13 @@ export interface GetCourseEnrollmentListItem {
  */
 export const GetCourseEnrollmentListItemStatusEnum = {
     Enrolled: 'Enrolled',
+    InProgress: 'InProgress',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Expired: 'Expired',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 } as const;
 export type GetCourseEnrollmentListItemStatusEnum = typeof GetCourseEnrollmentListItemStatusEnum[keyof typeof GetCourseEnrollmentListItemStatusEnum];
 

package/src/models/GetPortal.ts

@@ -43,6 +43,12 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortal
+     */
+    faviconUrl?: string | null;
     /**
      * 
      * @type {string}
@@ -104,6 +110,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
@@ -125,6 +132,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
         'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
         'base_type': value['baseType'],

package/src/models/GetPortalFaviconUpload.ts

@@ -0,0 +1,66 @@
+/* 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 GetPortalFaviconUpload
+ */
+export interface GetPortalFaviconUpload {
+    /**
+     * Presigned URL for the uploaded favicon image
+     * @type {string}
+     * @memberof GetPortalFaviconUpload
+     */
+    faviconUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export function instanceOfGetPortalFaviconUpload(value: object): value is GetPortalFaviconUpload {
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalFaviconUploadFromJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadFromJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalFaviconUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'faviconUrl': json['favicon_url'],
+    };
+}
+
+export function GetPortalFaviconUploadToJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadToJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadToJSONTyped(value?: GetPortalFaviconUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'favicon_url': value['faviconUrl'],
+    };
+}
+

package/src/models/PostDuplicate.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Optional body for duplicating a course
+ * @export
+ * @interface PostDuplicate
+ */
+export interface PostDuplicate {
+    /**
+     * Name for the duplicated course. Defaults to "{original name} (Copy)" if omitted.
+     * @type {string}
+     * @memberof PostDuplicate
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the PostDuplicate interface.
+ */
+export function instanceOfPostDuplicate(value: object): value is PostDuplicate {
+    return true;
+}
+
+export function PostDuplicateFromJSON(json: any): PostDuplicate {
+    return PostDuplicateFromJSONTyped(json, false);
+}
+
+export function PostDuplicateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function PostDuplicateToJSON(json: any): PostDuplicate {
+    return PostDuplicateToJSONTyped(json, false);
+}
+
+export function PostDuplicateToJSONTyped(value?: PostDuplicate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+    };
+}
+

package/src/models/PostDuplicate1.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Optional body for duplicating a module
+ * @export
+ * @interface PostDuplicate1
+ */
+export interface PostDuplicate1 {
+    /**
+     * Name for the duplicated module. Defaults to "{original name} (Copy)" if omitted.
+     * @type {string}
+     * @memberof PostDuplicate1
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the PostDuplicate1 interface.
+ */
+export function instanceOfPostDuplicate1(value: object): value is PostDuplicate1 {
+    return true;
+}
+
+export function PostDuplicate1FromJSON(json: any): PostDuplicate1 {
+    return PostDuplicate1FromJSONTyped(json, false);
+}
+
+export function PostDuplicate1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate1 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function PostDuplicate1ToJSON(json: any): PostDuplicate1 {
+    return PostDuplicate1ToJSONTyped(json, false);
+}
+
+export function PostDuplicate1ToJSONTyped(value?: PostDuplicate1 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+    };
+}
+

package/src/models/PostDuplicate2.ts

@@ -0,0 +1,65 @@
+/* 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';
+/**
+ * Optional body for duplicating a content item
+ * @export
+ * @interface PostDuplicate2
+ */
+export interface PostDuplicate2 {
+    /**
+     * Name for the duplicated content. Defaults to "{original name} (Copy)" if omitted.
+     * @type {string}
+     * @memberof PostDuplicate2
+     */
+    name?: string;
+}
+
+/**
+ * Check if a given object implements the PostDuplicate2 interface.
+ */
+export function instanceOfPostDuplicate2(value: object): value is PostDuplicate2 {
+    return true;
+}
+
+export function PostDuplicate2FromJSON(json: any): PostDuplicate2 {
+    return PostDuplicate2FromJSONTyped(json, false);
+}
+
+export function PostDuplicate2FromJSONTyped(json: any, ignoreDiscriminator: boolean): PostDuplicate2 {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+
+export function PostDuplicate2ToJSON(json: any): PostDuplicate2 {
+    return PostDuplicate2ToJSONTyped(json, false);
+}
+
+export function PostDuplicate2ToJSONTyped(value?: PostDuplicate2 | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+    };
+}
+

package/src/models/PutCourseEnrollment.ts

@@ -20,7 +20,10 @@ import { mapValues } from '../runtime';
  */
 export interface PutCourseEnrollment {
     /**
-     * Current status of the enrollment
+     * Target status for the enrollment. System-managed statuses (InProgress, Expired)
+     * cannot be set via this endpoint. Reopening a terminal enrollment to `Enrolled`
+     * requires `enrollment_date_end` to still be in the future.
+     * 
      * @type {PutCourseEnrollmentStatusEnum}
      * @memberof PutCourseEnrollment
      */
@@ -52,7 +55,10 @@ export interface PutCourseEnrollment {
 export const PutCourseEnrollmentStatusEnum = {
     Enrolled: 'Enrolled',
     Completed: 'Completed',
-    Removed: 'Removed'
+    Failed: 'Failed',
+    Withdrawn: 'Withdrawn',
+    Removed: 'Removed',
+    Archived: 'Archived'
 } as const;
 export type PutCourseEnrollmentStatusEnum = typeof PutCourseEnrollmentStatusEnum[keyof typeof PutCourseEnrollmentStatusEnum];
 

package/src/models/index.ts

@@ -72,6 +72,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';
@@ -175,6 +176,9 @@ export * from './PostCourse';
 export * from './PostCourseCatalog';
 export * from './PostCourseEnrollment';
 export * from './PostCourseExport';
+export * from './PostDuplicate';
+export * from './PostDuplicate1';
+export * from './PostDuplicate2';
 export * from './PostLogin';
 export * from './PostManualQuestionSelection';
 export * from './PostMessage';