@easyedu/js-lsm-api 1.77.0 → 1.79.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 +22 -0
- package/README.md +18 -2
- package/dist/apis/CourseApi.d.ts +18 -0
- package/dist/apis/CourseApi.js +49 -0
- package/dist/apis/PortalApi.d.ts +67 -0
- package/dist/apis/PortalApi.js +177 -0
- package/dist/esm/apis/CourseApi.d.ts +18 -0
- package/dist/esm/apis/CourseApi.js +49 -0
- package/dist/esm/apis/PortalApi.d.ts +67 -0
- package/dist/esm/apis/PortalApi.js +177 -0
- package/dist/esm/models/GetPortalUserFieldValues.d.ts +53 -0
- package/dist/esm/models/GetPortalUserFieldValues.js +58 -0
- package/dist/esm/models/PortalUserFieldConfig.d.ts +40 -0
- package/dist/esm/models/PortalUserFieldConfig.js +49 -0
- package/dist/esm/models/PortalUserFieldDefinition.d.ts +108 -0
- package/dist/esm/models/PortalUserFieldDefinition.js +90 -0
- package/dist/esm/models/PortalUserFieldGroup.d.ts +62 -0
- package/dist/esm/models/PortalUserFieldGroup.js +59 -0
- package/dist/esm/models/PortalUserFieldMissingRequired.d.ts +56 -0
- package/dist/esm/models/PortalUserFieldMissingRequired.js +55 -0
- package/dist/esm/models/PortalUserFieldOption.d.ts +56 -0
- package/dist/esm/models/PortalUserFieldOption.js +57 -0
- package/dist/esm/models/PortalUserFieldValueField.d.ts +96 -0
- package/dist/esm/models/PortalUserFieldValueField.js +86 -0
- package/dist/esm/models/PortalUserFieldValueGroup.d.ts +57 -0
- package/dist/esm/models/PortalUserFieldValueGroup.js +60 -0
- package/dist/esm/models/PortalUserFieldValueInput.d.ts +38 -0
- package/dist/esm/models/PortalUserFieldValueInput.js +47 -0
- package/dist/esm/models/PostCourseResume.d.ts +93 -0
- package/dist/esm/models/PostCourseResume.js +82 -0
- package/dist/esm/models/PutPortalUserFieldValues.d.ts +33 -0
- package/dist/esm/models/PutPortalUserFieldValues.js +44 -0
- package/dist/esm/models/index.d.ts +11 -0
- package/dist/esm/models/index.js +11 -0
- package/dist/models/GetPortalUserFieldValues.d.ts +53 -0
- package/dist/models/GetPortalUserFieldValues.js +65 -0
- package/dist/models/PortalUserFieldConfig.d.ts +40 -0
- package/dist/models/PortalUserFieldConfig.js +56 -0
- package/dist/models/PortalUserFieldDefinition.d.ts +108 -0
- package/dist/models/PortalUserFieldDefinition.js +98 -0
- package/dist/models/PortalUserFieldGroup.d.ts +62 -0
- package/dist/models/PortalUserFieldGroup.js +66 -0
- package/dist/models/PortalUserFieldMissingRequired.d.ts +56 -0
- package/dist/models/PortalUserFieldMissingRequired.js +62 -0
- package/dist/models/PortalUserFieldOption.d.ts +56 -0
- package/dist/models/PortalUserFieldOption.js +64 -0
- package/dist/models/PortalUserFieldValueField.d.ts +96 -0
- package/dist/models/PortalUserFieldValueField.js +94 -0
- package/dist/models/PortalUserFieldValueGroup.d.ts +57 -0
- package/dist/models/PortalUserFieldValueGroup.js +67 -0
- package/dist/models/PortalUserFieldValueInput.d.ts +38 -0
- package/dist/models/PortalUserFieldValueInput.js +54 -0
- package/dist/models/PostCourseResume.d.ts +93 -0
- package/dist/models/PostCourseResume.js +89 -0
- package/dist/models/PutPortalUserFieldValues.d.ts +33 -0
- package/dist/models/PutPortalUserFieldValues.js +51 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/docs/CourseApi.md +72 -0
- package/docs/GetPortalUserFieldValues.md +40 -0
- package/docs/PortalApi.md +287 -0
- package/docs/PortalUserFieldConfig.md +36 -0
- package/docs/PortalUserFieldDefinition.md +54 -0
- package/docs/PortalUserFieldGroup.md +44 -0
- package/docs/PortalUserFieldMissingRequired.md +42 -0
- package/docs/PortalUserFieldOption.md +42 -0
- package/docs/PortalUserFieldValueField.md +50 -0
- package/docs/PortalUserFieldValueGroup.md +42 -0
- package/docs/PortalUserFieldValueInput.md +36 -0
- package/docs/PostCourseResume.md +55 -0
- package/docs/PutPortalUserFieldValues.md +34 -0
- package/package.json +1 -1
- package/src/apis/CourseApi.ts +63 -0
- package/src/apis/PortalApi.ts +251 -0
- package/src/models/GetPortalUserFieldValues.ts +115 -0
- package/src/models/PortalUserFieldConfig.ts +90 -0
- package/src/models/PortalUserFieldDefinition.ts +178 -0
- package/src/models/PortalUserFieldGroup.ts +109 -0
- package/src/models/PortalUserFieldMissingRequired.ts +100 -0
- package/src/models/PortalUserFieldOption.ts +101 -0
- package/src/models/PortalUserFieldValueField.ts +162 -0
- package/src/models/PortalUserFieldValueGroup.ts +110 -0
- package/src/models/PortalUserFieldValueInput.ts +75 -0
- package/src/models/PostCourseResume.ts +165 -0
- package/src/models/PutPortalUserFieldValues.ts +74 -0
- package/src/models/index.ts +11 -0
|
@@ -32,6 +32,7 @@ import { GetCourseReportingBasicFromJSON, } from '../models/GetCourseReportingBa
|
|
|
32
32
|
import { PostCourseToJSON, } from '../models/PostCourse';
|
|
33
33
|
import { PostCourseEnrollmentToJSON, } from '../models/PostCourseEnrollment';
|
|
34
34
|
import { PostCourseExportToJSON, } from '../models/PostCourseExport';
|
|
35
|
+
import { PostCourseResumeFromJSON, } from '../models/PostCourseResume';
|
|
35
36
|
import { PostDuplicateToJSON, } from '../models/PostDuplicate';
|
|
36
37
|
import { PutCourseToJSON, } from '../models/PutCourse';
|
|
37
38
|
import { PutCourseEnrollmentToJSON, } from '../models/PutCourseEnrollment';
|
|
@@ -791,6 +792,54 @@ export class CourseApi extends runtime.BaseAPI {
|
|
|
791
792
|
return yield response.value();
|
|
792
793
|
});
|
|
793
794
|
}
|
|
795
|
+
/**
|
|
796
|
+
* Creates request options for postCourseResume without sending the request
|
|
797
|
+
*/
|
|
798
|
+
postCourseResumeRequestOpts(requestParameters) {
|
|
799
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
800
|
+
if (requestParameters['courseId'] == null) {
|
|
801
|
+
throw new runtime.RequiredError('courseId', 'Required parameter "courseId" was null or undefined when calling postCourseResume().');
|
|
802
|
+
}
|
|
803
|
+
const queryParameters = {};
|
|
804
|
+
const headerParameters = {};
|
|
805
|
+
let urlPath = `/courses/{courseId}/resume`;
|
|
806
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
807
|
+
return {
|
|
808
|
+
path: urlPath,
|
|
809
|
+
method: 'POST',
|
|
810
|
+
headers: headerParameters,
|
|
811
|
+
query: queryParameters,
|
|
812
|
+
};
|
|
813
|
+
});
|
|
814
|
+
}
|
|
815
|
+
/**
|
|
816
|
+
* Selects the first incomplete published content item in course order, creates or reuses the current live content session, and returns a launch-ready response.
|
|
817
|
+
* Resume the current learner\'s progress in a course
|
|
818
|
+
*/
|
|
819
|
+
postCourseResumeRaw(requestParameters, initOverrides) {
|
|
820
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
821
|
+
const requestOptions = yield this.postCourseResumeRequestOpts(requestParameters);
|
|
822
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
823
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PostCourseResumeFromJSON(jsonValue));
|
|
824
|
+
});
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* Selects the first incomplete published content item in course order, creates or reuses the current live content session, and returns a launch-ready response.
|
|
828
|
+
* Resume the current learner\'s progress in a course
|
|
829
|
+
*/
|
|
830
|
+
postCourseResume(requestParameters, initOverrides) {
|
|
831
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
832
|
+
const response = yield this.postCourseResumeRaw(requestParameters, initOverrides);
|
|
833
|
+
switch (response.raw.status) {
|
|
834
|
+
case 200:
|
|
835
|
+
return yield response.value();
|
|
836
|
+
case 204:
|
|
837
|
+
return null;
|
|
838
|
+
default:
|
|
839
|
+
return yield response.value();
|
|
840
|
+
}
|
|
841
|
+
});
|
|
842
|
+
}
|
|
794
843
|
/**
|
|
795
844
|
* Creates request options for putCourse without sending the request
|
|
796
845
|
*/
|
|
@@ -14,11 +14,14 @@ import { type GetPortal } from '../models/GetPortal';
|
|
|
14
14
|
import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
|
|
15
15
|
import { type GetPortalList } from '../models/GetPortalList';
|
|
16
16
|
import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
|
|
17
|
+
import { type GetPortalUserFieldValues } from '../models/GetPortalUserFieldValues';
|
|
17
18
|
import { type GetPortalUserList } from '../models/GetPortalUserList';
|
|
18
19
|
import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
|
|
20
|
+
import { type PortalUserFieldConfig } from '../models/PortalUserFieldConfig';
|
|
19
21
|
import { type PostPortal } from '../models/PostPortal';
|
|
20
22
|
import { type PostPortalInvite } from '../models/PostPortalInvite';
|
|
21
23
|
import { type PutPortalBranding } from '../models/PutPortalBranding';
|
|
24
|
+
import { type PutPortalUserFieldValues } from '../models/PutPortalUserFieldValues';
|
|
22
25
|
import { type UpdateSelectedPortalResponse } from '../models/UpdateSelectedPortalResponse';
|
|
23
26
|
export interface DeletePortalFaviconRequest {
|
|
24
27
|
portalId: string;
|
|
@@ -35,6 +38,13 @@ export interface GetPortalFaviconAssetRequest {
|
|
|
35
38
|
export interface GetPortalLogoAssetRequest {
|
|
36
39
|
portalId: string;
|
|
37
40
|
}
|
|
41
|
+
export interface GetPortalUserFieldConfigRequest {
|
|
42
|
+
portalId: string;
|
|
43
|
+
}
|
|
44
|
+
export interface GetPortalUserFieldValuesRequest {
|
|
45
|
+
portalId: string;
|
|
46
|
+
userId: string;
|
|
47
|
+
}
|
|
38
48
|
export interface GetPortalUsersRequest {
|
|
39
49
|
portalId: string;
|
|
40
50
|
type?: GetPortalUsersTypeEnum;
|
|
@@ -62,6 +72,15 @@ export interface PutPortalBrandingRequest {
|
|
|
62
72
|
portalId: string;
|
|
63
73
|
putPortalBranding: PutPortalBranding;
|
|
64
74
|
}
|
|
75
|
+
export interface PutPortalUserFieldConfigRequest {
|
|
76
|
+
portalId: string;
|
|
77
|
+
portalUserFieldConfig: PortalUserFieldConfig;
|
|
78
|
+
}
|
|
79
|
+
export interface PutPortalUserFieldValuesRequest {
|
|
80
|
+
portalId: string;
|
|
81
|
+
userId: string;
|
|
82
|
+
putPortalUserFieldValues: PutPortalUserFieldValues;
|
|
83
|
+
}
|
|
65
84
|
export interface RemovePortalUserRequest {
|
|
66
85
|
portalId: string;
|
|
67
86
|
userId: string;
|
|
@@ -145,6 +164,30 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
145
164
|
* Stream the configured portal logo
|
|
146
165
|
*/
|
|
147
166
|
getPortalLogoAsset(requestParameters: GetPortalLogoAssetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
|
|
167
|
+
/**
|
|
168
|
+
* Creates request options for getPortalUserFieldConfig without sending the request
|
|
169
|
+
*/
|
|
170
|
+
getPortalUserFieldConfigRequestOpts(requestParameters: GetPortalUserFieldConfigRequest): Promise<runtime.RequestOpts>;
|
|
171
|
+
/**
|
|
172
|
+
* Get portal user field configuration
|
|
173
|
+
*/
|
|
174
|
+
getPortalUserFieldConfigRaw(requestParameters: GetPortalUserFieldConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalUserFieldConfig>>;
|
|
175
|
+
/**
|
|
176
|
+
* Get portal user field configuration
|
|
177
|
+
*/
|
|
178
|
+
getPortalUserFieldConfig(requestParameters: GetPortalUserFieldConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalUserFieldConfig>;
|
|
179
|
+
/**
|
|
180
|
+
* Creates request options for getPortalUserFieldValues without sending the request
|
|
181
|
+
*/
|
|
182
|
+
getPortalUserFieldValuesRequestOpts(requestParameters: GetPortalUserFieldValuesRequest): Promise<runtime.RequestOpts>;
|
|
183
|
+
/**
|
|
184
|
+
* Get a user\'s portal field values and completion status
|
|
185
|
+
*/
|
|
186
|
+
getPortalUserFieldValuesRaw(requestParameters: GetPortalUserFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserFieldValues>>;
|
|
187
|
+
/**
|
|
188
|
+
* Get a user\'s portal field values and completion status
|
|
189
|
+
*/
|
|
190
|
+
getPortalUserFieldValues(requestParameters: GetPortalUserFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserFieldValues>;
|
|
148
191
|
/**
|
|
149
192
|
* Creates request options for getPortalUsers without sending the request
|
|
150
193
|
*/
|
|
@@ -259,6 +302,30 @@ export declare class PortalApi extends runtime.BaseAPI {
|
|
|
259
302
|
* Update portal branding (name, background color, text color)
|
|
260
303
|
*/
|
|
261
304
|
putPortalBranding(requestParameters: PutPortalBrandingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
|
|
305
|
+
/**
|
|
306
|
+
* Creates request options for putPortalUserFieldConfig without sending the request
|
|
307
|
+
*/
|
|
308
|
+
putPortalUserFieldConfigRequestOpts(requestParameters: PutPortalUserFieldConfigRequest): Promise<runtime.RequestOpts>;
|
|
309
|
+
/**
|
|
310
|
+
* Replace portal user field configuration
|
|
311
|
+
*/
|
|
312
|
+
putPortalUserFieldConfigRaw(requestParameters: PutPortalUserFieldConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalUserFieldConfig>>;
|
|
313
|
+
/**
|
|
314
|
+
* Replace portal user field configuration
|
|
315
|
+
*/
|
|
316
|
+
putPortalUserFieldConfig(requestParameters: PutPortalUserFieldConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalUserFieldConfig>;
|
|
317
|
+
/**
|
|
318
|
+
* Creates request options for putPortalUserFieldValues without sending the request
|
|
319
|
+
*/
|
|
320
|
+
putPortalUserFieldValuesRequestOpts(requestParameters: PutPortalUserFieldValuesRequest): Promise<runtime.RequestOpts>;
|
|
321
|
+
/**
|
|
322
|
+
* Bulk upsert a user\'s portal field values
|
|
323
|
+
*/
|
|
324
|
+
putPortalUserFieldValuesRaw(requestParameters: PutPortalUserFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalUserFieldValues>>;
|
|
325
|
+
/**
|
|
326
|
+
* Bulk upsert a user\'s portal field values
|
|
327
|
+
*/
|
|
328
|
+
putPortalUserFieldValues(requestParameters: PutPortalUserFieldValuesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserFieldValues>;
|
|
262
329
|
/**
|
|
263
330
|
* Creates request options for removePortalUser without sending the request
|
|
264
331
|
*/
|
|
@@ -25,11 +25,14 @@ import { GetPortalFromJSON, } from '../models/GetPortal';
|
|
|
25
25
|
import { GetPortalFaviconUploadFromJSON, } from '../models/GetPortalFaviconUpload';
|
|
26
26
|
import { GetPortalListFromJSON, } from '../models/GetPortalList';
|
|
27
27
|
import { GetPortalLogoUploadFromJSON, } from '../models/GetPortalLogoUpload';
|
|
28
|
+
import { GetPortalUserFieldValuesFromJSON, } from '../models/GetPortalUserFieldValues';
|
|
28
29
|
import { GetPortalUserListFromJSON, } from '../models/GetPortalUserList';
|
|
29
30
|
import { GetPublicPortalBrandingFromJSON, } from '../models/GetPublicPortalBranding';
|
|
31
|
+
import { PortalUserFieldConfigFromJSON, PortalUserFieldConfigToJSON, } from '../models/PortalUserFieldConfig';
|
|
30
32
|
import { PostPortalToJSON, } from '../models/PostPortal';
|
|
31
33
|
import { PostPortalInviteToJSON, } from '../models/PostPortalInvite';
|
|
32
34
|
import { PutPortalBrandingToJSON, } from '../models/PutPortalBranding';
|
|
35
|
+
import { PutPortalUserFieldValuesToJSON, } from '../models/PutPortalUserFieldValues';
|
|
33
36
|
import { UpdateSelectedPortalResponseFromJSON, } from '../models/UpdateSelectedPortalResponse';
|
|
34
37
|
/**
|
|
35
38
|
*
|
|
@@ -263,6 +266,88 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
263
266
|
return yield response.value();
|
|
264
267
|
});
|
|
265
268
|
}
|
|
269
|
+
/**
|
|
270
|
+
* Creates request options for getPortalUserFieldConfig without sending the request
|
|
271
|
+
*/
|
|
272
|
+
getPortalUserFieldConfigRequestOpts(requestParameters) {
|
|
273
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
274
|
+
if (requestParameters['portalId'] == null) {
|
|
275
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUserFieldConfig().');
|
|
276
|
+
}
|
|
277
|
+
const queryParameters = {};
|
|
278
|
+
const headerParameters = {};
|
|
279
|
+
let urlPath = `/portals/{portalId}/user-field-config`;
|
|
280
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
281
|
+
return {
|
|
282
|
+
path: urlPath,
|
|
283
|
+
method: 'GET',
|
|
284
|
+
headers: headerParameters,
|
|
285
|
+
query: queryParameters,
|
|
286
|
+
};
|
|
287
|
+
});
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Get portal user field configuration
|
|
291
|
+
*/
|
|
292
|
+
getPortalUserFieldConfigRaw(requestParameters, initOverrides) {
|
|
293
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
294
|
+
const requestOptions = yield this.getPortalUserFieldConfigRequestOpts(requestParameters);
|
|
295
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
296
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PortalUserFieldConfigFromJSON(jsonValue));
|
|
297
|
+
});
|
|
298
|
+
}
|
|
299
|
+
/**
|
|
300
|
+
* Get portal user field configuration
|
|
301
|
+
*/
|
|
302
|
+
getPortalUserFieldConfig(requestParameters, initOverrides) {
|
|
303
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
304
|
+
const response = yield this.getPortalUserFieldConfigRaw(requestParameters, initOverrides);
|
|
305
|
+
return yield response.value();
|
|
306
|
+
});
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Creates request options for getPortalUserFieldValues without sending the request
|
|
310
|
+
*/
|
|
311
|
+
getPortalUserFieldValuesRequestOpts(requestParameters) {
|
|
312
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
313
|
+
if (requestParameters['portalId'] == null) {
|
|
314
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling getPortalUserFieldValues().');
|
|
315
|
+
}
|
|
316
|
+
if (requestParameters['userId'] == null) {
|
|
317
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling getPortalUserFieldValues().');
|
|
318
|
+
}
|
|
319
|
+
const queryParameters = {};
|
|
320
|
+
const headerParameters = {};
|
|
321
|
+
let urlPath = `/portals/{portalId}/users/{userId}/user-field-values`;
|
|
322
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
323
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
324
|
+
return {
|
|
325
|
+
path: urlPath,
|
|
326
|
+
method: 'GET',
|
|
327
|
+
headers: headerParameters,
|
|
328
|
+
query: queryParameters,
|
|
329
|
+
};
|
|
330
|
+
});
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* Get a user\'s portal field values and completion status
|
|
334
|
+
*/
|
|
335
|
+
getPortalUserFieldValuesRaw(requestParameters, initOverrides) {
|
|
336
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
337
|
+
const requestOptions = yield this.getPortalUserFieldValuesRequestOpts(requestParameters);
|
|
338
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
339
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserFieldValuesFromJSON(jsonValue));
|
|
340
|
+
});
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Get a user\'s portal field values and completion status
|
|
344
|
+
*/
|
|
345
|
+
getPortalUserFieldValues(requestParameters, initOverrides) {
|
|
346
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
347
|
+
const response = yield this.getPortalUserFieldValuesRaw(requestParameters, initOverrides);
|
|
348
|
+
return yield response.value();
|
|
349
|
+
});
|
|
350
|
+
}
|
|
266
351
|
/**
|
|
267
352
|
* Creates request options for getPortalUsers without sending the request
|
|
268
353
|
*/
|
|
@@ -677,6 +762,98 @@ export class PortalApi extends runtime.BaseAPI {
|
|
|
677
762
|
return yield response.value();
|
|
678
763
|
});
|
|
679
764
|
}
|
|
765
|
+
/**
|
|
766
|
+
* Creates request options for putPortalUserFieldConfig without sending the request
|
|
767
|
+
*/
|
|
768
|
+
putPortalUserFieldConfigRequestOpts(requestParameters) {
|
|
769
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
770
|
+
if (requestParameters['portalId'] == null) {
|
|
771
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalUserFieldConfig().');
|
|
772
|
+
}
|
|
773
|
+
if (requestParameters['portalUserFieldConfig'] == null) {
|
|
774
|
+
throw new runtime.RequiredError('portalUserFieldConfig', 'Required parameter "portalUserFieldConfig" was null or undefined when calling putPortalUserFieldConfig().');
|
|
775
|
+
}
|
|
776
|
+
const queryParameters = {};
|
|
777
|
+
const headerParameters = {};
|
|
778
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
779
|
+
let urlPath = `/portals/{portalId}/user-field-config`;
|
|
780
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
781
|
+
return {
|
|
782
|
+
path: urlPath,
|
|
783
|
+
method: 'PUT',
|
|
784
|
+
headers: headerParameters,
|
|
785
|
+
query: queryParameters,
|
|
786
|
+
body: PortalUserFieldConfigToJSON(requestParameters['portalUserFieldConfig']),
|
|
787
|
+
};
|
|
788
|
+
});
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* Replace portal user field configuration
|
|
792
|
+
*/
|
|
793
|
+
putPortalUserFieldConfigRaw(requestParameters, initOverrides) {
|
|
794
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
795
|
+
const requestOptions = yield this.putPortalUserFieldConfigRequestOpts(requestParameters);
|
|
796
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
797
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PortalUserFieldConfigFromJSON(jsonValue));
|
|
798
|
+
});
|
|
799
|
+
}
|
|
800
|
+
/**
|
|
801
|
+
* Replace portal user field configuration
|
|
802
|
+
*/
|
|
803
|
+
putPortalUserFieldConfig(requestParameters, initOverrides) {
|
|
804
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
805
|
+
const response = yield this.putPortalUserFieldConfigRaw(requestParameters, initOverrides);
|
|
806
|
+
return yield response.value();
|
|
807
|
+
});
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* Creates request options for putPortalUserFieldValues without sending the request
|
|
811
|
+
*/
|
|
812
|
+
putPortalUserFieldValuesRequestOpts(requestParameters) {
|
|
813
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
814
|
+
if (requestParameters['portalId'] == null) {
|
|
815
|
+
throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling putPortalUserFieldValues().');
|
|
816
|
+
}
|
|
817
|
+
if (requestParameters['userId'] == null) {
|
|
818
|
+
throw new runtime.RequiredError('userId', 'Required parameter "userId" was null or undefined when calling putPortalUserFieldValues().');
|
|
819
|
+
}
|
|
820
|
+
if (requestParameters['putPortalUserFieldValues'] == null) {
|
|
821
|
+
throw new runtime.RequiredError('putPortalUserFieldValues', 'Required parameter "putPortalUserFieldValues" was null or undefined when calling putPortalUserFieldValues().');
|
|
822
|
+
}
|
|
823
|
+
const queryParameters = {};
|
|
824
|
+
const headerParameters = {};
|
|
825
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
826
|
+
let urlPath = `/portals/{portalId}/users/{userId}/user-field-values`;
|
|
827
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
828
|
+
urlPath = urlPath.replace('{userId}', encodeURIComponent(String(requestParameters['userId'])));
|
|
829
|
+
return {
|
|
830
|
+
path: urlPath,
|
|
831
|
+
method: 'PUT',
|
|
832
|
+
headers: headerParameters,
|
|
833
|
+
query: queryParameters,
|
|
834
|
+
body: PutPortalUserFieldValuesToJSON(requestParameters['putPortalUserFieldValues']),
|
|
835
|
+
};
|
|
836
|
+
});
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* Bulk upsert a user\'s portal field values
|
|
840
|
+
*/
|
|
841
|
+
putPortalUserFieldValuesRaw(requestParameters, initOverrides) {
|
|
842
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
843
|
+
const requestOptions = yield this.putPortalUserFieldValuesRequestOpts(requestParameters);
|
|
844
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
845
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalUserFieldValuesFromJSON(jsonValue));
|
|
846
|
+
});
|
|
847
|
+
}
|
|
848
|
+
/**
|
|
849
|
+
* Bulk upsert a user\'s portal field values
|
|
850
|
+
*/
|
|
851
|
+
putPortalUserFieldValues(requestParameters, initOverrides) {
|
|
852
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
853
|
+
const response = yield this.putPortalUserFieldValuesRaw(requestParameters, initOverrides);
|
|
854
|
+
return yield response.value();
|
|
855
|
+
});
|
|
856
|
+
}
|
|
680
857
|
/**
|
|
681
858
|
* Creates request options for removePortalUser without sending the request
|
|
682
859
|
*/
|
|
@@ -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 { PortalUserFieldValueField } from './PortalUserFieldValueField';
|
|
13
|
+
import type { PortalUserFieldMissingRequired } from './PortalUserFieldMissingRequired';
|
|
14
|
+
import type { PortalUserFieldValueGroup } from './PortalUserFieldValueGroup';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
* @interface GetPortalUserFieldValues
|
|
19
|
+
*/
|
|
20
|
+
export interface GetPortalUserFieldValues {
|
|
21
|
+
/**
|
|
22
|
+
*
|
|
23
|
+
* @type {boolean}
|
|
24
|
+
* @memberof GetPortalUserFieldValues
|
|
25
|
+
*/
|
|
26
|
+
complete: boolean;
|
|
27
|
+
/**
|
|
28
|
+
*
|
|
29
|
+
* @type {Array<PortalUserFieldMissingRequired>}
|
|
30
|
+
* @memberof GetPortalUserFieldValues
|
|
31
|
+
*/
|
|
32
|
+
missingRequiredFields: Array<PortalUserFieldMissingRequired>;
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @type {Array<PortalUserFieldValueGroup>}
|
|
36
|
+
* @memberof GetPortalUserFieldValues
|
|
37
|
+
*/
|
|
38
|
+
groups: Array<PortalUserFieldValueGroup>;
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @type {Array<PortalUserFieldValueField>}
|
|
42
|
+
* @memberof GetPortalUserFieldValues
|
|
43
|
+
*/
|
|
44
|
+
ungroupedFields: Array<PortalUserFieldValueField>;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Check if a given object implements the GetPortalUserFieldValues interface.
|
|
48
|
+
*/
|
|
49
|
+
export declare function instanceOfGetPortalUserFieldValues(value: object): value is GetPortalUserFieldValues;
|
|
50
|
+
export declare function GetPortalUserFieldValuesFromJSON(json: any): GetPortalUserFieldValues;
|
|
51
|
+
export declare function GetPortalUserFieldValuesFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalUserFieldValues;
|
|
52
|
+
export declare function GetPortalUserFieldValuesToJSON(json: any): GetPortalUserFieldValues;
|
|
53
|
+
export declare function GetPortalUserFieldValuesToJSONTyped(value?: GetPortalUserFieldValues | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,58 @@
|
|
|
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
|
+
import { PortalUserFieldValueFieldFromJSON, PortalUserFieldValueFieldToJSON, } from './PortalUserFieldValueField';
|
|
15
|
+
import { PortalUserFieldMissingRequiredFromJSON, PortalUserFieldMissingRequiredToJSON, } from './PortalUserFieldMissingRequired';
|
|
16
|
+
import { PortalUserFieldValueGroupFromJSON, PortalUserFieldValueGroupToJSON, } from './PortalUserFieldValueGroup';
|
|
17
|
+
/**
|
|
18
|
+
* Check if a given object implements the GetPortalUserFieldValues interface.
|
|
19
|
+
*/
|
|
20
|
+
export function instanceOfGetPortalUserFieldValues(value) {
|
|
21
|
+
if (!('complete' in value) || value['complete'] === undefined)
|
|
22
|
+
return false;
|
|
23
|
+
if (!('missingRequiredFields' in value) || value['missingRequiredFields'] === undefined)
|
|
24
|
+
return false;
|
|
25
|
+
if (!('groups' in value) || value['groups'] === undefined)
|
|
26
|
+
return false;
|
|
27
|
+
if (!('ungroupedFields' in value) || value['ungroupedFields'] === undefined)
|
|
28
|
+
return false;
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
export function GetPortalUserFieldValuesFromJSON(json) {
|
|
32
|
+
return GetPortalUserFieldValuesFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
export function GetPortalUserFieldValuesFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if (json == null) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'complete': json['complete'],
|
|
40
|
+
'missingRequiredFields': (json['missing_required_fields'].map(PortalUserFieldMissingRequiredFromJSON)),
|
|
41
|
+
'groups': (json['groups'].map(PortalUserFieldValueGroupFromJSON)),
|
|
42
|
+
'ungroupedFields': (json['ungrouped_fields'].map(PortalUserFieldValueFieldFromJSON)),
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
export function GetPortalUserFieldValuesToJSON(json) {
|
|
46
|
+
return GetPortalUserFieldValuesToJSONTyped(json, false);
|
|
47
|
+
}
|
|
48
|
+
export function GetPortalUserFieldValuesToJSONTyped(value, ignoreDiscriminator = false) {
|
|
49
|
+
if (value == null) {
|
|
50
|
+
return value;
|
|
51
|
+
}
|
|
52
|
+
return {
|
|
53
|
+
'complete': value['complete'],
|
|
54
|
+
'missing_required_fields': (value['missingRequiredFields'].map(PortalUserFieldMissingRequiredToJSON)),
|
|
55
|
+
'groups': (value['groups'].map(PortalUserFieldValueGroupToJSON)),
|
|
56
|
+
'ungrouped_fields': (value['ungroupedFields'].map(PortalUserFieldValueFieldToJSON)),
|
|
57
|
+
};
|
|
58
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
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 { PortalUserFieldDefinition } from './PortalUserFieldDefinition';
|
|
13
|
+
import type { PortalUserFieldGroup } from './PortalUserFieldGroup';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface PortalUserFieldConfig
|
|
18
|
+
*/
|
|
19
|
+
export interface PortalUserFieldConfig {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {Array<PortalUserFieldGroup>}
|
|
23
|
+
* @memberof PortalUserFieldConfig
|
|
24
|
+
*/
|
|
25
|
+
groups: Array<PortalUserFieldGroup>;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {Array<PortalUserFieldDefinition>}
|
|
29
|
+
* @memberof PortalUserFieldConfig
|
|
30
|
+
*/
|
|
31
|
+
fields: Array<PortalUserFieldDefinition>;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the PortalUserFieldConfig interface.
|
|
35
|
+
*/
|
|
36
|
+
export declare function instanceOfPortalUserFieldConfig(value: object): value is PortalUserFieldConfig;
|
|
37
|
+
export declare function PortalUserFieldConfigFromJSON(json: any): PortalUserFieldConfig;
|
|
38
|
+
export declare function PortalUserFieldConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): PortalUserFieldConfig;
|
|
39
|
+
export declare function PortalUserFieldConfigToJSON(json: any): PortalUserFieldConfig;
|
|
40
|
+
export declare function PortalUserFieldConfigToJSONTyped(value?: PortalUserFieldConfig | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,49 @@
|
|
|
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
|
+
import { PortalUserFieldDefinitionFromJSON, PortalUserFieldDefinitionToJSON, } from './PortalUserFieldDefinition';
|
|
15
|
+
import { PortalUserFieldGroupFromJSON, PortalUserFieldGroupToJSON, } from './PortalUserFieldGroup';
|
|
16
|
+
/**
|
|
17
|
+
* Check if a given object implements the PortalUserFieldConfig interface.
|
|
18
|
+
*/
|
|
19
|
+
export function instanceOfPortalUserFieldConfig(value) {
|
|
20
|
+
if (!('groups' in value) || value['groups'] === undefined)
|
|
21
|
+
return false;
|
|
22
|
+
if (!('fields' in value) || value['fields'] === undefined)
|
|
23
|
+
return false;
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
export function PortalUserFieldConfigFromJSON(json) {
|
|
27
|
+
return PortalUserFieldConfigFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
export function PortalUserFieldConfigFromJSONTyped(json, ignoreDiscriminator) {
|
|
30
|
+
if (json == null) {
|
|
31
|
+
return json;
|
|
32
|
+
}
|
|
33
|
+
return {
|
|
34
|
+
'groups': (json['groups'].map(PortalUserFieldGroupFromJSON)),
|
|
35
|
+
'fields': (json['fields'].map(PortalUserFieldDefinitionFromJSON)),
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
export function PortalUserFieldConfigToJSON(json) {
|
|
39
|
+
return PortalUserFieldConfigToJSONTyped(json, false);
|
|
40
|
+
}
|
|
41
|
+
export function PortalUserFieldConfigToJSONTyped(value, ignoreDiscriminator = false) {
|
|
42
|
+
if (value == null) {
|
|
43
|
+
return value;
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
'groups': (value['groups'].map(PortalUserFieldGroupToJSON)),
|
|
47
|
+
'fields': (value['fields'].map(PortalUserFieldDefinitionToJSON)),
|
|
48
|
+
};
|
|
49
|
+
}
|