@easyedu/js-lsm-api 1.86.0 → 1.88.0

package/src/apis/index.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './CertificateApi';
+export * from './CertificateTemplateApi';
 export * from './ChatApi';
 export * from './ContentApi';
 export * from './ContentLibraryApi';

package/src/models/ArtifactConflict.ts

@@ -0,0 +1,95 @@
+/* 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 ArtifactConflict
+ */
+export interface ArtifactConflict {
+    /**
+     * 
+     * @type {ArtifactConflictCodeEnum}
+     * @memberof ArtifactConflict
+     */
+    code: ArtifactConflictCodeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof ArtifactConflict
+     */
+    message: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ArtifactConflict
+     */
+    retryable: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const ArtifactConflictCodeEnum = {
+    ArtifactPending: 'artifact_pending',
+    ArtifactFailed: 'artifact_failed'
+} as const;
+export type ArtifactConflictCodeEnum = typeof ArtifactConflictCodeEnum[keyof typeof ArtifactConflictCodeEnum];
+
+
+/**
+ * Check if a given object implements the ArtifactConflict interface.
+ */
+export function instanceOfArtifactConflict(value: object): value is ArtifactConflict {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('retryable' in value) || value['retryable'] === undefined) return false;
+    return true;
+}
+
+export function ArtifactConflictFromJSON(json: any): ArtifactConflict {
+    return ArtifactConflictFromJSONTyped(json, false);
+}
+
+export function ArtifactConflictFromJSONTyped(json: any, ignoreDiscriminator: boolean): ArtifactConflict {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+        'message': json['message'],
+        'retryable': json['retryable'],
+    };
+}
+
+export function ArtifactConflictToJSON(json: any): ArtifactConflict {
+    return ArtifactConflictToJSONTyped(json, false);
+}
+
+export function ArtifactConflictToJSONTyped(value?: ArtifactConflict | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+        'message': value['message'],
+        'retryable': value['retryable'],
+    };
+}
+

package/src/models/BadgeIssuer.ts

@@ -0,0 +1,135 @@
+/* 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 BadgeIssuer
+ */
+export interface BadgeIssuer {
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    portalId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    displayName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    websiteUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    did: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof BadgeIssuer
+     */
+    activeKeyId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof BadgeIssuer
+     */
+    createdAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof BadgeIssuer
+     */
+    updatedAt: number;
+}
+
+/**
+ * Check if a given object implements the BadgeIssuer interface.
+ */
+export function instanceOfBadgeIssuer(value: object): value is BadgeIssuer {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('portalId' in value) || value['portalId'] === undefined) return false;
+    if (!('displayName' in value) || value['displayName'] === undefined) return false;
+    if (!('did' in value) || value['did'] === 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 BadgeIssuerFromJSON(json: any): BadgeIssuer {
+    return BadgeIssuerFromJSONTyped(json, false);
+}
+
+export function BadgeIssuerFromJSONTyped(json: any, ignoreDiscriminator: boolean): BadgeIssuer {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'portalId': json['portal_id'],
+        'displayName': json['display_name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'websiteUrl': json['website_url'] == null ? undefined : json['website_url'],
+        'did': json['did'],
+        'activeKeyId': json['active_key_id'] == null ? undefined : json['active_key_id'],
+        'createdAt': json['created_at'],
+        'updatedAt': json['updated_at'],
+    };
+}
+
+export function BadgeIssuerToJSON(json: any): BadgeIssuer {
+    return BadgeIssuerToJSONTyped(json, false);
+}
+
+export function BadgeIssuerToJSONTyped(value?: BadgeIssuer | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'portal_id': value['portalId'],
+        'display_name': value['displayName'],
+        'description': value['description'],
+        'website_url': value['websiteUrl'],
+        'did': value['did'],
+        'active_key_id': value['activeKeyId'],
+        'created_at': value['createdAt'],
+        'updated_at': value['updatedAt'],
+    };
+}
+

package/src/models/Certificate.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CertificateArtifact } from './CertificateArtifact';
+import {
+    CertificateArtifactFromJSON,
+    CertificateArtifactFromJSONTyped,
+    CertificateArtifactToJSON,
+    CertificateArtifactToJSONTyped,
+} from './CertificateArtifact';
+
 /**
  * 
  * @export
@@ -73,12 +81,54 @@ export interface Certificate {
      * @memberof Certificate
      */
     issuanceReason: CertificateIssuanceReasonEnum;
+    /**
+     * 
+     * @type {CertificateIssuanceTypeEnum}
+     * @memberof Certificate
+     */
+    issuanceType: CertificateIssuanceTypeEnum;
     /**
      * 
      * @type {CertificateStatusEnum}
      * @memberof Certificate
      */
     status: CertificateStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    supersedesCertificateId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    supersededByCertificateId?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Certificate
+     */
+    supersededAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    templateVersionId?: string | null;
+    /**
+     * 
+     * @type {CertificateArtifact}
+     * @memberof Certificate
+     */
+    artifact: CertificateArtifact;
+    /**
+     * 
+     * @type {string}
+     * @memberof Certificate
+     */
+    badgeCredentialId?: string | null;
     /**
      * 
      * @type {number}
@@ -140,12 +190,24 @@ export const CertificateIssuanceReasonEnum = {
 } as const;
 export type CertificateIssuanceReasonEnum = typeof CertificateIssuanceReasonEnum[keyof typeof CertificateIssuanceReasonEnum];
 
+/**
+ * @export
+ */
+export const CertificateIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+} as const;
+export type CertificateIssuanceTypeEnum = typeof CertificateIssuanceTypeEnum[keyof typeof CertificateIssuanceTypeEnum];
+
 /**
  * @export
  */
 export const CertificateStatusEnum = {
     Active: 'active',
-    Revoked: 'revoked'
+    Revoked: 'revoked',
+    Superseded: 'superseded'
 } as const;
 export type CertificateStatusEnum = typeof CertificateStatusEnum[keyof typeof CertificateStatusEnum];
 
@@ -160,7 +222,9 @@ export function instanceOfCertificate(value: object): value is Certificate {
     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 (!('issuanceType' in value) || value['issuanceType'] === undefined) return false;
     if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('artifact' in value) || value['artifact'] === 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;
@@ -188,7 +252,14 @@ export function CertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean
         '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'],
+        'issuanceType': json['issuance_type'],
         'status': json['status'],
+        'supersedesCertificateId': json['supersedes_certificate_id'] == null ? undefined : json['supersedes_certificate_id'],
+        'supersededByCertificateId': json['superseded_by_certificate_id'] == null ? undefined : json['superseded_by_certificate_id'],
+        'supersededAt': json['superseded_at'] == null ? undefined : json['superseded_at'],
+        'templateVersionId': json['template_version_id'] == null ? undefined : json['template_version_id'],
+        'artifact': CertificateArtifactFromJSON(json['artifact']),
+        'badgeCredentialId': json['badge_credential_id'] == null ? undefined : json['badge_credential_id'],
         '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'],
@@ -220,7 +291,14 @@ export function CertificateToJSONTyped(value?: Certificate | null, ignoreDiscrim
         'expires_at': value['expiresAt'],
         'issued_by_user_id': value['issuedByUserId'],
         'issuance_reason': value['issuanceReason'],
+        'issuance_type': value['issuanceType'],
         'status': value['status'],
+        'supersedes_certificate_id': value['supersedesCertificateId'],
+        'superseded_by_certificate_id': value['supersededByCertificateId'],
+        'superseded_at': value['supersededAt'],
+        'template_version_id': value['templateVersionId'],
+        'artifact': CertificateArtifactToJSON(value['artifact']),
+        'badge_credential_id': value['badgeCredentialId'],
         'revoked_at': value['revokedAt'],
         'revoked_by_user_id': value['revokedByUserId'],
         'revocation_reason': value['revocationReason'],

package/src/models/CertificateArtifact.ts

@@ -0,0 +1,119 @@
+/* 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 CertificateArtifact
+ */
+export interface CertificateArtifact {
+    /**
+     * 
+     * @type {CertificateArtifactStatusEnum}
+     * @memberof CertificateArtifact
+     */
+    status: CertificateArtifactStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateArtifact
+     */
+    byteSize?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateArtifact
+     */
+    checksumSha256?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateArtifact
+     */
+    rendererVersion?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CertificateArtifact
+     */
+    generatedAt?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateArtifact
+     */
+    lastErrorCode?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CertificateArtifactStatusEnum = {
+    Queued: 'queued',
+    Processing: 'processing',
+    Ready: 'ready',
+    Failed: 'failed'
+} as const;
+export type CertificateArtifactStatusEnum = typeof CertificateArtifactStatusEnum[keyof typeof CertificateArtifactStatusEnum];
+
+
+/**
+ * Check if a given object implements the CertificateArtifact interface.
+ */
+export function instanceOfCertificateArtifact(value: object): value is CertificateArtifact {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    return true;
+}
+
+export function CertificateArtifactFromJSON(json: any): CertificateArtifact {
+    return CertificateArtifactFromJSONTyped(json, false);
+}
+
+export function CertificateArtifactFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateArtifact {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'byteSize': json['byte_size'] == null ? undefined : json['byte_size'],
+        'checksumSha256': json['checksum_sha256'] == null ? undefined : json['checksum_sha256'],
+        'rendererVersion': json['renderer_version'] == null ? undefined : json['renderer_version'],
+        'generatedAt': json['generated_at'] == null ? undefined : json['generated_at'],
+        'lastErrorCode': json['last_error_code'] == null ? undefined : json['last_error_code'],
+    };
+}
+
+export function CertificateArtifactToJSON(json: any): CertificateArtifact {
+    return CertificateArtifactToJSONTyped(json, false);
+}
+
+export function CertificateArtifactToJSONTyped(value?: CertificateArtifact | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'byte_size': value['byteSize'],
+        'checksum_sha256': value['checksumSha256'],
+        'renderer_version': value['rendererVersion'],
+        'generated_at': value['generatedAt'],
+        'last_error_code': value['lastErrorCode'],
+    };
+}
+

package/src/models/CertificateBadgePolicy.ts

@@ -0,0 +1,126 @@
+/* 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 { CertificateBadgePolicyAlignmentsInner } from './CertificateBadgePolicyAlignmentsInner';
+import {
+    CertificateBadgePolicyAlignmentsInnerFromJSON,
+    CertificateBadgePolicyAlignmentsInnerFromJSONTyped,
+    CertificateBadgePolicyAlignmentsInnerToJSON,
+    CertificateBadgePolicyAlignmentsInnerToJSONTyped,
+} from './CertificateBadgePolicyAlignmentsInner';
+
+/**
+ * 
+ * @export
+ * @interface CertificateBadgePolicy
+ */
+export interface CertificateBadgePolicy {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CertificateBadgePolicy
+     */
+    enabled: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicy
+     */
+    criteria: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicy
+     */
+    imageAssetId?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CertificateBadgePolicy
+     */
+    description?: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CertificateBadgePolicy
+     */
+    tags: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof CertificateBadgePolicy
+     */
+    skills: Array<string>;
+    /**
+     * 
+     * @type {Array<CertificateBadgePolicyAlignmentsInner>}
+     * @memberof CertificateBadgePolicy
+     */
+    alignments: Array<CertificateBadgePolicyAlignmentsInner>;
+}
+
+/**
+ * Check if a given object implements the CertificateBadgePolicy interface.
+ */
+export function instanceOfCertificateBadgePolicy(value: object): value is CertificateBadgePolicy {
+    if (!('enabled' in value) || value['enabled'] === undefined) return false;
+    if (!('criteria' in value) || value['criteria'] === undefined) return false;
+    if (!('tags' in value) || value['tags'] === undefined) return false;
+    if (!('skills' in value) || value['skills'] === undefined) return false;
+    if (!('alignments' in value) || value['alignments'] === undefined) return false;
+    return true;
+}
+
+export function CertificateBadgePolicyFromJSON(json: any): CertificateBadgePolicy {
+    return CertificateBadgePolicyFromJSONTyped(json, false);
+}
+
+export function CertificateBadgePolicyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateBadgePolicy {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'enabled': json['enabled'],
+        'criteria': json['criteria'],
+        'imageAssetId': json['image_asset_id'] == null ? undefined : json['image_asset_id'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'tags': json['tags'],
+        'skills': json['skills'],
+        'alignments': ((json['alignments'] as Array<any>).map(CertificateBadgePolicyAlignmentsInnerFromJSON)),
+    };
+}
+
+export function CertificateBadgePolicyToJSON(json: any): CertificateBadgePolicy {
+    return CertificateBadgePolicyToJSONTyped(json, false);
+}
+
+export function CertificateBadgePolicyToJSONTyped(value?: CertificateBadgePolicy | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'enabled': value['enabled'],
+        'criteria': value['criteria'],
+        'image_asset_id': value['imageAssetId'],
+        'description': value['description'],
+        'tags': value['tags'],
+        'skills': value['skills'],
+        'alignments': ((value['alignments'] as Array<any>).map(CertificateBadgePolicyAlignmentsInnerToJSON)),
+    };
+}
+