@easyedu/js-lsm-api 1.99.0 → 1.100.0

package/dist/models/GetAttemptAllowance.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfGetAttemptAllowance(value: object): value is GetAttemptAllowance;
+export declare function GetAttemptAllowanceFromJSON(json: any): GetAttemptAllowance;
+export declare function GetAttemptAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetAttemptAllowance;
+export declare function GetAttemptAllowanceToJSON(json: any): GetAttemptAllowance;
+export declare function GetAttemptAllowanceToJSONTyped(value?: GetAttemptAllowance | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetAttemptAllowance.js

@@ -0,0 +1,82 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetAttemptAllowance = instanceOfGetAttemptAllowance;
+exports.GetAttemptAllowanceFromJSON = GetAttemptAllowanceFromJSON;
+exports.GetAttemptAllowanceFromJSONTyped = GetAttemptAllowanceFromJSONTyped;
+exports.GetAttemptAllowanceToJSON = GetAttemptAllowanceToJSON;
+exports.GetAttemptAllowanceToJSONTyped = GetAttemptAllowanceToJSONTyped;
+/**
+ * Check if a given object implements the GetAttemptAllowance interface.
+ */
+function instanceOfGetAttemptAllowance(value) {
+    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;
+}
+function GetAttemptAllowanceFromJSON(json) {
+    return GetAttemptAllowanceFromJSONTyped(json, false);
+}
+function GetAttemptAllowanceFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function GetAttemptAllowanceToJSON(json) {
+    return GetAttemptAllowanceToJSONTyped(json, false);
+}
+function GetAttemptAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/PostClearSessions.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PostClearSessions
+ */
+export interface PostClearSessions {
+    /**
+     *
+     * @type {string}
+     * @memberof PostClearSessions
+     */
+    reason: string;
+}
+/**
+ * Check if a given object implements the PostClearSessions interface.
+ */
+export declare function instanceOfPostClearSessions(value: object): value is PostClearSessions;
+export declare function PostClearSessionsFromJSON(json: any): PostClearSessions;
+export declare function PostClearSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostClearSessions;
+export declare function PostClearSessionsToJSON(json: any): PostClearSessions;
+export declare function PostClearSessionsToJSONTyped(value?: PostClearSessions | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostClearSessions.js

@@ -0,0 +1,50 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostClearSessions = instanceOfPostClearSessions;
+exports.PostClearSessionsFromJSON = PostClearSessionsFromJSON;
+exports.PostClearSessionsFromJSONTyped = PostClearSessionsFromJSONTyped;
+exports.PostClearSessionsToJSON = PostClearSessionsToJSON;
+exports.PostClearSessionsToJSONTyped = PostClearSessionsToJSONTyped;
+/**
+ * Check if a given object implements the PostClearSessions interface.
+ */
+function instanceOfPostClearSessions(value) {
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function PostClearSessionsFromJSON(json) {
+    return PostClearSessionsFromJSONTyped(json, false);
+}
+function PostClearSessionsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reason': json['reason'],
+    };
+}
+function PostClearSessionsToJSON(json) {
+    return PostClearSessionsToJSONTyped(json, false);
+}
+function PostClearSessionsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reason': value['reason'],
+    };
+}

package/dist/models/PostClearSessionsResponse.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PostClearSessionsResponse
+ */
+export interface PostClearSessionsResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PostClearSessionsResponse
+     */
+    resourceSessionsDeleted: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PostClearSessionsResponse
+     */
+    quizSessionsDeleted: number;
+    /**
+     *
+     * @type {number}
+     * @memberof PostClearSessionsResponse
+     */
+    totalSessionsDeleted: number;
+}
+/**
+ * Check if a given object implements the PostClearSessionsResponse interface.
+ */
+export declare function instanceOfPostClearSessionsResponse(value: object): value is PostClearSessionsResponse;
+export declare function PostClearSessionsResponseFromJSON(json: any): PostClearSessionsResponse;
+export declare function PostClearSessionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostClearSessionsResponse;
+export declare function PostClearSessionsResponseToJSON(json: any): PostClearSessionsResponse;
+export declare function PostClearSessionsResponseToJSONTyped(value?: PostClearSessionsResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostClearSessionsResponse.js

@@ -0,0 +1,58 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostClearSessionsResponse = instanceOfPostClearSessionsResponse;
+exports.PostClearSessionsResponseFromJSON = PostClearSessionsResponseFromJSON;
+exports.PostClearSessionsResponseFromJSONTyped = PostClearSessionsResponseFromJSONTyped;
+exports.PostClearSessionsResponseToJSON = PostClearSessionsResponseToJSON;
+exports.PostClearSessionsResponseToJSONTyped = PostClearSessionsResponseToJSONTyped;
+/**
+ * Check if a given object implements the PostClearSessionsResponse interface.
+ */
+function instanceOfPostClearSessionsResponse(value) {
+    if (!('resourceSessionsDeleted' in value) || value['resourceSessionsDeleted'] === undefined)
+        return false;
+    if (!('quizSessionsDeleted' in value) || value['quizSessionsDeleted'] === undefined)
+        return false;
+    if (!('totalSessionsDeleted' in value) || value['totalSessionsDeleted'] === undefined)
+        return false;
+    return true;
+}
+function PostClearSessionsResponseFromJSON(json) {
+    return PostClearSessionsResponseFromJSONTyped(json, false);
+}
+function PostClearSessionsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'resourceSessionsDeleted': json['resource_sessions_deleted'],
+        'quizSessionsDeleted': json['quiz_sessions_deleted'],
+        'totalSessionsDeleted': json['total_sessions_deleted'],
+    };
+}
+function PostClearSessionsResponseToJSON(json) {
+    return PostClearSessionsResponseToJSONTyped(json, false);
+}
+function PostClearSessionsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'resource_sessions_deleted': value['resourceSessionsDeleted'],
+        'quiz_sessions_deleted': value['quizSessionsDeleted'],
+        'total_sessions_deleted': value['totalSessionsDeleted'],
+    };
+}

package/dist/models/PutAttemptAllowance.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface PutAttemptAllowance
+ */
+export interface PutAttemptAllowance {
+    /**
+     * Attempts added to this course item's configured limit for this learner.
+     * @type {number}
+     * @memberof PutAttemptAllowance
+     */
+    additionalAttempts: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PutAttemptAllowance
+     */
+    reason: string;
+}
+/**
+ * Check if a given object implements the PutAttemptAllowance interface.
+ */
+export declare function instanceOfPutAttemptAllowance(value: object): value is PutAttemptAllowance;
+export declare function PutAttemptAllowanceFromJSON(json: any): PutAttemptAllowance;
+export declare function PutAttemptAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutAttemptAllowance;
+export declare function PutAttemptAllowanceToJSON(json: any): PutAttemptAllowance;
+export declare function PutAttemptAllowanceToJSONTyped(value?: PutAttemptAllowance | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutAttemptAllowance.js

@@ -0,0 +1,54 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutAttemptAllowance = instanceOfPutAttemptAllowance;
+exports.PutAttemptAllowanceFromJSON = PutAttemptAllowanceFromJSON;
+exports.PutAttemptAllowanceFromJSONTyped = PutAttemptAllowanceFromJSONTyped;
+exports.PutAttemptAllowanceToJSON = PutAttemptAllowanceToJSON;
+exports.PutAttemptAllowanceToJSONTyped = PutAttemptAllowanceToJSONTyped;
+/**
+ * Check if a given object implements the PutAttemptAllowance interface.
+ */
+function instanceOfPutAttemptAllowance(value) {
+    if (!('additionalAttempts' in value) || value['additionalAttempts'] === undefined)
+        return false;
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function PutAttemptAllowanceFromJSON(json) {
+    return PutAttemptAllowanceFromJSONTyped(json, false);
+}
+function PutAttemptAllowanceFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'additionalAttempts': json['additional_attempts'],
+        'reason': json['reason'],
+    };
+}
+function PutAttemptAllowanceToJSON(json) {
+    return PutAttemptAllowanceToJSONTyped(json, false);
+}
+function PutAttemptAllowanceToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'additional_attempts': value['additionalAttempts'],
+        'reason': value['reason'],
+    };
+}

package/dist/models/PutLibraryQuizSessionOverride.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+/**
+ * Instructor-entered progress values for an existing live quiz session.
+ * @export
+ * @interface PutLibraryQuizSessionOverride
+ */
+export interface PutLibraryQuizSessionOverride {
+    /**
+     *
+     * @type {PutLibraryQuizSessionOverrideStatusEnum}
+     * @memberof PutLibraryQuizSessionOverride
+     */
+    status?: PutLibraryQuizSessionOverrideStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PutLibraryQuizSessionOverride
+     */
+    scorePercentage?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutLibraryQuizSessionOverride
+     */
+    passed?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PutLibraryQuizSessionOverride
+     */
+    reason: string;
+}
+/**
+ * @export
+ */
+export declare const PutLibraryQuizSessionOverrideStatusEnum: {
+    readonly Completed: "completed";
+};
+export type PutLibraryQuizSessionOverrideStatusEnum = typeof PutLibraryQuizSessionOverrideStatusEnum[keyof typeof PutLibraryQuizSessionOverrideStatusEnum];
+/**
+ * Check if a given object implements the PutLibraryQuizSessionOverride interface.
+ */
+export declare function instanceOfPutLibraryQuizSessionOverride(value: object): value is PutLibraryQuizSessionOverride;
+export declare function PutLibraryQuizSessionOverrideFromJSON(json: any): PutLibraryQuizSessionOverride;
+export declare function PutLibraryQuizSessionOverrideFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLibraryQuizSessionOverride;
+export declare function PutLibraryQuizSessionOverrideToJSON(json: any): PutLibraryQuizSessionOverride;
+export declare function PutLibraryQuizSessionOverrideToJSONTyped(value?: PutLibraryQuizSessionOverride | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutLibraryQuizSessionOverride.js

@@ -0,0 +1,63 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutLibraryQuizSessionOverrideStatusEnum = void 0;
+exports.instanceOfPutLibraryQuizSessionOverride = instanceOfPutLibraryQuizSessionOverride;
+exports.PutLibraryQuizSessionOverrideFromJSON = PutLibraryQuizSessionOverrideFromJSON;
+exports.PutLibraryQuizSessionOverrideFromJSONTyped = PutLibraryQuizSessionOverrideFromJSONTyped;
+exports.PutLibraryQuizSessionOverrideToJSON = PutLibraryQuizSessionOverrideToJSON;
+exports.PutLibraryQuizSessionOverrideToJSONTyped = PutLibraryQuizSessionOverrideToJSONTyped;
+/**
+ * @export
+ */
+exports.PutLibraryQuizSessionOverrideStatusEnum = {
+    Completed: 'completed'
+};
+/**
+ * Check if a given object implements the PutLibraryQuizSessionOverride interface.
+ */
+function instanceOfPutLibraryQuizSessionOverride(value) {
+    if (!('reason' in value) || value['reason'] === undefined)
+        return false;
+    return true;
+}
+function PutLibraryQuizSessionOverrideFromJSON(json) {
+    return PutLibraryQuizSessionOverrideFromJSONTyped(json, false);
+}
+function PutLibraryQuizSessionOverrideFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'] == null ? undefined : json['status'],
+        'scorePercentage': json['score_percentage'] == null ? undefined : json['score_percentage'],
+        'passed': json['passed'] == null ? undefined : json['passed'],
+        'reason': json['reason'],
+    };
+}
+function PutLibraryQuizSessionOverrideToJSON(json) {
+    return PutLibraryQuizSessionOverrideToJSONTyped(json, false);
+}
+function PutLibraryQuizSessionOverrideToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'score_percentage': value['scorePercentage'],
+        'passed': value['passed'],
+        'reason': value['reason'],
+    };
+}

package/dist/models/PutResourceSessionOverride.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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.
+ */
+/**
+ * Instructor-entered progress values for an existing live resource session.
+ * @export
+ * @interface PutResourceSessionOverride
+ */
+export interface PutResourceSessionOverride {
+    /**
+     *
+     * @type {PutResourceSessionOverrideCompletionStatusEnum}
+     * @memberof PutResourceSessionOverride
+     */
+    completionStatus?: PutResourceSessionOverrideCompletionStatusEnum;
+    /**
+     *
+     * @type {PutResourceSessionOverrideGradeStatusEnum}
+     * @memberof PutResourceSessionOverride
+     */
+    gradeStatus?: PutResourceSessionOverrideGradeStatusEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof PutResourceSessionOverride
+     */
+    scoreRaw?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PutResourceSessionOverride
+     */
+    reason: string;
+}
+/**
+ * @export
+ */
+export declare const PutResourceSessionOverrideCompletionStatusEnum: {
+    readonly Completed: "completed";
+};
+export type PutResourceSessionOverrideCompletionStatusEnum = typeof PutResourceSessionOverrideCompletionStatusEnum[keyof typeof PutResourceSessionOverrideCompletionStatusEnum];
+/**
+ * @export
+ */
+export declare const PutResourceSessionOverrideGradeStatusEnum: {
+    readonly Ungraded: "ungraded";
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+    readonly PointsEarned: "points_earned";
+    readonly PercentageEarned: "percentage_earned";
+    readonly NotApplicable: "not_applicable";
+};
+export type PutResourceSessionOverrideGradeStatusEnum = typeof PutResourceSessionOverrideGradeStatusEnum[keyof typeof PutResourceSessionOverrideGradeStatusEnum];
+/**
+ * Check if a given object implements the PutResourceSessionOverride interface.
+ */
+export declare function instanceOfPutResourceSessionOverride(value: object): value is PutResourceSessionOverride;
+export declare function PutResourceSessionOverrideFromJSON(json: any): PutResourceSessionOverride;
+export declare function PutResourceSessionOverrideFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutResourceSessionOverride;
+export declare function PutResourceSessionOverrideToJSON(json: any): PutResourceSessionOverride;
+export declare function PutResourceSessionOverrideToJSONTyped(value?: PutResourceSessionOverride | null, ignoreDiscriminator?: boolean): any;