@easyedu/js-lsm-api 1.7.0 → 1.8.0

package/.openapi-generator/FILES

@@ -31,6 +31,8 @@ src/models/GetModule.ts
 src/models/GetModuleList.ts
 src/models/GetPortal.ts
 src/models/GetPortalList.ts
+src/models/GetPortalUser.ts
+src/models/GetPortalUserList.ts
 src/models/GetQuestion.ts
 src/models/GetQuestionAnswerChoicesInner.ts
 src/models/GetQuestionList.ts

package/README.md

@@ -1,4 +1,4 @@
-## @easyedu/js-lsm-api@1.7.0
+## @easyedu/js-lsm-api@1.8.0
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @easyedu/js-lsm-api@1.7.0 --save
+npm install @easyedu/js-lsm-api@1.8.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/PortalApi.d.ts

@@ -10,10 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+import type { GetPortal, GetPortalList, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
 export interface GetPortalByIdRequest {
     portalId: string;
 }
+export interface GetPortalUsersRequest {
+    portalId: string;
+    roles?: Array<GetPortalUsersRolesEnum>;
+    page?: number;
+    pageSize?: number;
+}
 export interface InviteUserToPortalRequest {
     portalId: string;
     postPortalInvite: PostPortalInvite;
@@ -49,6 +55,14 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Get all portals a user has access to
      */
     getPortalList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>>;
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
     /**
      * Invite a new user to a portal
      */
@@ -82,3 +96,12 @@ export declare class PortalApi extends runtime.BaseAPI {
      */
     updateSelectedPortal(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetPortalUsersRolesEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];

package/dist/apis/PortalApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PortalApi = void 0;
+exports.GetPortalUsersRolesEnum = exports.PortalApi = void 0;
 const runtime = require("../runtime");
 const index_1 = require("../models/index");
 /**
@@ -82,6 +82,43 @@ class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUsers().');
+            }
+            const queryParameters = {};
+            if (requestParameters['roles'] != null) {
+                queryParameters['roles'] = requestParameters['roles'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['page_size'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            const response = yield this.request({
+                path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalUserListFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsers(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPortalUsersRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Invite a new user to a portal
      */
@@ -209,3 +246,11 @@ class PortalApi extends runtime.BaseAPI {
     }
 }
 exports.PortalApi = PortalApi;
+/**
+ * @export
+ */
+exports.GetPortalUsersRolesEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};

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

@@ -10,10 +10,16 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+import type { GetPortal, GetPortalList, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
 export interface GetPortalByIdRequest {
     portalId: string;
 }
+export interface GetPortalUsersRequest {
+    portalId: string;
+    roles?: Array<GetPortalUsersRolesEnum>;
+    page?: number;
+    pageSize?: number;
+}
 export interface InviteUserToPortalRequest {
     portalId: string;
     postPortalInvite: PostPortalInvite;
@@ -49,6 +55,14 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Get all portals a user has access to
      */
     getPortalList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalList>;
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>>;
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
     /**
      * Invite a new user to a portal
      */
@@ -82,3 +96,12 @@ export declare class PortalApi extends runtime.BaseAPI {
      */
     updateSelectedPortal(requestParameters: UpdateSelectedPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 }
+/**
+ * @export
+ */
+export declare const GetPortalUsersRolesEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];

package/dist/esm/apis/PortalApi.js

@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { GetPortalFromJSON, GetPortalListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
+import { GetPortalFromJSON, GetPortalListFromJSON, GetPortalUserListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
 /**
  *
  */
@@ -79,6 +79,43 @@ export class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUsers().');
+            }
+            const queryParameters = {};
+            if (requestParameters['roles'] != null) {
+                queryParameters['roles'] = requestParameters['roles'];
+            }
+            if (requestParameters['page'] != null) {
+                queryParameters['page'] = requestParameters['page'];
+            }
+            if (requestParameters['pageSize'] != null) {
+                queryParameters['page_size'] = requestParameters['pageSize'];
+            }
+            const headerParameters = {};
+            const response = yield this.request({
+                path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserListFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    getPortalUsers(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPortalUsersRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Invite a new user to a portal
      */
@@ -205,3 +242,11 @@ export class PortalApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const GetPortalUsersRolesEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};

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

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ */
+/**
+ * A user with their portal access information
+ * @export
+ * @interface GetPortalUser
+ */
+export interface GetPortalUser {
+    /**
+     * The unique identifier for the user
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    userId: string;
+    /**
+     * The user's email address
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    email: string;
+    /**
+     * The user's first name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    firstName: string;
+    /**
+     * The user's last name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    lastName: string;
+    /**
+     * The user's role in the portal
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    role: GetPortalUserRoleEnum;
+    /**
+     * Whether the user's portal access is active
+     * @type {boolean}
+     * @memberof GetPortalUser
+     */
+    isActive: boolean;
+}
+/**
+ * @export
+ */
+export declare const GetPortalUserRoleEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export declare function instanceOfGetPortalUser(value: object): value is GetPortalUser;
+export declare function GetPortalUserFromJSON(json: any): GetPortalUser;
+export declare function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser;
+export declare function GetPortalUserToJSON(json: any): GetPortalUser;
+export declare function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalUser.js

@@ -0,0 +1,71 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export function instanceOfGetPortalUser(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    return true;
+}
+export function GetPortalUserFromJSON(json) {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+export function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'role': json['role'],
+        'isActive': json['is_active'],
+    };
+}
+export function GetPortalUserToJSON(json) {
+    return GetPortalUserToJSONTyped(json, false);
+}
+export function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'role': value['role'],
+        'is_active': value['isActive'],
+    };
+}

package/dist/esm/models/GetPortalUserList.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 { GetPortalUser } from './GetPortalUser';
+/**
+ * A list of portal users with pagination information
+ * @export
+ * @interface GetPortalUserList
+ */
+export interface GetPortalUserList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetPortalUser>}
+     * @memberof GetPortalUserList
+     */
+    items: Array<GetPortalUser>;
+}
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export declare function instanceOfGetPortalUserList(value: object): value is GetPortalUserList;
+export declare function GetPortalUserListFromJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserList;
+export declare function GetPortalUserListToJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListToJSONTyped(value?: GetPortalUserList | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalUserList.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 { GetPortalUserFromJSON, GetPortalUserToJSON, } from './GetPortalUser';
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export function instanceOfGetPortalUserList(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 GetPortalUserListFromJSON(json) {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+export function GetPortalUserListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(GetPortalUserFromJSON)),
+    };
+}
+export function GetPortalUserListToJSON(json) {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+export function GetPortalUserListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(GetPortalUserToJSON)),
+    };
+}

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

@@ -16,6 +16,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/esm/models/index.js

@@ -18,6 +18,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/models/GetPortalUser.d.ts

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ */
+/**
+ * A user with their portal access information
+ * @export
+ * @interface GetPortalUser
+ */
+export interface GetPortalUser {
+    /**
+     * The unique identifier for the user
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    userId: string;
+    /**
+     * The user's email address
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    email: string;
+    /**
+     * The user's first name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    firstName: string;
+    /**
+     * The user's last name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    lastName: string;
+    /**
+     * The user's role in the portal
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    role: GetPortalUserRoleEnum;
+    /**
+     * Whether the user's portal access is active
+     * @type {boolean}
+     * @memberof GetPortalUser
+     */
+    isActive: boolean;
+}
+/**
+ * @export
+ */
+export declare const GetPortalUserRoleEnum: {
+    readonly Admin: "Admin";
+    readonly Instructor: "Instructor";
+    readonly Learner: "Learner";
+};
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export declare function instanceOfGetPortalUser(value: object): value is GetPortalUser;
+export declare function GetPortalUserFromJSON(json: any): GetPortalUser;
+export declare function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser;
+export declare function GetPortalUserToJSON(json: any): GetPortalUser;
+export declare function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPortalUser.js

@@ -0,0 +1,79 @@
+"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.GetPortalUserRoleEnum = void 0;
+exports.instanceOfGetPortalUser = instanceOfGetPortalUser;
+exports.GetPortalUserFromJSON = GetPortalUserFromJSON;
+exports.GetPortalUserFromJSONTyped = GetPortalUserFromJSONTyped;
+exports.GetPortalUserToJSON = GetPortalUserToJSON;
+exports.GetPortalUserToJSONTyped = GetPortalUserToJSONTyped;
+/**
+ * @export
+ */
+exports.GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+};
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+function instanceOfGetPortalUser(value) {
+    if (!('userId' in value) || value['userId'] === undefined)
+        return false;
+    if (!('email' in value) || value['email'] === undefined)
+        return false;
+    if (!('firstName' in value) || value['firstName'] === undefined)
+        return false;
+    if (!('lastName' in value) || value['lastName'] === undefined)
+        return false;
+    if (!('role' in value) || value['role'] === undefined)
+        return false;
+    if (!('isActive' in value) || value['isActive'] === undefined)
+        return false;
+    return true;
+}
+function GetPortalUserFromJSON(json) {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+function GetPortalUserFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'userId': json['user_id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'role': json['role'],
+        'isActive': json['is_active'],
+    };
+}
+function GetPortalUserToJSON(json) {
+    return GetPortalUserToJSONTyped(json, false);
+}
+function GetPortalUserToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'user_id': value['userId'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'role': value['role'],
+        'is_active': value['isActive'],
+    };
+}

package/dist/models/GetPortalUserList.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 { GetPortalUser } from './GetPortalUser';
+/**
+ * A list of portal users with pagination information
+ * @export
+ * @interface GetPortalUserList
+ */
+export interface GetPortalUserList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalItems: number;
+    /**
+     *
+     * @type {Array<GetPortalUser>}
+     * @memberof GetPortalUserList
+     */
+    items: Array<GetPortalUser>;
+}
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export declare function instanceOfGetPortalUserList(value: object): value is GetPortalUserList;
+export declare function GetPortalUserListFromJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserList;
+export declare function GetPortalUserListToJSON(json: any): GetPortalUserList;
+export declare function GetPortalUserListToJSONTyped(value?: GetPortalUserList | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPortalUserList.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.instanceOfGetPortalUserList = instanceOfGetPortalUserList;
+exports.GetPortalUserListFromJSON = GetPortalUserListFromJSON;
+exports.GetPortalUserListFromJSONTyped = GetPortalUserListFromJSONTyped;
+exports.GetPortalUserListToJSON = GetPortalUserListToJSON;
+exports.GetPortalUserListToJSONTyped = GetPortalUserListToJSONTyped;
+const GetPortalUser_1 = require("./GetPortalUser");
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+function instanceOfGetPortalUserList(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 GetPortalUserListFromJSON(json) {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+function GetPortalUserListFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': (json['items'].map(GetPortalUser_1.GetPortalUserFromJSON)),
+    };
+}
+function GetPortalUserListToJSON(json) {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+function GetPortalUserListToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': (value['items'].map(GetPortalUser_1.GetPortalUserToJSON)),
+    };
+}

package/dist/models/index.d.ts

@@ -16,6 +16,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/models/index.js

@@ -34,6 +34,8 @@ __exportStar(require("./GetModule"), exports);
 __exportStar(require("./GetModuleList"), exports);
 __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalList"), exports);
+__exportStar(require("./GetPortalUser"), exports);
+__exportStar(require("./GetPortalUserList"), exports);
 __exportStar(require("./GetQuestion"), exports);
 __exportStar(require("./GetQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./GetQuestionList"), exports);

package/package.json

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

package/src/apis/PortalApi.ts

@@ -17,6 +17,7 @@ import * as runtime from '../runtime';
 import type {
   GetPortal,
   GetPortalList,
+  GetPortalUserList,
   PostPortal,
   PostPortalInvite,
   PutPortalBranding,
@@ -26,6 +27,8 @@ import {
     GetPortalToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
+    GetPortalUserListFromJSON,
+    GetPortalUserListToJSON,
     PostPortalFromJSON,
     PostPortalToJSON,
     PostPortalInviteFromJSON,
@@ -38,6 +41,13 @@ export interface GetPortalByIdRequest {
     portalId: string;
 }
 
+export interface GetPortalUsersRequest {
+    portalId: string;
+    roles?: Array<GetPortalUsersRolesEnum>;
+    page?: number;
+    pageSize?: number;
+}
+
 export interface InviteUserToPortalRequest {
     portalId: string;
     postPortalInvite: PostPortalInvite;
@@ -121,6 +131,51 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    async getPortalUsersRaw(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserList>> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling getPortalUsers().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['roles'] != null) {
+            queryParameters['roles'] = requestParameters['roles'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['page_size'] = requestParameters['pageSize'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/portals/{portalId}/users`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserListFromJSON(jsonValue));
+    }
+
+    /**
+     * Get all users for a portal with optional role filtering
+     */
+    async getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList> {
+        const response = await this.getPortalUsersRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Invite a new user to a portal
      */
@@ -279,3 +334,13 @@ export class PortalApi extends runtime.BaseAPI {
     }
 
 }
+
+/**
+ * @export
+ */
+export const GetPortalUsersRolesEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+} as const;
+export type GetPortalUsersRolesEnum = typeof GetPortalUsersRolesEnum[keyof typeof GetPortalUsersRolesEnum];

package/src/models/GetPortalUser.ts

@@ -0,0 +1,123 @@
+/* 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';
+/**
+ * A user with their portal access information
+ * @export
+ * @interface GetPortalUser
+ */
+export interface GetPortalUser {
+    /**
+     * The unique identifier for the user
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    userId: string;
+    /**
+     * The user's email address
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    email: string;
+    /**
+     * The user's first name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    firstName: string;
+    /**
+     * The user's last name
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    lastName: string;
+    /**
+     * The user's role in the portal
+     * @type {string}
+     * @memberof GetPortalUser
+     */
+    role: GetPortalUserRoleEnum;
+    /**
+     * Whether the user's portal access is active
+     * @type {boolean}
+     * @memberof GetPortalUser
+     */
+    isActive: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const GetPortalUserRoleEnum = {
+    Admin: 'Admin',
+    Instructor: 'Instructor',
+    Learner: 'Learner'
+} as const;
+export type GetPortalUserRoleEnum = typeof GetPortalUserRoleEnum[keyof typeof GetPortalUserRoleEnum];
+
+
+/**
+ * Check if a given object implements the GetPortalUser interface.
+ */
+export function instanceOfGetPortalUser(value: object): value is GetPortalUser {
+    if (!('userId' in value) || value['userId'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('firstName' in value) || value['firstName'] === undefined) return false;
+    if (!('lastName' in value) || value['lastName'] === undefined) return false;
+    if (!('role' in value) || value['role'] === undefined) return false;
+    if (!('isActive' in value) || value['isActive'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalUserFromJSON(json: any): GetPortalUser {
+    return GetPortalUserFromJSONTyped(json, false);
+}
+
+export function GetPortalUserFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUser {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'userId': json['user_id'],
+        'email': json['email'],
+        'firstName': json['first_name'],
+        'lastName': json['last_name'],
+        'role': json['role'],
+        'isActive': json['is_active'],
+    };
+}
+
+export function GetPortalUserToJSON(json: any): GetPortalUser {
+    return GetPortalUserToJSONTyped(json, false);
+}
+
+export function GetPortalUserToJSONTyped(value?: GetPortalUser | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'user_id': value['userId'],
+        'email': value['email'],
+        'first_name': value['firstName'],
+        'last_name': value['lastName'],
+        'role': value['role'],
+        'is_active': value['isActive'],
+    };
+}
+

package/src/models/GetPortalUserList.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 { GetPortalUser } from './GetPortalUser';
+import {
+    GetPortalUserFromJSON,
+    GetPortalUserFromJSONTyped,
+    GetPortalUserToJSON,
+    GetPortalUserToJSONTyped,
+} from './GetPortalUser';
+
+/**
+ * A list of portal users with pagination information
+ * @export
+ * @interface GetPortalUserList
+ */
+export interface GetPortalUserList {
+    /**
+     * The current page number
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    page: number;
+    /**
+     * The number of items per page
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    pageSize: number;
+    /**
+     * The total number of pages
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalPages: number;
+    /**
+     * The total number of items
+     * @type {number}
+     * @memberof GetPortalUserList
+     */
+    totalItems: number;
+    /**
+     * 
+     * @type {Array<GetPortalUser>}
+     * @memberof GetPortalUserList
+     */
+    items: Array<GetPortalUser>;
+}
+
+/**
+ * Check if a given object implements the GetPortalUserList interface.
+ */
+export function instanceOfGetPortalUserList(value: object): value is GetPortalUserList {
+    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 GetPortalUserListFromJSON(json: any): GetPortalUserList {
+    return GetPortalUserListFromJSONTyped(json, false);
+}
+
+export function GetPortalUserListFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'page': json['page'],
+        'pageSize': json['page_size'],
+        'totalPages': json['total_pages'],
+        'totalItems': json['total_items'],
+        'items': ((json['items'] as Array<any>).map(GetPortalUserFromJSON)),
+    };
+}
+
+export function GetPortalUserListToJSON(json: any): GetPortalUserList {
+    return GetPortalUserListToJSONTyped(json, false);
+}
+
+export function GetPortalUserListToJSONTyped(value?: GetPortalUserList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'page': value['page'],
+        'page_size': value['pageSize'],
+        'total_pages': value['totalPages'],
+        'total_items': value['totalItems'],
+        'items': ((value['items'] as Array<any>).map(GetPortalUserToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -18,6 +18,8 @@ export * from './GetModule';
 export * from './GetModuleList';
 export * from './GetPortal';
 export * from './GetPortalList';
+export * from './GetPortalUser';
+export * from './GetPortalUserList';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';