@easyedu/js-lsm-api 1.86.0 → 1.88.0

package/dist/models/CertificateNotificationPolicy.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 CertificateNotificationPolicy
+ */
+export interface CertificateNotificationPolicy {
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateNotificationPolicy
+     */
+    issuedEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateNotificationPolicy
+     */
+    renewedEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateNotificationPolicy
+     */
+    expiringEnabled: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateNotificationPolicy
+     */
+    expiredEnabled: boolean;
+    /**
+     *
+     * @type {Array<CertificateNotificationPolicyRecipientsEnum>}
+     * @memberof CertificateNotificationPolicy
+     */
+    recipients: Array<CertificateNotificationPolicyRecipientsEnum>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CertificateNotificationPolicy
+     */
+    portalRecipients: Array<string>;
+    /**
+     *
+     * @type {Set<number>}
+     * @memberof CertificateNotificationPolicy
+     */
+    reminderOffsetsDays: Set<number>;
+}
+/**
+ * @export
+ */
+export declare const CertificateNotificationPolicyRecipientsEnum: {
+    readonly Learner: "learner";
+    readonly Portal: "portal";
+};
+export type CertificateNotificationPolicyRecipientsEnum = typeof CertificateNotificationPolicyRecipientsEnum[keyof typeof CertificateNotificationPolicyRecipientsEnum];
+/**
+ * Check if a given object implements the CertificateNotificationPolicy interface.
+ */
+export declare function instanceOfCertificateNotificationPolicy(value: object): value is CertificateNotificationPolicy;
+export declare function CertificateNotificationPolicyFromJSON(json: any): CertificateNotificationPolicy;
+export declare function CertificateNotificationPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateNotificationPolicy;
+export declare function CertificateNotificationPolicyToJSON(json: any): CertificateNotificationPolicy;
+export declare function CertificateNotificationPolicyToJSONTyped(value?: CertificateNotificationPolicy | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CertificateNotificationPolicy.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.CertificateNotificationPolicyRecipientsEnum = void 0;
+exports.instanceOfCertificateNotificationPolicy = instanceOfCertificateNotificationPolicy;
+exports.CertificateNotificationPolicyFromJSON = CertificateNotificationPolicyFromJSON;
+exports.CertificateNotificationPolicyFromJSONTyped = CertificateNotificationPolicyFromJSONTyped;
+exports.CertificateNotificationPolicyToJSON = CertificateNotificationPolicyToJSON;
+exports.CertificateNotificationPolicyToJSONTyped = CertificateNotificationPolicyToJSONTyped;
+/**
+ * @export
+ */
+exports.CertificateNotificationPolicyRecipientsEnum = {
+    Learner: 'learner',
+    Portal: 'portal'
+};
+/**
+ * Check if a given object implements the CertificateNotificationPolicy interface.
+ */
+function instanceOfCertificateNotificationPolicy(value) {
+    if (!('issuedEnabled' in value) || value['issuedEnabled'] === undefined)
+        return false;
+    if (!('renewedEnabled' in value) || value['renewedEnabled'] === undefined)
+        return false;
+    if (!('expiringEnabled' in value) || value['expiringEnabled'] === undefined)
+        return false;
+    if (!('expiredEnabled' in value) || value['expiredEnabled'] === undefined)
+        return false;
+    if (!('recipients' in value) || value['recipients'] === undefined)
+        return false;
+    if (!('portalRecipients' in value) || value['portalRecipients'] === undefined)
+        return false;
+    if (!('reminderOffsetsDays' in value) || value['reminderOffsetsDays'] === undefined)
+        return false;
+    return true;
+}
+function CertificateNotificationPolicyFromJSON(json) {
+    return CertificateNotificationPolicyFromJSONTyped(json, false);
+}
+function CertificateNotificationPolicyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'issuedEnabled': json['issued_enabled'],
+        'renewedEnabled': json['renewed_enabled'],
+        'expiringEnabled': json['expiring_enabled'],
+        'expiredEnabled': json['expired_enabled'],
+        'recipients': json['recipients'],
+        'portalRecipients': json['portal_recipients'],
+        'reminderOffsetsDays': new Set(json['reminder_offsets_days']),
+    };
+}
+function CertificateNotificationPolicyToJSON(json) {
+    return CertificateNotificationPolicyToJSONTyped(json, false);
+}
+function CertificateNotificationPolicyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'issued_enabled': value['issuedEnabled'],
+        'renewed_enabled': value['renewedEnabled'],
+        'expiring_enabled': value['expiringEnabled'],
+        'expired_enabled': value['expiredEnabled'],
+        'recipients': value['recipients'],
+        'portal_recipients': value['portalRecipients'],
+        'reminder_offsets_days': Array.from(value['reminderOffsetsDays']),
+    };
+}

package/dist/models/CertificatePublic.d.ts

@@ -51,6 +51,30 @@ export interface CertificatePublic {
      * @memberof CertificatePublic
      */
     issuanceReason: CertificatePublicIssuanceReasonEnum;
+    /**
+     *
+     * @type {CertificatePublicIssuanceTypeEnum}
+     * @memberof CertificatePublic
+     */
+    issuanceType: CertificatePublicIssuanceTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    supersededByCertificateId?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificatePublic
+     */
+    pdfAvailable: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CertificatePublic
+     */
+    badgeCredentialId?: string | null;
     /**
      *
      * @type {number}
@@ -76,6 +100,7 @@ export interface CertificatePublic {
 export declare const CertificatePublicStatusEnum: {
     readonly Active: "active";
     readonly Revoked: "revoked";
+    readonly Superseded: "superseded";
     readonly Expired: "expired";
 };
 export type CertificatePublicStatusEnum = typeof CertificatePublicStatusEnum[keyof typeof CertificatePublicStatusEnum];
@@ -88,6 +113,16 @@ export declare const CertificatePublicIssuanceReasonEnum: {
     readonly Manual: "manual";
 };
 export type CertificatePublicIssuanceReasonEnum = typeof CertificatePublicIssuanceReasonEnum[keyof typeof CertificatePublicIssuanceReasonEnum];
+/**
+ * @export
+ */
+export declare const CertificatePublicIssuanceTypeEnum: {
+    readonly Original: "original";
+    readonly Renewal: "renewal";
+    readonly Replacement: "replacement";
+    readonly Correction: "correction";
+};
+export type CertificatePublicIssuanceTypeEnum = typeof CertificatePublicIssuanceTypeEnum[keyof typeof CertificatePublicIssuanceTypeEnum];
 /**
  * Check if a given object implements the CertificatePublic interface.
  */

package/dist/models/CertificatePublic.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CertificatePublicIssuanceReasonEnum = exports.CertificatePublicStatusEnum = void 0;
+exports.CertificatePublicIssuanceTypeEnum = exports.CertificatePublicIssuanceReasonEnum = exports.CertificatePublicStatusEnum = void 0;
 exports.instanceOfCertificatePublic = instanceOfCertificatePublic;
 exports.CertificatePublicFromJSON = CertificatePublicFromJSON;
 exports.CertificatePublicFromJSONTyped = CertificatePublicFromJSONTyped;
@@ -25,6 +25,7 @@ exports.CertificatePublicToJSONTyped = CertificatePublicToJSONTyped;
 exports.CertificatePublicStatusEnum = {
     Active: 'active',
     Revoked: 'revoked',
+    Superseded: 'superseded',
     Expired: 'expired'
 };
 /**
@@ -35,6 +36,15 @@ exports.CertificatePublicIssuanceReasonEnum = {
     QuizPassed: 'quiz_passed',
     Manual: 'manual'
 };
+/**
+ * @export
+ */
+exports.CertificatePublicIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+};
 /**
  * Check if a given object implements the CertificatePublic interface.
  */
@@ -51,6 +61,10 @@ function instanceOfCertificatePublic(value) {
         return false;
     if (!('issuanceReason' in value) || value['issuanceReason'] === undefined)
         return false;
+    if (!('issuanceType' in value) || value['issuanceType'] === undefined)
+        return false;
+    if (!('pdfAvailable' in value) || value['pdfAvailable'] === undefined)
+        return false;
     if (!('issuedAt' in value) || value['issuedAt'] === undefined)
         return false;
     return true;
@@ -69,6 +83,10 @@ function CertificatePublicFromJSONTyped(json, ignoreDiscriminator) {
         'courseName': json['course_name'],
         'portalName': json['portal_name'],
         'issuanceReason': json['issuance_reason'],
+        'issuanceType': json['issuance_type'],
+        'supersededByCertificateId': json['superseded_by_certificate_id'] == null ? undefined : json['superseded_by_certificate_id'],
+        'pdfAvailable': json['pdf_available'],
+        'badgeCredentialId': json['badge_credential_id'] == null ? undefined : json['badge_credential_id'],
         'issuedAt': json['issued_at'],
         'expiresAt': json['expires_at'] == null ? undefined : json['expires_at'],
         'revokedAt': json['revoked_at'] == null ? undefined : json['revoked_at'],
@@ -88,6 +106,10 @@ function CertificatePublicToJSONTyped(value, ignoreDiscriminator = false) {
         'course_name': value['courseName'],
         'portal_name': value['portalName'],
         'issuance_reason': value['issuanceReason'],
+        'issuance_type': value['issuanceType'],
+        'superseded_by_certificate_id': value['supersededByCertificateId'],
+        'pdf_available': value['pdfAvailable'],
+        'badge_credential_id': value['badgeCredentialId'],
         'issued_at': value['issuedAt'],
         'expires_at': value['expiresAt'],
         'revoked_at': value['revokedAt'],

package/dist/models/CertificateRenewalPolicy.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 CertificateRenewalPolicy
+ */
+export interface CertificateRenewalPolicy {
+    /**
+     *
+     * @type {CertificateRenewalPolicyModeEnum}
+     * @memberof CertificateRenewalPolicy
+     */
+    mode: CertificateRenewalPolicyModeEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof CertificateRenewalPolicy
+     */
+    renewalWindowDays: number;
+}
+/**
+ * @export
+ */
+export declare const CertificateRenewalPolicyModeEnum: {
+    readonly ManualOnly: "manual_only";
+    readonly Automatic: "automatic";
+};
+export type CertificateRenewalPolicyModeEnum = typeof CertificateRenewalPolicyModeEnum[keyof typeof CertificateRenewalPolicyModeEnum];
+/**
+ * Check if a given object implements the CertificateRenewalPolicy interface.
+ */
+export declare function instanceOfCertificateRenewalPolicy(value: object): value is CertificateRenewalPolicy;
+export declare function CertificateRenewalPolicyFromJSON(json: any): CertificateRenewalPolicy;
+export declare function CertificateRenewalPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateRenewalPolicy;
+export declare function CertificateRenewalPolicyToJSON(json: any): CertificateRenewalPolicy;
+export declare function CertificateRenewalPolicyToJSONTyped(value?: CertificateRenewalPolicy | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CertificateRenewalPolicy.js

@@ -0,0 +1,62 @@
+"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.CertificateRenewalPolicyModeEnum = void 0;
+exports.instanceOfCertificateRenewalPolicy = instanceOfCertificateRenewalPolicy;
+exports.CertificateRenewalPolicyFromJSON = CertificateRenewalPolicyFromJSON;
+exports.CertificateRenewalPolicyFromJSONTyped = CertificateRenewalPolicyFromJSONTyped;
+exports.CertificateRenewalPolicyToJSON = CertificateRenewalPolicyToJSON;
+exports.CertificateRenewalPolicyToJSONTyped = CertificateRenewalPolicyToJSONTyped;
+/**
+ * @export
+ */
+exports.CertificateRenewalPolicyModeEnum = {
+    ManualOnly: 'manual_only',
+    Automatic: 'automatic'
+};
+/**
+ * Check if a given object implements the CertificateRenewalPolicy interface.
+ */
+function instanceOfCertificateRenewalPolicy(value) {
+    if (!('mode' in value) || value['mode'] === undefined)
+        return false;
+    if (!('renewalWindowDays' in value) || value['renewalWindowDays'] === undefined)
+        return false;
+    return true;
+}
+function CertificateRenewalPolicyFromJSON(json) {
+    return CertificateRenewalPolicyFromJSONTyped(json, false);
+}
+function CertificateRenewalPolicyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'mode': json['mode'],
+        'renewalWindowDays': json['renewal_window_days'],
+    };
+}
+function CertificateRenewalPolicyToJSON(json) {
+    return CertificateRenewalPolicyToJSONTyped(json, false);
+}
+function CertificateRenewalPolicyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'mode': value['mode'],
+        'renewal_window_days': value['renewalWindowDays'],
+    };
+}

package/dist/models/CertificateTemplate.d.ts

@@ -0,0 +1,121 @@
+/**
+ * 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 { CertificateTemplateVersion } from './CertificateTemplateVersion';
+/**
+ *
+ * @export
+ * @interface CertificateTemplate
+ */
+export interface CertificateTemplate {
+    /**
+     *
+     * @type {string}
+     * @memberof CertificateTemplate
+     */
+    id: string;
+    /**
+     * Null for a platform-owned design.
+     * @type {string}
+     * @memberof CertificateTemplate
+     */
+    portalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CertificateTemplate
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CertificateTemplate
+     */
+    description: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateTemplate
+     */
+    isDefault: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CertificateTemplate
+     */
+    isInherited: boolean;
+    /**
+     *
+     * @type {CertificateTemplateEffectiveSourceEnum}
+     * @memberof CertificateTemplate
+     */
+    effectiveSource: CertificateTemplateEffectiveSourceEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof CertificateTemplate
+     */
+    effectiveSourcePortalId?: string | null;
+    /**
+     *
+     * @type {CertificateTemplateVersion}
+     * @memberof CertificateTemplate
+     */
+    activeVersion: CertificateTemplateVersion;
+    /**
+     *
+     * @type {CertificateTemplateVersion}
+     * @memberof CertificateTemplate
+     */
+    draftVersion?: CertificateTemplateVersion | null;
+    /**
+     *
+     * @type {Array<CertificateTemplateVersion>}
+     * @memberof CertificateTemplate
+     */
+    versions: Array<CertificateTemplateVersion>;
+    /**
+     *
+     * @type {number}
+     * @memberof CertificateTemplate
+     */
+    archivedAt?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CertificateTemplate
+     */
+    createdAt: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CertificateTemplate
+     */
+    updatedAt: number;
+}
+/**
+ * @export
+ */
+export declare const CertificateTemplateEffectiveSourceEnum: {
+    readonly Portal: "portal";
+    readonly Ancestor: "ancestor";
+    readonly Platform: "platform";
+    readonly System: "system";
+};
+export type CertificateTemplateEffectiveSourceEnum = typeof CertificateTemplateEffectiveSourceEnum[keyof typeof CertificateTemplateEffectiveSourceEnum];
+/**
+ * Check if a given object implements the CertificateTemplate interface.
+ */
+export declare function instanceOfCertificateTemplate(value: object): value is CertificateTemplate;
+export declare function CertificateTemplateFromJSON(json: any): CertificateTemplate;
+export declare function CertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateTemplate;
+export declare function CertificateTemplateToJSON(json: any): CertificateTemplate;
+export declare function CertificateTemplateToJSONTyped(value?: CertificateTemplate | null, ignoreDiscriminator?: boolean): any;

package/dist/models/CertificateTemplate.js

@@ -0,0 +1,105 @@
+"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.CertificateTemplateEffectiveSourceEnum = void 0;
+exports.instanceOfCertificateTemplate = instanceOfCertificateTemplate;
+exports.CertificateTemplateFromJSON = CertificateTemplateFromJSON;
+exports.CertificateTemplateFromJSONTyped = CertificateTemplateFromJSONTyped;
+exports.CertificateTemplateToJSON = CertificateTemplateToJSON;
+exports.CertificateTemplateToJSONTyped = CertificateTemplateToJSONTyped;
+const CertificateTemplateVersion_1 = require("./CertificateTemplateVersion");
+/**
+ * @export
+ */
+exports.CertificateTemplateEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+};
+/**
+ * Check if a given object implements the CertificateTemplate interface.
+ */
+function instanceOfCertificateTemplate(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined)
+        return false;
+    if (!('isInherited' in value) || value['isInherited'] === undefined)
+        return false;
+    if (!('effectiveSource' in value) || value['effectiveSource'] === undefined)
+        return false;
+    if (!('activeVersion' in value) || value['activeVersion'] === undefined)
+        return false;
+    if (!('versions' in value) || value['versions'] === undefined)
+        return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined)
+        return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined)
+        return false;
+    return true;
+}
+function CertificateTemplateFromJSON(json) {
+    return CertificateTemplateFromJSONTyped(json, false);
+}
+function CertificateTemplateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'portalId': json['portal_id'] == null ? undefined : json['portal_id'],
+        'name': json['name'],
+        'description': json['description'],
+        'isDefault': json['is_default'],
+        'isInherited': json['is_inherited'],
+        'effectiveSource': json['effective_source'],
+        'effectiveSourcePortalId': json['effective_source_portal_id'] == null ? undefined : json['effective_source_portal_id'],
+        'activeVersion': (0, CertificateTemplateVersion_1.CertificateTemplateVersionFromJSON)(json['active_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : (0, CertificateTemplateVersion_1.CertificateTemplateVersionFromJSON)(json['draft_version']),
+        'versions': (json['versions'].map(CertificateTemplateVersion_1.CertificateTemplateVersionFromJSON)),
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+function CertificateTemplateToJSON(json) {
+    return CertificateTemplateToJSONTyped(json, false);
+}
+function CertificateTemplateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'portal_id': value['portalId'],
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'is_inherited': value['isInherited'],
+        'effective_source': value['effectiveSource'],
+        'effective_source_portal_id': value['effectiveSourcePortalId'],
+        'active_version': (0, CertificateTemplateVersion_1.CertificateTemplateVersionToJSON)(value['activeVersion']),
+        'draft_version': (0, CertificateTemplateVersion_1.CertificateTemplateVersionToJSON)(value['draftVersion']),
+        'versions': (value['versions'].map(CertificateTemplateVersion_1.CertificateTemplateVersionToJSON)),
+        'archived_at': value['archivedAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}