@easyedu/js-lsm-api 1.108.0 → 1.110.0

package/src/apis/CourseApi.ts

@@ -1788,7 +1788,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Visible resource placements in the selected sections are exported - Reusable quiz placements are skipped and do not block the export - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
      * Create a new SCORM export for a course
      */
     async postCourseExportRaw(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseExport>> {
@@ -1799,7 +1799,7 @@ export class CourseApi extends runtime.BaseAPI {
     }
 
     /**
-     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
+     * Enqueues a job to generate a SCORM export package for the course. Returns immediately with PENDING status.  **NOTES:** - This endpoint enqueues a background job to generate the SCORM package - Visible resource placements in the selected sections are exported - Reusable quiz placements are skipped and do not block the export - Poll GET /courses/{courseId}/exports/{exportId} to check status - Download URL will be available when status becomes COMPLETED 
      * Create a new SCORM export for a course
      */
     async postCourseExport(requestParameters: PostCourseExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseExport> {

package/src/apis/CourseShareApi.ts

@@ -13,6 +13,11 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type CourseShareAcceptError,
+    CourseShareAcceptErrorFromJSON,
+    CourseShareAcceptErrorToJSON,
+} from '../models/CourseShareAcceptError';
 import {
     type GetCourseShareList,
     GetCourseShareListFromJSON,

package/src/apis/QuestionApi.ts

@@ -45,10 +45,8 @@ export interface GetQuestionRequest {
 export interface GetQuestionListRequest {
     page?: number;
     pageSize?: number;
-    topic?: string;
     questionType?: GetQuestionListQuestionTypeEnum;
-    difficultyLevel?: GetQuestionListDifficultyLevelEnum;
-    tags?: Array<string>;
+    tagId?: string;
     search?: string;
 }
 
@@ -169,20 +167,12 @@ export class QuestionApi extends runtime.BaseAPI {
             queryParameters['pageSize'] = requestParameters['pageSize'];
         }
 
-        if (requestParameters['topic'] != null) {
-            queryParameters['topic'] = requestParameters['topic'];
-        }
-
         if (requestParameters['questionType'] != null) {
             queryParameters['question_type'] = requestParameters['questionType'];
         }
 
-        if (requestParameters['difficultyLevel'] != null) {
-            queryParameters['difficulty_level'] = requestParameters['difficultyLevel'];
-        }
-
-        if (requestParameters['tags'] != null) {
-            queryParameters['tags'] = requestParameters['tags'];
+        if (requestParameters['tagId'] != null) {
+            queryParameters['tag_id'] = requestParameters['tagId'];
         }
 
         if (requestParameters['search'] != null) {
@@ -333,12 +323,3 @@ export const GetQuestionListQuestionTypeEnum = {
     FillInBlank: 'fill_in_blank'
 } as const;
 export type GetQuestionListQuestionTypeEnum = typeof GetQuestionListQuestionTypeEnum[keyof typeof GetQuestionListQuestionTypeEnum];
-/**
- * @export
- */
-export const GetQuestionListDifficultyLevelEnum = {
-    Beginner: 'beginner',
-    Intermediate: 'intermediate',
-    Advanced: 'advanced'
-} as const;
-export type GetQuestionListDifficultyLevelEnum = typeof GetQuestionListDifficultyLevelEnum[keyof typeof GetQuestionListDifficultyLevelEnum];

package/src/models/ContentLibraryTag.ts

@@ -0,0 +1,180 @@
+/* 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 ContentLibraryTag
+ */
+export interface ContentLibraryTag {
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTag
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTag
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTag
+     */
+    key?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTag
+     */
+    value: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    archivedAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTag
+     */
+    mergedIntoTagId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    totalItemCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    activeItemCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    archivedItemCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    resourceCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    quizCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    questionCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTag
+     */
+    updatedAt: number;
+}
+
+/**
+ * Check if a given object implements the ContentLibraryTag interface.
+ */
+export function instanceOfContentLibraryTag(value: object): value is ContentLibraryTag {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    if (!('totalItemCount' in value) || value['totalItemCount'] === undefined) return false;
+    if (!('activeItemCount' in value) || value['activeItemCount'] === undefined) return false;
+    if (!('archivedItemCount' in value) || value['archivedItemCount'] === undefined) return false;
+    if (!('resourceCount' in value) || value['resourceCount'] === undefined) return false;
+    if (!('quizCount' in value) || value['quizCount'] === undefined) return false;
+    if (!('questionCount' in value) || value['questionCount'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ContentLibraryTagFromJSON(json: any): ContentLibraryTag {
+    return ContentLibraryTagFromJSONTyped(json, false);
+}
+
+export function ContentLibraryTagFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLibraryTag {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'key': json['key'] == null ? undefined : json['key'],
+        'value': json['value'],
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+        'mergedIntoTagId': json['merged_into_tag_id'] == null ? undefined : json['merged_into_tag_id'],
+        'totalItemCount': json['total_item_count'],
+        'activeItemCount': json['active_item_count'],
+        'archivedItemCount': json['archived_item_count'],
+        'resourceCount': json['resource_count'],
+        'quizCount': json['quiz_count'],
+        'questionCount': json['question_count'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function ContentLibraryTagToJSON(json: any): ContentLibraryTag {
+    return ContentLibraryTagToJSONTyped(json, false);
+}
+
+export function ContentLibraryTagToJSONTyped(value?: ContentLibraryTag | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'key': value['key'],
+        'value': value['value'],
+        'archived_at': value['archivedAt'],
+        'merged_into_tag_id': value['mergedIntoTagId'],
+        'total_item_count': value['totalItemCount'],
+        'active_item_count': value['activeItemCount'],
+        'archived_item_count': value['archivedItemCount'],
+        'resource_count': value['resourceCount'],
+        'quiz_count': value['quizCount'],
+        'question_count': value['questionCount'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/ContentLibraryTagItem.ts

@@ -0,0 +1,154 @@
+/* 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 { ContentLibraryTag } from './ContentLibraryTag';
+import {
+    ContentLibraryTagFromJSON,
+    ContentLibraryTagFromJSONTyped,
+    ContentLibraryTagToJSON,
+    ContentLibraryTagToJSONTyped,
+} from './ContentLibraryTag';
+import type { ResourceType } from './ResourceType';
+import {
+    ResourceTypeFromJSON,
+    ResourceTypeFromJSONTyped,
+    ResourceTypeToJSON,
+    ResourceTypeToJSONTyped,
+} from './ResourceType';
+
+/**
+ * 
+ * @export
+ * @interface ContentLibraryTagItem
+ */
+export interface ContentLibraryTagItem {
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTagItem
+     */
+    id: string;
+    /**
+     * 
+     * @type {ContentLibraryTagItemKindEnum}
+     * @memberof ContentLibraryTagItem
+     */
+    kind: ContentLibraryTagItemKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTagItem
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ContentLibraryTagItem
+     */
+    description: string;
+    /**
+     * 
+     * @type {ResourceType}
+     * @memberof ContentLibraryTagItem
+     */
+    resourceType?: ResourceType | null;
+    /**
+     * 
+     * @type {Array<ContentLibraryTag>}
+     * @memberof ContentLibraryTagItem
+     */
+    tags: Array<ContentLibraryTag>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTagItem
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ContentLibraryTagItem
+     */
+    archivedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const ContentLibraryTagItemKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz',
+    Question: 'question'
+} as const;
+export type ContentLibraryTagItemKindEnum = typeof ContentLibraryTagItemKindEnum[keyof typeof ContentLibraryTagItemKindEnum];
+
+
+/**
+ * Check if a given object implements the ContentLibraryTagItem interface.
+ */
+export function instanceOfContentLibraryTagItem(value: object): value is ContentLibraryTagItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('kind' in value) || value['kind'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function ContentLibraryTagItemFromJSON(json: any): ContentLibraryTagItem {
+    return ContentLibraryTagItemFromJSONTyped(json, false);
+}
+
+export function ContentLibraryTagItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentLibraryTagItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'kind': json['kind'],
+        'name': json['name'],
+        'description': json['description'],
+        'resourceType': json['resource_type'] == null ? undefined : ResourceTypeFromJSON(json['resource_type']),
+        'tags': ((json['tags'] as Array<any>).map(ContentLibraryTagFromJSON)),
+        'updatedAt': json['updated_at'],
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+    };
+}
+
+export function ContentLibraryTagItemToJSON(json: any): ContentLibraryTagItem {
+    return ContentLibraryTagItemToJSONTyped(json, false);
+}
+
+export function ContentLibraryTagItemToJSONTyped(value?: ContentLibraryTagItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'kind': value['kind'],
+        'name': value['name'],
+        'description': value['description'],
+        'resource_type': ResourceTypeToJSON(value['resourceType']),
+        'tags': ((value['tags'] as Array<any>).map(ContentLibraryTagToJSON)),
+        'updated_at': value['updatedAt'],
+        'archived_at': value['archivedAt'],
+    };
+}
+

package/src/models/CourseShareAcceptError.ts

@@ -0,0 +1,94 @@
+/* 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';
+/**
+ * A safe, actionable error returned when a course-share offer cannot be accepted.
+ * @export
+ * @interface CourseShareAcceptError
+ */
+export interface CourseShareAcceptError {
+    /**
+     * 
+     * @type {CourseShareAcceptErrorCodeEnum}
+     * @memberof CourseShareAcceptError
+     */
+    code: CourseShareAcceptErrorCodeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CourseShareAcceptError
+     */
+    message: string;
+}
+
+
+/**
+ * @export
+ */
+export const CourseShareAcceptErrorCodeEnum = {
+    PortalNotFound: 'portal_not_found',
+    ShareNotFound: 'share_not_found',
+    ShareNotAddressedToPortal: 'share_not_addressed_to_portal',
+    ModeNotAllowed: 'mode_not_allowed',
+    ShareNotOffered: 'share_not_offered',
+    SourceCourseUnavailable: 'source_course_unavailable',
+    SourceVersionUnpublished: 'source_version_unpublished',
+    SourceContentInvalid: 'source_content_invalid',
+    StorageCopyFailed: 'storage_copy_failed',
+    AcceptanceFailed: 'acceptance_failed'
+} as const;
+export type CourseShareAcceptErrorCodeEnum = typeof CourseShareAcceptErrorCodeEnum[keyof typeof CourseShareAcceptErrorCodeEnum];
+
+
+/**
+ * Check if a given object implements the CourseShareAcceptError interface.
+ */
+export function instanceOfCourseShareAcceptError(value: object): value is CourseShareAcceptError {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function CourseShareAcceptErrorFromJSON(json: any): CourseShareAcceptError {
+    return CourseShareAcceptErrorFromJSONTyped(json, false);
+}
+
+export function CourseShareAcceptErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): CourseShareAcceptError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+    };
+}
+
+export function CourseShareAcceptErrorToJSON(json: any): CourseShareAcceptError {
+    return CourseShareAcceptErrorToJSONTyped(json, false);
+}
+
+export function CourseShareAcceptErrorToJSONTyped(value?: CourseShareAcceptError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+    };
+}
+

package/src/models/GetContentLibraryTagItemList.ts

@@ -0,0 +1,110 @@
+/* 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 { ContentLibraryTagItem } from './ContentLibraryTagItem';
+import {
+    ContentLibraryTagItemFromJSON,
+    ContentLibraryTagItemFromJSONTyped,
+    ContentLibraryTagItemToJSON,
+    ContentLibraryTagItemToJSONTyped,
+} from './ContentLibraryTagItem';
+
+/**
+ * 
+ * @export
+ * @interface GetContentLibraryTagItemList
+ */
+export interface GetContentLibraryTagItemList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetContentLibraryTagItemList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetContentLibraryTagItemList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetContentLibraryTagItemList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetContentLibraryTagItemList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<ContentLibraryTagItem>}
+     * @memberof GetContentLibraryTagItemList
+     */
+    items: Array<ContentLibraryTagItem>;
+}
+
+/**
+ * Check if a given object implements the GetContentLibraryTagItemList interface.
+ */
+export function instanceOfGetContentLibraryTagItemList(value: object): value is GetContentLibraryTagItemList {
+    if (!('page' in value) || value['page'] === undefined) return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined) return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined) return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetContentLibraryTagItemListFromJSON(json: any): GetContentLibraryTagItemList {
+    return GetContentLibraryTagItemListFromJSONTyped(json, false);
+}
+
+export function GetContentLibraryTagItemListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentLibraryTagItemList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(ContentLibraryTagItemFromJSON)),
+    };
+}
+
+export function GetContentLibraryTagItemListToJSON(json: any): GetContentLibraryTagItemList {
+    return GetContentLibraryTagItemListToJSONTyped(json, false);
+}
+
+export function GetContentLibraryTagItemListToJSONTyped(value?: GetContentLibraryTagItemList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(ContentLibraryTagItemToJSON)),
+    };
+}
+