@easyedu/js-lsm-api 1.6.0 → 1.8.0

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/PostPortal.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 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 declare function instanceOfPostPortal(value: object): value is PostPortal;
+export declare function PostPortalFromJSON(json: any): PostPortal;
+export declare function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal;
+export declare function PostPortalToJSON(json: any): PostPortal;
+export declare function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/PostPortal.js

@@ -0,0 +1,47 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PostPortal interface.
+ */
+export function instanceOfPostPortal(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function PostPortalFromJSON(json) {
+    return PostPortalFromJSONTyped(json, false);
+}
+export function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return PostPortalToJSONTyped(json, false);
+}
+export function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}

package/dist/esm/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/esm/models/PutPortalBranding.js

@@ -0,0 +1,45 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the PutPortalBranding interface.
+ */
+export function instanceOfPutPortalBranding(value) {
+    return true;
+}
+export function PutPortalBrandingFromJSON(json) {
+    return PutPortalBrandingFromJSONTyped(json, false);
+}
+export 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'],
+    };
+}
+export function PutPortalBrandingToJSON(json) {
+    return PutPortalBrandingToJSONTyped(json, false);
+}
+export 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/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';
@@ -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/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';
@@ -90,6 +92,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';
@@ -112,6 +115,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/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/PostPortal.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 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 declare function instanceOfPostPortal(value: object): value is PostPortal;
+export declare function PostPortalFromJSON(json: any): PostPortal;
+export declare function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal;
+export declare function PostPortalToJSON(json: any): PostPortal;
+export declare function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator?: boolean): any;

package/dist/models/PostPortal.js

@@ -0,0 +1,54 @@
+"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.instanceOfPostPortal = instanceOfPostPortal;
+exports.PostPortalFromJSON = PostPortalFromJSON;
+exports.PostPortalFromJSONTyped = PostPortalFromJSONTyped;
+exports.PostPortalToJSON = PostPortalToJSON;
+exports.PostPortalToJSONTyped = PostPortalToJSONTyped;
+/**
+ * Check if a given object implements the PostPortal interface.
+ */
+function instanceOfPostPortal(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+function PostPortalFromJSON(json) {
+    return PostPortalFromJSONTyped(json, false);
+}
+function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
+    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'],
+    };
+}
+function PostPortalToJSON(json) {
+    return PostPortalToJSONTyped(json, false);
+}
+function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}