@easyedu/js-lsm-api 1.86.0 → 1.87.0

package/src/models/CertificateConfig.ts

@@ -13,6 +13,28 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CertificateNotificationPolicy } from './CertificateNotificationPolicy';
+import {
+    CertificateNotificationPolicyFromJSON,
+    CertificateNotificationPolicyFromJSONTyped,
+    CertificateNotificationPolicyToJSON,
+    CertificateNotificationPolicyToJSONTyped,
+} from './CertificateNotificationPolicy';
+import type { CertificateRenewalPolicy } from './CertificateRenewalPolicy';
+import {
+    CertificateRenewalPolicyFromJSON,
+    CertificateRenewalPolicyFromJSONTyped,
+    CertificateRenewalPolicyToJSON,
+    CertificateRenewalPolicyToJSONTyped,
+} from './CertificateRenewalPolicy';
+import type { CertificateBadgePolicy } from './CertificateBadgePolicy';
+import {
+    CertificateBadgePolicyFromJSON,
+    CertificateBadgePolicyFromJSONTyped,
+    CertificateBadgePolicyToJSON,
+    CertificateBadgePolicyToJSONTyped,
+} from './CertificateBadgePolicy';
+
 /**
  * 
  * @export
@@ -67,6 +89,30 @@ export interface CertificateConfig {
      * @memberof CertificateConfig
      */
     quizConfigId?: string | null;
+    /**
+     * Logical certificate design selection. Null uses scope defaults.
+     * @type {string}
+     * @memberof CertificateConfig
+     */
+    certificateTemplateId?: string | null;
+    /**
+     * At course scope, null inherits the portal policy as a whole.
+     * @type {CertificateRenewalPolicy}
+     * @memberof CertificateConfig
+     */
+    renewalPolicy?: CertificateRenewalPolicy | null;
+    /**
+     * At course scope, null inherits the portal policy as a whole.
+     * @type {CertificateNotificationPolicy}
+     * @memberof CertificateConfig
+     */
+    notificationPolicy?: CertificateNotificationPolicy | null;
+    /**
+     * At course scope, null inherits the portal policy as a whole.
+     * @type {CertificateBadgePolicy}
+     * @memberof CertificateConfig
+     */
+    badgePolicy?: CertificateBadgePolicy | null;
     /**
      * 
      * @type {number}
@@ -111,6 +157,10 @@ export function CertificateConfigFromJSONTyped(json: any, ignoreDiscriminator: b
         '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'],
+        'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
+        'renewalPolicy': json['renewal_policy'] == null ? undefined : CertificateRenewalPolicyFromJSON(json['renewal_policy']),
+        'notificationPolicy': json['notification_policy'] == null ? undefined : CertificateNotificationPolicyFromJSON(json['notification_policy']),
+        'badgePolicy': json['badge_policy'] == null ? undefined : CertificateBadgePolicyFromJSON(json['badge_policy']),
         'createdAt': json['created_at'],
         'updatedAt': json['updated_at'],
     };
@@ -135,6 +185,10 @@ export function CertificateConfigToJSONTyped(value?: CertificateConfig | null, i
         'require_quiz_pass': value['requireQuizPass'],
         'min_quiz_score': value['minQuizScore'],
         'quiz_config_id': value['quizConfigId'],
+        'certificate_template_id': value['certificateTemplateId'],
+        'renewal_policy': CertificateRenewalPolicyToJSON(value['renewalPolicy']),
+        'notification_policy': CertificateNotificationPolicyToJSON(value['notificationPolicy']),
+        'badge_policy': CertificateBadgePolicyToJSON(value['badgePolicy']),
         'created_at': value['createdAt'],
         'updated_at': value['updatedAt'],
     };

package/src/models/CertificateEvent.ts

@@ -0,0 +1,117 @@
+/* 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 CertificateEvent
+ */
+export interface CertificateEvent {
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateEvent
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateEvent
+     */
+    eventType: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateEvent
+     */
+    actorUserId?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof CertificateEvent
+     */
+    oldValues?: { [key: string]: any; } | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof CertificateEvent
+     */
+    newValues?: { [key: string]: any; } | null;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof CertificateEvent
+     */
+    context: { [key: string]: any; };
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateEvent
+     */
+    createdAt: number;
+}
+
+/**
+ * Check if a given object implements the CertificateEvent interface.
+ */
+export function instanceOfCertificateEvent(value: object): value is CertificateEvent {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('eventType' in value) || value['eventType'] === undefined) return false;
+    if (!('context' in value) || value['context'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    return true;
+}
+
+export function CertificateEventFromJSON(json: any): CertificateEvent {
+    return CertificateEventFromJSONTyped(json, false);
+}
+
+export function CertificateEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateEvent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'eventType': json['event_type'],
+        'actorUserId': json['actor_user_id'] == null ? undefined : json['actor_user_id'],
+        'oldValues': json['old_values'] == null ? undefined : json['old_values'],
+        'newValues': json['new_values'] == null ? undefined : json['new_values'],
+        'context': json['context'],
+        'createdAt': json['created_at'],
+    };
+}
+
+export function CertificateEventToJSON(json: any): CertificateEvent {
+    return CertificateEventToJSONTyped(json, false);
+}
+
+export function CertificateEventToJSONTyped(value?: CertificateEvent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'event_type': value['eventType'],
+        'actor_user_id': value['actorUserId'],
+        'old_values': value['oldValues'],
+        'new_values': value['newValues'],
+        'context': value['context'],
+        'created_at': value['createdAt'],
+    };
+}
+

package/src/models/CertificateNotificationPolicy.ts

@@ -0,0 +1,131 @@
+/* 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 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 const CertificateNotificationPolicyRecipientsEnum = {
+    Learner: 'learner',
+    Portal: 'portal'
+} as const;
+export type CertificateNotificationPolicyRecipientsEnum = typeof CertificateNotificationPolicyRecipientsEnum[keyof typeof CertificateNotificationPolicyRecipientsEnum];
+
+
+/**
+ * Check if a given object implements the CertificateNotificationPolicy interface.
+ */
+export function instanceOfCertificateNotificationPolicy(value: object): value is CertificateNotificationPolicy {
+    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;
+}
+
+export function CertificateNotificationPolicyFromJSON(json: any): CertificateNotificationPolicy {
+    return CertificateNotificationPolicyFromJSONTyped(json, false);
+}
+
+export function CertificateNotificationPolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateNotificationPolicy {
+    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']),
+    };
+}
+
+export function CertificateNotificationPolicyToJSON(json: any): CertificateNotificationPolicy {
+    return CertificateNotificationPolicyToJSONTyped(json, false);
+}
+
+export function CertificateNotificationPolicyToJSONTyped(value?: CertificateNotificationPolicy | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Set<any>),
+    };
+}
+

package/src/models/CertificatePublic.ts

@@ -55,6 +55,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}
@@ -82,6 +106,7 @@ export interface CertificatePublic {
 export const CertificatePublicStatusEnum = {
     Active: 'active',
     Revoked: 'revoked',
+    Superseded: 'superseded',
     Expired: 'expired'
 } as const;
 export type CertificatePublicStatusEnum = typeof CertificatePublicStatusEnum[keyof typeof CertificatePublicStatusEnum];
@@ -96,6 +121,17 @@ export const CertificatePublicIssuanceReasonEnum = {
 } as const;
 export type CertificatePublicIssuanceReasonEnum = typeof CertificatePublicIssuanceReasonEnum[keyof typeof CertificatePublicIssuanceReasonEnum];
 
+/**
+ * @export
+ */
+export const CertificatePublicIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+} as const;
+export type CertificatePublicIssuanceTypeEnum = typeof CertificatePublicIssuanceTypeEnum[keyof typeof CertificatePublicIssuanceTypeEnum];
+
 
 /**
  * Check if a given object implements the CertificatePublic interface.
@@ -107,6 +143,8 @@ export function instanceOfCertificatePublic(value: object): value is Certificate
     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 (!('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;
 }
@@ -127,6 +165,10 @@ export function CertificatePublicFromJSONTyped(json: any, ignoreDiscriminator: b
         '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'],
@@ -150,6 +192,10 @@ export function CertificatePublicToJSONTyped(value?: CertificatePublic | null, i
         '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/src/models/CertificateRenewalPolicy.ts

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