@easyedu/js-lsm-api 1.67.0 → 1.68.0

package/src/apis/ContentApi.ts

@@ -18,6 +18,11 @@ import {
     GetContentFromJSON,
     GetContentToJSON,
 } from '../models/GetContent';
+import {
+    type GetContentAttempts,
+    GetContentAttemptsFromJSON,
+    GetContentAttemptsToJSON,
+} from '../models/GetContentAttempts';
 import {
     type GetContentList,
     GetContentListFromJSON,
@@ -147,6 +152,14 @@ export interface GetContentRequest {
     courseId: string;
 }
 
+export interface GetContentAttemptsRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    userId?: number;
+    environment?: GetContentAttemptsEnvironmentEnum;
+}
+
 export interface GetContentListRequest {
     moduleId: string;
     courseId: string;
@@ -239,6 +252,13 @@ export interface PostContentSessionRequest {
     environment?: PostContentSessionEnvironmentEnum;
 }
 
+export interface PostContentSessionRetakeRequest {
+    contentId: string;
+    moduleId: string;
+    courseId: string;
+    environment?: PostContentSessionRetakeEnvironmentEnum;
+}
+
 export interface PostContentUploadRequest {
     moduleId: string;
     courseId: string;
@@ -528,6 +548,77 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getContentAttempts without sending the request
+     */
+    async getContentAttemptsRequestOpts(requestParameters: GetContentAttemptsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling getContentAttempts().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling getContentAttempts().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling getContentAttempts().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['user_id'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['environment'] != null) {
+            queryParameters['environment'] = requestParameters['environment'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/attempts`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Lists content attempts and score rollup for the current learner. Instructors may pass user_id to inspect another learner.
+     * Get content attempts
+     */
+    async getContentAttemptsRaw(requestParameters: GetContentAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetContentAttempts>> {
+        const requestOptions = await this.getContentAttemptsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetContentAttemptsFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists content attempts and score rollup for the current learner. Instructors may pass user_id to inspect another learner.
+     * Get content attempts
+     */
+    async getContentAttempts(requestParameters: GetContentAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetContentAttempts> {
+        const response = await this.getContentAttemptsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getContentList without sending the request
      */
@@ -1445,6 +1536,71 @@ export class ContentApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postContentSessionRetake without sending the request
+     */
+    async postContentSessionRetakeRequestOpts(requestParameters: PostContentSessionRetakeRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['contentId'] == null) {
+            throw new runtime.RequiredError(
+                'contentId',
+                'Required parameter "contentId" was null or undefined when calling postContentSessionRetake().'
+            );
+        }
+
+        if (requestParameters['moduleId'] == null) {
+            throw new runtime.RequiredError(
+                'moduleId',
+                'Required parameter "moduleId" was null or undefined when calling postContentSessionRetake().'
+            );
+        }
+
+        if (requestParameters['courseId'] == null) {
+            throw new runtime.RequiredError(
+                'courseId',
+                'Required parameter "courseId" was null or undefined when calling postContentSessionRetake().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['environment'] != null) {
+            queryParameters['environment'] = requestParameters['environment'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/courses/{courseId}/modules/{moduleId}/contents/{contentId}/session/retake`;
+        urlPath = urlPath.replace('{contentId}', encodeURIComponent(String(requestParameters['contentId'])));
+        urlPath = urlPath.replace('{moduleId}', encodeURIComponent(String(requestParameters['moduleId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Create a new retake content session
+     */
+    async postContentSessionRetakeRaw(requestParameters: PostContentSessionRetakeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PostContentSession>> {
+        const requestOptions = await this.postContentSessionRetakeRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostContentSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new retake content session
+     */
+    async postContentSessionRetake(requestParameters: PostContentSessionRetakeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostContentSession> {
+        const response = await this.postContentSessionRetakeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postContentUpload without sending the request
      */
@@ -1946,6 +2102,14 @@ export class ContentApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const GetContentAttemptsEnvironmentEnum = {
+    Sandbox: 'sandbox',
+    Live: 'live'
+} as const;
+export type GetContentAttemptsEnvironmentEnum = typeof GetContentAttemptsEnvironmentEnum[keyof typeof GetContentAttemptsEnvironmentEnum];
 /**
  * @export
  */
@@ -1962,3 +2126,11 @@ export const PostContentSessionEnvironmentEnum = {
     Live: 'live'
 } as const;
 export type PostContentSessionEnvironmentEnum = typeof PostContentSessionEnvironmentEnum[keyof typeof PostContentSessionEnvironmentEnum];
+/**
+ * @export
+ */
+export const PostContentSessionRetakeEnvironmentEnum = {
+    Sandbox: 'sandbox',
+    Live: 'live'
+} as const;
+export type PostContentSessionRetakeEnvironmentEnum = typeof PostContentSessionRetakeEnvironmentEnum[keyof typeof PostContentSessionRetakeEnvironmentEnum];

package/src/models/ContentAttemptItem.ts

@@ -0,0 +1,128 @@
+/* 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 { ContentAttemptScore } from './ContentAttemptScore';
+import {
+    ContentAttemptScoreFromJSON,
+    ContentAttemptScoreFromJSONTyped,
+    ContentAttemptScoreToJSON,
+    ContentAttemptScoreToJSONTyped,
+} from './ContentAttemptScore';
+
+/**
+ * A single learner attempt for a content item
+ * @export
+ * @interface ContentAttemptItem
+ */
+export interface ContentAttemptItem {
+    /**
+     * Content session UUID for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    sessionId: string;
+    /**
+     * Learner attempt number for this content item
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    attemptNumber: number;
+    /**
+     * Completion status for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    completionStatus: string;
+    /**
+     * Grade status for this attempt
+     * @type {string}
+     * @memberof ContentAttemptItem
+     */
+    gradeStatus: string;
+    /**
+     * 
+     * @type {ContentAttemptScore}
+     * @memberof ContentAttemptItem
+     */
+    score: ContentAttemptScore | null;
+    /**
+     * Attempt creation time as a Unix timestamp in seconds
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    createdAt: number;
+    /**
+     * Attempt update time as a Unix timestamp in seconds
+     * @type {number}
+     * @memberof ContentAttemptItem
+     */
+    updatedAt: number;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptItem interface.
+ */
+export function instanceOfContentAttemptItem(value: object): value is ContentAttemptItem {
+    if (!('sessionId' in value) || value['sessionId'] === undefined) return false;
+    if (!('attemptNumber' in value) || value['attemptNumber'] === undefined) return false;
+    if (!('completionStatus' in value) || value['completionStatus'] === undefined) return false;
+    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
+    if (!('score' in value) || value['score'] === 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 ContentAttemptItemFromJSON(json: any): ContentAttemptItem {
+    return ContentAttemptItemFromJSONTyped(json, false);
+}
+
+export function ContentAttemptItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sessionId': json['session_id'],
+        'attemptNumber': json['attempt_number'],
+        'completionStatus': json['completion_status'],
+        'gradeStatus': json['grade_status'],
+        'score': ContentAttemptScoreFromJSON(json['score']),
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function ContentAttemptItemToJSON(json: any): ContentAttemptItem {
+    return ContentAttemptItemToJSONTyped(json, false);
+}
+
+export function ContentAttemptItemToJSONTyped(value?: ContentAttemptItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'session_id': value['sessionId'],
+        'attempt_number': value['attemptNumber'],
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score': ContentAttemptScoreToJSON(value['score']),
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/ContentAttemptRollupScore.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * Rolled-up score for a content item
+ * @export
+ * @interface ContentAttemptRollupScore
+ */
+export interface ContentAttemptRollupScore {
+    /**
+     * Rolled-up score normalized to a 0-100 percentage
+     * @type {number}
+     * @memberof ContentAttemptRollupScore
+     */
+    percentage: number;
+    /**
+     * Attempt number that supplied the rolled-up score
+     * @type {number}
+     * @memberof ContentAttemptRollupScore
+     */
+    sourceAttemptNumber: number;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptRollupScore interface.
+ */
+export function instanceOfContentAttemptRollupScore(value: object): value is ContentAttemptRollupScore {
+    if (!('percentage' in value) || value['percentage'] === undefined) return false;
+    if (!('sourceAttemptNumber' in value) || value['sourceAttemptNumber'] === undefined) return false;
+    return true;
+}
+
+export function ContentAttemptRollupScoreFromJSON(json: any): ContentAttemptRollupScore {
+    return ContentAttemptRollupScoreFromJSONTyped(json, false);
+}
+
+export function ContentAttemptRollupScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptRollupScore {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'percentage': json['percentage'],
+        'sourceAttemptNumber': json['source_attempt_number'],
+    };
+}
+
+export function ContentAttemptRollupScoreToJSON(json: any): ContentAttemptRollupScore {
+    return ContentAttemptRollupScoreToJSONTyped(json, false);
+}
+
+export function ContentAttemptRollupScoreToJSONTyped(value?: ContentAttemptRollupScore | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'percentage': value['percentage'],
+        'source_attempt_number': value['sourceAttemptNumber'],
+    };
+}
+

package/src/models/ContentAttemptScore.ts

@@ -0,0 +1,89 @@
+/* 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';
+/**
+ * Normalized score data for a content attempt
+ * @export
+ * @interface ContentAttemptScore
+ */
+export interface ContentAttemptScore {
+    /**
+     * Raw score reported by the content, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    raw?: number | null;
+    /**
+     * Minimum possible score, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    min?: number | null;
+    /**
+     * Maximum possible score, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    max?: number | null;
+    /**
+     * Score normalized to a 0-100 percentage, if available
+     * @type {number}
+     * @memberof ContentAttemptScore
+     */
+    percentage?: number | null;
+}
+
+/**
+ * Check if a given object implements the ContentAttemptScore interface.
+ */
+export function instanceOfContentAttemptScore(value: object): value is ContentAttemptScore {
+    return true;
+}
+
+export function ContentAttemptScoreFromJSON(json: any): ContentAttemptScore {
+    return ContentAttemptScoreFromJSONTyped(json, false);
+}
+
+export function ContentAttemptScoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContentAttemptScore {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'raw': json['raw'] == null ? undefined : json['raw'],
+        'min': json['min'] == null ? undefined : json['min'],
+        'max': json['max'] == null ? undefined : json['max'],
+        'percentage': json['percentage'] == null ? undefined : json['percentage'],
+    };
+}
+
+export function ContentAttemptScoreToJSON(json: any): ContentAttemptScore {
+    return ContentAttemptScoreToJSONTyped(json, false);
+}
+
+export function ContentAttemptScoreToJSONTyped(value?: ContentAttemptScore | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'raw': value['raw'],
+        'min': value['min'],
+        'max': value['max'],
+        'percentage': value['percentage'],
+    };
+}
+

package/src/models/GetContentAttempts.ts

@@ -0,0 +1,164 @@
+/* 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 { ContentAttemptRollupScore } from './ContentAttemptRollupScore';
+import {
+    ContentAttemptRollupScoreFromJSON,
+    ContentAttemptRollupScoreFromJSONTyped,
+    ContentAttemptRollupScoreToJSON,
+    ContentAttemptRollupScoreToJSONTyped,
+} from './ContentAttemptRollupScore';
+import type { ContentAttemptItem } from './ContentAttemptItem';
+import {
+    ContentAttemptItemFromJSON,
+    ContentAttemptItemFromJSONTyped,
+    ContentAttemptItemToJSON,
+    ContentAttemptItemToJSONTyped,
+} from './ContentAttemptItem';
+
+/**
+ * Learner attempt history and rollup for a content item
+ * @export
+ * @interface GetContentAttempts
+ */
+export interface GetContentAttempts {
+    /**
+     * Content external ID
+     * @type {string}
+     * @memberof GetContentAttempts
+     */
+    contentId: string;
+    /**
+     * User ID these attempts belong to
+     * @type {string}
+     * @memberof GetContentAttempts
+     */
+    userId: string;
+    /**
+     * Maximum content sessions allowed for this learner/content pair
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    maxAttempts: number;
+    /**
+     * Number of attempts already created
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    attemptsUsed: number;
+    /**
+     * Number of additional attempts that can be created
+     * @type {number}
+     * @memberof GetContentAttempts
+     */
+    attemptsRemaining: number;
+    /**
+     * Whether another attempt may be started under the current policy
+     * @type {boolean}
+     * @memberof GetContentAttempts
+     */
+    canStartNewAttempt: boolean;
+    /**
+     * Strategy used to compute rollup_score from attempts
+     * @type {GetContentAttemptsScoreRollupStrategyEnum}
+     * @memberof GetContentAttempts
+     */
+    scoreRollupStrategy: GetContentAttemptsScoreRollupStrategyEnum;
+    /**
+     * 
+     * @type {ContentAttemptRollupScore}
+     * @memberof GetContentAttempts
+     */
+    rollupScore: ContentAttemptRollupScore | null;
+    /**
+     * 
+     * @type {Array<ContentAttemptItem>}
+     * @memberof GetContentAttempts
+     */
+    attempts: Array<ContentAttemptItem>;
+}
+
+
+/**
+ * @export
+ */
+export const GetContentAttemptsScoreRollupStrategyEnum = {
+    Latest: 'Latest',
+    Best: 'Best'
+} as const;
+export type GetContentAttemptsScoreRollupStrategyEnum = typeof GetContentAttemptsScoreRollupStrategyEnum[keyof typeof GetContentAttemptsScoreRollupStrategyEnum];
+
+
+/**
+ * Check if a given object implements the GetContentAttempts interface.
+ */
+export function instanceOfGetContentAttempts(value: object): value is GetContentAttempts {
+    if (!('contentId' in value) || value['contentId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('maxAttempts' in value) || value['maxAttempts'] === undefined) return false;
+    if (!('attemptsUsed' in value) || value['attemptsUsed'] === undefined) return false;
+    if (!('attemptsRemaining' in value) || value['attemptsRemaining'] === undefined) return false;
+    if (!('canStartNewAttempt' in value) || value['canStartNewAttempt'] === undefined) return false;
+    if (!('scoreRollupStrategy' in value) || value['scoreRollupStrategy'] === undefined) return false;
+    if (!('rollupScore' in value) || value['rollupScore'] === undefined) return false;
+    if (!('attempts' in value) || value['attempts'] === undefined) return false;
+    return true;
+}
+
+export function GetContentAttemptsFromJSON(json: any): GetContentAttempts {
+    return GetContentAttemptsFromJSONTyped(json, false);
+}
+
+export function GetContentAttemptsFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentAttempts {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'contentId': json['content_id'],
+        'userId': json['user_id'],
+        'maxAttempts': json['max_attempts'],
+        'attemptsUsed': json['attempts_used'],
+        'attemptsRemaining': json['attempts_remaining'],
+        'canStartNewAttempt': json['can_start_new_attempt'],
+        'scoreRollupStrategy': json['score_rollup_strategy'],
+        'rollupScore': ContentAttemptRollupScoreFromJSON(json['rollup_score']),
+        'attempts': ((json['attempts'] as Array<any>).map(ContentAttemptItemFromJSON)),
+    };
+}
+
+export function GetContentAttemptsToJSON(json: any): GetContentAttempts {
+    return GetContentAttemptsToJSONTyped(json, false);
+}
+
+export function GetContentAttemptsToJSONTyped(value?: GetContentAttempts | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'content_id': value['contentId'],
+        'user_id': value['userId'],
+        'max_attempts': value['maxAttempts'],
+        'attempts_used': value['attemptsUsed'],
+        'attempts_remaining': value['attemptsRemaining'],
+        'can_start_new_attempt': value['canStartNewAttempt'],
+        'score_rollup_strategy': value['scoreRollupStrategy'],
+        'rollup_score': ContentAttemptRollupScoreToJSON(value['rollupScore']),
+        'attempts': ((value['attempts'] as Array<any>).map(ContentAttemptItemToJSON)),
+    };
+}
+