@iblai/iblai-api 3.48.3-core → 3.48.4-core
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/dist/index.cjs.js +3038 -2750
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +3038 -2750
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +3038 -2750
- package/dist/index.umd.js.map +1 -1
- package/dist/types/services/AnalyticsService.d.ts +42 -13
- package/dist/types/services/AudienceService.d.ts +345 -149
- package/dist/types/services/CareerService.d.ts +117 -90
- package/dist/types/services/CatalogService.d.ts +3735 -1072
- package/dist/types/services/CoreService.d.ts +421 -210
- package/dist/types/services/CredentialsService.d.ts +173 -138
- package/dist/types/services/DepartmentsService.d.ts +53 -16
- package/dist/types/services/EngagementService.d.ts +459 -179
- package/dist/types/services/FeaturesService.d.ts +16 -7
- package/dist/types/services/FinanceService.d.ts +49 -20
- package/dist/types/services/MediaResourcesService.d.ts +243 -67
- package/dist/types/services/NotificationBuilderService.d.ts +31 -17
- package/dist/types/services/NotificationService.d.ts +56 -49
- package/dist/types/services/OrgsService.d.ts +106 -77
- package/dist/types/services/OverviewService.d.ts +154 -55
- package/dist/types/services/PerformanceService.d.ts +132 -56
- package/dist/types/services/PerlearnerService.d.ts +431 -217
- package/dist/types/services/PlatformService.d.ts +221 -116
- package/dist/types/services/ProviderAssociationService.d.ts +3 -2
- package/dist/types/services/ProvidersService.d.ts +27 -18
- package/dist/types/services/ProvisionService.d.ts +3 -2
- package/dist/types/services/RecommendationsService.d.ts +3 -3
- package/dist/types/services/ReportsService.d.ts +22 -16
- package/dist/types/services/RolesService.d.ts +8 -6
- package/dist/types/services/SearchService.d.ts +305 -80
- package/dist/types/services/ServiceService.d.ts +33 -29
- package/dist/types/services/SkillsService.d.ts +40 -32
- package/dist/types/services/UserGroupsService.d.ts +53 -16
- package/package.json +1 -1
- package/src/services/AnalyticsService.ts +45 -16
- package/src/services/AudienceService.ts +380 -184
- package/src/services/CareerService.ts +144 -117
- package/src/services/CatalogService.ts +3995 -1332
- package/src/services/CoreService.ts +503 -286
- package/src/services/CredentialsService.ts +253 -173
- package/src/services/DepartmentsService.ts +56 -19
- package/src/services/EngagementService.ts +528 -236
- package/src/services/FeaturesService.ts +19 -10
- package/src/services/FinanceService.ts +54 -25
- package/src/services/MediaResourcesService.ts +251 -75
- package/src/services/NotificationBuilderService.ts +36 -22
- package/src/services/NotificationService.ts +73 -61
- package/src/services/OrgsService.ts +135 -106
- package/src/services/OverviewService.ts +172 -73
- package/src/services/PerformanceService.ts +153 -77
- package/src/services/PerlearnerService.ts +591 -279
- package/src/services/PlatformService.ts +278 -157
- package/src/services/ProviderAssociationService.ts +4 -3
- package/src/services/ProvidersService.ts +36 -27
- package/src/services/ProvisionService.ts +4 -3
- package/src/services/RecommendationsService.ts +5 -4
- package/src/services/ReportsService.ts +28 -22
- package/src/services/RolesService.ts +10 -8
- package/src/services/SearchService.ts +323 -98
- package/src/services/ServiceService.ts +49 -39
- package/src/services/SkillsService.ts +56 -44
- package/src/services/UserGroupsService.ts +56 -19
|
@@ -53,13 +53,14 @@ export class CoreService {
|
|
|
53
53
|
* Params:
|
|
54
54
|
* - Any of user_id, username, or email (choose one only, required)
|
|
55
55
|
* - platform_key: str (required)
|
|
56
|
-
* @param requestBody
|
|
57
56
|
* @returns TokenProxyOutput
|
|
58
57
|
* @throws ApiError
|
|
59
58
|
*/
|
|
60
|
-
public static coreConsolidatedTokenProxyCreate(
|
|
59
|
+
public static coreConsolidatedTokenProxyCreate({
|
|
60
|
+
requestBody,
|
|
61
|
+
}: {
|
|
61
62
|
requestBody: TokenProxyInput,
|
|
62
|
-
): CancelablePromise<TokenProxyOutput> {
|
|
63
|
+
}): CancelablePromise<TokenProxyOutput> {
|
|
63
64
|
return __request(OpenAPI, {
|
|
64
65
|
method: 'POST',
|
|
65
66
|
url: '/api/core/consolidated-token/proxy/',
|
|
@@ -157,15 +158,16 @@ export class CoreService {
|
|
|
157
158
|
}
|
|
158
159
|
/**
|
|
159
160
|
* Check if a domain is whitelisted
|
|
160
|
-
* @param url
|
|
161
|
-
* @param isActive
|
|
162
161
|
* @returns any No response body
|
|
163
162
|
* @throws ApiError
|
|
164
163
|
*/
|
|
165
|
-
public static coreDomainsWhitelistRetrieve(
|
|
164
|
+
public static coreDomainsWhitelistRetrieve({
|
|
165
|
+
url,
|
|
166
|
+
isActive,
|
|
167
|
+
}: {
|
|
166
168
|
url: string,
|
|
167
169
|
isActive?: boolean,
|
|
168
|
-
): CancelablePromise<any> {
|
|
170
|
+
}): CancelablePromise<any> {
|
|
169
171
|
return __request(OpenAPI, {
|
|
170
172
|
method: 'GET',
|
|
171
173
|
url: '/api/core/domains/whitelist/',
|
|
@@ -177,13 +179,14 @@ export class CoreService {
|
|
|
177
179
|
}
|
|
178
180
|
/**
|
|
179
181
|
* Add a new domain to whitelist
|
|
180
|
-
* @param requestBody
|
|
181
182
|
* @returns WhitelistedDomain
|
|
182
183
|
* @throws ApiError
|
|
183
184
|
*/
|
|
184
|
-
public static coreDomainsWhitelistCreate(
|
|
185
|
+
public static coreDomainsWhitelistCreate({
|
|
186
|
+
requestBody,
|
|
187
|
+
}: {
|
|
185
188
|
requestBody: WhitelistedDomain,
|
|
186
|
-
): CancelablePromise<WhitelistedDomain> {
|
|
189
|
+
}): CancelablePromise<WhitelistedDomain> {
|
|
187
190
|
return __request(OpenAPI, {
|
|
188
191
|
method: 'POST',
|
|
189
192
|
url: '/api/core/domains/whitelist/',
|
|
@@ -241,15 +244,16 @@ export class CoreService {
|
|
|
241
244
|
* Params:
|
|
242
245
|
* key
|
|
243
246
|
* user_id: Optional
|
|
244
|
-
* @param key
|
|
245
|
-
* @param userId
|
|
246
247
|
* @returns PlatformList
|
|
247
248
|
* @throws ApiError
|
|
248
249
|
*/
|
|
249
|
-
public static coreLauncherRetrieve(
|
|
250
|
+
public static coreLauncherRetrieve({
|
|
251
|
+
key,
|
|
252
|
+
userId,
|
|
253
|
+
}: {
|
|
250
254
|
key: string,
|
|
251
255
|
userId?: number,
|
|
252
|
-
): CancelablePromise<PlatformList> {
|
|
256
|
+
}): CancelablePromise<PlatformList> {
|
|
253
257
|
return __request(OpenAPI, {
|
|
254
258
|
method: 'GET',
|
|
255
259
|
url: '/api/core/launcher/',
|
|
@@ -270,13 +274,14 @@ export class CoreService {
|
|
|
270
274
|
* lms_url: LMS URL ("optional")
|
|
271
275
|
* cms_url: CMS URL ("optional")
|
|
272
276
|
* portal_url: Portal URL ("optional")
|
|
273
|
-
* @param requestBody
|
|
274
277
|
* @returns PlatformList
|
|
275
278
|
* @throws ApiError
|
|
276
279
|
*/
|
|
277
|
-
public static coreLauncherCreate(
|
|
280
|
+
public static coreLauncherCreate({
|
|
281
|
+
requestBody,
|
|
282
|
+
}: {
|
|
278
283
|
requestBody: LauncherViewPostRequest,
|
|
279
|
-
): CancelablePromise<PlatformList> {
|
|
284
|
+
}): CancelablePromise<PlatformList> {
|
|
280
285
|
return __request(OpenAPI, {
|
|
281
286
|
method: 'POST',
|
|
282
287
|
url: '/api/core/launcher/',
|
|
@@ -286,13 +291,17 @@ export class CoreService {
|
|
|
286
291
|
}
|
|
287
292
|
/**
|
|
288
293
|
* List your LTI Provider Key's
|
|
289
|
-
* @param platformKey Platform Key
|
|
290
294
|
* @returns LtiKey
|
|
291
295
|
* @throws ApiError
|
|
292
296
|
*/
|
|
293
|
-
public static coreLti1P3ProviderLtiKeysList(
|
|
297
|
+
public static coreLti1P3ProviderLtiKeysList({
|
|
298
|
+
platformKey,
|
|
299
|
+
}: {
|
|
300
|
+
/**
|
|
301
|
+
* Platform Key
|
|
302
|
+
*/
|
|
294
303
|
platformKey: string,
|
|
295
|
-
): CancelablePromise<Array<LtiKey>> {
|
|
304
|
+
}): CancelablePromise<Array<LtiKey>> {
|
|
296
305
|
return __request(OpenAPI, {
|
|
297
306
|
method: 'GET',
|
|
298
307
|
url: '/api/core/lti/1p3/provider/lti-keys/',
|
|
@@ -303,13 +312,14 @@ export class CoreService {
|
|
|
303
312
|
}
|
|
304
313
|
/**
|
|
305
314
|
* Create a new LTI Provider Key
|
|
306
|
-
* @param requestBody
|
|
307
315
|
* @returns LtiKey
|
|
308
316
|
* @throws ApiError
|
|
309
317
|
*/
|
|
310
|
-
public static coreLti1P3ProviderLtiKeysCreate(
|
|
318
|
+
public static coreLti1P3ProviderLtiKeysCreate({
|
|
319
|
+
requestBody,
|
|
320
|
+
}: {
|
|
311
321
|
requestBody: LtiKey,
|
|
312
|
-
): CancelablePromise<LtiKey> {
|
|
322
|
+
}): CancelablePromise<LtiKey> {
|
|
313
323
|
return __request(OpenAPI, {
|
|
314
324
|
method: 'POST',
|
|
315
325
|
url: '/api/core/lti/1p3/provider/lti-keys/',
|
|
@@ -319,15 +329,19 @@ export class CoreService {
|
|
|
319
329
|
}
|
|
320
330
|
/**
|
|
321
331
|
* Get details about a specific LTI Provider Key
|
|
322
|
-
* @param id
|
|
323
|
-
* @param platformKey Platform Key
|
|
324
332
|
* @returns LtiKey
|
|
325
333
|
* @throws ApiError
|
|
326
334
|
*/
|
|
327
|
-
public static coreLti1P3ProviderLtiKeysRetrieve(
|
|
335
|
+
public static coreLti1P3ProviderLtiKeysRetrieve({
|
|
336
|
+
id,
|
|
337
|
+
platformKey,
|
|
338
|
+
}: {
|
|
328
339
|
id: string,
|
|
340
|
+
/**
|
|
341
|
+
* Platform Key
|
|
342
|
+
*/
|
|
329
343
|
platformKey: string,
|
|
330
|
-
): CancelablePromise<LtiKey> {
|
|
344
|
+
}): CancelablePromise<LtiKey> {
|
|
331
345
|
return __request(OpenAPI, {
|
|
332
346
|
method: 'GET',
|
|
333
347
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -341,15 +355,16 @@ export class CoreService {
|
|
|
341
355
|
}
|
|
342
356
|
/**
|
|
343
357
|
* Update an LTI Provider Key
|
|
344
|
-
* @param id
|
|
345
|
-
* @param requestBody
|
|
346
358
|
* @returns LtiKey
|
|
347
359
|
* @throws ApiError
|
|
348
360
|
*/
|
|
349
|
-
public static coreLti1P3ProviderLtiKeysUpdate(
|
|
361
|
+
public static coreLti1P3ProviderLtiKeysUpdate({
|
|
362
|
+
id,
|
|
363
|
+
requestBody,
|
|
364
|
+
}: {
|
|
350
365
|
id: string,
|
|
351
366
|
requestBody: LtiKey,
|
|
352
|
-
): CancelablePromise<LtiKey> {
|
|
367
|
+
}): CancelablePromise<LtiKey> {
|
|
353
368
|
return __request(OpenAPI, {
|
|
354
369
|
method: 'PUT',
|
|
355
370
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -364,15 +379,19 @@ export class CoreService {
|
|
|
364
379
|
* Delete an LTI Provider Key
|
|
365
380
|
*
|
|
366
381
|
* **DANGER:** Deleting a key will also delete all Tools that reference that Key. If you need to delete a Key you should first create a new one and update all Tools to reference the new Key before deleting the old one.
|
|
367
|
-
* @param id
|
|
368
|
-
* @param platformKey Platform Key
|
|
369
382
|
* @returns void
|
|
370
383
|
* @throws ApiError
|
|
371
384
|
*/
|
|
372
|
-
public static coreLti1P3ProviderLtiKeysDestroy(
|
|
385
|
+
public static coreLti1P3ProviderLtiKeysDestroy({
|
|
386
|
+
id,
|
|
387
|
+
platformKey,
|
|
388
|
+
}: {
|
|
373
389
|
id: string,
|
|
390
|
+
/**
|
|
391
|
+
* Platform Key
|
|
392
|
+
*/
|
|
374
393
|
platformKey: string,
|
|
375
|
-
): CancelablePromise<void> {
|
|
394
|
+
}): CancelablePromise<void> {
|
|
376
395
|
return __request(OpenAPI, {
|
|
377
396
|
method: 'DELETE',
|
|
378
397
|
url: '/api/core/lti/1p3/provider/lti-keys/{id}/',
|
|
@@ -386,13 +405,17 @@ export class CoreService {
|
|
|
386
405
|
}
|
|
387
406
|
/**
|
|
388
407
|
* List your LTI Tool's
|
|
389
|
-
* @param platformKey Platform Key
|
|
390
408
|
* @returns LtiTool
|
|
391
409
|
* @throws ApiError
|
|
392
410
|
*/
|
|
393
|
-
public static coreLti1P3ProviderLtiToolsList(
|
|
411
|
+
public static coreLti1P3ProviderLtiToolsList({
|
|
412
|
+
platformKey,
|
|
413
|
+
}: {
|
|
414
|
+
/**
|
|
415
|
+
* Platform Key
|
|
416
|
+
*/
|
|
394
417
|
platformKey: string,
|
|
395
|
-
): CancelablePromise<Array<LtiTool>> {
|
|
418
|
+
}): CancelablePromise<Array<LtiTool>> {
|
|
396
419
|
return __request(OpenAPI, {
|
|
397
420
|
method: 'GET',
|
|
398
421
|
url: '/api/core/lti/1p3/provider/lti-tools/',
|
|
@@ -403,13 +426,14 @@ export class CoreService {
|
|
|
403
426
|
}
|
|
404
427
|
/**
|
|
405
428
|
* Create a new LTI Tool
|
|
406
|
-
* @param requestBody
|
|
407
429
|
* @returns LtiTool
|
|
408
430
|
* @throws ApiError
|
|
409
431
|
*/
|
|
410
|
-
public static coreLti1P3ProviderLtiToolsCreate(
|
|
432
|
+
public static coreLti1P3ProviderLtiToolsCreate({
|
|
433
|
+
requestBody,
|
|
434
|
+
}: {
|
|
411
435
|
requestBody: LtiTool,
|
|
412
|
-
): CancelablePromise<LtiTool> {
|
|
436
|
+
}): CancelablePromise<LtiTool> {
|
|
413
437
|
return __request(OpenAPI, {
|
|
414
438
|
method: 'POST',
|
|
415
439
|
url: '/api/core/lti/1p3/provider/lti-tools/',
|
|
@@ -419,15 +443,19 @@ export class CoreService {
|
|
|
419
443
|
}
|
|
420
444
|
/**
|
|
421
445
|
* Get details about a specific LTI Tool
|
|
422
|
-
* @param id
|
|
423
|
-
* @param platformKey Platform Key
|
|
424
446
|
* @returns LtiTool
|
|
425
447
|
* @throws ApiError
|
|
426
448
|
*/
|
|
427
|
-
public static coreLti1P3ProviderLtiToolsRetrieve(
|
|
449
|
+
public static coreLti1P3ProviderLtiToolsRetrieve({
|
|
450
|
+
id,
|
|
451
|
+
platformKey,
|
|
452
|
+
}: {
|
|
428
453
|
id: string,
|
|
454
|
+
/**
|
|
455
|
+
* Platform Key
|
|
456
|
+
*/
|
|
429
457
|
platformKey: string,
|
|
430
|
-
): CancelablePromise<LtiTool> {
|
|
458
|
+
}): CancelablePromise<LtiTool> {
|
|
431
459
|
return __request(OpenAPI, {
|
|
432
460
|
method: 'GET',
|
|
433
461
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -441,15 +469,16 @@ export class CoreService {
|
|
|
441
469
|
}
|
|
442
470
|
/**
|
|
443
471
|
* Update an LTI Tool
|
|
444
|
-
* @param id
|
|
445
|
-
* @param requestBody
|
|
446
472
|
* @returns LtiTool
|
|
447
473
|
* @throws ApiError
|
|
448
474
|
*/
|
|
449
|
-
public static coreLti1P3ProviderLtiToolsUpdate(
|
|
475
|
+
public static coreLti1P3ProviderLtiToolsUpdate({
|
|
476
|
+
id,
|
|
477
|
+
requestBody,
|
|
478
|
+
}: {
|
|
450
479
|
id: string,
|
|
451
480
|
requestBody: LtiTool,
|
|
452
|
-
): CancelablePromise<LtiTool> {
|
|
481
|
+
}): CancelablePromise<LtiTool> {
|
|
453
482
|
return __request(OpenAPI, {
|
|
454
483
|
method: 'PUT',
|
|
455
484
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -462,15 +491,19 @@ export class CoreService {
|
|
|
462
491
|
}
|
|
463
492
|
/**
|
|
464
493
|
* Delete an LTI Tool
|
|
465
|
-
* @param id
|
|
466
|
-
* @param platformKey Platform Key
|
|
467
494
|
* @returns void
|
|
468
495
|
* @throws ApiError
|
|
469
496
|
*/
|
|
470
|
-
public static coreLti1P3ProviderLtiToolsDestroy(
|
|
497
|
+
public static coreLti1P3ProviderLtiToolsDestroy({
|
|
498
|
+
id,
|
|
499
|
+
platformKey,
|
|
500
|
+
}: {
|
|
471
501
|
id: string,
|
|
502
|
+
/**
|
|
503
|
+
* Platform Key
|
|
504
|
+
*/
|
|
472
505
|
platformKey: string,
|
|
473
|
-
): CancelablePromise<void> {
|
|
506
|
+
}): CancelablePromise<void> {
|
|
474
507
|
return __request(OpenAPI, {
|
|
475
508
|
method: 'DELETE',
|
|
476
509
|
url: '/api/core/lti/1p3/provider/lti-tools/{id}/',
|
|
@@ -484,13 +517,14 @@ export class CoreService {
|
|
|
484
517
|
}
|
|
485
518
|
/**
|
|
486
519
|
* Get platform logo
|
|
487
|
-
* @param org
|
|
488
520
|
* @returns any
|
|
489
521
|
* @throws ApiError
|
|
490
522
|
*/
|
|
491
|
-
public static coreOrgsDarkModeLogoRetrieve(
|
|
523
|
+
public static coreOrgsDarkModeLogoRetrieve({
|
|
524
|
+
org,
|
|
525
|
+
}: {
|
|
492
526
|
org: string,
|
|
493
|
-
): CancelablePromise<Record<string, any>> {
|
|
527
|
+
}): CancelablePromise<Record<string, any>> {
|
|
494
528
|
return __request(OpenAPI, {
|
|
495
529
|
method: 'GET',
|
|
496
530
|
url: '/api/core/orgs/{org}/dark-mode-logo/',
|
|
@@ -501,15 +535,16 @@ export class CoreService {
|
|
|
501
535
|
}
|
|
502
536
|
/**
|
|
503
537
|
* Upload a new platform logo
|
|
504
|
-
* @param org
|
|
505
|
-
* @param requestBody
|
|
506
538
|
* @returns ImageUpload
|
|
507
539
|
* @throws ApiError
|
|
508
540
|
*/
|
|
509
|
-
public static coreOrgsDarkModeLogoCreateCreate(
|
|
541
|
+
public static coreOrgsDarkModeLogoCreateCreate({
|
|
542
|
+
org,
|
|
543
|
+
requestBody,
|
|
544
|
+
}: {
|
|
510
545
|
org: string,
|
|
511
546
|
requestBody: ImageUpload,
|
|
512
|
-
): CancelablePromise<ImageUpload> {
|
|
547
|
+
}): CancelablePromise<ImageUpload> {
|
|
513
548
|
return __request(OpenAPI, {
|
|
514
549
|
method: 'POST',
|
|
515
550
|
url: '/api/core/orgs/{org}/dark-mode-logo/create/',
|
|
@@ -522,13 +557,14 @@ export class CoreService {
|
|
|
522
557
|
}
|
|
523
558
|
/**
|
|
524
559
|
* Get platform logo
|
|
525
|
-
* @param org
|
|
526
560
|
* @returns any
|
|
527
561
|
* @throws ApiError
|
|
528
562
|
*/
|
|
529
|
-
public static coreOrgsFaviconRetrieve(
|
|
563
|
+
public static coreOrgsFaviconRetrieve({
|
|
564
|
+
org,
|
|
565
|
+
}: {
|
|
530
566
|
org: string,
|
|
531
|
-
): CancelablePromise<Record<string, any>> {
|
|
567
|
+
}): CancelablePromise<Record<string, any>> {
|
|
532
568
|
return __request(OpenAPI, {
|
|
533
569
|
method: 'GET',
|
|
534
570
|
url: '/api/core/orgs/{org}/favicon/',
|
|
@@ -539,15 +575,16 @@ export class CoreService {
|
|
|
539
575
|
}
|
|
540
576
|
/**
|
|
541
577
|
* Upload a new platform logo
|
|
542
|
-
* @param org
|
|
543
|
-
* @param requestBody
|
|
544
578
|
* @returns ImageUpload
|
|
545
579
|
* @throws ApiError
|
|
546
580
|
*/
|
|
547
|
-
public static coreOrgsFaviconCreateCreate(
|
|
581
|
+
public static coreOrgsFaviconCreateCreate({
|
|
582
|
+
org,
|
|
583
|
+
requestBody,
|
|
584
|
+
}: {
|
|
548
585
|
org: string,
|
|
549
586
|
requestBody: ImageUpload,
|
|
550
|
-
): CancelablePromise<ImageUpload> {
|
|
587
|
+
}): CancelablePromise<ImageUpload> {
|
|
551
588
|
return __request(OpenAPI, {
|
|
552
589
|
method: 'POST',
|
|
553
590
|
url: '/api/core/orgs/{org}/favicon/create/',
|
|
@@ -560,13 +597,14 @@ export class CoreService {
|
|
|
560
597
|
}
|
|
561
598
|
/**
|
|
562
599
|
* Get platform logo
|
|
563
|
-
* @param org
|
|
564
600
|
* @returns any
|
|
565
601
|
* @throws ApiError
|
|
566
602
|
*/
|
|
567
|
-
public static coreOrgsLogoRetrieve(
|
|
603
|
+
public static coreOrgsLogoRetrieve({
|
|
604
|
+
org,
|
|
605
|
+
}: {
|
|
568
606
|
org: string,
|
|
569
|
-
): CancelablePromise<Record<string, any>> {
|
|
607
|
+
}): CancelablePromise<Record<string, any>> {
|
|
570
608
|
return __request(OpenAPI, {
|
|
571
609
|
method: 'GET',
|
|
572
610
|
url: '/api/core/orgs/{org}/logo/',
|
|
@@ -577,15 +615,16 @@ export class CoreService {
|
|
|
577
615
|
}
|
|
578
616
|
/**
|
|
579
617
|
* Upload a new platform logo
|
|
580
|
-
* @param org
|
|
581
|
-
* @param requestBody
|
|
582
618
|
* @returns ImageUpload
|
|
583
619
|
* @throws ApiError
|
|
584
620
|
*/
|
|
585
|
-
public static coreOrgsLogoCreateCreate(
|
|
621
|
+
public static coreOrgsLogoCreateCreate({
|
|
622
|
+
org,
|
|
623
|
+
requestBody,
|
|
624
|
+
}: {
|
|
586
625
|
org: string,
|
|
587
626
|
requestBody: ImageUpload,
|
|
588
|
-
): CancelablePromise<ImageUpload> {
|
|
627
|
+
}): CancelablePromise<ImageUpload> {
|
|
589
628
|
return __request(OpenAPI, {
|
|
590
629
|
method: 'POST',
|
|
591
630
|
url: '/api/core/orgs/{org}/logo/create/',
|
|
@@ -597,13 +636,14 @@ export class CoreService {
|
|
|
597
636
|
});
|
|
598
637
|
}
|
|
599
638
|
/**
|
|
600
|
-
* @param org
|
|
601
639
|
* @returns PlatformPublicMetadata
|
|
602
640
|
* @throws ApiError
|
|
603
641
|
*/
|
|
604
|
-
public static coreOrgsMetadataRetrieve(
|
|
642
|
+
public static coreOrgsMetadataRetrieve({
|
|
643
|
+
org,
|
|
644
|
+
}: {
|
|
605
645
|
org: string,
|
|
606
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
646
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
607
647
|
return __request(OpenAPI, {
|
|
608
648
|
method: 'GET',
|
|
609
649
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -613,15 +653,16 @@ export class CoreService {
|
|
|
613
653
|
});
|
|
614
654
|
}
|
|
615
655
|
/**
|
|
616
|
-
* @param org
|
|
617
|
-
* @param requestBody
|
|
618
656
|
* @returns PlatformPublicMetadata
|
|
619
657
|
* @throws ApiError
|
|
620
658
|
*/
|
|
621
|
-
public static coreOrgsMetadataUpdate(
|
|
659
|
+
public static coreOrgsMetadataUpdate({
|
|
660
|
+
org,
|
|
661
|
+
requestBody,
|
|
662
|
+
}: {
|
|
622
663
|
org: string,
|
|
623
664
|
requestBody?: PlatformPublicMetadata,
|
|
624
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
665
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
625
666
|
return __request(OpenAPI, {
|
|
626
667
|
method: 'PUT',
|
|
627
668
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -633,15 +674,16 @@ export class CoreService {
|
|
|
633
674
|
});
|
|
634
675
|
}
|
|
635
676
|
/**
|
|
636
|
-
* @param org
|
|
637
|
-
* @param requestBody
|
|
638
677
|
* @returns PlatformPublicMetadata
|
|
639
678
|
* @throws ApiError
|
|
640
679
|
*/
|
|
641
|
-
public static coreOrgsMetadataPartialUpdate(
|
|
680
|
+
public static coreOrgsMetadataPartialUpdate({
|
|
681
|
+
org,
|
|
682
|
+
requestBody,
|
|
683
|
+
}: {
|
|
642
684
|
org: string,
|
|
643
685
|
requestBody?: PatchedPlatformPublicMetadata,
|
|
644
|
-
): CancelablePromise<PlatformPublicMetadata> {
|
|
686
|
+
}): CancelablePromise<PlatformPublicMetadata> {
|
|
645
687
|
return __request(OpenAPI, {
|
|
646
688
|
method: 'PATCH',
|
|
647
689
|
url: '/api/core/orgs/{org}/metadata/',
|
|
@@ -654,15 +696,16 @@ export class CoreService {
|
|
|
654
696
|
}
|
|
655
697
|
/**
|
|
656
698
|
* Creates redirect tokens for a URL specified by for a platform
|
|
657
|
-
* @param org
|
|
658
|
-
* @param requestBody
|
|
659
699
|
* @returns RedirectTokenResponse
|
|
660
700
|
* @throws ApiError
|
|
661
701
|
*/
|
|
662
|
-
public static coreOrgsRedirectTokensCreate(
|
|
702
|
+
public static coreOrgsRedirectTokensCreate({
|
|
703
|
+
org,
|
|
704
|
+
requestBody,
|
|
705
|
+
}: {
|
|
663
706
|
org: string,
|
|
664
707
|
requestBody: RedirectTokenRequest,
|
|
665
|
-
): CancelablePromise<RedirectTokenResponse> {
|
|
708
|
+
}): CancelablePromise<RedirectTokenResponse> {
|
|
666
709
|
return __request(OpenAPI, {
|
|
667
710
|
method: 'POST',
|
|
668
711
|
url: '/api/core/orgs/{org}/redirect-tokens/',
|
|
@@ -679,15 +722,16 @@ export class CoreService {
|
|
|
679
722
|
* ```
|
|
680
723
|
* Requires user to be a member of the platform with the token passed
|
|
681
724
|
* ```
|
|
682
|
-
* @param org
|
|
683
|
-
* @param redirectToken
|
|
684
725
|
* @returns RedirectTokenResponse
|
|
685
726
|
* @throws ApiError
|
|
686
727
|
*/
|
|
687
|
-
public static coreOrgsRedirectTokensRetrieve(
|
|
728
|
+
public static coreOrgsRedirectTokensRetrieve({
|
|
729
|
+
org,
|
|
730
|
+
redirectToken,
|
|
731
|
+
}: {
|
|
688
732
|
org: string,
|
|
689
733
|
redirectToken: string,
|
|
690
|
-
): CancelablePromise<RedirectTokenResponse> {
|
|
734
|
+
}): CancelablePromise<RedirectTokenResponse> {
|
|
691
735
|
return __request(OpenAPI, {
|
|
692
736
|
method: 'GET',
|
|
693
737
|
url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/',
|
|
@@ -699,15 +743,16 @@ export class CoreService {
|
|
|
699
743
|
}
|
|
700
744
|
/**
|
|
701
745
|
* Delete specific token
|
|
702
|
-
* @param org
|
|
703
|
-
* @param redirectToken
|
|
704
746
|
* @returns void
|
|
705
747
|
* @throws ApiError
|
|
706
748
|
*/
|
|
707
|
-
public static coreOrgsRedirectTokensDeleteDestroy(
|
|
749
|
+
public static coreOrgsRedirectTokensDeleteDestroy({
|
|
750
|
+
org,
|
|
751
|
+
redirectToken,
|
|
752
|
+
}: {
|
|
708
753
|
org: string,
|
|
709
754
|
redirectToken: string,
|
|
710
|
-
): CancelablePromise<void> {
|
|
755
|
+
}): CancelablePromise<void> {
|
|
711
756
|
return __request(OpenAPI, {
|
|
712
757
|
method: 'DELETE',
|
|
713
758
|
url: '/api/core/orgs/{org}/redirect-tokens/{redirect_token}/delete',
|
|
@@ -719,13 +764,14 @@ export class CoreService {
|
|
|
719
764
|
}
|
|
720
765
|
/**
|
|
721
766
|
* Get platform logo
|
|
722
|
-
* @param org
|
|
723
767
|
* @returns any
|
|
724
768
|
* @throws ApiError
|
|
725
769
|
*/
|
|
726
|
-
public static coreOrgsThumbnailRetrieve(
|
|
770
|
+
public static coreOrgsThumbnailRetrieve({
|
|
771
|
+
org,
|
|
772
|
+
}: {
|
|
727
773
|
org: string,
|
|
728
|
-
): CancelablePromise<Record<string, any>> {
|
|
774
|
+
}): CancelablePromise<Record<string, any>> {
|
|
729
775
|
return __request(OpenAPI, {
|
|
730
776
|
method: 'GET',
|
|
731
777
|
url: '/api/core/orgs/{org}/thumbnail/',
|
|
@@ -736,15 +782,16 @@ export class CoreService {
|
|
|
736
782
|
}
|
|
737
783
|
/**
|
|
738
784
|
* Upload a new platform logo
|
|
739
|
-
* @param org
|
|
740
|
-
* @param requestBody
|
|
741
785
|
* @returns ImageUpload
|
|
742
786
|
* @throws ApiError
|
|
743
787
|
*/
|
|
744
|
-
public static coreOrgsThumbnailCreateCreate(
|
|
788
|
+
public static coreOrgsThumbnailCreateCreate({
|
|
789
|
+
org,
|
|
790
|
+
requestBody,
|
|
791
|
+
}: {
|
|
745
792
|
org: string,
|
|
746
793
|
requestBody: ImageUpload,
|
|
747
|
-
): CancelablePromise<ImageUpload> {
|
|
794
|
+
}): CancelablePromise<ImageUpload> {
|
|
748
795
|
return __request(OpenAPI, {
|
|
749
796
|
method: 'POST',
|
|
750
797
|
url: '/api/core/orgs/{org}/thumbnail/create/',
|
|
@@ -767,15 +814,16 @@ export class CoreService {
|
|
|
767
814
|
* key
|
|
768
815
|
* field_key (POST)
|
|
769
816
|
* value (POST)
|
|
770
|
-
* @param key
|
|
771
|
-
* @param userId
|
|
772
817
|
* @returns PlatformList
|
|
773
818
|
* @throws ApiError
|
|
774
819
|
*/
|
|
775
|
-
public static corePlatformRetrieve(
|
|
820
|
+
public static corePlatformRetrieve({
|
|
821
|
+
key,
|
|
822
|
+
userId,
|
|
823
|
+
}: {
|
|
776
824
|
key: string,
|
|
777
825
|
userId?: number,
|
|
778
|
-
): CancelablePromise<PlatformList> {
|
|
826
|
+
}): CancelablePromise<PlatformList> {
|
|
779
827
|
return __request(OpenAPI, {
|
|
780
828
|
method: 'GET',
|
|
781
829
|
url: '/api/core/platform/',
|
|
@@ -799,13 +847,14 @@ export class CoreService {
|
|
|
799
847
|
* lms_url
|
|
800
848
|
* cms_url
|
|
801
849
|
* portal_url
|
|
802
|
-
* @param requestBody
|
|
803
850
|
* @returns PlatformList
|
|
804
851
|
* @throws ApiError
|
|
805
852
|
*/
|
|
806
|
-
public static corePlatformCreate(
|
|
853
|
+
public static corePlatformCreate({
|
|
854
|
+
requestBody,
|
|
855
|
+
}: {
|
|
807
856
|
requestBody: PlatformUpdatePostRequest,
|
|
808
|
-
): CancelablePromise<PlatformList> {
|
|
857
|
+
}): CancelablePromise<PlatformList> {
|
|
809
858
|
return __request(OpenAPI, {
|
|
810
859
|
method: 'POST',
|
|
811
860
|
url: '/api/core/platform/',
|
|
@@ -815,13 +864,17 @@ export class CoreService {
|
|
|
815
864
|
}
|
|
816
865
|
/**
|
|
817
866
|
* List Platform API Key's belonging to the target platform
|
|
818
|
-
* @param platformKey Platform key of target platform
|
|
819
867
|
* @returns PlatformApiKey
|
|
820
868
|
* @throws ApiError
|
|
821
869
|
*/
|
|
822
|
-
public static corePlatformApiTokensList(
|
|
870
|
+
public static corePlatformApiTokensList({
|
|
871
|
+
platformKey,
|
|
872
|
+
}: {
|
|
873
|
+
/**
|
|
874
|
+
* Platform key of target platform
|
|
875
|
+
*/
|
|
823
876
|
platformKey: string,
|
|
824
|
-
): CancelablePromise<Array<PlatformApiKey>> {
|
|
877
|
+
}): CancelablePromise<Array<PlatformApiKey>> {
|
|
825
878
|
return __request(OpenAPI, {
|
|
826
879
|
method: 'GET',
|
|
827
880
|
url: '/api/core/platform/api-tokens/',
|
|
@@ -832,13 +885,14 @@ export class CoreService {
|
|
|
832
885
|
}
|
|
833
886
|
/**
|
|
834
887
|
* Create a new Platform Api Key for the target platform
|
|
835
|
-
* @param requestBody
|
|
836
888
|
* @returns PlatformApiKey
|
|
837
889
|
* @throws ApiError
|
|
838
890
|
*/
|
|
839
|
-
public static corePlatformApiTokensCreate(
|
|
891
|
+
public static corePlatformApiTokensCreate({
|
|
892
|
+
requestBody,
|
|
893
|
+
}: {
|
|
840
894
|
requestBody: PlatformApiKey,
|
|
841
|
-
): CancelablePromise<PlatformApiKey> {
|
|
895
|
+
}): CancelablePromise<PlatformApiKey> {
|
|
842
896
|
return __request(OpenAPI, {
|
|
843
897
|
method: 'POST',
|
|
844
898
|
url: '/api/core/platform/api-tokens/',
|
|
@@ -848,15 +902,19 @@ export class CoreService {
|
|
|
848
902
|
}
|
|
849
903
|
/**
|
|
850
904
|
* Delete Platform Api Key by name in the target platform
|
|
851
|
-
* @param name
|
|
852
|
-
* @param platformKey Platform key of target platform
|
|
853
905
|
* @returns void
|
|
854
906
|
* @throws ApiError
|
|
855
907
|
*/
|
|
856
|
-
public static corePlatformApiTokensDestroy(
|
|
908
|
+
public static corePlatformApiTokensDestroy({
|
|
909
|
+
name,
|
|
910
|
+
platformKey,
|
|
911
|
+
}: {
|
|
857
912
|
name: string,
|
|
913
|
+
/**
|
|
914
|
+
* Platform key of target platform
|
|
915
|
+
*/
|
|
858
916
|
platformKey: string,
|
|
859
|
-
): CancelablePromise<void> {
|
|
917
|
+
}): CancelablePromise<void> {
|
|
860
918
|
return __request(OpenAPI, {
|
|
861
919
|
method: 'DELETE',
|
|
862
920
|
url: '/api/core/platform/api-tokens/{name}',
|
|
@@ -880,15 +938,16 @@ export class CoreService {
|
|
|
880
938
|
* key
|
|
881
939
|
* field_key (POST)
|
|
882
940
|
* value (POST)
|
|
883
|
-
* @param key
|
|
884
|
-
* @param userId
|
|
885
941
|
* @returns any
|
|
886
942
|
* @throws ApiError
|
|
887
943
|
*/
|
|
888
|
-
public static corePlatformConfigSiteRetrieve(
|
|
944
|
+
public static corePlatformConfigSiteRetrieve({
|
|
945
|
+
key,
|
|
946
|
+
userId,
|
|
947
|
+
}: {
|
|
889
948
|
key: string,
|
|
890
949
|
userId?: number,
|
|
891
|
-
): CancelablePromise<Record<string, any>> {
|
|
950
|
+
}): CancelablePromise<Record<string, any>> {
|
|
892
951
|
return __request(OpenAPI, {
|
|
893
952
|
method: 'GET',
|
|
894
953
|
url: '/api/core/platform/config/site/',
|
|
@@ -910,13 +969,14 @@ export class CoreService {
|
|
|
910
969
|
* key
|
|
911
970
|
* field_key (POST)
|
|
912
971
|
* value (POST)
|
|
913
|
-
* @param requestBody
|
|
914
972
|
* @returns any
|
|
915
973
|
* @throws ApiError
|
|
916
974
|
*/
|
|
917
|
-
public static corePlatformConfigSiteCreate(
|
|
975
|
+
public static corePlatformConfigSiteCreate({
|
|
976
|
+
requestBody,
|
|
977
|
+
}: {
|
|
918
978
|
requestBody?: Record<string, any>,
|
|
919
|
-
): CancelablePromise<Record<string, any>> {
|
|
979
|
+
}): CancelablePromise<Record<string, any>> {
|
|
920
980
|
return __request(OpenAPI, {
|
|
921
981
|
method: 'POST',
|
|
922
982
|
url: '/api/core/platform/config/site/',
|
|
@@ -935,23 +995,24 @@ export class CoreService {
|
|
|
935
995
|
* sort
|
|
936
996
|
*
|
|
937
997
|
* is_admin: Return tenant admin users
|
|
938
|
-
* @param page
|
|
939
|
-
* @param pageSize
|
|
940
|
-
* @param platformKey
|
|
941
|
-
* @param platformOrg
|
|
942
|
-
* @param query
|
|
943
|
-
* @param sort
|
|
944
998
|
* @returns UserPlatformManagementListViewGetResponse
|
|
945
999
|
* @throws ApiError
|
|
946
1000
|
*/
|
|
947
|
-
public static corePlatformUsersRetrieve(
|
|
1001
|
+
public static corePlatformUsersRetrieve({
|
|
1002
|
+
page,
|
|
1003
|
+
pageSize,
|
|
1004
|
+
platformKey,
|
|
1005
|
+
platformOrg,
|
|
1006
|
+
query,
|
|
1007
|
+
sort,
|
|
1008
|
+
}: {
|
|
948
1009
|
page?: number,
|
|
949
1010
|
pageSize?: number,
|
|
950
1011
|
platformKey?: string,
|
|
951
1012
|
platformOrg?: string,
|
|
952
1013
|
query?: string,
|
|
953
1014
|
sort?: string,
|
|
954
|
-
): CancelablePromise<UserPlatformManagementListViewGetResponse> {
|
|
1015
|
+
}): CancelablePromise<UserPlatformManagementListViewGetResponse> {
|
|
955
1016
|
return __request(OpenAPI, {
|
|
956
1017
|
method: 'GET',
|
|
957
1018
|
url: '/api/core/platform/users/',
|
|
@@ -968,21 +1029,37 @@ export class CoreService {
|
|
|
968
1029
|
/**
|
|
969
1030
|
* List group role assignments
|
|
970
1031
|
* Retrieve a list of group role assignments. Can be filtered by platform_key, group_id, or role_id.
|
|
971
|
-
* @param groupId Filter group roles by group ID
|
|
972
|
-
* @param page A page number within the paginated result set.
|
|
973
|
-
* @param pageSize Number of results to return per page.
|
|
974
|
-
* @param platformKey Filter group roles by platform key
|
|
975
|
-
* @param roleId Filter group roles by role ID
|
|
976
1032
|
* @returns PaginatedRbacGroupRoleList
|
|
977
1033
|
* @throws ApiError
|
|
978
1034
|
*/
|
|
979
|
-
public static coreRbacGroupRolesList(
|
|
1035
|
+
public static coreRbacGroupRolesList({
|
|
1036
|
+
groupId,
|
|
1037
|
+
page,
|
|
1038
|
+
pageSize,
|
|
1039
|
+
platformKey,
|
|
1040
|
+
roleId,
|
|
1041
|
+
}: {
|
|
1042
|
+
/**
|
|
1043
|
+
* Filter group roles by group ID
|
|
1044
|
+
*/
|
|
980
1045
|
groupId?: number,
|
|
1046
|
+
/**
|
|
1047
|
+
* A page number within the paginated result set.
|
|
1048
|
+
*/
|
|
981
1049
|
page?: number,
|
|
1050
|
+
/**
|
|
1051
|
+
* Number of results to return per page.
|
|
1052
|
+
*/
|
|
982
1053
|
pageSize?: number,
|
|
1054
|
+
/**
|
|
1055
|
+
* Filter group roles by platform key
|
|
1056
|
+
*/
|
|
983
1057
|
platformKey?: string,
|
|
1058
|
+
/**
|
|
1059
|
+
* Filter group roles by role ID
|
|
1060
|
+
*/
|
|
984
1061
|
roleId?: number,
|
|
985
|
-
): CancelablePromise<PaginatedRbacGroupRoleList> {
|
|
1062
|
+
}): CancelablePromise<PaginatedRbacGroupRoleList> {
|
|
986
1063
|
return __request(OpenAPI, {
|
|
987
1064
|
method: 'GET',
|
|
988
1065
|
url: '/api/core/rbac/group-roles/',
|
|
@@ -998,13 +1075,14 @@ export class CoreService {
|
|
|
998
1075
|
/**
|
|
999
1076
|
* Create group role assignment
|
|
1000
1077
|
* Assign a role to a group. The group and role must belong to the same platform.
|
|
1001
|
-
* @param requestBody
|
|
1002
1078
|
* @returns RbacGroupRole
|
|
1003
1079
|
* @throws ApiError
|
|
1004
1080
|
*/
|
|
1005
|
-
public static coreRbacGroupRolesCreate(
|
|
1081
|
+
public static coreRbacGroupRolesCreate({
|
|
1082
|
+
requestBody,
|
|
1083
|
+
}: {
|
|
1006
1084
|
requestBody: RbacGroupRole,
|
|
1007
|
-
): CancelablePromise<RbacGroupRole> {
|
|
1085
|
+
}): CancelablePromise<RbacGroupRole> {
|
|
1008
1086
|
return __request(OpenAPI, {
|
|
1009
1087
|
method: 'POST',
|
|
1010
1088
|
url: '/api/core/rbac/group-roles/',
|
|
@@ -1021,13 +1099,17 @@ export class CoreService {
|
|
|
1021
1099
|
/**
|
|
1022
1100
|
* Retrieve group role assignment
|
|
1023
1101
|
* Retrieve details of a specific group role assignment.
|
|
1024
|
-
* @param id A unique integer value identifying this RBAC Group Role.
|
|
1025
1102
|
* @returns RbacGroupRole
|
|
1026
1103
|
* @throws ApiError
|
|
1027
1104
|
*/
|
|
1028
|
-
public static coreRbacGroupRolesRetrieve(
|
|
1105
|
+
public static coreRbacGroupRolesRetrieve({
|
|
1106
|
+
id,
|
|
1107
|
+
}: {
|
|
1108
|
+
/**
|
|
1109
|
+
* A unique integer value identifying this RBAC Group Role.
|
|
1110
|
+
*/
|
|
1029
1111
|
id: number,
|
|
1030
|
-
): CancelablePromise<RbacGroupRole> {
|
|
1112
|
+
}): CancelablePromise<RbacGroupRole> {
|
|
1031
1113
|
return __request(OpenAPI, {
|
|
1032
1114
|
method: 'GET',
|
|
1033
1115
|
url: '/api/core/rbac/group-roles/{id}/',
|
|
@@ -1042,15 +1124,19 @@ export class CoreService {
|
|
|
1042
1124
|
/**
|
|
1043
1125
|
* Update group role assignment
|
|
1044
1126
|
* Update an existing group role assignment. Platform validation applies.
|
|
1045
|
-
* @param id A unique integer value identifying this RBAC Group Role.
|
|
1046
|
-
* @param requestBody
|
|
1047
1127
|
* @returns RbacGroupRole
|
|
1048
1128
|
* @throws ApiError
|
|
1049
1129
|
*/
|
|
1050
|
-
public static coreRbacGroupRolesUpdate(
|
|
1130
|
+
public static coreRbacGroupRolesUpdate({
|
|
1131
|
+
id,
|
|
1132
|
+
requestBody,
|
|
1133
|
+
}: {
|
|
1134
|
+
/**
|
|
1135
|
+
* A unique integer value identifying this RBAC Group Role.
|
|
1136
|
+
*/
|
|
1051
1137
|
id: number,
|
|
1052
1138
|
requestBody: RbacGroupRole,
|
|
1053
|
-
): CancelablePromise<RbacGroupRole> {
|
|
1139
|
+
}): CancelablePromise<RbacGroupRole> {
|
|
1054
1140
|
return __request(OpenAPI, {
|
|
1055
1141
|
method: 'PUT',
|
|
1056
1142
|
url: '/api/core/rbac/group-roles/{id}/',
|
|
@@ -1071,15 +1157,19 @@ export class CoreService {
|
|
|
1071
1157
|
/**
|
|
1072
1158
|
* Partially update group role assignment
|
|
1073
1159
|
* Partially update an existing group role assignment. Platform validation applies.
|
|
1074
|
-
* @param id A unique integer value identifying this RBAC Group Role.
|
|
1075
|
-
* @param requestBody
|
|
1076
1160
|
* @returns RbacGroupRole
|
|
1077
1161
|
* @throws ApiError
|
|
1078
1162
|
*/
|
|
1079
|
-
public static coreRbacGroupRolesPartialUpdate(
|
|
1163
|
+
public static coreRbacGroupRolesPartialUpdate({
|
|
1164
|
+
id,
|
|
1165
|
+
requestBody,
|
|
1166
|
+
}: {
|
|
1167
|
+
/**
|
|
1168
|
+
* A unique integer value identifying this RBAC Group Role.
|
|
1169
|
+
*/
|
|
1080
1170
|
id: number,
|
|
1081
1171
|
requestBody?: PatchedRbacGroupRole,
|
|
1082
|
-
): CancelablePromise<RbacGroupRole> {
|
|
1172
|
+
}): CancelablePromise<RbacGroupRole> {
|
|
1083
1173
|
return __request(OpenAPI, {
|
|
1084
1174
|
method: 'PATCH',
|
|
1085
1175
|
url: '/api/core/rbac/group-roles/{id}/',
|
|
@@ -1100,13 +1190,17 @@ export class CoreService {
|
|
|
1100
1190
|
/**
|
|
1101
1191
|
* Delete group role assignment
|
|
1102
1192
|
* Remove a role assignment from a group.
|
|
1103
|
-
* @param id A unique integer value identifying this RBAC Group Role.
|
|
1104
1193
|
* @returns void
|
|
1105
1194
|
* @throws ApiError
|
|
1106
1195
|
*/
|
|
1107
|
-
public static coreRbacGroupRolesDestroy(
|
|
1196
|
+
public static coreRbacGroupRolesDestroy({
|
|
1197
|
+
id,
|
|
1198
|
+
}: {
|
|
1199
|
+
/**
|
|
1200
|
+
* A unique integer value identifying this RBAC Group Role.
|
|
1201
|
+
*/
|
|
1108
1202
|
id: number,
|
|
1109
|
-
): CancelablePromise<void> {
|
|
1203
|
+
}): CancelablePromise<void> {
|
|
1110
1204
|
return __request(OpenAPI, {
|
|
1111
1205
|
method: 'DELETE',
|
|
1112
1206
|
url: '/api/core/rbac/group-roles/{id}/',
|
|
@@ -1121,17 +1215,27 @@ export class CoreService {
|
|
|
1121
1215
|
/**
|
|
1122
1216
|
* List RBAC groups
|
|
1123
1217
|
* Retrieve a list of RBAC groups. Can be filtered by platform_key.
|
|
1124
|
-
* @param page A page number within the paginated result set.
|
|
1125
|
-
* @param pageSize Number of results to return per page.
|
|
1126
|
-
* @param platformKey Filter groups by platform key
|
|
1127
1218
|
* @returns PaginatedRbacGroupList
|
|
1128
1219
|
* @throws ApiError
|
|
1129
1220
|
*/
|
|
1130
|
-
public static coreRbacGroupsList(
|
|
1221
|
+
public static coreRbacGroupsList({
|
|
1222
|
+
page,
|
|
1223
|
+
pageSize,
|
|
1224
|
+
platformKey,
|
|
1225
|
+
}: {
|
|
1226
|
+
/**
|
|
1227
|
+
* A page number within the paginated result set.
|
|
1228
|
+
*/
|
|
1131
1229
|
page?: number,
|
|
1230
|
+
/**
|
|
1231
|
+
* Number of results to return per page.
|
|
1232
|
+
*/
|
|
1132
1233
|
pageSize?: number,
|
|
1234
|
+
/**
|
|
1235
|
+
* Filter groups by platform key
|
|
1236
|
+
*/
|
|
1133
1237
|
platformKey?: string,
|
|
1134
|
-
): CancelablePromise<PaginatedRbacGroupList> {
|
|
1238
|
+
}): CancelablePromise<PaginatedRbacGroupList> {
|
|
1135
1239
|
return __request(OpenAPI, {
|
|
1136
1240
|
method: 'GET',
|
|
1137
1241
|
url: '/api/core/rbac/groups/',
|
|
@@ -1145,13 +1249,14 @@ export class CoreService {
|
|
|
1145
1249
|
/**
|
|
1146
1250
|
* Create RBAC group
|
|
1147
1251
|
* Create a new RBAC group for a platform. Users can be assigned during creation.
|
|
1148
|
-
* @param requestBody
|
|
1149
1252
|
* @returns RbacGroup
|
|
1150
1253
|
* @throws ApiError
|
|
1151
1254
|
*/
|
|
1152
|
-
public static coreRbacGroupsCreate(
|
|
1255
|
+
public static coreRbacGroupsCreate({
|
|
1256
|
+
requestBody,
|
|
1257
|
+
}: {
|
|
1153
1258
|
requestBody: RbacGroup,
|
|
1154
|
-
): CancelablePromise<RbacGroup> {
|
|
1259
|
+
}): CancelablePromise<RbacGroup> {
|
|
1155
1260
|
return __request(OpenAPI, {
|
|
1156
1261
|
method: 'POST',
|
|
1157
1262
|
url: '/api/core/rbac/groups/',
|
|
@@ -1167,13 +1272,17 @@ export class CoreService {
|
|
|
1167
1272
|
/**
|
|
1168
1273
|
* Retrieve RBAC group
|
|
1169
1274
|
* Retrieve details of a specific RBAC group including assigned users.
|
|
1170
|
-
* @param id A unique integer value identifying this RBAC Group.
|
|
1171
1275
|
* @returns RbacGroup
|
|
1172
1276
|
* @throws ApiError
|
|
1173
1277
|
*/
|
|
1174
|
-
public static coreRbacGroupsRetrieve(
|
|
1278
|
+
public static coreRbacGroupsRetrieve({
|
|
1279
|
+
id,
|
|
1280
|
+
}: {
|
|
1281
|
+
/**
|
|
1282
|
+
* A unique integer value identifying this RBAC Group.
|
|
1283
|
+
*/
|
|
1175
1284
|
id: number,
|
|
1176
|
-
): CancelablePromise<RbacGroup> {
|
|
1285
|
+
}): CancelablePromise<RbacGroup> {
|
|
1177
1286
|
return __request(OpenAPI, {
|
|
1178
1287
|
method: 'GET',
|
|
1179
1288
|
url: '/api/core/rbac/groups/{id}/',
|
|
@@ -1188,15 +1297,19 @@ export class CoreService {
|
|
|
1188
1297
|
/**
|
|
1189
1298
|
* Update RBAC group
|
|
1190
1299
|
* Update an existing RBAC group. Platform validation applies for user assignments.
|
|
1191
|
-
* @param id A unique integer value identifying this RBAC Group.
|
|
1192
|
-
* @param requestBody
|
|
1193
1300
|
* @returns RbacGroup
|
|
1194
1301
|
* @throws ApiError
|
|
1195
1302
|
*/
|
|
1196
|
-
public static coreRbacGroupsUpdate(
|
|
1303
|
+
public static coreRbacGroupsUpdate({
|
|
1304
|
+
id,
|
|
1305
|
+
requestBody,
|
|
1306
|
+
}: {
|
|
1307
|
+
/**
|
|
1308
|
+
* A unique integer value identifying this RBAC Group.
|
|
1309
|
+
*/
|
|
1197
1310
|
id: number,
|
|
1198
1311
|
requestBody: RbacGroup,
|
|
1199
|
-
): CancelablePromise<RbacGroup> {
|
|
1312
|
+
}): CancelablePromise<RbacGroup> {
|
|
1200
1313
|
return __request(OpenAPI, {
|
|
1201
1314
|
method: 'PUT',
|
|
1202
1315
|
url: '/api/core/rbac/groups/{id}/',
|
|
@@ -1216,15 +1329,19 @@ export class CoreService {
|
|
|
1216
1329
|
/**
|
|
1217
1330
|
* Partially update RBAC group
|
|
1218
1331
|
* Partially update an existing RBAC group. Platform validation applies for user assignments.
|
|
1219
|
-
* @param id A unique integer value identifying this RBAC Group.
|
|
1220
|
-
* @param requestBody
|
|
1221
1332
|
* @returns RbacGroup
|
|
1222
1333
|
* @throws ApiError
|
|
1223
1334
|
*/
|
|
1224
|
-
public static coreRbacGroupsPartialUpdate(
|
|
1335
|
+
public static coreRbacGroupsPartialUpdate({
|
|
1336
|
+
id,
|
|
1337
|
+
requestBody,
|
|
1338
|
+
}: {
|
|
1339
|
+
/**
|
|
1340
|
+
* A unique integer value identifying this RBAC Group.
|
|
1341
|
+
*/
|
|
1225
1342
|
id: number,
|
|
1226
1343
|
requestBody?: PatchedRbacGroup,
|
|
1227
|
-
): CancelablePromise<RbacGroup> {
|
|
1344
|
+
}): CancelablePromise<RbacGroup> {
|
|
1228
1345
|
return __request(OpenAPI, {
|
|
1229
1346
|
method: 'PATCH',
|
|
1230
1347
|
url: '/api/core/rbac/groups/{id}/',
|
|
@@ -1244,13 +1361,17 @@ export class CoreService {
|
|
|
1244
1361
|
/**
|
|
1245
1362
|
* Delete RBAC group
|
|
1246
1363
|
* Delete an RBAC group and all associated group role assignments.
|
|
1247
|
-
* @param id A unique integer value identifying this RBAC Group.
|
|
1248
1364
|
* @returns void
|
|
1249
1365
|
* @throws ApiError
|
|
1250
1366
|
*/
|
|
1251
|
-
public static coreRbacGroupsDestroy(
|
|
1367
|
+
public static coreRbacGroupsDestroy({
|
|
1368
|
+
id,
|
|
1369
|
+
}: {
|
|
1370
|
+
/**
|
|
1371
|
+
* A unique integer value identifying this RBAC Group.
|
|
1372
|
+
*/
|
|
1252
1373
|
id: number,
|
|
1253
|
-
): CancelablePromise<void> {
|
|
1374
|
+
}): CancelablePromise<void> {
|
|
1254
1375
|
return __request(OpenAPI, {
|
|
1255
1376
|
method: 'DELETE',
|
|
1256
1377
|
url: '/api/core/rbac/groups/{id}/',
|
|
@@ -1265,19 +1386,32 @@ export class CoreService {
|
|
|
1265
1386
|
/**
|
|
1266
1387
|
* List RBAC policies
|
|
1267
1388
|
* Retrieve a list of RBAC policies. Can be filtered by platform_key or role_id.
|
|
1268
|
-
* @param page A page number within the paginated result set.
|
|
1269
|
-
* @param pageSize Number of results to return per page.
|
|
1270
|
-
* @param platformKey Filter policies by platform key
|
|
1271
|
-
* @param roleId Filter policies by role ID
|
|
1272
1389
|
* @returns PaginatedRbacPolicyList
|
|
1273
1390
|
* @throws ApiError
|
|
1274
1391
|
*/
|
|
1275
|
-
public static coreRbacPoliciesList(
|
|
1392
|
+
public static coreRbacPoliciesList({
|
|
1393
|
+
page,
|
|
1394
|
+
pageSize,
|
|
1395
|
+
platformKey,
|
|
1396
|
+
roleId,
|
|
1397
|
+
}: {
|
|
1398
|
+
/**
|
|
1399
|
+
* A page number within the paginated result set.
|
|
1400
|
+
*/
|
|
1276
1401
|
page?: number,
|
|
1402
|
+
/**
|
|
1403
|
+
* Number of results to return per page.
|
|
1404
|
+
*/
|
|
1277
1405
|
pageSize?: number,
|
|
1406
|
+
/**
|
|
1407
|
+
* Filter policies by platform key
|
|
1408
|
+
*/
|
|
1278
1409
|
platformKey?: string,
|
|
1410
|
+
/**
|
|
1411
|
+
* Filter policies by role ID
|
|
1412
|
+
*/
|
|
1279
1413
|
roleId?: number,
|
|
1280
|
-
): CancelablePromise<PaginatedRbacPolicyList> {
|
|
1414
|
+
}): CancelablePromise<PaginatedRbacPolicyList> {
|
|
1281
1415
|
return __request(OpenAPI, {
|
|
1282
1416
|
method: 'GET',
|
|
1283
1417
|
url: '/api/core/rbac/policies/',
|
|
@@ -1292,13 +1426,14 @@ export class CoreService {
|
|
|
1292
1426
|
/**
|
|
1293
1427
|
* Create RBAC policy
|
|
1294
1428
|
* Create a new RBAC policy that defines resource access for a role.
|
|
1295
|
-
* @param requestBody
|
|
1296
1429
|
* @returns RbacPolicy
|
|
1297
1430
|
* @throws ApiError
|
|
1298
1431
|
*/
|
|
1299
|
-
public static coreRbacPoliciesCreate(
|
|
1432
|
+
public static coreRbacPoliciesCreate({
|
|
1433
|
+
requestBody,
|
|
1434
|
+
}: {
|
|
1300
1435
|
requestBody: RbacPolicy,
|
|
1301
|
-
): CancelablePromise<RbacPolicy> {
|
|
1436
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1302
1437
|
return __request(OpenAPI, {
|
|
1303
1438
|
method: 'POST',
|
|
1304
1439
|
url: '/api/core/rbac/policies/',
|
|
@@ -1312,13 +1447,17 @@ export class CoreService {
|
|
|
1312
1447
|
/**
|
|
1313
1448
|
* Retrieve RBAC policy
|
|
1314
1449
|
* Retrieve details of a specific RBAC policy.
|
|
1315
|
-
* @param id A unique integer value identifying this RBAC Policy.
|
|
1316
1450
|
* @returns RbacPolicy
|
|
1317
1451
|
* @throws ApiError
|
|
1318
1452
|
*/
|
|
1319
|
-
public static coreRbacPoliciesRetrieve(
|
|
1453
|
+
public static coreRbacPoliciesRetrieve({
|
|
1454
|
+
id,
|
|
1455
|
+
}: {
|
|
1456
|
+
/**
|
|
1457
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1458
|
+
*/
|
|
1320
1459
|
id: number,
|
|
1321
|
-
): CancelablePromise<RbacPolicy> {
|
|
1460
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1322
1461
|
return __request(OpenAPI, {
|
|
1323
1462
|
method: 'GET',
|
|
1324
1463
|
url: '/api/core/rbac/policies/{id}/',
|
|
@@ -1333,15 +1472,19 @@ export class CoreService {
|
|
|
1333
1472
|
/**
|
|
1334
1473
|
* Update RBAC policy
|
|
1335
1474
|
* Update an existing RBAC policy.
|
|
1336
|
-
* @param id A unique integer value identifying this RBAC Policy.
|
|
1337
|
-
* @param requestBody
|
|
1338
1475
|
* @returns RbacPolicy
|
|
1339
1476
|
* @throws ApiError
|
|
1340
1477
|
*/
|
|
1341
|
-
public static coreRbacPoliciesUpdate(
|
|
1478
|
+
public static coreRbacPoliciesUpdate({
|
|
1479
|
+
id,
|
|
1480
|
+
requestBody,
|
|
1481
|
+
}: {
|
|
1482
|
+
/**
|
|
1483
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1484
|
+
*/
|
|
1342
1485
|
id: number,
|
|
1343
1486
|
requestBody: RbacPolicy,
|
|
1344
|
-
): CancelablePromise<RbacPolicy> {
|
|
1487
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1345
1488
|
return __request(OpenAPI, {
|
|
1346
1489
|
method: 'PUT',
|
|
1347
1490
|
url: '/api/core/rbac/policies/{id}/',
|
|
@@ -1359,15 +1502,19 @@ export class CoreService {
|
|
|
1359
1502
|
/**
|
|
1360
1503
|
* Partially update RBAC policy
|
|
1361
1504
|
* Partially update an existing RBAC policy.
|
|
1362
|
-
* @param id A unique integer value identifying this RBAC Policy.
|
|
1363
|
-
* @param requestBody
|
|
1364
1505
|
* @returns RbacPolicy
|
|
1365
1506
|
* @throws ApiError
|
|
1366
1507
|
*/
|
|
1367
|
-
public static coreRbacPoliciesPartialUpdate(
|
|
1508
|
+
public static coreRbacPoliciesPartialUpdate({
|
|
1509
|
+
id,
|
|
1510
|
+
requestBody,
|
|
1511
|
+
}: {
|
|
1512
|
+
/**
|
|
1513
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1514
|
+
*/
|
|
1368
1515
|
id: number,
|
|
1369
1516
|
requestBody?: PatchedRbacPolicy,
|
|
1370
|
-
): CancelablePromise<RbacPolicy> {
|
|
1517
|
+
}): CancelablePromise<RbacPolicy> {
|
|
1371
1518
|
return __request(OpenAPI, {
|
|
1372
1519
|
method: 'PATCH',
|
|
1373
1520
|
url: '/api/core/rbac/policies/{id}/',
|
|
@@ -1385,13 +1532,17 @@ export class CoreService {
|
|
|
1385
1532
|
/**
|
|
1386
1533
|
* Delete RBAC policy
|
|
1387
1534
|
* Delete an RBAC policy.
|
|
1388
|
-
* @param id A unique integer value identifying this RBAC Policy.
|
|
1389
1535
|
* @returns void
|
|
1390
1536
|
* @throws ApiError
|
|
1391
1537
|
*/
|
|
1392
|
-
public static coreRbacPoliciesDestroy(
|
|
1538
|
+
public static coreRbacPoliciesDestroy({
|
|
1539
|
+
id,
|
|
1540
|
+
}: {
|
|
1541
|
+
/**
|
|
1542
|
+
* A unique integer value identifying this RBAC Policy.
|
|
1543
|
+
*/
|
|
1393
1544
|
id: number,
|
|
1394
|
-
): CancelablePromise<void> {
|
|
1545
|
+
}): CancelablePromise<void> {
|
|
1395
1546
|
return __request(OpenAPI, {
|
|
1396
1547
|
method: 'DELETE',
|
|
1397
1548
|
url: '/api/core/rbac/policies/{id}/',
|
|
@@ -1406,17 +1557,27 @@ export class CoreService {
|
|
|
1406
1557
|
/**
|
|
1407
1558
|
* List RBAC roles
|
|
1408
1559
|
* Retrieve a list of RBAC roles. Can be filtered by platform_key.
|
|
1409
|
-
* @param page A page number within the paginated result set.
|
|
1410
|
-
* @param pageSize Number of results to return per page.
|
|
1411
|
-
* @param platformKey Filter roles by platform key
|
|
1412
1560
|
* @returns PaginatedRbacRoleList
|
|
1413
1561
|
* @throws ApiError
|
|
1414
1562
|
*/
|
|
1415
|
-
public static coreRbacRolesList(
|
|
1563
|
+
public static coreRbacRolesList({
|
|
1564
|
+
page,
|
|
1565
|
+
pageSize,
|
|
1566
|
+
platformKey,
|
|
1567
|
+
}: {
|
|
1568
|
+
/**
|
|
1569
|
+
* A page number within the paginated result set.
|
|
1570
|
+
*/
|
|
1416
1571
|
page?: number,
|
|
1572
|
+
/**
|
|
1573
|
+
* Number of results to return per page.
|
|
1574
|
+
*/
|
|
1417
1575
|
pageSize?: number,
|
|
1576
|
+
/**
|
|
1577
|
+
* Filter roles by platform key
|
|
1578
|
+
*/
|
|
1418
1579
|
platformKey?: string,
|
|
1419
|
-
): CancelablePromise<PaginatedRbacRoleList> {
|
|
1580
|
+
}): CancelablePromise<PaginatedRbacRoleList> {
|
|
1420
1581
|
return __request(OpenAPI, {
|
|
1421
1582
|
method: 'GET',
|
|
1422
1583
|
url: '/api/core/rbac/roles/',
|
|
@@ -1430,13 +1591,14 @@ export class CoreService {
|
|
|
1430
1591
|
/**
|
|
1431
1592
|
* Create RBAC role
|
|
1432
1593
|
* Create a new RBAC role for a platform.
|
|
1433
|
-
* @param requestBody
|
|
1434
1594
|
* @returns RbacRole
|
|
1435
1595
|
* @throws ApiError
|
|
1436
1596
|
*/
|
|
1437
|
-
public static coreRbacRolesCreate(
|
|
1597
|
+
public static coreRbacRolesCreate({
|
|
1598
|
+
requestBody,
|
|
1599
|
+
}: {
|
|
1438
1600
|
requestBody: RbacRole,
|
|
1439
|
-
): CancelablePromise<RbacRole> {
|
|
1601
|
+
}): CancelablePromise<RbacRole> {
|
|
1440
1602
|
return __request(OpenAPI, {
|
|
1441
1603
|
method: 'POST',
|
|
1442
1604
|
url: '/api/core/rbac/roles/',
|
|
@@ -1450,13 +1612,17 @@ export class CoreService {
|
|
|
1450
1612
|
/**
|
|
1451
1613
|
* Retrieve RBAC role
|
|
1452
1614
|
* Retrieve details of a specific RBAC role.
|
|
1453
|
-
* @param id A unique integer value identifying this RBAC Role.
|
|
1454
1615
|
* @returns RbacRole
|
|
1455
1616
|
* @throws ApiError
|
|
1456
1617
|
*/
|
|
1457
|
-
public static coreRbacRolesRetrieve(
|
|
1618
|
+
public static coreRbacRolesRetrieve({
|
|
1619
|
+
id,
|
|
1620
|
+
}: {
|
|
1621
|
+
/**
|
|
1622
|
+
* A unique integer value identifying this RBAC Role.
|
|
1623
|
+
*/
|
|
1458
1624
|
id: number,
|
|
1459
|
-
): CancelablePromise<RbacRole> {
|
|
1625
|
+
}): CancelablePromise<RbacRole> {
|
|
1460
1626
|
return __request(OpenAPI, {
|
|
1461
1627
|
method: 'GET',
|
|
1462
1628
|
url: '/api/core/rbac/roles/{id}/',
|
|
@@ -1471,15 +1637,19 @@ export class CoreService {
|
|
|
1471
1637
|
/**
|
|
1472
1638
|
* Update RBAC role
|
|
1473
1639
|
* Update an existing RBAC role.
|
|
1474
|
-
* @param id A unique integer value identifying this RBAC Role.
|
|
1475
|
-
* @param requestBody
|
|
1476
1640
|
* @returns RbacRole
|
|
1477
1641
|
* @throws ApiError
|
|
1478
1642
|
*/
|
|
1479
|
-
public static coreRbacRolesUpdate(
|
|
1643
|
+
public static coreRbacRolesUpdate({
|
|
1644
|
+
id,
|
|
1645
|
+
requestBody,
|
|
1646
|
+
}: {
|
|
1647
|
+
/**
|
|
1648
|
+
* A unique integer value identifying this RBAC Role.
|
|
1649
|
+
*/
|
|
1480
1650
|
id: number,
|
|
1481
1651
|
requestBody: RbacRole,
|
|
1482
|
-
): CancelablePromise<RbacRole> {
|
|
1652
|
+
}): CancelablePromise<RbacRole> {
|
|
1483
1653
|
return __request(OpenAPI, {
|
|
1484
1654
|
method: 'PUT',
|
|
1485
1655
|
url: '/api/core/rbac/roles/{id}/',
|
|
@@ -1497,15 +1667,19 @@ export class CoreService {
|
|
|
1497
1667
|
/**
|
|
1498
1668
|
* Partially update RBAC role
|
|
1499
1669
|
* Partially update an existing RBAC role.
|
|
1500
|
-
* @param id A unique integer value identifying this RBAC Role.
|
|
1501
|
-
* @param requestBody
|
|
1502
1670
|
* @returns RbacRole
|
|
1503
1671
|
* @throws ApiError
|
|
1504
1672
|
*/
|
|
1505
|
-
public static coreRbacRolesPartialUpdate(
|
|
1673
|
+
public static coreRbacRolesPartialUpdate({
|
|
1674
|
+
id,
|
|
1675
|
+
requestBody,
|
|
1676
|
+
}: {
|
|
1677
|
+
/**
|
|
1678
|
+
* A unique integer value identifying this RBAC Role.
|
|
1679
|
+
*/
|
|
1506
1680
|
id: number,
|
|
1507
1681
|
requestBody?: PatchedRbacRole,
|
|
1508
|
-
): CancelablePromise<RbacRole> {
|
|
1682
|
+
}): CancelablePromise<RbacRole> {
|
|
1509
1683
|
return __request(OpenAPI, {
|
|
1510
1684
|
method: 'PATCH',
|
|
1511
1685
|
url: '/api/core/rbac/roles/{id}/',
|
|
@@ -1523,13 +1697,17 @@ export class CoreService {
|
|
|
1523
1697
|
/**
|
|
1524
1698
|
* Delete RBAC role
|
|
1525
1699
|
* Delete an RBAC role.
|
|
1526
|
-
* @param id A unique integer value identifying this RBAC Role.
|
|
1527
1700
|
* @returns void
|
|
1528
1701
|
* @throws ApiError
|
|
1529
1702
|
*/
|
|
1530
|
-
public static coreRbacRolesDestroy(
|
|
1703
|
+
public static coreRbacRolesDestroy({
|
|
1704
|
+
id,
|
|
1705
|
+
}: {
|
|
1706
|
+
/**
|
|
1707
|
+
* A unique integer value identifying this RBAC Role.
|
|
1708
|
+
*/
|
|
1531
1709
|
id: number,
|
|
1532
|
-
): CancelablePromise<void> {
|
|
1710
|
+
}): CancelablePromise<void> {
|
|
1533
1711
|
return __request(OpenAPI, {
|
|
1534
1712
|
method: 'DELETE',
|
|
1535
1713
|
url: '/api/core/rbac/roles/{id}/',
|
|
@@ -1544,19 +1722,32 @@ export class CoreService {
|
|
|
1544
1722
|
/**
|
|
1545
1723
|
* List user role assignments
|
|
1546
1724
|
* Retrieve a list of user role assignments. Can be filtered by platform_key or user_id.
|
|
1547
|
-
* @param page A page number within the paginated result set.
|
|
1548
|
-
* @param pageSize Number of results to return per page.
|
|
1549
|
-
* @param platformKey Filter user roles by platform key
|
|
1550
|
-
* @param userId Filter user roles by user ID
|
|
1551
1725
|
* @returns PaginatedRbacUserRoleList
|
|
1552
1726
|
* @throws ApiError
|
|
1553
1727
|
*/
|
|
1554
|
-
public static coreRbacUserRolesList(
|
|
1728
|
+
public static coreRbacUserRolesList({
|
|
1729
|
+
page,
|
|
1730
|
+
pageSize,
|
|
1731
|
+
platformKey,
|
|
1732
|
+
userId,
|
|
1733
|
+
}: {
|
|
1734
|
+
/**
|
|
1735
|
+
* A page number within the paginated result set.
|
|
1736
|
+
*/
|
|
1555
1737
|
page?: number,
|
|
1738
|
+
/**
|
|
1739
|
+
* Number of results to return per page.
|
|
1740
|
+
*/
|
|
1556
1741
|
pageSize?: number,
|
|
1742
|
+
/**
|
|
1743
|
+
* Filter user roles by platform key
|
|
1744
|
+
*/
|
|
1557
1745
|
platformKey?: string,
|
|
1746
|
+
/**
|
|
1747
|
+
* Filter user roles by user ID
|
|
1748
|
+
*/
|
|
1558
1749
|
userId?: number,
|
|
1559
|
-
): CancelablePromise<PaginatedRbacUserRoleList> {
|
|
1750
|
+
}): CancelablePromise<PaginatedRbacUserRoleList> {
|
|
1560
1751
|
return __request(OpenAPI, {
|
|
1561
1752
|
method: 'GET',
|
|
1562
1753
|
url: '/api/core/rbac/user-roles/',
|
|
@@ -1571,13 +1762,14 @@ export class CoreService {
|
|
|
1571
1762
|
/**
|
|
1572
1763
|
* Create user role assignment
|
|
1573
1764
|
* Assign a role to a user. The user must belong to the same platform as the role.
|
|
1574
|
-
* @param requestBody
|
|
1575
1765
|
* @returns RbacUserRole
|
|
1576
1766
|
* @throws ApiError
|
|
1577
1767
|
*/
|
|
1578
|
-
public static coreRbacUserRolesCreate(
|
|
1768
|
+
public static coreRbacUserRolesCreate({
|
|
1769
|
+
requestBody,
|
|
1770
|
+
}: {
|
|
1579
1771
|
requestBody: RbacUserRole,
|
|
1580
|
-
): CancelablePromise<RbacUserRole> {
|
|
1772
|
+
}): CancelablePromise<RbacUserRole> {
|
|
1581
1773
|
return __request(OpenAPI, {
|
|
1582
1774
|
method: 'POST',
|
|
1583
1775
|
url: '/api/core/rbac/user-roles/',
|
|
@@ -1593,13 +1785,17 @@ export class CoreService {
|
|
|
1593
1785
|
/**
|
|
1594
1786
|
* Retrieve user role assignment
|
|
1595
1787
|
* Retrieve details of a specific user role assignment.
|
|
1596
|
-
* @param id A unique integer value identifying this RBAC User Role.
|
|
1597
1788
|
* @returns RbacUserRole
|
|
1598
1789
|
* @throws ApiError
|
|
1599
1790
|
*/
|
|
1600
|
-
public static coreRbacUserRolesRetrieve(
|
|
1791
|
+
public static coreRbacUserRolesRetrieve({
|
|
1792
|
+
id,
|
|
1793
|
+
}: {
|
|
1794
|
+
/**
|
|
1795
|
+
* A unique integer value identifying this RBAC User Role.
|
|
1796
|
+
*/
|
|
1601
1797
|
id: number,
|
|
1602
|
-
): CancelablePromise<RbacUserRole> {
|
|
1798
|
+
}): CancelablePromise<RbacUserRole> {
|
|
1603
1799
|
return __request(OpenAPI, {
|
|
1604
1800
|
method: 'GET',
|
|
1605
1801
|
url: '/api/core/rbac/user-roles/{id}/',
|
|
@@ -1614,15 +1810,19 @@ export class CoreService {
|
|
|
1614
1810
|
/**
|
|
1615
1811
|
* Update user role assignment
|
|
1616
1812
|
* Update an existing user role assignment. Platform validation applies.
|
|
1617
|
-
* @param id A unique integer value identifying this RBAC User Role.
|
|
1618
|
-
* @param requestBody
|
|
1619
1813
|
* @returns RbacUserRole
|
|
1620
1814
|
* @throws ApiError
|
|
1621
1815
|
*/
|
|
1622
|
-
public static coreRbacUserRolesUpdate(
|
|
1816
|
+
public static coreRbacUserRolesUpdate({
|
|
1817
|
+
id,
|
|
1818
|
+
requestBody,
|
|
1819
|
+
}: {
|
|
1820
|
+
/**
|
|
1821
|
+
* A unique integer value identifying this RBAC User Role.
|
|
1822
|
+
*/
|
|
1623
1823
|
id: number,
|
|
1624
1824
|
requestBody: RbacUserRole,
|
|
1625
|
-
): CancelablePromise<RbacUserRole> {
|
|
1825
|
+
}): CancelablePromise<RbacUserRole> {
|
|
1626
1826
|
return __request(OpenAPI, {
|
|
1627
1827
|
method: 'PUT',
|
|
1628
1828
|
url: '/api/core/rbac/user-roles/{id}/',
|
|
@@ -1642,15 +1842,19 @@ export class CoreService {
|
|
|
1642
1842
|
/**
|
|
1643
1843
|
* Partially update user role assignment
|
|
1644
1844
|
* Partially update an existing user role assignment. Platform validation applies.
|
|
1645
|
-
* @param id A unique integer value identifying this RBAC User Role.
|
|
1646
|
-
* @param requestBody
|
|
1647
1845
|
* @returns RbacUserRole
|
|
1648
1846
|
* @throws ApiError
|
|
1649
1847
|
*/
|
|
1650
|
-
public static coreRbacUserRolesPartialUpdate(
|
|
1848
|
+
public static coreRbacUserRolesPartialUpdate({
|
|
1849
|
+
id,
|
|
1850
|
+
requestBody,
|
|
1851
|
+
}: {
|
|
1852
|
+
/**
|
|
1853
|
+
* A unique integer value identifying this RBAC User Role.
|
|
1854
|
+
*/
|
|
1651
1855
|
id: number,
|
|
1652
1856
|
requestBody?: PatchedRbacUserRole,
|
|
1653
|
-
): CancelablePromise<RbacUserRole> {
|
|
1857
|
+
}): CancelablePromise<RbacUserRole> {
|
|
1654
1858
|
return __request(OpenAPI, {
|
|
1655
1859
|
method: 'PATCH',
|
|
1656
1860
|
url: '/api/core/rbac/user-roles/{id}/',
|
|
@@ -1670,13 +1874,17 @@ export class CoreService {
|
|
|
1670
1874
|
/**
|
|
1671
1875
|
* Delete user role assignment
|
|
1672
1876
|
* Remove a role assignment from a user.
|
|
1673
|
-
* @param id A unique integer value identifying this RBAC User Role.
|
|
1674
1877
|
* @returns void
|
|
1675
1878
|
* @throws ApiError
|
|
1676
1879
|
*/
|
|
1677
|
-
public static coreRbacUserRolesDestroy(
|
|
1880
|
+
public static coreRbacUserRolesDestroy({
|
|
1881
|
+
id,
|
|
1882
|
+
}: {
|
|
1883
|
+
/**
|
|
1884
|
+
* A unique integer value identifying this RBAC User Role.
|
|
1885
|
+
*/
|
|
1678
1886
|
id: number,
|
|
1679
|
-
): CancelablePromise<void> {
|
|
1887
|
+
}): CancelablePromise<void> {
|
|
1680
1888
|
return __request(OpenAPI, {
|
|
1681
1889
|
method: 'DELETE',
|
|
1682
1890
|
url: '/api/core/rbac/user-roles/{id}/',
|
|
@@ -1701,13 +1909,14 @@ export class CoreService {
|
|
|
1701
1909
|
}
|
|
1702
1910
|
/**
|
|
1703
1911
|
* POST signals/edx/
|
|
1704
|
-
* @param requestBody
|
|
1705
1912
|
* @returns any No response body
|
|
1706
1913
|
* @throws ApiError
|
|
1707
1914
|
*/
|
|
1708
|
-
public static coreSignalsEdxCreate(
|
|
1915
|
+
public static coreSignalsEdxCreate({
|
|
1916
|
+
requestBody,
|
|
1917
|
+
}: {
|
|
1709
1918
|
requestBody: EdxSignalReceiverRequest,
|
|
1710
|
-
): CancelablePromise<any> {
|
|
1919
|
+
}): CancelablePromise<any> {
|
|
1711
1920
|
return __request(OpenAPI, {
|
|
1712
1921
|
method: 'POST',
|
|
1713
1922
|
url: '/api/core/signals/edx/',
|
|
@@ -1819,13 +2028,14 @@ export class CoreService {
|
|
|
1819
2028
|
}
|
|
1820
2029
|
/**
|
|
1821
2030
|
* Initiates the account deletion process for the authenticated user or specified username.
|
|
1822
|
-
* @param requestBody
|
|
1823
2031
|
* @returns UserDeleteAPIResponse
|
|
1824
2032
|
* @throws ApiError
|
|
1825
2033
|
*/
|
|
1826
|
-
public static coreUsersDeleteCreate(
|
|
2034
|
+
public static coreUsersDeleteCreate({
|
|
2035
|
+
requestBody,
|
|
2036
|
+
}: {
|
|
1827
2037
|
requestBody?: UserDeleteAPIRequest,
|
|
1828
|
-
): CancelablePromise<UserDeleteAPIResponse> {
|
|
2038
|
+
}): CancelablePromise<UserDeleteAPIResponse> {
|
|
1829
2039
|
return __request(OpenAPI, {
|
|
1830
2040
|
method: 'POST',
|
|
1831
2041
|
url: '/api/core/users/delete/',
|
|
@@ -1838,17 +2048,18 @@ export class CoreService {
|
|
|
1838
2048
|
*
|
|
1839
2049
|
* Make permission check for platform admins here,
|
|
1840
2050
|
* then proxy request to edx.
|
|
1841
|
-
* @param email
|
|
1842
|
-
* @param userId
|
|
1843
|
-
* @param username
|
|
1844
2051
|
* @returns any No response body
|
|
1845
2052
|
* @throws ApiError
|
|
1846
2053
|
*/
|
|
1847
|
-
public static coreUsersMetadataProxyRetrieve(
|
|
2054
|
+
public static coreUsersMetadataProxyRetrieve({
|
|
2055
|
+
email,
|
|
2056
|
+
userId,
|
|
2057
|
+
username,
|
|
2058
|
+
}: {
|
|
1848
2059
|
email?: string,
|
|
1849
2060
|
userId?: number,
|
|
1850
2061
|
username?: string,
|
|
1851
|
-
): CancelablePromise<any> {
|
|
2062
|
+
}): CancelablePromise<any> {
|
|
1852
2063
|
return __request(OpenAPI, {
|
|
1853
2064
|
method: 'GET',
|
|
1854
2065
|
url: '/api/core/users/metadata/proxy/',
|
|
@@ -1866,17 +2077,18 @@ export class CoreService {
|
|
|
1866
2077
|
* user_id
|
|
1867
2078
|
* username
|
|
1868
2079
|
* email
|
|
1869
|
-
* @param email
|
|
1870
|
-
* @param userId
|
|
1871
|
-
* @param username
|
|
1872
2080
|
* @returns UserPlatformLink
|
|
1873
2081
|
* @throws ApiError
|
|
1874
2082
|
*/
|
|
1875
|
-
public static coreUsersPlatformsList(
|
|
2083
|
+
public static coreUsersPlatformsList({
|
|
2084
|
+
email,
|
|
2085
|
+
userId,
|
|
2086
|
+
username,
|
|
2087
|
+
}: {
|
|
1876
2088
|
email?: string,
|
|
1877
2089
|
userId?: number,
|
|
1878
2090
|
username?: string,
|
|
1879
|
-
): CancelablePromise<Array<UserPlatformLink>> {
|
|
2091
|
+
}): CancelablePromise<Array<UserPlatformLink>> {
|
|
1880
2092
|
return __request(OpenAPI, {
|
|
1881
2093
|
method: 'GET',
|
|
1882
2094
|
url: '/api/core/users/platforms/',
|
|
@@ -1897,13 +2109,14 @@ export class CoreService {
|
|
|
1897
2109
|
* expired_on (optional)
|
|
1898
2110
|
* is_admin (optional)
|
|
1899
2111
|
* active (optional)
|
|
1900
|
-
* @param requestBody
|
|
1901
2112
|
* @returns any No response body
|
|
1902
2113
|
* @throws ApiError
|
|
1903
2114
|
*/
|
|
1904
|
-
public static coreUsersPlatformsCreate(
|
|
2115
|
+
public static coreUsersPlatformsCreate({
|
|
2116
|
+
requestBody,
|
|
2117
|
+
}: {
|
|
1905
2118
|
requestBody: UserPlatformViewPostRequest,
|
|
1906
|
-
): CancelablePromise<any> {
|
|
2119
|
+
}): CancelablePromise<any> {
|
|
1907
2120
|
return __request(OpenAPI, {
|
|
1908
2121
|
method: 'POST',
|
|
1909
2122
|
url: '/api/core/users/platforms/',
|
|
@@ -1913,17 +2126,18 @@ export class CoreService {
|
|
|
1913
2126
|
}
|
|
1914
2127
|
/**
|
|
1915
2128
|
* Retrieve proxy user information by user_id
|
|
1916
|
-
* @param email
|
|
1917
|
-
* @param userId
|
|
1918
|
-
* @param username
|
|
1919
2129
|
* @returns UserProxyGetResponse
|
|
1920
2130
|
* @throws ApiError
|
|
1921
2131
|
*/
|
|
1922
|
-
public static coreUsersProxyRetrieve(
|
|
2132
|
+
public static coreUsersProxyRetrieve({
|
|
2133
|
+
email,
|
|
2134
|
+
userId,
|
|
2135
|
+
username,
|
|
2136
|
+
}: {
|
|
1923
2137
|
email?: string,
|
|
1924
2138
|
userId?: number,
|
|
1925
2139
|
username?: string,
|
|
1926
|
-
): CancelablePromise<UserProxyGetResponse> {
|
|
2140
|
+
}): CancelablePromise<UserProxyGetResponse> {
|
|
1927
2141
|
return __request(OpenAPI, {
|
|
1928
2142
|
method: 'GET',
|
|
1929
2143
|
url: '/api/core/users/proxy/',
|
|
@@ -1943,13 +2157,14 @@ export class CoreService {
|
|
|
1943
2157
|
* email
|
|
1944
2158
|
* edx_data
|
|
1945
2159
|
* data
|
|
1946
|
-
* @param requestBody
|
|
1947
2160
|
* @returns UserProxyPostResponse
|
|
1948
2161
|
* @throws ApiError
|
|
1949
2162
|
*/
|
|
1950
|
-
public static coreUsersProxyCreate(
|
|
2163
|
+
public static coreUsersProxyCreate({
|
|
2164
|
+
requestBody,
|
|
2165
|
+
}: {
|
|
1951
2166
|
requestBody: UserProxyPostRequest,
|
|
1952
|
-
): CancelablePromise<UserProxyPostResponse> {
|
|
2167
|
+
}): CancelablePromise<UserProxyPostResponse> {
|
|
1953
2168
|
return __request(OpenAPI, {
|
|
1954
2169
|
method: 'POST',
|
|
1955
2170
|
url: '/api/core/users/proxy/',
|
|
@@ -1968,13 +2183,14 @@ export class CoreService {
|
|
|
1968
2183
|
* {"user_id": 2, ...}
|
|
1969
2184
|
* ]
|
|
1970
2185
|
* ```
|
|
1971
|
-
* @param requestBody
|
|
1972
2186
|
* @returns string
|
|
1973
2187
|
* @throws ApiError
|
|
1974
2188
|
*/
|
|
1975
|
-
public static coreUsersProxyBulkCreate(
|
|
2189
|
+
public static coreUsersProxyBulkCreate({
|
|
2190
|
+
requestBody,
|
|
2191
|
+
}: {
|
|
1976
2192
|
requestBody: UserProxyBulkRequest,
|
|
1977
|
-
): CancelablePromise<Array<Record<string, string>>> {
|
|
2193
|
+
}): CancelablePromise<Array<Record<string, string>>> {
|
|
1978
2194
|
return __request(OpenAPI, {
|
|
1979
2195
|
method: 'POST',
|
|
1980
2196
|
url: '/api/core/users/proxy/bulk/',
|
|
@@ -1989,19 +2205,20 @@ export class CoreService {
|
|
|
1989
2205
|
* Params:
|
|
1990
2206
|
* query
|
|
1991
2207
|
* sort
|
|
1992
|
-
* @param page
|
|
1993
|
-
* @param pageSize
|
|
1994
|
-
* @param query
|
|
1995
|
-
* @param sort
|
|
1996
2208
|
* @returns UserSearchViewGetResponse
|
|
1997
2209
|
* @throws ApiError
|
|
1998
2210
|
*/
|
|
1999
|
-
public static coreUsersSearchRetrieve(
|
|
2211
|
+
public static coreUsersSearchRetrieve({
|
|
2212
|
+
page,
|
|
2213
|
+
pageSize,
|
|
2214
|
+
query,
|
|
2215
|
+
sort,
|
|
2216
|
+
}: {
|
|
2000
2217
|
page?: number,
|
|
2001
2218
|
pageSize?: number,
|
|
2002
2219
|
query?: string,
|
|
2003
2220
|
sort?: string,
|
|
2004
|
-
): CancelablePromise<UserSearchViewGetResponse> {
|
|
2221
|
+
}): CancelablePromise<UserSearchViewGetResponse> {
|
|
2005
2222
|
return __request(OpenAPI, {
|
|
2006
2223
|
method: 'GET',
|
|
2007
2224
|
url: '/api/core/users/search/',
|