@easyedu/js-lsm-api 1.91.0 → 1.93.0

package/src/apis/PlayerApi.ts

@@ -90,6 +90,10 @@ export interface GetImagePlayerRequest {
     sessionId: string;
 }
 
+export interface GetLibraryQuizSessionPlayerRequest {
+    sessionId: string;
+}
+
 export interface GetPdfAssetRequest {
     contentId: string;
 }
@@ -481,6 +485,55 @@ export class PlayerApi extends runtime.BaseAPI {
         await this.getImagePlayerRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for getLibraryQuizSessionPlayer without sending the request
+     */
+    async getLibraryQuizSessionPlayerRequestOpts(requestParameters: GetLibraryQuizSessionPlayerRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getLibraryQuizSessionPlayer().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/quiz/sessions/{sessionId}/player`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    async getLibraryQuizSessionPlayerRaw(requestParameters: GetLibraryQuizSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.getLibraryQuizSessionPlayerRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Serve the player for a reusable quiz session
+     */
+    async getLibraryQuizSessionPlayer(requestParameters: GetLibraryQuizSessionPlayerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.getLibraryQuizSessionPlayerRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getPdfAsset without sending the request
      */

package/src/apis/index.ts

@@ -5,6 +5,7 @@ export * from './CertificateTemplateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './ContentLibraryApi';
+export * from './ContentLibraryQuizApi';
 export * from './CourseApi';
 export * from './CourseCatalogApi';
 export * from './CourseShareApi';

package/src/models/GetCourseVersionItem.ts

@@ -39,6 +39,12 @@ export interface GetCourseVersionItem {
      * @memberof GetCourseVersionItem
      */
     sourceKind: GetCourseVersionItemSourceKindEnum;
+    /**
+     * Discriminates reusable Content Library placements without changing source_kind.
+     * @type {GetCourseVersionItemContentLibraryKindEnum}
+     * @memberof GetCourseVersionItem
+     */
+    contentLibraryKind?: GetCourseVersionItemContentLibraryKindEnum | null;
     /**
      * 
      * @type {string}
@@ -129,6 +135,15 @@ export const GetCourseVersionItemSourceKindEnum = {
 } as const;
 export type GetCourseVersionItemSourceKindEnum = typeof GetCourseVersionItemSourceKindEnum[keyof typeof GetCourseVersionItemSourceKindEnum];
 
+/**
+ * @export
+ */
+export const GetCourseVersionItemContentLibraryKindEnum = {
+    Resource: 'resource',
+    Quiz: 'quiz'
+} as const;
+export type GetCourseVersionItemContentLibraryKindEnum = typeof GetCourseVersionItemContentLibraryKindEnum[keyof typeof GetCourseVersionItemContentLibraryKindEnum];
+
 /**
  * @export
  */
@@ -168,6 +183,7 @@ export function GetCourseVersionItemFromJSONTyped(json: any, ignoreDiscriminator
         
         'id': json['id'],
         'sourceKind': json['source_kind'],
+        'contentLibraryKind': json['content_library_kind'] == null ? undefined : json['content_library_kind'],
         'contentLibraryItemId': json['content_library_item_id'] == null ? undefined : json['content_library_item_id'],
         'contentLibraryVersionId': json['content_library_version_id'] == null ? undefined : json['content_library_version_id'],
         'resourceVersionNumber': json['resource_version_number'] == null ? undefined : json['resource_version_number'],
@@ -197,6 +213,7 @@ export function GetCourseVersionItemToJSONTyped(value?: GetCourseVersionItem | n
         
         'id': value['id'],
         'source_kind': value['sourceKind'],
+        'content_library_kind': value['contentLibraryKind'],
         'content_library_item_id': value['contentLibraryItemId'],
         'content_library_version_id': value['contentLibraryVersionId'],
         'resource_version_number': value['resourceVersionNumber'],

package/src/models/GetLibraryQuiz.ts

@@ -0,0 +1,207 @@
+/* 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 { GetLibraryQuizVersion } from './GetLibraryQuizVersion';
+import {
+    GetLibraryQuizVersionFromJSON,
+    GetLibraryQuizVersionFromJSONTyped,
+    GetLibraryQuizVersionToJSON,
+    GetLibraryQuizVersionToJSONTyped,
+} from './GetLibraryQuizVersion';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuiz
+ */
+export interface GetLibraryQuiz {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuiz
+     */
+    id: string;
+    /**
+     * 
+     * @type {GetLibraryQuizKindEnum}
+     * @memberof GetLibraryQuiz
+     */
+    kind: GetLibraryQuizKindEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuiz
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuiz
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuiz
+     */
+    ownerId: string;
+    /**
+     * 
+     * @type {GetLibraryQuizVersion}
+     * @memberof GetLibraryQuiz
+     */
+    latestPublishedVersion?: GetLibraryQuizVersion | null;
+    /**
+     * 
+     * @type {GetLibraryQuizVersion}
+     * @memberof GetLibraryQuiz
+     */
+    draftVersion?: GetLibraryQuizVersion | null;
+    /**
+     * 
+     * @type {Array<GetLibraryQuizVersion>}
+     * @memberof GetLibraryQuiz
+     */
+    versions: Array<GetLibraryQuizVersion>;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    publishedCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    draftCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    historicalCourseCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    activeLearnerCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuiz
+     */
+    archivedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const GetLibraryQuizKindEnum = {
+    Quiz: 'quiz'
+} as const;
+export type GetLibraryQuizKindEnum = typeof GetLibraryQuizKindEnum[keyof typeof GetLibraryQuizKindEnum];
+
+
+/**
+ * Check if a given object implements the GetLibraryQuiz interface.
+ */
+export function instanceOfGetLibraryQuiz(value: object): value is GetLibraryQuiz {
+    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 (!('ownerId' in value) || value['ownerId'] === undefined) return false;
+    if (!('versions' in value) || value['versions'] === undefined) return false;
+    if (!('publishedCourseCount' in value) || value['publishedCourseCount'] === undefined) return false;
+    if (!('draftCourseCount' in value) || value['draftCourseCount'] === undefined) return false;
+    if (!('historicalCourseCount' in value) || value['historicalCourseCount'] === undefined) return false;
+    if (!('activeLearnerCount' in value) || value['activeLearnerCount'] === 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 GetLibraryQuizFromJSON(json: any): GetLibraryQuiz {
+    return GetLibraryQuizFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuiz {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'kind': json['kind'],
+        'name': json['name'],
+        'description': json['description'],
+        'ownerId': json['owner_id'],
+        'latestPublishedVersion': json['latest_published_version'] == null ? undefined : GetLibraryQuizVersionFromJSON(json['latest_published_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : GetLibraryQuizVersionFromJSON(json['draft_version']),
+        'versions': ((json['versions'] as Array<any>).map(GetLibraryQuizVersionFromJSON)),
+        'publishedCourseCount': json['published_course_count'],
+        'draftCourseCount': json['draft_course_count'],
+        'historicalCourseCount': json['historical_course_count'],
+        'activeLearnerCount': json['active_learner_count'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+    };
+}
+
+export function GetLibraryQuizToJSON(json: any): GetLibraryQuiz {
+    return GetLibraryQuizToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizToJSONTyped(value?: GetLibraryQuiz | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'kind': value['kind'],
+        'name': value['name'],
+        'description': value['description'],
+        'owner_id': value['ownerId'],
+        'latest_published_version': GetLibraryQuizVersionToJSON(value['latestPublishedVersion']),
+        'draft_version': GetLibraryQuizVersionToJSON(value['draftVersion']),
+        'versions': ((value['versions'] as Array<any>).map(GetLibraryQuizVersionToJSON)),
+        'published_course_count': value['publishedCourseCount'],
+        'draft_course_count': value['draftCourseCount'],
+        'historical_course_count': value['historicalCourseCount'],
+        'active_learner_count': value['activeLearnerCount'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'archived_at': value['archivedAt'],
+    };
+}
+

package/src/models/GetLibraryQuizAnalytics.ts

@@ -0,0 +1,120 @@
+/* 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 GetLibraryQuizAnalytics
+ */
+export interface GetLibraryQuizAnalytics {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    quizId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    totalAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    completedAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    pendingReviewAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    averageScore: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    passRate: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLibraryQuizAnalytics
+     */
+    averageDurationSeconds: number;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizAnalytics interface.
+ */
+export function instanceOfGetLibraryQuizAnalytics(value: object): value is GetLibraryQuizAnalytics {
+    if (!('quizId' in value) || value['quizId'] === undefined) return false;
+    if (!('totalAttempts' in value) || value['totalAttempts'] === undefined) return false;
+    if (!('completedAttempts' in value) || value['completedAttempts'] === undefined) return false;
+    if (!('pendingReviewAttempts' in value) || value['pendingReviewAttempts'] === undefined) return false;
+    if (!('averageScore' in value) || value['averageScore'] === undefined) return false;
+    if (!('passRate' in value) || value['passRate'] === undefined) return false;
+    if (!('averageDurationSeconds' in value) || value['averageDurationSeconds'] === undefined) return false;
+    return true;
+}
+
+export function GetLibraryQuizAnalyticsFromJSON(json: any): GetLibraryQuizAnalytics {
+    return GetLibraryQuizAnalyticsFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizAnalyticsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizAnalytics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'quizId': json['quiz_id'],
+        'totalAttempts': json['total_attempts'],
+        'completedAttempts': json['completed_attempts'],
+        'pendingReviewAttempts': json['pending_review_attempts'],
+        'averageScore': json['average_score'],
+        'passRate': json['pass_rate'],
+        'averageDurationSeconds': json['average_duration_seconds'],
+    };
+}
+
+export function GetLibraryQuizAnalyticsToJSON(json: any): GetLibraryQuizAnalytics {
+    return GetLibraryQuizAnalyticsToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizAnalyticsToJSONTyped(value?: GetLibraryQuizAnalytics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'quiz_id': value['quizId'],
+        'total_attempts': value['totalAttempts'],
+        'completed_attempts': value['completedAttempts'],
+        'pending_review_attempts': value['pendingReviewAttempts'],
+        'average_score': value['averageScore'],
+        'pass_rate': value['passRate'],
+        'average_duration_seconds': value['averageDurationSeconds'],
+    };
+}
+

package/src/models/GetLibraryQuizList.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 { GetLibraryQuiz } from './GetLibraryQuiz';
+import {
+    GetLibraryQuizFromJSON,
+    GetLibraryQuizFromJSONTyped,
+    GetLibraryQuizToJSON,
+    GetLibraryQuizToJSONTyped,
+} from './GetLibraryQuiz';
+
+/**
+ * 
+ * @export
+ * @interface GetLibraryQuizList
+ */
+export interface GetLibraryQuizList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetLibraryQuizList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetLibraryQuiz>}
+     * @memberof GetLibraryQuizList
+     */
+    items: Array<GetLibraryQuiz>;
+}
+
+/**
+ * Check if a given object implements the GetLibraryQuizList interface.
+ */
+export function instanceOfGetLibraryQuizList(value: object): value is GetLibraryQuizList {
+    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 GetLibraryQuizListFromJSON(json: any): GetLibraryQuizList {
+    return GetLibraryQuizListFromJSONTyped(json, false);
+}
+
+export function GetLibraryQuizListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLibraryQuizList {
+    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(GetLibraryQuizFromJSON)),
+    };
+}
+
+export function GetLibraryQuizListToJSON(json: any): GetLibraryQuizList {
+    return GetLibraryQuizListToJSONTyped(json, false);
+}
+
+export function GetLibraryQuizListToJSONTyped(value?: GetLibraryQuizList | 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(GetLibraryQuizToJSON)),
+    };
+}
+