@easyedu/js-lsm-api 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -103,6 +103,7 @@ src/models/PostCourse.ts
103
103
  src/models/PostCourseEnrollment.ts
104
104
  src/models/PostLogin.ts
105
105
  src/models/PostModule.ts
106
+ src/models/PostPortal.ts
106
107
  src/models/PostPortalInvite.ts
107
108
  src/models/PostQuestion.ts
108
109
  src/models/PostQuestionAnswerChoicesInner.ts
@@ -125,6 +126,7 @@ src/models/PostSendResetPassword.ts
125
126
  src/models/PutContent.ts
126
127
  src/models/PutCourse.ts
127
128
  src/models/PutModule.ts
129
+ src/models/PutPortalBranding.ts
128
130
  src/models/PutQuestion.ts
129
131
  src/models/PutQuestionAnswerChoicesInner.ts
130
132
  src/models/PutQuiz.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @easyedu/js-lsm-api@1.6.0
1
+ ## @easyedu/js-lsm-api@1.7.0
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @easyedu/js-lsm-api@1.6.0 --save
39
+ npm install @easyedu/js-lsm-api@1.7.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetPortal, GetPortalList, PostPortalInvite } from '../models/index';
13
+ import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
14
14
  export interface GetPortalByIdRequest {
15
15
  portalId: string;
16
16
  }
@@ -18,6 +18,13 @@ export interface InviteUserToPortalRequest {
18
18
  portalId: string;
19
19
  postPortalInvite: PostPortalInvite;
20
20
  }
21
+ export interface PostPortalRequest {
22
+ postPortal: PostPortal;
23
+ }
24
+ export interface PutPortalBrandingRequest {
25
+ portalId: string;
26
+ putPortalBranding: PutPortalBranding;
27
+ }
21
28
  export interface UpdateSelectedPortalRequest {
22
29
  portalId: string;
23
30
  selectedUserRole?: string;
@@ -50,6 +57,22 @@ export declare class PortalApi extends runtime.BaseAPI {
50
57
  * Invite a new user to a portal
51
58
  */
52
59
  inviteUserToPortal(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
60
+ /**
61
+ * Create a new portal as a child of the current selected portal
62
+ */
63
+ postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
64
+ /**
65
+ * Create a new portal as a child of the current selected portal
66
+ */
67
+ postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
68
+ /**
69
+ * Update portal branding (name, background color, text color)
70
+ */
71
+ putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
72
+ /**
73
+ * Update portal branding (name, background color, text color)
74
+ */
75
+ putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
53
76
  /**
54
77
  * Update the users current selected portal
55
78
  */
@@ -114,6 +114,69 @@ class PortalApi extends runtime.BaseAPI {
114
114
  yield this.inviteUserToPortalRaw(requestParameters, initOverrides);
115
115
  });
116
116
  }
117
+ /**
118
+ * Create a new portal as a child of the current selected portal
119
+ */
120
+ postPortalRaw(requestParameters, initOverrides) {
121
+ return __awaiter(this, void 0, void 0, function* () {
122
+ if (requestParameters['postPortal'] == null) {
123
+ throw new runtime.RequiredError('postPortal', 'Required parameter "postPortal" was null or undefined when calling postPortal().');
124
+ }
125
+ const queryParameters = {};
126
+ const headerParameters = {};
127
+ headerParameters['Content-Type'] = 'application/json';
128
+ const response = yield this.request({
129
+ path: `/portals`,
130
+ method: 'POST',
131
+ headers: headerParameters,
132
+ query: queryParameters,
133
+ body: (0, index_1.PostPortalToJSON)(requestParameters['postPortal']),
134
+ }, initOverrides);
135
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalFromJSON)(jsonValue));
136
+ });
137
+ }
138
+ /**
139
+ * Create a new portal as a child of the current selected portal
140
+ */
141
+ postPortal(requestParameters, initOverrides) {
142
+ return __awaiter(this, void 0, void 0, function* () {
143
+ const response = yield this.postPortalRaw(requestParameters, initOverrides);
144
+ return yield response.value();
145
+ });
146
+ }
147
+ /**
148
+ * Update portal branding (name, background color, text color)
149
+ */
150
+ putPortalBrandingRaw(requestParameters, initOverrides) {
151
+ return __awaiter(this, void 0, void 0, function* () {
152
+ if (requestParameters['portalId'] == null) {
153
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalBranding().');
154
+ }
155
+ if (requestParameters['putPortalBranding'] == null) {
156
+ throw new runtime.RequiredError('putPortalBranding', 'Required parameter "putPortalBranding" was null or undefined when calling putPortalBranding().');
157
+ }
158
+ const queryParameters = {};
159
+ const headerParameters = {};
160
+ headerParameters['Content-Type'] = 'application/json';
161
+ const response = yield this.request({
162
+ path: `/portals/{portalId}`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
163
+ method: 'PUT',
164
+ headers: headerParameters,
165
+ query: queryParameters,
166
+ body: (0, index_1.PutPortalBrandingToJSON)(requestParameters['putPortalBranding']),
167
+ }, initOverrides);
168
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalFromJSON)(jsonValue));
169
+ });
170
+ }
171
+ /**
172
+ * Update portal branding (name, background color, text color)
173
+ */
174
+ putPortalBranding(requestParameters, initOverrides) {
175
+ return __awaiter(this, void 0, void 0, function* () {
176
+ const response = yield this.putPortalBrandingRaw(requestParameters, initOverrides);
177
+ return yield response.value();
178
+ });
179
+ }
117
180
  /**
118
181
  * Update the users current selected portal
119
182
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { GetPortal, GetPortalList, PostPortalInvite } from '../models/index';
13
+ import type { GetPortal, GetPortalList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
14
14
  export interface GetPortalByIdRequest {
15
15
  portalId: string;
16
16
  }
@@ -18,6 +18,13 @@ export interface InviteUserToPortalRequest {
18
18
  portalId: string;
19
19
  postPortalInvite: PostPortalInvite;
20
20
  }
21
+ export interface PostPortalRequest {
22
+ postPortal: PostPortal;
23
+ }
24
+ export interface PutPortalBrandingRequest {
25
+ portalId: string;
26
+ putPortalBranding: PutPortalBranding;
27
+ }
21
28
  export interface UpdateSelectedPortalRequest {
22
29
  portalId: string;
23
30
  selectedUserRole?: string;
@@ -50,6 +57,22 @@ export declare class PortalApi extends runtime.BaseAPI {
50
57
  * Invite a new user to a portal
51
58
  */
52
59
  inviteUserToPortal(requestParameters: InviteUserToPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
60
+ /**
61
+ * Create a new portal as a child of the current selected portal
62
+ */
63
+ postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
64
+ /**
65
+ * Create a new portal as a child of the current selected portal
66
+ */
67
+ postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
68
+ /**
69
+ * Update portal branding (name, background color, text color)
70
+ */
71
+ putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>>;
72
+ /**
73
+ * Update portal branding (name, background color, text color)
74
+ */
75
+ putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
53
76
  /**
54
77
  * Update the users current selected portal
55
78
  */
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
21
21
  });
22
22
  };
23
23
  import * as runtime from '../runtime';
24
- import { GetPortalFromJSON, GetPortalListFromJSON, PostPortalInviteToJSON, } from '../models/index';
24
+ import { GetPortalFromJSON, GetPortalListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
25
25
  /**
26
26
  *
27
27
  */
@@ -111,6 +111,69 @@ export class PortalApi extends runtime.BaseAPI {
111
111
  yield this.inviteUserToPortalRaw(requestParameters, initOverrides);
112
112
  });
113
113
  }
114
+ /**
115
+ * Create a new portal as a child of the current selected portal
116
+ */
117
+ postPortalRaw(requestParameters, initOverrides) {
118
+ return __awaiter(this, void 0, void 0, function* () {
119
+ if (requestParameters['postPortal'] == null) {
120
+ throw new runtime.RequiredError('postPortal', 'Required parameter "postPortal" was null or undefined when calling postPortal().');
121
+ }
122
+ const queryParameters = {};
123
+ const headerParameters = {};
124
+ headerParameters['Content-Type'] = 'application/json';
125
+ const response = yield this.request({
126
+ path: `/portals`,
127
+ method: 'POST',
128
+ headers: headerParameters,
129
+ query: queryParameters,
130
+ body: PostPortalToJSON(requestParameters['postPortal']),
131
+ }, initOverrides);
132
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
133
+ });
134
+ }
135
+ /**
136
+ * Create a new portal as a child of the current selected portal
137
+ */
138
+ postPortal(requestParameters, initOverrides) {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ const response = yield this.postPortalRaw(requestParameters, initOverrides);
141
+ return yield response.value();
142
+ });
143
+ }
144
+ /**
145
+ * Update portal branding (name, background color, text color)
146
+ */
147
+ putPortalBrandingRaw(requestParameters, initOverrides) {
148
+ return __awaiter(this, void 0, void 0, function* () {
149
+ if (requestParameters['portalId'] == null) {
150
+ throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalBranding().');
151
+ }
152
+ if (requestParameters['putPortalBranding'] == null) {
153
+ throw new runtime.RequiredError('putPortalBranding', 'Required parameter "putPortalBranding" was null or undefined when calling putPortalBranding().');
154
+ }
155
+ const queryParameters = {};
156
+ const headerParameters = {};
157
+ headerParameters['Content-Type'] = 'application/json';
158
+ const response = yield this.request({
159
+ path: `/portals/{portalId}`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
160
+ method: 'PUT',
161
+ headers: headerParameters,
162
+ query: queryParameters,
163
+ body: PutPortalBrandingToJSON(requestParameters['putPortalBranding']),
164
+ }, initOverrides);
165
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
166
+ });
167
+ }
168
+ /**
169
+ * Update portal branding (name, background color, text color)
170
+ */
171
+ putPortalBranding(requestParameters, initOverrides) {
172
+ return __awaiter(this, void 0, void 0, function* () {
173
+ const response = yield this.putPortalBrandingRaw(requestParameters, initOverrides);
174
+ return yield response.value();
175
+ });
176
+ }
114
177
  /**
115
178
  * Update the users current selected portal
116
179
  */
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostPortal
16
+ */
17
+ export interface PostPortal {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PostPortal
22
+ */
23
+ name: string;
24
+ /**
25
+ * Hex color value for portal background (e.g.,
26
+ * @type {string}
27
+ * @memberof PostPortal
28
+ */
29
+ headerBackgroundColor?: string;
30
+ /**
31
+ * Hex color value for portal text (e.g.,
32
+ * @type {string}
33
+ * @memberof PostPortal
34
+ */
35
+ headerTextColor?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PostPortal interface.
39
+ */
40
+ export declare function instanceOfPostPortal(value: object): value is PostPortal;
41
+ export declare function PostPortalFromJSON(json: any): PostPortal;
42
+ export declare function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal;
43
+ export declare function PostPortalToJSON(json: any): PostPortal;
44
+ export declare function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,47 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the PostPortal interface.
16
+ */
17
+ export function instanceOfPostPortal(value) {
18
+ if (!('name' in value) || value['name'] === undefined)
19
+ return false;
20
+ return true;
21
+ }
22
+ export function PostPortalFromJSON(json) {
23
+ return PostPortalFromJSONTyped(json, false);
24
+ }
25
+ export function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
26
+ if (json == null) {
27
+ return json;
28
+ }
29
+ return {
30
+ 'name': json['name'],
31
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
32
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
33
+ };
34
+ }
35
+ export function PostPortalToJSON(json) {
36
+ return PostPortalToJSONTyped(json, false);
37
+ }
38
+ export function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
39
+ if (value == null) {
40
+ return value;
41
+ }
42
+ return {
43
+ 'name': value['name'],
44
+ 'header_background_color': value['headerBackgroundColor'],
45
+ 'header_text_color': value['headerTextColor'],
46
+ };
47
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PutPortalBranding
16
+ */
17
+ export interface PutPortalBranding {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PutPortalBranding
22
+ */
23
+ name?: string;
24
+ /**
25
+ * Hex color value for portal background (e.g.,
26
+ * @type {string}
27
+ * @memberof PutPortalBranding
28
+ */
29
+ headerBackgroundColor?: string;
30
+ /**
31
+ * Hex color value for portal text (e.g.,
32
+ * @type {string}
33
+ * @memberof PutPortalBranding
34
+ */
35
+ headerTextColor?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PutPortalBranding interface.
39
+ */
40
+ export declare function instanceOfPutPortalBranding(value: object): value is PutPortalBranding;
41
+ export declare function PutPortalBrandingFromJSON(json: any): PutPortalBranding;
42
+ export declare function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalBranding;
43
+ export declare function PutPortalBrandingToJSON(json: any): PutPortalBranding;
44
+ export declare function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,45 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * Check if a given object implements the PutPortalBranding interface.
16
+ */
17
+ export function instanceOfPutPortalBranding(value) {
18
+ return true;
19
+ }
20
+ export function PutPortalBrandingFromJSON(json) {
21
+ return PutPortalBrandingFromJSONTyped(json, false);
22
+ }
23
+ export function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
24
+ if (json == null) {
25
+ return json;
26
+ }
27
+ return {
28
+ 'name': json['name'] == null ? undefined : json['name'],
29
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
30
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
31
+ };
32
+ }
33
+ export function PutPortalBrandingToJSON(json) {
34
+ return PutPortalBrandingToJSONTyped(json, false);
35
+ }
36
+ export function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
37
+ if (value == null) {
38
+ return value;
39
+ }
40
+ return {
41
+ 'name': value['name'],
42
+ 'header_background_color': value['headerBackgroundColor'],
43
+ 'header_text_color': value['headerTextColor'],
44
+ };
45
+ }
@@ -88,6 +88,7 @@ export * from './PostCourse';
88
88
  export * from './PostCourseEnrollment';
89
89
  export * from './PostLogin';
90
90
  export * from './PostModule';
91
+ export * from './PostPortal';
91
92
  export * from './PostPortalInvite';
92
93
  export * from './PostQuestion';
93
94
  export * from './PostQuestionAnswerChoicesInner';
@@ -110,6 +111,7 @@ export * from './PostSendResetPassword';
110
111
  export * from './PutContent';
111
112
  export * from './PutCourse';
112
113
  export * from './PutModule';
114
+ export * from './PutPortalBranding';
113
115
  export * from './PutQuestion';
114
116
  export * from './PutQuestionAnswerChoicesInner';
115
117
  export * from './PutQuiz';
@@ -90,6 +90,7 @@ export * from './PostCourse';
90
90
  export * from './PostCourseEnrollment';
91
91
  export * from './PostLogin';
92
92
  export * from './PostModule';
93
+ export * from './PostPortal';
93
94
  export * from './PostPortalInvite';
94
95
  export * from './PostQuestion';
95
96
  export * from './PostQuestionAnswerChoicesInner';
@@ -112,6 +113,7 @@ export * from './PostSendResetPassword';
112
113
  export * from './PutContent';
113
114
  export * from './PutCourse';
114
115
  export * from './PutModule';
116
+ export * from './PutPortalBranding';
115
117
  export * from './PutQuestion';
116
118
  export * from './PutQuestionAnswerChoicesInner';
117
119
  export * from './PutQuiz';
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PostPortal
16
+ */
17
+ export interface PostPortal {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PostPortal
22
+ */
23
+ name: string;
24
+ /**
25
+ * Hex color value for portal background (e.g.,
26
+ * @type {string}
27
+ * @memberof PostPortal
28
+ */
29
+ headerBackgroundColor?: string;
30
+ /**
31
+ * Hex color value for portal text (e.g.,
32
+ * @type {string}
33
+ * @memberof PostPortal
34
+ */
35
+ headerTextColor?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PostPortal interface.
39
+ */
40
+ export declare function instanceOfPostPortal(value: object): value is PostPortal;
41
+ export declare function PostPortalFromJSON(json: any): PostPortal;
42
+ export declare function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal;
43
+ export declare function PostPortalToJSON(json: any): PostPortal;
44
+ export declare function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfPostPortal = instanceOfPostPortal;
17
+ exports.PostPortalFromJSON = PostPortalFromJSON;
18
+ exports.PostPortalFromJSONTyped = PostPortalFromJSONTyped;
19
+ exports.PostPortalToJSON = PostPortalToJSON;
20
+ exports.PostPortalToJSONTyped = PostPortalToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PostPortal interface.
23
+ */
24
+ function instanceOfPostPortal(value) {
25
+ if (!('name' in value) || value['name'] === undefined)
26
+ return false;
27
+ return true;
28
+ }
29
+ function PostPortalFromJSON(json) {
30
+ return PostPortalFromJSONTyped(json, false);
31
+ }
32
+ function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'name': json['name'],
38
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
39
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
40
+ };
41
+ }
42
+ function PostPortalToJSON(json) {
43
+ return PostPortalToJSONTyped(json, false);
44
+ }
45
+ function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
46
+ if (value == null) {
47
+ return value;
48
+ }
49
+ return {
50
+ 'name': value['name'],
51
+ 'header_background_color': value['headerBackgroundColor'],
52
+ 'header_text_color': value['headerTextColor'],
53
+ };
54
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * LMS API
3
+ * LMS API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface PutPortalBranding
16
+ */
17
+ export interface PutPortalBranding {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof PutPortalBranding
22
+ */
23
+ name?: string;
24
+ /**
25
+ * Hex color value for portal background (e.g.,
26
+ * @type {string}
27
+ * @memberof PutPortalBranding
28
+ */
29
+ headerBackgroundColor?: string;
30
+ /**
31
+ * Hex color value for portal text (e.g.,
32
+ * @type {string}
33
+ * @memberof PutPortalBranding
34
+ */
35
+ headerTextColor?: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the PutPortalBranding interface.
39
+ */
40
+ export declare function instanceOfPutPortalBranding(value: object): value is PutPortalBranding;
41
+ export declare function PutPortalBrandingFromJSON(json: any): PutPortalBranding;
42
+ export declare function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalBranding;
43
+ export declare function PutPortalBrandingToJSON(json: any): PutPortalBranding;
44
+ export declare function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * LMS API
6
+ * LMS API
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfPutPortalBranding = instanceOfPutPortalBranding;
17
+ exports.PutPortalBrandingFromJSON = PutPortalBrandingFromJSON;
18
+ exports.PutPortalBrandingFromJSONTyped = PutPortalBrandingFromJSONTyped;
19
+ exports.PutPortalBrandingToJSON = PutPortalBrandingToJSON;
20
+ exports.PutPortalBrandingToJSONTyped = PutPortalBrandingToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the PutPortalBranding interface.
23
+ */
24
+ function instanceOfPutPortalBranding(value) {
25
+ return true;
26
+ }
27
+ function PutPortalBrandingFromJSON(json) {
28
+ return PutPortalBrandingFromJSONTyped(json, false);
29
+ }
30
+ function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'name': json['name'] == null ? undefined : json['name'],
36
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
37
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
38
+ };
39
+ }
40
+ function PutPortalBrandingToJSON(json) {
41
+ return PutPortalBrandingToJSONTyped(json, false);
42
+ }
43
+ function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'name': value['name'],
49
+ 'header_background_color': value['headerBackgroundColor'],
50
+ 'header_text_color': value['headerTextColor'],
51
+ };
52
+ }
@@ -88,6 +88,7 @@ export * from './PostCourse';
88
88
  export * from './PostCourseEnrollment';
89
89
  export * from './PostLogin';
90
90
  export * from './PostModule';
91
+ export * from './PostPortal';
91
92
  export * from './PostPortalInvite';
92
93
  export * from './PostQuestion';
93
94
  export * from './PostQuestionAnswerChoicesInner';
@@ -110,6 +111,7 @@ export * from './PostSendResetPassword';
110
111
  export * from './PutContent';
111
112
  export * from './PutCourse';
112
113
  export * from './PutModule';
114
+ export * from './PutPortalBranding';
113
115
  export * from './PutQuestion';
114
116
  export * from './PutQuestionAnswerChoicesInner';
115
117
  export * from './PutQuiz';
@@ -106,6 +106,7 @@ __exportStar(require("./PostCourse"), exports);
106
106
  __exportStar(require("./PostCourseEnrollment"), exports);
107
107
  __exportStar(require("./PostLogin"), exports);
108
108
  __exportStar(require("./PostModule"), exports);
109
+ __exportStar(require("./PostPortal"), exports);
109
110
  __exportStar(require("./PostPortalInvite"), exports);
110
111
  __exportStar(require("./PostQuestion"), exports);
111
112
  __exportStar(require("./PostQuestionAnswerChoicesInner"), exports);
@@ -128,6 +129,7 @@ __exportStar(require("./PostSendResetPassword"), exports);
128
129
  __exportStar(require("./PutContent"), exports);
129
130
  __exportStar(require("./PutCourse"), exports);
130
131
  __exportStar(require("./PutModule"), exports);
132
+ __exportStar(require("./PutPortalBranding"), exports);
131
133
  __exportStar(require("./PutQuestion"), exports);
132
134
  __exportStar(require("./PutQuestionAnswerChoicesInner"), exports);
133
135
  __exportStar(require("./PutQuiz"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@easyedu/js-lsm-api",
3
- "version": "1.6.0",
3
+ "version": "1.7.0",
4
4
  "description": "OpenAPI client for @easyedu/js-lsm-api",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -17,15 +17,21 @@ import * as runtime from '../runtime';
17
17
  import type {
18
18
  GetPortal,
19
19
  GetPortalList,
20
+ PostPortal,
20
21
  PostPortalInvite,
22
+ PutPortalBranding,
21
23
  } from '../models/index';
22
24
  import {
23
25
  GetPortalFromJSON,
24
26
  GetPortalToJSON,
25
27
  GetPortalListFromJSON,
26
28
  GetPortalListToJSON,
29
+ PostPortalFromJSON,
30
+ PostPortalToJSON,
27
31
  PostPortalInviteFromJSON,
28
32
  PostPortalInviteToJSON,
33
+ PutPortalBrandingFromJSON,
34
+ PutPortalBrandingToJSON,
29
35
  } from '../models/index';
30
36
 
31
37
  export interface GetPortalByIdRequest {
@@ -37,6 +43,15 @@ export interface InviteUserToPortalRequest {
37
43
  postPortalInvite: PostPortalInvite;
38
44
  }
39
45
 
46
+ export interface PostPortalRequest {
47
+ postPortal: PostPortal;
48
+ }
49
+
50
+ export interface PutPortalBrandingRequest {
51
+ portalId: string;
52
+ putPortalBranding: PutPortalBranding;
53
+ }
54
+
40
55
  export interface UpdateSelectedPortalRequest {
41
56
  portalId: string;
42
57
  selectedUserRole?: string;
@@ -148,6 +163,85 @@ export class PortalApi extends runtime.BaseAPI {
148
163
  await this.inviteUserToPortalRaw(requestParameters, initOverrides);
149
164
  }
150
165
 
166
+ /**
167
+ * Create a new portal as a child of the current selected portal
168
+ */
169
+ async postPortalRaw(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
170
+ if (requestParameters['postPortal'] == null) {
171
+ throw new runtime.RequiredError(
172
+ 'postPortal',
173
+ 'Required parameter "postPortal" was null or undefined when calling postPortal().'
174
+ );
175
+ }
176
+
177
+ const queryParameters: any = {};
178
+
179
+ const headerParameters: runtime.HTTPHeaders = {};
180
+
181
+ headerParameters['Content-Type'] = 'application/json';
182
+
183
+ const response = await this.request({
184
+ path: `/portals`,
185
+ method: 'POST',
186
+ headers: headerParameters,
187
+ query: queryParameters,
188
+ body: PostPortalToJSON(requestParameters['postPortal']),
189
+ }, initOverrides);
190
+
191
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
192
+ }
193
+
194
+ /**
195
+ * Create a new portal as a child of the current selected portal
196
+ */
197
+ async postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
198
+ const response = await this.postPortalRaw(requestParameters, initOverrides);
199
+ return await response.value();
200
+ }
201
+
202
+ /**
203
+ * Update portal branding (name, background color, text color)
204
+ */
205
+ async putPortalBrandingRaw(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortal>> {
206
+ if (requestParameters['portalId'] == null) {
207
+ throw new runtime.RequiredError(
208
+ 'portalId',
209
+ 'Required parameter "portalId" was null or undefined when calling putPortalBranding().'
210
+ );
211
+ }
212
+
213
+ if (requestParameters['putPortalBranding'] == null) {
214
+ throw new runtime.RequiredError(
215
+ 'putPortalBranding',
216
+ 'Required parameter "putPortalBranding" was null or undefined when calling putPortalBranding().'
217
+ );
218
+ }
219
+
220
+ const queryParameters: any = {};
221
+
222
+ const headerParameters: runtime.HTTPHeaders = {};
223
+
224
+ headerParameters['Content-Type'] = 'application/json';
225
+
226
+ const response = await this.request({
227
+ path: `/portals/{portalId}`.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId']))),
228
+ method: 'PUT',
229
+ headers: headerParameters,
230
+ query: queryParameters,
231
+ body: PutPortalBrandingToJSON(requestParameters['putPortalBranding']),
232
+ }, initOverrides);
233
+
234
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFromJSON(jsonValue));
235
+ }
236
+
237
+ /**
238
+ * Update portal branding (name, background color, text color)
239
+ */
240
+ async putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal> {
241
+ const response = await this.putPortalBrandingRaw(requestParameters, initOverrides);
242
+ return await response.value();
243
+ }
244
+
151
245
  /**
152
246
  * Update the users current selected portal
153
247
  */
@@ -0,0 +1,82 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PostPortal
20
+ */
21
+ export interface PostPortal {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PostPortal
26
+ */
27
+ name: string;
28
+ /**
29
+ * Hex color value for portal background (e.g.,
30
+ * @type {string}
31
+ * @memberof PostPortal
32
+ */
33
+ headerBackgroundColor?: string;
34
+ /**
35
+ * Hex color value for portal text (e.g.,
36
+ * @type {string}
37
+ * @memberof PostPortal
38
+ */
39
+ headerTextColor?: string;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the PostPortal interface.
44
+ */
45
+ export function instanceOfPostPortal(value: object): value is PostPortal {
46
+ if (!('name' in value) || value['name'] === undefined) return false;
47
+ return true;
48
+ }
49
+
50
+ export function PostPortalFromJSON(json: any): PostPortal {
51
+ return PostPortalFromJSONTyped(json, false);
52
+ }
53
+
54
+ export function PostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PostPortal {
55
+ if (json == null) {
56
+ return json;
57
+ }
58
+ return {
59
+
60
+ 'name': json['name'],
61
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
62
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
63
+ };
64
+ }
65
+
66
+ export function PostPortalToJSON(json: any): PostPortal {
67
+ return PostPortalToJSONTyped(json, false);
68
+ }
69
+
70
+ export function PostPortalToJSONTyped(value?: PostPortal | null, ignoreDiscriminator: boolean = false): any {
71
+ if (value == null) {
72
+ return value;
73
+ }
74
+
75
+ return {
76
+
77
+ 'name': value['name'],
78
+ 'header_background_color': value['headerBackgroundColor'],
79
+ 'header_text_color': value['headerTextColor'],
80
+ };
81
+ }
82
+
@@ -0,0 +1,81 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * LMS API
5
+ * LMS API
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface PutPortalBranding
20
+ */
21
+ export interface PutPortalBranding {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof PutPortalBranding
26
+ */
27
+ name?: string;
28
+ /**
29
+ * Hex color value for portal background (e.g.,
30
+ * @type {string}
31
+ * @memberof PutPortalBranding
32
+ */
33
+ headerBackgroundColor?: string;
34
+ /**
35
+ * Hex color value for portal text (e.g.,
36
+ * @type {string}
37
+ * @memberof PutPortalBranding
38
+ */
39
+ headerTextColor?: string;
40
+ }
41
+
42
+ /**
43
+ * Check if a given object implements the PutPortalBranding interface.
44
+ */
45
+ export function instanceOfPutPortalBranding(value: object): value is PutPortalBranding {
46
+ return true;
47
+ }
48
+
49
+ export function PutPortalBrandingFromJSON(json: any): PutPortalBranding {
50
+ return PutPortalBrandingFromJSONTyped(json, false);
51
+ }
52
+
53
+ export function PutPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): PutPortalBranding {
54
+ if (json == null) {
55
+ return json;
56
+ }
57
+ return {
58
+
59
+ 'name': json['name'] == null ? undefined : json['name'],
60
+ 'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
61
+ 'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
62
+ };
63
+ }
64
+
65
+ export function PutPortalBrandingToJSON(json: any): PutPortalBranding {
66
+ return PutPortalBrandingToJSONTyped(json, false);
67
+ }
68
+
69
+ export function PutPortalBrandingToJSONTyped(value?: PutPortalBranding | null, ignoreDiscriminator: boolean = false): any {
70
+ if (value == null) {
71
+ return value;
72
+ }
73
+
74
+ return {
75
+
76
+ 'name': value['name'],
77
+ 'header_background_color': value['headerBackgroundColor'],
78
+ 'header_text_color': value['headerTextColor'],
79
+ };
80
+ }
81
+
@@ -90,6 +90,7 @@ export * from './PostCourse';
90
90
  export * from './PostCourseEnrollment';
91
91
  export * from './PostLogin';
92
92
  export * from './PostModule';
93
+ export * from './PostPortal';
93
94
  export * from './PostPortalInvite';
94
95
  export * from './PostQuestion';
95
96
  export * from './PostQuestionAnswerChoicesInner';
@@ -112,6 +113,7 @@ export * from './PostSendResetPassword';
112
113
  export * from './PutContent';
113
114
  export * from './PutCourse';
114
115
  export * from './PutModule';
116
+ export * from './PutPortalBranding';
115
117
  export * from './PutQuestion';
116
118
  export * from './PutQuestionAnswerChoicesInner';
117
119
  export * from './PutQuiz';