@easyedu/js-lsm-api 1.48.0 → 1.50.0

package/dist/esm/models/Certificate.d.ts

@@ -0,0 +1,151 @@
+/**
+ * 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 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 declare const CertificateIssuanceReasonEnum: {
+    readonly CourseCompletion: "course_completion";
+    readonly QuizPassed: "quiz_passed";
+    readonly Manual: "manual";
+};
+export type CertificateIssuanceReasonEnum = typeof CertificateIssuanceReasonEnum[keyof typeof CertificateIssuanceReasonEnum];
+/**
+ * @export
+ */
+export declare const CertificateStatusEnum: {
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+};
+export type CertificateStatusEnum = typeof CertificateStatusEnum[keyof typeof CertificateStatusEnum];
+/**
+ * Check if a given object implements the Certificate interface.
+ */
+export declare function instanceOfCertificate(value: object): value is Certificate;
+export declare function CertificateFromJSON(json: any): Certificate;
+export declare function CertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): Certificate;
+export declare function CertificateToJSON(json: any): Certificate;
+export declare function CertificateToJSONTyped(value?: Certificate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Certificate.js

@@ -0,0 +1,114 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CertificateIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+};
+/**
+ * @export
+ */
+export const CertificateStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked'
+};
+/**
+ * Check if a given object implements the Certificate interface.
+ */
+export function instanceOfCertificate(value) {
+    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) {
+    return CertificateFromJSONTyped(json, false);
+}
+export function CertificateFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return CertificateToJSONTyped(json, false);
+}
+export function CertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/CertificateConfig.d.ts

@@ -0,0 +1,86 @@
+/**
+ * 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 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 declare function instanceOfCertificateConfig(value: object): value is CertificateConfig;
+export declare function CertificateConfigFromJSON(json: any): CertificateConfig;
+export declare function CertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateConfig;
+export declare function CertificateConfigToJSON(json: any): CertificateConfig;
+export declare function CertificateConfigToJSONTyped(value?: CertificateConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CertificateConfig.js

@@ -0,0 +1,69 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the CertificateConfig interface.
+ */
+export function instanceOfCertificateConfig(value) {
+    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) {
+    return CertificateConfigFromJSONTyped(json, false);
+}
+export function CertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return CertificateConfigToJSONTyped(json, false);
+}
+export function CertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/CertificatePublic.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const CertificatePublicStatusEnum: {
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+    readonly Expired: "expired";
+};
+export type CertificatePublicStatusEnum = typeof CertificatePublicStatusEnum[keyof typeof CertificatePublicStatusEnum];
+/**
+ * @export
+ */
+export declare const CertificatePublicIssuanceReasonEnum: {
+    readonly CourseCompletion: "course_completion";
+    readonly QuizPassed: "quiz_passed";
+    readonly Manual: "manual";
+};
+export type CertificatePublicIssuanceReasonEnum = typeof CertificatePublicIssuanceReasonEnum[keyof typeof CertificatePublicIssuanceReasonEnum];
+/**
+ * Check if a given object implements the CertificatePublic interface.
+ */
+export declare function instanceOfCertificatePublic(value: object): value is CertificatePublic;
+export declare function CertificatePublicFromJSON(json: any): CertificatePublic;
+export declare function CertificatePublicFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificatePublic;
+export declare function CertificatePublicToJSON(json: any): CertificatePublic;
+export declare function CertificatePublicToJSONTyped(value?: CertificatePublic | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/CertificatePublic.js

@@ -0,0 +1,87 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const CertificatePublicStatusEnum = {
+    Active: 'active',
+    Revoked: 'revoked',
+    Expired: 'expired'
+};
+/**
+ * @export
+ */
+export const CertificatePublicIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+};
+/**
+ * Check if a given object implements the CertificatePublic interface.
+ */
+export function instanceOfCertificatePublic(value) {
+    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) {
+    return CertificatePublicFromJSONTyped(json, false);
+}
+export function CertificatePublicFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return CertificatePublicToJSONTyped(json, false);
+}
+export function CertificatePublicToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/EffectiveCertificateConfig.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare function instanceOfEffectiveCertificateConfig(value: object): value is EffectiveCertificateConfig;
+export declare function EffectiveCertificateConfigFromJSON(json: any): EffectiveCertificateConfig;
+export declare function EffectiveCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): EffectiveCertificateConfig;
+export declare function EffectiveCertificateConfigToJSON(json: any): EffectiveCertificateConfig;
+export declare function EffectiveCertificateConfigToJSONTyped(value?: EffectiveCertificateConfig | null, ignoreDiscriminator?: boolean): any;