@easyedu/js-lsm-api 1.52.0 → 1.53.0

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.52.0
+# @easyedu/js-lsm-api@1.53.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -107,6 +107,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *CourseApi* | [**putCourseEnrollment**](docs/CourseApi.md#putcourseenrollment) | **PUT** /courses/{courseId}/enrollments/{enrollmentId} | Update a course enrollment
 *CourseCatalogApi* | [**addCourseToCatalog**](docs/CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog
 *CourseCatalogApi* | [**deleteCourseCatalog**](docs/CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog
+*CourseCatalogApi* | [**getCatalogCourses**](docs/CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog
 *CourseCatalogApi* | [**getCourseCatalog**](docs/CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog
 *CourseCatalogApi* | [**getCourseCatalogs**](docs/CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal
 *CourseCatalogApi* | [**postCourseCatalog**](docs/CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog
@@ -471,7 +472,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.52.0`
+- Package version: `1.53.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/CourseCatalogApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CourseCatalog, PostCourseCatalog, PutCourseCatalog } from '../models/index';
+import type { CourseCatalog, GetCourse, PostCourseCatalog, PutCourseCatalog } from '../models/index';
 export interface AddCourseToCatalogRequest {
     catalogId: string;
     courseId: string;
@@ -18,6 +18,9 @@ export interface AddCourseToCatalogRequest {
 export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -60,6 +63,18 @@ export declare class CourseCatalogApi extends runtime.BaseAPI {
      * Delete a catalog
      */
     deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>>;
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/apis/CourseCatalogApi.js

@@ -109,6 +109,45 @@ class CourseCatalogApi extends runtime.BaseAPI {
             yield this.deleteCourseCatalogRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCatalogCoursesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.GetCourseFromJSON));
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCatalogCoursesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/esm/apis/CourseCatalogApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CourseCatalog, PostCourseCatalog, PutCourseCatalog } from '../models/index';
+import type { CourseCatalog, GetCourse, PostCourseCatalog, PutCourseCatalog } from '../models/index';
 export interface AddCourseToCatalogRequest {
     catalogId: string;
     courseId: string;
@@ -18,6 +18,9 @@ export interface AddCourseToCatalogRequest {
 export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -60,6 +63,18 @@ export declare class CourseCatalogApi extends runtime.BaseAPI {
      * Delete a catalog
      */
     deleteCourseCatalog(requestParameters: DeleteCourseCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>>;
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>>;
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/dist/esm/apis/CourseCatalogApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { CourseCatalogFromJSON, PostCourseCatalogToJSON, PutCourseCatalogToJSON, } from '../models/index';
+import { CourseCatalogFromJSON, GetCourseFromJSON, PostCourseCatalogToJSON, PutCourseCatalogToJSON, } from '../models/index';
 /**
  *
  */
@@ -106,6 +106,45 @@ export class CourseCatalogApi extends runtime.BaseAPI {
             yield this.deleteCourseCatalogRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    getCatalogCoursesRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['catalogId'] == null) {
+                throw new runtime.RequiredError('catalogId', 'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/catalogs/{catalogId}/courses`;
+            urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCoursesRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getCatalogCoursesRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+        });
+    }
+    /**
+     * List the courses in a catalog
+     */
+    getCatalogCourses(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getCatalogCoursesRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for getCourseCatalog without sending the request
      */

package/docs/CourseCatalogApi.md

@@ -6,6 +6,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 |------------- | ------------- | -------------|
 | [**addCourseToCatalog**](CourseCatalogApi.md#addcoursetocatalog) | **POST** /catalogs/{catalogId}/courses/{courseId} | Add a course to a catalog |
 | [**deleteCourseCatalog**](CourseCatalogApi.md#deletecoursecatalog) | **DELETE** /catalogs/{catalogId} | Delete a catalog |
+| [**getCatalogCourses**](CourseCatalogApi.md#getcatalogcourses) | **GET** /catalogs/{catalogId}/courses | List the courses in a catalog |
 | [**getCourseCatalog**](CourseCatalogApi.md#getcoursecatalog) | **GET** /catalogs/{catalogId} | Get a catalog |
 | [**getCourseCatalogs**](CourseCatalogApi.md#getcoursecatalogs) | **GET** /catalogs | List catalogs in the current portal |
 | [**postCourseCatalog**](CourseCatalogApi.md#postcoursecatalog) | **POST** /catalogs | Create a course catalog |
@@ -149,6 +150,73 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getCatalogCourses
+
+> Array<GetCourse> getCatalogCourses(catalogId)
+
+List the courses in a catalog
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CourseCatalogApi,
+} from '@easyedu/js-lsm-api';
+import type { GetCatalogCoursesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new CourseCatalogApi();
+
+  const body = {
+    // string
+    catalogId: catalogId_example,
+  } satisfies GetCatalogCoursesRequest;
+
+  try {
+    const data = await api.getCatalogCourses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **catalogId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetCourse>**](GetCourse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Courses in the catalog |  -  |
+| **403** | Catalog not owned by your portal |  -  |
+| **404** | Catalog not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getCourseCatalog
 
 > CourseCatalog getCourseCatalog(catalogId)

package/package.json

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

package/src/apis/CourseCatalogApi.ts

@@ -16,12 +16,15 @@
 import * as runtime from '../runtime';
 import type {
   CourseCatalog,
+  GetCourse,
   PostCourseCatalog,
   PutCourseCatalog,
 } from '../models/index';
 import {
     CourseCatalogFromJSON,
     CourseCatalogToJSON,
+    GetCourseFromJSON,
+    GetCourseToJSON,
     PostCourseCatalogFromJSON,
     PostCourseCatalogToJSON,
     PutCourseCatalogFromJSON,
@@ -37,6 +40,10 @@ export interface DeleteCourseCatalogRequest {
     catalogId: string;
 }
 
+export interface GetCatalogCoursesRequest {
+    catalogId: string;
+}
+
 export interface GetCourseCatalogRequest {
     catalogId: string;
 }
@@ -156,6 +163,51 @@ export class CourseCatalogApi extends runtime.BaseAPI {
         await this.deleteCourseCatalogRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for getCatalogCourses without sending the request
+     */
+    async getCatalogCoursesRequestOpts(requestParameters: GetCatalogCoursesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['catalogId'] == null) {
+            throw new runtime.RequiredError(
+                'catalogId',
+                'Required parameter "catalogId" was null or undefined when calling getCatalogCourses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/catalogs/{catalogId}/courses`;
+        urlPath = urlPath.replace(`{${"catalogId"}}`, encodeURIComponent(String(requestParameters['catalogId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCoursesRaw(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<GetCourse>>> {
+        const requestOptions = await this.getCatalogCoursesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetCourseFromJSON));
+    }
+
+    /**
+     * List the courses in a catalog
+     */
+    async getCatalogCourses(requestParameters: GetCatalogCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<GetCourse>> {
+        const response = await this.getCatalogCoursesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getCourseCatalog without sending the request
      */