@easyedu/js-lsm-api 1.48.0 → 1.50.0

package/dist/esm/models/EffectiveCertificateConfig.js

@@ -0,0 +1,55 @@
+/* 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 EffectiveCertificateConfig interface.
+ */
+export function instanceOfEffectiveCertificateConfig(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    if (!('requireQuizPass' in value) || value['requireQuizPass'] === undefined)
+        return false;
+    return true;
+}
+export function EffectiveCertificateConfigFromJSON(json) {
+    return EffectiveCertificateConfigFromJSONTyped(json, false);
+}
+export function EffectiveCertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return EffectiveCertificateConfigToJSONTyped(json, false);
+}
+export function EffectiveCertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    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'],
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { CertificateConfig } from './CertificateConfig';
+/**
+ *
+ * @export
+ * @interface GetCertificateConfigList
+ */
+export interface GetCertificateConfigList {
+    /**
+     *
+     * @type {Array<CertificateConfig>}
+     * @memberof GetCertificateConfigList
+     */
+    items: Array<CertificateConfig>;
+}
+/**
+ * Check if a given object implements the GetCertificateConfigList interface.
+ */
+export declare function instanceOfGetCertificateConfigList(value: object): value is GetCertificateConfigList;
+export declare function GetCertificateConfigListFromJSON(json: any): GetCertificateConfigList;
+export declare function GetCertificateConfigListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateConfigList;
+export declare function GetCertificateConfigListToJSON(json: any): GetCertificateConfigList;
+export declare function GetCertificateConfigListToJSONTyped(value?: GetCertificateConfigList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCertificateConfigList.js

@@ -0,0 +1,44 @@
+/* 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 { CertificateConfigFromJSON, CertificateConfigToJSON, } from './CertificateConfig';
+/**
+ * Check if a given object implements the GetCertificateConfigList interface.
+ */
+export function instanceOfGetCertificateConfigList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetCertificateConfigListFromJSON(json) {
+    return GetCertificateConfigListFromJSONTyped(json, false);
+}
+export function GetCertificateConfigListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(CertificateConfigFromJSON)),
+    };
+}
+export function GetCertificateConfigListToJSON(json) {
+    return GetCertificateConfigListToJSONTyped(json, false);
+}
+export function GetCertificateConfigListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(CertificateConfigToJSON)),
+    };
+}

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { Certificate } from './Certificate';
+/**
+ *
+ * @export
+ * @interface GetCertificateList
+ */
+export interface GetCertificateList {
+    /**
+     *
+     * @type {Array<Certificate>}
+     * @memberof GetCertificateList
+     */
+    items: Array<Certificate>;
+}
+/**
+ * Check if a given object implements the GetCertificateList interface.
+ */
+export declare function instanceOfGetCertificateList(value: object): value is GetCertificateList;
+export declare function GetCertificateListFromJSON(json: any): GetCertificateList;
+export declare function GetCertificateListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateList;
+export declare function GetCertificateListToJSON(json: any): GetCertificateList;
+export declare function GetCertificateListToJSONTyped(value?: GetCertificateList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCertificateList.js

@@ -0,0 +1,44 @@
+/* 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 { CertificateFromJSON, CertificateToJSON, } from './Certificate';
+/**
+ * Check if a given object implements the GetCertificateList interface.
+ */
+export function instanceOfGetCertificateList(value) {
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetCertificateListFromJSON(json) {
+    return GetCertificateListFromJSONTyped(json, false);
+}
+export function GetCertificateListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'items': (json['items'].map(CertificateFromJSON)),
+    };
+}
+export function GetCertificateListToJSON(json) {
+    return GetCertificateListToJSONTyped(json, false);
+}
+export function GetCertificateListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'items': (value['items'].map(CertificateToJSON)),
+    };
+}

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

@@ -21,6 +21,30 @@ export interface GetModuleInstructorBasicReportingEngagement {
      * @memberof GetModuleInstructorBasicReportingEngagement
      */
     avgTimeSpentHours: number | null;
+    /**
+     * Percentage of active course-enrolled students who have completed every published content item in this module. Null if there are no active enrolled students.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completionRatePercentage: number | null;
+    /**
+     * Number of active course-enrolled students who have completed every published content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    completedCount: number;
+    /**
+     * Number of active course-enrolled students who have started at least one content item in this module but have not completed all published items.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    inProgressCount: number;
+    /**
+     * Number of active course-enrolled students who have not opened any content item in this module.
+     * @type {number}
+     * @memberof GetModuleInstructorBasicReportingEngagement
+     */
+    notStartedCount: number;
 }
 /**
  * Check if a given object implements the GetModuleInstructorBasicReportingEngagement interface.

package/dist/esm/models/GetModuleInstructorBasicReportingEngagement.js

@@ -17,6 +17,14 @@
 export function instanceOfGetModuleInstructorBasicReportingEngagement(value) {
     if (!('avgTimeSpentHours' in value) || value['avgTimeSpentHours'] === undefined)
         return false;
+    if (!('completionRatePercentage' in value) || value['completionRatePercentage'] === undefined)
+        return false;
+    if (!('completedCount' in value) || value['completedCount'] === undefined)
+        return false;
+    if (!('inProgressCount' in value) || value['inProgressCount'] === undefined)
+        return false;
+    if (!('notStartedCount' in value) || value['notStartedCount'] === undefined)
+        return false;
     return true;
 }
 export function GetModuleInstructorBasicReportingEngagementFromJSON(json) {
@@ -28,6 +36,10 @@ export function GetModuleInstructorBasicReportingEngagementFromJSONTyped(json, i
     }
     return {
         'avgTimeSpentHours': json['avg_time_spent_hours'],
+        'completionRatePercentage': json['completion_rate_percentage'],
+        'completedCount': json['completed_count'],
+        'inProgressCount': json['in_progress_count'],
+        'notStartedCount': json['not_started_count'],
     };
 }
 export function GetModuleInstructorBasicReportingEngagementToJSON(json) {
@@ -39,5 +51,9 @@ export function GetModuleInstructorBasicReportingEngagementToJSONTyped(value, ig
     }
     return {
         'avg_time_spent_hours': value['avgTimeSpentHours'],
+        'completion_rate_percentage': value['completionRatePercentage'],
+        'completed_count': value['completedCount'],
+        'in_progress_count': value['inProgressCount'],
+        'not_started_count': value['notStartedCount'],
     };
 }

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

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * Manually issue a certificate
+ * @export
+ * @interface PostCertificate
+ */
+export interface PostCertificate {
+    /**
+     * External ID of the recipient
+     * @type {string}
+     * @memberof PostCertificate
+     */
+    userId: string;
+    /**
+     * Unix epoch timestamp; null = never expires
+     * @type {number}
+     * @memberof PostCertificate
+     */
+    expiresAt?: number | null;
+    /**
+     * Optional override for backfilled historical data
+     * @type {number}
+     * @memberof PostCertificate
+     */
+    issuedAt?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCertificate
+     */
+    note?: string | null;
+}
+/**
+ * Check if a given object implements the PostCertificate interface.
+ */
+export declare function instanceOfPostCertificate(value: object): value is PostCertificate;
+export declare function PostCertificateFromJSON(json: any): PostCertificate;
+export declare function PostCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificate;
+export declare function PostCertificateToJSON(json: any): PostCertificate;
+export declare function PostCertificateToJSONTyped(value?: PostCertificate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCertificate.js

@@ -0,0 +1,49 @@
+/* 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 PostCertificate interface.
+ */
+export function instanceOfPostCertificate(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    return true;
+}
+export function PostCertificateFromJSON(json) {
+    return PostCertificateFromJSONTyped(json, false);
+}
+export function PostCertificateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
+        'issuedAt': json['issued_at'] == null ? undefined : json['issued_at'],
+        'note': json['note'] == null ? undefined : json['note'],
+    };
+}
+export function PostCertificateToJSON(json) {
+    return PostCertificateToJSONTyped(json, false);
+}
+export function PostCertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'expires_at': value['expiresAt'],
+        'issued_at': value['issuedAt'],
+        'note': value['note'],
+    };
+}

package/dist/esm/models/PostCertificateConfig.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.
+ */
+/**
+ *
+ * @export
+ * @interface PostCertificateConfig
+ */
+export interface PostCertificateConfig {
+    /**
+     * Omit or null for the portal default config
+     * @type {string}
+     * @memberof PostCertificateConfig
+     */
+    courseId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostCertificateConfig
+     */
+    enabled: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PostCertificateConfig
+     */
+    requireQuizPass?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PostCertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PostCertificateConfig
+     */
+    quizConfigId?: string | null;
+}
+/**
+ * Check if a given object implements the PostCertificateConfig interface.
+ */
+export declare function instanceOfPostCertificateConfig(value: object): value is PostCertificateConfig;
+export declare function PostCertificateConfigFromJSON(json: any): PostCertificateConfig;
+export declare function PostCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostCertificateConfig;
+export declare function PostCertificateConfigToJSON(json: any): PostCertificateConfig;
+export declare function PostCertificateConfigToJSONTyped(value?: PostCertificateConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostCertificateConfig.js

@@ -0,0 +1,53 @@
+/* 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 PostCertificateConfig interface.
+ */
+export function instanceOfPostCertificateConfig(value) {
+    if (!('enabled' in value) || value['enabled'] === undefined)
+        return false;
+    return true;
+}
+export function PostCertificateConfigFromJSON(json) {
+    return PostCertificateConfigFromJSONTyped(json, false);
+}
+export function PostCertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        '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'],
+    };
+}
+export function PostCertificateConfigToJSON(json) {
+    return PostCertificateConfigToJSONTyped(json, false);
+}
+export function PostCertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        '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'],
+    };
+}

package/dist/esm/models/PostRevokeCertificate.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 PostRevokeCertificate
+ */
+export interface PostRevokeCertificate {
+    /**
+     *
+     * @type {string}
+     * @memberof PostRevokeCertificate
+     */
+    reason?: string | null;
+}
+/**
+ * Check if a given object implements the PostRevokeCertificate interface.
+ */
+export declare function instanceOfPostRevokeCertificate(value: object): value is PostRevokeCertificate;
+export declare function PostRevokeCertificateFromJSON(json: any): PostRevokeCertificate;
+export declare function PostRevokeCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostRevokeCertificate;
+export declare function PostRevokeCertificateToJSON(json: any): PostRevokeCertificate;
+export declare function PostRevokeCertificateToJSONTyped(value?: PostRevokeCertificate | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostRevokeCertificate.js

@@ -0,0 +1,41 @@
+/* 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 PostRevokeCertificate interface.
+ */
+export function instanceOfPostRevokeCertificate(value) {
+    return true;
+}
+export function PostRevokeCertificateFromJSON(json) {
+    return PostRevokeCertificateFromJSONTyped(json, false);
+}
+export function PostRevokeCertificateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+export function PostRevokeCertificateToJSON(json) {
+    return PostRevokeCertificateToJSONTyped(json, false);
+}
+export function PostRevokeCertificateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'reason': value['reason'],
+    };
+}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 PutCertificateConfig
+ */
+export interface PutCertificateConfig {
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutCertificateConfig
+     */
+    enabled?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCertificateConfig
+     */
+    expiryMonths?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutCertificateConfig
+     */
+    requireQuizPass?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof PutCertificateConfig
+     */
+    minQuizScore?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PutCertificateConfig
+     */
+    quizConfigId?: string | null;
+}
+/**
+ * Check if a given object implements the PutCertificateConfig interface.
+ */
+export declare function instanceOfPutCertificateConfig(value: object): value is PutCertificateConfig;
+export declare function PutCertificateConfigFromJSON(json: any): PutCertificateConfig;
+export declare function PutCertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutCertificateConfig;
+export declare function PutCertificateConfigToJSON(json: any): PutCertificateConfig;
+export declare function PutCertificateConfigToJSONTyped(value?: PutCertificateConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PutCertificateConfig.js

@@ -0,0 +1,49 @@
+/* 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 PutCertificateConfig interface.
+ */
+export function instanceOfPutCertificateConfig(value) {
+    return true;
+}
+export function PutCertificateConfigFromJSON(json) {
+    return PutCertificateConfigFromJSONTyped(json, false);
+}
+export function PutCertificateConfigFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'enabled': json['enabled'] == null ? undefined : 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'],
+    };
+}
+export function PutCertificateConfigToJSON(json) {
+    return PutCertificateConfigToJSONTyped(json, false);
+}
+export function PutCertificateConfigToJSONTyped(value, ignoreDiscriminator = false) {
+    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'],
+    };
+}