@easyedu/js-lsm-api 1.86.0 → 1.87.0

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

@@ -1,6 +1,25 @@
+export * from './ArtifactConflict';
+export * from './BadgeIssuer';
 export * from './Certificate';
+export * from './CertificateArtifact';
+export * from './CertificateBadgePolicy';
+export * from './CertificateBadgePolicyAlignmentsInner';
+export * from './CertificateCanvasDocument';
+export * from './CertificateCanvasDocumentPage';
+export * from './CertificateCanvasElement';
+export * from './CertificateCanvasImageElement';
+export * from './CertificateCanvasLineElement';
+export * from './CertificateCanvasPortalLogoElement';
+export * from './CertificateCanvasShapeElement';
+export * from './CertificateCanvasTextElement';
+export * from './CertificateCanvasVerificationQrElement';
 export * from './CertificateConfig';
+export * from './CertificateEvent';
+export * from './CertificateNotificationPolicy';
 export * from './CertificatePublic';
+export * from './CertificateRenewalPolicy';
+export * from './CertificateTemplate';
+export * from './CertificateTemplateVersion';
 export * from './ContentAttemptItem';
 export * from './ContentAttemptRollupScore';
 export * from './ContentAttemptScore';
@@ -21,8 +40,11 @@ export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
 export * from './FillInBlank1';
+export * from './GetCertificateAssetUpload';
 export * from './GetCertificateConfigList';
+export * from './GetCertificateEventList';
 export * from './GetCertificateList';
+export * from './GetCertificateTemplateList';
 export * from './GetChatMessage';
 export * from './GetContent';
 export * from './GetContentAttempts';
@@ -104,6 +126,7 @@ export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserFieldValues';
 export * from './GetPortalUserList';
+export * from './GetPublicBadgeCredentialStatus200Response';
 export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
@@ -212,7 +235,13 @@ export * from './PortalUserFieldValueField';
 export * from './PortalUserFieldValueGroup';
 export * from './PortalUserFieldValueInput';
 export * from './PostCertificate';
+export * from './PostCertificateAssetComplete';
+export * from './PostCertificateAssetUpload';
 export * from './PostCertificateConfig';
+export * from './PostCertificateLifecycleAction';
+export * from './PostCertificateTemplate';
+export * from './PostCertificateTemplateClone';
+export * from './PostCertificateTemplatePreview';
 export * from './PostContentQuiz';
 export * from './PostContentQuizAssignment';
 export * from './PostContentQuizQuestionSelection';
@@ -281,7 +310,10 @@ export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
+export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
+export * from './PutCertificateTemplate';
+export * from './PutCertificateTemplateDraft';
 export * from './PutContent';
 export * from './PutContentAttemptSettings';
 export * from './PutContentReorder';

package/dist/esm/models/index.js

@@ -1,8 +1,27 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './ArtifactConflict';
+export * from './BadgeIssuer';
 export * from './Certificate';
+export * from './CertificateArtifact';
+export * from './CertificateBadgePolicy';
+export * from './CertificateBadgePolicyAlignmentsInner';
+export * from './CertificateCanvasDocument';
+export * from './CertificateCanvasDocumentPage';
+export * from './CertificateCanvasElement';
+export * from './CertificateCanvasImageElement';
+export * from './CertificateCanvasLineElement';
+export * from './CertificateCanvasPortalLogoElement';
+export * from './CertificateCanvasShapeElement';
+export * from './CertificateCanvasTextElement';
+export * from './CertificateCanvasVerificationQrElement';
 export * from './CertificateConfig';
+export * from './CertificateEvent';
+export * from './CertificateNotificationPolicy';
 export * from './CertificatePublic';
+export * from './CertificateRenewalPolicy';
+export * from './CertificateTemplate';
+export * from './CertificateTemplateVersion';
 export * from './ContentAttemptItem';
 export * from './ContentAttemptRollupScore';
 export * from './ContentAttemptScore';
@@ -23,8 +42,11 @@ export * from './Essay';
 export * from './Essay1';
 export * from './FillInBlank';
 export * from './FillInBlank1';
+export * from './GetCertificateAssetUpload';
 export * from './GetCertificateConfigList';
+export * from './GetCertificateEventList';
 export * from './GetCertificateList';
+export * from './GetCertificateTemplateList';
 export * from './GetChatMessage';
 export * from './GetContent';
 export * from './GetContentAttempts';
@@ -106,6 +128,7 @@ export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserFieldValues';
 export * from './GetPortalUserList';
+export * from './GetPublicBadgeCredentialStatus200Response';
 export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
@@ -214,7 +237,13 @@ export * from './PortalUserFieldValueField';
 export * from './PortalUserFieldValueGroup';
 export * from './PortalUserFieldValueInput';
 export * from './PostCertificate';
+export * from './PostCertificateAssetComplete';
+export * from './PostCertificateAssetUpload';
 export * from './PostCertificateConfig';
+export * from './PostCertificateLifecycleAction';
+export * from './PostCertificateTemplate';
+export * from './PostCertificateTemplateClone';
+export * from './PostCertificateTemplatePreview';
 export * from './PostContentQuiz';
 export * from './PostContentQuizAssignment';
 export * from './PostContentQuizQuestionSelection';
@@ -283,7 +312,10 @@ export * from './PostSupportTicketComment';
 export * from './PostVerifyManifest';
 export * from './PostVerifyManifestItemsInner';
 export * from './PostVerifyManifestResourcesInner';
+export * from './PutBadgeIssuer';
 export * from './PutCertificateConfig';
+export * from './PutCertificateTemplate';
+export * from './PutCertificateTemplateDraft';
 export * from './PutContent';
 export * from './PutContentAttemptSettings';
 export * from './PutContentReorder';

package/dist/models/ArtifactConflict.d.ts

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

package/dist/models/ArtifactConflict.js

@@ -0,0 +1,66 @@
+"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.ArtifactConflictCodeEnum = void 0;
+exports.instanceOfArtifactConflict = instanceOfArtifactConflict;
+exports.ArtifactConflictFromJSON = ArtifactConflictFromJSON;
+exports.ArtifactConflictFromJSONTyped = ArtifactConflictFromJSONTyped;
+exports.ArtifactConflictToJSON = ArtifactConflictToJSON;
+exports.ArtifactConflictToJSONTyped = ArtifactConflictToJSONTyped;
+/**
+ * @export
+ */
+exports.ArtifactConflictCodeEnum = {
+    ArtifactPending: 'artifact_pending',
+    ArtifactFailed: 'artifact_failed'
+};
+/**
+ * Check if a given object implements the ArtifactConflict interface.
+ */
+function instanceOfArtifactConflict(value) {
+    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;
+}
+function ArtifactConflictFromJSON(json) {
+    return ArtifactConflictFromJSONTyped(json, false);
+}
+function ArtifactConflictFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': json['code'],
+        'message': json['message'],
+        'retryable': json['retryable'],
+    };
+}
+function ArtifactConflictToJSON(json) {
+    return ArtifactConflictToJSONTyped(json, false);
+}
+function ArtifactConflictToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': value['code'],
+        'message': value['message'],
+        'retryable': value['retryable'],
+    };
+}

package/dist/models/BadgeIssuer.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 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 declare function instanceOfBadgeIssuer(value: object): value is BadgeIssuer;
+export declare function BadgeIssuerFromJSON(json: any): BadgeIssuer;
+export declare function BadgeIssuerFromJSONTyped(json: any, ignoreDiscriminator: boolean): BadgeIssuer;
+export declare function BadgeIssuerToJSON(json: any): BadgeIssuer;
+export declare function BadgeIssuerToJSONTyped(value?: BadgeIssuer | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BadgeIssuer.js

@@ -0,0 +1,76 @@
+"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.instanceOfBadgeIssuer = instanceOfBadgeIssuer;
+exports.BadgeIssuerFromJSON = BadgeIssuerFromJSON;
+exports.BadgeIssuerFromJSONTyped = BadgeIssuerFromJSONTyped;
+exports.BadgeIssuerToJSON = BadgeIssuerToJSON;
+exports.BadgeIssuerToJSONTyped = BadgeIssuerToJSONTyped;
+/**
+ * Check if a given object implements the BadgeIssuer interface.
+ */
+function instanceOfBadgeIssuer(value) {
+    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;
+}
+function BadgeIssuerFromJSON(json) {
+    return BadgeIssuerFromJSONTyped(json, false);
+}
+function BadgeIssuerFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function BadgeIssuerToJSON(json) {
+    return BadgeIssuerToJSONTyped(json, false);
+}
+function BadgeIssuerToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/models/Certificate.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { CertificateArtifact } from './CertificateArtifact';
 /**
  *
  * @export
@@ -69,12 +70,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}
@@ -133,12 +176,23 @@ export declare const CertificateIssuanceReasonEnum: {
     readonly Manual: "manual";
 };
 export type CertificateIssuanceReasonEnum = typeof CertificateIssuanceReasonEnum[keyof typeof CertificateIssuanceReasonEnum];
+/**
+ * @export
+ */
+export declare const CertificateIssuanceTypeEnum: {
+    readonly Original: "original";
+    readonly Renewal: "renewal";
+    readonly Replacement: "replacement";
+    readonly Correction: "correction";
+};
+export type CertificateIssuanceTypeEnum = typeof CertificateIssuanceTypeEnum[keyof typeof CertificateIssuanceTypeEnum];
 /**
  * @export
  */
 export declare const CertificateStatusEnum: {
     readonly Active: "active";
     readonly Revoked: "revoked";
+    readonly Superseded: "superseded";
 };
 export type CertificateStatusEnum = typeof CertificateStatusEnum[keyof typeof CertificateStatusEnum];
 /**

package/dist/models/Certificate.js

@@ -13,12 +13,13 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CertificateStatusEnum = exports.CertificateIssuanceReasonEnum = void 0;
+exports.CertificateStatusEnum = exports.CertificateIssuanceTypeEnum = exports.CertificateIssuanceReasonEnum = void 0;
 exports.instanceOfCertificate = instanceOfCertificate;
 exports.CertificateFromJSON = CertificateFromJSON;
 exports.CertificateFromJSONTyped = CertificateFromJSONTyped;
 exports.CertificateToJSON = CertificateToJSON;
 exports.CertificateToJSONTyped = CertificateToJSONTyped;
+const CertificateArtifact_1 = require("./CertificateArtifact");
 /**
  * @export
  */
@@ -27,12 +28,22 @@ exports.CertificateIssuanceReasonEnum = {
     QuizPassed: 'quiz_passed',
     Manual: 'manual'
 };
+/**
+ * @export
+ */
+exports.CertificateIssuanceTypeEnum = {
+    Original: 'original',
+    Renewal: 'renewal',
+    Replacement: 'replacement',
+    Correction: 'correction'
+};
 /**
  * @export
  */
 exports.CertificateStatusEnum = {
     Active: 'active',
-    Revoked: 'revoked'
+    Revoked: 'revoked',
+    Superseded: 'superseded'
 };
 /**
  * Check if a given object implements the Certificate interface.
@@ -50,8 +61,12 @@ function instanceOfCertificate(value) {
         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)
@@ -81,7 +96,14 @@ function CertificateFromJSONTyped(json, ignoreDiscriminator) {
         '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': (0, CertificateArtifact_1.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'],
@@ -109,7 +131,14 @@ function CertificateToJSONTyped(value, ignoreDiscriminator = false) {
         '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': (0, CertificateArtifact_1.CertificateArtifactToJSON)(value['artifact']),
+        'badge_credential_id': value['badgeCredentialId'],
         'revoked_at': value['revokedAt'],
         'revoked_by_user_id': value['revokedByUserId'],
         'revocation_reason': value['revocationReason'],

package/dist/models/CertificateArtifact.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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 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 declare const CertificateArtifactStatusEnum: {
+    readonly Queued: "queued";
+    readonly Processing: "processing";
+    readonly Ready: "ready";
+    readonly Failed: "failed";
+};
+export type CertificateArtifactStatusEnum = typeof CertificateArtifactStatusEnum[keyof typeof CertificateArtifactStatusEnum];
+/**
+ * Check if a given object implements the CertificateArtifact interface.
+ */
+export declare function instanceOfCertificateArtifact(value: object): value is CertificateArtifact;
+export declare function CertificateArtifactFromJSON(json: any): CertificateArtifact;
+export declare function CertificateArtifactFromJSONTyped(json: any, ignoreDiscriminator: boolean): CertificateArtifact;
+export declare function CertificateArtifactToJSON(json: any): CertificateArtifact;
+export declare function CertificateArtifactToJSONTyped(value?: CertificateArtifact | null, ignoreDiscriminator?: boolean): any;