@easyedu/js-lsm-api 1.78.0 → 1.80.0

package/docs/UserApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**getAuthCheck**](UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in |
 | [**getCurrentUserPermissions**](UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions |
 | [**getUser**](UserApi.md#getuser) | **GET** /users/{userId} | Get a user by id |
+| [**getUserCourses**](UserApi.md#getusercourses) | **GET** /users/{userId}/courses | Get enrolled courses for a user |
 | [**getUserEnrollments**](UserApi.md#getuserenrollments) | **GET** /users/{userId}/enrollments | Get user enrollments |
 | [**postLogin**](UserApi.md#postlogin) | **POST** /auth/login | Post a new login |
 | [**postLogout**](UserApi.md#postlogout) | **POST** /auth/logout | Logout a user |
@@ -269,6 +270,95 @@ 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)
 
 
+## getUserCourses
+
+> GetUserCourseList getUserCourses(userId, page, pageSize, search, recentActivitySince, enrollmentStatus, orderBy, orderDirection)
+
+Get enrolled courses for a user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { GetUserCoursesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string | User external ID, or `current` for the authenticated user.
+    userId: userId_example,
+    // number | Page number for pagination. (optional)
+    page: 56,
+    // number | Number of items per page. (optional)
+    pageSize: 56,
+    // string | Case-insensitive match against course name or description. (optional)
+    search: search_example,
+    // number | Unix timestamp in seconds. Only courses with learner live content-session activity at or after this time are returned. (optional)
+    recentActivitySince: 789,
+    // string | Comma-separated list of selected enrollment statuses to include. Example: `enrollmentStatus=Enrolled,InProgress,Completed`. Unknown values are ignored.  (optional)
+    enrollmentStatus: enrollmentStatus_example,
+    // 'name' | 'created_at' | 'enrollment_date_start' | 'enrollment_status' | 'completion_percentage' | Field used to order the selected course list. (optional)
+    orderBy: orderBy_example,
+    // 'asc' | 'desc' | Sort direction. (optional)
+    orderDirection: orderDirection_example,
+  } satisfies GetUserCoursesRequest;
+
+  try {
+    const data = await api.getUserCourses(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | User external ID, or `current` for the authenticated user. | [Defaults to `undefined`] |
+| **page** | `number` | Page number for pagination. | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page. | [Optional] [Defaults to `20`] |
+| **search** | `string` | Case-insensitive match against course name or description. | [Optional] [Defaults to `undefined`] |
+| **recentActivitySince** | `number` | Unix timestamp in seconds. Only courses with learner live content-session activity at or after this time are returned. | [Optional] [Defaults to `undefined`] |
+| **enrollmentStatus** | `string` | Comma-separated list of selected enrollment statuses to include. Example: `enrollmentStatus=Enrolled,InProgress,Completed`. Unknown values are ignored.  | [Optional] [Defaults to `undefined`] |
+| **orderBy** | `name`, `created_at`, `enrollment_date_start`, `enrollment_status`, `completion_percentage` | Field used to order the selected course list. | [Optional] [Defaults to `'enrollment_date_start'`] [Enum: name, created_at, enrollment_date_start, enrollment_status, completion_percentage] |
+| **orderDirection** | `asc`, `desc` | Sort direction. | [Optional] [Defaults to `'desc'`] [Enum: asc, desc] |
+
+### Return type
+
+[**GetUserCourseList**](GetUserCourseList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get user courses response OK |  -  |
+| **400** | Invalid query parameter |  -  |
+| **403** | Forbidden |  -  |
+| **404** | User 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)
+
+
 ## getUserEnrollments
 
 > GetCourseEnrollmentList getUserEnrollments(userId, type, status, page, pageSize)

package/package.json

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

package/src/apis/CertificateApi.ts

@@ -13,18 +13,56 @@
  */
 
 import * as runtime from '../runtime';
-import type {
-    Certificate,
-    CertificateConfig,
-    CertificatePublic,
-    EffectiveCertificateConfig,
-    GetCertificateConfigList,
-    GetCertificateList,
-    PostCertificate,
-    PostCertificateConfig,
-    PostRevokeCertificate,
-    PutCertificateConfig,
-} from '../models/index';
+import {
+    type Certificate,
+    CertificateFromJSON,
+    CertificateToJSON,
+} from '../models/Certificate';
+import {
+    type CertificateConfig,
+    CertificateConfigFromJSON,
+    CertificateConfigToJSON,
+} from '../models/CertificateConfig';
+import {
+    type CertificatePublic,
+    CertificatePublicFromJSON,
+    CertificatePublicToJSON,
+} from '../models/CertificatePublic';
+import {
+    type EffectiveCertificateConfig,
+    EffectiveCertificateConfigFromJSON,
+    EffectiveCertificateConfigToJSON,
+} from '../models/EffectiveCertificateConfig';
+import {
+    type GetCertificateConfigList,
+    GetCertificateConfigListFromJSON,
+    GetCertificateConfigListToJSON,
+} from '../models/GetCertificateConfigList';
+import {
+    type GetCertificateList,
+    GetCertificateListFromJSON,
+    GetCertificateListToJSON,
+} from '../models/GetCertificateList';
+import {
+    type PostCertificate,
+    PostCertificateFromJSON,
+    PostCertificateToJSON,
+} from '../models/PostCertificate';
+import {
+    type PostCertificateConfig,
+    PostCertificateConfigFromJSON,
+    PostCertificateConfigToJSON,
+} from '../models/PostCertificateConfig';
+import {
+    type PostRevokeCertificate,
+    PostRevokeCertificateFromJSON,
+    PostRevokeCertificateToJSON,
+} from '../models/PostRevokeCertificate';
+import {
+    type PutCertificateConfig,
+    PutCertificateConfigFromJSON,
+    PutCertificateConfigToJSON,
+} from '../models/PutCertificateConfig';
 
 export interface DeleteCertificateConfigRequest {
     configId: string;
@@ -168,7 +206,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getCertificateRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
     }
 
     /**
@@ -213,7 +251,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getCertificateConfigRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
     }
 
     /**
@@ -258,7 +296,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getCertificateConfigsRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateConfigListFromJSON(jsonValue));
     }
 
     /**
@@ -372,7 +410,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getCertificatesRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateListFromJSON(jsonValue));
     }
 
     /**
@@ -409,7 +447,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getCurrentUserCertificatesRequestOpts();
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateListFromJSON(jsonValue));
     }
 
     /**
@@ -454,7 +492,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.getEffectiveCertificateConfigRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => EffectiveCertificateConfigFromJSON(jsonValue));
     }
 
     /**
@@ -490,7 +528,7 @@ export class CertificateApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['postCertificateConfig'],
+            body: PostCertificateConfigToJSON(requestParameters['postCertificateConfig']),
         };
     }
 
@@ -501,7 +539,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.postCertificateConfigRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
     }
 
     /**
@@ -545,7 +583,7 @@ export class CertificateApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['postCertificate'],
+            body: PostCertificateToJSON(requestParameters['postCertificate']),
         };
     }
 
@@ -556,7 +594,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.postCourseCertificateRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
     }
 
     /**
@@ -600,7 +638,7 @@ export class CertificateApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['postRevokeCertificate'],
+            body: PostRevokeCertificateToJSON(requestParameters['postRevokeCertificate']),
         };
     }
 
@@ -611,7 +649,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.postRevokeCertificateRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
     }
 
     /**
@@ -655,7 +693,7 @@ export class CertificateApi extends runtime.BaseAPI {
             method: 'PUT',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['putCertificateConfig'],
+            body: PutCertificateConfigToJSON(requestParameters['putCertificateConfig']),
         };
     }
 
@@ -666,7 +704,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.putCertificateConfigRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
     }
 
     /**
@@ -711,7 +749,7 @@ export class CertificateApi extends runtime.BaseAPI {
         const requestOptions = await this.verifyCertificateRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificatePublicFromJSON(jsonValue));
     }
 
     /**

package/src/apis/ChatApi.ts

@@ -13,14 +13,36 @@
  */
 
 import * as runtime from '../runtime';
-import type {
-    GetChatMessage,
-    GetConversationList,
-    PostConversation,
-    PostConversationResponse,
-    PostMessage,
-    PostMessageResponse,
-} from '../models/index';
+import {
+    type GetChatMessage,
+    GetChatMessageFromJSON,
+    GetChatMessageToJSON,
+} from '../models/GetChatMessage';
+import {
+    type GetConversationList,
+    GetConversationListFromJSON,
+    GetConversationListToJSON,
+} from '../models/GetConversationList';
+import {
+    type PostConversation,
+    PostConversationFromJSON,
+    PostConversationToJSON,
+} from '../models/PostConversation';
+import {
+    type PostConversationResponse,
+    PostConversationResponseFromJSON,
+    PostConversationResponseToJSON,
+} from '../models/PostConversationResponse';
+import {
+    type PostMessage,
+    PostMessageFromJSON,
+    PostMessageToJSON,
+} from '../models/PostMessage';
+import {
+    type PostMessageResponse,
+    PostMessageResponseFromJSON,
+    PostMessageResponseToJSON,
+} from '../models/PostMessageResponse';
 
 export interface DeleteConversationRequest {
     conversationId: string;
@@ -127,7 +149,7 @@ export class ChatApi extends runtime.BaseAPI {
         const requestOptions = await this.getConversationMessagesRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(GetChatMessageFromJSON));
     }
 
     /**
@@ -172,7 +194,7 @@ export class ChatApi extends runtime.BaseAPI {
         const requestOptions = await this.getConversationsRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetConversationListFromJSON(jsonValue));
     }
 
     /**
@@ -208,7 +230,7 @@ export class ChatApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['postConversation'],
+            body: PostConversationToJSON(requestParameters['postConversation']),
         };
     }
 
@@ -219,7 +241,7 @@ export class ChatApi extends runtime.BaseAPI {
         const requestOptions = await this.postConversationRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostConversationResponseFromJSON(jsonValue));
     }
 
     /**
@@ -263,7 +285,7 @@ export class ChatApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: requestParameters['postMessage'],
+            body: PostMessageToJSON(requestParameters['postMessage']),
         };
     }
 
@@ -274,7 +296,7 @@ export class ChatApi extends runtime.BaseAPI {
         const requestOptions = await this.postMessageRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response);
+        return new runtime.JSONApiResponse(response, (jsonValue) => PostMessageResponseFromJSON(jsonValue));
     }
 
     /**