@easyedu/js-lsm-api 1.86.0 → 1.88.0

package/docs/CertificateArtifact.md

@@ -0,0 +1,44 @@
+
+# CertificateArtifact
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`byteSize` | number
+`checksumSha256` | string
+`rendererVersion` | string
+`generatedAt` | number
+`lastErrorCode` | string
+
+## Example
+
+```typescript
+import type { CertificateArtifact } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "byteSize": null,
+  "checksumSha256": null,
+  "rendererVersion": null,
+  "generatedAt": null,
+  "lastErrorCode": null,
+} satisfies CertificateArtifact
+
+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 CertificateArtifact
+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/CertificateBadgePolicy.md

@@ -0,0 +1,46 @@
+
+# CertificateBadgePolicy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`criteria` | string
+`imageAssetId` | string
+`description` | string
+`tags` | Array<string>
+`skills` | Array<string>
+`alignments` | [Array<CertificateBadgePolicyAlignmentsInner>](CertificateBadgePolicyAlignmentsInner.md)
+
+## Example
+
+```typescript
+import type { CertificateBadgePolicy } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "criteria": null,
+  "imageAssetId": null,
+  "description": null,
+  "tags": null,
+  "skills": null,
+  "alignments": null,
+} satisfies CertificateBadgePolicy
+
+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 CertificateBadgePolicy
+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/CertificateBadgePolicyAlignmentsInner.md

@@ -0,0 +1,40 @@
+
+# CertificateBadgePolicyAlignmentsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`targetName` | string
+`targetUrl` | string
+`targetFramework` | string
+`targetCode` | string
+
+## Example
+
+```typescript
+import type { CertificateBadgePolicyAlignmentsInner } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "targetName": null,
+  "targetUrl": null,
+  "targetFramework": null,
+  "targetCode": null,
+} satisfies CertificateBadgePolicyAlignmentsInner
+
+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 CertificateBadgePolicyAlignmentsInner
+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/CertificateCanvasDocument.md

@@ -0,0 +1,39 @@
+
+# CertificateCanvasDocument
+
+Constrained fixed-page certificate-canvas-v1 document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`format` | string
+`page` | [CertificateCanvasDocumentPage](CertificateCanvasDocumentPage.md)
+`elements` | [Array<CertificateCanvasElement>](CertificateCanvasElement.md)
+
+## Example
+
+```typescript
+import type { CertificateCanvasDocument } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "format": null,
+  "page": null,
+  "elements": null,
+} satisfies CertificateCanvasDocument
+
+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 CertificateCanvasDocument
+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/CertificateCanvasDocumentPage.md

@@ -0,0 +1,38 @@
+
+# CertificateCanvasDocumentPage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`size` | string
+`orientation` | string
+`backgroundColor` | string
+
+## Example
+
+```typescript
+import type { CertificateCanvasDocumentPage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "size": null,
+  "orientation": null,
+  "backgroundColor": null,
+} satisfies CertificateCanvasDocumentPage
+
+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 CertificateCanvasDocumentPage
+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/CertificateCanvasElement.md

@@ -0,0 +1,65 @@
+
+# CertificateCanvasElement
+
+A constrained certificate-canvas-v1 element.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+`text` | string
+`fontFamily` | string
+`fontSize` | number
+`color` | string
+`align` | string
+`assetId` | string
+`fit` | string
+`strokeWidth` | number
+`fillColor` | string
+`strokeColor` | string
+
+## Example
+
+```typescript
+import type { CertificateCanvasElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+  "text": null,
+  "fontFamily": null,
+  "fontSize": null,
+  "color": null,
+  "align": null,
+  "assetId": null,
+  "fit": null,
+  "strokeWidth": null,
+  "fillColor": null,
+  "strokeColor": null,
+} satisfies CertificateCanvasElement
+
+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 CertificateCanvasElement
+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/CertificateCanvasImageElement.md

@@ -0,0 +1,48 @@
+
+# CertificateCanvasImageElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+`assetId` | string
+`fit` | string
+
+## Example
+
+```typescript
+import type { CertificateCanvasImageElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+  "assetId": null,
+  "fit": null,
+} satisfies CertificateCanvasImageElement
+
+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 CertificateCanvasImageElement
+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/CertificateCanvasLineElement.md

@@ -0,0 +1,48 @@
+
+# CertificateCanvasLineElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+`color` | string
+`strokeWidth` | number
+
+## Example
+
+```typescript
+import type { CertificateCanvasLineElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+  "color": null,
+  "strokeWidth": null,
+} satisfies CertificateCanvasLineElement
+
+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 CertificateCanvasLineElement
+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/CertificateCanvasPortalLogoElement.md

@@ -0,0 +1,44 @@
+
+# CertificateCanvasPortalLogoElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { CertificateCanvasPortalLogoElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+} satisfies CertificateCanvasPortalLogoElement
+
+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 CertificateCanvasPortalLogoElement
+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/CertificateCanvasShapeElement.md

@@ -0,0 +1,50 @@
+
+# CertificateCanvasShapeElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+`fillColor` | string
+`strokeColor` | string
+`strokeWidth` | number
+
+## Example
+
+```typescript
+import type { CertificateCanvasShapeElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+  "fillColor": null,
+  "strokeColor": null,
+  "strokeWidth": null,
+} satisfies CertificateCanvasShapeElement
+
+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 CertificateCanvasShapeElement
+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/CertificateCanvasTextElement.md

@@ -0,0 +1,54 @@
+
+# CertificateCanvasTextElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+`text` | string
+`fontFamily` | string
+`fontSize` | number
+`color` | string
+`align` | string
+
+## Example
+
+```typescript
+import type { CertificateCanvasTextElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+  "text": null,
+  "fontFamily": null,
+  "fontSize": null,
+  "color": null,
+  "align": null,
+} satisfies CertificateCanvasTextElement
+
+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 CertificateCanvasTextElement
+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/CertificateCanvasVerificationQrElement.md

@@ -0,0 +1,44 @@
+
+# CertificateCanvasVerificationQrElement
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | string
+`x` | number
+`y` | number
+`width` | number
+`height` | number
+
+## Example
+
+```typescript
+import type { CertificateCanvasVerificationQrElement } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "x": null,
+  "y": null,
+  "width": null,
+  "height": null,
+} satisfies CertificateCanvasVerificationQrElement
+
+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 CertificateCanvasVerificationQrElement
+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/CertificateConfig.md

@@ -14,6 +14,10 @@ Name | Type
 `requireQuizPass` | boolean
 `minQuizScore` | number
 `quizConfigId` | string
+`certificateTemplateId` | string
+`renewalPolicy` | [CertificateRenewalPolicy](CertificateRenewalPolicy.md)
+`notificationPolicy` | [CertificateNotificationPolicy](CertificateNotificationPolicy.md)
+`badgePolicy` | [CertificateBadgePolicy](CertificateBadgePolicy.md)
 `createdAt` | number
 `updatedAt` | number
 
@@ -32,6 +36,10 @@ const example = {
   "requireQuizPass": null,
   "minQuizScore": null,
   "quizConfigId": null,
+  "certificateTemplateId": null,
+  "renewalPolicy": null,
+  "notificationPolicy": null,
+  "badgePolicy": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies CertificateConfig

package/docs/CertificateEvent.md

@@ -0,0 +1,46 @@
+
+# CertificateEvent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`eventType` | string
+`actorUserId` | string
+`oldValues` | { [key: string]: any; }
+`newValues` | { [key: string]: any; }
+`context` | { [key: string]: any; }
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { CertificateEvent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "eventType": null,
+  "actorUserId": null,
+  "oldValues": null,
+  "newValues": null,
+  "context": null,
+  "createdAt": null,
+} satisfies CertificateEvent
+
+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 CertificateEvent
+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/CertificateNotificationPolicy.md

@@ -0,0 +1,46 @@
+
+# CertificateNotificationPolicy
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`issuedEnabled` | boolean
+`renewedEnabled` | boolean
+`expiringEnabled` | boolean
+`expiredEnabled` | boolean
+`recipients` | Array<string>
+`portalRecipients` | Array<string>
+`reminderOffsetsDays` | Set<number>
+
+## Example
+
+```typescript
+import type { CertificateNotificationPolicy } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "issuedEnabled": null,
+  "renewedEnabled": null,
+  "expiringEnabled": null,
+  "expiredEnabled": null,
+  "recipients": null,
+  "portalRecipients": null,
+  "reminderOffsetsDays": null,
+} satisfies CertificateNotificationPolicy
+
+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 CertificateNotificationPolicy
+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)
+
+