@easyedu/js-lsm-api 1.49.0 → 1.50.0

package/src/apis/index.ts

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './CertificateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './CourseApi';

package/src/models/Certificate.ts

@@ -0,0 +1,234 @@
+/* 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 Certificate
+ */
+export interface Certificate {
+    /**
+     * External ID (UUID) of the certificate
+     * @type {string}
+     * @memberof Certificate
+     */
+    id: string;
+    /**
+     * External ID of the portal
+     * @type {string}
+     * @memberof Certificate
+     */
+    portalId: string;
+    /**
+     * External ID of the recipient user
+     * @type {string}
+     * @memberof Certificate
+     */
+    userId: string;
+    /**
+     * External ID of the course
+     * @type {string}
+     * @memberof Certificate
+     */
+    courseId: string;
+    /**
+     * External ID of the enrollment, null for manual issuance
+     * @type {string}
+     * @memberof Certificate
+     */
+    enrollmentId?: string | null;
+    /**
+     * Unix epoch timestamp
+     * @type {number}
+     * @memberof Certificate
+     */
+    issuedAt: number;
+    /**
+     * Unix epoch timestamp, null = never expires
+     * @type {number}
+     * @memberof Certificate
+     */
+    expiresAt?: number | null;
+    /**
+     * External ID of the user who manually issued (null for auto)
+     * @type {string}
+     * @memberof Certificate
+     */
+    issuedByUserId?: string | null;
+    /**
+     * 
+     * @type {CertificateIssuanceReasonEnum}
+     * @memberof Certificate
+     */
+    issuanceReason: CertificateIssuanceReasonEnum;
+    /**
+     * 
+     * @type {CertificateStatusEnum}
+     * @memberof Certificate
+     */
+    status: CertificateStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof Certificate
+     */
+    revokedAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    revokedByUserId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    revocationReason?: string | null;
+    /**
+     * Snapshotted learner name as of issue time
+     * @type {string}
+     * @memberof Certificate
+     */
+    learnerName: string;
+    /**
+     * Snapshotted course name as of issue time
+     * @type {string}
+     * @memberof Certificate
+     */
+    courseName: string;
+    /**
+     * Snapshotted portal name as of issue time
+     * @type {string}
+     * @memberof Certificate
+     */
+    portalName: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Certificate
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof Certificate
+     */
+    updatedAt: number;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+} as const;
+export type CertificateIssuanceReasonEnum = typeof CertificateIssuanceReasonEnum[keyof typeof CertificateIssuanceReasonEnum];
+
+/**
+ * @export
+ */
+export const CertificateStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked'
+} as const;
+export type CertificateStatusEnum = typeof CertificateStatusEnum[keyof typeof CertificateStatusEnum];
+
+
+/**
+ * Check if a given object implements the Certificate interface.
+ */
+export function instanceOfCertificate(value: object): value is Certificate {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('portalId' in value) || value['portalId'] === undefined) return false;
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('courseId' in value) || value['courseId'] === undefined) return false;
+    if (!('issuedAt' in value) || value['issuedAt'] === undefined) return false;
+    if (!('issuanceReason' in value) || value['issuanceReason'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('learnerName' in value) || value['learnerName'] === undefined) return false;
+    if (!('courseName' in value) || value['courseName'] === undefined) return false;
+    if (!('portalName' in value) || value['portalName'] === 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 CertificateFromJSON(json: any): Certificate {
+    return CertificateFromJSONTyped(json, false);
+}
+
+export function CertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): Certificate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'portalId': json['portal_id'],
+        'userId': json['user_id'],
+        'courseId': json['course_id'],
+        'enrollmentId': json['enrollment_id'] == null ? undefined : json['enrollment_id'],
+        'issuedAt': json['issued_at'],
+        'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
+        'issuedByUserId': json['issued_by_user_id'] == null ? undefined : json['issued_by_user_id'],
+        'issuanceReason': json['issuance_reason'],
+        'status': json['status'],
+        'revokedAt': json['revoked_at'] == null ? undefined : json['revoked_at'],
+        'revokedByUserId': json['revoked_by_user_id'] == null ? undefined : json['revoked_by_user_id'],
+        'revocationReason': json['revocation_reason'] == null ? undefined : json['revocation_reason'],
+        'learnerName': json['learner_name'],
+        'courseName': json['course_name'],
+        'portalName': json['portal_name'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function CertificateToJSON(json: any): Certificate {
+    return CertificateToJSONTyped(json, false);
+}
+
+export function CertificateToJSONTyped(value?: Certificate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'portal_id': value['portalId'],
+        'user_id': value['userId'],
+        'course_id': value['courseId'],
+        'enrollment_id': value['enrollmentId'],
+        'issued_at': value['issuedAt'],
+        'expires_at': value['expiresAt'],
+        'issued_by_user_id': value['issuedByUserId'],
+        'issuance_reason': value['issuanceReason'],
+        'status': value['status'],
+        'revoked_at': value['revokedAt'],
+        'revoked_by_user_id': value['revokedByUserId'],
+        'revocation_reason': value['revocationReason'],
+        'learner_name': value['learnerName'],
+        'course_name': value['courseName'],
+        'portal_name': value['portalName'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/CertificateConfig.ts

@@ -0,0 +1,142 @@
+/* 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 CertificateConfig
+ */
+export interface CertificateConfig {
+    /**
+     * External ID (UUID) of the config
+     * @type {string}
+     * @memberof CertificateConfig
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateConfig
+     */
+    portalId: string;
+    /**
+     * null = portal default, set = course override
+     * @type {string}
+     * @memberof CertificateConfig
+     */
+    courseId?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CertificateConfig
+     */
+    enabled: boolean;
+    /**
+     * Months from issue date until expiry, null = never expires
+     * @type {number}
+     * @memberof CertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     * At course scope, null inherits the portal default
+     * @type {boolean}
+     * @memberof CertificateConfig
+     */
+    requireQuizPass?: boolean | null;
+    /**
+     * 0-100, only used when require_quiz_pass is true
+     * @type {number}
+     * @memberof CertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     * External ID of the gating quiz config
+     * @type {string}
+     * @memberof CertificateConfig
+     */
+    quizConfigId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateConfig
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateConfig
+     */
+    updatedAt: number;
+}
+
+/**
+ * Check if a given object implements the CertificateConfig interface.
+ */
+export function instanceOfCertificateConfig(value: object): value is CertificateConfig {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('portalId' in value) || value['portalId'] === undefined) return false;
+    if (!('enabled' in value) || value['enabled'] === 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 CertificateConfigFromJSON(json: any): CertificateConfig {
+    return CertificateConfigFromJSONTyped(json, false);
+}
+
+export function CertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'portalId': json['portal_id'],
+        'courseId': json['course_id'] == null ? undefined : json['course_id'],
+        'enabled': json['enabled'],
+        'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
+        'requireQuizPass': json['require_quiz_pass'] == null ? undefined : json['require_quiz_pass'],
+        'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
+        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function CertificateConfigToJSON(json: any): CertificateConfig {
+    return CertificateConfigToJSONTyped(json, false);
+}
+
+export function CertificateConfigToJSONTyped(value?: CertificateConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'portal_id': value['portalId'],
+        'course_id': value['courseId'],
+        'enabled': value['enabled'],
+        'expiry_months': value['expiryMonths'],
+        'require_quiz_pass': value['requireQuizPass'],
+        'min_quiz_score': value['minQuizScore'],
+        'quiz_config_id': value['quizConfigId'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/CertificatePublic.ts

@@ -0,0 +1,158 @@
+/* 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';
+/**
+ * Public certificate verification view (no internal IDs)
+ * @export
+ * @interface CertificatePublic
+ */
+export interface CertificatePublic {
+    /**
+     * External ID (UUID) of the certificate
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    id: string;
+    /**
+     * 
+     * @type {CertificatePublicStatusEnum}
+     * @memberof CertificatePublic
+     */
+    status: CertificatePublicStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    learnerName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    courseName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    portalName: string;
+    /**
+     * 
+     * @type {CertificatePublicIssuanceReasonEnum}
+     * @memberof CertificatePublic
+     */
+    issuanceReason: CertificatePublicIssuanceReasonEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificatePublic
+     */
+    issuedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificatePublic
+     */
+    expiresAt?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificatePublic
+     */
+    revokedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const CertificatePublicStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked',
+    Expired: 'expired'
+} as const;
+export type CertificatePublicStatusEnum = typeof CertificatePublicStatusEnum[keyof typeof CertificatePublicStatusEnum];
+
+/**
+ * @export
+ */
+export const CertificatePublicIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+} as const;
+export type CertificatePublicIssuanceReasonEnum = typeof CertificatePublicIssuanceReasonEnum[keyof typeof CertificatePublicIssuanceReasonEnum];
+
+
+/**
+ * Check if a given object implements the CertificatePublic interface.
+ */
+export function instanceOfCertificatePublic(value: object): value is CertificatePublic {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('learnerName' in value) || value['learnerName'] === undefined) return false;
+    if (!('courseName' in value) || value['courseName'] === undefined) return false;
+    if (!('portalName' in value) || value['portalName'] === undefined) return false;
+    if (!('issuanceReason' in value) || value['issuanceReason'] === undefined) return false;
+    if (!('issuedAt' in value) || value['issuedAt'] === undefined) return false;
+    return true;
+}
+
+export function CertificatePublicFromJSON(json: any): CertificatePublic {
+    return CertificatePublicFromJSONTyped(json, false);
+}
+
+export function CertificatePublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificatePublic {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'learnerName': json['learner_name'],
+        'courseName': json['course_name'],
+        'portalName': json['portal_name'],
+        'issuanceReason': json['issuance_reason'],
+        'issuedAt': json['issued_at'],
+        'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
+        'revokedAt': json['revoked_at'] == null ? undefined : json['revoked_at'],
+    };
+}
+
+export function CertificatePublicToJSON(json: any): CertificatePublic {
+    return CertificatePublicToJSONTyped(json, false);
+}
+
+export function CertificatePublicToJSONTyped(value?: CertificatePublic | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'learner_name': value['learnerName'],
+        'course_name': value['courseName'],
+        'portal_name': value['portalName'],
+        'issuance_reason': value['issuanceReason'],
+        'issued_at': value['issuedAt'],
+        'expires_at': value['expiresAt'],
+        'revoked_at': value['revokedAt'],
+    };
+}
+

package/src/models/EffectiveCertificateConfig.ts

@@ -0,0 +1,107 @@
+/* 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';
+/**
+ * Resolved effective config for a course (course override merged with portal default)
+ * @export
+ * @interface EffectiveCertificateConfig
+ */
+export interface EffectiveCertificateConfig {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EffectiveCertificateConfig
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof EffectiveCertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof EffectiveCertificateConfig
+     */
+    requireQuizPass: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof EffectiveCertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EffectiveCertificateConfig
+     */
+    quizConfigId?: string | null;
+    /**
+     * External ID of the config that resolved this (course override or portal default)
+     * @type {string}
+     * @memberof EffectiveCertificateConfig
+     */
+    sourceConfigId?: string | null;
+}
+
+/**
+ * Check if a given object implements the EffectiveCertificateConfig interface.
+ */
+export function instanceOfEffectiveCertificateConfig(value: object): value is EffectiveCertificateConfig {
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('requireQuizPass' in value) || value['requireQuizPass'] === undefined) return false;
+    return true;
+}
+
+export function EffectiveCertificateConfigFromJSON(json: any): EffectiveCertificateConfig {
+    return EffectiveCertificateConfigFromJSONTyped(json, false);
+}
+
+export function EffectiveCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): EffectiveCertificateConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'],
+        'expiryMonths': json['expiry_months'] == null ? undefined : json['expiry_months'],
+        'requireQuizPass': json['require_quiz_pass'],
+        'minQuizScore': json['min_quiz_score'] == null ? undefined : json['min_quiz_score'],
+        'quizConfigId': json['quiz_config_id'] == null ? undefined : json['quiz_config_id'],
+        'sourceConfigId': json['source_config_id'] == null ? undefined : json['source_config_id'],
+    };
+}
+
+export function EffectiveCertificateConfigToJSON(json: any): EffectiveCertificateConfig {
+    return EffectiveCertificateConfigToJSONTyped(json, false);
+}
+
+export function EffectiveCertificateConfigToJSONTyped(value?: EffectiveCertificateConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'expiry_months': value['expiryMonths'],
+        'require_quiz_pass': value['requireQuizPass'],
+        'min_quiz_score': value['minQuizScore'],
+        'quiz_config_id': value['quizConfigId'],
+        'source_config_id': value['sourceConfigId'],
+    };
+}
+