@easyedu/js-lsm-api 1.86.0 → 1.88.0

package/docs/CertificateApi.md

@@ -5,16 +5,32 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**deleteCertificateConfig**](CertificateApi.md#deletecertificateconfig) | **DELETE** /certificate-configs/{configId} | Delete a certificate config |
+| [**getBadgeIssuer**](CertificateApi.md#getbadgeissuer) | **GET** /badge-issuer | Get the selected portal Open Badges issuer |
 | [**getCertificate**](CertificateApi.md#getcertificate) | **GET** /certificates/{certificateId} | Get a single certificate |
 | [**getCertificateConfig**](CertificateApi.md#getcertificateconfig) | **GET** /certificate-configs/{configId} | Get a certificate config |
 | [**getCertificateConfigs**](CertificateApi.md#getcertificateconfigs) | **GET** /certificate-configs | List certificate configs in the current portal |
+| [**getCertificateCsvExport**](CertificateApi.md#getcertificatecsvexport) | **GET** /certificates/export | Export filtered certificate records as CSV |
+| [**getCertificateEvents**](CertificateApi.md#getcertificateevents) | **GET** /certificates/{certificateId}/events | List immutable lifecycle events for a certificate |
 | [**getCertificatePdf**](CertificateApi.md#getcertificatepdf) | **GET** /certificates/{certificateId}/pdf | Download certificate as PDF |
 | [**getCertificates**](CertificateApi.md#getcertificates) | **GET** /certificates | List certificates in the current portal |
 | [**getCurrentUserCertificates**](CertificateApi.md#getcurrentusercertificates) | **GET** /certificates/current | List the authenticated user\'s own certificates |
 | [**getEffectiveCertificateConfig**](CertificateApi.md#geteffectivecertificateconfig) | **GET** /courses/{courseId}/certificate-config/effective | Resolve effective certificate config for a course |
+| [**getPublicBadgeAchievement**](CertificateApi.md#getpublicbadgeachievement) | **GET** /public/badge-achievements/{achievementId} | Get a hosted Open Badges Achievement |
+| [**getPublicBadgeAchievementImage**](CertificateApi.md#getpublicbadgeachievementimage) | **GET** /public/badge-achievements/{achievementId}/image | Get a validated square PNG badge image |
+| [**getPublicBadgeCredential**](CertificateApi.md#getpublicbadgecredential) | **GET** /public/badge-credentials/{credentialId} | Download an Open Badges 3.0 VC-JWT |
+| [**getPublicBadgeCredentialDocument**](CertificateApi.md#getpublicbadgecredentialdocument) | **GET** /public/badge-credentials/{credentialId}/document | Read the signed Open Badges credential document |
+| [**getPublicBadgeCredentialStatus**](CertificateApi.md#getpublicbadgecredentialstatus) | **GET** /public/badge-credentials/{credentialId}/status | Get mutable hosted status without changing the signed credential |
+| [**getPublicBadgeIssuer**](CertificateApi.md#getpublicbadgeissuer) | **GET** /public/badge-issuers/{portalId} | Get an Open Badges issuer profile |
+| [**getPublicBadgeIssuerDidDocument**](CertificateApi.md#getpublicbadgeissuerdiddocument) | **GET** /public/badge-issuers/{portalId}/did.json | Get the portal-specific did:web document and retained public keys |
+| [**getPublicCertificatePdf**](CertificateApi.md#getpubliccertificatepdf) | **GET** /public/certificates/{certificateId}/pdf | Download an immutable public certificate PDF |
+| [**postBadgeIssuerKeyRotate**](CertificateApi.md#postbadgeissuerkeyrotate) | **POST** /badge-issuer/keys/rotate | Generate and activate a new KMS-wrapped portal signing key |
+| [**postCertificateArtifactRetry**](CertificateApi.md#postcertificateartifactretry) | **POST** /certificates/{certificateId}/artifacts/retry | Retry failed certificate artifact generation |
 | [**postCertificateConfig**](CertificateApi.md#postcertificateconfig) | **POST** /certificate-configs | Create a certificate config |
+| [**postCertificateRenew**](CertificateApi.md#postcertificaterenew) | **POST** /certificates/{certificateId}/renew | Manually renew an eligible certificate |
+| [**postCertificateReplace**](CertificateApi.md#postcertificatereplace) | **POST** /certificates/{certificateId}/replace | Replace or correct an issued certificate |
 | [**postCourseCertificate**](CertificateApi.md#postcoursecertificate) | **POST** /courses/{courseId}/certificates | Manually issue a certificate for a course |
 | [**postRevokeCertificate**](CertificateApi.md#postrevokecertificate) | **POST** /certificates/{certificateId}/revoke | Revoke a certificate |
+| [**putBadgeIssuer**](CertificateApi.md#putbadgeissuer) | **PUT** /badge-issuer | Create or update the selected portal Open Badges issuer |
 | [**putCertificateConfig**](CertificateApi.md#putcertificateconfig) | **PUT** /certificate-configs/{configId} | Update a certificate config |
 | [**verifyCertificate**](CertificateApi.md#verifycertificate) | **GET** /public/certificates/{certificateId}/verify | Public certificate verification (no auth) |
 
@@ -86,6 +102,64 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getBadgeIssuer
+
+> BadgeIssuer getBadgeIssuer()
+
+Get the selected portal Open Badges issuer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetBadgeIssuerRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  try {
+    const data = await api.getBadgeIssuer();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BadgeIssuer**](BadgeIssuer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Badge issuer |  -  |
+| **404** | Issuer not configured |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCertificate
 
 > Certificate getCertificate(certificateId)
@@ -288,6 +362,148 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getCertificateCsvExport
+
+> Blob getCertificateCsvExport(userId, courseId, status, issuedAfter, issuedBefore)
+
+Export filtered certificate records as CSV
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificateCsvExportRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string (optional)
+    userId: userId_example,
+    // string (optional)
+    courseId: courseId_example,
+    // 'active' | 'revoked' | 'superseded' (optional)
+    status: status_example,
+    // number (optional)
+    issuedAfter: 789,
+    // number (optional)
+    issuedBefore: 789,
+  } satisfies GetCertificateCsvExportRequest;
+
+  try {
+    const data = await api.getCertificateCsvExport(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **status** | `active`, `revoked`, `superseded` |  | [Optional] [Defaults to `undefined`] [Enum: active, revoked, superseded] |
+| **issuedAfter** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **issuedBefore** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/csv`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | CSV export |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCertificateEvents
+
+> GetCertificateEventList getCertificateEvents(certificateId)
+
+List immutable lifecycle events for a certificate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificateEventsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+  } satisfies GetCertificateEventsRequest;
+
+  try {
+    const data = await api.getCertificateEvents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCertificateEventList**](GetCertificateEventList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Certificate event history |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCertificatePdf
 
 > Blob getCertificatePdf(certificateId)
@@ -342,7 +558,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/pdf`
+- **Accept**: `application/pdf`, `application/json`
 
 
 ### HTTP response details
@@ -350,6 +566,7 @@ No authorization required
 |-------------|-------------|------------------|
 | **200** | PDF file |  -  |
 | **404** | Not found |  -  |
+| **409** | Artifact has not completed successfully |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -378,7 +595,7 @@ async function example() {
     userId: userId_example,
     // string (optional)
     courseId: courseId_example,
-    // 'active' | 'revoked' (optional)
+    // 'active' | 'revoked' | 'superseded' (optional)
     status: status_example,
     // number (optional)
     issuedAfter: 789,
@@ -411,7 +628,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **userId** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |
-| **status** | `active`, `revoked` |  | [Optional] [Defaults to `undefined`] [Enum: active, revoked] |
+| **status** | `active`, `revoked`, `superseded` |  | [Optional] [Defaults to `undefined`] [Enum: active, revoked, superseded] |
 | **issuedAfter** | `number` |  | [Optional] [Defaults to `undefined`] |
 | **issuedBefore** | `number` |  | [Optional] [Defaults to `undefined`] |
 | **expiresAfter** | `number` |  | [Optional] [Defaults to `undefined`] |
@@ -563,11 +780,11 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## postCertificateConfig
+## getPublicBadgeAchievement
 
-> CertificateConfig postCertificateConfig(postCertificateConfig)
+> { [key: string]: any; } getPublicBadgeAchievement(achievementId)
 
-Create a certificate config
+Get a hosted Open Badges Achievement
 
 ### Example
 
@@ -576,19 +793,19 @@ import {
   Configuration,
   CertificateApi,
 } from '@easyedu/js-lsm-api';
-import type { PostCertificateConfigRequest } from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeAchievementRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CertificateApi();
 
   const body = {
-    // PostCertificateConfig
-    postCertificateConfig: ...,
-  } satisfies PostCertificateConfigRequest;
+    // string
+    achievementId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicBadgeAchievementRequest;
 
   try {
-    const data = await api.postCertificateConfig(body);
+    const data = await api.getPublicBadgeAchievement(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -604,11 +821,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **postCertificateConfig** | [PostCertificateConfig](PostCertificateConfig.md) |  | |
+| **achievementId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**CertificateConfig**](CertificateConfig.md)
+**{ [key: string]: any; }**
 
 ### Authorization
 
@@ -616,24 +833,24 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
+- **Content-Type**: Not defined
 - **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **201** | Config created |  -  |
-| **409** | Config already exists for this scope |  -  |
+| **200** | Open Badges Achievement |  -  |
+| **404** | Achievement not found |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## postCourseCertificate
+## getPublicBadgeAchievementImage
 
-> Certificate postCourseCertificate(courseId, postCertificate)
+> Blob getPublicBadgeAchievementImage(achievementId)
 
-Manually issue a certificate for a course
+Get a validated square PNG badge image
 
 ### Example
 
@@ -642,7 +859,7 @@ import {
   Configuration,
   CertificateApi,
 } from '@easyedu/js-lsm-api';
-import type { PostCourseCertificateRequest } from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeAchievementImageRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -650,13 +867,11 @@ async function example() {
 
   const body = {
     // string
-    courseId: courseId_example,
-    // PostCertificate
-    postCertificate: ...,
-  } satisfies PostCourseCertificateRequest;
+    achievementId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicBadgeAchievementImageRequest;
 
   try {
-    const data = await api.postCourseCertificate(body);
+    const data = await api.getPublicBadgeAchievementImage(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -672,12 +887,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **courseId** | `string` |  | [Defaults to `undefined`] |
-| **postCertificate** | [PostCertificate](PostCertificate.md) |  | |
+| **achievementId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**Certificate**](Certificate.md)
+**Blob**
 
 ### Authorization
 
@@ -685,24 +899,23 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
+- **Content-Type**: Not defined
+- **Accept**: `image/png`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **201** | Certificate issued |  -  |
-| **409** | Active certificate already exists for this user and course |  -  |
+| **200** | Badge PNG |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## postRevokeCertificate
+## getPublicBadgeCredential
 
-> Certificate postRevokeCertificate(certificateId, postRevokeCertificate)
+> string getPublicBadgeCredential(credentialId)
 
-Revoke a certificate
+Download an Open Badges 3.0 VC-JWT
 
 ### Example
 
@@ -711,7 +924,7 @@ import {
   Configuration,
   CertificateApi,
 } from '@easyedu/js-lsm-api';
-import type { PostRevokeCertificateRequest } from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeCredentialRequest } from '@easyedu/js-lsm-api';
 
 async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
@@ -719,13 +932,11 @@ async function example() {
 
   const body = {
     // string
-    certificateId: certificateId_example,
-    // PostRevokeCertificate
-    postRevokeCertificate: ...,
-  } satisfies PostRevokeCertificateRequest;
+    credentialId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicBadgeCredentialRequest;
 
   try {
-    const data = await api.postRevokeCertificate(body);
+    const data = await api.getPublicBadgeCredential(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -741,12 +952,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **certificateId** | `string` |  | [Defaults to `undefined`] |
-| **postRevokeCertificate** | [PostRevokeCertificate](PostRevokeCertificate.md) |  | |
+| **credentialId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**Certificate**](Certificate.md)
+**string**
 
 ### Authorization
 
@@ -754,15 +964,876 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
+- **Content-Type**: Not defined
+- **Accept**: `application/vc+jwt`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Revoked |  -  |
-| **404** | Not found |  -  |
+| **200** | Compact signed VC-JWT |  -  |
+| **404** | Credential not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicBadgeCredentialDocument
+
+> { [key: string]: any; } getPublicBadgeCredentialDocument(credentialId)
+
+Read the signed Open Badges credential document
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeCredentialDocumentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    credentialId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicBadgeCredentialDocumentRequest;
+
+  try {
+    const data = await api.getPublicBadgeCredentialDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **credentialId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OpenBadgeCredential JSON document |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicBadgeCredentialStatus
+
+> GetPublicBadgeCredentialStatus200Response getPublicBadgeCredentialStatus(credentialId)
+
+Get mutable hosted status without changing the signed credential
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeCredentialStatusRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    credentialId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetPublicBadgeCredentialStatusRequest;
+
+  try {
+    const data = await api.getPublicBadgeCredentialStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **credentialId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPublicBadgeCredentialStatus200Response**](GetPublicBadgeCredentialStatus200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Hosted credential status |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicBadgeIssuer
+
+> { [key: string]: any; } getPublicBadgeIssuer(portalId)
+
+Get an Open Badges issuer profile
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeIssuerRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPublicBadgeIssuerRequest;
+
+  try {
+    const data = await api.getPublicBadgeIssuer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Open Badges Profile |  -  |
+| **404** | Issuer not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicBadgeIssuerDidDocument
+
+> { [key: string]: any; } getPublicBadgeIssuerDidDocument(portalId)
+
+Get the portal-specific did:web document and retained public keys
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicBadgeIssuerDidDocumentRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    portalId: portalId_example,
+  } satisfies GetPublicBadgeIssuerDidDocumentRequest;
+
+  try {
+    const data = await api.getPublicBadgeIssuerDidDocument(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **portalId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/did+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | did:web document |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getPublicCertificatePdf
+
+> Blob getPublicCertificatePdf(certificateId)
+
+Download an immutable public certificate PDF
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicCertificatePdfRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+  } satisfies GetPublicCertificatePdfRequest;
+
+  try {
+    const data = await api.getPublicCertificatePdf(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/pdf`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Stored PDF |  -  |
+| **404** | Certificate not found |  -  |
+| **409** | Artifact has not completed successfully |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postBadgeIssuerKeyRotate
+
+> BadgeIssuer postBadgeIssuerKeyRotate()
+
+Generate and activate a new KMS-wrapped portal signing key
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostBadgeIssuerKeyRotateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  try {
+    const data = await api.postBadgeIssuerKeyRotate();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BadgeIssuer**](BadgeIssuer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Issuer with the new active key |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCertificateArtifactRetry
+
+> CertificateArtifact postCertificateArtifactRetry(certificateId)
+
+Retry failed certificate artifact generation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCertificateArtifactRetryRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+  } satisfies PostCertificateArtifactRetryRequest;
+
+  try {
+    const data = await api.postCertificateArtifactRetry(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CertificateArtifact**](CertificateArtifact.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Artifact generation queued |  -  |
+| **409** | Artifact is not failed |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCertificateConfig
+
+> CertificateConfig postCertificateConfig(postCertificateConfig)
+
+Create a certificate config
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCertificateConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // PostCertificateConfig
+    postCertificateConfig: ...,
+  } satisfies PostCertificateConfigRequest;
+
+  try {
+    const data = await api.postCertificateConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postCertificateConfig** | [PostCertificateConfig](PostCertificateConfig.md) |  | |
+
+### Return type
+
+[**CertificateConfig**](CertificateConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Config created |  -  |
+| **409** | Config already exists for this scope |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCertificateRenew
+
+> Certificate postCertificateRenew(certificateId, postCertificateLifecycleAction)
+
+Manually renew an eligible certificate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCertificateRenewRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+    // PostCertificateLifecycleAction
+    postCertificateLifecycleAction: ...,
+  } satisfies PostCertificateRenewRequest;
+
+  try {
+    const data = await api.postCertificateRenew(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+| **postCertificateLifecycleAction** | [PostCertificateLifecycleAction](PostCertificateLifecycleAction.md) |  | |
+
+### Return type
+
+[**Certificate**](Certificate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Renewal issued |  -  |
+| **409** | Certificate is not eligible for renewal |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCertificateReplace
+
+> Certificate postCertificateReplace(certificateId, postCertificateLifecycleAction, correction)
+
+Replace or correct an issued certificate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCertificateReplaceRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+    // PostCertificateLifecycleAction
+    postCertificateLifecycleAction: ...,
+    // boolean (optional)
+    correction: true,
+  } satisfies PostCertificateReplaceRequest;
+
+  try {
+    const data = await api.postCertificateReplace(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+| **postCertificateLifecycleAction** | [PostCertificateLifecycleAction](PostCertificateLifecycleAction.md) |  | |
+| **correction** | `boolean` |  | [Optional] [Defaults to `false`] |
+
+### Return type
+
+[**Certificate**](Certificate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Replacement or correction issued |  -  |
+| **409** | Certificate already has a successor |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postCourseCertificate
+
+> Certificate postCourseCertificate(courseId, postCertificate)
+
+Manually issue a certificate for a course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostCourseCertificateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    courseId: courseId_example,
+    // PostCertificate
+    postCertificate: ...,
+  } satisfies PostCourseCertificateRequest;
+
+  try {
+    const data = await api.postCourseCertificate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Defaults to `undefined`] |
+| **postCertificate** | [PostCertificate](PostCertificate.md) |  | |
+
+### Return type
+
+[**Certificate**](Certificate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Certificate issued |  -  |
+| **409** | Active certificate already exists for this user and course |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postRevokeCertificate
+
+> Certificate postRevokeCertificate(certificateId, postRevokeCertificate)
+
+Revoke a certificate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PostRevokeCertificateRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    certificateId: certificateId_example,
+    // PostRevokeCertificate
+    postRevokeCertificate: ...,
+  } satisfies PostRevokeCertificateRequest;
+
+  try {
+    const data = await api.postRevokeCertificate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **certificateId** | `string` |  | [Defaults to `undefined`] |
+| **postRevokeCertificate** | [PostRevokeCertificate](PostRevokeCertificate.md) |  | |
+
+### Return type
+
+[**Certificate**](Certificate.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Revoked |  -  |
+| **404** | Not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putBadgeIssuer
+
+> BadgeIssuer putBadgeIssuer(putBadgeIssuer)
+
+Create or update the selected portal Open Badges issuer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutBadgeIssuerRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // PutBadgeIssuer
+    putBadgeIssuer: ...,
+  } satisfies PutBadgeIssuerRequest;
+
+  try {
+    const data = await api.putBadgeIssuer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **putBadgeIssuer** | [PutBadgeIssuer](PutBadgeIssuer.md) |  | |
+
+### Return type
+
+[**BadgeIssuer**](BadgeIssuer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Badge issuer |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)