@easyedu/js-lsm-api 1.107.0 → 1.108.0

package/dist/esm/models/GetCourseShareList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+import type { CourseShare } from './CourseShare';
+/**
+ *
+ * @export
+ * @interface GetCourseShareList
+ */
+export interface GetCourseShareList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseShare>}
+     * @memberof GetCourseShareList
+     */
+    items: Array<CourseShare>;
+}
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export declare function instanceOfGetCourseShareList(value: object): value is GetCourseShareList;
+export declare function GetCourseShareListFromJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseShareList;
+export declare function GetCourseShareListToJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListToJSONTyped(value?: GetCourseShareList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetCourseShareList.js

@@ -0,0 +1,60 @@
+/* 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.
+ */
+import { CourseShareFromJSON, CourseShareToJSON, } from './CourseShare';
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export function instanceOfGetCourseShareList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+export function GetCourseShareListFromJSON(json) {
+    return GetCourseShareListFromJSONTyped(json, false);
+}
+export function GetCourseShareListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseShareFromJSON)),
+    };
+}
+export function GetCourseShareListToJSON(json) {
+    return GetCourseShareListToJSONTyped(json, false);
+}
+export function GetCourseShareListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseShareToJSON)),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -56,6 +56,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -63,6 +64,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/esm/models/index.js

@@ -58,6 +58,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -65,6 +66,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/models/GetCourseCatalogList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+import type { CourseCatalog } from './CourseCatalog';
+/**
+ *
+ * @export
+ * @interface GetCourseCatalogList
+ */
+export interface GetCourseCatalogList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseCatalogList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseCatalog>}
+     * @memberof GetCourseCatalogList
+     */
+    items: Array<CourseCatalog>;
+}
+/**
+ * Check if a given object implements the GetCourseCatalogList interface.
+ */
+export declare function instanceOfGetCourseCatalogList(value: object): value is GetCourseCatalogList;
+export declare function GetCourseCatalogListFromJSON(json: any): GetCourseCatalogList;
+export declare function GetCourseCatalogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseCatalogList;
+export declare function GetCourseCatalogListToJSON(json: any): GetCourseCatalogList;
+export declare function GetCourseCatalogListToJSONTyped(value?: GetCourseCatalogList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseCatalogList.js

@@ -0,0 +1,67 @@
+"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.instanceOfGetCourseCatalogList = instanceOfGetCourseCatalogList;
+exports.GetCourseCatalogListFromJSON = GetCourseCatalogListFromJSON;
+exports.GetCourseCatalogListFromJSONTyped = GetCourseCatalogListFromJSONTyped;
+exports.GetCourseCatalogListToJSON = GetCourseCatalogListToJSON;
+exports.GetCourseCatalogListToJSONTyped = GetCourseCatalogListToJSONTyped;
+const CourseCatalog_1 = require("./CourseCatalog");
+/**
+ * Check if a given object implements the GetCourseCatalogList interface.
+ */
+function instanceOfGetCourseCatalogList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseCatalogListFromJSON(json) {
+    return GetCourseCatalogListFromJSONTyped(json, false);
+}
+function GetCourseCatalogListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseCatalog_1.CourseCatalogFromJSON)),
+    };
+}
+function GetCourseCatalogListToJSON(json) {
+    return GetCourseCatalogListToJSONTyped(json, false);
+}
+function GetCourseCatalogListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseCatalog_1.CourseCatalogToJSON)),
+    };
+}

package/dist/models/GetCourseShareList.d.ts

@@ -0,0 +1,57 @@
+/**
+ * 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.
+ */
+import type { CourseShare } from './CourseShare';
+/**
+ *
+ * @export
+ * @interface GetCourseShareList
+ */
+export interface GetCourseShareList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetCourseShareList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<CourseShare>}
+     * @memberof GetCourseShareList
+     */
+    items: Array<CourseShare>;
+}
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+export declare function instanceOfGetCourseShareList(value: object): value is GetCourseShareList;
+export declare function GetCourseShareListFromJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseShareList;
+export declare function GetCourseShareListToJSON(json: any): GetCourseShareList;
+export declare function GetCourseShareListToJSONTyped(value?: GetCourseShareList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetCourseShareList.js

@@ -0,0 +1,67 @@
+"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.instanceOfGetCourseShareList = instanceOfGetCourseShareList;
+exports.GetCourseShareListFromJSON = GetCourseShareListFromJSON;
+exports.GetCourseShareListFromJSONTyped = GetCourseShareListFromJSONTyped;
+exports.GetCourseShareListToJSON = GetCourseShareListToJSON;
+exports.GetCourseShareListToJSONTyped = GetCourseShareListToJSONTyped;
+const CourseShare_1 = require("./CourseShare");
+/**
+ * Check if a given object implements the GetCourseShareList interface.
+ */
+function instanceOfGetCourseShareList(value) {
+    if (!('page' in value) || value['page'] === undefined)
+        return false;
+    if (!('pageSize' in value) || value['pageSize'] === undefined)
+        return false;
+    if (!('totalPages' in value) || value['totalPages'] === undefined)
+        return false;
+    if (!('totalItems' in value) || value['totalItems'] === undefined)
+        return false;
+    if (!('items' in value) || value['items'] === undefined)
+        return false;
+    return true;
+}
+function GetCourseShareListFromJSON(json) {
+    return GetCourseShareListFromJSONTyped(json, false);
+}
+function GetCourseShareListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': (json['items'].map(CourseShare_1.CourseShareFromJSON)),
+    };
+}
+function GetCourseShareListToJSON(json) {
+    return GetCourseShareListToJSONTyped(json, false);
+}
+function GetCourseShareListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': (value['items'].map(CourseShare_1.CourseShareToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -56,6 +56,7 @@ export * from './GetContentLibraryVersion';
 export * from './GetConversation';
 export * from './GetConversationList';
 export * from './GetCourse';
+export * from './GetCourseCatalogList';
 export * from './GetCourseEnrollment';
 export * from './GetCourseEnrollmentList';
 export * from './GetCourseEnrollmentListItem';
@@ -63,6 +64,7 @@ export * from './GetCourseExport';
 export * from './GetCourseExportList';
 export * from './GetCourseImageUpload';
 export * from './GetCourseList';
+export * from './GetCourseShareList';
 export * from './GetCourseVersion';
 export * from './GetCourseVersionItem';
 export * from './GetCourseVersionItemLaunch';

package/dist/models/index.js

@@ -74,6 +74,7 @@ __exportStar(require("./GetContentLibraryVersion"), exports);
 __exportStar(require("./GetConversation"), exports);
 __exportStar(require("./GetConversationList"), exports);
 __exportStar(require("./GetCourse"), exports);
+__exportStar(require("./GetCourseCatalogList"), exports);
 __exportStar(require("./GetCourseEnrollment"), exports);
 __exportStar(require("./GetCourseEnrollmentList"), exports);
 __exportStar(require("./GetCourseEnrollmentListItem"), exports);
@@ -81,6 +82,7 @@ __exportStar(require("./GetCourseExport"), exports);
 __exportStar(require("./GetCourseExportList"), exports);
 __exportStar(require("./GetCourseImageUpload"), exports);
 __exportStar(require("./GetCourseList"), exports);
+__exportStar(require("./GetCourseShareList"), exports);
 __exportStar(require("./GetCourseVersion"), exports);
 __exportStar(require("./GetCourseVersionItem"), exports);
 __exportStar(require("./GetCourseVersionItemLaunch"), exports);

package/docs/CourseCatalogApi.md

@@ -285,7 +285,7 @@ No authorization required
 
 ## getCourseCatalogs
 
-> Array<CourseCatalog> getCourseCatalogs()
+> GetCourseCatalogList getCourseCatalogs(page, pageSize)
 
 List catalogs in the current portal
 
@@ -302,8 +302,15 @@ async function example() {
   console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
   const api = new CourseCatalogApi();
 
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetCourseCatalogsRequest;
+
   try {
-    const data = await api.getCourseCatalogs();
+    const data = await api.getCourseCatalogs(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -316,11 +323,15 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 
 ### Return type
 
-[**Array<CourseCatalog>**](CourseCatalog.md)
+[**GetCourseCatalogList**](GetCourseCatalogList.md)
 
 ### Authorization
 

package/docs/CourseShareApi.md

@@ -87,7 +87,7 @@ No authorization required
 
 ## getCourseSharesOfferedByMe
 
-> Array<CourseShare> getCourseSharesOfferedByMe(state)
+> GetCourseShareList getCourseSharesOfferedByMe(page, pageSize, courseId, state)
 
 List shares the current portal has offered out
 
@@ -105,6 +105,12 @@ async function example() {
   const api = new CourseShareApi();
 
   const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Filter by an owned course external ID (optional)
+    courseId: courseId_example,
     // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
     state: state_example,
   } satisfies GetCourseSharesOfferedByMeRequest;
@@ -126,11 +132,14 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **courseId** | `string` | Filter by an owned course external ID | [Optional] [Defaults to `undefined`] |
 | **state** | `offered`, `accepted_mirror`, `accepted_clone`, `declined`, `revoked` | Filter by share state (case-insensitive) | [Optional] [Defaults to `undefined`] [Enum: offered, accepted_mirror, accepted_clone, declined, revoked] |
 
 ### Return type
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 
@@ -153,11 +162,11 @@ No authorization required
 
 ## getCourseSharesOfferedToMe
 
-> Array<CourseShare> getCourseSharesOfferedToMe(state)
+> GetCourseShareList getCourseSharesOfferedToMe(page, pageSize, state)
 
 List shares offered to the current portal
 
-Returns every `course_share` row where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
+Returns `course_share` rows where the current portal is the target, with the source portal name and course name joined in. Optionally filter by share state via the `state` query parameter. 
 
 ### Example
 
@@ -173,6 +182,10 @@ async function example() {
   const api = new CourseShareApi();
 
   const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
     // 'offered' | 'accepted_mirror' | 'accepted_clone' | 'declined' | 'revoked' | Filter by share state (case-insensitive) (optional)
     state: state_example,
   } satisfies GetCourseSharesOfferedToMeRequest;
@@ -194,11 +207,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
 | **state** | `offered`, `accepted_mirror`, `accepted_clone`, `declined`, `revoked` | Filter by share state (case-insensitive) | [Optional] [Defaults to `undefined`] [Enum: offered, accepted_mirror, accepted_clone, declined, revoked] |
 
 ### Return type
 
-[**Array<CourseShare>**](CourseShare.md)
+[**GetCourseShareList**](GetCourseShareList.md)
 
 ### Authorization
 

package/docs/GetCourseCatalogList.md

@@ -0,0 +1,42 @@
+
+# GetCourseCatalogList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseCatalog>](CourseCatalog.md)
+
+## Example
+
+```typescript
+import type { GetCourseCatalogList } 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 GetCourseCatalogList
+
+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 GetCourseCatalogList
+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/GetCourseShareList.md

@@ -0,0 +1,42 @@
+
+# GetCourseShareList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+`items` | [Array<CourseShare>](CourseShare.md)
+
+## Example
+
+```typescript
+import type { GetCourseShareList } 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 GetCourseShareList
+
+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 GetCourseShareList
+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.107.0",
+  "version": "1.108.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {