@easyedu/js-lsm-api 1.99.0 → 1.100.0

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/PostClearSessions.ts

@@ -0,0 +1,66 @@
+/* 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 PostClearSessions
+ */
+export interface PostClearSessions {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostClearSessions
+     */
+    reason: string;
+}
+
+/**
+ * Check if a given object implements the PostClearSessions interface.
+ */
+export function instanceOfPostClearSessions(value: object): value is PostClearSessions {
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function PostClearSessionsFromJSON(json: any): PostClearSessions {
+    return PostClearSessionsFromJSONTyped(json, false);
+}
+
+export function PostClearSessionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostClearSessions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'reason': json['reason'],
+    };
+}
+
+export function PostClearSessionsToJSON(json: any): PostClearSessions {
+    return PostClearSessionsToJSONTyped(json, false);
+}
+
+export function PostClearSessionsToJSONTyped(value?: PostClearSessions | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'reason': value['reason'],
+    };
+}
+

package/src/models/PostClearSessionsResponse.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';
+/**
+ * 
+ * @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 function instanceOfPostClearSessionsResponse(value: object): value is PostClearSessionsResponse {
+    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;
+}
+
+export function PostClearSessionsResponseFromJSON(json: any): PostClearSessionsResponse {
+    return PostClearSessionsResponseFromJSONTyped(json, false);
+}
+
+export function PostClearSessionsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostClearSessionsResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'resourceSessionsDeleted': json['resource_sessions_deleted'],
+        'quizSessionsDeleted': json['quiz_sessions_deleted'],
+        'totalSessionsDeleted': json['total_sessions_deleted'],
+    };
+}
+
+export function PostClearSessionsResponseToJSON(json: any): PostClearSessionsResponse {
+    return PostClearSessionsResponseToJSONTyped(json, false);
+}
+
+export function PostClearSessionsResponseToJSONTyped(value?: PostClearSessionsResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'resource_sessions_deleted': value['resourceSessionsDeleted'],
+        'quiz_sessions_deleted': value['quizSessionsDeleted'],
+        'total_sessions_deleted': value['totalSessionsDeleted'],
+    };
+}
+

package/src/models/PutAttemptAllowance.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';
+/**
+ * 
+ * @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 function instanceOfPutAttemptAllowance(value: object): value is PutAttemptAllowance {
+    if (!('additionalAttempts' in value) || value['additionalAttempts'] === undefined) return false;
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function PutAttemptAllowanceFromJSON(json: any): PutAttemptAllowance {
+    return PutAttemptAllowanceFromJSONTyped(json, false);
+}
+
+export function PutAttemptAllowanceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutAttemptAllowance {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'additionalAttempts': json['additional_attempts'],
+        'reason': json['reason'],
+    };
+}
+
+export function PutAttemptAllowanceToJSON(json: any): PutAttemptAllowance {
+    return PutAttemptAllowanceToJSONTyped(json, false);
+}
+
+export function PutAttemptAllowanceToJSONTyped(value?: PutAttemptAllowance | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'additional_attempts': value['additionalAttempts'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/PutLibraryQuizSessionOverride.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * 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 const PutLibraryQuizSessionOverrideStatusEnum = {
+    Completed: 'completed'
+} as const;
+export type PutLibraryQuizSessionOverrideStatusEnum = typeof PutLibraryQuizSessionOverrideStatusEnum[keyof typeof PutLibraryQuizSessionOverrideStatusEnum];
+
+
+/**
+ * Check if a given object implements the PutLibraryQuizSessionOverride interface.
+ */
+export function instanceOfPutLibraryQuizSessionOverride(value: object): value is PutLibraryQuizSessionOverride {
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function PutLibraryQuizSessionOverrideFromJSON(json: any): PutLibraryQuizSessionOverride {
+    return PutLibraryQuizSessionOverrideFromJSONTyped(json, false);
+}
+
+export function PutLibraryQuizSessionOverrideFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutLibraryQuizSessionOverride {
+    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'],
+    };
+}
+
+export function PutLibraryQuizSessionOverrideToJSON(json: any): PutLibraryQuizSessionOverride {
+    return PutLibraryQuizSessionOverrideToJSONTyped(json, false);
+}
+
+export function PutLibraryQuizSessionOverrideToJSONTyped(value?: PutLibraryQuizSessionOverride | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'score_percentage': value['scorePercentage'],
+        'passed': value['passed'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/PutResourceSessionOverride.ts

@@ -0,0 +1,113 @@
+/* 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';
+/**
+ * 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 const PutResourceSessionOverrideCompletionStatusEnum = {
+    Completed: 'completed'
+} as const;
+export type PutResourceSessionOverrideCompletionStatusEnum = typeof PutResourceSessionOverrideCompletionStatusEnum[keyof typeof PutResourceSessionOverrideCompletionStatusEnum];
+
+/**
+ * @export
+ */
+export const PutResourceSessionOverrideGradeStatusEnum = {
+    Ungraded: 'ungraded',
+    Passed: 'passed',
+    Failed: 'failed',
+    PointsEarned: 'points_earned',
+    PercentageEarned: 'percentage_earned',
+    NotApplicable: 'not_applicable'
+} as const;
+export type PutResourceSessionOverrideGradeStatusEnum = typeof PutResourceSessionOverrideGradeStatusEnum[keyof typeof PutResourceSessionOverrideGradeStatusEnum];
+
+
+/**
+ * Check if a given object implements the PutResourceSessionOverride interface.
+ */
+export function instanceOfPutResourceSessionOverride(value: object): value is PutResourceSessionOverride {
+    if (!('reason' in value) || value['reason'] === undefined) return false;
+    return true;
+}
+
+export function PutResourceSessionOverrideFromJSON(json: any): PutResourceSessionOverride {
+    return PutResourceSessionOverrideFromJSONTyped(json, false);
+}
+
+export function PutResourceSessionOverrideFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutResourceSessionOverride {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'completionStatus': json['completion_status'] == null ? undefined : json['completion_status'],
+        'gradeStatus': json['grade_status'] == null ? undefined : json['grade_status'],
+        'scoreRaw': json['score_raw'] == null ? undefined : json['score_raw'],
+        'reason': json['reason'],
+    };
+}
+
+export function PutResourceSessionOverrideToJSON(json: any): PutResourceSessionOverride {
+    return PutResourceSessionOverrideToJSONTyped(json, false);
+}
+
+export function PutResourceSessionOverrideToJSONTyped(value?: PutResourceSessionOverride | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'completion_status': value['completionStatus'],
+        'grade_status': value['gradeStatus'],
+        'score_raw': value['scoreRaw'],
+        'reason': value['reason'],
+    };
+}
+

package/src/models/index.ts

@@ -31,6 +31,7 @@ export * from './EmailTemplateDefinition';
 export * from './EmailTemplateScope';
 export * from './EmailTemplateVariable';
 export * from './EmailTemplateVersion';
+export * from './GetAttemptAllowance';
 export * from './GetCertificateAssetUpload';
 export * from './GetCertificateConfigList';
 export * from './GetCertificateEventList';
@@ -155,6 +156,8 @@ export * from './PostCertificateLifecycleAction';
 export * from './PostCertificateTemplate';
 export * from './PostCertificateTemplateClone';
 export * from './PostCertificateTemplatePreview';
+export * from './PostClearSessions';
+export * from './PostClearSessionsResponse';
 export * from './PostConversation';
 export * from './PostConversationResponse';
 export * from './PostCourse';
@@ -204,6 +207,7 @@ export * from './PostSignupRequest';
 export * from './PostSignupRequestResponse';
 export * from './PostSupportTicket';
 export * from './PostSupportTicketComment';
+export * from './PutAttemptAllowance';
 export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
 export * from './PutCertificateTemplate';
@@ -220,6 +224,7 @@ export * from './PutLibraryQuizCriteria';
 export * from './PutLibraryQuizQuestions';
 export * from './PutLibraryQuizSessionAnswer';
 export * from './PutLibraryQuizSessionGrade';
+export * from './PutLibraryQuizSessionOverride';
 export * from './PutLibraryQuizVersion';
 export * from './PutPortalBranding';
 export * from './PutPortalSublicense';
@@ -227,6 +232,7 @@ export * from './PutPortalUserFieldValues';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';
 export * from './PutResource';
+export * from './PutResourceSessionOverride';
 export * from './PutResourceVersion';
 export * from './PutRole';
 export * from './PutRolePermissions';