@easyedu/js-lsm-api 1.86.0 → 1.87.0

package/dist/apis/CertificateApi.d.ts

@@ -10,15 +10,21 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
+import { type BadgeIssuer } from '../models/BadgeIssuer';
 import { type Certificate } from '../models/Certificate';
+import { type CertificateArtifact } from '../models/CertificateArtifact';
 import { type CertificateConfig } from '../models/CertificateConfig';
 import { type CertificatePublic } from '../models/CertificatePublic';
 import { type EffectiveCertificateConfig } from '../models/EffectiveCertificateConfig';
 import { type GetCertificateConfigList } from '../models/GetCertificateConfigList';
+import { type GetCertificateEventList } from '../models/GetCertificateEventList';
 import { type GetCertificateList } from '../models/GetCertificateList';
+import { type GetPublicBadgeCredentialStatus200Response } from '../models/GetPublicBadgeCredentialStatus200Response';
 import { type PostCertificate } from '../models/PostCertificate';
 import { type PostCertificateConfig } from '../models/PostCertificateConfig';
+import { type PostCertificateLifecycleAction } from '../models/PostCertificateLifecycleAction';
 import { type PostRevokeCertificate } from '../models/PostRevokeCertificate';
+import { type PutBadgeIssuer } from '../models/PutBadgeIssuer';
 import { type PutCertificateConfig } from '../models/PutCertificateConfig';
 export interface DeleteCertificateConfigRequest {
     configId: string;
@@ -33,6 +39,16 @@ export interface GetCertificateConfigsRequest {
     courseId?: string;
     scope?: GetCertificateConfigsScopeEnum;
 }
+export interface GetCertificateCsvExportRequest {
+    userId?: string;
+    courseId?: string;
+    status?: GetCertificateCsvExportStatusEnum;
+    issuedAfter?: number;
+    issuedBefore?: number;
+}
+export interface GetCertificateEventsRequest {
+    certificateId: string;
+}
 export interface GetCertificatePdfRequest {
     certificateId: string;
 }
@@ -49,9 +65,45 @@ export interface GetCertificatesRequest {
 export interface GetEffectiveCertificateConfigRequest {
     courseId: string;
 }
+export interface GetPublicBadgeAchievementRequest {
+    achievementId: string;
+}
+export interface GetPublicBadgeAchievementImageRequest {
+    achievementId: string;
+}
+export interface GetPublicBadgeCredentialRequest {
+    credentialId: string;
+}
+export interface GetPublicBadgeCredentialDocumentRequest {
+    credentialId: string;
+}
+export interface GetPublicBadgeCredentialStatusRequest {
+    credentialId: string;
+}
+export interface GetPublicBadgeIssuerRequest {
+    portalId: string;
+}
+export interface GetPublicBadgeIssuerDidDocumentRequest {
+    portalId: string;
+}
+export interface GetPublicCertificatePdfRequest {
+    certificateId: string;
+}
+export interface PostCertificateArtifactRetryRequest {
+    certificateId: string;
+}
 export interface PostCertificateConfigRequest {
     postCertificateConfig: PostCertificateConfig;
 }
+export interface PostCertificateRenewRequest {
+    certificateId: string;
+    postCertificateLifecycleAction: PostCertificateLifecycleAction;
+}
+export interface PostCertificateReplaceRequest {
+    certificateId: string;
+    postCertificateLifecycleAction: PostCertificateLifecycleAction;
+    correction?: boolean;
+}
 export interface PostCourseCertificateRequest {
     courseId: string;
     postCertificate: PostCertificate;
@@ -60,6 +112,9 @@ export interface PostRevokeCertificateRequest {
     certificateId: string;
     postRevokeCertificate: PostRevokeCertificate;
 }
+export interface PutBadgeIssuerRequest {
+    putBadgeIssuer: PutBadgeIssuer;
+}
 export interface PutCertificateConfigRequest {
     configId: string;
     putCertificateConfig: PutCertificateConfig;
@@ -83,6 +138,18 @@ export declare class CertificateApi extends runtime.BaseAPI {
      * Delete a certificate config
      */
     deleteCertificateConfig(requestParameters: DeleteCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getBadgeIssuer without sending the request
+     */
+    getBadgeIssuerRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Get the selected portal Open Badges issuer
+     */
+    getBadgeIssuerRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>>;
+    /**
+     * Get the selected portal Open Badges issuer
+     */
+    getBadgeIssuer(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer>;
     /**
      * Creates request options for getCertificate without sending the request
      */
@@ -119,6 +186,30 @@ export declare class CertificateApi extends runtime.BaseAPI {
      * List certificate configs in the current portal
      */
     getCertificateConfigs(requestParameters?: GetCertificateConfigsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateConfigList>;
+    /**
+     * Creates request options for getCertificateCsvExport without sending the request
+     */
+    getCertificateCsvExportRequestOpts(requestParameters: GetCertificateCsvExportRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Export filtered certificate records as CSV
+     */
+    getCertificateCsvExportRaw(requestParameters: GetCertificateCsvExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Export filtered certificate records as CSV
+     */
+    getCertificateCsvExport(requestParameters?: GetCertificateCsvExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getCertificateEvents without sending the request
+     */
+    getCertificateEventsRequestOpts(requestParameters: GetCertificateEventsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List immutable lifecycle events for a certificate
+     */
+    getCertificateEventsRaw(requestParameters: GetCertificateEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCertificateEventList>>;
+    /**
+     * List immutable lifecycle events for a certificate
+     */
+    getCertificateEvents(requestParameters: GetCertificateEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateEventList>;
     /**
      * Creates request options for getCertificatePdf without sending the request
      */
@@ -167,6 +258,142 @@ export declare class CertificateApi extends runtime.BaseAPI {
      * Resolve effective certificate config for a course
      */
     getEffectiveCertificateConfig(requestParameters: GetEffectiveCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EffectiveCertificateConfig>;
+    /**
+     * Creates request options for getPublicBadgeAchievement without sending the request
+     */
+    getPublicBadgeAchievementRequestOpts(requestParameters: GetPublicBadgeAchievementRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a hosted Open Badges Achievement
+     */
+    getPublicBadgeAchievementRaw(requestParameters: GetPublicBadgeAchievementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get a hosted Open Badges Achievement
+     */
+    getPublicBadgeAchievement(requestParameters: GetPublicBadgeAchievementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Creates request options for getPublicBadgeAchievementImage without sending the request
+     */
+    getPublicBadgeAchievementImageRequestOpts(requestParameters: GetPublicBadgeAchievementImageRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get a validated square PNG badge image
+     */
+    getPublicBadgeAchievementImageRaw(requestParameters: GetPublicBadgeAchievementImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Get a validated square PNG badge image
+     */
+    getPublicBadgeAchievementImage(requestParameters: GetPublicBadgeAchievementImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for getPublicBadgeCredential without sending the request
+     */
+    getPublicBadgeCredentialRequestOpts(requestParameters: GetPublicBadgeCredentialRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Download an Open Badges 3.0 VC-JWT
+     */
+    getPublicBadgeCredentialRaw(requestParameters: GetPublicBadgeCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Download an Open Badges 3.0 VC-JWT
+     */
+    getPublicBadgeCredential(requestParameters: GetPublicBadgeCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Creates request options for getPublicBadgeCredentialDocument without sending the request
+     */
+    getPublicBadgeCredentialDocumentRequestOpts(requestParameters: GetPublicBadgeCredentialDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Read the signed Open Badges credential document
+     */
+    getPublicBadgeCredentialDocumentRaw(requestParameters: GetPublicBadgeCredentialDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Read the signed Open Badges credential document
+     */
+    getPublicBadgeCredentialDocument(requestParameters: GetPublicBadgeCredentialDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Creates request options for getPublicBadgeCredentialStatus without sending the request
+     */
+    getPublicBadgeCredentialStatusRequestOpts(requestParameters: GetPublicBadgeCredentialStatusRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get mutable hosted status without changing the signed credential
+     */
+    getPublicBadgeCredentialStatusRaw(requestParameters: GetPublicBadgeCredentialStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicBadgeCredentialStatus200Response>>;
+    /**
+     * Get mutable hosted status without changing the signed credential
+     */
+    getPublicBadgeCredentialStatus(requestParameters: GetPublicBadgeCredentialStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicBadgeCredentialStatus200Response>;
+    /**
+     * Creates request options for getPublicBadgeIssuer without sending the request
+     */
+    getPublicBadgeIssuerRequestOpts(requestParameters: GetPublicBadgeIssuerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get an Open Badges issuer profile
+     */
+    getPublicBadgeIssuerRaw(requestParameters: GetPublicBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get an Open Badges issuer profile
+     */
+    getPublicBadgeIssuer(requestParameters: GetPublicBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Creates request options for getPublicBadgeIssuerDidDocument without sending the request
+     */
+    getPublicBadgeIssuerDidDocumentRequestOpts(requestParameters: GetPublicBadgeIssuerDidDocumentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the portal-specific did:web document and retained public keys
+     */
+    getPublicBadgeIssuerDidDocumentRaw(requestParameters: GetPublicBadgeIssuerDidDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get the portal-specific did:web document and retained public keys
+     */
+    getPublicBadgeIssuerDidDocument(requestParameters: GetPublicBadgeIssuerDidDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Creates request options for getPublicCertificatePdf without sending the request
+     */
+    getPublicCertificatePdfRequestOpts(requestParameters: GetPublicCertificatePdfRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Download an immutable public certificate PDF
+     */
+    getPublicCertificatePdfRaw(requestParameters: GetPublicCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Download an immutable public certificate PDF
+     */
+    getPublicCertificatePdf(requestParameters: GetPublicCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+    /**
+     * Creates request options for postBadgeIssuerKeyRotate without sending the request
+     */
+    postBadgeIssuerKeyRotateRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Generate and activate a new KMS-wrapped portal signing key
+     */
+    postBadgeIssuerKeyRotateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>>;
+    /**
+     * Generate and activate a new KMS-wrapped portal signing key
+     */
+    postBadgeIssuerKeyRotate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer>;
+    /**
+     * Creates request options for postCertificateArtifactRetry without sending the request
+     */
+    postCertificateArtifactRetryRequestOpts(requestParameters: PostCertificateArtifactRetryRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Retry failed certificate artifact generation
+     */
+    postCertificateArtifactRetryRaw(requestParameters: PostCertificateArtifactRetryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateArtifact>>;
+    /**
+     * Retry failed certificate artifact generation
+     */
+    postCertificateArtifactRetry(requestParameters: PostCertificateArtifactRetryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateArtifact>;
     /**
      * Creates request options for postCertificateConfig without sending the request
      */
@@ -179,6 +406,30 @@ export declare class CertificateApi extends runtime.BaseAPI {
      * Create a certificate config
      */
     postCertificateConfig(requestParameters: PostCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig>;
+    /**
+     * Creates request options for postCertificateRenew without sending the request
+     */
+    postCertificateRenewRequestOpts(requestParameters: PostCertificateRenewRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Manually renew an eligible certificate
+     */
+    postCertificateRenewRaw(requestParameters: PostCertificateRenewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>>;
+    /**
+     * Manually renew an eligible certificate
+     */
+    postCertificateRenew(requestParameters: PostCertificateRenewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
+    /**
+     * Creates request options for postCertificateReplace without sending the request
+     */
+    postCertificateReplaceRequestOpts(requestParameters: PostCertificateReplaceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Replace or correct an issued certificate
+     */
+    postCertificateReplaceRaw(requestParameters: PostCertificateReplaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>>;
+    /**
+     * Replace or correct an issued certificate
+     */
+    postCertificateReplace(requestParameters: PostCertificateReplaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
     /**
      * Creates request options for postCourseCertificate without sending the request
      */
@@ -203,6 +454,18 @@ export declare class CertificateApi extends runtime.BaseAPI {
      * Revoke a certificate
      */
     postRevokeCertificate(requestParameters: PostRevokeCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate>;
+    /**
+     * Creates request options for putBadgeIssuer without sending the request
+     */
+    putBadgeIssuerRequestOpts(requestParameters: PutBadgeIssuerRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create or update the selected portal Open Badges issuer
+     */
+    putBadgeIssuerRaw(requestParameters: PutBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>>;
+    /**
+     * Create or update the selected portal Open Badges issuer
+     */
+    putBadgeIssuer(requestParameters: PutBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer>;
     /**
      * Creates request options for putCertificateConfig without sending the request
      */
@@ -236,11 +499,21 @@ export declare const GetCertificateConfigsScopeEnum: {
     readonly Course: "course";
 };
 export type GetCertificateConfigsScopeEnum = typeof GetCertificateConfigsScopeEnum[keyof typeof GetCertificateConfigsScopeEnum];
+/**
+ * @export
+ */
+export declare const GetCertificateCsvExportStatusEnum: {
+    readonly Active: "active";
+    readonly Revoked: "revoked";
+    readonly Superseded: "superseded";
+};
+export type GetCertificateCsvExportStatusEnum = typeof GetCertificateCsvExportStatusEnum[keyof typeof GetCertificateCsvExportStatusEnum];
 /**
  * @export
  */
 export declare const GetCertificatesStatusEnum: {
     readonly Active: "active";
     readonly Revoked: "revoked";
+    readonly Superseded: "superseded";
 };
 export type GetCertificatesStatusEnum = typeof GetCertificatesStatusEnum[keyof typeof GetCertificatesStatusEnum];