@easyedu/js-lsm-api 1.99.0 → 1.101.0

package/src/apis/CourseApi.ts

@@ -13,6 +13,11 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type GetAttemptAllowance,
+    GetAttemptAllowanceFromJSON,
+    GetAttemptAllowanceToJSON,
+} from '../models/GetAttemptAllowance';
 import {
     type GetCourse,
     GetCourseFromJSON,
@@ -78,6 +83,16 @@ import {
     GetCourseVersionSectionFromJSON,
     GetCourseVersionSectionToJSON,
 } from '../models/GetCourseVersionSection';
+import {
+    type PostClearSessions,
+    PostClearSessionsFromJSON,
+    PostClearSessionsToJSON,
+} from '../models/PostClearSessions';
+import {
+    type PostClearSessionsResponse,
+    PostClearSessionsResponseFromJSON,
+    PostClearSessionsResponseToJSON,
+} from '../models/PostClearSessionsResponse';
 import {
     type PostCourse,
     PostCourseFromJSON,
@@ -133,6 +148,11 @@ import {
     PostDuplicateFromJSON,
     PostDuplicateToJSON,
 } from '../models/PostDuplicate';
+import {
+    type PutAttemptAllowance,
+    PutAttemptAllowanceFromJSON,
+    PutAttemptAllowanceToJSON,
+} from '../models/PutAttemptAllowance';
 import {
     type PutCourse,
     PutCourseFromJSON,
@@ -226,6 +246,13 @@ export interface GetCourseExportsRequest {
     pageSize?: number;
 }
 
+export interface GetCourseItemLearnerAttemptAllowanceRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+}
+
 export interface GetCourseListRequest {
     page?: number;
     pageSize?: number;
@@ -282,6 +309,14 @@ export interface PostCourseImageUploadRequest {
     file: Blob;
 }
 
+export interface PostCourseItemLearnerSessionsClearRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+    postClearSessions: PostClearSessions;
+}
+
 export interface PostCourseResumeRequest {
     courseId: string;
 }
@@ -327,6 +362,14 @@ export interface PutCourseEnrollmentRequest {
     putCourseEnrollment: PutCourseEnrollment;
 }
 
+export interface PutCourseItemLearnerAttemptAllowanceRequest {
+    courseId: string;
+    courseVersionId: string;
+    itemId: string;
+    userId: string;
+    putAttemptAllowance: PutAttemptAllowance;
+}
+
 export interface PutCourseVersionItemRequest {
     courseId: string;
     sectionId: string;
@@ -1023,6 +1066,75 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getCourseItemLearnerAttemptAllowance without sending the request
+     */
+    async getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling getCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get a learner\'s effective attempt limit for a course item
+     */
+    async getCourseItemLearnerAttemptAllowanceRaw(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
+        const requestOptions = await this.getCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a learner\'s effective attempt limit for a course item
+     */
+    async getCourseItemLearnerAttemptAllowance(requestParameters: GetCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
+        const response = await this.getCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourseList without sending the request
      */
@@ -1614,6 +1726,85 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postCourseItemLearnerSessionsClear without sending the request
+     */
+    async postCourseItemLearnerSessionsClearRequestOpts(requestParameters: PostCourseItemLearnerSessionsClearRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        if (requestParameters['postClearSessions'] == null) {
+            throw new runtime.RequiredError(
+                'postClearSessions',
+                'Required parameter "postClearSessions" was null or undefined when calling postCourseItemLearnerSessionsClear().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/sessions/clear`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PostClearSessionsToJSON(requestParameters['postClearSessions']),
+        };
+    }
+
+    /**
+     * Clear all live sessions for a learner and course item
+     */
+    async postCourseItemLearnerSessionsClearRaw(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostClearSessionsResponse>> {
+        const requestOptions = await this.postCourseItemLearnerSessionsClearRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostClearSessionsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Clear all live sessions for a learner and course item
+     */
+    async postCourseItemLearnerSessionsClear(requestParameters: PostCourseItemLearnerSessionsClearRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostClearSessionsResponse> {
+        const response = await this.postCourseItemLearnerSessionsClearRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postCourseResume without sending the request
      */
@@ -2080,6 +2271,85 @@ export class CourseApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putCourseItemLearnerAttemptAllowance without sending the request
+     */
+    async putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['courseVersionId'] == null) {
+            throw new runtime.RequiredError(
+                'courseVersionId',
+                'Required parameter "courseVersionId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['itemId'] == null) {
+            throw new runtime.RequiredError(
+                'itemId',
+                'Required parameter "itemId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        if (requestParameters['putAttemptAllowance'] == null) {
+            throw new runtime.RequiredError(
+                'putAttemptAllowance',
+                'Required parameter "putAttemptAllowance" was null or undefined when calling putCourseItemLearnerAttemptAllowance().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/courses/{courseId}/versions/{courseVersionId}/items/{itemId}/learners/{userId}/attempt-allowance`;
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseVersionId}', encodeURIComponent(String(requestParameters['courseVersionId'])));
+        urlPath = urlPath.replace('{itemId}', encodeURIComponent(String(requestParameters['itemId'])));
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutAttemptAllowanceToJSON(requestParameters['putAttemptAllowance']),
+        };
+    }
+
+    /**
+     * Set extra attempts for a learner on a course item
+     */
+    async putCourseItemLearnerAttemptAllowanceRaw(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAttemptAllowance>> {
+        const requestOptions = await this.putCourseItemLearnerAttemptAllowanceRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetAttemptAllowanceFromJSON(jsonValue));
+    }
+
+    /**
+     * Set extra attempts for a learner on a course item
+     */
+    async putCourseItemLearnerAttemptAllowance(requestParameters: PutCourseItemLearnerAttemptAllowanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttemptAllowance> {
+        const response = await this.putCourseItemLearnerAttemptAllowanceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for putCourseVersionItem without sending the request
      */

package/src/apis/PlayerApi.ts

@@ -58,6 +58,11 @@ import {
     PostResourceSessionActivityEventFromJSON,
     PostResourceSessionActivityEventToJSON,
 } from '../models/PostResourceSessionActivityEvent';
+import {
+    type PutResourceSessionOverride,
+    PutResourceSessionOverrideFromJSON,
+    PutResourceSessionOverrideToJSON,
+} from '../models/PutResourceSessionOverride';
 import {
     type ResourceSessionEnvironment,
     ResourceSessionEnvironmentFromJSON,
@@ -183,6 +188,11 @@ export interface PostResourceSessionCompleteRequest {
     sessionId: string;
 }
 
+export interface PutResourceSessionOverrideRequest {
+    sessionId: string;
+    putResourceSessionOverride: PutResourceSessionOverride;
+}
+
 export interface SetResourceScormValueRequest {
     sessionId: string;
     scormSetValueRequest: ScormSetValueRequest;
@@ -1090,6 +1100,61 @@ export class PlayerApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for putResourceSessionOverride without sending the request
+     */
+    async putResourceSessionOverrideRequestOpts(requestParameters: PutResourceSessionOverrideRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling putResourceSessionOverride().'
+            );
+        }
+
+        if (requestParameters['putResourceSessionOverride'] == null) {
+            throw new runtime.RequiredError(
+                'putResourceSessionOverride',
+                'Required parameter "putResourceSessionOverride" was null or undefined when calling putResourceSessionOverride().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/resource/sessions/{sessionId}/override`;
+        urlPath = urlPath.replace('{sessionId}', encodeURIComponent(String(requestParameters['sessionId'])));
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PutResourceSessionOverrideToJSON(requestParameters['putResourceSessionOverride']),
+        };
+    }
+
+    /**
+     * Override a learner\'s live resource-session progress
+     */
+    async putResourceSessionOverrideRaw(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetResourceSession>> {
+        const requestOptions = await this.putResourceSessionOverrideRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetResourceSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Override a learner\'s live resource-session progress
+     */
+    async putResourceSessionOverride(requestParameters: PutResourceSessionOverrideRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetResourceSession> {
+        const response = await this.putResourceSessionOverrideRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for setResourceScormValue without sending the request
      */

package/src/apis/index.ts

@@ -2,6 +2,7 @@
 /* eslint-disable */
 export * from './CertificateApi';
 export * from './CertificateTemplateApi';
+export * from './ChangelogApi';
 export * from './ChatApi';
 export * from './ContentLibraryApi';
 export * from './ContentLibraryQuizApi';

package/src/models/GetAttemptAllowance.ts

@@ -0,0 +1,138 @@
+/* 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';
+/**
+ * The effective attempt limit for one learner and course-version item.
+ * @export
+ * @interface GetAttemptAllowance
+ */
+export interface GetAttemptAllowance {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetAttemptAllowance
+     */
+    courseId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetAttemptAllowance
+     */
+    courseVersionId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetAttemptAllowance
+     */
+    itemId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetAttemptAllowance
+     */
+    userId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAttemptAllowance
+     */
+    baseMaxAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAttemptAllowance
+     */
+    additionalAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAttemptAllowance
+     */
+    effectiveMaxAttempts: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAttemptAllowance
+     */
+    attemptsUsed: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetAttemptAllowance
+     */
+    attemptsRemaining: number;
+}
+
+/**
+ * Check if a given object implements the GetAttemptAllowance interface.
+ */
+export function instanceOfGetAttemptAllowance(value: object): value is GetAttemptAllowance {
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('courseVersionId' in value) || value['courseVersionId'] === undefined) return false;
+    if (!('itemId' in value) || value['itemId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('baseMaxAttempts' in value) || value['baseMaxAttempts'] === undefined) return false;
+    if (!('additionalAttempts' in value) || value['additionalAttempts'] === undefined) return false;
+    if (!('effectiveMaxAttempts' in value) || value['effectiveMaxAttempts'] === undefined) return false;
+    if (!('attemptsUsed' in value) || value['attemptsUsed'] === undefined) return false;
+    if (!('attemptsRemaining' in value) || value['attemptsRemaining'] === undefined) return false;
+    return true;
+}
+
+export function GetAttemptAllowanceFromJSON(json: any): GetAttemptAllowance {
+    return GetAttemptAllowanceFromJSONTyped(json, false);
+}
+
+export function GetAttemptAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetAttemptAllowance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'courseId': json['course_id'],
+        'courseVersionId': json['course_version_id'],
+        'itemId': json['item_id'],
+        'userId': json['user_id'],
+        'baseMaxAttempts': json['base_max_attempts'],
+        'additionalAttempts': json['additional_attempts'],
+        'effectiveMaxAttempts': json['effective_max_attempts'],
+        'attemptsUsed': json['attempts_used'],
+        'attemptsRemaining': json['attempts_remaining'],
+    };
+}
+
+export function GetAttemptAllowanceToJSON(json: any): GetAttemptAllowance {
+    return GetAttemptAllowanceToJSONTyped(json, false);
+}
+
+export function GetAttemptAllowanceToJSONTyped(value?: GetAttemptAllowance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course_id': value['courseId'],
+        'course_version_id': value['courseVersionId'],
+        'item_id': value['itemId'],
+        'user_id': value['userId'],
+        'base_max_attempts': value['baseMaxAttempts'],
+        'additional_attempts': value['additionalAttempts'],
+        'effective_max_attempts': value['effectiveMaxAttempts'],
+        'attempts_used': value['attemptsUsed'],
+        'attempts_remaining': value['attemptsRemaining'],
+    };
+}
+

package/src/models/GetChangelogEntry.ts

@@ -0,0 +1,84 @@
+/* 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 user-facing summary of product changes published on one date.
+ * @export
+ * @interface GetChangelogEntry
+ */
+export interface GetChangelogEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetChangelogEntry
+     */
+    title: string;
+    /**
+     * A short Markdown-formatted summary. Multiple changes are represented as bullet points.
+     * @type {string}
+     * @memberof GetChangelogEntry
+     */
+    desc: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof GetChangelogEntry
+     */
+    date: Date;
+}
+
+/**
+ * Check if a given object implements the GetChangelogEntry interface.
+ */
+export function instanceOfGetChangelogEntry(value: object): value is GetChangelogEntry {
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('desc' in value) || value['desc'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    return true;
+}
+
+export function GetChangelogEntryFromJSON(json: any): GetChangelogEntry {
+    return GetChangelogEntryFromJSONTyped(json, false);
+}
+
+export function GetChangelogEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetChangelogEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'title': json['title'],
+        'desc': json['desc'],
+        'date': (new Date(json['date'])),
+    };
+}
+
+export function GetChangelogEntryToJSON(json: any): GetChangelogEntry {
+    return GetChangelogEntryToJSONTyped(json, false);
+}
+
+export function GetChangelogEntryToJSONTyped(value?: GetChangelogEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'title': value['title'],
+        'desc': value['desc'],
+        'date': value['date'].toISOString().substring(0,10),
+    };
+}
+