@easyedu/js-lsm-api 1.6.0 → 1.8.0

package/dist/models/PutPortalBranding.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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
+ * @interface PutPortalBranding
+ */
+export interface PutPortalBranding {
+    /**
+     *
+     * @type {string}
+     * @memberof PutPortalBranding
+     */
+    name?: string;
+    /**
+     * Hex color value for portal background (e.g.,
+     * @type {string}
+     * @memberof PutPortalBranding
+     */
+    headerBackgroundColor?: string;
+    /**
+     * Hex color value for portal text (e.g.,
+     * @type {string}
+     * @memberof PutPortalBranding
+     */
+    headerTextColor?: string;
+}
+/**
+ * Check if a given object implements the PutPortalBranding interface.
+ */
+export declare function instanceOfPutPortalBranding(value: object): value is PutPortalBranding;
+export declare function PutPortalBrandingFromJSON(json: any): PutPortalBranding;
+export declare function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalBranding;
+export declare function PutPortalBrandingToJSON(json: any): PutPortalBranding;
+export declare function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PutPortalBranding.js

@@ -0,0 +1,52 @@
+"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.instanceOfPutPortalBranding = instanceOfPutPortalBranding;
+exports.PutPortalBrandingFromJSON = PutPortalBrandingFromJSON;
+exports.PutPortalBrandingFromJSONTyped = PutPortalBrandingFromJSONTyped;
+exports.PutPortalBrandingToJSON = PutPortalBrandingToJSON;
+exports.PutPortalBrandingToJSONTyped = PutPortalBrandingToJSONTyped;
+/**
+ * Check if a given object implements the PutPortalBranding interface.
+ */
+function instanceOfPutPortalBranding(value) {
+    return true;
+}
+function PutPortalBrandingFromJSON(json) {
+    return PutPortalBrandingFromJSONTyped(json, false);
+}
+function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'] == null ? undefined : json['name'],
+        'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
+        'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+    };
+}
+function PutPortalBrandingToJSON(json) {
+    return PutPortalBrandingToJSONTyped(json, false);
+}
+function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}

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';
@@ -88,6 +90,7 @@ export * from './PostCourse';
 export * from './PostCourseEnrollment';
 export * from './PostLogin';
 export * from './PostModule';
+export * from './PostPortal';
 export * from './PostPortalInvite';
 export * from './PostQuestion';
 export * from './PostQuestionAnswerChoicesInner';
@@ -110,6 +113,7 @@ export * from './PostSendResetPassword';
 export * from './PutContent';
 export * from './PutCourse';
 export * from './PutModule';
+export * from './PutPortalBranding';
 export * from './PutQuestion';
 export * from './PutQuestionAnswerChoicesInner';
 export * from './PutQuiz';

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);
@@ -106,6 +108,7 @@ __exportStar(require("./PostCourse"), exports);
 __exportStar(require("./PostCourseEnrollment"), exports);
 __exportStar(require("./PostLogin"), exports);
 __exportStar(require("./PostModule"), exports);
+__exportStar(require("./PostPortal"), exports);
 __exportStar(require("./PostPortalInvite"), exports);
 __exportStar(require("./PostQuestion"), exports);
 __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
@@ -128,6 +131,7 @@ __exportStar(require("./PostSendResetPassword"), exports);
 __exportStar(require("./PutContent"), exports);
 __exportStar(require("./PutCourse"), exports);
 __exportStar(require("./PutModule"), exports);
+__exportStar(require("./PutPortalBranding"), exports);
 __exportStar(require("./PutQuestion"), exports);
 __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./PutQuiz"), exports);

package/package.json

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

package/src/apis/PortalApi.ts

@@ -17,26 +17,51 @@ import * as runtime from '../runtime';
 import type {
   GetPortal,
   GetPortalList,
+  GetPortalUserList,
+  PostPortal,
   PostPortalInvite,
+  PutPortalBranding,
 } from '../models/index';
 import {
     GetPortalFromJSON,
     GetPortalToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
+    GetPortalUserListFromJSON,
+    GetPortalUserListToJSON,
+    PostPortalFromJSON,
+    PostPortalToJSON,
     PostPortalInviteFromJSON,
     PostPortalInviteToJSON,
+    PutPortalBrandingFromJSON,
+    PutPortalBrandingToJSON,
 } 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;
@@ -106,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
      */
@@ -148,6 +218,85 @@ export class PortalApi extends runtime.BaseAPI {
         await this.inviteUserToPortalRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Create a new portal as a child of the current selected portal
+     */
+    async postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        if (requestParameters['postPortal'] == null) {
+            throw new runtime.RequiredError(
+                'postPortal',
+                'Required parameter "postPortal" was null or undefined when calling postPortal().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await 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
+     */
+    async postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
+        const response = await this.postPortalRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Update portal branding (name, background color, text color)
+     */
+    async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
+        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: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await 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)
+     */
+    async putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
+        const response = await this.putPortalBrandingRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update the users current selected portal
      */
@@ -185,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/PostPortal.ts

@@ -0,0 +1,82 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface PostPortal
+ */
+export interface PostPortal {
+    /**
+     * 
+     * @type {string}
+     * @memberof PostPortal
+     */
+    name: string;
+    /**
+     * Hex color value for portal background (e.g.,
+     * @type {string}
+     * @memberof PostPortal
+     */
+    headerBackgroundColor?: string;
+    /**
+     * Hex color value for portal text (e.g.,
+     * @type {string}
+     * @memberof PostPortal
+     */
+    headerTextColor?: string;
+}
+
+/**
+ * Check if a given object implements the PostPortal interface.
+ */
+export function instanceOfPostPortal(value: object): value is PostPortal {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function PostPortalFromJSON(json: any): PostPortal {
+    return PostPortalFromJSONTyped(json, false);
+}
+
+export function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
+        'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
+    };
+}
+
+export function PostPortalToJSON(json: any): PostPortal {
+    return PostPortalToJSONTyped(json, false);
+}
+
+export function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}
+