@easyedu/js-lsm-api 1.79.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.79.0",
+  "version": "1.80.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/UserApi.ts

@@ -28,6 +28,11 @@ import {
     GetUserAvatarUploadFromJSON,
     GetUserAvatarUploadToJSON,
 } from '../models/GetUserAvatarUpload';
+import {
+    type GetUserCourseList,
+    GetUserCourseListFromJSON,
+    GetUserCourseListToJSON,
+} from '../models/GetUserCourseList';
 import {
     type LoginRes,
     LoginResFromJSON,
@@ -72,6 +77,17 @@ export interface GetUserRequest {
     userId: string;
 }
 
+export interface GetUserCoursesRequest {
+    userId: string;
+    page?: number;
+    pageSize?: number;
+    search?: string;
+    recentActivitySince?: number;
+    enrollmentStatus?: string;
+    orderBy?: GetUserCoursesOrderByEnum;
+    orderDirection?: GetUserCoursesOrderDirectionEnum;
+}
+
 export interface GetUserEnrollmentsRequest {
     userId: string;
     type?: GetUserEnrollmentsTypeEnum;
@@ -279,6 +295,79 @@ export class UserApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getUserCourses without sending the request
+     */
+    async getUserCoursesRequestOpts(requestParameters: GetUserCoursesRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['userId'] == null) {
+            throw new runtime.RequiredError(
+                'userId',
+                'Required parameter "userId" was null or undefined when calling getUserCourses().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['pageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        if (requestParameters['recentActivitySince'] != null) {
+            queryParameters['recentActivitySince'] = requestParameters['recentActivitySince'];
+        }
+
+        if (requestParameters['enrollmentStatus'] != null) {
+            queryParameters['enrollmentStatus'] = requestParameters['enrollmentStatus'];
+        }
+
+        if (requestParameters['orderBy'] != null) {
+            queryParameters['orderBy'] = requestParameters['orderBy'];
+        }
+
+        if (requestParameters['orderDirection'] != null) {
+            queryParameters['orderDirection'] = requestParameters['orderDirection'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/users/{userId}/courses`;
+        urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get enrolled courses for a user
+     */
+    async getUserCoursesRaw(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCourseList>> {
+        const requestOptions = await this.getUserCoursesRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetUserCourseListFromJSON(jsonValue));
+    }
+
+    /**
+     * Get enrolled courses for a user
+     */
+    async getUserCourses(requestParameters: GetUserCoursesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCourseList> {
+        const response = await this.getUserCoursesRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getUserEnrollments without sending the request
      */
@@ -739,6 +828,25 @@ export class UserApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const GetUserCoursesOrderByEnum = {
+    Name: 'name',
+    CreatedAt: 'created_at',
+    EnrollmentDateStart: 'enrollment_date_start',
+    EnrollmentStatus: 'enrollment_status',
+    CompletionPercentage: 'completion_percentage'
+} as const;
+export type GetUserCoursesOrderByEnum = typeof GetUserCoursesOrderByEnum[keyof typeof GetUserCoursesOrderByEnum];
+/**
+ * @export
+ */
+export const GetUserCoursesOrderDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type GetUserCoursesOrderDirectionEnum = typeof GetUserCoursesOrderDirectionEnum[keyof typeof GetUserCoursesOrderDirectionEnum];
 /**
  * @export
  */

package/src/models/GetUserCourseList.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 { GetUserCourseListItem } from './GetUserCourseListItem';
+import {
+    GetUserCourseListItemFromJSON,
+    GetUserCourseListItemFromJSONTyped,
+    GetUserCourseListItemToJSON,
+    GetUserCourseListItemToJSONTyped,
+} from './GetUserCourseListItem';
+
+/**
+ * A paginated list of courses the target user is enrolled in.
+ * @export
+ * @interface GetUserCourseList
+ */
+export interface GetUserCourseList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    page: number;
+    /**
+     * The number of items returned on this page
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    totalPages: number;
+    /**
+     * The total number of courses after selecting one enrollment per course
+     * @type {number}
+     * @memberof GetUserCourseList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetUserCourseListItem>}
+     * @memberof GetUserCourseList
+     */
+    items: Array<GetUserCourseListItem>;
+}
+
+/**
+ * Check if a given object implements the GetUserCourseList interface.
+ */
+export function instanceOfGetUserCourseList(value: object): value is GetUserCourseList {
+    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 GetUserCourseListFromJSON(json: any): GetUserCourseList {
+    return GetUserCourseListFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseList {
+    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(GetUserCourseListItemFromJSON)),
+    };
+}
+
+export function GetUserCourseListToJSON(json: any): GetUserCourseList {
+    return GetUserCourseListToJSONTyped(json, false);
+}
+
+export function GetUserCourseListToJSONTyped(value?: GetUserCourseList | 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(GetUserCourseListItemToJSON)),
+    };
+}
+

package/src/models/GetUserCourseListItem.ts

@@ -0,0 +1,122 @@
+/* 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 { GetUserCourseListItemCourse } from './GetUserCourseListItemCourse';
+import {
+    GetUserCourseListItemCourseFromJSON,
+    GetUserCourseListItemCourseFromJSONTyped,
+    GetUserCourseListItemCourseToJSON,
+    GetUserCourseListItemCourseToJSONTyped,
+} from './GetUserCourseListItemCourse';
+import type { GetUserCourseListItemEnrollment } from './GetUserCourseListItemEnrollment';
+import {
+    GetUserCourseListItemEnrollmentFromJSON,
+    GetUserCourseListItemEnrollmentFromJSONTyped,
+    GetUserCourseListItemEnrollmentToJSON,
+    GetUserCourseListItemEnrollmentToJSONTyped,
+} from './GetUserCourseListItemEnrollment';
+import type { GetUserCourseListItemCertificate } from './GetUserCourseListItemCertificate';
+import {
+    GetUserCourseListItemCertificateFromJSON,
+    GetUserCourseListItemCertificateFromJSONTyped,
+    GetUserCourseListItemCertificateToJSON,
+    GetUserCourseListItemCertificateToJSONTyped,
+} from './GetUserCourseListItemCertificate';
+import type { GetUserCourseListItemProgress } from './GetUserCourseListItemProgress';
+import {
+    GetUserCourseListItemProgressFromJSON,
+    GetUserCourseListItemProgressFromJSONTyped,
+    GetUserCourseListItemProgressToJSON,
+    GetUserCourseListItemProgressToJSONTyped,
+} from './GetUserCourseListItemProgress';
+
+/**
+ * A course the target user is enrolled in, grouped by course and selected enrollment.
+ * @export
+ * @interface GetUserCourseListItem
+ */
+export interface GetUserCourseListItem {
+    /**
+     * 
+     * @type {GetUserCourseListItemCourse}
+     * @memberof GetUserCourseListItem
+     */
+    course: GetUserCourseListItemCourse;
+    /**
+     * 
+     * @type {GetUserCourseListItemEnrollment}
+     * @memberof GetUserCourseListItem
+     */
+    enrollment: GetUserCourseListItemEnrollment;
+    /**
+     * 
+     * @type {GetUserCourseListItemProgress}
+     * @memberof GetUserCourseListItem
+     */
+    progress: GetUserCourseListItemProgress;
+    /**
+     * 
+     * @type {GetUserCourseListItemCertificate}
+     * @memberof GetUserCourseListItem
+     */
+    certificate: GetUserCourseListItemCertificate | null;
+}
+
+/**
+ * Check if a given object implements the GetUserCourseListItem interface.
+ */
+export function instanceOfGetUserCourseListItem(value: object): value is GetUserCourseListItem {
+    if (!('course' in value) || value['course'] === undefined) return false;
+    if (!('enrollment' in value) || value['enrollment'] === undefined) return false;
+    if (!('progress' in value) || value['progress'] === undefined) return false;
+    if (!('certificate' in value) || value['certificate'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemFromJSON(json: any): GetUserCourseListItem {
+    return GetUserCourseListItemFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'course': GetUserCourseListItemCourseFromJSON(json['course']),
+        'enrollment': GetUserCourseListItemEnrollmentFromJSON(json['enrollment']),
+        'progress': GetUserCourseListItemProgressFromJSON(json['progress']),
+        'certificate': GetUserCourseListItemCertificateFromJSON(json['certificate']),
+    };
+}
+
+export function GetUserCourseListItemToJSON(json: any): GetUserCourseListItem {
+    return GetUserCourseListItemToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemToJSONTyped(value?: GetUserCourseListItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'course': GetUserCourseListItemCourseToJSON(value['course']),
+        'enrollment': GetUserCourseListItemEnrollmentToJSON(value['enrollment']),
+        'progress': GetUserCourseListItemProgressToJSON(value['progress']),
+        'certificate': GetUserCourseListItemCertificateToJSON(value['certificate']),
+    };
+}
+

package/src/models/GetUserCourseListItemCertificate.ts

@@ -0,0 +1,124 @@
+/* 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';
+/**
+ * Latest certificate for the learner and course, if one exists.
+ * @export
+ * @interface GetUserCourseListItemCertificate
+ */
+export interface GetUserCourseListItemCertificate {
+    /**
+     * The external ID of the certificate.
+     * @type {string}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    id: string;
+    /**
+     * Derived certificate status. Active certificates with expires_at in the past are returned as expired.
+     * @type {GetUserCourseListItemCertificateStatusEnum}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    status: GetUserCourseListItemCertificateStatusEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    issuedAt: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    expiresAt: number | null;
+    /**
+     * 
+     * @type {GetUserCourseListItemCertificateIssuanceReasonEnum}
+     * @memberof GetUserCourseListItemCertificate
+     */
+    issuanceReason: GetUserCourseListItemCertificateIssuanceReasonEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemCertificateStatusEnum = {
+    Active: 'active',
+    Expired: 'expired',
+    Revoked: 'revoked'
+} as const;
+export type GetUserCourseListItemCertificateStatusEnum = typeof GetUserCourseListItemCertificateStatusEnum[keyof typeof GetUserCourseListItemCertificateStatusEnum];
+
+/**
+ * @export
+ */
+export const GetUserCourseListItemCertificateIssuanceReasonEnum = {
+    CourseCompletion: 'course_completion',
+    QuizPassed: 'quiz_passed',
+    Manual: 'manual'
+} as const;
+export type GetUserCourseListItemCertificateIssuanceReasonEnum = typeof GetUserCourseListItemCertificateIssuanceReasonEnum[keyof typeof GetUserCourseListItemCertificateIssuanceReasonEnum];
+
+
+/**
+ * Check if a given object implements the GetUserCourseListItemCertificate interface.
+ */
+export function instanceOfGetUserCourseListItemCertificate(value: object): value is GetUserCourseListItemCertificate {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('issuedAt' in value) || value['issuedAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('issuanceReason' in value) || value['issuanceReason'] === undefined) return false;
+    return true;
+}
+
+export function GetUserCourseListItemCertificateFromJSON(json: any): GetUserCourseListItemCertificate {
+    return GetUserCourseListItemCertificateFromJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCertificateFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUserCourseListItemCertificate {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'status': json['status'],
+        'issuedAt': json['issued_at'],
+        'expiresAt': json['expires_at'],
+        'issuanceReason': json['issuance_reason'],
+    };
+}
+
+export function GetUserCourseListItemCertificateToJSON(json: any): GetUserCourseListItemCertificate {
+    return GetUserCourseListItemCertificateToJSONTyped(json, false);
+}
+
+export function GetUserCourseListItemCertificateToJSONTyped(value?: GetUserCourseListItemCertificate | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'status': value['status'],
+        'issued_at': value['issuedAt'],
+        'expires_at': value['expiresAt'],
+        'issuance_reason': value['issuanceReason'],
+    };
+}
+