@easyedu/js-lsm-api 1.5.0 → 1.7.0

package/dist/models/GetContent.d.ts

@@ -58,6 +58,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     order?: number;
+    /**
+     * Whether the content is published and visible to students
+     * @type {boolean}
+     * @memberof GetContent
+     */
+    published: boolean;
     /**
      *
      * @type {Date}

package/dist/models/GetContent.js

@@ -46,6 +46,8 @@ function instanceOfGetContent(value) {
         return false;
     if (!('contentData' in value) || value['contentData'] === undefined)
         return false;
+    if (!('published' in value) || value['published'] === undefined)
+        return false;
     return true;
 }
 function GetContentFromJSON(json) {
@@ -63,6 +65,7 @@ function GetContentFromJSONTyped(json, ignoreDiscriminator) {
         'contentType': json['content_type'],
         'contentData': (0, GetContentContentData_1.GetContentContentDataFromJSON)(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
+        'published': json['published'],
         'createdDate': json['created_date'] == null ? undefined : (new Date(json['created_date'])),
         'updatedDate': json['updated_date'] == null ? undefined : (new Date(json['updated_date'])),
     };
@@ -81,5 +84,6 @@ function GetContentToJSONTyped(value, ignoreDiscriminator = false) {
         'content_type': value['contentType'],
         'content_data': (0, GetContentContentData_1.GetContentContentDataToJSON)(value['contentData']),
         'order': value['order'],
+        'published': value['published'],
     };
 }

package/dist/models/GetCourse.d.ts

@@ -45,6 +45,12 @@ export interface GetCourse {
      * @memberof GetCourse
      */
     imageUrl: string;
+    /**
+     * Whether the course is published and visible to students
+     * @type {boolean}
+     * @memberof GetCourse
+     */
+    published: boolean;
 }
 /**
  * Check if a given object implements the GetCourse interface.

package/dist/models/GetCourse.js

@@ -30,6 +30,8 @@ function instanceOfGetCourse(value) {
         return false;
     if (!('imageUrl' in value) || value['imageUrl'] === undefined)
         return false;
+    if (!('published' in value) || value['published'] === undefined)
+        return false;
     return true;
 }
 function GetCourseFromJSON(json) {
@@ -45,6 +47,7 @@ function GetCourseFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
         'imageUrl': json['image_url'],
+        'published': json['published'],
     };
 }
 function GetCourseToJSON(json) {
@@ -59,5 +62,6 @@ function GetCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'instructor': value['instructor'],
         'image_url': value['imageUrl'],
+        'published': value['published'],
     };
 }

package/dist/models/GetModule.d.ts

@@ -45,6 +45,12 @@ export interface GetModule {
      * @memberof GetModule
      */
     lastUpdated: number;
+    /**
+     * Whether the module is published and visible to students
+     * @type {boolean}
+     * @memberof GetModule
+     */
+    published: boolean;
 }
 /**
  * Check if a given object implements the GetModule interface.

package/dist/models/GetModule.js

@@ -32,6 +32,8 @@ function instanceOfGetModule(value) {
         return false;
     if (!('lastUpdated' in value) || value['lastUpdated'] === undefined)
         return false;
+    if (!('published' in value) || value['published'] === undefined)
+        return false;
     return true;
 }
 function GetModuleFromJSON(json) {
@@ -47,6 +49,7 @@ function GetModuleFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'],
         'order': json['order'],
         'lastUpdated': json['last_updated'],
+        'published': json['published'],
     };
 }
 function GetModuleToJSON(json) {
@@ -61,5 +64,6 @@ function GetModuleToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'order': value['order'],
         'last_updated': value['lastUpdated'],
+        'published': value['published'],
     };
 }

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'],
+    };
+}

package/dist/models/PutCourse.d.ts

@@ -45,6 +45,12 @@ export interface PutCourse {
      * @memberof PutCourse
      */
     imageUrl?: string;
+    /**
+     * Whether the course is published and visible to students
+     * @type {boolean}
+     * @memberof PutCourse
+     */
+    published?: boolean;
 }
 /**
  * Check if a given object implements the PutCourse interface.

package/dist/models/PutCourse.js

@@ -37,6 +37,7 @@ function PutCourseFromJSONTyped(json, ignoreDiscriminator) {
         'description': json['description'] == null ? undefined : json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
         'imageUrl': json['image_url'] == null ? undefined : json['image_url'],
+        'published': json['published'] == null ? undefined : json['published'],
     };
 }
 function PutCourseToJSON(json) {
@@ -51,5 +52,6 @@ function PutCourseToJSONTyped(value, ignoreDiscriminator = false) {
         'description': value['description'],
         'instructor': value['instructor'],
         'image_url': value['imageUrl'],
+        'published': value['published'],
     };
 }

package/dist/models/PutModule.d.ts

@@ -33,6 +33,12 @@ export interface PutModule {
      * @memberof PutModule
      */
     order?: number;
+    /**
+     * Whether the module is published and visible to students
+     * @type {boolean}
+     * @memberof PutModule
+     */
+    published?: boolean;
 }
 /**
  * Check if a given object implements the PutModule interface.

package/dist/models/PutModule.js

@@ -35,6 +35,7 @@ function PutModuleFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'order': json['order'] == null ? undefined : json['order'],
+        'published': json['published'] == null ? undefined : json['published'],
     };
 }
 function PutModuleToJSON(json) {
@@ -48,5 +49,6 @@ function PutModuleToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'description': value['description'],
         'order': value['order'],
+        'published': value['published'],
     };
 }

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

@@ -88,6 +88,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 +111,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

@@ -106,6 +106,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 +129,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.5.0",
+  "version": "1.7.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/PortalApi.ts

@@ -17,15 +17,21 @@ import * as runtime from '../runtime';
 import type {
   GetPortal,
   GetPortalList,
+  PostPortal,
   PostPortalInvite,
+  PutPortalBranding,
 } from '../models/index';
 import {
     GetPortalFromJSON,
     GetPortalToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
+    PostPortalFromJSON,
+    PostPortalToJSON,
     PostPortalInviteFromJSON,
     PostPortalInviteToJSON,
+    PutPortalBrandingFromJSON,
+    PutPortalBrandingToJSON,
 } from '../models/index';
 
 export interface GetPortalByIdRequest {
@@ -37,6 +43,15 @@ export interface InviteUserToPortalRequest {
     postPortalInvite: PostPortalInvite;
 }
 
+export interface PostPortalRequest {
+    postPortal: PostPortal;
+}
+
+export interface PutPortalBrandingRequest {
+    portalId: string;
+    putPortalBranding: PutPortalBranding;
+}
+
 export interface UpdateSelectedPortalRequest {
     portalId: string;
     selectedUserRole?: string;
@@ -148,6 +163,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
      */

package/src/models/GetContent.ts

@@ -69,6 +69,12 @@ export interface GetContent {
      * @memberof GetContent
      */
     order?: number;
+    /**
+     * Whether the content is published and visible to students
+     * @type {boolean}
+     * @memberof GetContent
+     */
+    published: boolean;
     /**
      * 
      * @type {Date}
@@ -108,6 +114,7 @@ export function instanceOfGetContent(value: object): value is GetContent {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('contentType' in value) || value['contentType'] === undefined) return false;
     if (!('contentData' in value) || value['contentData'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
     return true;
 }
 
@@ -128,6 +135,7 @@ export function GetContentFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'contentType': json['content_type'],
         'contentData': GetContentContentDataFromJSON(json['content_data']),
         'order': json['order'] == null ? undefined : json['order'],
+        'published': json['published'],
         'createdDate': json['created_date'] == null ? undefined : (new Date(json['created_date'])),
         'updatedDate': json['updated_date'] == null ? undefined : (new Date(json['updated_date'])),
     };
@@ -150,6 +158,7 @@ export function GetContentToJSONTyped(value?: Omit<GetContent, 'id'|'created_dat
         'content_type': value['contentType'],
         'content_data': GetContentContentDataToJSON(value['contentData']),
         'order': value['order'],
+        'published': value['published'],
     };
 }
 

package/src/models/GetCourse.ts

@@ -49,6 +49,12 @@ export interface GetCourse {
      * @memberof GetCourse
      */
     imageUrl: string;
+    /**
+     * Whether the course is published and visible to students
+     * @type {boolean}
+     * @memberof GetCourse
+     */
+    published: boolean;
 }
 
 /**
@@ -59,6 +65,7 @@ export function instanceOfGetCourse(value: object): value is GetCourse {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('imageUrl' in value) || value['imageUrl'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
     return true;
 }
 
@@ -77,6 +84,7 @@ export function GetCourseFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'description': json['description'],
         'instructor': json['instructor'] == null ? undefined : json['instructor'],
         'imageUrl': json['image_url'],
+        'published': json['published'],
     };
 }
 
@@ -95,6 +103,7 @@ export function GetCourseToJSONTyped(value?: Omit<GetCourse, 'id'> | null, ignor
         'description': value['description'],
         'instructor': value['instructor'],
         'image_url': value['imageUrl'],
+        'published': value['published'],
     };
 }
 

package/src/models/GetModule.ts

@@ -49,6 +49,12 @@ export interface GetModule {
      * @memberof GetModule
      */
     lastUpdated: number;
+    /**
+     * Whether the module is published and visible to students
+     * @type {boolean}
+     * @memberof GetModule
+     */
+    published: boolean;
 }
 
 /**
@@ -60,6 +66,7 @@ export function instanceOfGetModule(value: object): value is GetModule {
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('order' in value) || value['order'] === undefined) return false;
     if (!('lastUpdated' in value) || value['lastUpdated'] === undefined) return false;
+    if (!('published' in value) || value['published'] === undefined) return false;
     return true;
 }
 
@@ -78,6 +85,7 @@ export function GetModuleFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'description': json['description'],
         'order': json['order'],
         'lastUpdated': json['last_updated'],
+        'published': json['published'],
     };
 }
 
@@ -96,6 +104,7 @@ export function GetModuleToJSONTyped(value?: Omit<GetModule, 'id'> | null, ignor
         'description': value['description'],
         'order': value['order'],
         'last_updated': value['lastUpdated'],
+        'published': value['published'],
     };
 }