@easyedu/js-lsm-api 1.94.0 → 1.95.0

package/src/models/GetContentAttempts.ts

@@ -1,164 +0,0 @@
-/* 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)),
-    };
-}
-

package/src/models/GetContentContentData.ts

@@ -1,89 +0,0 @@
-/* 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 type { MediaContent } from './MediaContent';
-import {
-    instanceOfMediaContent,
-    MediaContentFromJSON,
-    MediaContentFromJSONTyped,
-    MediaContentToJSON,
-} from './MediaContent';
-import type { QuizContent } from './QuizContent';
-import {
-    instanceOfQuizContent,
-    QuizContentFromJSON,
-    QuizContentFromJSONTyped,
-    QuizContentToJSON,
-} from './QuizContent';
-import type { SCORMContent } from './SCORMContent';
-import {
-    instanceOfSCORMContent,
-    SCORMContentFromJSON,
-    SCORMContentFromJSONTyped,
-    SCORMContentToJSON,
-} from './SCORMContent';
-
-/**
- * @type GetContentContentData
- * Content-specific data based on content_type
- * @export
- */
-export type GetContentContentData = MediaContent | QuizContent | SCORMContent;
-
-export function GetContentContentDataFromJSON(json: any): GetContentContentData {
-    return GetContentContentDataFromJSONTyped(json, false);
-}
-
-export function GetContentContentDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentContentData {
-    if (json == null) {
-        return json;
-    }
-    if (typeof json !== 'object') {
-        return json;
-    }
-    if (instanceOfMediaContent(json)) {
-        return MediaContentFromJSONTyped(json, true);
-    }
-    if (instanceOfQuizContent(json)) {
-        return QuizContentFromJSONTyped(json, true);
-    }
-    if (instanceOfSCORMContent(json)) {
-        return SCORMContentFromJSONTyped(json, true);
-    }
-    return {} as any;
-}
-
-export function GetContentContentDataToJSON(json: any): any {
-    return GetContentContentDataToJSONTyped(json, false);
-}
-
-export function GetContentContentDataToJSONTyped(value?: GetContentContentData | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-    if (typeof value !== 'object') {
-        return value;
-    }
-    if (instanceOfMediaContent(value)) {
-        return MediaContentToJSON(value as MediaContent);
-    }
-    if (instanceOfQuizContent(value)) {
-        return QuizContentToJSON(value as QuizContent);
-    }
-    if (instanceOfSCORMContent(value)) {
-        return SCORMContentToJSON(value as SCORMContent);
-    }
-    return {};
-}
-

package/src/models/GetContentGradeDetail.ts

@@ -1,191 +0,0 @@
-/* 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 { ScormSessionData } from './ScormSessionData';
-import {
-    ScormSessionDataFromJSON,
-    ScormSessionDataFromJSONTyped,
-    ScormSessionDataToJSON,
-    ScormSessionDataToJSONTyped,
-} from './ScormSessionData';
-import type { GetContentGradesItemsInnerUser } from './GetContentGradesItemsInnerUser';
-import {
-    GetContentGradesItemsInnerUserFromJSON,
-    GetContentGradesItemsInnerUserFromJSONTyped,
-    GetContentGradesItemsInnerUserToJSON,
-    GetContentGradesItemsInnerUserToJSONTyped,
-} from './GetContentGradesItemsInnerUser';
-
-/**
- * 
- * @export
- * @interface GetContentGradeDetail
- */
-export interface GetContentGradeDetail {
-    /**
-     * Content session external ID
-     * @type {string}
-     * @memberof GetContentGradeDetail
-     */
-    id?: string | null;
-    /**
-     * 
-     * @type {GetContentGradesItemsInnerUser}
-     * @memberof GetContentGradeDetail
-     */
-    user: GetContentGradesItemsInnerUser;
-    /**
-     * Content completion status
-     * @type {GetContentGradeDetailCompletionEnum}
-     * @memberof GetContentGradeDetail
-     */
-    completion: GetContentGradeDetailCompletionEnum;
-    /**
-     * Content grade status
-     * @type {GetContentGradeDetailGradeStatusEnum}
-     * @memberof GetContentGradeDetail
-     */
-    gradeStatus: GetContentGradeDetailGradeStatusEnum;
-    /**
-     * Content session creation timestamp (epoch seconds)
-     * @type {number}
-     * @memberof GetContentGradeDetail
-     */
-    createdAt: number | null;
-    /**
-     * Content session last update timestamp (epoch seconds)
-     * @type {number}
-     * @memberof GetContentGradeDetail
-     */
-    updatedAt: number | null;
-    /**
-     * Type of content
-     * @type {GetContentGradeDetailContentTypeEnum}
-     * @memberof GetContentGradeDetail
-     */
-    contentType: GetContentGradeDetailContentTypeEnum;
-    /**
-     * Number of attempts for this content
-     * @type {number}
-     * @memberof GetContentGradeDetail
-     */
-    attemptCount?: number | null;
-    /**
-     * 
-     * @type {ScormSessionData}
-     * @memberof GetContentGradeDetail
-     */
-    scormData?: ScormSessionData;
-}
-
-
-/**
- * @export
- */
-export const GetContentGradeDetailCompletionEnum = {
-    NotAttempted: 'NotAttempted',
-    InProgress: 'InProgress',
-    Completed: 'Completed'
-} as const;
-export type GetContentGradeDetailCompletionEnum = typeof GetContentGradeDetailCompletionEnum[keyof typeof GetContentGradeDetailCompletionEnum];
-
-/**
- * @export
- */
-export const GetContentGradeDetailGradeStatusEnum = {
-    Ungraded: 'Ungraded',
-    Passed: 'Passed',
-    Failed: 'Failed',
-    PointsEarned: 'PointsEarned',
-    PercentageEarned: 'PercentageEarned',
-    NotApplicable: 'NotApplicable'
-} as const;
-export type GetContentGradeDetailGradeStatusEnum = typeof GetContentGradeDetailGradeStatusEnum[keyof typeof GetContentGradeDetailGradeStatusEnum];
-
-/**
- * @export
- */
-export const GetContentGradeDetailContentTypeEnum = {
-    Scorm: 'Scorm',
-    Video: 'Video',
-    Audio: 'Audio',
-    Image: 'Image',
-    Text: 'Text',
-    Link: 'Link',
-    File: 'File',
-    Pdf: 'Pdf',
-    Quiz: 'Quiz'
-} as const;
-export type GetContentGradeDetailContentTypeEnum = typeof GetContentGradeDetailContentTypeEnum[keyof typeof GetContentGradeDetailContentTypeEnum];
-
-
-/**
- * Check if a given object implements the GetContentGradeDetail interface.
- */
-export function instanceOfGetContentGradeDetail(value: object): value is GetContentGradeDetail {
-    if (!('user' in value) || value['user'] === undefined) return false;
-    if (!('completion' in value) || value['completion'] === undefined) return false;
-    if (!('gradeStatus' in value) || value['gradeStatus'] === undefined) return false;
-    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
-    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
-    if (!('contentType' in value) || value['contentType'] === undefined) return false;
-    return true;
-}
-
-export function GetContentGradeDetailFromJSON(json: any): GetContentGradeDetail {
-    return GetContentGradeDetailFromJSONTyped(json, false);
-}
-
-export function GetContentGradeDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGradeDetail {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'id': json['id'] == null ? undefined : json['id'],
-        'user': GetContentGradesItemsInnerUserFromJSON(json['user']),
-        'completion': json['completion'],
-        'gradeStatus': json['grade_status'],
-        'createdAt': json['created_at'],
-        'updatedAt': json['updated_at'],
-        'contentType': json['content_type'],
-        'attemptCount': json['attempt_count'] == null ? undefined : json['attempt_count'],
-        'scormData': json['scorm_data'] == null ? undefined : ScormSessionDataFromJSON(json['scorm_data']),
-    };
-}
-
-export function GetContentGradeDetailToJSON(json: any): GetContentGradeDetail {
-    return GetContentGradeDetailToJSONTyped(json, false);
-}
-
-export function GetContentGradeDetailToJSONTyped(value?: GetContentGradeDetail | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'id': value['id'],
-        'user': GetContentGradesItemsInnerUserToJSON(value['user']),
-        'completion': value['completion'],
-        'grade_status': value['gradeStatus'],
-        'created_at': value['createdAt'],
-        'updated_at': value['updatedAt'],
-        'content_type': value['contentType'],
-        'attempt_count': value['attemptCount'],
-        'scorm_data': ScormSessionDataToJSON(value['scormData']),
-    };
-}
-

package/src/models/GetContentGrades.ts

@@ -1,110 +0,0 @@
-/* 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 { GetContentGradesItemsInner } from './GetContentGradesItemsInner';
-import {
-    GetContentGradesItemsInnerFromJSON,
-    GetContentGradesItemsInnerFromJSONTyped,
-    GetContentGradesItemsInnerToJSON,
-    GetContentGradesItemsInnerToJSONTyped,
-} from './GetContentGradesItemsInner';
-
-/**
- * 
- * @export
- * @interface GetContentGrades
- */
-export interface GetContentGrades {
-    /**
-     * The current page number
-     * @type {number}
-     * @memberof GetContentGrades
-     */
-    page: number;
-    /**
-     * The number of items per page
-     * @type {number}
-     * @memberof GetContentGrades
-     */
-    pageSize: number;
-    /**
-     * The total number of pages
-     * @type {number}
-     * @memberof GetContentGrades
-     */
-    totalPages: number;
-    /**
-     * The total number of items
-     * @type {number}
-     * @memberof GetContentGrades
-     */
-    totalItems: number;
-    /**
-     * 
-     * @type {Array<GetContentGradesItemsInner>}
-     * @memberof GetContentGrades
-     */
-    items: Array<GetContentGradesItemsInner>;
-}
-
-/**
- * Check if a given object implements the GetContentGrades interface.
- */
-export function instanceOfGetContentGrades(value: object): value is GetContentGrades {
-    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 GetContentGradesFromJSON(json: any): GetContentGrades {
-    return GetContentGradesFromJSONTyped(json, false);
-}
-
-export function GetContentGradesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetContentGrades {
-    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(GetContentGradesItemsInnerFromJSON)),
-    };
-}
-
-export function GetContentGradesToJSON(json: any): GetContentGrades {
-    return GetContentGradesToJSONTyped(json, false);
-}
-
-export function GetContentGradesToJSONTyped(value?: GetContentGrades | 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(GetContentGradesItemsInnerToJSON)),
-    };
-}
-