@easyedu/js-lsm-api 1.49.0 → 1.50.0

package/docs/CertificateApi.md

@@ -0,0 +1,903 @@
+# CertificateApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteCertificateConfig**](CertificateApi.md#deletecertificateconfig) | **DELETE** /certificate-configs/{configId} | Delete a certificate config |
+| [**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 |
+| [**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 |
+| [**postCertificateConfig**](CertificateApi.md#postcertificateconfig) | **POST** /certificate-configs | Create a certificate config |
+| [**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 |
+| [**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) |
+
+
+
+## deleteCertificateConfig
+
+> deleteCertificateConfig(configId)
+
+Delete a certificate config
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteCertificateConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    configId: configId_example,
+  } satisfies DeleteCertificateConfigRequest;
+
+  try {
+    const data = await api.deleteCertificateConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **configId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Deleted |  -  |
+| **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)
+
+
+## getCertificate
+
+> Certificate getCertificate(certificateId)
+
+Get a single certificate
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificateRequest } 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 GetCertificateRequest;
+
+  try {
+    const data = await api.getCertificate(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
+
+[**Certificate**](Certificate.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 |  -  |
+| **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)
+
+
+## getCertificateConfig
+
+> CertificateConfig getCertificateConfig(configId)
+
+Get a certificate config
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificateConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    configId: configId_example,
+  } satisfies GetCertificateConfigRequest;
+
+  try {
+    const data = await api.getCertificateConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **configId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CertificateConfig**](CertificateConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Config details |  -  |
+| **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)
+
+
+## getCertificateConfigs
+
+> GetCertificateConfigList getCertificateConfigs(courseId, scope)
+
+List certificate configs in the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificateConfigsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string (optional)
+    courseId: courseId_example,
+    // 'portal' | 'course' (optional)
+    scope: scope_example,
+  } satisfies GetCertificateConfigsRequest;
+
+  try {
+    const data = await api.getCertificateConfigs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **courseId** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **scope** | `portal`, `course` |  | [Optional] [Defaults to `undefined`] [Enum: portal, course] |
+
+### Return type
+
+[**GetCertificateConfigList**](GetCertificateConfigList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of configs |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[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)
+
+Download certificate as PDF
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificatePdfRequest } 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 GetCertificatePdfRequest;
+
+  try {
+    const data = await api.getCertificatePdf(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`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | PDF file |  -  |
+| **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)
+
+
+## getCertificates
+
+> GetCertificateList getCertificates(userId, courseId, status, issuedAfter, issuedBefore, expiresAfter, expiresBefore, expiringWithinDays)
+
+List certificates in the current portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCertificatesRequest } 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' (optional)
+    status: status_example,
+    // number (optional)
+    issuedAfter: 789,
+    // number (optional)
+    issuedBefore: 789,
+    // number (optional)
+    expiresAfter: 789,
+    // number (optional)
+    expiresBefore: 789,
+    // number (optional)
+    expiringWithinDays: 56,
+  } satisfies GetCertificatesRequest;
+
+  try {
+    const data = await api.getCertificates(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` |  | [Optional] [Defaults to `undefined`] [Enum: active, revoked] |
+| **issuedAfter** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **issuedBefore** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **expiresAfter** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **expiresBefore** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **expiringWithinDays** | `number` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetCertificateList**](GetCertificateList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of certificates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getCurrentUserCertificates
+
+> GetCertificateList getCurrentUserCertificates()
+
+List the authenticated user\'s own certificates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCurrentUserCertificatesRequest } 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.getCurrentUserCertificates();
+    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
+
+[**GetCertificateList**](GetCertificateList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of certificates |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getEffectiveCertificateConfig
+
+> EffectiveCertificateConfig getEffectiveCertificateConfig(courseId)
+
+Resolve effective certificate config for a course
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { GetEffectiveCertificateConfigRequest } 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,
+  } satisfies GetEffectiveCertificateConfigRequest;
+
+  try {
+    const data = await api.getEffectiveCertificateConfig(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`] |
+
+### Return type
+
+[**EffectiveCertificateConfig**](EffectiveCertificateConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Effective config |  -  |
+| **404** | Course 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)
+
+
+## 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)
+
+
+## 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)
+
+
+## putCertificateConfig
+
+> CertificateConfig putCertificateConfig(configId, putCertificateConfig)
+
+Update a certificate config
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { PutCertificateConfigRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CertificateApi();
+
+  const body = {
+    // string
+    configId: configId_example,
+    // PutCertificateConfig
+    putCertificateConfig: ...,
+  } satisfies PutCertificateConfigRequest;
+
+  try {
+    const data = await api.putCertificateConfig(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **configId** | `string` |  | [Defaults to `undefined`] |
+| **putCertificateConfig** | [PutCertificateConfig](PutCertificateConfig.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 |
+|-------------|-------------|------------------|
+| **200** | Updated |  -  |
+| **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)
+
+
+## verifyCertificate
+
+> CertificatePublic verifyCertificate(certificateId)
+
+Public certificate verification (no auth)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CertificateApi,
+} from '@easyedu/js-lsm-api';
+import type { VerifyCertificateRequest } 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 VerifyCertificateRequest;
+
+  try {
+    const data = await api.verifyCertificate(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
+
+[**CertificatePublic**](CertificatePublic.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public certificate details |  -  |
+| **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)
+