@easyedu/js-lsm-api 1.105.0 → 1.106.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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +6 -3
- package/dist/apis/PortalApi.d.ts +2 -2
- package/dist/apis/PortalApi.js +2 -2
- package/dist/esm/apis/PortalApi.d.ts +2 -2
- package/dist/esm/apis/PortalApi.js +2 -2
- package/dist/esm/models/GetPortal.d.ts +11 -2
- package/dist/esm/models/GetPortal.js +5 -0
- package/dist/esm/models/GetPublicPortalBranding.d.ts +11 -2
- package/dist/esm/models/GetPublicPortalBranding.js +5 -0
- package/dist/esm/models/PortalBrandColorsV1.d.ts +194 -0
- package/dist/esm/models/PortalBrandColorsV1.js +151 -0
- package/dist/esm/models/PortalBrandThemeV1.d.ts +53 -0
- package/dist/esm/models/PortalBrandThemeV1.js +59 -0
- package/dist/esm/models/PortalBrandTypographyV1.d.ts +80 -0
- package/dist/esm/models/PortalBrandTypographyV1.js +78 -0
- package/dist/esm/models/PostPortal.d.ts +9 -0
- package/dist/esm/models/PostPortal.js +3 -0
- package/dist/esm/models/PutPortalBranding.d.ts +9 -0
- package/dist/esm/models/PutPortalBranding.js +3 -0
- package/dist/esm/models/index.d.ts +3 -0
- package/dist/esm/models/index.js +3 -0
- package/dist/models/GetPortal.d.ts +11 -2
- package/dist/models/GetPortal.js +5 -0
- package/dist/models/GetPublicPortalBranding.d.ts +11 -2
- package/dist/models/GetPublicPortalBranding.js +5 -0
- package/dist/models/PortalBrandColorsV1.d.ts +194 -0
- package/dist/models/PortalBrandColorsV1.js +158 -0
- package/dist/models/PortalBrandThemeV1.d.ts +53 -0
- package/dist/models/PortalBrandThemeV1.js +67 -0
- package/dist/models/PortalBrandTypographyV1.d.ts +80 -0
- package/dist/models/PortalBrandTypographyV1.js +86 -0
- package/dist/models/PostPortal.d.ts +9 -0
- package/dist/models/PostPortal.js +3 -0
- package/dist/models/PutPortalBranding.d.ts +9 -0
- package/dist/models/PutPortalBranding.js +3 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/docs/GetPortal.md +2 -0
- package/docs/GetPublicPortalBranding.md +2 -0
- package/docs/PortalApi.md +2 -2
- package/docs/PortalBrandColorsV1.md +89 -0
- package/docs/PortalBrandThemeV1.md +39 -0
- package/docs/PortalBrandTypographyV1.md +47 -0
- package/docs/PostPortal.md +2 -0
- package/docs/PutPortalBranding.md +2 -0
- package/package.json +1 -1
- package/src/apis/PortalApi.ts +2 -2
- package/src/models/GetPortal.ts +21 -2
- package/src/models/GetPublicPortalBranding.ts +21 -2
- package/src/models/PortalBrandColorsV1.ts +309 -0
- package/src/models/PortalBrandThemeV1.ts +109 -0
- package/src/models/PortalBrandTypographyV1.ts +135 -0
- package/src/models/PostPortal.ts +18 -0
- package/src/models/PutPortalBranding.ts +18 -0
- package/src/models/index.ts +3 -0
|
@@ -0,0 +1,158 @@
|
|
|
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.instanceOfPortalBrandColorsV1 = instanceOfPortalBrandColorsV1;
|
|
17
|
+
exports.PortalBrandColorsV1FromJSON = PortalBrandColorsV1FromJSON;
|
|
18
|
+
exports.PortalBrandColorsV1FromJSONTyped = PortalBrandColorsV1FromJSONTyped;
|
|
19
|
+
exports.PortalBrandColorsV1ToJSON = PortalBrandColorsV1ToJSON;
|
|
20
|
+
exports.PortalBrandColorsV1ToJSONTyped = PortalBrandColorsV1ToJSONTyped;
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the PortalBrandColorsV1 interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfPortalBrandColorsV1(value) {
|
|
25
|
+
if (!('headerBackground' in value) || value['headerBackground'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('headerForeground' in value) || value['headerForeground'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
if (!('navigationBackground' in value) || value['navigationBackground'] === undefined)
|
|
30
|
+
return false;
|
|
31
|
+
if (!('navigationForeground' in value) || value['navigationForeground'] === undefined)
|
|
32
|
+
return false;
|
|
33
|
+
if (!('primaryAction' in value) || value['primaryAction'] === undefined)
|
|
34
|
+
return false;
|
|
35
|
+
if (!('onPrimaryAction' in value) || value['onPrimaryAction'] === undefined)
|
|
36
|
+
return false;
|
|
37
|
+
if (!('secondaryAction' in value) || value['secondaryAction'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('onSecondaryAction' in value) || value['onSecondaryAction'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('pageBackground' in value) || value['pageBackground'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('surfaceBackground' in value) || value['surfaceBackground'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('textPrimary' in value) || value['textPrimary'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('textSecondary' in value) || value['textSecondary'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('divider' in value) || value['divider'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
if (!('link' in value) || value['link'] === undefined)
|
|
52
|
+
return false;
|
|
53
|
+
if (!('linkHover' in value) || value['linkHover'] === undefined)
|
|
54
|
+
return false;
|
|
55
|
+
if (!('active' in value) || value['active'] === undefined)
|
|
56
|
+
return false;
|
|
57
|
+
if (!('onActive' in value) || value['onActive'] === undefined)
|
|
58
|
+
return false;
|
|
59
|
+
if (!('focusRing' in value) || value['focusRing'] === undefined)
|
|
60
|
+
return false;
|
|
61
|
+
if (!('progress' in value) || value['progress'] === undefined)
|
|
62
|
+
return false;
|
|
63
|
+
if (!('progressTrack' in value) || value['progressTrack'] === undefined)
|
|
64
|
+
return false;
|
|
65
|
+
if (!('success' in value) || value['success'] === undefined)
|
|
66
|
+
return false;
|
|
67
|
+
if (!('onSuccess' in value) || value['onSuccess'] === undefined)
|
|
68
|
+
return false;
|
|
69
|
+
if (!('warning' in value) || value['warning'] === undefined)
|
|
70
|
+
return false;
|
|
71
|
+
if (!('onWarning' in value) || value['onWarning'] === undefined)
|
|
72
|
+
return false;
|
|
73
|
+
if (!('error' in value) || value['error'] === undefined)
|
|
74
|
+
return false;
|
|
75
|
+
if (!('onError' in value) || value['onError'] === undefined)
|
|
76
|
+
return false;
|
|
77
|
+
if (!('info' in value) || value['info'] === undefined)
|
|
78
|
+
return false;
|
|
79
|
+
if (!('onInfo' in value) || value['onInfo'] === undefined)
|
|
80
|
+
return false;
|
|
81
|
+
return true;
|
|
82
|
+
}
|
|
83
|
+
function PortalBrandColorsV1FromJSON(json) {
|
|
84
|
+
return PortalBrandColorsV1FromJSONTyped(json, false);
|
|
85
|
+
}
|
|
86
|
+
function PortalBrandColorsV1FromJSONTyped(json, ignoreDiscriminator) {
|
|
87
|
+
if (json == null) {
|
|
88
|
+
return json;
|
|
89
|
+
}
|
|
90
|
+
return {
|
|
91
|
+
'headerBackground': json['header_background'],
|
|
92
|
+
'headerForeground': json['header_foreground'],
|
|
93
|
+
'navigationBackground': json['navigation_background'],
|
|
94
|
+
'navigationForeground': json['navigation_foreground'],
|
|
95
|
+
'primaryAction': json['primary_action'],
|
|
96
|
+
'onPrimaryAction': json['on_primary_action'],
|
|
97
|
+
'secondaryAction': json['secondary_action'],
|
|
98
|
+
'onSecondaryAction': json['on_secondary_action'],
|
|
99
|
+
'pageBackground': json['page_background'],
|
|
100
|
+
'surfaceBackground': json['surface_background'],
|
|
101
|
+
'textPrimary': json['text_primary'],
|
|
102
|
+
'textSecondary': json['text_secondary'],
|
|
103
|
+
'divider': json['divider'],
|
|
104
|
+
'link': json['link'],
|
|
105
|
+
'linkHover': json['link_hover'],
|
|
106
|
+
'active': json['active'],
|
|
107
|
+
'onActive': json['on_active'],
|
|
108
|
+
'focusRing': json['focus_ring'],
|
|
109
|
+
'progress': json['progress'],
|
|
110
|
+
'progressTrack': json['progress_track'],
|
|
111
|
+
'success': json['success'],
|
|
112
|
+
'onSuccess': json['on_success'],
|
|
113
|
+
'warning': json['warning'],
|
|
114
|
+
'onWarning': json['on_warning'],
|
|
115
|
+
'error': json['error'],
|
|
116
|
+
'onError': json['on_error'],
|
|
117
|
+
'info': json['info'],
|
|
118
|
+
'onInfo': json['on_info'],
|
|
119
|
+
};
|
|
120
|
+
}
|
|
121
|
+
function PortalBrandColorsV1ToJSON(json) {
|
|
122
|
+
return PortalBrandColorsV1ToJSONTyped(json, false);
|
|
123
|
+
}
|
|
124
|
+
function PortalBrandColorsV1ToJSONTyped(value, ignoreDiscriminator = false) {
|
|
125
|
+
if (value == null) {
|
|
126
|
+
return value;
|
|
127
|
+
}
|
|
128
|
+
return {
|
|
129
|
+
'header_background': value['headerBackground'],
|
|
130
|
+
'header_foreground': value['headerForeground'],
|
|
131
|
+
'navigation_background': value['navigationBackground'],
|
|
132
|
+
'navigation_foreground': value['navigationForeground'],
|
|
133
|
+
'primary_action': value['primaryAction'],
|
|
134
|
+
'on_primary_action': value['onPrimaryAction'],
|
|
135
|
+
'secondary_action': value['secondaryAction'],
|
|
136
|
+
'on_secondary_action': value['onSecondaryAction'],
|
|
137
|
+
'page_background': value['pageBackground'],
|
|
138
|
+
'surface_background': value['surfaceBackground'],
|
|
139
|
+
'text_primary': value['textPrimary'],
|
|
140
|
+
'text_secondary': value['textSecondary'],
|
|
141
|
+
'divider': value['divider'],
|
|
142
|
+
'link': value['link'],
|
|
143
|
+
'link_hover': value['linkHover'],
|
|
144
|
+
'active': value['active'],
|
|
145
|
+
'on_active': value['onActive'],
|
|
146
|
+
'focus_ring': value['focusRing'],
|
|
147
|
+
'progress': value['progress'],
|
|
148
|
+
'progress_track': value['progressTrack'],
|
|
149
|
+
'success': value['success'],
|
|
150
|
+
'on_success': value['onSuccess'],
|
|
151
|
+
'warning': value['warning'],
|
|
152
|
+
'on_warning': value['onWarning'],
|
|
153
|
+
'error': value['error'],
|
|
154
|
+
'on_error': value['onError'],
|
|
155
|
+
'info': value['info'],
|
|
156
|
+
'on_info': value['onInfo'],
|
|
157
|
+
};
|
|
158
|
+
}
|
|
@@ -0,0 +1,53 @@
|
|
|
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
|
+
import type { PortalBrandColorsV1 } from './PortalBrandColorsV1';
|
|
13
|
+
import type { PortalBrandTypographyV1 } from './PortalBrandTypographyV1';
|
|
14
|
+
/**
|
|
15
|
+
* Complete version 1 portal application theme. Updates replace this object as a whole.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface PortalBrandThemeV1
|
|
18
|
+
*/
|
|
19
|
+
export interface PortalBrandThemeV1 {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {PortalBrandThemeV1SchemaVersionEnum}
|
|
23
|
+
* @memberof PortalBrandThemeV1
|
|
24
|
+
*/
|
|
25
|
+
schemaVersion: PortalBrandThemeV1SchemaVersionEnum;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {PortalBrandTypographyV1}
|
|
29
|
+
* @memberof PortalBrandThemeV1
|
|
30
|
+
*/
|
|
31
|
+
typography: PortalBrandTypographyV1;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {PortalBrandColorsV1}
|
|
35
|
+
* @memberof PortalBrandThemeV1
|
|
36
|
+
*/
|
|
37
|
+
colors: PortalBrandColorsV1;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* @export
|
|
41
|
+
*/
|
|
42
|
+
export declare const PortalBrandThemeV1SchemaVersionEnum: {
|
|
43
|
+
readonly V1: "v1";
|
|
44
|
+
};
|
|
45
|
+
export type PortalBrandThemeV1SchemaVersionEnum = typeof PortalBrandThemeV1SchemaVersionEnum[keyof typeof PortalBrandThemeV1SchemaVersionEnum];
|
|
46
|
+
/**
|
|
47
|
+
* Check if a given object implements the PortalBrandThemeV1 interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfPortalBrandThemeV1(value: object): value is PortalBrandThemeV1;
|
|
50
|
+
export declare function PortalBrandThemeV1FromJSON(json: any): PortalBrandThemeV1;
|
|
51
|
+
export declare function PortalBrandThemeV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandThemeV1;
|
|
52
|
+
export declare function PortalBrandThemeV1ToJSON(json: any): PortalBrandThemeV1;
|
|
53
|
+
export declare function PortalBrandThemeV1ToJSONTyped(value?: PortalBrandThemeV1 | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,67 @@
|
|
|
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.PortalBrandThemeV1SchemaVersionEnum = void 0;
|
|
17
|
+
exports.instanceOfPortalBrandThemeV1 = instanceOfPortalBrandThemeV1;
|
|
18
|
+
exports.PortalBrandThemeV1FromJSON = PortalBrandThemeV1FromJSON;
|
|
19
|
+
exports.PortalBrandThemeV1FromJSONTyped = PortalBrandThemeV1FromJSONTyped;
|
|
20
|
+
exports.PortalBrandThemeV1ToJSON = PortalBrandThemeV1ToJSON;
|
|
21
|
+
exports.PortalBrandThemeV1ToJSONTyped = PortalBrandThemeV1ToJSONTyped;
|
|
22
|
+
const PortalBrandColorsV1_1 = require("./PortalBrandColorsV1");
|
|
23
|
+
const PortalBrandTypographyV1_1 = require("./PortalBrandTypographyV1");
|
|
24
|
+
/**
|
|
25
|
+
* @export
|
|
26
|
+
*/
|
|
27
|
+
exports.PortalBrandThemeV1SchemaVersionEnum = {
|
|
28
|
+
V1: 'v1'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Check if a given object implements the PortalBrandThemeV1 interface.
|
|
32
|
+
*/
|
|
33
|
+
function instanceOfPortalBrandThemeV1(value) {
|
|
34
|
+
if (!('schemaVersion' in value) || value['schemaVersion'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('typography' in value) || value['typography'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('colors' in value) || value['colors'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
return true;
|
|
41
|
+
}
|
|
42
|
+
function PortalBrandThemeV1FromJSON(json) {
|
|
43
|
+
return PortalBrandThemeV1FromJSONTyped(json, false);
|
|
44
|
+
}
|
|
45
|
+
function PortalBrandThemeV1FromJSONTyped(json, ignoreDiscriminator) {
|
|
46
|
+
if (json == null) {
|
|
47
|
+
return json;
|
|
48
|
+
}
|
|
49
|
+
return {
|
|
50
|
+
'schemaVersion': json['schema_version'],
|
|
51
|
+
'typography': (0, PortalBrandTypographyV1_1.PortalBrandTypographyV1FromJSON)(json['typography']),
|
|
52
|
+
'colors': (0, PortalBrandColorsV1_1.PortalBrandColorsV1FromJSON)(json['colors']),
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
function PortalBrandThemeV1ToJSON(json) {
|
|
56
|
+
return PortalBrandThemeV1ToJSONTyped(json, false);
|
|
57
|
+
}
|
|
58
|
+
function PortalBrandThemeV1ToJSONTyped(value, ignoreDiscriminator = false) {
|
|
59
|
+
if (value == null) {
|
|
60
|
+
return value;
|
|
61
|
+
}
|
|
62
|
+
return {
|
|
63
|
+
'schema_version': value['schemaVersion'],
|
|
64
|
+
'typography': (0, PortalBrandTypographyV1_1.PortalBrandTypographyV1ToJSON)(value['typography']),
|
|
65
|
+
'colors': (0, PortalBrandColorsV1_1.PortalBrandColorsV1ToJSON)(value['colors']),
|
|
66
|
+
};
|
|
67
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
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
|
+
* Typography settings for a portal-owned light application theme.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface PortalBrandTypographyV1
|
|
16
|
+
*/
|
|
17
|
+
export interface PortalBrandTypographyV1 {
|
|
18
|
+
/**
|
|
19
|
+
* Curated application font family. Values map to bundled frontend fonts.
|
|
20
|
+
* @type {PortalBrandTypographyV1FontFamilyEnum}
|
|
21
|
+
* @memberof PortalBrandTypographyV1
|
|
22
|
+
*/
|
|
23
|
+
fontFamily: PortalBrandTypographyV1FontFamilyEnum;
|
|
24
|
+
/**
|
|
25
|
+
* Base application font size in CSS pixels.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof PortalBrandTypographyV1
|
|
28
|
+
*/
|
|
29
|
+
baseFontSizePx: number;
|
|
30
|
+
/**
|
|
31
|
+
* Regular text weight. Supported values are 300 through 800 in increments of 100.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof PortalBrandTypographyV1
|
|
34
|
+
*/
|
|
35
|
+
fontWeightRegular: number;
|
|
36
|
+
/**
|
|
37
|
+
* Emphasized text weight. Supported values are 300 through 800 in increments of 100.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof PortalBrandTypographyV1
|
|
40
|
+
*/
|
|
41
|
+
fontWeightMedium: number;
|
|
42
|
+
/**
|
|
43
|
+
* Heading and bold text weight. Supported values are 300 through 800 in increments of 100.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof PortalBrandTypographyV1
|
|
46
|
+
*/
|
|
47
|
+
fontWeightBold: number;
|
|
48
|
+
/**
|
|
49
|
+
* Unitless line-height multiplier for normal application text.
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof PortalBrandTypographyV1
|
|
52
|
+
*/
|
|
53
|
+
lineHeight: number;
|
|
54
|
+
/**
|
|
55
|
+
* Letter spacing for normal application text, in em units.
|
|
56
|
+
* @type {number}
|
|
57
|
+
* @memberof PortalBrandTypographyV1
|
|
58
|
+
*/
|
|
59
|
+
letterSpacingEm: number;
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* @export
|
|
63
|
+
*/
|
|
64
|
+
export declare const PortalBrandTypographyV1FontFamilyEnum: {
|
|
65
|
+
readonly Inter: "Inter";
|
|
66
|
+
readonly Roboto: "Roboto";
|
|
67
|
+
readonly OpenSans: "Open Sans";
|
|
68
|
+
readonly Montserrat: "Montserrat";
|
|
69
|
+
readonly SourceSans3: "Source Sans 3";
|
|
70
|
+
readonly NunitoSans: "Nunito Sans";
|
|
71
|
+
};
|
|
72
|
+
export type PortalBrandTypographyV1FontFamilyEnum = typeof PortalBrandTypographyV1FontFamilyEnum[keyof typeof PortalBrandTypographyV1FontFamilyEnum];
|
|
73
|
+
/**
|
|
74
|
+
* Check if a given object implements the PortalBrandTypographyV1 interface.
|
|
75
|
+
*/
|
|
76
|
+
export declare function instanceOfPortalBrandTypographyV1(value: object): value is PortalBrandTypographyV1;
|
|
77
|
+
export declare function PortalBrandTypographyV1FromJSON(json: any): PortalBrandTypographyV1;
|
|
78
|
+
export declare function PortalBrandTypographyV1FromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalBrandTypographyV1;
|
|
79
|
+
export declare function PortalBrandTypographyV1ToJSON(json: any): PortalBrandTypographyV1;
|
|
80
|
+
export declare function PortalBrandTypographyV1ToJSONTyped(value?: PortalBrandTypographyV1 | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,86 @@
|
|
|
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.PortalBrandTypographyV1FontFamilyEnum = void 0;
|
|
17
|
+
exports.instanceOfPortalBrandTypographyV1 = instanceOfPortalBrandTypographyV1;
|
|
18
|
+
exports.PortalBrandTypographyV1FromJSON = PortalBrandTypographyV1FromJSON;
|
|
19
|
+
exports.PortalBrandTypographyV1FromJSONTyped = PortalBrandTypographyV1FromJSONTyped;
|
|
20
|
+
exports.PortalBrandTypographyV1ToJSON = PortalBrandTypographyV1ToJSON;
|
|
21
|
+
exports.PortalBrandTypographyV1ToJSONTyped = PortalBrandTypographyV1ToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.PortalBrandTypographyV1FontFamilyEnum = {
|
|
26
|
+
Inter: 'Inter',
|
|
27
|
+
Roboto: 'Roboto',
|
|
28
|
+
OpenSans: 'Open Sans',
|
|
29
|
+
Montserrat: 'Montserrat',
|
|
30
|
+
SourceSans3: 'Source Sans 3',
|
|
31
|
+
NunitoSans: 'Nunito Sans'
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the PortalBrandTypographyV1 interface.
|
|
35
|
+
*/
|
|
36
|
+
function instanceOfPortalBrandTypographyV1(value) {
|
|
37
|
+
if (!('fontFamily' in value) || value['fontFamily'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
if (!('baseFontSizePx' in value) || value['baseFontSizePx'] === undefined)
|
|
40
|
+
return false;
|
|
41
|
+
if (!('fontWeightRegular' in value) || value['fontWeightRegular'] === undefined)
|
|
42
|
+
return false;
|
|
43
|
+
if (!('fontWeightMedium' in value) || value['fontWeightMedium'] === undefined)
|
|
44
|
+
return false;
|
|
45
|
+
if (!('fontWeightBold' in value) || value['fontWeightBold'] === undefined)
|
|
46
|
+
return false;
|
|
47
|
+
if (!('lineHeight' in value) || value['lineHeight'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
if (!('letterSpacingEm' in value) || value['letterSpacingEm'] === undefined)
|
|
50
|
+
return false;
|
|
51
|
+
return true;
|
|
52
|
+
}
|
|
53
|
+
function PortalBrandTypographyV1FromJSON(json) {
|
|
54
|
+
return PortalBrandTypographyV1FromJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
function PortalBrandTypographyV1FromJSONTyped(json, ignoreDiscriminator) {
|
|
57
|
+
if (json == null) {
|
|
58
|
+
return json;
|
|
59
|
+
}
|
|
60
|
+
return {
|
|
61
|
+
'fontFamily': json['font_family'],
|
|
62
|
+
'baseFontSizePx': json['base_font_size_px'],
|
|
63
|
+
'fontWeightRegular': json['font_weight_regular'],
|
|
64
|
+
'fontWeightMedium': json['font_weight_medium'],
|
|
65
|
+
'fontWeightBold': json['font_weight_bold'],
|
|
66
|
+
'lineHeight': json['line_height'],
|
|
67
|
+
'letterSpacingEm': json['letter_spacing_em'],
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
function PortalBrandTypographyV1ToJSON(json) {
|
|
71
|
+
return PortalBrandTypographyV1ToJSONTyped(json, false);
|
|
72
|
+
}
|
|
73
|
+
function PortalBrandTypographyV1ToJSONTyped(value, ignoreDiscriminator = false) {
|
|
74
|
+
if (value == null) {
|
|
75
|
+
return value;
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
'font_family': value['fontFamily'],
|
|
79
|
+
'base_font_size_px': value['baseFontSizePx'],
|
|
80
|
+
'font_weight_regular': value['fontWeightRegular'],
|
|
81
|
+
'font_weight_medium': value['fontWeightMedium'],
|
|
82
|
+
'font_weight_bold': value['fontWeightBold'],
|
|
83
|
+
'line_height': value['lineHeight'],
|
|
84
|
+
'letter_spacing_em': value['letterSpacingEm'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -25,14 +26,22 @@ export interface PostPortal {
|
|
|
25
26
|
* Hex color value for portal background (e.g.,
|
|
26
27
|
* @type {string}
|
|
27
28
|
* @memberof PostPortal
|
|
29
|
+
* @deprecated
|
|
28
30
|
*/
|
|
29
31
|
headerBackgroundColor?: string;
|
|
30
32
|
/**
|
|
31
33
|
* Hex color value for portal text (e.g.,
|
|
32
34
|
* @type {string}
|
|
33
35
|
* @memberof PostPortal
|
|
36
|
+
* @deprecated
|
|
34
37
|
*/
|
|
35
38
|
headerTextColor?: string;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {PortalBrandThemeV1}
|
|
42
|
+
* @memberof PostPortal
|
|
43
|
+
*/
|
|
44
|
+
brandingTheme?: PortalBrandThemeV1;
|
|
36
45
|
/**
|
|
37
46
|
* Platform subdomain slug used for '{slug}.edaxu.com'
|
|
38
47
|
* @type {string}
|
|
@@ -18,6 +18,7 @@ exports.PostPortalFromJSON = PostPortalFromJSON;
|
|
|
18
18
|
exports.PostPortalFromJSONTyped = PostPortalFromJSONTyped;
|
|
19
19
|
exports.PostPortalToJSON = PostPortalToJSON;
|
|
20
20
|
exports.PostPortalToJSONTyped = PostPortalToJSONTyped;
|
|
21
|
+
const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the PostPortal interface.
|
|
23
24
|
*/
|
|
@@ -37,6 +38,7 @@ function PostPortalFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
37
38
|
'name': json['name'],
|
|
38
39
|
'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
|
|
39
40
|
'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
|
|
41
|
+
'brandingTheme': json['branding_theme'] == null ? undefined : (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
|
|
40
42
|
'slug': json['slug'] == null ? undefined : json['slug'],
|
|
41
43
|
'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
|
|
42
44
|
};
|
|
@@ -52,6 +54,7 @@ function PostPortalToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
52
54
|
'name': value['name'],
|
|
53
55
|
'header_background_color': value['headerBackgroundColor'],
|
|
54
56
|
'header_text_color': value['headerTextColor'],
|
|
57
|
+
'branding_theme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1ToJSON)(value['brandingTheme']),
|
|
55
58
|
'slug': value['slug'],
|
|
56
59
|
'client_domain': value['clientDomain'],
|
|
57
60
|
};
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { PortalBrandThemeV1 } from './PortalBrandThemeV1';
|
|
12
13
|
/**
|
|
13
14
|
*
|
|
14
15
|
* @export
|
|
@@ -25,14 +26,22 @@ export interface PutPortalBranding {
|
|
|
25
26
|
* Hex color value for portal background (e.g.,
|
|
26
27
|
* @type {string}
|
|
27
28
|
* @memberof PutPortalBranding
|
|
29
|
+
* @deprecated
|
|
28
30
|
*/
|
|
29
31
|
headerBackgroundColor?: string;
|
|
30
32
|
/**
|
|
31
33
|
* Hex color value for portal text (e.g.,
|
|
32
34
|
* @type {string}
|
|
33
35
|
* @memberof PutPortalBranding
|
|
36
|
+
* @deprecated
|
|
34
37
|
*/
|
|
35
38
|
headerTextColor?: string;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {PortalBrandThemeV1}
|
|
42
|
+
* @memberof PutPortalBranding
|
|
43
|
+
*/
|
|
44
|
+
brandingTheme?: PortalBrandThemeV1;
|
|
36
45
|
/**
|
|
37
46
|
* Platform subdomain slug used for '{slug}.edaxu.com'. Set null to inherit from an ancestor.
|
|
38
47
|
* @type {string}
|
|
@@ -18,6 +18,7 @@ exports.PutPortalBrandingFromJSON = PutPortalBrandingFromJSON;
|
|
|
18
18
|
exports.PutPortalBrandingFromJSONTyped = PutPortalBrandingFromJSONTyped;
|
|
19
19
|
exports.PutPortalBrandingToJSON = PutPortalBrandingToJSON;
|
|
20
20
|
exports.PutPortalBrandingToJSONTyped = PutPortalBrandingToJSONTyped;
|
|
21
|
+
const PortalBrandThemeV1_1 = require("./PortalBrandThemeV1");
|
|
21
22
|
/**
|
|
22
23
|
* Check if a given object implements the PutPortalBranding interface.
|
|
23
24
|
*/
|
|
@@ -35,6 +36,7 @@ function PutPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
36
|
'name': json['name'] == null ? undefined : json['name'],
|
|
36
37
|
'headerBackgroundColor': json['header_background_color'] == null ? undefined : json['header_background_color'],
|
|
37
38
|
'headerTextColor': json['header_text_color'] == null ? undefined : json['header_text_color'],
|
|
39
|
+
'brandingTheme': json['branding_theme'] == null ? undefined : (0, PortalBrandThemeV1_1.PortalBrandThemeV1FromJSON)(json['branding_theme']),
|
|
38
40
|
'slug': json['slug'] == null ? undefined : json['slug'],
|
|
39
41
|
'clientDomain': json['client_domain'] == null ? undefined : json['client_domain'],
|
|
40
42
|
};
|
|
@@ -50,6 +52,7 @@ function PutPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
50
52
|
'name': value['name'],
|
|
51
53
|
'header_background_color': value['headerBackgroundColor'],
|
|
52
54
|
'header_text_color': value['headerTextColor'],
|
|
55
|
+
'branding_theme': (0, PortalBrandThemeV1_1.PortalBrandThemeV1ToJSON)(value['brandingTheme']),
|
|
53
56
|
'slug': value['slug'],
|
|
54
57
|
'client_domain': value['clientDomain'],
|
|
55
58
|
};
|
package/dist/models/index.d.ts
CHANGED
|
@@ -157,6 +157,9 @@ export * from './LoginResAuthData';
|
|
|
157
157
|
export * from './LoginResUserData';
|
|
158
158
|
export * from './LoginResUserDataSelectedPortal';
|
|
159
159
|
export * from './Paginated';
|
|
160
|
+
export * from './PortalBrandColorsV1';
|
|
161
|
+
export * from './PortalBrandThemeV1';
|
|
162
|
+
export * from './PortalBrandTypographyV1';
|
|
160
163
|
export * from './PortalSublicense';
|
|
161
164
|
export * from './PortalUserFieldConfig';
|
|
162
165
|
export * from './PortalUserFieldDefinition';
|
package/dist/models/index.js
CHANGED
|
@@ -175,6 +175,9 @@ __exportStar(require("./LoginResAuthData"), exports);
|
|
|
175
175
|
__exportStar(require("./LoginResUserData"), exports);
|
|
176
176
|
__exportStar(require("./LoginResUserDataSelectedPortal"), exports);
|
|
177
177
|
__exportStar(require("./Paginated"), exports);
|
|
178
|
+
__exportStar(require("./PortalBrandColorsV1"), exports);
|
|
179
|
+
__exportStar(require("./PortalBrandThemeV1"), exports);
|
|
180
|
+
__exportStar(require("./PortalBrandTypographyV1"), exports);
|
|
178
181
|
__exportStar(require("./PortalSublicense"), exports);
|
|
179
182
|
__exportStar(require("./PortalUserFieldConfig"), exports);
|
|
180
183
|
__exportStar(require("./PortalUserFieldDefinition"), exports);
|
package/docs/GetPortal.md
CHANGED
|
@@ -15,6 +15,7 @@ Name | Type
|
|
|
15
15
|
`faviconUrl` | string
|
|
16
16
|
`headerBackgroundColor` | string
|
|
17
17
|
`headerTextColor` | string
|
|
18
|
+
`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
|
|
18
19
|
`baseType` | string
|
|
19
20
|
|
|
20
21
|
## Example
|
|
@@ -33,6 +34,7 @@ const example = {
|
|
|
33
34
|
"faviconUrl": null,
|
|
34
35
|
"headerBackgroundColor": null,
|
|
35
36
|
"headerTextColor": null,
|
|
37
|
+
"brandingTheme": null,
|
|
36
38
|
"baseType": null,
|
|
37
39
|
} satisfies GetPortal
|
|
38
40
|
|
|
@@ -14,6 +14,7 @@ Name | Type
|
|
|
14
14
|
`faviconUrl` | string
|
|
15
15
|
`headerBackgroundColor` | string
|
|
16
16
|
`headerTextColor` | string
|
|
17
|
+
`brandingTheme` | [PortalBrandThemeV1](PortalBrandThemeV1.md)
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"faviconUrl": null,
|
|
30
31
|
"headerBackgroundColor": null,
|
|
31
32
|
"headerTextColor": null,
|
|
33
|
+
"brandingTheme": null,
|
|
32
34
|
} satisfies GetPublicPortalBranding
|
|
33
35
|
|
|
34
36
|
console.log(example)
|
package/docs/PortalApi.md
CHANGED
|
@@ -20,7 +20,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
|
|
|
20
20
|
| [**postPortal**](PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal |
|
|
21
21
|
| [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
|
|
22
22
|
| [**postPortalLogoUpload**](PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding |
|
|
23
|
-
| [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding
|
|
23
|
+
| [**putPortalBranding**](PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding and complete application theme |
|
|
24
24
|
| [**putPortalUserFieldConfig**](PortalApi.md#putportaluserfieldconfig) | **PUT** /portals/{portalId}/user-field-config | Replace portal user field configuration |
|
|
25
25
|
| [**putPortalUserFieldValues**](PortalApi.md#putportaluserfieldvalues) | **PUT** /portals/{portalId}/users/{userId}/user-field-values | Bulk upsert a user\'s portal field values |
|
|
26
26
|
| [**removePortalUser**](PortalApi.md#removeportaluser) | **DELETE** /portals/{portalId}/users/{userId} | Remove a user from a portal |
|
|
@@ -1096,7 +1096,7 @@ No authorization required
|
|
|
1096
1096
|
|
|
1097
1097
|
> GetPortal putPortalBranding(portalId, putPortalBranding)
|
|
1098
1098
|
|
|
1099
|
-
Update portal branding
|
|
1099
|
+
Update portal branding and complete application theme
|
|
1100
1100
|
|
|
1101
1101
|
### Example
|
|
1102
1102
|
|