@easyedu/js-lsm-api 1.125.0 → 1.126.0

package/dist/models/PostPortalCertificateTemplate.js

@@ -0,0 +1,59 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPostPortalCertificateTemplate = instanceOfPostPortalCertificateTemplate;
+exports.PostPortalCertificateTemplateFromJSON = PostPortalCertificateTemplateFromJSON;
+exports.PostPortalCertificateTemplateFromJSONTyped = PostPortalCertificateTemplateFromJSONTyped;
+exports.PostPortalCertificateTemplateToJSON = PostPortalCertificateTemplateToJSON;
+exports.PostPortalCertificateTemplateToJSONTyped = PostPortalCertificateTemplateToJSONTyped;
+const CertificateCanvasDocument_1 = require("./CertificateCanvasDocument");
+/**
+ * Check if a given object implements the PostPortalCertificateTemplate interface.
+ */
+function instanceOfPostPortalCertificateTemplate(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function PostPortalCertificateTemplateFromJSON(json) {
+    return PostPortalCertificateTemplateFromJSONTyped(json, false);
+}
+function PostPortalCertificateTemplateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'designDocument': json['design_document'] == null ? undefined : (0, CertificateCanvasDocument_1.CertificateCanvasDocumentFromJSON)(json['design_document']),
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+    };
+}
+function PostPortalCertificateTemplateToJSON(json) {
+    return PostPortalCertificateTemplateToJSONTyped(json, false);
+}
+function PostPortalCertificateTemplateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'design_document': (0, CertificateCanvasDocument_1.CertificateCanvasDocumentToJSON)(value['designDocument']),
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
+    };
+}

package/dist/models/PutCourse.d.ts

@@ -57,6 +57,12 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     accessFixedEndAt?: number | null;
+    /**
+     *
+     * @type {Set<string>}
+     * @memberof PutCourse
+     */
+    tags?: Set<string>;
 }
 /**
  * @export

package/dist/models/PutCourse.js

@@ -48,6 +48,7 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'accessPolicyType': json['access_policy_type'] == null ? undefined : json['access_policy_type'],
         'accessDurationDays': json['access_duration_days'] == null ? undefined : json['access_duration_days'],
         'accessFixedEndAt': json['access_fixed_end_at'] == null ? undefined : json['access_fixed_end_at'],
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
     };
 }
 function PutCourseToJSON(json) {
@@ -64,5 +65,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'access_policy_type': value['accessPolicyType'],
         'access_duration_days': value['accessDurationDays'],
         'access_fixed_end_at': value['accessFixedEndAt'],
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
     };
 }

package/dist/models/PutPortalCertificateTemplate.d.ts

@@ -0,0 +1,50 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface PutPortalCertificateTemplate
+ */
+export interface PutPortalCertificateTemplate {
+    /**
+     *
+     * @type {string}
+     * @memberof PutPortalCertificateTemplate
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PutPortalCertificateTemplate
+     */
+    description?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PutPortalCertificateTemplate
+     */
+    isDefault?: boolean;
+    /**
+     *
+     * @type {Set<string>}
+     * @memberof PutPortalCertificateTemplate
+     */
+    tags?: Set<string>;
+}
+/**
+ * Check if a given object implements the PutPortalCertificateTemplate interface.
+ */
+export declare function instanceOfPutPortalCertificateTemplate(value: object): value is PutPortalCertificateTemplate;
+export declare function PutPortalCertificateTemplateFromJSON(json: any): PutPortalCertificateTemplate;
+export declare function PutPortalCertificateTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalCertificateTemplate;
+export declare function PutPortalCertificateTemplateToJSON(json: any): PutPortalCertificateTemplate;
+export declare function PutPortalCertificateTemplateToJSONTyped(value?: PutPortalCertificateTemplate | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutPortalCertificateTemplate.js

@@ -0,0 +1,54 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfPutPortalCertificateTemplate = instanceOfPutPortalCertificateTemplate;
+exports.PutPortalCertificateTemplateFromJSON = PutPortalCertificateTemplateFromJSON;
+exports.PutPortalCertificateTemplateFromJSONTyped = PutPortalCertificateTemplateFromJSONTyped;
+exports.PutPortalCertificateTemplateToJSON = PutPortalCertificateTemplateToJSON;
+exports.PutPortalCertificateTemplateToJSONTyped = PutPortalCertificateTemplateToJSONTyped;
+/**
+ * Check if a given object implements the PutPortalCertificateTemplate interface.
+ */
+function instanceOfPutPortalCertificateTemplate(value) {
+    return true;
+}
+function PutPortalCertificateTemplateFromJSON(json) {
+    return PutPortalCertificateTemplateFromJSONTyped(json, false);
+}
+function PutPortalCertificateTemplateFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'isDefault': json['is_default'] == null ? undefined : json['is_default'],
+        'tags': json['tags'] == null ? undefined : new Set(json['tags']),
+    };
+}
+function PutPortalCertificateTemplateToJSON(json) {
+    return PutPortalCertificateTemplateToJSONTyped(json, false);
+}
+function PutPortalCertificateTemplateToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'description': value['description'],
+        'is_default': value['isDefault'],
+        'tags': value['tags'] == null ? undefined : Array.from(value['tags']),
+    };
+}

package/dist/models/index.d.ts

@@ -263,6 +263,7 @@ export * from './PostOfferCatalogResponse';
 export * from './PostOfferCourse';
 export * from './PostOfferCourseResponse';
 export * from './PostPortal';
+export * from './PostPortalCertificateTemplate';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
 export * from './PostQuestionAnswerChoicesInner';
@@ -322,6 +323,7 @@ export * from './PutLibraryQuizSessionGrade';
 export * from './PutLibraryQuizSessionOverride';
 export * from './PutLibraryQuizVersion';
 export * from './PutPortalBranding';
+export * from './PutPortalCertificateTemplate';
 export * from './PutPortalSublicense';
 export * from './PutPortalUserFieldValues';
 export * from './PutQuestion';

package/dist/models/index.js

@@ -281,6 +281,7 @@ __exportStar(require("./PostOfferCatalogResponse"), exports);
 __exportStar(require("./PostOfferCourse"), exports);
 __exportStar(require("./PostOfferCourseResponse"), exports);
 __exportStar(require("./PostPortal"), exports);
+__exportStar(require("./PostPortalCertificateTemplate"), exports);
 __exportStar(require("./PostPortalInvite"), exports);
 __exportStar(require("./PostQuestion"), exports);
 __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
@@ -340,6 +341,7 @@ __exportStar(require("./PutLibraryQuizSessionGrade"), exports);
 __exportStar(require("./PutLibraryQuizSessionOverride"), exports);
 __exportStar(require("./PutLibraryQuizVersion"), exports);
 __exportStar(require("./PutPortalBranding"), exports);
+__exportStar(require("./PutPortalCertificateTemplate"), exports);
 __exportStar(require("./PutPortalSublicense"), exports);
 __exportStar(require("./PutPortalUserFieldValues"), exports);
 __exportStar(require("./PutQuestion"), exports);

package/docs/CertificateTemplate.md

@@ -14,6 +14,7 @@ Name | Type
 `isInherited` | boolean
 `effectiveSource` | string
 `effectiveSourcePortalId` | string
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 `activeVersion` | [CertificateTemplateVersion](CertificateTemplateVersion.md)
 `draftVersion` | [CertificateTemplateVersion](CertificateTemplateVersion.md)
 `versions` | [Array<CertificateTemplateVersion>](CertificateTemplateVersion.md)
@@ -36,6 +37,7 @@ const example = {
   "isInherited": null,
   "effectiveSource": null,
   "effectiveSourcePortalId": null,
+  "tags": null,
   "activeVersion": null,
   "draftVersion": null,
   "versions": null,

package/docs/CertificateTemplateApi.md

@@ -309,7 +309,7 @@ No authorization required
 
 ## getCertificateTemplateList
 
-> GetCertificateTemplateList getCertificateTemplateList()
+> GetCertificateTemplateList getCertificateTemplateList(tagId)
 
 List local and inherited certificate designs
 
@@ -326,8 +326,13 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CertificateTemplateApi();
 
+  const body = {
+    // string | Return locally owned certificate designs assigned to this portal tag. (optional)
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCertificateTemplateListRequest;
+
   try {
-    const data = await api.getCertificateTemplateList();
+    const data = await api.getCertificateTemplateList(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -340,7 +345,10 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tagId** | `string` | Return locally owned certificate designs assigned to this portal tag. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -885,7 +893,7 @@ No authorization required
 
 ## postCertificateTemplate
 
-> CertificateTemplate postCertificateTemplate(postCertificateTemplate)
+> CertificateTemplate postCertificateTemplate(postPortalCertificateTemplate)
 
 Create a portal certificate design and initial draft
 
@@ -903,8 +911,8 @@ async function example() {
   const api = new CertificateTemplateApi();
 
   const body = {
-    // PostCertificateTemplate
-    postCertificateTemplate: ...,
+    // PostPortalCertificateTemplate
+    postPortalCertificateTemplate: ...,
   } satisfies PostCertificateTemplateRequest;
 
   try {
@@ -924,7 +932,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **postCertificateTemplate** | [PostCertificateTemplate](PostCertificateTemplate.md) |  | |
+| **postPortalCertificateTemplate** | [PostPortalCertificateTemplate](PostPortalCertificateTemplate.md) |  | |
 
 ### Return type
 
@@ -2151,7 +2159,7 @@ No authorization required
 
 ## putCertificateTemplate
 
-> CertificateTemplate putCertificateTemplate(templateId, putCertificateTemplate)
+> CertificateTemplate putCertificateTemplate(templateId, putPortalCertificateTemplate)
 
 Update local certificate design metadata
 
@@ -2171,8 +2179,8 @@ async function example() {
   const body = {
     // string
     templateId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // PutCertificateTemplate
-    putCertificateTemplate: ...,
+    // PutPortalCertificateTemplate
+    putPortalCertificateTemplate: ...,
   } satisfies PutCertificateTemplateRequest;
 
   try {
@@ -2193,7 +2201,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **templateId** | `string` |  | [Defaults to `undefined`] |
-| **putCertificateTemplate** | [PutCertificateTemplate](PutCertificateTemplate.md) |  | |
+| **putPortalCertificateTemplate** | [PutPortalCertificateTemplate](PutPortalCertificateTemplate.md) |  | |
 
 ### Return type
 

package/docs/ContentLibraryApi.md

@@ -8,7 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**deleteResourceVersion**](ContentLibraryApi.md#deleteresourceversion) | **DELETE** /content-library/resources/{resourceId}/versions/{versionId} | Discard an unreferenced draft resource version |
 | [**getContentLibraryItemList**](ContentLibraryApi.md#getcontentlibraryitemlist) | **GET** /content-library/items | Search Content Library items |
 | [**getContentLibraryTag**](ContentLibraryApi.md#getcontentlibrarytag) | **GET** /content-library/tags/{tagId} | Get a Content Library tag |
-| [**getContentLibraryTagItemList**](ContentLibraryApi.md#getcontentlibrarytagitemlist) | **GET** /content-library/tags/{tagId}/items | List resources, quizzes, and questions associated with a tag |
+| [**getContentLibraryTagItemList**](ContentLibraryApi.md#getcontentlibrarytagitemlist) | **GET** /content-library/tags/{tagId}/items | List resources, quizzes, questions, courses, and certificate designs associated with a tag |
 | [**getContentLibraryTagList**](ContentLibraryApi.md#getcontentlibrarytaglist) | **GET** /content-library/tags | List portal Content Library tags |
 | [**getResource**](ContentLibraryApi.md#getresource) | **GET** /content-library/resources/{resourceId} | Get a resource and all versions |
 | [**getResourceList**](ContentLibraryApi.md#getresourcelist) | **GET** /content-library/resources | List reusable resources |
@@ -318,7 +318,7 @@ No authorization required
 
 > GetContentLibraryTagItemList getContentLibraryTagItemList(tagId, kind, search, includeArchived, page, pageSize)
 
-List resources, quizzes, and questions associated with a tag
+List resources, quizzes, questions, courses, and certificate designs associated with a tag
 
 ### Example
 
@@ -336,7 +336,7 @@ async function example() {
   const body = {
     // string
     tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
-    // 'resource' | 'quiz' | 'question' (optional)
+    // 'resource' | 'quiz' | 'question' | 'course' | 'certificate_template' (optional)
     kind: kind_example,
     // string (optional)
     search: search_example,
@@ -366,7 +366,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **tagId** | `string` |  | [Defaults to `undefined`] |
-| **kind** | `resource`, `quiz`, `question` |  | [Optional] [Defaults to `undefined`] [Enum: resource, quiz, question] |
+| **kind** | `resource`, `quiz`, `question`, `course`, `certificate_template` |  | [Optional] [Defaults to `undefined`] [Enum: resource, quiz, question, course, certificate_template] |
 | **search** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **includeArchived** | `boolean` |  | [Optional] [Defaults to `false`] |
 | **page** | `number` |  | [Optional] [Defaults to `1`] |

package/docs/ContentLibraryTag.md

@@ -18,6 +18,8 @@ Name | Type
 `resourceCount` | number
 `quizCount` | number
 `questionCount` | number
+`courseCount` | number
+`certificateTemplateCount` | number
 `createdAt` | number
 `updatedAt` | number
 
@@ -40,6 +42,8 @@ const example = {
   "resourceCount": null,
   "quizCount": null,
   "questionCount": null,
+  "courseCount": null,
+  "certificateTemplateCount": null,
   "createdAt": null,
   "updatedAt": null,
 } satisfies ContentLibraryTag

package/docs/CourseApi.md

@@ -1034,7 +1034,7 @@ No authorization required
 
 ## getCourseList
 
-> GetCourseList getCourseList(page, pageSize, enrolled, search, recentActivitySince)
+> GetCourseList getCourseList(page, pageSize, enrolled, search, recentActivitySince, tagId)
 
 get course list
 
@@ -1062,6 +1062,8 @@ async function example() {
     search: search_example,
     // number | Unix timestamp in seconds. Filters to courses with live content activity updated at or after this time in the selected portal. (optional)
     recentActivitySince: 789,
+    // string | Return portal-owned courses assigned to this portal tag. (optional)
+    tagId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies GetCourseListRequest;
 
   try {
@@ -1086,6 +1088,7 @@ example().catch(console.error);
 | **enrolled** | `boolean` | Filter to only courses the authenticated user is enrolled in | [Optional] [Defaults to `undefined`] |
 | **search** | `string` | Case-insensitive substring match against course name or description | [Optional] [Defaults to `undefined`] |
 | **recentActivitySince** | `number` | Unix timestamp in seconds. Filters to courses with live content activity updated at or after this time in the selected portal. | [Optional] [Defaults to `undefined`] |
+| **tagId** | `string` | Return portal-owned courses assigned to this portal tag. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -1610,7 +1613,7 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | post course response OK |  -  |
+| **201** | post course response OK |  -  |
 
 [[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/GetCourse.md

@@ -15,6 +15,7 @@ Name | Type
 `accessPolicyType` | string
 `accessDurationDays` | number
 `accessFixedEndAt` | number
+`tags` | [Array<ContentLibraryTag>](ContentLibraryTag.md)
 
 ## Example
 
@@ -32,6 +33,7 @@ const example = {
   "accessPolicyType": null,
   "accessDurationDays": null,
   "accessFixedEndAt": null,
+  "tags": null,
 } satisfies GetCourse
 
 console.log(example)

package/docs/PostCourse.md

@@ -11,6 +11,7 @@ Name | Type
 `accessPolicyType` | string
 `accessDurationDays` | number
 `accessFixedEndAt` | number
+`tags` | Set<string>
 
 ## Example
 
@@ -24,6 +25,7 @@ const example = {
   "accessPolicyType": null,
   "accessDurationDays": null,
   "accessFixedEndAt": null,
+  "tags": null,
 } satisfies PostCourse
 
 console.log(example)

package/docs/PostPortalCertificateTemplate.md

@@ -0,0 +1,42 @@
+
+# PostPortalCertificateTemplate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`isDefault` | boolean
+`designDocument` | [CertificateCanvasDocument](CertificateCanvasDocument.md)
+`tags` | Set<string>
+
+## Example
+
+```typescript
+import type { PostPortalCertificateTemplate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "isDefault": null,
+  "designDocument": null,
+  "tags": null,
+} satisfies PostPortalCertificateTemplate
+
+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 PostPortalCertificateTemplate
+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/PutCourse.md

@@ -13,6 +13,7 @@ Name | Type
 `accessPolicyType` | string
 `accessDurationDays` | number
 `accessFixedEndAt` | number
+`tags` | Set<string>
 
 ## Example
 
@@ -28,6 +29,7 @@ const example = {
   "accessPolicyType": null,
   "accessDurationDays": null,
   "accessFixedEndAt": null,
+  "tags": null,
 } satisfies PutCourse
 
 console.log(example)

package/docs/PutPortalCertificateTemplate.md

@@ -0,0 +1,40 @@
+
+# PutPortalCertificateTemplate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`isDefault` | boolean
+`tags` | Set<string>
+
+## Example
+
+```typescript
+import type { PutPortalCertificateTemplate } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "isDefault": null,
+  "tags": null,
+} satisfies PutPortalCertificateTemplate
+
+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 PutPortalCertificateTemplate
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

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