@easyedu/js-lsm-api 1.59.0 → 1.61.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.
Files changed (32) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +5 -2
  3. package/dist/apis/PortalApi.d.ts +15 -0
  4. package/dist/apis/PortalApi.js +38 -0
  5. package/dist/esm/apis/PortalApi.d.ts +15 -0
  6. package/dist/esm/apis/PortalApi.js +38 -0
  7. package/dist/esm/models/GetPublicPortalBranding.d.ts +68 -0
  8. package/dist/esm/models/GetPublicPortalBranding.js +67 -0
  9. package/dist/esm/models/UpdateSelectedPortalResponse.d.ts +7 -0
  10. package/dist/esm/models/UpdateSelectedPortalResponse.js +5 -0
  11. package/dist/esm/models/UpdateSelectedPortalResponseHostPortal.d.ts +44 -0
  12. package/dist/esm/models/UpdateSelectedPortalResponseHostPortal.js +51 -0
  13. package/dist/esm/models/index.d.ts +2 -0
  14. package/dist/esm/models/index.js +2 -0
  15. package/dist/models/GetPublicPortalBranding.d.ts +68 -0
  16. package/dist/models/GetPublicPortalBranding.js +74 -0
  17. package/dist/models/UpdateSelectedPortalResponse.d.ts +7 -0
  18. package/dist/models/UpdateSelectedPortalResponse.js +5 -0
  19. package/dist/models/UpdateSelectedPortalResponseHostPortal.d.ts +44 -0
  20. package/dist/models/UpdateSelectedPortalResponseHostPortal.js +58 -0
  21. package/dist/models/index.d.ts +2 -0
  22. package/dist/models/index.js +2 -0
  23. package/docs/GetPublicPortalBranding.md +47 -0
  24. package/docs/PortalApi.md +62 -0
  25. package/docs/UpdateSelectedPortalResponse.md +2 -0
  26. package/docs/UpdateSelectedPortalResponseHostPortal.md +39 -0
  27. package/package.json +1 -1
  28. package/src/apis/PortalApi.ts +44 -0
  29. package/src/models/GetPublicPortalBranding.ts +120 -0
  30. package/src/models/UpdateSelectedPortalResponse.ts +16 -0
  31. package/src/models/UpdateSelectedPortalResponseHostPortal.ts +84 -0
  32. package/src/models/index.ts +2 -0
@@ -88,6 +88,7 @@ docs/GetPortalStudentReportingCertificates.md
88
88
  docs/GetPortalStudentReportingPortalInfo.md
89
89
  docs/GetPortalUser.md
90
90
  docs/GetPortalUserList.md
91
+ docs/GetPublicPortalBranding.md
91
92
  docs/GetQuestion.md
92
93
  docs/GetQuestionAnswerChoicesInner.md
93
94
  docs/GetQuestionList.md
@@ -273,6 +274,7 @@ docs/SingleAnswer.md
273
274
  docs/SupportTicketApi.md
274
275
  docs/SupportTicketUser.md
275
276
  docs/UpdateSelectedPortalResponse.md
277
+ docs/UpdateSelectedPortalResponseHostPortal.md
276
278
  docs/UpdateSelectedPortalResponseSelectedPortal.md
277
279
  docs/UserApi.md
278
280
  package.json
@@ -374,6 +376,7 @@ src/models/GetPortalStudentReportingCertificates.ts
374
376
  src/models/GetPortalStudentReportingPortalInfo.ts
375
377
  src/models/GetPortalUser.ts
376
378
  src/models/GetPortalUserList.ts
379
+ src/models/GetPublicPortalBranding.ts
377
380
  src/models/GetQuestion.ts
378
381
  src/models/GetQuestionAnswerChoicesInner.ts
379
382
  src/models/GetQuestionList.ts
@@ -550,6 +553,7 @@ src/models/ShortAnswer1.ts
550
553
  src/models/SingleAnswer.ts
551
554
  src/models/SupportTicketUser.ts
552
555
  src/models/UpdateSelectedPortalResponse.ts
556
+ src/models/UpdateSelectedPortalResponseHostPortal.ts
553
557
  src/models/UpdateSelectedPortalResponseSelectedPortal.ts
554
558
  src/models/index.ts
555
559
  src/runtime.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.59.0
1
+ # @easyedu/js-lsm-api@1.61.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -136,6 +136,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
136
136
  *PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
137
137
  *PortalApi* | [**getPortalList**](docs/PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to
138
138
  *PortalApi* | [**getPortalUsers**](docs/PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering
139
+ *PortalApi* | [**getPublicPortalBranding**](docs/PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host
139
140
  *PortalApi* | [**inviteUserToPortal**](docs/PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal
140
141
  *PortalApi* | [**postPortal**](docs/PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal
141
142
  *PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
@@ -296,6 +297,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
296
297
  - [GetPortalStudentReportingPortalInfo](docs/GetPortalStudentReportingPortalInfo.md)
297
298
  - [GetPortalUser](docs/GetPortalUser.md)
298
299
  - [GetPortalUserList](docs/GetPortalUserList.md)
300
+ - [GetPublicPortalBranding](docs/GetPublicPortalBranding.md)
299
301
  - [GetQuestion](docs/GetQuestion.md)
300
302
  - [GetQuestionAnswerChoicesInner](docs/GetQuestionAnswerChoicesInner.md)
301
303
  - [GetQuestionList](docs/GetQuestionList.md)
@@ -472,6 +474,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
472
474
  - [SingleAnswer](docs/SingleAnswer.md)
473
475
  - [SupportTicketUser](docs/SupportTicketUser.md)
474
476
  - [UpdateSelectedPortalResponse](docs/UpdateSelectedPortalResponse.md)
477
+ - [UpdateSelectedPortalResponseHostPortal](docs/UpdateSelectedPortalResponseHostPortal.md)
475
478
  - [UpdateSelectedPortalResponseSelectedPortal](docs/UpdateSelectedPortalResponseSelectedPortal.md)
476
479
 
477
480
  ### Authorization
@@ -486,7 +489,7 @@ and is automatically generated by the
486
489
  [OpenAPI Generator](https://openapi-generator.tech) project:
487
490
 
488
491
  - API version: `1.0.0`
489
- - Package version: `1.59.0`
492
+ - Package version: `1.61.0`
490
493
  - Generator version: `7.22.0`
491
494
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
492
495
 
@@ -15,6 +15,7 @@ import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
15
15
  import { type GetPortalList } from '../models/GetPortalList';
16
16
  import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
17
17
  import { type GetPortalUserList } from '../models/GetPortalUserList';
18
+ import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
18
19
  import { type PostPortal } from '../models/PostPortal';
19
20
  import { type PostPortalInvite } from '../models/PostPortalInvite';
20
21
  import { type PutPortalBranding } from '../models/PutPortalBranding';
@@ -122,6 +123,20 @@ export declare class PortalApi extends runtime.BaseAPI {
122
123
  * Get all users for a portal with optional role filtering
123
124
  */
124
125
  getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
126
+ /**
127
+ * Creates request options for getPublicPortalBranding without sending the request
128
+ */
129
+ getPublicPortalBrandingRequestOpts(): Promise<runtime.RequestOpts>;
130
+ /**
131
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
132
+ * Public portal branding resolved from the request host
133
+ */
134
+ getPublicPortalBrandingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicPortalBranding>>;
135
+ /**
136
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
137
+ * Public portal branding resolved from the request host
138
+ */
139
+ getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding>;
125
140
  /**
126
141
  * Creates request options for inviteUserToPortal without sending the request
127
142
  */
@@ -29,6 +29,7 @@ const GetPortalFaviconUpload_1 = require("../models/GetPortalFaviconUpload");
29
29
  const GetPortalList_1 = require("../models/GetPortalList");
30
30
  const GetPortalLogoUpload_1 = require("../models/GetPortalLogoUpload");
31
31
  const GetPortalUserList_1 = require("../models/GetPortalUserList");
32
+ const GetPublicPortalBranding_1 = require("../models/GetPublicPortalBranding");
32
33
  const PostPortal_1 = require("../models/PostPortal");
33
34
  const PostPortalInvite_1 = require("../models/PostPortalInvite");
34
35
  const PutPortalBranding_1 = require("../models/PutPortalBranding");
@@ -241,6 +242,43 @@ class PortalApi extends runtime.BaseAPI {
241
242
  return yield response.value();
242
243
  });
243
244
  }
245
+ /**
246
+ * Creates request options for getPublicPortalBranding without sending the request
247
+ */
248
+ getPublicPortalBrandingRequestOpts() {
249
+ return __awaiter(this, void 0, void 0, function* () {
250
+ const queryParameters = {};
251
+ const headerParameters = {};
252
+ let urlPath = `/public/portal/branding`;
253
+ return {
254
+ path: urlPath,
255
+ method: 'GET',
256
+ headers: headerParameters,
257
+ query: queryParameters,
258
+ };
259
+ });
260
+ }
261
+ /**
262
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
263
+ * Public portal branding resolved from the request host
264
+ */
265
+ getPublicPortalBrandingRaw(initOverrides) {
266
+ return __awaiter(this, void 0, void 0, function* () {
267
+ const requestOptions = yield this.getPublicPortalBrandingRequestOpts();
268
+ const response = yield this.request(requestOptions, initOverrides);
269
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPublicPortalBranding_1.GetPublicPortalBrandingFromJSON)(jsonValue));
270
+ });
271
+ }
272
+ /**
273
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
274
+ * Public portal branding resolved from the request host
275
+ */
276
+ getPublicPortalBranding(initOverrides) {
277
+ return __awaiter(this, void 0, void 0, function* () {
278
+ const response = yield this.getPublicPortalBrandingRaw(initOverrides);
279
+ return yield response.value();
280
+ });
281
+ }
244
282
  /**
245
283
  * Creates request options for inviteUserToPortal without sending the request
246
284
  */
@@ -15,6 +15,7 @@ import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
15
15
  import { type GetPortalList } from '../models/GetPortalList';
16
16
  import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
17
17
  import { type GetPortalUserList } from '../models/GetPortalUserList';
18
+ import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
18
19
  import { type PostPortal } from '../models/PostPortal';
19
20
  import { type PostPortalInvite } from '../models/PostPortalInvite';
20
21
  import { type PutPortalBranding } from '../models/PutPortalBranding';
@@ -122,6 +123,20 @@ export declare class PortalApi extends runtime.BaseAPI {
122
123
  * Get all users for a portal with optional role filtering
123
124
  */
124
125
  getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
126
+ /**
127
+ * Creates request options for getPublicPortalBranding without sending the request
128
+ */
129
+ getPublicPortalBrandingRequestOpts(): Promise<runtime.RequestOpts>;
130
+ /**
131
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
132
+ * Public portal branding resolved from the request host
133
+ */
134
+ getPublicPortalBrandingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicPortalBranding>>;
135
+ /**
136
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
137
+ * Public portal branding resolved from the request host
138
+ */
139
+ getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding>;
125
140
  /**
126
141
  * Creates request options for inviteUserToPortal without sending the request
127
142
  */
@@ -26,6 +26,7 @@ import { GetPortalFaviconUploadFromJSON, } from '../models/GetPortalFaviconUploa
26
26
  import { GetPortalListFromJSON, } from '../models/GetPortalList';
27
27
  import { GetPortalLogoUploadFromJSON, } from '../models/GetPortalLogoUpload';
28
28
  import { GetPortalUserListFromJSON, } from '../models/GetPortalUserList';
29
+ import { GetPublicPortalBrandingFromJSON, } from '../models/GetPublicPortalBranding';
29
30
  import { PostPortalToJSON, } from '../models/PostPortal';
30
31
  import { PostPortalInviteToJSON, } from '../models/PostPortalInvite';
31
32
  import { PutPortalBrandingToJSON, } from '../models/PutPortalBranding';
@@ -238,6 +239,43 @@ export class PortalApi extends runtime.BaseAPI {
238
239
  return yield response.value();
239
240
  });
240
241
  }
242
+ /**
243
+ * Creates request options for getPublicPortalBranding without sending the request
244
+ */
245
+ getPublicPortalBrandingRequestOpts() {
246
+ return __awaiter(this, void 0, void 0, function* () {
247
+ const queryParameters = {};
248
+ const headerParameters = {};
249
+ let urlPath = `/public/portal/branding`;
250
+ return {
251
+ path: urlPath,
252
+ method: 'GET',
253
+ headers: headerParameters,
254
+ query: queryParameters,
255
+ };
256
+ });
257
+ }
258
+ /**
259
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
260
+ * Public portal branding resolved from the request host
261
+ */
262
+ getPublicPortalBrandingRaw(initOverrides) {
263
+ return __awaiter(this, void 0, void 0, function* () {
264
+ const requestOptions = yield this.getPublicPortalBrandingRequestOpts();
265
+ const response = yield this.request(requestOptions, initOverrides);
266
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetPublicPortalBrandingFromJSON(jsonValue));
267
+ });
268
+ }
269
+ /**
270
+ * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
271
+ * Public portal branding resolved from the request host
272
+ */
273
+ getPublicPortalBranding(initOverrides) {
274
+ return __awaiter(this, void 0, void 0, function* () {
275
+ const response = yield this.getPublicPortalBrandingRaw(initOverrides);
276
+ return yield response.value();
277
+ });
278
+ }
241
279
  /**
242
280
  * Creates request options for inviteUserToPortal without sending the request
243
281
  */
@@ -0,0 +1,68 @@
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
+ * Public portal branding resolved from the browser host.
14
+ * @export
15
+ * @interface GetPublicPortalBranding
16
+ */
17
+ export interface GetPublicPortalBranding {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetPublicPortalBranding
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GetPublicPortalBranding
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GetPublicPortalBranding
34
+ */
35
+ slug: string | null;
36
+ /**
37
+ * Presigned portal logo URL when a logo is configured.
38
+ * @type {string}
39
+ * @memberof GetPublicPortalBranding
40
+ */
41
+ logoUrl: string | null;
42
+ /**
43
+ * Presigned portal favicon URL when a favicon is configured.
44
+ * @type {string}
45
+ * @memberof GetPublicPortalBranding
46
+ */
47
+ faviconUrl: string | null;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof GetPublicPortalBranding
52
+ */
53
+ headerBackgroundColor: string;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof GetPublicPortalBranding
58
+ */
59
+ headerTextColor: string;
60
+ }
61
+ /**
62
+ * Check if a given object implements the GetPublicPortalBranding interface.
63
+ */
64
+ export declare function instanceOfGetPublicPortalBranding(value: object): value is GetPublicPortalBranding;
65
+ export declare function GetPublicPortalBrandingFromJSON(json: any): GetPublicPortalBranding;
66
+ export declare function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicPortalBranding;
67
+ export declare function GetPublicPortalBrandingToJSON(json: any): GetPublicPortalBranding;
68
+ export declare function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBranding | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,67 @@
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 GetPublicPortalBranding interface.
16
+ */
17
+ export function instanceOfGetPublicPortalBranding(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('slug' in value) || value['slug'] === undefined)
23
+ return false;
24
+ if (!('logoUrl' in value) || value['logoUrl'] === undefined)
25
+ return false;
26
+ if (!('faviconUrl' in value) || value['faviconUrl'] === undefined)
27
+ return false;
28
+ if (!('headerBackgroundColor' in value) || value['headerBackgroundColor'] === undefined)
29
+ return false;
30
+ if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
31
+ return false;
32
+ return true;
33
+ }
34
+ export function GetPublicPortalBrandingFromJSON(json) {
35
+ return GetPublicPortalBrandingFromJSONTyped(json, false);
36
+ }
37
+ export function GetPublicPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
38
+ if (json == null) {
39
+ return json;
40
+ }
41
+ return {
42
+ 'id': json['id'],
43
+ 'name': json['name'],
44
+ 'slug': json['slug'],
45
+ 'logoUrl': json['logo_url'],
46
+ 'faviconUrl': json['favicon_url'],
47
+ 'headerBackgroundColor': json['header_background_color'],
48
+ 'headerTextColor': json['header_text_color'],
49
+ };
50
+ }
51
+ export function GetPublicPortalBrandingToJSON(json) {
52
+ return GetPublicPortalBrandingToJSONTyped(json, false);
53
+ }
54
+ export function GetPublicPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
55
+ if (value == null) {
56
+ return value;
57
+ }
58
+ return {
59
+ 'id': value['id'],
60
+ 'name': value['name'],
61
+ 'slug': value['slug'],
62
+ 'logo_url': value['logoUrl'],
63
+ 'favicon_url': value['faviconUrl'],
64
+ 'header_background_color': value['headerBackgroundColor'],
65
+ 'header_text_color': value['headerTextColor'],
66
+ };
67
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { UpdateSelectedPortalResponseSelectedPortal } from './UpdateSelectedPortalResponseSelectedPortal';
13
+ import type { UpdateSelectedPortalResponseHostPortal } from './UpdateSelectedPortalResponseHostPortal';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -34,6 +35,12 @@ export interface UpdateSelectedPortalResponse {
34
35
  * @memberof UpdateSelectedPortalResponse
35
36
  */
36
37
  selectedPortal: UpdateSelectedPortalResponseSelectedPortal;
38
+ /**
39
+ *
40
+ * @type {UpdateSelectedPortalResponseHostPortal}
41
+ * @memberof UpdateSelectedPortalResponse
42
+ */
43
+ hostPortal: UpdateSelectedPortalResponseHostPortal;
37
44
  }
38
45
  /**
39
46
  * Check if a given object implements the UpdateSelectedPortalResponse interface.
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { UpdateSelectedPortalResponseSelectedPortalFromJSON, UpdateSelectedPortalResponseSelectedPortalToJSON, } from './UpdateSelectedPortalResponseSelectedPortal';
15
+ import { UpdateSelectedPortalResponseHostPortalFromJSON, UpdateSelectedPortalResponseHostPortalToJSON, } from './UpdateSelectedPortalResponseHostPortal';
15
16
  /**
16
17
  * Check if a given object implements the UpdateSelectedPortalResponse interface.
17
18
  */
@@ -22,6 +23,8 @@ export function instanceOfUpdateSelectedPortalResponse(value) {
22
23
  return false;
23
24
  if (!('selectedPortal' in value) || value['selectedPortal'] === undefined)
24
25
  return false;
26
+ if (!('hostPortal' in value) || value['hostPortal'] === undefined)
27
+ return false;
25
28
  return true;
26
29
  }
27
30
  export function UpdateSelectedPortalResponseFromJSON(json) {
@@ -35,6 +38,7 @@ export function UpdateSelectedPortalResponseFromJSONTyped(json, ignoreDiscrimina
35
38
  'token': json['token'],
36
39
  'expiration': json['expiration'],
37
40
  'selectedPortal': UpdateSelectedPortalResponseSelectedPortalFromJSON(json['selected_portal']),
41
+ 'hostPortal': UpdateSelectedPortalResponseHostPortalFromJSON(json['host_portal']),
38
42
  };
39
43
  }
40
44
  export function UpdateSelectedPortalResponseToJSON(json) {
@@ -48,5 +52,6 @@ export function UpdateSelectedPortalResponseToJSONTyped(value, ignoreDiscriminat
48
52
  'token': value['token'],
49
53
  'expiration': value['expiration'],
50
54
  'selected_portal': UpdateSelectedPortalResponseSelectedPortalToJSON(value['selectedPortal']),
55
+ 'host_portal': UpdateSelectedPortalResponseHostPortalToJSON(value['hostPortal']),
51
56
  };
52
57
  }
@@ -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
+ * Nearest selected-portal ancestor that owns the platform subdomain.
14
+ * @export
15
+ * @interface UpdateSelectedPortalResponseHostPortal
16
+ */
17
+ export interface UpdateSelectedPortalResponseHostPortal {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof UpdateSelectedPortalResponseHostPortal
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof UpdateSelectedPortalResponseHostPortal
28
+ */
29
+ name: string;
30
+ /**
31
+ * Platform subdomain slug used for redirecting after portal switch.
32
+ * @type {string}
33
+ * @memberof UpdateSelectedPortalResponseHostPortal
34
+ */
35
+ slug: string;
36
+ }
37
+ /**
38
+ * Check if a given object implements the UpdateSelectedPortalResponseHostPortal interface.
39
+ */
40
+ export declare function instanceOfUpdateSelectedPortalResponseHostPortal(value: object): value is UpdateSelectedPortalResponseHostPortal;
41
+ export declare function UpdateSelectedPortalResponseHostPortalFromJSON(json: any): UpdateSelectedPortalResponseHostPortal;
42
+ export declare function UpdateSelectedPortalResponseHostPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSelectedPortalResponseHostPortal;
43
+ export declare function UpdateSelectedPortalResponseHostPortalToJSON(json: any): UpdateSelectedPortalResponseHostPortal;
44
+ export declare function UpdateSelectedPortalResponseHostPortalToJSONTyped(value?: UpdateSelectedPortalResponseHostPortal | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,51 @@
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 UpdateSelectedPortalResponseHostPortal interface.
16
+ */
17
+ export function instanceOfUpdateSelectedPortalResponseHostPortal(value) {
18
+ if (!('id' in value) || value['id'] === undefined)
19
+ return false;
20
+ if (!('name' in value) || value['name'] === undefined)
21
+ return false;
22
+ if (!('slug' in value) || value['slug'] === undefined)
23
+ return false;
24
+ return true;
25
+ }
26
+ export function UpdateSelectedPortalResponseHostPortalFromJSON(json) {
27
+ return UpdateSelectedPortalResponseHostPortalFromJSONTyped(json, false);
28
+ }
29
+ export function UpdateSelectedPortalResponseHostPortalFromJSONTyped(json, ignoreDiscriminator) {
30
+ if (json == null) {
31
+ return json;
32
+ }
33
+ return {
34
+ 'id': json['id'],
35
+ 'name': json['name'],
36
+ 'slug': json['slug'],
37
+ };
38
+ }
39
+ export function UpdateSelectedPortalResponseHostPortalToJSON(json) {
40
+ return UpdateSelectedPortalResponseHostPortalToJSONTyped(json, false);
41
+ }
42
+ export function UpdateSelectedPortalResponseHostPortalToJSONTyped(value, ignoreDiscriminator = false) {
43
+ if (value == null) {
44
+ return value;
45
+ }
46
+ return {
47
+ 'id': value['id'],
48
+ 'name': value['name'],
49
+ 'slug': value['slug'],
50
+ };
51
+ }
@@ -78,6 +78,7 @@ export * from './GetPortalStudentReportingCertificates';
78
78
  export * from './GetPortalStudentReportingPortalInfo';
79
79
  export * from './GetPortalUser';
80
80
  export * from './GetPortalUserList';
81
+ export * from './GetPublicPortalBranding';
81
82
  export * from './GetQuestion';
82
83
  export * from './GetQuestionAnswerChoicesInner';
83
84
  export * from './GetQuestionList';
@@ -254,4 +255,5 @@ export * from './ShortAnswer1';
254
255
  export * from './SingleAnswer';
255
256
  export * from './SupportTicketUser';
256
257
  export * from './UpdateSelectedPortalResponse';
258
+ export * from './UpdateSelectedPortalResponseHostPortal';
257
259
  export * from './UpdateSelectedPortalResponseSelectedPortal';
@@ -80,6 +80,7 @@ export * from './GetPortalStudentReportingCertificates';
80
80
  export * from './GetPortalStudentReportingPortalInfo';
81
81
  export * from './GetPortalUser';
82
82
  export * from './GetPortalUserList';
83
+ export * from './GetPublicPortalBranding';
83
84
  export * from './GetQuestion';
84
85
  export * from './GetQuestionAnswerChoicesInner';
85
86
  export * from './GetQuestionList';
@@ -256,4 +257,5 @@ export * from './ShortAnswer1';
256
257
  export * from './SingleAnswer';
257
258
  export * from './SupportTicketUser';
258
259
  export * from './UpdateSelectedPortalResponse';
260
+ export * from './UpdateSelectedPortalResponseHostPortal';
259
261
  export * from './UpdateSelectedPortalResponseSelectedPortal';
@@ -0,0 +1,68 @@
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
+ * Public portal branding resolved from the browser host.
14
+ * @export
15
+ * @interface GetPublicPortalBranding
16
+ */
17
+ export interface GetPublicPortalBranding {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof GetPublicPortalBranding
22
+ */
23
+ id: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof GetPublicPortalBranding
28
+ */
29
+ name: string;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof GetPublicPortalBranding
34
+ */
35
+ slug: string | null;
36
+ /**
37
+ * Presigned portal logo URL when a logo is configured.
38
+ * @type {string}
39
+ * @memberof GetPublicPortalBranding
40
+ */
41
+ logoUrl: string | null;
42
+ /**
43
+ * Presigned portal favicon URL when a favicon is configured.
44
+ * @type {string}
45
+ * @memberof GetPublicPortalBranding
46
+ */
47
+ faviconUrl: string | null;
48
+ /**
49
+ *
50
+ * @type {string}
51
+ * @memberof GetPublicPortalBranding
52
+ */
53
+ headerBackgroundColor: string;
54
+ /**
55
+ *
56
+ * @type {string}
57
+ * @memberof GetPublicPortalBranding
58
+ */
59
+ headerTextColor: string;
60
+ }
61
+ /**
62
+ * Check if a given object implements the GetPublicPortalBranding interface.
63
+ */
64
+ export declare function instanceOfGetPublicPortalBranding(value: object): value is GetPublicPortalBranding;
65
+ export declare function GetPublicPortalBrandingFromJSON(json: any): GetPublicPortalBranding;
66
+ export declare function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicPortalBranding;
67
+ export declare function GetPublicPortalBrandingToJSON(json: any): GetPublicPortalBranding;
68
+ export declare function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBranding | null, ignoreDiscriminator?: boolean): any;