@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.
Files changed (63) hide show
  1. package/dist/index.cjs.js +3038 -2750
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +3038 -2750
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +3038 -2750
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/services/AnalyticsService.d.ts +42 -13
  8. package/dist/types/services/AudienceService.d.ts +345 -149
  9. package/dist/types/services/CareerService.d.ts +117 -90
  10. package/dist/types/services/CatalogService.d.ts +3735 -1072
  11. package/dist/types/services/CoreService.d.ts +421 -210
  12. package/dist/types/services/CredentialsService.d.ts +173 -138
  13. package/dist/types/services/DepartmentsService.d.ts +53 -16
  14. package/dist/types/services/EngagementService.d.ts +459 -179
  15. package/dist/types/services/FeaturesService.d.ts +16 -7
  16. package/dist/types/services/FinanceService.d.ts +49 -20
  17. package/dist/types/services/MediaResourcesService.d.ts +243 -67
  18. package/dist/types/services/NotificationBuilderService.d.ts +31 -17
  19. package/dist/types/services/NotificationService.d.ts +56 -49
  20. package/dist/types/services/OrgsService.d.ts +106 -77
  21. package/dist/types/services/OverviewService.d.ts +154 -55
  22. package/dist/types/services/PerformanceService.d.ts +132 -56
  23. package/dist/types/services/PerlearnerService.d.ts +431 -217
  24. package/dist/types/services/PlatformService.d.ts +221 -116
  25. package/dist/types/services/ProviderAssociationService.d.ts +3 -2
  26. package/dist/types/services/ProvidersService.d.ts +27 -18
  27. package/dist/types/services/ProvisionService.d.ts +3 -2
  28. package/dist/types/services/RecommendationsService.d.ts +3 -3
  29. package/dist/types/services/ReportsService.d.ts +22 -16
  30. package/dist/types/services/RolesService.d.ts +8 -6
  31. package/dist/types/services/SearchService.d.ts +305 -80
  32. package/dist/types/services/ServiceService.d.ts +33 -29
  33. package/dist/types/services/SkillsService.d.ts +40 -32
  34. package/dist/types/services/UserGroupsService.d.ts +53 -16
  35. package/package.json +1 -1
  36. package/src/services/AnalyticsService.ts +45 -16
  37. package/src/services/AudienceService.ts +380 -184
  38. package/src/services/CareerService.ts +144 -117
  39. package/src/services/CatalogService.ts +3995 -1332
  40. package/src/services/CoreService.ts +503 -286
  41. package/src/services/CredentialsService.ts +253 -173
  42. package/src/services/DepartmentsService.ts +56 -19
  43. package/src/services/EngagementService.ts +528 -236
  44. package/src/services/FeaturesService.ts +19 -10
  45. package/src/services/FinanceService.ts +54 -25
  46. package/src/services/MediaResourcesService.ts +251 -75
  47. package/src/services/NotificationBuilderService.ts +36 -22
  48. package/src/services/NotificationService.ts +73 -61
  49. package/src/services/OrgsService.ts +135 -106
  50. package/src/services/OverviewService.ts +172 -73
  51. package/src/services/PerformanceService.ts +153 -77
  52. package/src/services/PerlearnerService.ts +591 -279
  53. package/src/services/PlatformService.ts +278 -157
  54. package/src/services/ProviderAssociationService.ts +4 -3
  55. package/src/services/ProvidersService.ts +36 -27
  56. package/src/services/ProvisionService.ts +4 -3
  57. package/src/services/RecommendationsService.ts +5 -4
  58. package/src/services/ReportsService.ts +28 -22
  59. package/src/services/RolesService.ts +10 -8
  60. package/src/services/SearchService.ts +323 -98
  61. package/src/services/ServiceService.ts +49 -39
  62. package/src/services/SkillsService.ts +56 -44
  63. package/src/services/UserGroupsService.ts +56 -19
@@ -47,11 +47,12 @@ export declare class CoreService {
47
47
  * Params:
48
48
  * - Any of user_id, username, or email (choose one only, required)
49
49
  * - platform_key: str (required)
50
- * @param requestBody
51
50
  * @returns TokenProxyOutput
52
51
  * @throws ApiError
53
52
  */
54
- static coreConsolidatedTokenProxyCreate(requestBody: TokenProxyInput): CancelablePromise<TokenProxyOutput>;
53
+ static coreConsolidatedTokenProxyCreate({ requestBody, }: {
54
+ requestBody: TokenProxyInput;
55
+ }): CancelablePromise<TokenProxyOutput>;
55
56
  /**
56
57
  * Show (active) departments associated with a platform
57
58
  * @returns any No response body
@@ -102,19 +103,21 @@ export declare class CoreService {
102
103
  static coreDepartmentsMembersCheckRetrieve(): CancelablePromise<any>;
103
104
  /**
104
105
  * Check if a domain is whitelisted
105
- * @param url
106
- * @param isActive
107
106
  * @returns any No response body
108
107
  * @throws ApiError
109
108
  */
110
- static coreDomainsWhitelistRetrieve(url: string, isActive?: boolean): CancelablePromise<any>;
109
+ static coreDomainsWhitelistRetrieve({ url, isActive, }: {
110
+ url: string;
111
+ isActive?: boolean;
112
+ }): CancelablePromise<any>;
111
113
  /**
112
114
  * Add a new domain to whitelist
113
- * @param requestBody
114
115
  * @returns WhitelistedDomain
115
116
  * @throws ApiError
116
117
  */
117
- static coreDomainsWhitelistCreate(requestBody: WhitelistedDomain): CancelablePromise<WhitelistedDomain>;
118
+ static coreDomainsWhitelistCreate({ requestBody, }: {
119
+ requestBody: WhitelistedDomain;
120
+ }): CancelablePromise<WhitelistedDomain>;
118
121
  /**
119
122
  * **Use Case**
120
123
  *
@@ -155,12 +158,12 @@ export declare class CoreService {
155
158
  * Params:
156
159
  * key
157
160
  * user_id: Optional
158
- * @param key
159
- * @param userId
160
161
  * @returns PlatformList
161
162
  * @throws ApiError
162
163
  */
163
- static coreLauncherRetrieve(key: string, userId?: number): CancelablePromise<PlatformList>;
164
+ static coreLauncherRetrieve({ key, userId, }: {
165
+ key: string;
166
+ }): CancelablePromise<PlatformList>;
164
167
  /**
165
168
  * POST: Launch a new edX platform
166
169
  *
@@ -172,197 +175,240 @@ export declare class CoreService {
172
175
  * lms_url: LMS URL ("optional")
173
176
  * cms_url: CMS URL ("optional")
174
177
  * portal_url: Portal URL ("optional")
175
- * @param requestBody
176
178
  * @returns PlatformList
177
179
  * @throws ApiError
178
180
  */
179
- static coreLauncherCreate(requestBody: LauncherViewPostRequest): CancelablePromise<PlatformList>;
181
+ static coreLauncherCreate({ requestBody, }: {
182
+ requestBody: LauncherViewPostRequest;
183
+ }): CancelablePromise<PlatformList>;
180
184
  /**
181
185
  * List your LTI Provider Key's
182
- * @param platformKey Platform Key
183
186
  * @returns LtiKey
184
187
  * @throws ApiError
185
188
  */
186
- static coreLti1P3ProviderLtiKeysList(platformKey: string): CancelablePromise<Array<LtiKey>>;
189
+ static coreLti1P3ProviderLtiKeysList({ platformKey, }: {
190
+ /**
191
+ * Platform Key
192
+ */
193
+ platformKey: string;
194
+ }): CancelablePromise<Array<LtiKey>>;
187
195
  /**
188
196
  * Create a new LTI Provider Key
189
- * @param requestBody
190
197
  * @returns LtiKey
191
198
  * @throws ApiError
192
199
  */
193
- static coreLti1P3ProviderLtiKeysCreate(requestBody: LtiKey): CancelablePromise<LtiKey>;
200
+ static coreLti1P3ProviderLtiKeysCreate({ requestBody, }: {
201
+ requestBody: LtiKey;
202
+ }): CancelablePromise<LtiKey>;
194
203
  /**
195
204
  * Get details about a specific LTI Provider Key
196
- * @param id
197
- * @param platformKey Platform Key
198
205
  * @returns LtiKey
199
206
  * @throws ApiError
200
207
  */
201
- static coreLti1P3ProviderLtiKeysRetrieve(id: string, platformKey: string): CancelablePromise<LtiKey>;
208
+ static coreLti1P3ProviderLtiKeysRetrieve({ id, platformKey, }: {
209
+ id: string;
210
+ /**
211
+ * Platform Key
212
+ */
213
+ platformKey: string;
214
+ }): CancelablePromise<LtiKey>;
202
215
  /**
203
216
  * Update an LTI Provider Key
204
- * @param id
205
- * @param requestBody
206
217
  * @returns LtiKey
207
218
  * @throws ApiError
208
219
  */
209
- static coreLti1P3ProviderLtiKeysUpdate(id: string, requestBody: LtiKey): CancelablePromise<LtiKey>;
220
+ static coreLti1P3ProviderLtiKeysUpdate({ id, requestBody, }: {
221
+ id: string;
222
+ requestBody: LtiKey;
223
+ }): CancelablePromise<LtiKey>;
210
224
  /**
211
225
  * Delete an LTI Provider Key
212
226
  *
213
227
  * **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.
214
- * @param id
215
- * @param platformKey Platform Key
216
228
  * @returns void
217
229
  * @throws ApiError
218
230
  */
219
- static coreLti1P3ProviderLtiKeysDestroy(id: string, platformKey: string): CancelablePromise<void>;
231
+ static coreLti1P3ProviderLtiKeysDestroy({ id, platformKey, }: {
232
+ id: string;
233
+ /**
234
+ * Platform Key
235
+ */
236
+ platformKey: string;
237
+ }): CancelablePromise<void>;
220
238
  /**
221
239
  * List your LTI Tool's
222
- * @param platformKey Platform Key
223
240
  * @returns LtiTool
224
241
  * @throws ApiError
225
242
  */
226
- static coreLti1P3ProviderLtiToolsList(platformKey: string): CancelablePromise<Array<LtiTool>>;
243
+ static coreLti1P3ProviderLtiToolsList({ platformKey, }: {
244
+ /**
245
+ * Platform Key
246
+ */
247
+ platformKey: string;
248
+ }): CancelablePromise<Array<LtiTool>>;
227
249
  /**
228
250
  * Create a new LTI Tool
229
- * @param requestBody
230
251
  * @returns LtiTool
231
252
  * @throws ApiError
232
253
  */
233
- static coreLti1P3ProviderLtiToolsCreate(requestBody: LtiTool): CancelablePromise<LtiTool>;
254
+ static coreLti1P3ProviderLtiToolsCreate({ requestBody, }: {
255
+ requestBody: LtiTool;
256
+ }): CancelablePromise<LtiTool>;
234
257
  /**
235
258
  * Get details about a specific LTI Tool
236
- * @param id
237
- * @param platformKey Platform Key
238
259
  * @returns LtiTool
239
260
  * @throws ApiError
240
261
  */
241
- static coreLti1P3ProviderLtiToolsRetrieve(id: string, platformKey: string): CancelablePromise<LtiTool>;
262
+ static coreLti1P3ProviderLtiToolsRetrieve({ id, platformKey, }: {
263
+ id: string;
264
+ /**
265
+ * Platform Key
266
+ */
267
+ platformKey: string;
268
+ }): CancelablePromise<LtiTool>;
242
269
  /**
243
270
  * Update an LTI Tool
244
- * @param id
245
- * @param requestBody
246
271
  * @returns LtiTool
247
272
  * @throws ApiError
248
273
  */
249
- static coreLti1P3ProviderLtiToolsUpdate(id: string, requestBody: LtiTool): CancelablePromise<LtiTool>;
274
+ static coreLti1P3ProviderLtiToolsUpdate({ id, requestBody, }: {
275
+ id: string;
276
+ requestBody: LtiTool;
277
+ }): CancelablePromise<LtiTool>;
250
278
  /**
251
279
  * Delete an LTI Tool
252
- * @param id
253
- * @param platformKey Platform Key
254
280
  * @returns void
255
281
  * @throws ApiError
256
282
  */
257
- static coreLti1P3ProviderLtiToolsDestroy(id: string, platformKey: string): CancelablePromise<void>;
283
+ static coreLti1P3ProviderLtiToolsDestroy({ id, platformKey, }: {
284
+ id: string;
285
+ /**
286
+ * Platform Key
287
+ */
288
+ platformKey: string;
289
+ }): CancelablePromise<void>;
258
290
  /**
259
291
  * Get platform logo
260
- * @param org
261
292
  * @returns any
262
293
  * @throws ApiError
263
294
  */
264
- static coreOrgsDarkModeLogoRetrieve(org: string): CancelablePromise<Record<string, any>>;
295
+ static coreOrgsDarkModeLogoRetrieve({ org, }: {
296
+ org: string;
297
+ }): CancelablePromise<Record<string, any>>;
265
298
  /**
266
299
  * Upload a new platform logo
267
- * @param org
268
- * @param requestBody
269
300
  * @returns ImageUpload
270
301
  * @throws ApiError
271
302
  */
272
- static coreOrgsDarkModeLogoCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
303
+ static coreOrgsDarkModeLogoCreateCreate({ org, requestBody, }: {
304
+ org: string;
305
+ requestBody: ImageUpload;
306
+ }): CancelablePromise<ImageUpload>;
273
307
  /**
274
308
  * Get platform logo
275
- * @param org
276
309
  * @returns any
277
310
  * @throws ApiError
278
311
  */
279
- static coreOrgsFaviconRetrieve(org: string): CancelablePromise<Record<string, any>>;
312
+ static coreOrgsFaviconRetrieve({ org, }: {
313
+ org: string;
314
+ }): CancelablePromise<Record<string, any>>;
280
315
  /**
281
316
  * Upload a new platform logo
282
- * @param org
283
- * @param requestBody
284
317
  * @returns ImageUpload
285
318
  * @throws ApiError
286
319
  */
287
- static coreOrgsFaviconCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
320
+ static coreOrgsFaviconCreateCreate({ org, requestBody, }: {
321
+ org: string;
322
+ requestBody: ImageUpload;
323
+ }): CancelablePromise<ImageUpload>;
288
324
  /**
289
325
  * Get platform logo
290
- * @param org
291
326
  * @returns any
292
327
  * @throws ApiError
293
328
  */
294
- static coreOrgsLogoRetrieve(org: string): CancelablePromise<Record<string, any>>;
329
+ static coreOrgsLogoRetrieve({ org, }: {
330
+ org: string;
331
+ }): CancelablePromise<Record<string, any>>;
295
332
  /**
296
333
  * Upload a new platform logo
297
- * @param org
298
- * @param requestBody
299
334
  * @returns ImageUpload
300
335
  * @throws ApiError
301
336
  */
302
- static coreOrgsLogoCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
337
+ static coreOrgsLogoCreateCreate({ org, requestBody, }: {
338
+ org: string;
339
+ requestBody: ImageUpload;
340
+ }): CancelablePromise<ImageUpload>;
303
341
  /**
304
- * @param org
305
342
  * @returns PlatformPublicMetadata
306
343
  * @throws ApiError
307
344
  */
308
- static coreOrgsMetadataRetrieve(org: string): CancelablePromise<PlatformPublicMetadata>;
345
+ static coreOrgsMetadataRetrieve({ org, }: {
346
+ org: string;
347
+ }): CancelablePromise<PlatformPublicMetadata>;
309
348
  /**
310
- * @param org
311
- * @param requestBody
312
349
  * @returns PlatformPublicMetadata
313
350
  * @throws ApiError
314
351
  */
315
- static coreOrgsMetadataUpdate(org: string, requestBody?: PlatformPublicMetadata): CancelablePromise<PlatformPublicMetadata>;
352
+ static coreOrgsMetadataUpdate({ org, requestBody, }: {
353
+ org: string;
354
+ requestBody?: PlatformPublicMetadata;
355
+ }): CancelablePromise<PlatformPublicMetadata>;
316
356
  /**
317
- * @param org
318
- * @param requestBody
319
357
  * @returns PlatformPublicMetadata
320
358
  * @throws ApiError
321
359
  */
322
- static coreOrgsMetadataPartialUpdate(org: string, requestBody?: PatchedPlatformPublicMetadata): CancelablePromise<PlatformPublicMetadata>;
360
+ static coreOrgsMetadataPartialUpdate({ org, requestBody, }: {
361
+ org: string;
362
+ requestBody?: PatchedPlatformPublicMetadata;
363
+ }): CancelablePromise<PlatformPublicMetadata>;
323
364
  /**
324
365
  * Creates redirect tokens for a URL specified by for a platform
325
- * @param org
326
- * @param requestBody
327
366
  * @returns RedirectTokenResponse
328
367
  * @throws ApiError
329
368
  */
330
- static coreOrgsRedirectTokensCreate(org: string, requestBody: RedirectTokenRequest): CancelablePromise<RedirectTokenResponse>;
369
+ static coreOrgsRedirectTokensCreate({ org, requestBody, }: {
370
+ org: string;
371
+ requestBody: RedirectTokenRequest;
372
+ }): CancelablePromise<RedirectTokenResponse>;
331
373
  /**
332
374
  * Returns Redirect URL for the token specified.
333
375
  *
334
376
  * ```
335
377
  * Requires user to be a member of the platform with the token passed
336
378
  * ```
337
- * @param org
338
- * @param redirectToken
339
379
  * @returns RedirectTokenResponse
340
380
  * @throws ApiError
341
381
  */
342
- static coreOrgsRedirectTokensRetrieve(org: string, redirectToken: string): CancelablePromise<RedirectTokenResponse>;
382
+ static coreOrgsRedirectTokensRetrieve({ org, redirectToken, }: {
383
+ org: string;
384
+ redirectToken: string;
385
+ }): CancelablePromise<RedirectTokenResponse>;
343
386
  /**
344
387
  * Delete specific token
345
- * @param org
346
- * @param redirectToken
347
388
  * @returns void
348
389
  * @throws ApiError
349
390
  */
350
- static coreOrgsRedirectTokensDeleteDestroy(org: string, redirectToken: string): CancelablePromise<void>;
391
+ static coreOrgsRedirectTokensDeleteDestroy({ org, redirectToken, }: {
392
+ org: string;
393
+ redirectToken: string;
394
+ }): CancelablePromise<void>;
351
395
  /**
352
396
  * Get platform logo
353
- * @param org
354
397
  * @returns any
355
398
  * @throws ApiError
356
399
  */
357
- static coreOrgsThumbnailRetrieve(org: string): CancelablePromise<Record<string, any>>;
400
+ static coreOrgsThumbnailRetrieve({ org, }: {
401
+ org: string;
402
+ }): CancelablePromise<Record<string, any>>;
358
403
  /**
359
404
  * Upload a new platform logo
360
- * @param org
361
- * @param requestBody
362
405
  * @returns ImageUpload
363
406
  * @throws ApiError
364
407
  */
365
- static coreOrgsThumbnailCreateCreate(org: string, requestBody: ImageUpload): CancelablePromise<ImageUpload>;
408
+ static coreOrgsThumbnailCreateCreate({ org, requestBody, }: {
409
+ org: string;
410
+ requestBody: ImageUpload;
411
+ }): CancelablePromise<ImageUpload>;
366
412
  /**
367
413
  * GET /api/core/platform/
368
414
  * Get main platform info.
@@ -375,12 +421,12 @@ export declare class CoreService {
375
421
  * key
376
422
  * field_key (POST)
377
423
  * value (POST)
378
- * @param key
379
- * @param userId
380
424
  * @returns PlatformList
381
425
  * @throws ApiError
382
426
  */
383
- static corePlatformRetrieve(key: string, userId?: number): CancelablePromise<PlatformList>;
427
+ static corePlatformRetrieve({ key, userId, }: {
428
+ key: string;
429
+ }): CancelablePromise<PlatformList>;
384
430
  /**
385
431
  * Update platform object
386
432
  *
@@ -395,33 +441,43 @@ export declare class CoreService {
395
441
  * lms_url
396
442
  * cms_url
397
443
  * portal_url
398
- * @param requestBody
399
444
  * @returns PlatformList
400
445
  * @throws ApiError
401
446
  */
402
- static corePlatformCreate(requestBody: PlatformUpdatePostRequest): CancelablePromise<PlatformList>;
447
+ static corePlatformCreate({ requestBody, }: {
448
+ requestBody: PlatformUpdatePostRequest;
449
+ }): CancelablePromise<PlatformList>;
403
450
  /**
404
451
  * List Platform API Key's belonging to the target platform
405
- * @param platformKey Platform key of target platform
406
452
  * @returns PlatformApiKey
407
453
  * @throws ApiError
408
454
  */
409
- static corePlatformApiTokensList(platformKey: string): CancelablePromise<Array<PlatformApiKey>>;
455
+ static corePlatformApiTokensList({ platformKey, }: {
456
+ /**
457
+ * Platform key of target platform
458
+ */
459
+ platformKey: string;
460
+ }): CancelablePromise<Array<PlatformApiKey>>;
410
461
  /**
411
462
  * Create a new Platform Api Key for the target platform
412
- * @param requestBody
413
463
  * @returns PlatformApiKey
414
464
  * @throws ApiError
415
465
  */
416
- static corePlatformApiTokensCreate(requestBody: PlatformApiKey): CancelablePromise<PlatformApiKey>;
466
+ static corePlatformApiTokensCreate({ requestBody, }: {
467
+ requestBody: PlatformApiKey;
468
+ }): CancelablePromise<PlatformApiKey>;
417
469
  /**
418
470
  * Delete Platform Api Key by name in the target platform
419
- * @param name
420
- * @param platformKey Platform key of target platform
421
471
  * @returns void
422
472
  * @throws ApiError
423
473
  */
424
- static corePlatformApiTokensDestroy(name: string, platformKey: string): CancelablePromise<void>;
474
+ static corePlatformApiTokensDestroy({ name, platformKey, }: {
475
+ name: string;
476
+ /**
477
+ * Platform key of target platform
478
+ */
479
+ platformKey: string;
480
+ }): CancelablePromise<void>;
425
481
  /**
426
482
  * GET /site
427
483
  * Get site settings.
@@ -434,12 +490,12 @@ export declare class CoreService {
434
490
  * key
435
491
  * field_key (POST)
436
492
  * value (POST)
437
- * @param key
438
- * @param userId
439
493
  * @returns any
440
494
  * @throws ApiError
441
495
  */
442
- static corePlatformConfigSiteRetrieve(key: string, userId?: number): CancelablePromise<Record<string, any>>;
496
+ static corePlatformConfigSiteRetrieve({ key, userId, }: {
497
+ key: string;
498
+ }): CancelablePromise<Record<string, any>>;
443
499
  /**
444
500
  * GET /site
445
501
  * Get site settings.
@@ -452,11 +508,12 @@ export declare class CoreService {
452
508
  * key
453
509
  * field_key (POST)
454
510
  * value (POST)
455
- * @param requestBody
456
511
  * @returns any
457
512
  * @throws ApiError
458
513
  */
459
- static corePlatformConfigSiteCreate(requestBody?: Record<string, any>): CancelablePromise<Record<string, any>>;
514
+ static corePlatformConfigSiteCreate({ requestBody, }: {
515
+ requestBody?: Record<string, any>;
516
+ }): CancelablePromise<Record<string, any>>;
460
517
  /**
461
518
  * Retrieve users associated with platform
462
519
  *
@@ -468,280 +525,428 @@ export declare class CoreService {
468
525
  * sort
469
526
  *
470
527
  * is_admin: Return tenant admin users
471
- * @param page
472
- * @param pageSize
473
- * @param platformKey
474
- * @param platformOrg
475
- * @param query
476
- * @param sort
477
528
  * @returns UserPlatformManagementListViewGetResponse
478
529
  * @throws ApiError
479
530
  */
480
- static corePlatformUsersRetrieve(page?: number, pageSize?: number, platformKey?: string, platformOrg?: string, query?: string, sort?: string): CancelablePromise<UserPlatformManagementListViewGetResponse>;
531
+ static corePlatformUsersRetrieve({ page, pageSize, platformKey, platformOrg, query, sort, }: {
532
+ page?: number;
533
+ pageSize?: number;
534
+ platformKey?: string;
535
+ platformOrg?: string;
536
+ query?: string;
537
+ sort?: string;
538
+ }): CancelablePromise<UserPlatformManagementListViewGetResponse>;
481
539
  /**
482
540
  * List group role assignments
483
541
  * Retrieve a list of group role assignments. Can be filtered by platform_key, group_id, or role_id.
484
- * @param groupId Filter group roles by group ID
485
- * @param page A page number within the paginated result set.
486
- * @param pageSize Number of results to return per page.
487
- * @param platformKey Filter group roles by platform key
488
- * @param roleId Filter group roles by role ID
489
542
  * @returns PaginatedRbacGroupRoleList
490
543
  * @throws ApiError
491
544
  */
492
- static coreRbacGroupRolesList(groupId?: number, page?: number, pageSize?: number, platformKey?: string, roleId?: number): CancelablePromise<PaginatedRbacGroupRoleList>;
545
+ static coreRbacGroupRolesList({ groupId, page, pageSize, platformKey, roleId, }: {
546
+ /**
547
+ * Filter group roles by group ID
548
+ */
549
+ groupId?: number;
550
+ /**
551
+ * A page number within the paginated result set.
552
+ */
553
+ page?: number;
554
+ /**
555
+ * Number of results to return per page.
556
+ */
557
+ pageSize?: number;
558
+ /**
559
+ * Filter group roles by platform key
560
+ */
561
+ platformKey?: string;
562
+ /**
563
+ * Filter group roles by role ID
564
+ */
565
+ roleId?: number;
566
+ }): CancelablePromise<PaginatedRbacGroupRoleList>;
493
567
  /**
494
568
  * Create group role assignment
495
569
  * Assign a role to a group. The group and role must belong to the same platform.
496
- * @param requestBody
497
570
  * @returns RbacGroupRole
498
571
  * @throws ApiError
499
572
  */
500
- static coreRbacGroupRolesCreate(requestBody: RbacGroupRole): CancelablePromise<RbacGroupRole>;
573
+ static coreRbacGroupRolesCreate({ requestBody, }: {
574
+ requestBody: RbacGroupRole;
575
+ }): CancelablePromise<RbacGroupRole>;
501
576
  /**
502
577
  * Retrieve group role assignment
503
578
  * Retrieve details of a specific group role assignment.
504
- * @param id A unique integer value identifying this RBAC Group Role.
505
579
  * @returns RbacGroupRole
506
580
  * @throws ApiError
507
581
  */
508
- static coreRbacGroupRolesRetrieve(id: number): CancelablePromise<RbacGroupRole>;
582
+ static coreRbacGroupRolesRetrieve({ id, }: {
583
+ /**
584
+ * A unique integer value identifying this RBAC Group Role.
585
+ */
586
+ id: number;
587
+ }): CancelablePromise<RbacGroupRole>;
509
588
  /**
510
589
  * Update group role assignment
511
590
  * Update an existing group role assignment. Platform validation applies.
512
- * @param id A unique integer value identifying this RBAC Group Role.
513
- * @param requestBody
514
591
  * @returns RbacGroupRole
515
592
  * @throws ApiError
516
593
  */
517
- static coreRbacGroupRolesUpdate(id: number, requestBody: RbacGroupRole): CancelablePromise<RbacGroupRole>;
594
+ static coreRbacGroupRolesUpdate({ id, requestBody, }: {
595
+ /**
596
+ * A unique integer value identifying this RBAC Group Role.
597
+ */
598
+ id: number;
599
+ requestBody: RbacGroupRole;
600
+ }): CancelablePromise<RbacGroupRole>;
518
601
  /**
519
602
  * Partially update group role assignment
520
603
  * Partially update an existing group role assignment. Platform validation applies.
521
- * @param id A unique integer value identifying this RBAC Group Role.
522
- * @param requestBody
523
604
  * @returns RbacGroupRole
524
605
  * @throws ApiError
525
606
  */
526
- static coreRbacGroupRolesPartialUpdate(id: number, requestBody?: PatchedRbacGroupRole): CancelablePromise<RbacGroupRole>;
607
+ static coreRbacGroupRolesPartialUpdate({ id, requestBody, }: {
608
+ /**
609
+ * A unique integer value identifying this RBAC Group Role.
610
+ */
611
+ id: number;
612
+ requestBody?: PatchedRbacGroupRole;
613
+ }): CancelablePromise<RbacGroupRole>;
527
614
  /**
528
615
  * Delete group role assignment
529
616
  * Remove a role assignment from a group.
530
- * @param id A unique integer value identifying this RBAC Group Role.
531
617
  * @returns void
532
618
  * @throws ApiError
533
619
  */
534
- static coreRbacGroupRolesDestroy(id: number): CancelablePromise<void>;
620
+ static coreRbacGroupRolesDestroy({ id, }: {
621
+ /**
622
+ * A unique integer value identifying this RBAC Group Role.
623
+ */
624
+ id: number;
625
+ }): CancelablePromise<void>;
535
626
  /**
536
627
  * List RBAC groups
537
628
  * Retrieve a list of RBAC groups. Can be filtered by platform_key.
538
- * @param page A page number within the paginated result set.
539
- * @param pageSize Number of results to return per page.
540
- * @param platformKey Filter groups by platform key
541
629
  * @returns PaginatedRbacGroupList
542
630
  * @throws ApiError
543
631
  */
544
- static coreRbacGroupsList(page?: number, pageSize?: number, platformKey?: string): CancelablePromise<PaginatedRbacGroupList>;
632
+ static coreRbacGroupsList({ page, pageSize, platformKey, }: {
633
+ /**
634
+ * A page number within the paginated result set.
635
+ */
636
+ page?: number;
637
+ /**
638
+ * Number of results to return per page.
639
+ */
640
+ pageSize?: number;
641
+ /**
642
+ * Filter groups by platform key
643
+ */
644
+ platformKey?: string;
645
+ }): CancelablePromise<PaginatedRbacGroupList>;
545
646
  /**
546
647
  * Create RBAC group
547
648
  * Create a new RBAC group for a platform. Users can be assigned during creation.
548
- * @param requestBody
549
649
  * @returns RbacGroup
550
650
  * @throws ApiError
551
651
  */
552
- static coreRbacGroupsCreate(requestBody: RbacGroup): CancelablePromise<RbacGroup>;
652
+ static coreRbacGroupsCreate({ requestBody, }: {
653
+ requestBody: RbacGroup;
654
+ }): CancelablePromise<RbacGroup>;
553
655
  /**
554
656
  * Retrieve RBAC group
555
657
  * Retrieve details of a specific RBAC group including assigned users.
556
- * @param id A unique integer value identifying this RBAC Group.
557
658
  * @returns RbacGroup
558
659
  * @throws ApiError
559
660
  */
560
- static coreRbacGroupsRetrieve(id: number): CancelablePromise<RbacGroup>;
661
+ static coreRbacGroupsRetrieve({ id, }: {
662
+ /**
663
+ * A unique integer value identifying this RBAC Group.
664
+ */
665
+ id: number;
666
+ }): CancelablePromise<RbacGroup>;
561
667
  /**
562
668
  * Update RBAC group
563
669
  * Update an existing RBAC group. Platform validation applies for user assignments.
564
- * @param id A unique integer value identifying this RBAC Group.
565
- * @param requestBody
566
670
  * @returns RbacGroup
567
671
  * @throws ApiError
568
672
  */
569
- static coreRbacGroupsUpdate(id: number, requestBody: RbacGroup): CancelablePromise<RbacGroup>;
673
+ static coreRbacGroupsUpdate({ id, requestBody, }: {
674
+ /**
675
+ * A unique integer value identifying this RBAC Group.
676
+ */
677
+ id: number;
678
+ requestBody: RbacGroup;
679
+ }): CancelablePromise<RbacGroup>;
570
680
  /**
571
681
  * Partially update RBAC group
572
682
  * Partially update an existing RBAC group. Platform validation applies for user assignments.
573
- * @param id A unique integer value identifying this RBAC Group.
574
- * @param requestBody
575
683
  * @returns RbacGroup
576
684
  * @throws ApiError
577
685
  */
578
- static coreRbacGroupsPartialUpdate(id: number, requestBody?: PatchedRbacGroup): CancelablePromise<RbacGroup>;
686
+ static coreRbacGroupsPartialUpdate({ id, requestBody, }: {
687
+ /**
688
+ * A unique integer value identifying this RBAC Group.
689
+ */
690
+ id: number;
691
+ requestBody?: PatchedRbacGroup;
692
+ }): CancelablePromise<RbacGroup>;
579
693
  /**
580
694
  * Delete RBAC group
581
695
  * Delete an RBAC group and all associated group role assignments.
582
- * @param id A unique integer value identifying this RBAC Group.
583
696
  * @returns void
584
697
  * @throws ApiError
585
698
  */
586
- static coreRbacGroupsDestroy(id: number): CancelablePromise<void>;
699
+ static coreRbacGroupsDestroy({ id, }: {
700
+ /**
701
+ * A unique integer value identifying this RBAC Group.
702
+ */
703
+ id: number;
704
+ }): CancelablePromise<void>;
587
705
  /**
588
706
  * List RBAC policies
589
707
  * Retrieve a list of RBAC policies. Can be filtered by platform_key or role_id.
590
- * @param page A page number within the paginated result set.
591
- * @param pageSize Number of results to return per page.
592
- * @param platformKey Filter policies by platform key
593
- * @param roleId Filter policies by role ID
594
708
  * @returns PaginatedRbacPolicyList
595
709
  * @throws ApiError
596
710
  */
597
- static coreRbacPoliciesList(page?: number, pageSize?: number, platformKey?: string, roleId?: number): CancelablePromise<PaginatedRbacPolicyList>;
711
+ static coreRbacPoliciesList({ page, pageSize, platformKey, roleId, }: {
712
+ /**
713
+ * A page number within the paginated result set.
714
+ */
715
+ page?: number;
716
+ /**
717
+ * Number of results to return per page.
718
+ */
719
+ pageSize?: number;
720
+ /**
721
+ * Filter policies by platform key
722
+ */
723
+ platformKey?: string;
724
+ /**
725
+ * Filter policies by role ID
726
+ */
727
+ roleId?: number;
728
+ }): CancelablePromise<PaginatedRbacPolicyList>;
598
729
  /**
599
730
  * Create RBAC policy
600
731
  * Create a new RBAC policy that defines resource access for a role.
601
- * @param requestBody
602
732
  * @returns RbacPolicy
603
733
  * @throws ApiError
604
734
  */
605
- static coreRbacPoliciesCreate(requestBody: RbacPolicy): CancelablePromise<RbacPolicy>;
735
+ static coreRbacPoliciesCreate({ requestBody, }: {
736
+ requestBody: RbacPolicy;
737
+ }): CancelablePromise<RbacPolicy>;
606
738
  /**
607
739
  * Retrieve RBAC policy
608
740
  * Retrieve details of a specific RBAC policy.
609
- * @param id A unique integer value identifying this RBAC Policy.
610
741
  * @returns RbacPolicy
611
742
  * @throws ApiError
612
743
  */
613
- static coreRbacPoliciesRetrieve(id: number): CancelablePromise<RbacPolicy>;
744
+ static coreRbacPoliciesRetrieve({ id, }: {
745
+ /**
746
+ * A unique integer value identifying this RBAC Policy.
747
+ */
748
+ id: number;
749
+ }): CancelablePromise<RbacPolicy>;
614
750
  /**
615
751
  * Update RBAC policy
616
752
  * Update an existing RBAC policy.
617
- * @param id A unique integer value identifying this RBAC Policy.
618
- * @param requestBody
619
753
  * @returns RbacPolicy
620
754
  * @throws ApiError
621
755
  */
622
- static coreRbacPoliciesUpdate(id: number, requestBody: RbacPolicy): CancelablePromise<RbacPolicy>;
756
+ static coreRbacPoliciesUpdate({ id, requestBody, }: {
757
+ /**
758
+ * A unique integer value identifying this RBAC Policy.
759
+ */
760
+ id: number;
761
+ requestBody: RbacPolicy;
762
+ }): CancelablePromise<RbacPolicy>;
623
763
  /**
624
764
  * Partially update RBAC policy
625
765
  * Partially update an existing RBAC policy.
626
- * @param id A unique integer value identifying this RBAC Policy.
627
- * @param requestBody
628
766
  * @returns RbacPolicy
629
767
  * @throws ApiError
630
768
  */
631
- static coreRbacPoliciesPartialUpdate(id: number, requestBody?: PatchedRbacPolicy): CancelablePromise<RbacPolicy>;
769
+ static coreRbacPoliciesPartialUpdate({ id, requestBody, }: {
770
+ /**
771
+ * A unique integer value identifying this RBAC Policy.
772
+ */
773
+ id: number;
774
+ requestBody?: PatchedRbacPolicy;
775
+ }): CancelablePromise<RbacPolicy>;
632
776
  /**
633
777
  * Delete RBAC policy
634
778
  * Delete an RBAC policy.
635
- * @param id A unique integer value identifying this RBAC Policy.
636
779
  * @returns void
637
780
  * @throws ApiError
638
781
  */
639
- static coreRbacPoliciesDestroy(id: number): CancelablePromise<void>;
782
+ static coreRbacPoliciesDestroy({ id, }: {
783
+ /**
784
+ * A unique integer value identifying this RBAC Policy.
785
+ */
786
+ id: number;
787
+ }): CancelablePromise<void>;
640
788
  /**
641
789
  * List RBAC roles
642
790
  * Retrieve a list of RBAC roles. Can be filtered by platform_key.
643
- * @param page A page number within the paginated result set.
644
- * @param pageSize Number of results to return per page.
645
- * @param platformKey Filter roles by platform key
646
791
  * @returns PaginatedRbacRoleList
647
792
  * @throws ApiError
648
793
  */
649
- static coreRbacRolesList(page?: number, pageSize?: number, platformKey?: string): CancelablePromise<PaginatedRbacRoleList>;
794
+ static coreRbacRolesList({ page, pageSize, platformKey, }: {
795
+ /**
796
+ * A page number within the paginated result set.
797
+ */
798
+ page?: number;
799
+ /**
800
+ * Number of results to return per page.
801
+ */
802
+ pageSize?: number;
803
+ /**
804
+ * Filter roles by platform key
805
+ */
806
+ platformKey?: string;
807
+ }): CancelablePromise<PaginatedRbacRoleList>;
650
808
  /**
651
809
  * Create RBAC role
652
810
  * Create a new RBAC role for a platform.
653
- * @param requestBody
654
811
  * @returns RbacRole
655
812
  * @throws ApiError
656
813
  */
657
- static coreRbacRolesCreate(requestBody: RbacRole): CancelablePromise<RbacRole>;
814
+ static coreRbacRolesCreate({ requestBody, }: {
815
+ requestBody: RbacRole;
816
+ }): CancelablePromise<RbacRole>;
658
817
  /**
659
818
  * Retrieve RBAC role
660
819
  * Retrieve details of a specific RBAC role.
661
- * @param id A unique integer value identifying this RBAC Role.
662
820
  * @returns RbacRole
663
821
  * @throws ApiError
664
822
  */
665
- static coreRbacRolesRetrieve(id: number): CancelablePromise<RbacRole>;
823
+ static coreRbacRolesRetrieve({ id, }: {
824
+ /**
825
+ * A unique integer value identifying this RBAC Role.
826
+ */
827
+ id: number;
828
+ }): CancelablePromise<RbacRole>;
666
829
  /**
667
830
  * Update RBAC role
668
831
  * Update an existing RBAC role.
669
- * @param id A unique integer value identifying this RBAC Role.
670
- * @param requestBody
671
832
  * @returns RbacRole
672
833
  * @throws ApiError
673
834
  */
674
- static coreRbacRolesUpdate(id: number, requestBody: RbacRole): CancelablePromise<RbacRole>;
835
+ static coreRbacRolesUpdate({ id, requestBody, }: {
836
+ /**
837
+ * A unique integer value identifying this RBAC Role.
838
+ */
839
+ id: number;
840
+ requestBody: RbacRole;
841
+ }): CancelablePromise<RbacRole>;
675
842
  /**
676
843
  * Partially update RBAC role
677
844
  * Partially update an existing RBAC role.
678
- * @param id A unique integer value identifying this RBAC Role.
679
- * @param requestBody
680
845
  * @returns RbacRole
681
846
  * @throws ApiError
682
847
  */
683
- static coreRbacRolesPartialUpdate(id: number, requestBody?: PatchedRbacRole): CancelablePromise<RbacRole>;
848
+ static coreRbacRolesPartialUpdate({ id, requestBody, }: {
849
+ /**
850
+ * A unique integer value identifying this RBAC Role.
851
+ */
852
+ id: number;
853
+ requestBody?: PatchedRbacRole;
854
+ }): CancelablePromise<RbacRole>;
684
855
  /**
685
856
  * Delete RBAC role
686
857
  * Delete an RBAC role.
687
- * @param id A unique integer value identifying this RBAC Role.
688
858
  * @returns void
689
859
  * @throws ApiError
690
860
  */
691
- static coreRbacRolesDestroy(id: number): CancelablePromise<void>;
861
+ static coreRbacRolesDestroy({ id, }: {
862
+ /**
863
+ * A unique integer value identifying this RBAC Role.
864
+ */
865
+ id: number;
866
+ }): CancelablePromise<void>;
692
867
  /**
693
868
  * List user role assignments
694
869
  * Retrieve a list of user role assignments. Can be filtered by platform_key or user_id.
695
- * @param page A page number within the paginated result set.
696
- * @param pageSize Number of results to return per page.
697
- * @param platformKey Filter user roles by platform key
698
- * @param userId Filter user roles by user ID
699
870
  * @returns PaginatedRbacUserRoleList
700
871
  * @throws ApiError
701
872
  */
702
- static coreRbacUserRolesList(page?: number, pageSize?: number, platformKey?: string, userId?: number): CancelablePromise<PaginatedRbacUserRoleList>;
873
+ static coreRbacUserRolesList({ page, pageSize, platformKey, userId, }: {
874
+ /**
875
+ * A page number within the paginated result set.
876
+ */
877
+ page?: number;
878
+ /**
879
+ * Number of results to return per page.
880
+ */
881
+ pageSize?: number;
882
+ /**
883
+ * Filter user roles by platform key
884
+ */
885
+ platformKey?: string;
886
+ /**
887
+ * Filter user roles by user ID
888
+ */
889
+ userId?: number;
890
+ }): CancelablePromise<PaginatedRbacUserRoleList>;
703
891
  /**
704
892
  * Create user role assignment
705
893
  * Assign a role to a user. The user must belong to the same platform as the role.
706
- * @param requestBody
707
894
  * @returns RbacUserRole
708
895
  * @throws ApiError
709
896
  */
710
- static coreRbacUserRolesCreate(requestBody: RbacUserRole): CancelablePromise<RbacUserRole>;
897
+ static coreRbacUserRolesCreate({ requestBody, }: {
898
+ requestBody: RbacUserRole;
899
+ }): CancelablePromise<RbacUserRole>;
711
900
  /**
712
901
  * Retrieve user role assignment
713
902
  * Retrieve details of a specific user role assignment.
714
- * @param id A unique integer value identifying this RBAC User Role.
715
903
  * @returns RbacUserRole
716
904
  * @throws ApiError
717
905
  */
718
- static coreRbacUserRolesRetrieve(id: number): CancelablePromise<RbacUserRole>;
906
+ static coreRbacUserRolesRetrieve({ id, }: {
907
+ /**
908
+ * A unique integer value identifying this RBAC User Role.
909
+ */
910
+ id: number;
911
+ }): CancelablePromise<RbacUserRole>;
719
912
  /**
720
913
  * Update user role assignment
721
914
  * Update an existing user role assignment. Platform validation applies.
722
- * @param id A unique integer value identifying this RBAC User Role.
723
- * @param requestBody
724
915
  * @returns RbacUserRole
725
916
  * @throws ApiError
726
917
  */
727
- static coreRbacUserRolesUpdate(id: number, requestBody: RbacUserRole): CancelablePromise<RbacUserRole>;
918
+ static coreRbacUserRolesUpdate({ id, requestBody, }: {
919
+ /**
920
+ * A unique integer value identifying this RBAC User Role.
921
+ */
922
+ id: number;
923
+ requestBody: RbacUserRole;
924
+ }): CancelablePromise<RbacUserRole>;
728
925
  /**
729
926
  * Partially update user role assignment
730
927
  * Partially update an existing user role assignment. Platform validation applies.
731
- * @param id A unique integer value identifying this RBAC User Role.
732
- * @param requestBody
733
928
  * @returns RbacUserRole
734
929
  * @throws ApiError
735
930
  */
736
- static coreRbacUserRolesPartialUpdate(id: number, requestBody?: PatchedRbacUserRole): CancelablePromise<RbacUserRole>;
931
+ static coreRbacUserRolesPartialUpdate({ id, requestBody, }: {
932
+ /**
933
+ * A unique integer value identifying this RBAC User Role.
934
+ */
935
+ id: number;
936
+ requestBody?: PatchedRbacUserRole;
937
+ }): CancelablePromise<RbacUserRole>;
737
938
  /**
738
939
  * Delete user role assignment
739
940
  * Remove a role assignment from a user.
740
- * @param id A unique integer value identifying this RBAC User Role.
741
941
  * @returns void
742
942
  * @throws ApiError
743
943
  */
744
- static coreRbacUserRolesDestroy(id: number): CancelablePromise<void>;
944
+ static coreRbacUserRolesDestroy({ id, }: {
945
+ /**
946
+ * A unique integer value identifying this RBAC User Role.
947
+ */
948
+ id: number;
949
+ }): CancelablePromise<void>;
745
950
  /**
746
951
  * Invalidate all tokens for the authenticated user
747
952
  * @returns any No response body
@@ -750,11 +955,12 @@ export declare class CoreService {
750
955
  static coreSessionLogoutCreate(): CancelablePromise<any>;
751
956
  /**
752
957
  * POST signals/edx/
753
- * @param requestBody
754
958
  * @returns any No response body
755
959
  * @throws ApiError
756
960
  */
757
- static coreSignalsEdxCreate(requestBody: EdxSignalReceiverRequest): CancelablePromise<any>;
961
+ static coreSignalsEdxCreate({ requestBody, }: {
962
+ requestBody: EdxSignalReceiverRequest;
963
+ }): CancelablePromise<any>;
758
964
  /**
759
965
  * Param:
760
966
  * Any of user_id/username/email
@@ -814,23 +1020,24 @@ export declare class CoreService {
814
1020
  static coreUserGroupsLinkBulkCreate(): CancelablePromise<any>;
815
1021
  /**
816
1022
  * Initiates the account deletion process for the authenticated user or specified username.
817
- * @param requestBody
818
1023
  * @returns UserDeleteAPIResponse
819
1024
  * @throws ApiError
820
1025
  */
821
- static coreUsersDeleteCreate(requestBody?: UserDeleteAPIRequest): CancelablePromise<UserDeleteAPIResponse>;
1026
+ static coreUsersDeleteCreate({ requestBody, }: {
1027
+ requestBody?: UserDeleteAPIRequest;
1028
+ }): CancelablePromise<UserDeleteAPIResponse>;
822
1029
  /**
823
1030
  * Get detailed user information.
824
1031
  *
825
1032
  * Make permission check for platform admins here,
826
1033
  * then proxy request to edx.
827
- * @param email
828
- * @param userId
829
- * @param username
830
1034
  * @returns any No response body
831
1035
  * @throws ApiError
832
1036
  */
833
- static coreUsersMetadataProxyRetrieve(email?: string, userId?: number, username?: string): CancelablePromise<any>;
1037
+ static coreUsersMetadataProxyRetrieve({ email, userId, username, }: {
1038
+ email?: string;
1039
+ username?: string;
1040
+ }): CancelablePromise<any>;
834
1041
  /**
835
1042
  * Retrieve platforms associated with user_id
836
1043
  *
@@ -838,13 +1045,13 @@ export declare class CoreService {
838
1045
  * user_id
839
1046
  * username
840
1047
  * email
841
- * @param email
842
- * @param userId
843
- * @param username
844
1048
  * @returns UserPlatformLink
845
1049
  * @throws ApiError
846
1050
  */
847
- static coreUsersPlatformsList(email?: string, userId?: number, username?: string): CancelablePromise<Array<UserPlatformLink>>;
1051
+ static coreUsersPlatformsList({ email, userId, username, }: {
1052
+ email?: string;
1053
+ username?: string;
1054
+ }): CancelablePromise<Array<UserPlatformLink>>;
848
1055
  /**
849
1056
  * Explicitly link platform to user_id
850
1057
  *
@@ -855,20 +1062,21 @@ export declare class CoreService {
855
1062
  * expired_on (optional)
856
1063
  * is_admin (optional)
857
1064
  * active (optional)
858
- * @param requestBody
859
1065
  * @returns any No response body
860
1066
  * @throws ApiError
861
1067
  */
862
- static coreUsersPlatformsCreate(requestBody: UserPlatformViewPostRequest): CancelablePromise<any>;
1068
+ static coreUsersPlatformsCreate({ requestBody, }: {
1069
+ requestBody: UserPlatformViewPostRequest;
1070
+ }): CancelablePromise<any>;
863
1071
  /**
864
1072
  * Retrieve proxy user information by user_id
865
- * @param email
866
- * @param userId
867
- * @param username
868
1073
  * @returns UserProxyGetResponse
869
1074
  * @throws ApiError
870
1075
  */
871
- static coreUsersProxyRetrieve(email?: string, userId?: number, username?: string): CancelablePromise<UserProxyGetResponse>;
1076
+ static coreUsersProxyRetrieve({ email, userId, username, }: {
1077
+ email?: string;
1078
+ username?: string;
1079
+ }): CancelablePromise<UserProxyGetResponse>;
872
1080
  /**
873
1081
  * Add proxy user
874
1082
  *
@@ -878,11 +1086,12 @@ export declare class CoreService {
878
1086
  * email
879
1087
  * edx_data
880
1088
  * data
881
- * @param requestBody
882
1089
  * @returns UserProxyPostResponse
883
1090
  * @throws ApiError
884
1091
  */
885
- static coreUsersProxyCreate(requestBody: UserProxyPostRequest): CancelablePromise<UserProxyPostResponse>;
1092
+ static coreUsersProxyCreate({ requestBody, }: {
1093
+ requestBody: UserProxyPostRequest;
1094
+ }): CancelablePromise<UserProxyPostResponse>;
886
1095
  /**
887
1096
  * Add proxy users by bulk
888
1097
  *
@@ -894,11 +1103,12 @@ export declare class CoreService {
894
1103
  * {"user_id": 2, ...}
895
1104
  * ]
896
1105
  * ```
897
- * @param requestBody
898
1106
  * @returns string
899
1107
  * @throws ApiError
900
1108
  */
901
- static coreUsersProxyBulkCreate(requestBody: UserProxyBulkRequest): CancelablePromise<Array<Record<string, string>>>;
1109
+ static coreUsersProxyBulkCreate({ requestBody, }: {
1110
+ requestBody: UserProxyBulkRequest;
1111
+ }): CancelablePromise<Array<Record<string, string>>>;
902
1112
  /**
903
1113
  * Retrieve users based on query
904
1114
  * Not intended for public use with multitenant platforms
@@ -906,12 +1116,13 @@ export declare class CoreService {
906
1116
  * Params:
907
1117
  * query
908
1118
  * sort
909
- * @param page
910
- * @param pageSize
911
- * @param query
912
- * @param sort
913
1119
  * @returns UserSearchViewGetResponse
914
1120
  * @throws ApiError
915
1121
  */
916
- static coreUsersSearchRetrieve(page?: number, pageSize?: number, query?: string, sort?: string): CancelablePromise<UserSearchViewGetResponse>;
1122
+ static coreUsersSearchRetrieve({ page, pageSize, query, sort, }: {
1123
+ page?: number;
1124
+ pageSize?: number;
1125
+ query?: string;
1126
+ sort?: string;
1127
+ }): CancelablePromise<UserSearchViewGetResponse>;
917
1128
  }