@easyedu/js-lsm-api 1.107.0 → 1.108.0

package/src/apis/CourseCatalogApi.ts

@@ -23,6 +23,11 @@ import {
     GetCourseFromJSON,
     GetCourseToJSON,
 } from '../models/GetCourse';
+import {
+    type GetCourseCatalogList,
+    GetCourseCatalogListFromJSON,
+    GetCourseCatalogListToJSON,
+} from '../models/GetCourseCatalogList';
 import {
     type PostCourseCatalog,
     PostCourseCatalogFromJSON,
@@ -51,6 +56,11 @@ export interface GetCourseCatalogRequest {
     catalogId: string;
 }
 
+export interface GetCourseCatalogsRequest {
+    page?: number;
+    pageSize?: number;
+}
+
 export interface PostCourseCatalogRequest {
     postCourseCatalog: PostCourseCatalog;
 }
@@ -259,9 +269,17 @@ export class CourseCatalogApi extends runtime.BaseAPI {
     /**
      * Creates request options for getCourseCatalogs without sending the request
      */
-    async getCourseCatalogsRequestOpts(): Promise<runtime.RequestOpts> {
+    async getCourseCatalogsRequestOpts(requestParameters: GetCourseCatalogsRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
 
@@ -278,18 +296,18 @@ export class CourseCatalogApi extends runtime.BaseAPI {
     /**
      * List catalogs in the current portal
      */
-    async getCourseCatalogsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseCatalog>>> {
-        const requestOptions = await this.getCourseCatalogsRequestOpts();
+    async getCourseCatalogsRaw(requestParameters: GetCourseCatalogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseCatalogList>> {
+        const requestOptions = await this.getCourseCatalogsRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseCatalogFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseCatalogListFromJSON(jsonValue));
     }
 
     /**
      * List catalogs in the current portal
      */
-    async getCourseCatalogs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseCatalog>> {
-        const response = await this.getCourseCatalogsRaw(initOverrides);
+    async getCourseCatalogs(requestParameters: GetCourseCatalogsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseCatalogList> {
+        const response = await this.getCourseCatalogsRaw(requestParameters, initOverrides);
         return await response.value();
     }
 

package/src/apis/CourseShareApi.ts

@@ -14,10 +14,10 @@
 
 import * as runtime from '../runtime';
 import {
-    type CourseShare,
-    CourseShareFromJSON,
-    CourseShareToJSON,
-} from '../models/CourseShare';
+    type GetCourseShareList,
+    GetCourseShareListFromJSON,
+    GetCourseShareListToJSON,
+} from '../models/GetCourseShareList';
 import {
     type PostOfferCatalog,
     PostOfferCatalogFromJSON,
@@ -44,10 +44,15 @@ export interface DeleteCourseShareRequest {
 }
 
 export interface GetCourseSharesOfferedByMeRequest {
+    page?: number;
+    pageSize?: number;
+    courseId?: string;
     state?: GetCourseSharesOfferedByMeStateEnum;
 }
 
 export interface GetCourseSharesOfferedToMeRequest {
+    page?: number;
+    pageSize?: number;
     state?: GetCourseSharesOfferedToMeStateEnum;
 }
 
@@ -134,6 +139,18 @@ export class CourseShareApi extends runtime.BaseAPI {
     async getCourseSharesOfferedByMeRequestOpts(requestParameters: GetCourseSharesOfferedByMeRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['courseId'] != null) {
+            queryParameters['course_id'] = requestParameters['courseId'];
+        }
+
         if (requestParameters['state'] != null) {
             queryParameters['state'] = requestParameters['state'];
         }
@@ -154,17 +171,17 @@ export class CourseShareApi extends runtime.BaseAPI {
     /**
      * List shares the current portal has offered out
      */
-    async getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+    async getCourseSharesOfferedByMeRaw(requestParameters: GetCourseSharesOfferedByMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseShareList>> {
         const requestOptions = await this.getCourseSharesOfferedByMeRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseShareListFromJSON(jsonValue));
     }
 
     /**
      * List shares the current portal has offered out
      */
-    async getCourseSharesOfferedByMe(requestParameters: GetCourseSharesOfferedByMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+    async getCourseSharesOfferedByMe(requestParameters: GetCourseSharesOfferedByMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseShareList> {
         const response = await this.getCourseSharesOfferedByMeRaw(requestParameters, initOverrides);
         return await response.value();
     }
@@ -175,6 +192,14 @@ export class CourseShareApi extends runtime.BaseAPI {
     async getCourseSharesOfferedToMeRequestOpts(requestParameters: GetCourseSharesOfferedToMeRequest): Promise<runtime.RequestOpts> {
         const queryParameters: any = {};
 
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
         if (requestParameters['state'] != null) {
             queryParameters['state'] = requestParameters['state'];
         }
@@ -193,21 +218,21 @@ export class CourseShareApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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. 
      * List shares offered to the current portal
      */
-    async getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CourseShare>>> {
+    async getCourseSharesOfferedToMeRaw(requestParameters: GetCourseSharesOfferedToMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCourseShareList>> {
         const requestOptions = await this.getCourseSharesOfferedToMeRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CourseShareFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCourseShareListFromJSON(jsonValue));
     }
 
     /**
-     * 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. 
      * List shares offered to the current portal
      */
-    async getCourseSharesOfferedToMe(requestParameters: GetCourseSharesOfferedToMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CourseShare>> {
+    async getCourseSharesOfferedToMe(requestParameters: GetCourseSharesOfferedToMeRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCourseShareList> {
         const response = await this.getCourseSharesOfferedToMeRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/models/GetCourseCatalogList.ts

@@ -0,0 +1,110 @@
+/* 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 { mapValues } from '../runtime';
+import type { CourseCatalog } from './CourseCatalog';
+import {
+    CourseCatalogFromJSON,
+    CourseCatalogFromJSONTyped,
+    CourseCatalogToJSON,
+    CourseCatalogToJSONTyped,
+} 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 function instanceOfGetCourseCatalogList(value: object): value is GetCourseCatalogList {
+    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 GetCourseCatalogListFromJSON(json: any): GetCourseCatalogList {
+    return GetCourseCatalogListFromJSONTyped(json, false);
+}
+
+export function GetCourseCatalogListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseCatalogList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(CourseCatalogFromJSON)),
+    };
+}
+
+export function GetCourseCatalogListToJSON(json: any): GetCourseCatalogList {
+    return GetCourseCatalogListToJSONTyped(json, false);
+}
+
+export function GetCourseCatalogListToJSONTyped(value?: GetCourseCatalogList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(CourseCatalogToJSON)),
+    };
+}
+

package/src/models/GetCourseShareList.ts

@@ -0,0 +1,110 @@
+/* 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 { mapValues } from '../runtime';
+import type { CourseShare } from './CourseShare';
+import {
+    CourseShareFromJSON,
+    CourseShareFromJSONTyped,
+    CourseShareToJSON,
+    CourseShareToJSONTyped,
+} 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 function instanceOfGetCourseShareList(value: object): value is GetCourseShareList {
+    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: any): GetCourseShareList {
+    return GetCourseShareListFromJSONTyped(json, false);
+}
+
+export function GetCourseShareListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetCourseShareList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['pageSize'],
+        'totalPages': json['totalPages'],
+        'totalItems': json['totalItems'],
+        'items': ((json['items'] as Array<any>).map(CourseShareFromJSON)),
+    };
+}
+
+export function GetCourseShareListToJSON(json: any): GetCourseShareList {
+    return GetCourseShareListToJSONTyped(json, false);
+}
+
+export function GetCourseShareListToJSONTyped(value?: GetCourseShareList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'pageSize': value['pageSize'],
+        'totalPages': value['totalPages'],
+        'totalItems': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(CourseShareToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -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';