@easyedu/js-lsm-api 1.83.0 → 1.85.0

package/docs/GetEmailTemplate.md

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

package/docs/GetEmailTemplateList.md

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

package/docs/GetEmailTemplatePreview.md

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

package/docs/GetResource.md

@@ -0,0 +1,62 @@
+
+# GetResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`resourceType` | [ResourceType](ResourceType.md)
+`ownerId` | string
+`latestPublishedVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
+`draftVersion` | [GetContentLibraryVersion](GetContentLibraryVersion.md)
+`versions` | [Array<GetContentLibraryVersion>](GetContentLibraryVersion.md)
+`publishedCourseCount` | number
+`draftCourseCount` | number
+`historicalCourseCount` | number
+`activeLearnerCount` | number
+`createdAt` | number
+`updatedAt` | number
+`archivedAt` | number
+
+## Example
+
+```typescript
+import type { GetResource } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "resourceType": null,
+  "ownerId": null,
+  "latestPublishedVersion": null,
+  "draftVersion": null,
+  "versions": null,
+  "publishedCourseCount": null,
+  "draftCourseCount": null,
+  "historicalCourseCount": null,
+  "activeLearnerCount": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "archivedAt": null,
+} satisfies GetResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetResourceList.md

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

package/docs/GetResourceUsage.md

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

package/docs/GetResourceUsageCoursesInner.md

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

package/docs/GetResourceVersionUpload.md

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