@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.
Files changed (262) hide show
  1. package/.openapi-generator/FILES +66 -0
  2. package/README.md +87 -2
  3. package/dist/apis/CertificateApi.d.ts +273 -0
  4. package/dist/apis/CertificateApi.js +663 -2
  5. package/dist/apis/CertificateTemplateApi.d.ts +591 -0
  6. package/dist/apis/CertificateTemplateApi.js +1546 -0
  7. package/dist/apis/EmailTemplateApi.js +2 -2
  8. package/dist/apis/index.d.ts +1 -0
  9. package/dist/apis/index.js +1 -0
  10. package/dist/esm/apis/CertificateApi.d.ts +273 -0
  11. package/dist/esm/apis/CertificateApi.js +662 -1
  12. package/dist/esm/apis/CertificateTemplateApi.d.ts +591 -0
  13. package/dist/esm/apis/CertificateTemplateApi.js +1542 -0
  14. package/dist/esm/apis/EmailTemplateApi.js +2 -2
  15. package/dist/esm/apis/index.d.ts +1 -0
  16. package/dist/esm/apis/index.js +1 -0
  17. package/dist/esm/models/ArtifactConflict.d.ts +52 -0
  18. package/dist/esm/models/ArtifactConflict.js +58 -0
  19. package/dist/esm/models/BadgeIssuer.d.ts +80 -0
  20. package/dist/esm/models/BadgeIssuer.js +69 -0
  21. package/dist/esm/models/Certificate.d.ts +54 -0
  22. package/dist/esm/models/Certificate.js +30 -1
  23. package/dist/esm/models/CertificateArtifact.d.ts +72 -0
  24. package/dist/esm/models/CertificateArtifact.js +62 -0
  25. package/dist/esm/models/CertificateBadgePolicy.d.ts +69 -0
  26. package/dist/esm/models/CertificateBadgePolicy.js +64 -0
  27. package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
  28. package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.js +51 -0
  29. package/dist/esm/models/CertificateCanvasDocument.d.ts +53 -0
  30. package/dist/esm/models/CertificateCanvasDocument.js +59 -0
  31. package/dist/esm/models/CertificateCanvasDocumentPage.d.ts +60 -0
  32. package/dist/esm/models/CertificateCanvasDocumentPage.js +63 -0
  33. package/dist/esm/models/CertificateCanvasElement.d.ts +27 -0
  34. package/dist/esm/models/CertificateCanvasElement.js +79 -0
  35. package/dist/esm/models/CertificateCanvasImageElement.d.ts +90 -0
  36. package/dist/esm/models/CertificateCanvasImageElement.js +83 -0
  37. package/dist/esm/models/CertificateCanvasLineElement.d.ts +81 -0
  38. package/dist/esm/models/CertificateCanvasLineElement.js +77 -0
  39. package/dist/esm/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
  40. package/dist/esm/models/CertificateCanvasPortalLogoElement.js +69 -0
  41. package/dist/esm/models/CertificateCanvasShapeElement.d.ts +87 -0
  42. package/dist/esm/models/CertificateCanvasShapeElement.js +81 -0
  43. package/dist/esm/models/CertificateCanvasTextElement.d.ts +115 -0
  44. package/dist/esm/models/CertificateCanvasTextElement.js +101 -0
  45. package/dist/esm/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
  46. package/dist/esm/models/CertificateCanvasVerificationQrElement.js +69 -0
  47. package/dist/esm/models/CertificateConfig.d.ts +27 -0
  48. package/dist/esm/models/CertificateConfig.js +11 -0
  49. package/dist/esm/models/CertificateEvent.d.ts +74 -0
  50. package/dist/esm/models/CertificateEvent.js +61 -0
  51. package/dist/esm/models/CertificateNotificationPolicy.d.ts +76 -0
  52. package/dist/esm/models/CertificateNotificationPolicy.js +74 -0
  53. package/dist/esm/models/CertificatePublic.d.ts +35 -0
  54. package/dist/esm/models/CertificatePublic.js +22 -0
  55. package/dist/esm/models/CertificateRenewalPolicy.d.ts +46 -0
  56. package/dist/esm/models/CertificateRenewalPolicy.js +54 -0
  57. package/dist/esm/models/CertificateTemplate.d.ts +121 -0
  58. package/dist/esm/models/CertificateTemplate.js +97 -0
  59. package/dist/esm/models/CertificateTemplateVersion.d.ts +85 -0
  60. package/dist/esm/models/CertificateTemplateVersion.js +77 -0
  61. package/dist/esm/models/EffectiveCertificateConfig.d.ts +56 -0
  62. package/dist/esm/models/EffectiveCertificateConfig.js +35 -0
  63. package/dist/esm/models/GetCertificateAssetUpload.d.ts +64 -0
  64. package/dist/esm/models/GetCertificateAssetUpload.js +66 -0
  65. package/dist/esm/models/GetCertificateEventList.d.ts +33 -0
  66. package/dist/esm/models/GetCertificateEventList.js +44 -0
  67. package/dist/esm/models/GetCertificateTemplateList.d.ts +33 -0
  68. package/dist/esm/models/GetCertificateTemplateList.js +44 -0
  69. package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
  70. package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.js +56 -0
  71. package/dist/esm/models/GetUserCourseListItemCertificate.d.ts +1 -0
  72. package/dist/esm/models/GetUserCourseListItemCertificate.js +2 -1
  73. package/dist/esm/models/PostCertificateAssetComplete.d.ts +32 -0
  74. package/dist/esm/models/PostCertificateAssetComplete.js +43 -0
  75. package/dist/esm/models/PostCertificateAssetUpload.d.ts +53 -0
  76. package/dist/esm/models/PostCertificateAssetUpload.js +59 -0
  77. package/dist/esm/models/PostCertificateConfig.d.ts +27 -0
  78. package/dist/esm/models/PostCertificateConfig.js +11 -0
  79. package/dist/esm/models/PostCertificateLifecycleAction.d.ts +38 -0
  80. package/dist/esm/models/PostCertificateLifecycleAction.js +45 -0
  81. package/dist/esm/models/PostCertificateTemplate.d.ts +51 -0
  82. package/dist/esm/models/PostCertificateTemplate.js +50 -0
  83. package/dist/esm/models/PostCertificateTemplateClone.d.ts +44 -0
  84. package/dist/esm/models/PostCertificateTemplateClone.js +47 -0
  85. package/dist/esm/models/PostCertificateTemplatePreview.d.ts +41 -0
  86. package/dist/esm/models/PostCertificateTemplatePreview.js +46 -0
  87. package/dist/esm/models/PutBadgeIssuer.d.ts +44 -0
  88. package/dist/esm/models/PutBadgeIssuer.js +47 -0
  89. package/dist/esm/models/PutCertificateConfig.d.ts +27 -0
  90. package/dist/esm/models/PutCertificateConfig.js +11 -0
  91. package/dist/esm/models/PutCertificateTemplate.d.ts +44 -0
  92. package/dist/esm/models/PutCertificateTemplate.js +45 -0
  93. package/dist/esm/models/PutCertificateTemplateDraft.d.ts +39 -0
  94. package/dist/esm/models/PutCertificateTemplateDraft.js +46 -0
  95. package/dist/esm/models/index.d.ts +32 -0
  96. package/dist/esm/models/index.js +32 -0
  97. package/dist/models/ArtifactConflict.d.ts +52 -0
  98. package/dist/models/ArtifactConflict.js +66 -0
  99. package/dist/models/BadgeIssuer.d.ts +80 -0
  100. package/dist/models/BadgeIssuer.js +76 -0
  101. package/dist/models/Certificate.d.ts +54 -0
  102. package/dist/models/Certificate.js +31 -2
  103. package/dist/models/CertificateArtifact.d.ts +72 -0
  104. package/dist/models/CertificateArtifact.js +70 -0
  105. package/dist/models/CertificateBadgePolicy.d.ts +69 -0
  106. package/dist/models/CertificateBadgePolicy.js +71 -0
  107. package/dist/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
  108. package/dist/models/CertificateBadgePolicyAlignmentsInner.js +58 -0
  109. package/dist/models/CertificateCanvasDocument.d.ts +53 -0
  110. package/dist/models/CertificateCanvasDocument.js +67 -0
  111. package/dist/models/CertificateCanvasDocumentPage.d.ts +60 -0
  112. package/dist/models/CertificateCanvasDocumentPage.js +71 -0
  113. package/dist/models/CertificateCanvasElement.d.ts +27 -0
  114. package/dist/models/CertificateCanvasElement.js +85 -0
  115. package/dist/models/CertificateCanvasImageElement.d.ts +90 -0
  116. package/dist/models/CertificateCanvasImageElement.js +91 -0
  117. package/dist/models/CertificateCanvasLineElement.d.ts +81 -0
  118. package/dist/models/CertificateCanvasLineElement.js +85 -0
  119. package/dist/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
  120. package/dist/models/CertificateCanvasPortalLogoElement.js +77 -0
  121. package/dist/models/CertificateCanvasShapeElement.d.ts +87 -0
  122. package/dist/models/CertificateCanvasShapeElement.js +89 -0
  123. package/dist/models/CertificateCanvasTextElement.d.ts +115 -0
  124. package/dist/models/CertificateCanvasTextElement.js +109 -0
  125. package/dist/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
  126. package/dist/models/CertificateCanvasVerificationQrElement.js +77 -0
  127. package/dist/models/CertificateConfig.d.ts +27 -0
  128. package/dist/models/CertificateConfig.js +11 -0
  129. package/dist/models/CertificateEvent.d.ts +74 -0
  130. package/dist/models/CertificateEvent.js +68 -0
  131. package/dist/models/CertificateNotificationPolicy.d.ts +76 -0
  132. package/dist/models/CertificateNotificationPolicy.js +82 -0
  133. package/dist/models/CertificatePublic.d.ts +35 -0
  134. package/dist/models/CertificatePublic.js +23 -1
  135. package/dist/models/CertificateRenewalPolicy.d.ts +46 -0
  136. package/dist/models/CertificateRenewalPolicy.js +62 -0
  137. package/dist/models/CertificateTemplate.d.ts +121 -0
  138. package/dist/models/CertificateTemplate.js +105 -0
  139. package/dist/models/CertificateTemplateVersion.d.ts +85 -0
  140. package/dist/models/CertificateTemplateVersion.js +85 -0
  141. package/dist/models/EffectiveCertificateConfig.d.ts +56 -0
  142. package/dist/models/EffectiveCertificateConfig.js +36 -0
  143. package/dist/models/GetCertificateAssetUpload.d.ts +64 -0
  144. package/dist/models/GetCertificateAssetUpload.js +74 -0
  145. package/dist/models/GetCertificateEventList.d.ts +33 -0
  146. package/dist/models/GetCertificateEventList.js +51 -0
  147. package/dist/models/GetCertificateTemplateList.d.ts +33 -0
  148. package/dist/models/GetCertificateTemplateList.js +51 -0
  149. package/dist/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
  150. package/dist/models/GetPublicBadgeCredentialStatus200Response.js +64 -0
  151. package/dist/models/GetUserCourseListItemCertificate.d.ts +1 -0
  152. package/dist/models/GetUserCourseListItemCertificate.js +2 -1
  153. package/dist/models/PostCertificateAssetComplete.d.ts +32 -0
  154. package/dist/models/PostCertificateAssetComplete.js +50 -0
  155. package/dist/models/PostCertificateAssetUpload.d.ts +53 -0
  156. package/dist/models/PostCertificateAssetUpload.js +67 -0
  157. package/dist/models/PostCertificateConfig.d.ts +27 -0
  158. package/dist/models/PostCertificateConfig.js +11 -0
  159. package/dist/models/PostCertificateLifecycleAction.d.ts +38 -0
  160. package/dist/models/PostCertificateLifecycleAction.js +52 -0
  161. package/dist/models/PostCertificateTemplate.d.ts +51 -0
  162. package/dist/models/PostCertificateTemplate.js +57 -0
  163. package/dist/models/PostCertificateTemplateClone.d.ts +44 -0
  164. package/dist/models/PostCertificateTemplateClone.js +54 -0
  165. package/dist/models/PostCertificateTemplatePreview.d.ts +41 -0
  166. package/dist/models/PostCertificateTemplatePreview.js +53 -0
  167. package/dist/models/PutBadgeIssuer.d.ts +44 -0
  168. package/dist/models/PutBadgeIssuer.js +54 -0
  169. package/dist/models/PutCertificateConfig.d.ts +27 -0
  170. package/dist/models/PutCertificateConfig.js +11 -0
  171. package/dist/models/PutCertificateTemplate.d.ts +44 -0
  172. package/dist/models/PutCertificateTemplate.js +52 -0
  173. package/dist/models/PutCertificateTemplateDraft.d.ts +39 -0
  174. package/dist/models/PutCertificateTemplateDraft.js +53 -0
  175. package/dist/models/index.d.ts +32 -0
  176. package/dist/models/index.js +32 -0
  177. package/docs/ArtifactConflict.md +38 -0
  178. package/docs/BadgeIssuer.md +50 -0
  179. package/docs/Certificate.md +14 -0
  180. package/docs/CertificateApi.md +1119 -48
  181. package/docs/CertificateArtifact.md +44 -0
  182. package/docs/CertificateBadgePolicy.md +46 -0
  183. package/docs/CertificateBadgePolicyAlignmentsInner.md +40 -0
  184. package/docs/CertificateCanvasDocument.md +39 -0
  185. package/docs/CertificateCanvasDocumentPage.md +38 -0
  186. package/docs/CertificateCanvasElement.md +65 -0
  187. package/docs/CertificateCanvasImageElement.md +48 -0
  188. package/docs/CertificateCanvasLineElement.md +48 -0
  189. package/docs/CertificateCanvasPortalLogoElement.md +44 -0
  190. package/docs/CertificateCanvasShapeElement.md +50 -0
  191. package/docs/CertificateCanvasTextElement.md +54 -0
  192. package/docs/CertificateCanvasVerificationQrElement.md +44 -0
  193. package/docs/CertificateConfig.md +8 -0
  194. package/docs/CertificateEvent.md +46 -0
  195. package/docs/CertificateNotificationPolicy.md +46 -0
  196. package/docs/CertificatePublic.md +8 -0
  197. package/docs/CertificateRenewalPolicy.md +36 -0
  198. package/docs/CertificateTemplate.md +60 -0
  199. package/docs/CertificateTemplateApi.md +2493 -0
  200. package/docs/CertificateTemplateVersion.md +48 -0
  201. package/docs/EffectiveCertificateConfig.md +14 -0
  202. package/docs/EmailTemplateApi.md +2 -2
  203. package/docs/GetCertificateAssetUpload.md +42 -0
  204. package/docs/GetCertificateEventList.md +34 -0
  205. package/docs/GetCertificateTemplateList.md +34 -0
  206. package/docs/GetPublicBadgeCredentialStatus200Response.md +36 -0
  207. package/docs/PostCertificateAssetComplete.md +34 -0
  208. package/docs/PostCertificateAssetUpload.md +38 -0
  209. package/docs/PostCertificateConfig.md +8 -0
  210. package/docs/PostCertificateLifecycleAction.md +36 -0
  211. package/docs/PostCertificateTemplate.md +40 -0
  212. package/docs/PostCertificateTemplateClone.md +38 -0
  213. package/docs/PostCertificateTemplatePreview.md +36 -0
  214. package/docs/PutBadgeIssuer.md +38 -0
  215. package/docs/PutCertificateConfig.md +8 -0
  216. package/docs/PutCertificateTemplate.md +38 -0
  217. package/docs/PutCertificateTemplateDraft.md +36 -0
  218. package/package.json +1 -1
  219. package/src/apis/CertificateApi.ts +952 -98
  220. package/src/apis/CertificateTemplateApi.ts +2020 -0
  221. package/src/apis/EmailTemplateApi.ts +2 -2
  222. package/src/apis/index.ts +1 -0
  223. package/src/models/ArtifactConflict.ts +95 -0
  224. package/src/models/BadgeIssuer.ts +135 -0
  225. package/src/models/Certificate.ts +79 -1
  226. package/src/models/CertificateArtifact.ts +119 -0
  227. package/src/models/CertificateBadgePolicy.ts +126 -0
  228. package/src/models/CertificateBadgePolicyAlignmentsInner.ts +91 -0
  229. package/src/models/CertificateCanvasDocument.ts +109 -0
  230. package/src/models/CertificateCanvasDocumentPage.ts +103 -0
  231. package/src/models/CertificateCanvasElement.ts +128 -0
  232. package/src/models/CertificateCanvasImageElement.ts +148 -0
  233. package/src/models/CertificateCanvasLineElement.ts +139 -0
  234. package/src/models/CertificateCanvasPortalLogoElement.ts +121 -0
  235. package/src/models/CertificateCanvasShapeElement.ts +148 -0
  236. package/src/models/CertificateCanvasTextElement.ts +183 -0
  237. package/src/models/CertificateCanvasVerificationQrElement.ts +121 -0
  238. package/src/models/CertificateConfig.ts +54 -0
  239. package/src/models/CertificateEvent.ts +117 -0
  240. package/src/models/CertificateNotificationPolicy.ts +131 -0
  241. package/src/models/CertificatePublic.ts +46 -0
  242. package/src/models/CertificateRenewalPolicy.ts +86 -0
  243. package/src/models/CertificateTemplate.ts +200 -0
  244. package/src/models/CertificateTemplateVersion.ts +148 -0
  245. package/src/models/EffectiveCertificateConfig.ts +96 -0
  246. package/src/models/GetCertificateAssetUpload.ts +113 -0
  247. package/src/models/GetCertificateEventList.ts +74 -0
  248. package/src/models/GetCertificateTemplateList.ts +74 -0
  249. package/src/models/GetPublicBadgeCredentialStatus200Response.ts +88 -0
  250. package/src/models/GetUserCourseListItemCertificate.ts +2 -1
  251. package/src/models/PostCertificateAssetComplete.ts +66 -0
  252. package/src/models/PostCertificateAssetUpload.ts +96 -0
  253. package/src/models/PostCertificateConfig.ts +54 -0
  254. package/src/models/PostCertificateLifecycleAction.ts +74 -0
  255. package/src/models/PostCertificateTemplate.ts +98 -0
  256. package/src/models/PostCertificateTemplateClone.ts +82 -0
  257. package/src/models/PostCertificateTemplatePreview.ts +82 -0
  258. package/src/models/PutBadgeIssuer.ts +82 -0
  259. package/src/models/PutCertificateConfig.ts +54 -0
  260. package/src/models/PutCertificateTemplate.ts +81 -0
  261. package/src/models/PutCertificateTemplateDraft.ts +82 -0
  262. package/src/models/index.ts +32 -0
@@ -0,0 +1,2493 @@
1
+ # CertificateTemplateApi
2
+
3
+ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
4
+
5
+ | Method | HTTP request | Description |
6
+ |------------- | ------------- | -------------|
7
+ | [**deleteCertificateTemplateDraft**](CertificateTemplateApi.md#deletecertificatetemplatedraft) | **DELETE** /certificate-templates/{templateId}/draft | Discard the current certificate design draft |
8
+ | [**deletePlatformCertificateTemplateDraft**](CertificateTemplateApi.md#deleteplatformcertificatetemplatedraft) | **DELETE** /system/certificate-templates/{templateId}/draft | Discard a platform certificate design draft |
9
+ | [**getCertificateAsset**](CertificateTemplateApi.md#getcertificateasset) | **GET** /certificate-assets/{assetId} | Read a portal certificate asset for design editing |
10
+ | [**getCertificateTemplate**](CertificateTemplateApi.md#getcertificatetemplate) | **GET** /certificate-templates/{templateId} | Get a certificate design with draft and history |
11
+ | [**getCertificateTemplateList**](CertificateTemplateApi.md#getcertificatetemplatelist) | **GET** /certificate-templates | List local and inherited certificate designs |
12
+ | [**getCertificateTemplateVersions**](CertificateTemplateApi.md#getcertificatetemplateversions) | **GET** /certificate-templates/{templateId}/versions | List certificate design version history |
13
+ | [**getPlatformCertificateAsset**](CertificateTemplateApi.md#getplatformcertificateasset) | **GET** /system/certificate-assets/{assetId} | Read a platform certificate asset for design editing |
14
+ | [**getPlatformCertificateTemplate**](CertificateTemplateApi.md#getplatformcertificatetemplate) | **GET** /system/certificate-templates/{templateId} | Get a platform certificate design |
15
+ | [**getPlatformCertificateTemplateList**](CertificateTemplateApi.md#getplatformcertificatetemplatelist) | **GET** /system/certificate-templates | List platform certificate designs |
16
+ | [**getPlatformCertificateTemplateVersions**](CertificateTemplateApi.md#getplatformcertificatetemplateversions) | **GET** /system/certificate-templates/{templateId}/versions | List platform certificate design version history |
17
+ | [**getPublicCertificateAsset**](CertificateTemplateApi.md#getpubliccertificateasset) | **GET** /public/certificate-assets/{assetId} | Read a managed certificate or badge image |
18
+ | [**postCertificateAssetComplete**](CertificateTemplateApi.md#postcertificateassetcomplete) | **POST** /certificate-assets/{assetId}/complete | Validate and complete a certificate image upload |
19
+ | [**postCertificateAssetUpload**](CertificateTemplateApi.md#postcertificateassetupload) | **POST** /certificate-assets/uploads | Create a portal certificate image upload |
20
+ | [**postCertificateTemplate**](CertificateTemplateApi.md#postcertificatetemplate) | **POST** /certificate-templates | Create a portal certificate design and initial draft |
21
+ | [**postCertificateTemplateArchive**](CertificateTemplateApi.md#postcertificatetemplatearchive) | **POST** /certificate-templates/{templateId}/archive | Archive a local certificate design |
22
+ | [**postCertificateTemplateClone**](CertificateTemplateApi.md#postcertificatetemplateclone) | **POST** /certificate-templates/{templateId}/clone | Clone an inherited or local design into the selected portal |
23
+ | [**postCertificateTemplateDraft**](CertificateTemplateApi.md#postcertificatetemplatedraft) | **POST** /certificate-templates/{templateId}/draft | Create a draft from the active version |
24
+ | [**postCertificateTemplateDraftPreview**](CertificateTemplateApi.md#postcertificatetemplatedraftpreview) | **POST** /certificate-templates/{templateId}/draft/preview | Canonically render the saved draft |
25
+ | [**postCertificateTemplatePreview**](CertificateTemplateApi.md#postcertificatetemplatepreview) | **POST** /certificate-templates/{templateId}/preview | Canonically render an unsaved canvas document |
26
+ | [**postCertificateTemplatePublish**](CertificateTemplateApi.md#postcertificatetemplatepublish) | **POST** /certificate-templates/{templateId}/publish | Publish and activate the current draft |
27
+ | [**postCertificateTemplateRestore**](CertificateTemplateApi.md#postcertificatetemplaterestore) | **POST** /certificate-templates/{templateId}/versions/{versionId}/restore | Restore a historical version into a new draft |
28
+ | [**postPlatformCertificateAssetComplete**](CertificateTemplateApi.md#postplatformcertificateassetcomplete) | **POST** /system/certificate-assets/{assetId}/complete | Complete a platform certificate image upload |
29
+ | [**postPlatformCertificateAssetUpload**](CertificateTemplateApi.md#postplatformcertificateassetupload) | **POST** /system/certificate-assets/uploads | Create a platform certificate image upload |
30
+ | [**postPlatformCertificateTemplate**](CertificateTemplateApi.md#postplatformcertificatetemplate) | **POST** /system/certificate-templates | Create a platform certificate design |
31
+ | [**postPlatformCertificateTemplateArchive**](CertificateTemplateApi.md#postplatformcertificatetemplatearchive) | **POST** /system/certificate-templates/{templateId}/archive | Archive a platform certificate design |
32
+ | [**postPlatformCertificateTemplateClone**](CertificateTemplateApi.md#postplatformcertificatetemplateclone) | **POST** /system/certificate-templates/{templateId}/clone | Clone a platform certificate design |
33
+ | [**postPlatformCertificateTemplateDraft**](CertificateTemplateApi.md#postplatformcertificatetemplatedraft) | **POST** /system/certificate-templates/{templateId}/draft | Create a platform certificate design draft |
34
+ | [**postPlatformCertificateTemplateDraftPreview**](CertificateTemplateApi.md#postplatformcertificatetemplatedraftpreview) | **POST** /system/certificate-templates/{templateId}/draft/preview | Render the saved platform certificate design draft |
35
+ | [**postPlatformCertificateTemplatePreview**](CertificateTemplateApi.md#postplatformcertificatetemplatepreview) | **POST** /system/certificate-templates/{templateId}/preview | Render an unsaved platform certificate design |
36
+ | [**postPlatformCertificateTemplatePublish**](CertificateTemplateApi.md#postplatformcertificatetemplatepublish) | **POST** /system/certificate-templates/{templateId}/publish | Publish a platform certificate design draft |
37
+ | [**postPlatformCertificateTemplateRestore**](CertificateTemplateApi.md#postplatformcertificatetemplaterestore) | **POST** /system/certificate-templates/{templateId}/versions/{versionId}/restore | Restore a platform certificate design version as a draft |
38
+ | [**putCertificateAssetFile**](CertificateTemplateApi.md#putcertificateassetfile) | **PUT** /certificate-assets/{assetId}/file | Upload certificate image bytes |
39
+ | [**putCertificateTemplate**](CertificateTemplateApi.md#putcertificatetemplate) | **PUT** /certificate-templates/{templateId} | Update local certificate design metadata |
40
+ | [**putCertificateTemplateDraft**](CertificateTemplateApi.md#putcertificatetemplatedraft) | **PUT** /certificate-templates/{templateId}/draft | Update a certificate design draft |
41
+ | [**putPlatformCertificateAssetFile**](CertificateTemplateApi.md#putplatformcertificateassetfile) | **PUT** /system/certificate-assets/{assetId}/file | Upload platform certificate image bytes |
42
+ | [**putPlatformCertificateTemplate**](CertificateTemplateApi.md#putplatformcertificatetemplate) | **PUT** /system/certificate-templates/{templateId} | Update platform certificate design metadata |
43
+ | [**putPlatformCertificateTemplateDraft**](CertificateTemplateApi.md#putplatformcertificatetemplatedraft) | **PUT** /system/certificate-templates/{templateId}/draft | Update a platform certificate design draft |
44
+
45
+
46
+
47
+ ## deleteCertificateTemplateDraft
48
+
49
+ > deleteCertificateTemplateDraft(templateId)
50
+
51
+ Discard the current certificate design draft
52
+
53
+ ### Example
54
+
55
+ ```ts
56
+ import {
57
+ Configuration,
58
+ CertificateTemplateApi,
59
+ } from '@easyedu/js-lsm-api';
60
+ import type { DeleteCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
61
+
62
+ async function example() {
63
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
64
+ const api = new CertificateTemplateApi();
65
+
66
+ const body = {
67
+ // string
68
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
69
+ } satisfies DeleteCertificateTemplateDraftRequest;
70
+
71
+ try {
72
+ const data = await api.deleteCertificateTemplateDraft(body);
73
+ console.log(data);
74
+ } catch (error) {
75
+ console.error(error);
76
+ }
77
+ }
78
+
79
+ // Run the test
80
+ example().catch(console.error);
81
+ ```
82
+
83
+ ### Parameters
84
+
85
+
86
+ | Name | Type | Description | Notes |
87
+ |------------- | ------------- | ------------- | -------------|
88
+ | **templateId** | `string` | | [Defaults to `undefined`] |
89
+
90
+ ### Return type
91
+
92
+ `void` (Empty response body)
93
+
94
+ ### Authorization
95
+
96
+ No authorization required
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: Not defined
101
+ - **Accept**: Not defined
102
+
103
+
104
+ ### HTTP response details
105
+ | Status code | Description | Response headers |
106
+ |-------------|-------------|------------------|
107
+ | **204** | Draft discarded | - |
108
+ | **404** | Draft not found | - |
109
+
110
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
111
+
112
+
113
+ ## deletePlatformCertificateTemplateDraft
114
+
115
+ > deletePlatformCertificateTemplateDraft(templateId)
116
+
117
+ Discard a platform certificate design draft
118
+
119
+ ### Example
120
+
121
+ ```ts
122
+ import {
123
+ Configuration,
124
+ CertificateTemplateApi,
125
+ } from '@easyedu/js-lsm-api';
126
+ import type { DeletePlatformCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
127
+
128
+ async function example() {
129
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
130
+ const api = new CertificateTemplateApi();
131
+
132
+ const body = {
133
+ // string
134
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
135
+ } satisfies DeletePlatformCertificateTemplateDraftRequest;
136
+
137
+ try {
138
+ const data = await api.deletePlatformCertificateTemplateDraft(body);
139
+ console.log(data);
140
+ } catch (error) {
141
+ console.error(error);
142
+ }
143
+ }
144
+
145
+ // Run the test
146
+ example().catch(console.error);
147
+ ```
148
+
149
+ ### Parameters
150
+
151
+
152
+ | Name | Type | Description | Notes |
153
+ |------------- | ------------- | ------------- | -------------|
154
+ | **templateId** | `string` | | [Defaults to `undefined`] |
155
+
156
+ ### Return type
157
+
158
+ `void` (Empty response body)
159
+
160
+ ### Authorization
161
+
162
+ No authorization required
163
+
164
+ ### HTTP request headers
165
+
166
+ - **Content-Type**: Not defined
167
+ - **Accept**: Not defined
168
+
169
+
170
+ ### HTTP response details
171
+ | Status code | Description | Response headers |
172
+ |-------------|-------------|------------------|
173
+ | **204** | Draft discarded | - |
174
+
175
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
176
+
177
+
178
+ ## getCertificateAsset
179
+
180
+ > Blob getCertificateAsset(assetId)
181
+
182
+ Read a portal certificate asset for design editing
183
+
184
+ ### Example
185
+
186
+ ```ts
187
+ import {
188
+ Configuration,
189
+ CertificateTemplateApi,
190
+ } from '@easyedu/js-lsm-api';
191
+ import type { GetCertificateAssetRequest } from '@easyedu/js-lsm-api';
192
+
193
+ async function example() {
194
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
195
+ const api = new CertificateTemplateApi();
196
+
197
+ const body = {
198
+ // string
199
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
200
+ } satisfies GetCertificateAssetRequest;
201
+
202
+ try {
203
+ const data = await api.getCertificateAsset(body);
204
+ console.log(data);
205
+ } catch (error) {
206
+ console.error(error);
207
+ }
208
+ }
209
+
210
+ // Run the test
211
+ example().catch(console.error);
212
+ ```
213
+
214
+ ### Parameters
215
+
216
+
217
+ | Name | Type | Description | Notes |
218
+ |------------- | ------------- | ------------- | -------------|
219
+ | **assetId** | `string` | | [Defaults to `undefined`] |
220
+
221
+ ### Return type
222
+
223
+ **Blob**
224
+
225
+ ### Authorization
226
+
227
+ No authorization required
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: `image/png`, `image/jpeg`, `image/webp`
233
+
234
+
235
+ ### HTTP response details
236
+ | Status code | Description | Response headers |
237
+ |-------------|-------------|------------------|
238
+ | **200** | Certificate image bytes | - |
239
+ | **404** | Asset not found | - |
240
+
241
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
242
+
243
+
244
+ ## getCertificateTemplate
245
+
246
+ > CertificateTemplate getCertificateTemplate(templateId)
247
+
248
+ Get a certificate design with draft and history
249
+
250
+ ### Example
251
+
252
+ ```ts
253
+ import {
254
+ Configuration,
255
+ CertificateTemplateApi,
256
+ } from '@easyedu/js-lsm-api';
257
+ import type { GetCertificateTemplateRequest } from '@easyedu/js-lsm-api';
258
+
259
+ async function example() {
260
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
261
+ const api = new CertificateTemplateApi();
262
+
263
+ const body = {
264
+ // string
265
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
266
+ } satisfies GetCertificateTemplateRequest;
267
+
268
+ try {
269
+ const data = await api.getCertificateTemplate(body);
270
+ console.log(data);
271
+ } catch (error) {
272
+ console.error(error);
273
+ }
274
+ }
275
+
276
+ // Run the test
277
+ example().catch(console.error);
278
+ ```
279
+
280
+ ### Parameters
281
+
282
+
283
+ | Name | Type | Description | Notes |
284
+ |------------- | ------------- | ------------- | -------------|
285
+ | **templateId** | `string` | | [Defaults to `undefined`] |
286
+
287
+ ### Return type
288
+
289
+ [**CertificateTemplate**](CertificateTemplate.md)
290
+
291
+ ### Authorization
292
+
293
+ No authorization required
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: Not defined
298
+ - **Accept**: `application/json`
299
+
300
+
301
+ ### HTTP response details
302
+ | Status code | Description | Response headers |
303
+ |-------------|-------------|------------------|
304
+ | **200** | Certificate design | - |
305
+ | **404** | Design not found | - |
306
+
307
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
308
+
309
+
310
+ ## getCertificateTemplateList
311
+
312
+ > GetCertificateTemplateList getCertificateTemplateList()
313
+
314
+ List local and inherited certificate designs
315
+
316
+ ### Example
317
+
318
+ ```ts
319
+ import {
320
+ Configuration,
321
+ CertificateTemplateApi,
322
+ } from '@easyedu/js-lsm-api';
323
+ import type { GetCertificateTemplateListRequest } from '@easyedu/js-lsm-api';
324
+
325
+ async function example() {
326
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
327
+ const api = new CertificateTemplateApi();
328
+
329
+ try {
330
+ const data = await api.getCertificateTemplateList();
331
+ console.log(data);
332
+ } catch (error) {
333
+ console.error(error);
334
+ }
335
+ }
336
+
337
+ // Run the test
338
+ example().catch(console.error);
339
+ ```
340
+
341
+ ### Parameters
342
+
343
+ This endpoint does not need any parameter.
344
+
345
+ ### Return type
346
+
347
+ [**GetCertificateTemplateList**](GetCertificateTemplateList.md)
348
+
349
+ ### Authorization
350
+
351
+ No authorization required
352
+
353
+ ### HTTP request headers
354
+
355
+ - **Content-Type**: Not defined
356
+ - **Accept**: `application/json`
357
+
358
+
359
+ ### HTTP response details
360
+ | Status code | Description | Response headers |
361
+ |-------------|-------------|------------------|
362
+ | **200** | Certificate designs | - |
363
+
364
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
365
+
366
+
367
+ ## getCertificateTemplateVersions
368
+
369
+ > Array<CertificateTemplateVersion> getCertificateTemplateVersions(templateId)
370
+
371
+ List certificate design version history
372
+
373
+ ### Example
374
+
375
+ ```ts
376
+ import {
377
+ Configuration,
378
+ CertificateTemplateApi,
379
+ } from '@easyedu/js-lsm-api';
380
+ import type { GetCertificateTemplateVersionsRequest } from '@easyedu/js-lsm-api';
381
+
382
+ async function example() {
383
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
384
+ const api = new CertificateTemplateApi();
385
+
386
+ const body = {
387
+ // string
388
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
389
+ } satisfies GetCertificateTemplateVersionsRequest;
390
+
391
+ try {
392
+ const data = await api.getCertificateTemplateVersions(body);
393
+ console.log(data);
394
+ } catch (error) {
395
+ console.error(error);
396
+ }
397
+ }
398
+
399
+ // Run the test
400
+ example().catch(console.error);
401
+ ```
402
+
403
+ ### Parameters
404
+
405
+
406
+ | Name | Type | Description | Notes |
407
+ |------------- | ------------- | ------------- | -------------|
408
+ | **templateId** | `string` | | [Defaults to `undefined`] |
409
+
410
+ ### Return type
411
+
412
+ [**Array<CertificateTemplateVersion>**](CertificateTemplateVersion.md)
413
+
414
+ ### Authorization
415
+
416
+ No authorization required
417
+
418
+ ### HTTP request headers
419
+
420
+ - **Content-Type**: Not defined
421
+ - **Accept**: `application/json`
422
+
423
+
424
+ ### HTTP response details
425
+ | Status code | Description | Response headers |
426
+ |-------------|-------------|------------------|
427
+ | **200** | Immutable published and archived versions plus any local draft | - |
428
+ | **404** | Certificate design not found | - |
429
+
430
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
431
+
432
+
433
+ ## getPlatformCertificateAsset
434
+
435
+ > Blob getPlatformCertificateAsset(assetId)
436
+
437
+ Read a platform certificate asset for design editing
438
+
439
+ ### Example
440
+
441
+ ```ts
442
+ import {
443
+ Configuration,
444
+ CertificateTemplateApi,
445
+ } from '@easyedu/js-lsm-api';
446
+ import type { GetPlatformCertificateAssetRequest } from '@easyedu/js-lsm-api';
447
+
448
+ async function example() {
449
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
450
+ const api = new CertificateTemplateApi();
451
+
452
+ const body = {
453
+ // string
454
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
455
+ } satisfies GetPlatformCertificateAssetRequest;
456
+
457
+ try {
458
+ const data = await api.getPlatformCertificateAsset(body);
459
+ console.log(data);
460
+ } catch (error) {
461
+ console.error(error);
462
+ }
463
+ }
464
+
465
+ // Run the test
466
+ example().catch(console.error);
467
+ ```
468
+
469
+ ### Parameters
470
+
471
+
472
+ | Name | Type | Description | Notes |
473
+ |------------- | ------------- | ------------- | -------------|
474
+ | **assetId** | `string` | | [Defaults to `undefined`] |
475
+
476
+ ### Return type
477
+
478
+ **Blob**
479
+
480
+ ### Authorization
481
+
482
+ No authorization required
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: Not defined
487
+ - **Accept**: `image/png`, `image/jpeg`, `image/webp`
488
+
489
+
490
+ ### HTTP response details
491
+ | Status code | Description | Response headers |
492
+ |-------------|-------------|------------------|
493
+ | **200** | Certificate image bytes | - |
494
+ | **404** | Asset not found | - |
495
+
496
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
497
+
498
+
499
+ ## getPlatformCertificateTemplate
500
+
501
+ > CertificateTemplate getPlatformCertificateTemplate(templateId)
502
+
503
+ Get a platform certificate design
504
+
505
+ ### Example
506
+
507
+ ```ts
508
+ import {
509
+ Configuration,
510
+ CertificateTemplateApi,
511
+ } from '@easyedu/js-lsm-api';
512
+ import type { GetPlatformCertificateTemplateRequest } from '@easyedu/js-lsm-api';
513
+
514
+ async function example() {
515
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
516
+ const api = new CertificateTemplateApi();
517
+
518
+ const body = {
519
+ // string
520
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
521
+ } satisfies GetPlatformCertificateTemplateRequest;
522
+
523
+ try {
524
+ const data = await api.getPlatformCertificateTemplate(body);
525
+ console.log(data);
526
+ } catch (error) {
527
+ console.error(error);
528
+ }
529
+ }
530
+
531
+ // Run the test
532
+ example().catch(console.error);
533
+ ```
534
+
535
+ ### Parameters
536
+
537
+
538
+ | Name | Type | Description | Notes |
539
+ |------------- | ------------- | ------------- | -------------|
540
+ | **templateId** | `string` | | [Defaults to `undefined`] |
541
+
542
+ ### Return type
543
+
544
+ [**CertificateTemplate**](CertificateTemplate.md)
545
+
546
+ ### Authorization
547
+
548
+ No authorization required
549
+
550
+ ### HTTP request headers
551
+
552
+ - **Content-Type**: Not defined
553
+ - **Accept**: `application/json`
554
+
555
+
556
+ ### HTTP response details
557
+ | Status code | Description | Response headers |
558
+ |-------------|-------------|------------------|
559
+ | **200** | Platform design | - |
560
+
561
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
562
+
563
+
564
+ ## getPlatformCertificateTemplateList
565
+
566
+ > GetCertificateTemplateList getPlatformCertificateTemplateList()
567
+
568
+ List platform certificate designs
569
+
570
+ ### Example
571
+
572
+ ```ts
573
+ import {
574
+ Configuration,
575
+ CertificateTemplateApi,
576
+ } from '@easyedu/js-lsm-api';
577
+ import type { GetPlatformCertificateTemplateListRequest } from '@easyedu/js-lsm-api';
578
+
579
+ async function example() {
580
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
581
+ const api = new CertificateTemplateApi();
582
+
583
+ try {
584
+ const data = await api.getPlatformCertificateTemplateList();
585
+ console.log(data);
586
+ } catch (error) {
587
+ console.error(error);
588
+ }
589
+ }
590
+
591
+ // Run the test
592
+ example().catch(console.error);
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ This endpoint does not need any parameter.
598
+
599
+ ### Return type
600
+
601
+ [**GetCertificateTemplateList**](GetCertificateTemplateList.md)
602
+
603
+ ### Authorization
604
+
605
+ No authorization required
606
+
607
+ ### HTTP request headers
608
+
609
+ - **Content-Type**: Not defined
610
+ - **Accept**: `application/json`
611
+
612
+
613
+ ### HTTP response details
614
+ | Status code | Description | Response headers |
615
+ |-------------|-------------|------------------|
616
+ | **200** | Platform designs | - |
617
+
618
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
619
+
620
+
621
+ ## getPlatformCertificateTemplateVersions
622
+
623
+ > Array<CertificateTemplateVersion> getPlatformCertificateTemplateVersions(templateId)
624
+
625
+ List platform certificate design version history
626
+
627
+ ### Example
628
+
629
+ ```ts
630
+ import {
631
+ Configuration,
632
+ CertificateTemplateApi,
633
+ } from '@easyedu/js-lsm-api';
634
+ import type { GetPlatformCertificateTemplateVersionsRequest } from '@easyedu/js-lsm-api';
635
+
636
+ async function example() {
637
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
638
+ const api = new CertificateTemplateApi();
639
+
640
+ const body = {
641
+ // string
642
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
643
+ } satisfies GetPlatformCertificateTemplateVersionsRequest;
644
+
645
+ try {
646
+ const data = await api.getPlatformCertificateTemplateVersions(body);
647
+ console.log(data);
648
+ } catch (error) {
649
+ console.error(error);
650
+ }
651
+ }
652
+
653
+ // Run the test
654
+ example().catch(console.error);
655
+ ```
656
+
657
+ ### Parameters
658
+
659
+
660
+ | Name | Type | Description | Notes |
661
+ |------------- | ------------- | ------------- | -------------|
662
+ | **templateId** | `string` | | [Defaults to `undefined`] |
663
+
664
+ ### Return type
665
+
666
+ [**Array<CertificateTemplateVersion>**](CertificateTemplateVersion.md)
667
+
668
+ ### Authorization
669
+
670
+ No authorization required
671
+
672
+ ### HTTP request headers
673
+
674
+ - **Content-Type**: Not defined
675
+ - **Accept**: `application/json`
676
+
677
+
678
+ ### HTTP response details
679
+ | Status code | Description | Response headers |
680
+ |-------------|-------------|------------------|
681
+ | **200** | Immutable published and archived versions plus any draft | - |
682
+ | **404** | Certificate design not found | - |
683
+
684
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
685
+
686
+
687
+ ## getPublicCertificateAsset
688
+
689
+ > Blob getPublicCertificateAsset(assetId)
690
+
691
+ Read a managed certificate or badge image
692
+
693
+ ### Example
694
+
695
+ ```ts
696
+ import {
697
+ Configuration,
698
+ CertificateTemplateApi,
699
+ } from '@easyedu/js-lsm-api';
700
+ import type { GetPublicCertificateAssetRequest } from '@easyedu/js-lsm-api';
701
+
702
+ async function example() {
703
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
704
+ const api = new CertificateTemplateApi();
705
+
706
+ const body = {
707
+ // string
708
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
709
+ } satisfies GetPublicCertificateAssetRequest;
710
+
711
+ try {
712
+ const data = await api.getPublicCertificateAsset(body);
713
+ console.log(data);
714
+ } catch (error) {
715
+ console.error(error);
716
+ }
717
+ }
718
+
719
+ // Run the test
720
+ example().catch(console.error);
721
+ ```
722
+
723
+ ### Parameters
724
+
725
+
726
+ | Name | Type | Description | Notes |
727
+ |------------- | ------------- | ------------- | -------------|
728
+ | **assetId** | `string` | | [Defaults to `undefined`] |
729
+
730
+ ### Return type
731
+
732
+ **Blob**
733
+
734
+ ### Authorization
735
+
736
+ No authorization required
737
+
738
+ ### HTTP request headers
739
+
740
+ - **Content-Type**: Not defined
741
+ - **Accept**: `image/png`, `image/jpeg`, `image/webp`
742
+
743
+
744
+ ### HTTP response details
745
+ | Status code | Description | Response headers |
746
+ |-------------|-------------|------------------|
747
+ | **200** | Managed image | - |
748
+ | **404** | Asset not found | - |
749
+
750
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
751
+
752
+
753
+ ## postCertificateAssetComplete
754
+
755
+ > GetCertificateAssetUpload postCertificateAssetComplete(assetId, postCertificateAssetComplete)
756
+
757
+ Validate and complete a certificate image upload
758
+
759
+ ### Example
760
+
761
+ ```ts
762
+ import {
763
+ Configuration,
764
+ CertificateTemplateApi,
765
+ } from '@easyedu/js-lsm-api';
766
+ import type { PostCertificateAssetCompleteRequest } from '@easyedu/js-lsm-api';
767
+
768
+ async function example() {
769
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
770
+ const api = new CertificateTemplateApi();
771
+
772
+ const body = {
773
+ // string
774
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
775
+ // PostCertificateAssetComplete
776
+ postCertificateAssetComplete: ...,
777
+ } satisfies PostCertificateAssetCompleteRequest;
778
+
779
+ try {
780
+ const data = await api.postCertificateAssetComplete(body);
781
+ console.log(data);
782
+ } catch (error) {
783
+ console.error(error);
784
+ }
785
+ }
786
+
787
+ // Run the test
788
+ example().catch(console.error);
789
+ ```
790
+
791
+ ### Parameters
792
+
793
+
794
+ | Name | Type | Description | Notes |
795
+ |------------- | ------------- | ------------- | -------------|
796
+ | **assetId** | `string` | | [Defaults to `undefined`] |
797
+ | **postCertificateAssetComplete** | [PostCertificateAssetComplete](PostCertificateAssetComplete.md) | | |
798
+
799
+ ### Return type
800
+
801
+ [**GetCertificateAssetUpload**](GetCertificateAssetUpload.md)
802
+
803
+ ### Authorization
804
+
805
+ No authorization required
806
+
807
+ ### HTTP request headers
808
+
809
+ - **Content-Type**: `application/json`
810
+ - **Accept**: `application/json`
811
+
812
+
813
+ ### HTTP response details
814
+ | Status code | Description | Response headers |
815
+ |-------------|-------------|------------------|
816
+ | **200** | Asset ready | - |
817
+
818
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
819
+
820
+
821
+ ## postCertificateAssetUpload
822
+
823
+ > GetCertificateAssetUpload postCertificateAssetUpload(postCertificateAssetUpload)
824
+
825
+ Create a portal certificate image upload
826
+
827
+ ### Example
828
+
829
+ ```ts
830
+ import {
831
+ Configuration,
832
+ CertificateTemplateApi,
833
+ } from '@easyedu/js-lsm-api';
834
+ import type { PostCertificateAssetUploadRequest } from '@easyedu/js-lsm-api';
835
+
836
+ async function example() {
837
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
838
+ const api = new CertificateTemplateApi();
839
+
840
+ const body = {
841
+ // PostCertificateAssetUpload
842
+ postCertificateAssetUpload: ...,
843
+ } satisfies PostCertificateAssetUploadRequest;
844
+
845
+ try {
846
+ const data = await api.postCertificateAssetUpload(body);
847
+ console.log(data);
848
+ } catch (error) {
849
+ console.error(error);
850
+ }
851
+ }
852
+
853
+ // Run the test
854
+ example().catch(console.error);
855
+ ```
856
+
857
+ ### Parameters
858
+
859
+
860
+ | Name | Type | Description | Notes |
861
+ |------------- | ------------- | ------------- | -------------|
862
+ | **postCertificateAssetUpload** | [PostCertificateAssetUpload](PostCertificateAssetUpload.md) | | |
863
+
864
+ ### Return type
865
+
866
+ [**GetCertificateAssetUpload**](GetCertificateAssetUpload.md)
867
+
868
+ ### Authorization
869
+
870
+ No authorization required
871
+
872
+ ### HTTP request headers
873
+
874
+ - **Content-Type**: `application/json`
875
+ - **Accept**: `application/json`
876
+
877
+
878
+ ### HTTP response details
879
+ | Status code | Description | Response headers |
880
+ |-------------|-------------|------------------|
881
+ | **201** | Upload created | - |
882
+
883
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
884
+
885
+
886
+ ## postCertificateTemplate
887
+
888
+ > CertificateTemplate postCertificateTemplate(postCertificateTemplate)
889
+
890
+ Create a portal certificate design and initial draft
891
+
892
+ ### Example
893
+
894
+ ```ts
895
+ import {
896
+ Configuration,
897
+ CertificateTemplateApi,
898
+ } from '@easyedu/js-lsm-api';
899
+ import type { PostCertificateTemplateRequest } from '@easyedu/js-lsm-api';
900
+
901
+ async function example() {
902
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
903
+ const api = new CertificateTemplateApi();
904
+
905
+ const body = {
906
+ // PostCertificateTemplate
907
+ postCertificateTemplate: ...,
908
+ } satisfies PostCertificateTemplateRequest;
909
+
910
+ try {
911
+ const data = await api.postCertificateTemplate(body);
912
+ console.log(data);
913
+ } catch (error) {
914
+ console.error(error);
915
+ }
916
+ }
917
+
918
+ // Run the test
919
+ example().catch(console.error);
920
+ ```
921
+
922
+ ### Parameters
923
+
924
+
925
+ | Name | Type | Description | Notes |
926
+ |------------- | ------------- | ------------- | -------------|
927
+ | **postCertificateTemplate** | [PostCertificateTemplate](PostCertificateTemplate.md) | | |
928
+
929
+ ### Return type
930
+
931
+ [**CertificateTemplate**](CertificateTemplate.md)
932
+
933
+ ### Authorization
934
+
935
+ No authorization required
936
+
937
+ ### HTTP request headers
938
+
939
+ - **Content-Type**: `application/json`
940
+ - **Accept**: `application/json`
941
+
942
+
943
+ ### HTTP response details
944
+ | Status code | Description | Response headers |
945
+ |-------------|-------------|------------------|
946
+ | **201** | Certificate design created | - |
947
+ | **409** | A default or draft conflicts with an existing design | - |
948
+
949
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
950
+
951
+
952
+ ## postCertificateTemplateArchive
953
+
954
+ > CertificateTemplate postCertificateTemplateArchive(templateId)
955
+
956
+ Archive a local certificate design
957
+
958
+ ### Example
959
+
960
+ ```ts
961
+ import {
962
+ Configuration,
963
+ CertificateTemplateApi,
964
+ } from '@easyedu/js-lsm-api';
965
+ import type { PostCertificateTemplateArchiveRequest } from '@easyedu/js-lsm-api';
966
+
967
+ async function example() {
968
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
969
+ const api = new CertificateTemplateApi();
970
+
971
+ const body = {
972
+ // string
973
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
974
+ } satisfies PostCertificateTemplateArchiveRequest;
975
+
976
+ try {
977
+ const data = await api.postCertificateTemplateArchive(body);
978
+ console.log(data);
979
+ } catch (error) {
980
+ console.error(error);
981
+ }
982
+ }
983
+
984
+ // Run the test
985
+ example().catch(console.error);
986
+ ```
987
+
988
+ ### Parameters
989
+
990
+
991
+ | Name | Type | Description | Notes |
992
+ |------------- | ------------- | ------------- | -------------|
993
+ | **templateId** | `string` | | [Defaults to `undefined`] |
994
+
995
+ ### Return type
996
+
997
+ [**CertificateTemplate**](CertificateTemplate.md)
998
+
999
+ ### Authorization
1000
+
1001
+ No authorization required
1002
+
1003
+ ### HTTP request headers
1004
+
1005
+ - **Content-Type**: Not defined
1006
+ - **Accept**: `application/json`
1007
+
1008
+
1009
+ ### HTTP response details
1010
+ | Status code | Description | Response headers |
1011
+ |-------------|-------------|------------------|
1012
+ | **200** | Archived design | - |
1013
+
1014
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1015
+
1016
+
1017
+ ## postCertificateTemplateClone
1018
+
1019
+ > CertificateTemplate postCertificateTemplateClone(templateId, postCertificateTemplateClone)
1020
+
1021
+ Clone an inherited or local design into the selected portal
1022
+
1023
+ ### Example
1024
+
1025
+ ```ts
1026
+ import {
1027
+ Configuration,
1028
+ CertificateTemplateApi,
1029
+ } from '@easyedu/js-lsm-api';
1030
+ import type { PostCertificateTemplateCloneRequest } from '@easyedu/js-lsm-api';
1031
+
1032
+ async function example() {
1033
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1034
+ const api = new CertificateTemplateApi();
1035
+
1036
+ const body = {
1037
+ // string
1038
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1039
+ // PostCertificateTemplateClone
1040
+ postCertificateTemplateClone: ...,
1041
+ } satisfies PostCertificateTemplateCloneRequest;
1042
+
1043
+ try {
1044
+ const data = await api.postCertificateTemplateClone(body);
1045
+ console.log(data);
1046
+ } catch (error) {
1047
+ console.error(error);
1048
+ }
1049
+ }
1050
+
1051
+ // Run the test
1052
+ example().catch(console.error);
1053
+ ```
1054
+
1055
+ ### Parameters
1056
+
1057
+
1058
+ | Name | Type | Description | Notes |
1059
+ |------------- | ------------- | ------------- | -------------|
1060
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1061
+ | **postCertificateTemplateClone** | [PostCertificateTemplateClone](PostCertificateTemplateClone.md) | | |
1062
+
1063
+ ### Return type
1064
+
1065
+ [**CertificateTemplate**](CertificateTemplate.md)
1066
+
1067
+ ### Authorization
1068
+
1069
+ No authorization required
1070
+
1071
+ ### HTTP request headers
1072
+
1073
+ - **Content-Type**: `application/json`
1074
+ - **Accept**: `application/json`
1075
+
1076
+
1077
+ ### HTTP response details
1078
+ | Status code | Description | Response headers |
1079
+ |-------------|-------------|------------------|
1080
+ | **201** | Local design clone | - |
1081
+
1082
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1083
+
1084
+
1085
+ ## postCertificateTemplateDraft
1086
+
1087
+ > CertificateTemplateVersion postCertificateTemplateDraft(templateId)
1088
+
1089
+ Create a draft from the active version
1090
+
1091
+ ### Example
1092
+
1093
+ ```ts
1094
+ import {
1095
+ Configuration,
1096
+ CertificateTemplateApi,
1097
+ } from '@easyedu/js-lsm-api';
1098
+ import type { PostCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
1099
+
1100
+ async function example() {
1101
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1102
+ const api = new CertificateTemplateApi();
1103
+
1104
+ const body = {
1105
+ // string
1106
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1107
+ } satisfies PostCertificateTemplateDraftRequest;
1108
+
1109
+ try {
1110
+ const data = await api.postCertificateTemplateDraft(body);
1111
+ console.log(data);
1112
+ } catch (error) {
1113
+ console.error(error);
1114
+ }
1115
+ }
1116
+
1117
+ // Run the test
1118
+ example().catch(console.error);
1119
+ ```
1120
+
1121
+ ### Parameters
1122
+
1123
+
1124
+ | Name | Type | Description | Notes |
1125
+ |------------- | ------------- | ------------- | -------------|
1126
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1127
+
1128
+ ### Return type
1129
+
1130
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
1131
+
1132
+ ### Authorization
1133
+
1134
+ No authorization required
1135
+
1136
+ ### HTTP request headers
1137
+
1138
+ - **Content-Type**: Not defined
1139
+ - **Accept**: `application/json`
1140
+
1141
+
1142
+ ### HTTP response details
1143
+ | Status code | Description | Response headers |
1144
+ |-------------|-------------|------------------|
1145
+ | **201** | Draft created | - |
1146
+ | **409** | A draft already exists | - |
1147
+
1148
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1149
+
1150
+
1151
+ ## postCertificateTemplateDraftPreview
1152
+
1153
+ > Blob postCertificateTemplateDraftPreview(templateId)
1154
+
1155
+ Canonically render the saved draft
1156
+
1157
+ ### Example
1158
+
1159
+ ```ts
1160
+ import {
1161
+ Configuration,
1162
+ CertificateTemplateApi,
1163
+ } from '@easyedu/js-lsm-api';
1164
+ import type { PostCertificateTemplateDraftPreviewRequest } from '@easyedu/js-lsm-api';
1165
+
1166
+ async function example() {
1167
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1168
+ const api = new CertificateTemplateApi();
1169
+
1170
+ const body = {
1171
+ // string
1172
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1173
+ } satisfies PostCertificateTemplateDraftPreviewRequest;
1174
+
1175
+ try {
1176
+ const data = await api.postCertificateTemplateDraftPreview(body);
1177
+ console.log(data);
1178
+ } catch (error) {
1179
+ console.error(error);
1180
+ }
1181
+ }
1182
+
1183
+ // Run the test
1184
+ example().catch(console.error);
1185
+ ```
1186
+
1187
+ ### Parameters
1188
+
1189
+
1190
+ | Name | Type | Description | Notes |
1191
+ |------------- | ------------- | ------------- | -------------|
1192
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1193
+
1194
+ ### Return type
1195
+
1196
+ **Blob**
1197
+
1198
+ ### Authorization
1199
+
1200
+ No authorization required
1201
+
1202
+ ### HTTP request headers
1203
+
1204
+ - **Content-Type**: Not defined
1205
+ - **Accept**: `application/pdf`
1206
+
1207
+
1208
+ ### HTTP response details
1209
+ | Status code | Description | Response headers |
1210
+ |-------------|-------------|------------------|
1211
+ | **200** | Canonical PDF preview | - |
1212
+ | **404** | Draft not found | - |
1213
+
1214
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1215
+
1216
+
1217
+ ## postCertificateTemplatePreview
1218
+
1219
+ > Blob postCertificateTemplatePreview(templateId, postCertificateTemplatePreview)
1220
+
1221
+ Canonically render an unsaved canvas document
1222
+
1223
+ ### Example
1224
+
1225
+ ```ts
1226
+ import {
1227
+ Configuration,
1228
+ CertificateTemplateApi,
1229
+ } from '@easyedu/js-lsm-api';
1230
+ import type { PostCertificateTemplatePreviewRequest } from '@easyedu/js-lsm-api';
1231
+
1232
+ async function example() {
1233
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1234
+ const api = new CertificateTemplateApi();
1235
+
1236
+ const body = {
1237
+ // string
1238
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1239
+ // PostCertificateTemplatePreview
1240
+ postCertificateTemplatePreview: ...,
1241
+ } satisfies PostCertificateTemplatePreviewRequest;
1242
+
1243
+ try {
1244
+ const data = await api.postCertificateTemplatePreview(body);
1245
+ console.log(data);
1246
+ } catch (error) {
1247
+ console.error(error);
1248
+ }
1249
+ }
1250
+
1251
+ // Run the test
1252
+ example().catch(console.error);
1253
+ ```
1254
+
1255
+ ### Parameters
1256
+
1257
+
1258
+ | Name | Type | Description | Notes |
1259
+ |------------- | ------------- | ------------- | -------------|
1260
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1261
+ | **postCertificateTemplatePreview** | [PostCertificateTemplatePreview](PostCertificateTemplatePreview.md) | | |
1262
+
1263
+ ### Return type
1264
+
1265
+ **Blob**
1266
+
1267
+ ### Authorization
1268
+
1269
+ No authorization required
1270
+
1271
+ ### HTTP request headers
1272
+
1273
+ - **Content-Type**: `application/json`
1274
+ - **Accept**: `application/pdf`
1275
+
1276
+
1277
+ ### HTTP response details
1278
+ | Status code | Description | Response headers |
1279
+ |-------------|-------------|------------------|
1280
+ | **200** | Canonical PDF preview | - |
1281
+ | **400** | Invalid canvas document or variables | - |
1282
+
1283
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1284
+
1285
+
1286
+ ## postCertificateTemplatePublish
1287
+
1288
+ > CertificateTemplateVersion postCertificateTemplatePublish(templateId)
1289
+
1290
+ Publish and activate the current draft
1291
+
1292
+ ### Example
1293
+
1294
+ ```ts
1295
+ import {
1296
+ Configuration,
1297
+ CertificateTemplateApi,
1298
+ } from '@easyedu/js-lsm-api';
1299
+ import type { PostCertificateTemplatePublishRequest } from '@easyedu/js-lsm-api';
1300
+
1301
+ async function example() {
1302
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1303
+ const api = new CertificateTemplateApi();
1304
+
1305
+ const body = {
1306
+ // string
1307
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1308
+ } satisfies PostCertificateTemplatePublishRequest;
1309
+
1310
+ try {
1311
+ const data = await api.postCertificateTemplatePublish(body);
1312
+ console.log(data);
1313
+ } catch (error) {
1314
+ console.error(error);
1315
+ }
1316
+ }
1317
+
1318
+ // Run the test
1319
+ example().catch(console.error);
1320
+ ```
1321
+
1322
+ ### Parameters
1323
+
1324
+
1325
+ | Name | Type | Description | Notes |
1326
+ |------------- | ------------- | ------------- | -------------|
1327
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1328
+
1329
+ ### Return type
1330
+
1331
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
1332
+
1333
+ ### Authorization
1334
+
1335
+ No authorization required
1336
+
1337
+ ### HTTP request headers
1338
+
1339
+ - **Content-Type**: Not defined
1340
+ - **Accept**: `application/json`
1341
+
1342
+
1343
+ ### HTTP response details
1344
+ | Status code | Description | Response headers |
1345
+ |-------------|-------------|------------------|
1346
+ | **200** | Published version | - |
1347
+ | **400** | Draft does not satisfy publication requirements | - |
1348
+ | **404** | Draft not found | - |
1349
+
1350
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1351
+
1352
+
1353
+ ## postCertificateTemplateRestore
1354
+
1355
+ > CertificateTemplateVersion postCertificateTemplateRestore(templateId, versionId)
1356
+
1357
+ Restore a historical version into a new draft
1358
+
1359
+ ### Example
1360
+
1361
+ ```ts
1362
+ import {
1363
+ Configuration,
1364
+ CertificateTemplateApi,
1365
+ } from '@easyedu/js-lsm-api';
1366
+ import type { PostCertificateTemplateRestoreRequest } from '@easyedu/js-lsm-api';
1367
+
1368
+ async function example() {
1369
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1370
+ const api = new CertificateTemplateApi();
1371
+
1372
+ const body = {
1373
+ // string
1374
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1375
+ // string
1376
+ versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1377
+ } satisfies PostCertificateTemplateRestoreRequest;
1378
+
1379
+ try {
1380
+ const data = await api.postCertificateTemplateRestore(body);
1381
+ console.log(data);
1382
+ } catch (error) {
1383
+ console.error(error);
1384
+ }
1385
+ }
1386
+
1387
+ // Run the test
1388
+ example().catch(console.error);
1389
+ ```
1390
+
1391
+ ### Parameters
1392
+
1393
+
1394
+ | Name | Type | Description | Notes |
1395
+ |------------- | ------------- | ------------- | -------------|
1396
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1397
+ | **versionId** | `string` | | [Defaults to `undefined`] |
1398
+
1399
+ ### Return type
1400
+
1401
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
1402
+
1403
+ ### Authorization
1404
+
1405
+ No authorization required
1406
+
1407
+ ### HTTP request headers
1408
+
1409
+ - **Content-Type**: Not defined
1410
+ - **Accept**: `application/json`
1411
+
1412
+
1413
+ ### HTTP response details
1414
+ | Status code | Description | Response headers |
1415
+ |-------------|-------------|------------------|
1416
+ | **201** | Restored draft | - |
1417
+
1418
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1419
+
1420
+
1421
+ ## postPlatformCertificateAssetComplete
1422
+
1423
+ > GetCertificateAssetUpload postPlatformCertificateAssetComplete(assetId, postCertificateAssetComplete)
1424
+
1425
+ Complete a platform certificate image upload
1426
+
1427
+ ### Example
1428
+
1429
+ ```ts
1430
+ import {
1431
+ Configuration,
1432
+ CertificateTemplateApi,
1433
+ } from '@easyedu/js-lsm-api';
1434
+ import type { PostPlatformCertificateAssetCompleteRequest } from '@easyedu/js-lsm-api';
1435
+
1436
+ async function example() {
1437
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1438
+ const api = new CertificateTemplateApi();
1439
+
1440
+ const body = {
1441
+ // string
1442
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1443
+ // PostCertificateAssetComplete
1444
+ postCertificateAssetComplete: ...,
1445
+ } satisfies PostPlatformCertificateAssetCompleteRequest;
1446
+
1447
+ try {
1448
+ const data = await api.postPlatformCertificateAssetComplete(body);
1449
+ console.log(data);
1450
+ } catch (error) {
1451
+ console.error(error);
1452
+ }
1453
+ }
1454
+
1455
+ // Run the test
1456
+ example().catch(console.error);
1457
+ ```
1458
+
1459
+ ### Parameters
1460
+
1461
+
1462
+ | Name | Type | Description | Notes |
1463
+ |------------- | ------------- | ------------- | -------------|
1464
+ | **assetId** | `string` | | [Defaults to `undefined`] |
1465
+ | **postCertificateAssetComplete** | [PostCertificateAssetComplete](PostCertificateAssetComplete.md) | | |
1466
+
1467
+ ### Return type
1468
+
1469
+ [**GetCertificateAssetUpload**](GetCertificateAssetUpload.md)
1470
+
1471
+ ### Authorization
1472
+
1473
+ No authorization required
1474
+
1475
+ ### HTTP request headers
1476
+
1477
+ - **Content-Type**: `application/json`
1478
+ - **Accept**: `application/json`
1479
+
1480
+
1481
+ ### HTTP response details
1482
+ | Status code | Description | Response headers |
1483
+ |-------------|-------------|------------------|
1484
+ | **200** | Asset ready | - |
1485
+
1486
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1487
+
1488
+
1489
+ ## postPlatformCertificateAssetUpload
1490
+
1491
+ > GetCertificateAssetUpload postPlatformCertificateAssetUpload(postCertificateAssetUpload)
1492
+
1493
+ Create a platform certificate image upload
1494
+
1495
+ ### Example
1496
+
1497
+ ```ts
1498
+ import {
1499
+ Configuration,
1500
+ CertificateTemplateApi,
1501
+ } from '@easyedu/js-lsm-api';
1502
+ import type { PostPlatformCertificateAssetUploadRequest } from '@easyedu/js-lsm-api';
1503
+
1504
+ async function example() {
1505
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1506
+ const api = new CertificateTemplateApi();
1507
+
1508
+ const body = {
1509
+ // PostCertificateAssetUpload
1510
+ postCertificateAssetUpload: ...,
1511
+ } satisfies PostPlatformCertificateAssetUploadRequest;
1512
+
1513
+ try {
1514
+ const data = await api.postPlatformCertificateAssetUpload(body);
1515
+ console.log(data);
1516
+ } catch (error) {
1517
+ console.error(error);
1518
+ }
1519
+ }
1520
+
1521
+ // Run the test
1522
+ example().catch(console.error);
1523
+ ```
1524
+
1525
+ ### Parameters
1526
+
1527
+
1528
+ | Name | Type | Description | Notes |
1529
+ |------------- | ------------- | ------------- | -------------|
1530
+ | **postCertificateAssetUpload** | [PostCertificateAssetUpload](PostCertificateAssetUpload.md) | | |
1531
+
1532
+ ### Return type
1533
+
1534
+ [**GetCertificateAssetUpload**](GetCertificateAssetUpload.md)
1535
+
1536
+ ### Authorization
1537
+
1538
+ No authorization required
1539
+
1540
+ ### HTTP request headers
1541
+
1542
+ - **Content-Type**: `application/json`
1543
+ - **Accept**: `application/json`
1544
+
1545
+
1546
+ ### HTTP response details
1547
+ | Status code | Description | Response headers |
1548
+ |-------------|-------------|------------------|
1549
+ | **201** | Upload created | - |
1550
+
1551
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1552
+
1553
+
1554
+ ## postPlatformCertificateTemplate
1555
+
1556
+ > CertificateTemplate postPlatformCertificateTemplate(postCertificateTemplate)
1557
+
1558
+ Create a platform certificate design
1559
+
1560
+ ### Example
1561
+
1562
+ ```ts
1563
+ import {
1564
+ Configuration,
1565
+ CertificateTemplateApi,
1566
+ } from '@easyedu/js-lsm-api';
1567
+ import type { PostPlatformCertificateTemplateRequest } from '@easyedu/js-lsm-api';
1568
+
1569
+ async function example() {
1570
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1571
+ const api = new CertificateTemplateApi();
1572
+
1573
+ const body = {
1574
+ // PostCertificateTemplate
1575
+ postCertificateTemplate: ...,
1576
+ } satisfies PostPlatformCertificateTemplateRequest;
1577
+
1578
+ try {
1579
+ const data = await api.postPlatformCertificateTemplate(body);
1580
+ console.log(data);
1581
+ } catch (error) {
1582
+ console.error(error);
1583
+ }
1584
+ }
1585
+
1586
+ // Run the test
1587
+ example().catch(console.error);
1588
+ ```
1589
+
1590
+ ### Parameters
1591
+
1592
+
1593
+ | Name | Type | Description | Notes |
1594
+ |------------- | ------------- | ------------- | -------------|
1595
+ | **postCertificateTemplate** | [PostCertificateTemplate](PostCertificateTemplate.md) | | |
1596
+
1597
+ ### Return type
1598
+
1599
+ [**CertificateTemplate**](CertificateTemplate.md)
1600
+
1601
+ ### Authorization
1602
+
1603
+ No authorization required
1604
+
1605
+ ### HTTP request headers
1606
+
1607
+ - **Content-Type**: `application/json`
1608
+ - **Accept**: `application/json`
1609
+
1610
+
1611
+ ### HTTP response details
1612
+ | Status code | Description | Response headers |
1613
+ |-------------|-------------|------------------|
1614
+ | **201** | Platform design created | - |
1615
+
1616
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1617
+
1618
+
1619
+ ## postPlatformCertificateTemplateArchive
1620
+
1621
+ > CertificateTemplate postPlatformCertificateTemplateArchive(templateId)
1622
+
1623
+ Archive a platform certificate design
1624
+
1625
+ ### Example
1626
+
1627
+ ```ts
1628
+ import {
1629
+ Configuration,
1630
+ CertificateTemplateApi,
1631
+ } from '@easyedu/js-lsm-api';
1632
+ import type { PostPlatformCertificateTemplateArchiveRequest } from '@easyedu/js-lsm-api';
1633
+
1634
+ async function example() {
1635
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1636
+ const api = new CertificateTemplateApi();
1637
+
1638
+ const body = {
1639
+ // string
1640
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1641
+ } satisfies PostPlatformCertificateTemplateArchiveRequest;
1642
+
1643
+ try {
1644
+ const data = await api.postPlatformCertificateTemplateArchive(body);
1645
+ console.log(data);
1646
+ } catch (error) {
1647
+ console.error(error);
1648
+ }
1649
+ }
1650
+
1651
+ // Run the test
1652
+ example().catch(console.error);
1653
+ ```
1654
+
1655
+ ### Parameters
1656
+
1657
+
1658
+ | Name | Type | Description | Notes |
1659
+ |------------- | ------------- | ------------- | -------------|
1660
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1661
+
1662
+ ### Return type
1663
+
1664
+ [**CertificateTemplate**](CertificateTemplate.md)
1665
+
1666
+ ### Authorization
1667
+
1668
+ No authorization required
1669
+
1670
+ ### HTTP request headers
1671
+
1672
+ - **Content-Type**: Not defined
1673
+ - **Accept**: `application/json`
1674
+
1675
+
1676
+ ### HTTP response details
1677
+ | Status code | Description | Response headers |
1678
+ |-------------|-------------|------------------|
1679
+ | **200** | Archived design | - |
1680
+
1681
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1682
+
1683
+
1684
+ ## postPlatformCertificateTemplateClone
1685
+
1686
+ > CertificateTemplate postPlatformCertificateTemplateClone(templateId, postCertificateTemplateClone)
1687
+
1688
+ Clone a platform certificate design
1689
+
1690
+ ### Example
1691
+
1692
+ ```ts
1693
+ import {
1694
+ Configuration,
1695
+ CertificateTemplateApi,
1696
+ } from '@easyedu/js-lsm-api';
1697
+ import type { PostPlatformCertificateTemplateCloneRequest } from '@easyedu/js-lsm-api';
1698
+
1699
+ async function example() {
1700
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1701
+ const api = new CertificateTemplateApi();
1702
+
1703
+ const body = {
1704
+ // string
1705
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1706
+ // PostCertificateTemplateClone
1707
+ postCertificateTemplateClone: ...,
1708
+ } satisfies PostPlatformCertificateTemplateCloneRequest;
1709
+
1710
+ try {
1711
+ const data = await api.postPlatformCertificateTemplateClone(body);
1712
+ console.log(data);
1713
+ } catch (error) {
1714
+ console.error(error);
1715
+ }
1716
+ }
1717
+
1718
+ // Run the test
1719
+ example().catch(console.error);
1720
+ ```
1721
+
1722
+ ### Parameters
1723
+
1724
+
1725
+ | Name | Type | Description | Notes |
1726
+ |------------- | ------------- | ------------- | -------------|
1727
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1728
+ | **postCertificateTemplateClone** | [PostCertificateTemplateClone](PostCertificateTemplateClone.md) | | |
1729
+
1730
+ ### Return type
1731
+
1732
+ [**CertificateTemplate**](CertificateTemplate.md)
1733
+
1734
+ ### Authorization
1735
+
1736
+ No authorization required
1737
+
1738
+ ### HTTP request headers
1739
+
1740
+ - **Content-Type**: `application/json`
1741
+ - **Accept**: `application/json`
1742
+
1743
+
1744
+ ### HTTP response details
1745
+ | Status code | Description | Response headers |
1746
+ |-------------|-------------|------------------|
1747
+ | **201** | Platform design clone | - |
1748
+
1749
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1750
+
1751
+
1752
+ ## postPlatformCertificateTemplateDraft
1753
+
1754
+ > CertificateTemplateVersion postPlatformCertificateTemplateDraft(templateId)
1755
+
1756
+ Create a platform certificate design draft
1757
+
1758
+ ### Example
1759
+
1760
+ ```ts
1761
+ import {
1762
+ Configuration,
1763
+ CertificateTemplateApi,
1764
+ } from '@easyedu/js-lsm-api';
1765
+ import type { PostPlatformCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
1766
+
1767
+ async function example() {
1768
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1769
+ const api = new CertificateTemplateApi();
1770
+
1771
+ const body = {
1772
+ // string
1773
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1774
+ } satisfies PostPlatformCertificateTemplateDraftRequest;
1775
+
1776
+ try {
1777
+ const data = await api.postPlatformCertificateTemplateDraft(body);
1778
+ console.log(data);
1779
+ } catch (error) {
1780
+ console.error(error);
1781
+ }
1782
+ }
1783
+
1784
+ // Run the test
1785
+ example().catch(console.error);
1786
+ ```
1787
+
1788
+ ### Parameters
1789
+
1790
+
1791
+ | Name | Type | Description | Notes |
1792
+ |------------- | ------------- | ------------- | -------------|
1793
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1794
+
1795
+ ### Return type
1796
+
1797
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
1798
+
1799
+ ### Authorization
1800
+
1801
+ No authorization required
1802
+
1803
+ ### HTTP request headers
1804
+
1805
+ - **Content-Type**: Not defined
1806
+ - **Accept**: `application/json`
1807
+
1808
+
1809
+ ### HTTP response details
1810
+ | Status code | Description | Response headers |
1811
+ |-------------|-------------|------------------|
1812
+ | **201** | Draft created | - |
1813
+
1814
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1815
+
1816
+
1817
+ ## postPlatformCertificateTemplateDraftPreview
1818
+
1819
+ > Blob postPlatformCertificateTemplateDraftPreview(templateId)
1820
+
1821
+ Render the saved platform certificate design draft
1822
+
1823
+ ### Example
1824
+
1825
+ ```ts
1826
+ import {
1827
+ Configuration,
1828
+ CertificateTemplateApi,
1829
+ } from '@easyedu/js-lsm-api';
1830
+ import type { PostPlatformCertificateTemplateDraftPreviewRequest } from '@easyedu/js-lsm-api';
1831
+
1832
+ async function example() {
1833
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1834
+ const api = new CertificateTemplateApi();
1835
+
1836
+ const body = {
1837
+ // string
1838
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1839
+ } satisfies PostPlatformCertificateTemplateDraftPreviewRequest;
1840
+
1841
+ try {
1842
+ const data = await api.postPlatformCertificateTemplateDraftPreview(body);
1843
+ console.log(data);
1844
+ } catch (error) {
1845
+ console.error(error);
1846
+ }
1847
+ }
1848
+
1849
+ // Run the test
1850
+ example().catch(console.error);
1851
+ ```
1852
+
1853
+ ### Parameters
1854
+
1855
+
1856
+ | Name | Type | Description | Notes |
1857
+ |------------- | ------------- | ------------- | -------------|
1858
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1859
+
1860
+ ### Return type
1861
+
1862
+ **Blob**
1863
+
1864
+ ### Authorization
1865
+
1866
+ No authorization required
1867
+
1868
+ ### HTTP request headers
1869
+
1870
+ - **Content-Type**: Not defined
1871
+ - **Accept**: `application/pdf`
1872
+
1873
+
1874
+ ### HTTP response details
1875
+ | Status code | Description | Response headers |
1876
+ |-------------|-------------|------------------|
1877
+ | **200** | Canonical PDF preview | - |
1878
+ | **404** | Draft not found | - |
1879
+
1880
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1881
+
1882
+
1883
+ ## postPlatformCertificateTemplatePreview
1884
+
1885
+ > Blob postPlatformCertificateTemplatePreview(templateId, postCertificateTemplatePreview)
1886
+
1887
+ Render an unsaved platform certificate design
1888
+
1889
+ ### Example
1890
+
1891
+ ```ts
1892
+ import {
1893
+ Configuration,
1894
+ CertificateTemplateApi,
1895
+ } from '@easyedu/js-lsm-api';
1896
+ import type { PostPlatformCertificateTemplatePreviewRequest } from '@easyedu/js-lsm-api';
1897
+
1898
+ async function example() {
1899
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1900
+ const api = new CertificateTemplateApi();
1901
+
1902
+ const body = {
1903
+ // string
1904
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1905
+ // PostCertificateTemplatePreview
1906
+ postCertificateTemplatePreview: ...,
1907
+ } satisfies PostPlatformCertificateTemplatePreviewRequest;
1908
+
1909
+ try {
1910
+ const data = await api.postPlatformCertificateTemplatePreview(body);
1911
+ console.log(data);
1912
+ } catch (error) {
1913
+ console.error(error);
1914
+ }
1915
+ }
1916
+
1917
+ // Run the test
1918
+ example().catch(console.error);
1919
+ ```
1920
+
1921
+ ### Parameters
1922
+
1923
+
1924
+ | Name | Type | Description | Notes |
1925
+ |------------- | ------------- | ------------- | -------------|
1926
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1927
+ | **postCertificateTemplatePreview** | [PostCertificateTemplatePreview](PostCertificateTemplatePreview.md) | | |
1928
+
1929
+ ### Return type
1930
+
1931
+ **Blob**
1932
+
1933
+ ### Authorization
1934
+
1935
+ No authorization required
1936
+
1937
+ ### HTTP request headers
1938
+
1939
+ - **Content-Type**: `application/json`
1940
+ - **Accept**: `application/pdf`
1941
+
1942
+
1943
+ ### HTTP response details
1944
+ | Status code | Description | Response headers |
1945
+ |-------------|-------------|------------------|
1946
+ | **200** | PDF preview | - |
1947
+
1948
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
1949
+
1950
+
1951
+ ## postPlatformCertificateTemplatePublish
1952
+
1953
+ > CertificateTemplateVersion postPlatformCertificateTemplatePublish(templateId)
1954
+
1955
+ Publish a platform certificate design draft
1956
+
1957
+ ### Example
1958
+
1959
+ ```ts
1960
+ import {
1961
+ Configuration,
1962
+ CertificateTemplateApi,
1963
+ } from '@easyedu/js-lsm-api';
1964
+ import type { PostPlatformCertificateTemplatePublishRequest } from '@easyedu/js-lsm-api';
1965
+
1966
+ async function example() {
1967
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
1968
+ const api = new CertificateTemplateApi();
1969
+
1970
+ const body = {
1971
+ // string
1972
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
1973
+ } satisfies PostPlatformCertificateTemplatePublishRequest;
1974
+
1975
+ try {
1976
+ const data = await api.postPlatformCertificateTemplatePublish(body);
1977
+ console.log(data);
1978
+ } catch (error) {
1979
+ console.error(error);
1980
+ }
1981
+ }
1982
+
1983
+ // Run the test
1984
+ example().catch(console.error);
1985
+ ```
1986
+
1987
+ ### Parameters
1988
+
1989
+
1990
+ | Name | Type | Description | Notes |
1991
+ |------------- | ------------- | ------------- | -------------|
1992
+ | **templateId** | `string` | | [Defaults to `undefined`] |
1993
+
1994
+ ### Return type
1995
+
1996
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
1997
+
1998
+ ### Authorization
1999
+
2000
+ No authorization required
2001
+
2002
+ ### HTTP request headers
2003
+
2004
+ - **Content-Type**: Not defined
2005
+ - **Accept**: `application/json`
2006
+
2007
+
2008
+ ### HTTP response details
2009
+ | Status code | Description | Response headers |
2010
+ |-------------|-------------|------------------|
2011
+ | **200** | Published version | - |
2012
+
2013
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2014
+
2015
+
2016
+ ## postPlatformCertificateTemplateRestore
2017
+
2018
+ > CertificateTemplateVersion postPlatformCertificateTemplateRestore(templateId, versionId)
2019
+
2020
+ Restore a platform certificate design version as a draft
2021
+
2022
+ ### Example
2023
+
2024
+ ```ts
2025
+ import {
2026
+ Configuration,
2027
+ CertificateTemplateApi,
2028
+ } from '@easyedu/js-lsm-api';
2029
+ import type { PostPlatformCertificateTemplateRestoreRequest } from '@easyedu/js-lsm-api';
2030
+
2031
+ async function example() {
2032
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2033
+ const api = new CertificateTemplateApi();
2034
+
2035
+ const body = {
2036
+ // string
2037
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2038
+ // string
2039
+ versionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2040
+ } satisfies PostPlatformCertificateTemplateRestoreRequest;
2041
+
2042
+ try {
2043
+ const data = await api.postPlatformCertificateTemplateRestore(body);
2044
+ console.log(data);
2045
+ } catch (error) {
2046
+ console.error(error);
2047
+ }
2048
+ }
2049
+
2050
+ // Run the test
2051
+ example().catch(console.error);
2052
+ ```
2053
+
2054
+ ### Parameters
2055
+
2056
+
2057
+ | Name | Type | Description | Notes |
2058
+ |------------- | ------------- | ------------- | -------------|
2059
+ | **templateId** | `string` | | [Defaults to `undefined`] |
2060
+ | **versionId** | `string` | | [Defaults to `undefined`] |
2061
+
2062
+ ### Return type
2063
+
2064
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
2065
+
2066
+ ### Authorization
2067
+
2068
+ No authorization required
2069
+
2070
+ ### HTTP request headers
2071
+
2072
+ - **Content-Type**: Not defined
2073
+ - **Accept**: `application/json`
2074
+
2075
+
2076
+ ### HTTP response details
2077
+ | Status code | Description | Response headers |
2078
+ |-------------|-------------|------------------|
2079
+ | **201** | Restored draft | - |
2080
+
2081
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2082
+
2083
+
2084
+ ## putCertificateAssetFile
2085
+
2086
+ > putCertificateAssetFile(assetId, body)
2087
+
2088
+ Upload certificate image bytes
2089
+
2090
+ ### Example
2091
+
2092
+ ```ts
2093
+ import {
2094
+ Configuration,
2095
+ CertificateTemplateApi,
2096
+ } from '@easyedu/js-lsm-api';
2097
+ import type { PutCertificateAssetFileRequest } from '@easyedu/js-lsm-api';
2098
+
2099
+ async function example() {
2100
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2101
+ const api = new CertificateTemplateApi();
2102
+
2103
+ const body = {
2104
+ // string
2105
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2106
+ // Blob
2107
+ body: BINARY_DATA_HERE,
2108
+ } satisfies PutCertificateAssetFileRequest;
2109
+
2110
+ try {
2111
+ const data = await api.putCertificateAssetFile(body);
2112
+ console.log(data);
2113
+ } catch (error) {
2114
+ console.error(error);
2115
+ }
2116
+ }
2117
+
2118
+ // Run the test
2119
+ example().catch(console.error);
2120
+ ```
2121
+
2122
+ ### Parameters
2123
+
2124
+
2125
+ | Name | Type | Description | Notes |
2126
+ |------------- | ------------- | ------------- | -------------|
2127
+ | **assetId** | `string` | | [Defaults to `undefined`] |
2128
+ | **body** | `Blob` | | |
2129
+
2130
+ ### Return type
2131
+
2132
+ `void` (Empty response body)
2133
+
2134
+ ### Authorization
2135
+
2136
+ No authorization required
2137
+
2138
+ ### HTTP request headers
2139
+
2140
+ - **Content-Type**: `image/png`, `image/jpeg`, `image/webp`
2141
+ - **Accept**: Not defined
2142
+
2143
+
2144
+ ### HTTP response details
2145
+ | Status code | Description | Response headers |
2146
+ |-------------|-------------|------------------|
2147
+ | **204** | Bytes uploaded | - |
2148
+
2149
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2150
+
2151
+
2152
+ ## putCertificateTemplate
2153
+
2154
+ > CertificateTemplate putCertificateTemplate(templateId, putCertificateTemplate)
2155
+
2156
+ Update local certificate design metadata
2157
+
2158
+ ### Example
2159
+
2160
+ ```ts
2161
+ import {
2162
+ Configuration,
2163
+ CertificateTemplateApi,
2164
+ } from '@easyedu/js-lsm-api';
2165
+ import type { PutCertificateTemplateRequest } from '@easyedu/js-lsm-api';
2166
+
2167
+ async function example() {
2168
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2169
+ const api = new CertificateTemplateApi();
2170
+
2171
+ const body = {
2172
+ // string
2173
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2174
+ // PutCertificateTemplate
2175
+ putCertificateTemplate: ...,
2176
+ } satisfies PutCertificateTemplateRequest;
2177
+
2178
+ try {
2179
+ const data = await api.putCertificateTemplate(body);
2180
+ console.log(data);
2181
+ } catch (error) {
2182
+ console.error(error);
2183
+ }
2184
+ }
2185
+
2186
+ // Run the test
2187
+ example().catch(console.error);
2188
+ ```
2189
+
2190
+ ### Parameters
2191
+
2192
+
2193
+ | Name | Type | Description | Notes |
2194
+ |------------- | ------------- | ------------- | -------------|
2195
+ | **templateId** | `string` | | [Defaults to `undefined`] |
2196
+ | **putCertificateTemplate** | [PutCertificateTemplate](PutCertificateTemplate.md) | | |
2197
+
2198
+ ### Return type
2199
+
2200
+ [**CertificateTemplate**](CertificateTemplate.md)
2201
+
2202
+ ### Authorization
2203
+
2204
+ No authorization required
2205
+
2206
+ ### HTTP request headers
2207
+
2208
+ - **Content-Type**: `application/json`
2209
+ - **Accept**: `application/json`
2210
+
2211
+
2212
+ ### HTTP response details
2213
+ | Status code | Description | Response headers |
2214
+ |-------------|-------------|------------------|
2215
+ | **200** | Certificate design updated | - |
2216
+ | **404** | Design not found | - |
2217
+
2218
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2219
+
2220
+
2221
+ ## putCertificateTemplateDraft
2222
+
2223
+ > CertificateTemplateVersion putCertificateTemplateDraft(templateId, putCertificateTemplateDraft)
2224
+
2225
+ Update a certificate design draft
2226
+
2227
+ ### Example
2228
+
2229
+ ```ts
2230
+ import {
2231
+ Configuration,
2232
+ CertificateTemplateApi,
2233
+ } from '@easyedu/js-lsm-api';
2234
+ import type { PutCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
2235
+
2236
+ async function example() {
2237
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2238
+ const api = new CertificateTemplateApi();
2239
+
2240
+ const body = {
2241
+ // string
2242
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2243
+ // PutCertificateTemplateDraft
2244
+ putCertificateTemplateDraft: ...,
2245
+ } satisfies PutCertificateTemplateDraftRequest;
2246
+
2247
+ try {
2248
+ const data = await api.putCertificateTemplateDraft(body);
2249
+ console.log(data);
2250
+ } catch (error) {
2251
+ console.error(error);
2252
+ }
2253
+ }
2254
+
2255
+ // Run the test
2256
+ example().catch(console.error);
2257
+ ```
2258
+
2259
+ ### Parameters
2260
+
2261
+
2262
+ | Name | Type | Description | Notes |
2263
+ |------------- | ------------- | ------------- | -------------|
2264
+ | **templateId** | `string` | | [Defaults to `undefined`] |
2265
+ | **putCertificateTemplateDraft** | [PutCertificateTemplateDraft](PutCertificateTemplateDraft.md) | | |
2266
+
2267
+ ### Return type
2268
+
2269
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
2270
+
2271
+ ### Authorization
2272
+
2273
+ No authorization required
2274
+
2275
+ ### HTTP request headers
2276
+
2277
+ - **Content-Type**: `application/json`
2278
+ - **Accept**: `application/json`
2279
+
2280
+
2281
+ ### HTTP response details
2282
+ | Status code | Description | Response headers |
2283
+ |-------------|-------------|------------------|
2284
+ | **200** | Draft updated | - |
2285
+ | **400** | Invalid canvas document | - |
2286
+ | **404** | Draft not found | - |
2287
+
2288
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2289
+
2290
+
2291
+ ## putPlatformCertificateAssetFile
2292
+
2293
+ > putPlatformCertificateAssetFile(assetId, body)
2294
+
2295
+ Upload platform certificate image bytes
2296
+
2297
+ ### Example
2298
+
2299
+ ```ts
2300
+ import {
2301
+ Configuration,
2302
+ CertificateTemplateApi,
2303
+ } from '@easyedu/js-lsm-api';
2304
+ import type { PutPlatformCertificateAssetFileRequest } from '@easyedu/js-lsm-api';
2305
+
2306
+ async function example() {
2307
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2308
+ const api = new CertificateTemplateApi();
2309
+
2310
+ const body = {
2311
+ // string
2312
+ assetId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2313
+ // Blob
2314
+ body: BINARY_DATA_HERE,
2315
+ } satisfies PutPlatformCertificateAssetFileRequest;
2316
+
2317
+ try {
2318
+ const data = await api.putPlatformCertificateAssetFile(body);
2319
+ console.log(data);
2320
+ } catch (error) {
2321
+ console.error(error);
2322
+ }
2323
+ }
2324
+
2325
+ // Run the test
2326
+ example().catch(console.error);
2327
+ ```
2328
+
2329
+ ### Parameters
2330
+
2331
+
2332
+ | Name | Type | Description | Notes |
2333
+ |------------- | ------------- | ------------- | -------------|
2334
+ | **assetId** | `string` | | [Defaults to `undefined`] |
2335
+ | **body** | `Blob` | | |
2336
+
2337
+ ### Return type
2338
+
2339
+ `void` (Empty response body)
2340
+
2341
+ ### Authorization
2342
+
2343
+ No authorization required
2344
+
2345
+ ### HTTP request headers
2346
+
2347
+ - **Content-Type**: `image/png`, `image/jpeg`, `image/webp`
2348
+ - **Accept**: Not defined
2349
+
2350
+
2351
+ ### HTTP response details
2352
+ | Status code | Description | Response headers |
2353
+ |-------------|-------------|------------------|
2354
+ | **204** | Bytes uploaded | - |
2355
+
2356
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2357
+
2358
+
2359
+ ## putPlatformCertificateTemplate
2360
+
2361
+ > CertificateTemplate putPlatformCertificateTemplate(templateId, putCertificateTemplate)
2362
+
2363
+ Update platform certificate design metadata
2364
+
2365
+ ### Example
2366
+
2367
+ ```ts
2368
+ import {
2369
+ Configuration,
2370
+ CertificateTemplateApi,
2371
+ } from '@easyedu/js-lsm-api';
2372
+ import type { PutPlatformCertificateTemplateRequest } from '@easyedu/js-lsm-api';
2373
+
2374
+ async function example() {
2375
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2376
+ const api = new CertificateTemplateApi();
2377
+
2378
+ const body = {
2379
+ // string
2380
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2381
+ // PutCertificateTemplate
2382
+ putCertificateTemplate: ...,
2383
+ } satisfies PutPlatformCertificateTemplateRequest;
2384
+
2385
+ try {
2386
+ const data = await api.putPlatformCertificateTemplate(body);
2387
+ console.log(data);
2388
+ } catch (error) {
2389
+ console.error(error);
2390
+ }
2391
+ }
2392
+
2393
+ // Run the test
2394
+ example().catch(console.error);
2395
+ ```
2396
+
2397
+ ### Parameters
2398
+
2399
+
2400
+ | Name | Type | Description | Notes |
2401
+ |------------- | ------------- | ------------- | -------------|
2402
+ | **templateId** | `string` | | [Defaults to `undefined`] |
2403
+ | **putCertificateTemplate** | [PutCertificateTemplate](PutCertificateTemplate.md) | | |
2404
+
2405
+ ### Return type
2406
+
2407
+ [**CertificateTemplate**](CertificateTemplate.md)
2408
+
2409
+ ### Authorization
2410
+
2411
+ No authorization required
2412
+
2413
+ ### HTTP request headers
2414
+
2415
+ - **Content-Type**: `application/json`
2416
+ - **Accept**: `application/json`
2417
+
2418
+
2419
+ ### HTTP response details
2420
+ | Status code | Description | Response headers |
2421
+ |-------------|-------------|------------------|
2422
+ | **200** | Platform design updated | - |
2423
+
2424
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2425
+
2426
+
2427
+ ## putPlatformCertificateTemplateDraft
2428
+
2429
+ > CertificateTemplateVersion putPlatformCertificateTemplateDraft(templateId, putCertificateTemplateDraft)
2430
+
2431
+ Update a platform certificate design draft
2432
+
2433
+ ### Example
2434
+
2435
+ ```ts
2436
+ import {
2437
+ Configuration,
2438
+ CertificateTemplateApi,
2439
+ } from '@easyedu/js-lsm-api';
2440
+ import type { PutPlatformCertificateTemplateDraftRequest } from '@easyedu/js-lsm-api';
2441
+
2442
+ async function example() {
2443
+ console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
2444
+ const api = new CertificateTemplateApi();
2445
+
2446
+ const body = {
2447
+ // string
2448
+ templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
2449
+ // PutCertificateTemplateDraft
2450
+ putCertificateTemplateDraft: ...,
2451
+ } satisfies PutPlatformCertificateTemplateDraftRequest;
2452
+
2453
+ try {
2454
+ const data = await api.putPlatformCertificateTemplateDraft(body);
2455
+ console.log(data);
2456
+ } catch (error) {
2457
+ console.error(error);
2458
+ }
2459
+ }
2460
+
2461
+ // Run the test
2462
+ example().catch(console.error);
2463
+ ```
2464
+
2465
+ ### Parameters
2466
+
2467
+
2468
+ | Name | Type | Description | Notes |
2469
+ |------------- | ------------- | ------------- | -------------|
2470
+ | **templateId** | `string` | | [Defaults to `undefined`] |
2471
+ | **putCertificateTemplateDraft** | [PutCertificateTemplateDraft](PutCertificateTemplateDraft.md) | | |
2472
+
2473
+ ### Return type
2474
+
2475
+ [**CertificateTemplateVersion**](CertificateTemplateVersion.md)
2476
+
2477
+ ### Authorization
2478
+
2479
+ No authorization required
2480
+
2481
+ ### HTTP request headers
2482
+
2483
+ - **Content-Type**: `application/json`
2484
+ - **Accept**: `application/json`
2485
+
2486
+
2487
+ ### HTTP response details
2488
+ | Status code | Description | Response headers |
2489
+ |-------------|-------------|------------------|
2490
+ | **200** | Draft updated | - |
2491
+
2492
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
2493
+