@easyedu/js-lsm-api 1.86.0 → 1.88.0

package/src/models/CertificateTemplate.ts

@@ -0,0 +1,200 @@
+/* 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';
+import type { CertificateTemplateVersion } from './CertificateTemplateVersion';
+import {
+    CertificateTemplateVersionFromJSON,
+    CertificateTemplateVersionFromJSONTyped,
+    CertificateTemplateVersionToJSON,
+    CertificateTemplateVersionToJSONTyped,
+} 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 const CertificateTemplateEffectiveSourceEnum = {
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type CertificateTemplateEffectiveSourceEnum = typeof CertificateTemplateEffectiveSourceEnum[keyof typeof CertificateTemplateEffectiveSourceEnum];
+
+
+/**
+ * Check if a given object implements the CertificateTemplate interface.
+ */
+export function instanceOfCertificateTemplate(value: object): value is CertificateTemplate {
+    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;
+}
+
+export function CertificateTemplateFromJSON(json: any): CertificateTemplate {
+    return CertificateTemplateFromJSONTyped(json, false);
+}
+
+export function CertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateTemplate {
+    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': CertificateTemplateVersionFromJSON(json['active_version']),
+        'draftVersion': json['draft_version'] == null ? undefined : CertificateTemplateVersionFromJSON(json['draft_version']),
+        'versions': ((json['versions'] as Array<any>).map(CertificateTemplateVersionFromJSON)),
+        'archivedAt': json['archived_at'] == null ? undefined : json['archived_at'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function CertificateTemplateToJSON(json: any): CertificateTemplate {
+    return CertificateTemplateToJSONTyped(json, false);
+}
+
+export function CertificateTemplateToJSONTyped(value?: CertificateTemplate | null, ignoreDiscriminator: boolean = false): any {
+    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': CertificateTemplateVersionToJSON(value['activeVersion']),
+        'draft_version': CertificateTemplateVersionToJSON(value['draftVersion']),
+        'versions': ((value['versions'] as Array<any>).map(CertificateTemplateVersionToJSON)),
+        'archived_at': value['archivedAt'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/CertificateTemplateVersion.ts

@@ -0,0 +1,148 @@
+/* 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';
+import type { CertificateCanvasDocument } from './CertificateCanvasDocument';
+import {
+    CertificateCanvasDocumentFromJSON,
+    CertificateCanvasDocumentFromJSONTyped,
+    CertificateCanvasDocumentToJSON,
+    CertificateCanvasDocumentToJSONTyped,
+} from './CertificateCanvasDocument';
+
+/**
+ * 
+ * @export
+ * @interface CertificateTemplateVersion
+ */
+export interface CertificateTemplateVersion {
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateTemplateVersion
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateTemplateVersion
+     */
+    versionNumber: number;
+    /**
+     * 
+     * @type {CertificateTemplateVersionStatusEnum}
+     * @memberof CertificateTemplateVersion
+     */
+    status: CertificateTemplateVersionStatusEnum;
+    /**
+     * 
+     * @type {CertificateCanvasDocument}
+     * @memberof CertificateTemplateVersion
+     */
+    designDocument: CertificateCanvasDocument;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateTemplateVersion
+     */
+    changeNotes?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateTemplateVersion
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateTemplateVersion
+     */
+    updatedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateTemplateVersion
+     */
+    publishedAt?: number | null;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateTemplateVersionStatusEnum = {
+    Draft: 'draft',
+    Published: 'published',
+    Archived: 'archived',
+    System: 'system'
+} as const;
+export type CertificateTemplateVersionStatusEnum = typeof CertificateTemplateVersionStatusEnum[keyof typeof CertificateTemplateVersionStatusEnum];
+
+
+/**
+ * Check if a given object implements the CertificateTemplateVersion interface.
+ */
+export function instanceOfCertificateTemplateVersion(value: object): value is CertificateTemplateVersion {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('versionNumber' in value) || value['versionNumber'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('designDocument' in value) || value['designDocument'] === 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 CertificateTemplateVersionFromJSON(json: any): CertificateTemplateVersion {
+    return CertificateTemplateVersionFromJSONTyped(json, false);
+}
+
+export function CertificateTemplateVersionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateTemplateVersion {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'versionNumber': json['version_number'],
+        'status': json['status'],
+        'designDocument': CertificateCanvasDocumentFromJSON(json['design_document']),
+        'changeNotes': json['change_notes'] == null ? undefined : json['change_notes'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+        'publishedAt': json['published_at'] == null ? undefined : json['published_at'],
+    };
+}
+
+export function CertificateTemplateVersionToJSON(json: any): CertificateTemplateVersion {
+    return CertificateTemplateVersionToJSONTyped(json, false);
+}
+
+export function CertificateTemplateVersionToJSONTyped(value?: CertificateTemplateVersion | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'version_number': value['versionNumber'],
+        'status': value['status'],
+        'design_document': CertificateCanvasDocumentToJSON(value['designDocument']),
+        'change_notes': value['changeNotes'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+        'published_at': value['publishedAt'],
+    };
+}
+

package/src/models/EffectiveCertificateConfig.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';
+
 /**
  * Resolved effective config for a course (course override merged with portal default)
  * @export
@@ -55,14 +77,74 @@ export interface EffectiveCertificateConfig {
      * @memberof EffectiveCertificateConfig
      */
     sourceConfigId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EffectiveCertificateConfig
+     */
+    certificateTemplateId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof EffectiveCertificateConfig
+     */
+    certificateTemplateVersionId?: string | null;
+    /**
+     * 
+     * @type {EffectiveCertificateConfigTemplateSourceEnum}
+     * @memberof EffectiveCertificateConfig
+     */
+    templateSource: EffectiveCertificateConfigTemplateSourceEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof EffectiveCertificateConfig
+     */
+    templateSourcePortalId?: string | null;
+    /**
+     * 
+     * @type {CertificateRenewalPolicy}
+     * @memberof EffectiveCertificateConfig
+     */
+    renewalPolicy: CertificateRenewalPolicy;
+    /**
+     * 
+     * @type {CertificateNotificationPolicy}
+     * @memberof EffectiveCertificateConfig
+     */
+    notificationPolicy: CertificateNotificationPolicy;
+    /**
+     * 
+     * @type {CertificateBadgePolicy}
+     * @memberof EffectiveCertificateConfig
+     */
+    badgePolicy: CertificateBadgePolicy;
 }
 
+
+/**
+ * @export
+ */
+export const EffectiveCertificateConfigTemplateSourceEnum = {
+    Course: 'course',
+    Portal: 'portal',
+    Ancestor: 'ancestor',
+    Platform: 'platform',
+    System: 'system'
+} as const;
+export type EffectiveCertificateConfigTemplateSourceEnum = typeof EffectiveCertificateConfigTemplateSourceEnum[keyof typeof EffectiveCertificateConfigTemplateSourceEnum];
+
+
 /**
  * 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;
+    if (!('templateSource' in value) || value['templateSource'] === undefined) return false;
+    if (!('renewalPolicy' in value) || value['renewalPolicy'] === undefined) return false;
+    if (!('notificationPolicy' in value) || value['notificationPolicy'] === undefined) return false;
+    if (!('badgePolicy' in value) || value['badgePolicy'] === undefined) return false;
     return true;
 }
 
@@ -82,6 +164,13 @@ export function EffectiveCertificateConfigFromJSONTyped(json: any, ignoreDiscrim
         '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'],
+        'certificateTemplateId': json['certificate_template_id'] == null ? undefined : json['certificate_template_id'],
+        'certificateTemplateVersionId': json['certificate_template_version_id'] == null ? undefined : json['certificate_template_version_id'],
+        'templateSource': json['template_source'],
+        'templateSourcePortalId': json['template_source_portal_id'] == null ? undefined : json['template_source_portal_id'],
+        'renewalPolicy': CertificateRenewalPolicyFromJSON(json['renewal_policy']),
+        'notificationPolicy': CertificateNotificationPolicyFromJSON(json['notification_policy']),
+        'badgePolicy': CertificateBadgePolicyFromJSON(json['badge_policy']),
     };
 }
 
@@ -102,6 +191,13 @@ export function EffectiveCertificateConfigToJSONTyped(value?: EffectiveCertifica
         'min_quiz_score': value['minQuizScore'],
         'quiz_config_id': value['quizConfigId'],
         'source_config_id': value['sourceConfigId'],
+        'certificate_template_id': value['certificateTemplateId'],
+        'certificate_template_version_id': value['certificateTemplateVersionId'],
+        'template_source': value['templateSource'],
+        'template_source_portal_id': value['templateSourcePortalId'],
+        'renewal_policy': CertificateRenewalPolicyToJSON(value['renewalPolicy']),
+        'notification_policy': CertificateNotificationPolicyToJSON(value['notificationPolicy']),
+        'badge_policy': CertificateBadgePolicyToJSON(value['badgePolicy']),
     };
 }
 

package/src/models/GetCertificateAssetUpload.ts

@@ -0,0 +1,113 @@
+/* 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 GetCertificateAssetUpload
+ */
+export interface GetCertificateAssetUpload {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCertificateAssetUpload
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetCertificateAssetUpload
+     */
+    uploadUrl: string;
+    /**
+     * Authenticated URL for editing and previewing unpublished assets.
+     * @type {string}
+     * @memberof GetCertificateAssetUpload
+     */
+    assetUrl: string;
+    /**
+     * Public URL available only after a published certificate design pins the asset.
+     * @type {string}
+     * @memberof GetCertificateAssetUpload
+     */
+    publicUrl: string;
+    /**
+     * 
+     * @type {GetCertificateAssetUploadStatusEnum}
+     * @memberof GetCertificateAssetUpload
+     */
+    status: GetCertificateAssetUploadStatusEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetCertificateAssetUploadStatusEnum = {
+    Pending: 'pending',
+    Ready: 'ready'
+} as const;
+export type GetCertificateAssetUploadStatusEnum = typeof GetCertificateAssetUploadStatusEnum[keyof typeof GetCertificateAssetUploadStatusEnum];
+
+
+/**
+ * Check if a given object implements the GetCertificateAssetUpload interface.
+ */
+export function instanceOfGetCertificateAssetUpload(value: object): value is GetCertificateAssetUpload {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('uploadUrl' in value) || value['uploadUrl'] === undefined) return false;
+    if (!('assetUrl' in value) || value['assetUrl'] === undefined) return false;
+    if (!('publicUrl' in value) || value['publicUrl'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function GetCertificateAssetUploadFromJSON(json: any): GetCertificateAssetUpload {
+    return GetCertificateAssetUploadFromJSONTyped(json, false);
+}
+
+export function GetCertificateAssetUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateAssetUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'uploadUrl': json['upload_url'],
+        'assetUrl': json['asset_url'],
+        'publicUrl': json['public_url'],
+        'status': json['status'],
+    };
+}
+
+export function GetCertificateAssetUploadToJSON(json: any): GetCertificateAssetUpload {
+    return GetCertificateAssetUploadToJSONTyped(json, false);
+}
+
+export function GetCertificateAssetUploadToJSONTyped(value?: GetCertificateAssetUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'upload_url': value['uploadUrl'],
+        'asset_url': value['assetUrl'],
+        'public_url': value['publicUrl'],
+        'status': value['status'],
+    };
+}
+

package/src/models/GetCertificateEventList.ts

@@ -0,0 +1,74 @@
+/* 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';
+import type { CertificateEvent } from './CertificateEvent';
+import {
+    CertificateEventFromJSON,
+    CertificateEventFromJSONTyped,
+    CertificateEventToJSON,
+    CertificateEventToJSONTyped,
+} from './CertificateEvent';
+
+/**
+ * 
+ * @export
+ * @interface GetCertificateEventList
+ */
+export interface GetCertificateEventList {
+    /**
+     * 
+     * @type {Array<CertificateEvent>}
+     * @memberof GetCertificateEventList
+     */
+    items: Array<CertificateEvent>;
+}
+
+/**
+ * Check if a given object implements the GetCertificateEventList interface.
+ */
+export function instanceOfGetCertificateEventList(value: object): value is GetCertificateEventList {
+    if (!('items' in value) || value['items'] === undefined) return false;
+    return true;
+}
+
+export function GetCertificateEventListFromJSON(json: any): GetCertificateEventList {
+    return GetCertificateEventListFromJSONTyped(json, false);
+}
+
+export function GetCertificateEventListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCertificateEventList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'items': ((json['items'] as Array<any>).map(CertificateEventFromJSON)),
+    };
+}
+
+export function GetCertificateEventListToJSON(json: any): GetCertificateEventList {
+    return GetCertificateEventListToJSONTyped(json, false);
+}
+
+export function GetCertificateEventListToJSONTyped(value?: GetCertificateEventList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'items': ((value['items'] as Array<any>).map(CertificateEventToJSON)),
+    };
+}
+