@easyedu/js-lsm-api 1.85.0 → 1.87.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +66 -0
- package/README.md +87 -2
- package/dist/apis/CertificateApi.d.ts +273 -0
- package/dist/apis/CertificateApi.js +663 -2
- package/dist/apis/CertificateTemplateApi.d.ts +591 -0
- package/dist/apis/CertificateTemplateApi.js +1546 -0
- package/dist/apis/EmailTemplateApi.js +2 -2
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/CertificateApi.d.ts +273 -0
- package/dist/esm/apis/CertificateApi.js +662 -1
- package/dist/esm/apis/CertificateTemplateApi.d.ts +591 -0
- package/dist/esm/apis/CertificateTemplateApi.js +1542 -0
- package/dist/esm/apis/EmailTemplateApi.js +2 -2
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ArtifactConflict.d.ts +52 -0
- package/dist/esm/models/ArtifactConflict.js +58 -0
- package/dist/esm/models/BadgeIssuer.d.ts +80 -0
- package/dist/esm/models/BadgeIssuer.js +69 -0
- package/dist/esm/models/Certificate.d.ts +54 -0
- package/dist/esm/models/Certificate.js +30 -1
- package/dist/esm/models/CertificateArtifact.d.ts +72 -0
- package/dist/esm/models/CertificateArtifact.js +62 -0
- package/dist/esm/models/CertificateBadgePolicy.d.ts +69 -0
- package/dist/esm/models/CertificateBadgePolicy.js +64 -0
- package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
- package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.js +51 -0
- package/dist/esm/models/CertificateCanvasDocument.d.ts +53 -0
- package/dist/esm/models/CertificateCanvasDocument.js +59 -0
- package/dist/esm/models/CertificateCanvasDocumentPage.d.ts +60 -0
- package/dist/esm/models/CertificateCanvasDocumentPage.js +63 -0
- package/dist/esm/models/CertificateCanvasElement.d.ts +27 -0
- package/dist/esm/models/CertificateCanvasElement.js +79 -0
- package/dist/esm/models/CertificateCanvasImageElement.d.ts +90 -0
- package/dist/esm/models/CertificateCanvasImageElement.js +83 -0
- package/dist/esm/models/CertificateCanvasLineElement.d.ts +81 -0
- package/dist/esm/models/CertificateCanvasLineElement.js +77 -0
- package/dist/esm/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
- package/dist/esm/models/CertificateCanvasPortalLogoElement.js +69 -0
- package/dist/esm/models/CertificateCanvasShapeElement.d.ts +87 -0
- package/dist/esm/models/CertificateCanvasShapeElement.js +81 -0
- package/dist/esm/models/CertificateCanvasTextElement.d.ts +115 -0
- package/dist/esm/models/CertificateCanvasTextElement.js +101 -0
- package/dist/esm/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
- package/dist/esm/models/CertificateCanvasVerificationQrElement.js +69 -0
- package/dist/esm/models/CertificateConfig.d.ts +27 -0
- package/dist/esm/models/CertificateConfig.js +11 -0
- package/dist/esm/models/CertificateEvent.d.ts +74 -0
- package/dist/esm/models/CertificateEvent.js +61 -0
- package/dist/esm/models/CertificateNotificationPolicy.d.ts +76 -0
- package/dist/esm/models/CertificateNotificationPolicy.js +74 -0
- package/dist/esm/models/CertificatePublic.d.ts +35 -0
- package/dist/esm/models/CertificatePublic.js +22 -0
- package/dist/esm/models/CertificateRenewalPolicy.d.ts +46 -0
- package/dist/esm/models/CertificateRenewalPolicy.js +54 -0
- package/dist/esm/models/CertificateTemplate.d.ts +121 -0
- package/dist/esm/models/CertificateTemplate.js +97 -0
- package/dist/esm/models/CertificateTemplateVersion.d.ts +85 -0
- package/dist/esm/models/CertificateTemplateVersion.js +77 -0
- package/dist/esm/models/EffectiveCertificateConfig.d.ts +56 -0
- package/dist/esm/models/EffectiveCertificateConfig.js +35 -0
- package/dist/esm/models/GetCertificateAssetUpload.d.ts +64 -0
- package/dist/esm/models/GetCertificateAssetUpload.js +66 -0
- package/dist/esm/models/GetCertificateEventList.d.ts +33 -0
- package/dist/esm/models/GetCertificateEventList.js +44 -0
- package/dist/esm/models/GetCertificateTemplateList.d.ts +33 -0
- package/dist/esm/models/GetCertificateTemplateList.js +44 -0
- package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
- package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.js +56 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.d.ts +1 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.js +2 -1
- package/dist/esm/models/PostCertificateAssetComplete.d.ts +32 -0
- package/dist/esm/models/PostCertificateAssetComplete.js +43 -0
- package/dist/esm/models/PostCertificateAssetUpload.d.ts +53 -0
- package/dist/esm/models/PostCertificateAssetUpload.js +59 -0
- package/dist/esm/models/PostCertificateConfig.d.ts +27 -0
- package/dist/esm/models/PostCertificateConfig.js +11 -0
- package/dist/esm/models/PostCertificateLifecycleAction.d.ts +38 -0
- package/dist/esm/models/PostCertificateLifecycleAction.js +45 -0
- package/dist/esm/models/PostCertificateTemplate.d.ts +51 -0
- package/dist/esm/models/PostCertificateTemplate.js +50 -0
- package/dist/esm/models/PostCertificateTemplateClone.d.ts +44 -0
- package/dist/esm/models/PostCertificateTemplateClone.js +47 -0
- package/dist/esm/models/PostCertificateTemplatePreview.d.ts +41 -0
- package/dist/esm/models/PostCertificateTemplatePreview.js +46 -0
- package/dist/esm/models/PutBadgeIssuer.d.ts +44 -0
- package/dist/esm/models/PutBadgeIssuer.js +47 -0
- package/dist/esm/models/PutCertificateConfig.d.ts +27 -0
- package/dist/esm/models/PutCertificateConfig.js +11 -0
- package/dist/esm/models/PutCertificateTemplate.d.ts +44 -0
- package/dist/esm/models/PutCertificateTemplate.js +45 -0
- package/dist/esm/models/PutCertificateTemplateDraft.d.ts +39 -0
- package/dist/esm/models/PutCertificateTemplateDraft.js +46 -0
- package/dist/esm/models/index.d.ts +32 -0
- package/dist/esm/models/index.js +32 -0
- package/dist/models/ArtifactConflict.d.ts +52 -0
- package/dist/models/ArtifactConflict.js +66 -0
- package/dist/models/BadgeIssuer.d.ts +80 -0
- package/dist/models/BadgeIssuer.js +76 -0
- package/dist/models/Certificate.d.ts +54 -0
- package/dist/models/Certificate.js +31 -2
- package/dist/models/CertificateArtifact.d.ts +72 -0
- package/dist/models/CertificateArtifact.js +70 -0
- package/dist/models/CertificateBadgePolicy.d.ts +69 -0
- package/dist/models/CertificateBadgePolicy.js +71 -0
- package/dist/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
- package/dist/models/CertificateBadgePolicyAlignmentsInner.js +58 -0
- package/dist/models/CertificateCanvasDocument.d.ts +53 -0
- package/dist/models/CertificateCanvasDocument.js +67 -0
- package/dist/models/CertificateCanvasDocumentPage.d.ts +60 -0
- package/dist/models/CertificateCanvasDocumentPage.js +71 -0
- package/dist/models/CertificateCanvasElement.d.ts +27 -0
- package/dist/models/CertificateCanvasElement.js +85 -0
- package/dist/models/CertificateCanvasImageElement.d.ts +90 -0
- package/dist/models/CertificateCanvasImageElement.js +91 -0
- package/dist/models/CertificateCanvasLineElement.d.ts +81 -0
- package/dist/models/CertificateCanvasLineElement.js +85 -0
- package/dist/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
- package/dist/models/CertificateCanvasPortalLogoElement.js +77 -0
- package/dist/models/CertificateCanvasShapeElement.d.ts +87 -0
- package/dist/models/CertificateCanvasShapeElement.js +89 -0
- package/dist/models/CertificateCanvasTextElement.d.ts +115 -0
- package/dist/models/CertificateCanvasTextElement.js +109 -0
- package/dist/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
- package/dist/models/CertificateCanvasVerificationQrElement.js +77 -0
- package/dist/models/CertificateConfig.d.ts +27 -0
- package/dist/models/CertificateConfig.js +11 -0
- package/dist/models/CertificateEvent.d.ts +74 -0
- package/dist/models/CertificateEvent.js +68 -0
- package/dist/models/CertificateNotificationPolicy.d.ts +76 -0
- package/dist/models/CertificateNotificationPolicy.js +82 -0
- package/dist/models/CertificatePublic.d.ts +35 -0
- package/dist/models/CertificatePublic.js +23 -1
- package/dist/models/CertificateRenewalPolicy.d.ts +46 -0
- package/dist/models/CertificateRenewalPolicy.js +62 -0
- package/dist/models/CertificateTemplate.d.ts +121 -0
- package/dist/models/CertificateTemplate.js +105 -0
- package/dist/models/CertificateTemplateVersion.d.ts +85 -0
- package/dist/models/CertificateTemplateVersion.js +85 -0
- package/dist/models/EffectiveCertificateConfig.d.ts +56 -0
- package/dist/models/EffectiveCertificateConfig.js +36 -0
- package/dist/models/GetCertificateAssetUpload.d.ts +64 -0
- package/dist/models/GetCertificateAssetUpload.js +74 -0
- package/dist/models/GetCertificateEventList.d.ts +33 -0
- package/dist/models/GetCertificateEventList.js +51 -0
- package/dist/models/GetCertificateTemplateList.d.ts +33 -0
- package/dist/models/GetCertificateTemplateList.js +51 -0
- package/dist/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
- package/dist/models/GetPublicBadgeCredentialStatus200Response.js +64 -0
- package/dist/models/GetUserCourseListItemCertificate.d.ts +1 -0
- package/dist/models/GetUserCourseListItemCertificate.js +2 -1
- package/dist/models/PostCertificateAssetComplete.d.ts +32 -0
- package/dist/models/PostCertificateAssetComplete.js +50 -0
- package/dist/models/PostCertificateAssetUpload.d.ts +53 -0
- package/dist/models/PostCertificateAssetUpload.js +67 -0
- package/dist/models/PostCertificateConfig.d.ts +27 -0
- package/dist/models/PostCertificateConfig.js +11 -0
- package/dist/models/PostCertificateLifecycleAction.d.ts +38 -0
- package/dist/models/PostCertificateLifecycleAction.js +52 -0
- package/dist/models/PostCertificateTemplate.d.ts +51 -0
- package/dist/models/PostCertificateTemplate.js +57 -0
- package/dist/models/PostCertificateTemplateClone.d.ts +44 -0
- package/dist/models/PostCertificateTemplateClone.js +54 -0
- package/dist/models/PostCertificateTemplatePreview.d.ts +41 -0
- package/dist/models/PostCertificateTemplatePreview.js +53 -0
- package/dist/models/PutBadgeIssuer.d.ts +44 -0
- package/dist/models/PutBadgeIssuer.js +54 -0
- package/dist/models/PutCertificateConfig.d.ts +27 -0
- package/dist/models/PutCertificateConfig.js +11 -0
- package/dist/models/PutCertificateTemplate.d.ts +44 -0
- package/dist/models/PutCertificateTemplate.js +52 -0
- package/dist/models/PutCertificateTemplateDraft.d.ts +39 -0
- package/dist/models/PutCertificateTemplateDraft.js +53 -0
- package/dist/models/index.d.ts +32 -0
- package/dist/models/index.js +32 -0
- package/docs/ArtifactConflict.md +38 -0
- package/docs/BadgeIssuer.md +50 -0
- package/docs/Certificate.md +14 -0
- package/docs/CertificateApi.md +1119 -48
- package/docs/CertificateArtifact.md +44 -0
- package/docs/CertificateBadgePolicy.md +46 -0
- package/docs/CertificateBadgePolicyAlignmentsInner.md +40 -0
- package/docs/CertificateCanvasDocument.md +39 -0
- package/docs/CertificateCanvasDocumentPage.md +38 -0
- package/docs/CertificateCanvasElement.md +65 -0
- package/docs/CertificateCanvasImageElement.md +48 -0
- package/docs/CertificateCanvasLineElement.md +48 -0
- package/docs/CertificateCanvasPortalLogoElement.md +44 -0
- package/docs/CertificateCanvasShapeElement.md +50 -0
- package/docs/CertificateCanvasTextElement.md +54 -0
- package/docs/CertificateCanvasVerificationQrElement.md +44 -0
- package/docs/CertificateConfig.md +8 -0
- package/docs/CertificateEvent.md +46 -0
- package/docs/CertificateNotificationPolicy.md +46 -0
- package/docs/CertificatePublic.md +8 -0
- package/docs/CertificateRenewalPolicy.md +36 -0
- package/docs/CertificateTemplate.md +60 -0
- package/docs/CertificateTemplateApi.md +2493 -0
- package/docs/CertificateTemplateVersion.md +48 -0
- package/docs/EffectiveCertificateConfig.md +14 -0
- package/docs/EmailTemplateApi.md +2 -2
- package/docs/GetCertificateAssetUpload.md +42 -0
- package/docs/GetCertificateEventList.md +34 -0
- package/docs/GetCertificateTemplateList.md +34 -0
- package/docs/GetPublicBadgeCredentialStatus200Response.md +36 -0
- package/docs/PostCertificateAssetComplete.md +34 -0
- package/docs/PostCertificateAssetUpload.md +38 -0
- package/docs/PostCertificateConfig.md +8 -0
- package/docs/PostCertificateLifecycleAction.md +36 -0
- package/docs/PostCertificateTemplate.md +40 -0
- package/docs/PostCertificateTemplateClone.md +38 -0
- package/docs/PostCertificateTemplatePreview.md +36 -0
- package/docs/PutBadgeIssuer.md +38 -0
- package/docs/PutCertificateConfig.md +8 -0
- package/docs/PutCertificateTemplate.md +38 -0
- package/docs/PutCertificateTemplateDraft.md +36 -0
- package/package.json +1 -1
- package/src/apis/CertificateApi.ts +952 -98
- package/src/apis/CertificateTemplateApi.ts +2020 -0
- package/src/apis/EmailTemplateApi.ts +2 -2
- package/src/apis/index.ts +1 -0
- package/src/models/ArtifactConflict.ts +95 -0
- package/src/models/BadgeIssuer.ts +135 -0
- package/src/models/Certificate.ts +79 -1
- package/src/models/CertificateArtifact.ts +119 -0
- package/src/models/CertificateBadgePolicy.ts +126 -0
- package/src/models/CertificateBadgePolicyAlignmentsInner.ts +91 -0
- package/src/models/CertificateCanvasDocument.ts +109 -0
- package/src/models/CertificateCanvasDocumentPage.ts +103 -0
- package/src/models/CertificateCanvasElement.ts +128 -0
- package/src/models/CertificateCanvasImageElement.ts +148 -0
- package/src/models/CertificateCanvasLineElement.ts +139 -0
- package/src/models/CertificateCanvasPortalLogoElement.ts +121 -0
- package/src/models/CertificateCanvasShapeElement.ts +148 -0
- package/src/models/CertificateCanvasTextElement.ts +183 -0
- package/src/models/CertificateCanvasVerificationQrElement.ts +121 -0
- package/src/models/CertificateConfig.ts +54 -0
- package/src/models/CertificateEvent.ts +117 -0
- package/src/models/CertificateNotificationPolicy.ts +131 -0
- package/src/models/CertificatePublic.ts +46 -0
- package/src/models/CertificateRenewalPolicy.ts +86 -0
- package/src/models/CertificateTemplate.ts +200 -0
- package/src/models/CertificateTemplateVersion.ts +148 -0
- package/src/models/EffectiveCertificateConfig.ts +96 -0
- package/src/models/GetCertificateAssetUpload.ts +113 -0
- package/src/models/GetCertificateEventList.ts +74 -0
- package/src/models/GetCertificateTemplateList.ts +74 -0
- package/src/models/GetPublicBadgeCredentialStatus200Response.ts +88 -0
- package/src/models/GetUserCourseListItemCertificate.ts +2 -1
- package/src/models/PostCertificateAssetComplete.ts +66 -0
- package/src/models/PostCertificateAssetUpload.ts +96 -0
- package/src/models/PostCertificateConfig.ts +54 -0
- package/src/models/PostCertificateLifecycleAction.ts +74 -0
- package/src/models/PostCertificateTemplate.ts +98 -0
- package/src/models/PostCertificateTemplateClone.ts +82 -0
- package/src/models/PostCertificateTemplatePreview.ts +82 -0
- package/src/models/PutBadgeIssuer.ts +82 -0
- package/src/models/PutCertificateConfig.ts +54 -0
- package/src/models/PutCertificateTemplate.ts +81 -0
- package/src/models/PutCertificateTemplateDraft.ts +82 -0
- package/src/models/index.ts +32 -0
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# CertificateTemplateVersion
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`versionNumber` | number
|
|
11
|
+
`status` | string
|
|
12
|
+
`designDocument` | [CertificateCanvasDocument](CertificateCanvasDocument.md)
|
|
13
|
+
`changeNotes` | string
|
|
14
|
+
`createdAt` | number
|
|
15
|
+
`updatedAt` | number
|
|
16
|
+
`publishedAt` | number
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { CertificateTemplateVersion } from '@easyedu/js-lsm-api'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"id": null,
|
|
26
|
+
"versionNumber": null,
|
|
27
|
+
"status": null,
|
|
28
|
+
"designDocument": null,
|
|
29
|
+
"changeNotes": null,
|
|
30
|
+
"createdAt": null,
|
|
31
|
+
"updatedAt": null,
|
|
32
|
+
"publishedAt": null,
|
|
33
|
+
} satisfies CertificateTemplateVersion
|
|
34
|
+
|
|
35
|
+
console.log(example)
|
|
36
|
+
|
|
37
|
+
// Convert the instance to a JSON string
|
|
38
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
39
|
+
console.log(exampleJSON)
|
|
40
|
+
|
|
41
|
+
// Parse the JSON string back to an object
|
|
42
|
+
const exampleParsed = JSON.parse(exampleJSON) as CertificateTemplateVersion
|
|
43
|
+
console.log(exampleParsed)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
47
|
+
|
|
48
|
+
|
|
@@ -13,6 +13,13 @@ Name | Type
|
|
|
13
13
|
`minQuizScore` | number
|
|
14
14
|
`quizConfigId` | string
|
|
15
15
|
`sourceConfigId` | string
|
|
16
|
+
`certificateTemplateId` | string
|
|
17
|
+
`certificateTemplateVersionId` | string
|
|
18
|
+
`templateSource` | string
|
|
19
|
+
`templateSourcePortalId` | string
|
|
20
|
+
`renewalPolicy` | [CertificateRenewalPolicy](CertificateRenewalPolicy.md)
|
|
21
|
+
`notificationPolicy` | [CertificateNotificationPolicy](CertificateNotificationPolicy.md)
|
|
22
|
+
`badgePolicy` | [CertificateBadgePolicy](CertificateBadgePolicy.md)
|
|
16
23
|
|
|
17
24
|
## Example
|
|
18
25
|
|
|
@@ -27,6 +34,13 @@ const example = {
|
|
|
27
34
|
"minQuizScore": null,
|
|
28
35
|
"quizConfigId": null,
|
|
29
36
|
"sourceConfigId": null,
|
|
37
|
+
"certificateTemplateId": null,
|
|
38
|
+
"certificateTemplateVersionId": null,
|
|
39
|
+
"templateSource": null,
|
|
40
|
+
"templateSourcePortalId": null,
|
|
41
|
+
"renewalPolicy": null,
|
|
42
|
+
"notificationPolicy": null,
|
|
43
|
+
"badgePolicy": null,
|
|
30
44
|
} satisfies EffectiveCertificateConfig
|
|
31
45
|
|
|
32
46
|
console.log(example)
|
package/docs/EmailTemplateApi.md
CHANGED
|
@@ -1876,7 +1876,7 @@ No authorization required
|
|
|
1876
1876
|
|
|
1877
1877
|
### HTTP request headers
|
|
1878
1878
|
|
|
1879
|
-
- **Content-Type**: `
|
|
1879
|
+
- **Content-Type**: `application/octet-stream`
|
|
1880
1880
|
- **Accept**: Not defined
|
|
1881
1881
|
|
|
1882
1882
|
|
|
@@ -2015,7 +2015,7 @@ No authorization required
|
|
|
2015
2015
|
|
|
2016
2016
|
### HTTP request headers
|
|
2017
2017
|
|
|
2018
|
-
- **Content-Type**: `
|
|
2018
|
+
- **Content-Type**: `application/octet-stream`
|
|
2019
2019
|
- **Accept**: Not defined
|
|
2020
2020
|
|
|
2021
2021
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# GetCertificateAssetUpload
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | string
|
|
10
|
+
`uploadUrl` | string
|
|
11
|
+
`assetUrl` | string
|
|
12
|
+
`publicUrl` | string
|
|
13
|
+
`status` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { GetCertificateAssetUpload } from '@easyedu/js-lsm-api'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"uploadUrl": null,
|
|
24
|
+
"assetUrl": null,
|
|
25
|
+
"publicUrl": null,
|
|
26
|
+
"status": null,
|
|
27
|
+
} satisfies GetCertificateAssetUpload
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetCertificateAssetUpload
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# GetCertificateEventList
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`items` | [Array<CertificateEvent>](CertificateEvent.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GetCertificateEventList } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"items": null,
|
|
19
|
+
} satisfies GetCertificateEventList
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetCertificateEventList
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# GetCertificateTemplateList
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`items` | [Array<CertificateTemplate>](CertificateTemplate.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GetCertificateTemplateList } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"items": null,
|
|
19
|
+
} satisfies GetCertificateTemplateList
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetCertificateTemplateList
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# GetPublicBadgeCredentialStatus200Response
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`active` | boolean
|
|
10
|
+
`status` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { GetPublicBadgeCredentialStatus200Response } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"active": null,
|
|
20
|
+
"status": null,
|
|
21
|
+
} satisfies GetPublicBadgeCredentialStatus200Response
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetPublicBadgeCredentialStatus200Response
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateAssetComplete
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`checksumSha256` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PostCertificateAssetComplete } from '@easyedu/js-lsm-api'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"checksumSha256": null,
|
|
19
|
+
} satisfies PostCertificateAssetComplete
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateAssetComplete
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateAssetUpload
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`filename` | string
|
|
10
|
+
`contentType` | string
|
|
11
|
+
`byteSize` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { PostCertificateAssetUpload } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"filename": null,
|
|
21
|
+
"contentType": null,
|
|
22
|
+
"byteSize": null,
|
|
23
|
+
} satisfies PostCertificateAssetUpload
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateAssetUpload
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -12,6 +12,10 @@ Name | Type
|
|
|
12
12
|
`requireQuizPass` | boolean
|
|
13
13
|
`minQuizScore` | number
|
|
14
14
|
`quizConfigId` | string
|
|
15
|
+
`certificateTemplateId` | string
|
|
16
|
+
`renewalPolicy` | [CertificateRenewalPolicy](CertificateRenewalPolicy.md)
|
|
17
|
+
`notificationPolicy` | [CertificateNotificationPolicy](CertificateNotificationPolicy.md)
|
|
18
|
+
`badgePolicy` | [CertificateBadgePolicy](CertificateBadgePolicy.md)
|
|
15
19
|
|
|
16
20
|
## Example
|
|
17
21
|
|
|
@@ -26,6 +30,10 @@ const example = {
|
|
|
26
30
|
"requireQuizPass": null,
|
|
27
31
|
"minQuizScore": null,
|
|
28
32
|
"quizConfigId": null,
|
|
33
|
+
"certificateTemplateId": null,
|
|
34
|
+
"renewalPolicy": null,
|
|
35
|
+
"notificationPolicy": null,
|
|
36
|
+
"badgePolicy": null,
|
|
29
37
|
} satisfies PostCertificateConfig
|
|
30
38
|
|
|
31
39
|
console.log(example)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateLifecycleAction
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`reason` | string
|
|
10
|
+
`expiresAt` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PostCertificateLifecycleAction } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"reason": null,
|
|
20
|
+
"expiresAt": null,
|
|
21
|
+
} satisfies PostCertificateLifecycleAction
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateLifecycleAction
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateTemplate
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
`isDefault` | boolean
|
|
12
|
+
`designDocument` | [CertificateCanvasDocument](CertificateCanvasDocument.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { PostCertificateTemplate } from '@easyedu/js-lsm-api'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"name": null,
|
|
22
|
+
"description": null,
|
|
23
|
+
"isDefault": null,
|
|
24
|
+
"designDocument": null,
|
|
25
|
+
} satisfies PostCertificateTemplate
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateTemplate
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateTemplateClone
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
`isDefault` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { PostCertificateTemplateClone } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"name": null,
|
|
21
|
+
"description": null,
|
|
22
|
+
"isDefault": null,
|
|
23
|
+
} satisfies PostCertificateTemplateClone
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateTemplateClone
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PostCertificateTemplatePreview
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`designDocument` | [CertificateCanvasDocument](CertificateCanvasDocument.md)
|
|
10
|
+
`sampleValues` | { [key: string]: any; }
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PostCertificateTemplatePreview } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"designDocument": null,
|
|
20
|
+
"sampleValues": null,
|
|
21
|
+
} satisfies PostCertificateTemplatePreview
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PostCertificateTemplatePreview
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# PutBadgeIssuer
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`displayName` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
`websiteUrl` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { PutBadgeIssuer } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"displayName": null,
|
|
21
|
+
"description": null,
|
|
22
|
+
"websiteUrl": null,
|
|
23
|
+
} satisfies PutBadgeIssuer
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutBadgeIssuer
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -11,6 +11,10 @@ Name | Type
|
|
|
11
11
|
`requireQuizPass` | boolean
|
|
12
12
|
`minQuizScore` | number
|
|
13
13
|
`quizConfigId` | string
|
|
14
|
+
`certificateTemplateId` | string
|
|
15
|
+
`renewalPolicy` | [CertificateRenewalPolicy](CertificateRenewalPolicy.md)
|
|
16
|
+
`notificationPolicy` | [CertificateNotificationPolicy](CertificateNotificationPolicy.md)
|
|
17
|
+
`badgePolicy` | [CertificateBadgePolicy](CertificateBadgePolicy.md)
|
|
14
18
|
|
|
15
19
|
## Example
|
|
16
20
|
|
|
@@ -24,6 +28,10 @@ const example = {
|
|
|
24
28
|
"requireQuizPass": null,
|
|
25
29
|
"minQuizScore": null,
|
|
26
30
|
"quizConfigId": null,
|
|
31
|
+
"certificateTemplateId": null,
|
|
32
|
+
"renewalPolicy": null,
|
|
33
|
+
"notificationPolicy": null,
|
|
34
|
+
"badgePolicy": null,
|
|
27
35
|
} satisfies PutCertificateConfig
|
|
28
36
|
|
|
29
37
|
console.log(example)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# PutCertificateTemplate
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`name` | string
|
|
10
|
+
`description` | string
|
|
11
|
+
`isDefault` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { PutCertificateTemplate } from '@easyedu/js-lsm-api'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"name": null,
|
|
21
|
+
"description": null,
|
|
22
|
+
"isDefault": null,
|
|
23
|
+
} satisfies PutCertificateTemplate
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutCertificateTemplate
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PutCertificateTemplateDraft
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`designDocument` | [CertificateCanvasDocument](CertificateCanvasDocument.md)
|
|
10
|
+
`changeNotes` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PutCertificateTemplateDraft } from '@easyedu/js-lsm-api'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"designDocument": null,
|
|
20
|
+
"changeNotes": null,
|
|
21
|
+
} satisfies PutCertificateTemplateDraft
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PutCertificateTemplateDraft
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|