@easyedu/js-lsm-api 1.42.0 → 1.44.0

package/src/apis/CourseApi.ts

@@ -20,6 +20,7 @@ import type {
   GetCourseEnrollmentList,
   GetCourseExport,
   GetCourseExportList,
+  GetCourseImageUpload,
   GetCourseList,
   GetCourseReportingBasic,
   PostCourse,
@@ -39,6 +40,8 @@ import {
     GetCourseExportToJSON,
     GetCourseExportListFromJSON,
     GetCourseExportListToJSON,
+    GetCourseImageUploadFromJSON,
+    GetCourseImageUploadToJSON,
     GetCourseListFromJSON,
     GetCourseListToJSON,
     GetCourseReportingBasicFromJSON,
@@ -55,6 +58,10 @@ import {
     PutCourseEnrollmentToJSON,
 } from '../models/index';
 
+export interface DeleteCourseImageRequest {
+    courseId: string;
+}
+
 export interface GetCourseRequest {
     courseId: string;
 }
@@ -104,6 +111,11 @@ export interface PostCourseExportRequest {
     postCourseExport: PostCourseExport;
 }
 
+export interface PostCourseImageUploadRequest {
+    courseId: string;
+    file: Blob;
+}
+
 export interface PutCourseRequest {
     courseId: string;
     putCourse: Omit<PutCourse, 'id'>;
@@ -120,6 +132,50 @@ export interface PutCourseEnrollmentRequest {
  */
 export class CourseApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deleteCourseImage without sending the request
+     */
+    async deleteCourseImageRequestOpts(requestParameters: DeleteCourseImageRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling deleteCourseImage().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/image`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove the course image
+     */
+    async deleteCourseImageRaw(requestParameters: DeleteCourseImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteCourseImageRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the course image
+     */
+    async deleteCourseImage(requestParameters: DeleteCourseImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteCourseImageRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for getCourse without sending the request
      */
@@ -626,6 +682,79 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCourseImageUpload without sending the request
+     */
+    async postCourseImageUploadRequestOpts(requestParameters: PostCourseImageUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseImageUpload().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postCourseImageUpload().'
+            );
+        }
+
+        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 = `/courses/{courseId}/image`;
+        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a course image
+     */
+    async postCourseImageUploadRaw(requestParameters: PostCourseImageUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseImageUpload>> {
+        const requestOptions = await this.postCourseImageUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseImageUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a course image
+     */
+    async postCourseImageUpload(requestParameters: PostCourseImageUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseImageUpload> {
+        const response = await this.postCourseImageUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putCourse without sending the request
      */

package/src/models/GetCourseImageUpload.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 GetCourseImageUpload
+ */
+export interface GetCourseImageUpload {
+    /**
+     * Presigned URL for the uploaded course image
+     * @type {string}
+     * @memberof GetCourseImageUpload
+     */
+    imageUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetCourseImageUpload interface.
+ */
+export function instanceOfGetCourseImageUpload(value: object): value is GetCourseImageUpload {
+    if (!('imageUrl' in value) || value['imageUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetCourseImageUploadFromJSON(json: any): GetCourseImageUpload {
+    return GetCourseImageUploadFromJSONTyped(json, false);
+}
+
+export function GetCourseImageUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseImageUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'imageUrl': json['image_url'],
+    };
+}
+
+export function GetCourseImageUploadToJSON(json: any): GetCourseImageUpload {
+    return GetCourseImageUploadToJSONTyped(json, false);
+}
+
+export function GetCourseImageUploadToJSONTyped(value?: GetCourseImageUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'image_url': value['imageUrl'],
+    };
+}
+

package/src/models/GetQuestion.ts

@@ -20,6 +20,13 @@ import {
     GetQuestionAnswerChoicesInnerToJSON,
     GetQuestionAnswerChoicesInnerToJSONTyped,
 } from './GetQuestionAnswerChoicesInner';
+import type { GetQuestionQuizzesInner } from './GetQuestionQuizzesInner';
+import {
+    GetQuestionQuizzesInnerFromJSON,
+    GetQuestionQuizzesInnerFromJSONTyped,
+    GetQuestionQuizzesInnerToJSON,
+    GetQuestionQuizzesInnerToJSONTyped,
+} from './GetQuestionQuizzesInner';
 
 /**
  * 
@@ -117,6 +124,12 @@ export interface GetQuestion {
      * @memberof GetQuestion
      */
     readonly quizCount?: number;
+    /**
+     * Quizzes that use this question
+     * @type {Array<GetQuestionQuizzesInner>}
+     * @memberof GetQuestion
+     */
+    readonly quizzes?: Array<GetQuestionQuizzesInner>;
 }
 
 
@@ -183,6 +196,7 @@ export function GetQuestionFromJSONTyped(json: any, ignoreDiscriminator: boolean
         'updatedDate': (new Date(json['updated_date'])),
         'createdBy': json['created_by'] == null ? undefined : json['created_by'],
         'quizCount': json['quiz_count'] == null ? undefined : json['quiz_count'],
+        'quizzes': json['quizzes'] == null ? undefined : ((json['quizzes'] as Array<any>).map(GetQuestionQuizzesInnerFromJSON)),
     };
 }
 
@@ -190,7 +204,7 @@ export function GetQuestionToJSON(json: any): GetQuestion {
     return GetQuestionToJSONTyped(json, false);
 }
 
-export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'created_date'|'updated_date'|'created_by'|'quiz_count'> | null, ignoreDiscriminator: boolean = false): any {
+export function GetQuestionToJSONTyped(value?: Omit<GetQuestion, 'id'|'created_date'|'updated_date'|'created_by'|'quiz_count'|'quizzes'> | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }

package/src/models/GetQuestionQuizzesInner.ts

@@ -0,0 +1,93 @@
+/* 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 GetQuestionQuizzesInner
+ */
+export interface GetQuestionQuizzesInner {
+    /**
+     * Quiz external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    quizId: string;
+    /**
+     * Quiz name
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    quizName: string;
+    /**
+     * Module external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    moduleId: string;
+    /**
+     * Course external identifier
+     * @type {string}
+     * @memberof GetQuestionQuizzesInner
+     */
+    courseId: string;
+}
+
+/**
+ * Check if a given object implements the GetQuestionQuizzesInner interface.
+ */
+export function instanceOfGetQuestionQuizzesInner(value: object): value is GetQuestionQuizzesInner {
+    if (!('quizId' in value) || value['quizId'] === undefined) return false;
+    if (!('quizName' in value) || value['quizName'] === undefined) return false;
+    if (!('moduleId' in value) || value['moduleId'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    return true;
+}
+
+export function GetQuestionQuizzesInnerFromJSON(json: any): GetQuestionQuizzesInner {
+    return GetQuestionQuizzesInnerFromJSONTyped(json, false);
+}
+
+export function GetQuestionQuizzesInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetQuestionQuizzesInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'quizId': json['quiz_id'],
+        'quizName': json['quiz_name'],
+        'moduleId': json['module_id'],
+        'courseId': json['course_id'],
+    };
+}
+
+export function GetQuestionQuizzesInnerToJSON(json: any): GetQuestionQuizzesInner {
+    return GetQuestionQuizzesInnerToJSONTyped(json, false);
+}
+
+export function GetQuestionQuizzesInnerToJSONTyped(value?: GetQuestionQuizzesInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'quiz_id': value['quizId'],
+        'quiz_name': value['quizName'],
+        'module_id': value['moduleId'],
+        'course_id': value['courseId'],
+    };
+}
+

package/src/models/PutCourse.ts

@@ -43,12 +43,6 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     instructor?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof PutCourse
-     */
-    imageUrl?: string;
     /**
      * Whether the course is published and visible to students
      * @type {boolean}
@@ -78,7 +72,6 @@ export function PutCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
-        'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
         'published': json['published'] == null ? undefined : json['published'],
     };
 }
@@ -97,7 +90,6 @@ export function PutCourseToJSONTyped(value?: Omit<PutCourse, 'id'> | null, ignor
         'name': value['name'],
         'description': value['description'],
         'instructor': value['instructor'],
-        'image_url': value['imageUrl'],
         'published': value['published'],
     };
 }

package/src/models/index.ts

@@ -41,6 +41,7 @@ export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
 export * from './GetCourseExport';
 export * from './GetCourseExportList';
+export * from './GetCourseImageUpload';
 export * from './GetCourseList';
 export * from './GetCourseReportingBasic';
 export * from './GetCourseStudentReporting';
@@ -74,6 +75,7 @@ export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';
 export * from './GetQuestionListFilters';
+export * from './GetQuestionQuizzesInner';
 export * from './GetQuiz';
 export * from './GetQuizAttempt';
 export * from './GetQuizAttemptAnalytics';