@easyedu/js-lsm-api 1.49.0 → 1.51.0

package/docs/CertificateConfig.md

@@ -0,0 +1,52 @@
+
+# CertificateConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`portalId` | string
+`courseId` | string
+`enabled` | boolean
+`expiryMonths` | number
+`requireQuizPass` | boolean
+`minQuizScore` | number
+`quizConfigId` | string
+`createdAt` | number
+`updatedAt` | number
+
+## Example
+
+```typescript
+import type { CertificateConfig } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "portalId": null,
+  "courseId": null,
+  "enabled": null,
+  "expiryMonths": null,
+  "requireQuizPass": null,
+  "minQuizScore": null,
+  "quizConfigId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies CertificateConfig
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CertificateConfig
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/CertificatePublic.md

@@ -0,0 +1,51 @@
+
+# CertificatePublic
+
+Public certificate verification view (no internal IDs)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`status` | string
+`learnerName` | string
+`courseName` | string
+`portalName` | string
+`issuanceReason` | string
+`issuedAt` | number
+`expiresAt` | number
+`revokedAt` | number
+
+## Example
+
+```typescript
+import type { CertificatePublic } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "status": null,
+  "learnerName": null,
+  "courseName": null,
+  "portalName": null,
+  "issuanceReason": null,
+  "issuedAt": null,
+  "expiresAt": null,
+  "revokedAt": null,
+} satisfies CertificatePublic
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as CertificatePublic
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EffectiveCertificateConfig.md

@@ -0,0 +1,45 @@
+
+# EffectiveCertificateConfig
+
+Resolved effective config for a course (course override merged with portal default)
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`expiryMonths` | number
+`requireQuizPass` | boolean
+`minQuizScore` | number
+`quizConfigId` | string
+`sourceConfigId` | string
+
+## Example
+
+```typescript
+import type { EffectiveCertificateConfig } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "expiryMonths": null,
+  "requireQuizPass": null,
+  "minQuizScore": null,
+  "quizConfigId": null,
+  "sourceConfigId": null,
+} satisfies EffectiveCertificateConfig
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EffectiveCertificateConfig
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetCertificateConfigList.md

@@ -0,0 +1,34 @@
+
+# GetCertificateConfigList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<CertificateConfig>](CertificateConfig.md)
+
+## Example
+
+```typescript
+import type { GetCertificateConfigList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetCertificateConfigList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCertificateConfigList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetCertificateList.md

@@ -0,0 +1,34 @@
+
+# GetCertificateList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<Certificate>](Certificate.md)
+
+## Example
+
+```typescript
+import type { GetCertificateList } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+} satisfies GetCertificateList
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetCertificateList
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostCertificate.md

@@ -0,0 +1,41 @@
+
+# PostCertificate
+
+Manually issue a certificate
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`expiresAt` | number
+`issuedAt` | number
+`note` | string
+
+## Example
+
+```typescript
+import type { PostCertificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "expiresAt": null,
+  "issuedAt": null,
+  "note": null,
+} satisfies PostCertificate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostCertificate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostCertificateConfig.md

@@ -0,0 +1,44 @@
+
+# PostCertificateConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`courseId` | string
+`enabled` | boolean
+`expiryMonths` | number
+`requireQuizPass` | boolean
+`minQuizScore` | number
+`quizConfigId` | string
+
+## Example
+
+```typescript
+import type { PostCertificateConfig } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "courseId": null,
+  "enabled": null,
+  "expiryMonths": null,
+  "requireQuizPass": null,
+  "minQuizScore": null,
+  "quizConfigId": null,
+} satisfies PostCertificateConfig
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostCertificateConfig
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PostRevokeCertificate.md

@@ -0,0 +1,34 @@
+
+# PostRevokeCertificate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reason` | string
+
+## Example
+
+```typescript
+import type { PostRevokeCertificate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reason": null,
+} satisfies PostRevokeCertificate
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PostRevokeCertificate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/PutCertificateConfig.md

@@ -0,0 +1,42 @@
+
+# PutCertificateConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`expiryMonths` | number
+`requireQuizPass` | boolean
+`minQuizScore` | number
+`quizConfigId` | string
+
+## Example
+
+```typescript
+import type { PutCertificateConfig } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "expiryMonths": null,
+  "requireQuizPass": null,
+  "minQuizScore": null,
+  "quizConfigId": null,
+} satisfies PutCertificateConfig
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as PutCertificateConfig
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.49.0",
+  "version": "1.51.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {