@easyedu/js-lsm-api 1.6.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
@@ -103,6 +105,7 @@ src/models/PostCourse.ts
 src/models/PostCourseEnrollment.ts
 src/models/PostLogin.ts
 src/models/PostModule.ts
+src/models/PostPortal.ts
 src/models/PostPortalInvite.ts
 src/models/PostQuestion.ts
 src/models/PostQuestionAnswerChoicesInner.ts
@@ -125,6 +128,7 @@ src/models/PostSendResetPassword.ts
 src/models/PutContent.ts
 src/models/PutCourse.ts
 src/models/PutModule.ts
+src/models/PutPortalBranding.ts
 src/models/PutQuestion.ts
 src/models/PutQuestionAnswerChoicesInner.ts
 src/models/PutQuiz.ts

package/README.md

@@ -1,4 +1,4 @@
-## @easyedu/js-lsm-api@1.6.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.6.0 --save
+npm install @easyedu/js-lsm-api@1.8.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/PortalApi.d.ts

@@ -10,14 +10,27 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, PostPortalInvite } 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;
 }
+export interface PostPortalRequest {
+    postPortal: PostPortal;
+}
+export interface PutPortalBrandingRequest {
+    portalId: string;
+    putPortalBranding: PutPortalBranding;
+}
 export interface UpdateSelectedPortalRequest {
     portalId: string;
     selectedUserRole?: string;
@@ -42,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
      */
@@ -50,6 +71,22 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Invite a new user to a portal
      */
     inviteUserToPortal(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
     /**
      * Update the users current selected portal
      */
@@ -59,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
      */
@@ -114,6 +151,69 @@ class PortalApi extends runtime.BaseAPI {
             yield this.inviteUserToPortalRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortalRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postPortal'] == null) {
+                throw new runtime.RequiredError('postPortal', 'Required parameter "postPortal" was null or undefined when calling postPortal().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            const response = yield this.request({
+                path: `/portals`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.PostPortalToJSON)(requestParameters['postPortal']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortal(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postPortalRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBrandingRaw(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 putPortalBranding().');
+            }
+            if (requestParameters['putPortalBranding'] == null) {
+                throw new runtime.RequiredError('putPortalBranding', 'Required parameter "putPortalBranding" was null or undefined when calling putPortalBranding().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            const response = yield this.request({
+                path: `/portals/{portalId}`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.PutPortalBrandingToJSON)(requestParameters['putPortalBranding']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBranding(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putPortalBrandingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Update the users current selected portal
      */
@@ -146,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,14 +10,27 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, PostPortalInvite } 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;
 }
+export interface PostPortalRequest {
+    postPortal: PostPortal;
+}
+export interface PutPortalBrandingRequest {
+    portalId: string;
+    putPortalBranding: PutPortalBranding;
+}
 export interface UpdateSelectedPortalRequest {
     portalId: string;
     selectedUserRole?: string;
@@ -42,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
      */
@@ -50,6 +71,22 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Invite a new user to a portal
      */
     inviteUserToPortal(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
     /**
      * Update the users current selected portal
      */
@@ -59,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, PostPortalInviteToJSON, } 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
      */
@@ -111,6 +148,69 @@ export class PortalApi extends runtime.BaseAPI {
             yield this.inviteUserToPortalRaw(requestParameters, initOverrides);
         });
     }
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortalRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['postPortal'] == null) {
+                throw new runtime.RequiredError('postPortal', 'Required parameter "postPortal" was null or undefined when calling postPortal().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            const response = yield this.request({
+                path: `/portals`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PostPortalToJSON(requestParameters['postPortal']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    postPortal(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postPortalRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBrandingRaw(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 putPortalBranding().');
+            }
+            if (requestParameters['putPortalBranding'] == null) {
+                throw new runtime.RequiredError('putPortalBranding', 'Required parameter "putPortalBranding" was null or undefined when calling putPortalBranding().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            const response = yield this.request({
+                path: `/portals/{portalId}`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: PutPortalBrandingToJSON(requestParameters['putPortalBranding']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    putPortalBranding(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.putPortalBrandingRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Update the users current selected portal
      */
@@ -142,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;