@iblai/iblai-api 4.305.0-core → 4.306.0-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 (71) hide show
  1. package/dist/index.cjs.js +1342 -207
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +1343 -208
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +1342 -207
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +25 -1
  8. package/dist/types/models/KindEnum.d.ts +8 -0
  9. package/dist/types/models/NotificationTemplateDetail.d.ts +3 -2
  10. package/dist/types/models/NotificationTemplateList.d.ts +3 -2
  11. package/dist/types/models/PatchedNotificationTemplateDetail.d.ts +3 -2
  12. package/dist/types/models/PatchedPlatformApplicationFormUpdate.d.ts +12 -0
  13. package/dist/types/models/PatchedPlatformApplicationNote.d.ts +8 -0
  14. package/dist/types/models/PatchedPlatformApplicationPlacementUpdate.d.ts +12 -0
  15. package/dist/types/models/PatchedPlatformApplicationUpdate.d.ts +6 -0
  16. package/dist/types/models/PlatformApplicationAdminSubmit.d.ts +6 -0
  17. package/dist/types/models/PlatformApplicationAttachmentUpload.d.ts +8 -0
  18. package/dist/types/models/PlatformApplicationCandidateLink.d.ts +8 -0
  19. package/dist/types/models/PlatformApplicationCourseAssignment.d.ts +7 -0
  20. package/dist/types/models/PlatformApplicationCourseAssignmentItem.d.ts +10 -0
  21. package/dist/types/models/PlatformApplicationCreate.d.ts +8 -0
  22. package/dist/types/models/PlatformApplicationDetail.d.ts +7 -0
  23. package/dist/types/models/PlatformApplicationFeeAction.d.ts +11 -0
  24. package/dist/types/models/PlatformApplicationFeeActionActionEnum.d.ts +12 -0
  25. package/dist/types/models/PlatformApplicationFormCreate.d.ts +12 -0
  26. package/dist/types/models/PlatformApplicationFormDetail.d.ts +9 -0
  27. package/dist/types/models/PlatformApplicationNote.d.ts +8 -0
  28. package/dist/types/models/PlatformApplicationPlacementCreate.d.ts +8 -0
  29. package/dist/types/models/PlatformApplicationPlacementItem.d.ts +11 -0
  30. package/dist/types/models/PlatformApplicationPlacementUpdateStatusEnum.d.ts +16 -0
  31. package/dist/types/models/PlatformApplicationSubmit.d.ts +6 -0
  32. package/dist/types/models/PlatformApplicationTransition.d.ts +11 -0
  33. package/dist/types/models/PlatformApplicationTransitionActionEnum.d.ts +16 -0
  34. package/dist/types/models/PlatformApplicationWaiver.d.ts +9 -0
  35. package/dist/types/models/{Type4b7Enum.d.ts → TypeB29Enum.d.ts} +3 -1
  36. package/dist/types/services/CatalogService.d.ts +648 -0
  37. package/dist/types/services/CoreService.d.ts +14 -0
  38. package/package.json +1 -1
  39. package/sdk_schema.yml +1893 -5
  40. package/src/core/OpenAPI.ts +1 -1
  41. package/src/index.ts +25 -1
  42. package/src/models/KindEnum.ts +12 -0
  43. package/src/models/NotificationTemplateDetail.ts +3 -2
  44. package/src/models/NotificationTemplateList.ts +3 -2
  45. package/src/models/PatchedNotificationTemplateDetail.ts +3 -2
  46. package/src/models/PatchedPlatformApplicationFormUpdate.ts +17 -0
  47. package/src/models/PatchedPlatformApplicationNote.ts +13 -0
  48. package/src/models/PatchedPlatformApplicationPlacementUpdate.ts +17 -0
  49. package/src/models/PatchedPlatformApplicationUpdate.ts +11 -0
  50. package/src/models/PlatformApplicationAdminSubmit.ts +11 -0
  51. package/src/models/PlatformApplicationAttachmentUpload.ts +13 -0
  52. package/src/models/PlatformApplicationCandidateLink.ts +13 -0
  53. package/src/models/PlatformApplicationCourseAssignment.ts +12 -0
  54. package/src/models/PlatformApplicationCourseAssignmentItem.ts +15 -0
  55. package/src/models/PlatformApplicationCreate.ts +13 -0
  56. package/src/models/PlatformApplicationDetail.ts +12 -0
  57. package/src/models/PlatformApplicationFeeAction.ts +16 -0
  58. package/src/models/PlatformApplicationFeeActionActionEnum.ts +16 -0
  59. package/src/models/PlatformApplicationFormCreate.ts +17 -0
  60. package/src/models/PlatformApplicationFormDetail.ts +14 -0
  61. package/src/models/PlatformApplicationNote.ts +13 -0
  62. package/src/models/PlatformApplicationPlacementCreate.ts +13 -0
  63. package/src/models/PlatformApplicationPlacementItem.ts +16 -0
  64. package/src/models/PlatformApplicationPlacementUpdateStatusEnum.ts +20 -0
  65. package/src/models/PlatformApplicationSubmit.ts +11 -0
  66. package/src/models/PlatformApplicationTransition.ts +16 -0
  67. package/src/models/PlatformApplicationTransitionActionEnum.ts +20 -0
  68. package/src/models/PlatformApplicationWaiver.ts +14 -0
  69. package/src/models/{Type4b7Enum.ts → TypeB29Enum.ts} +3 -1
  70. package/src/services/CatalogService.ts +1196 -0
  71. package/src/services/CoreService.ts +28 -0
@@ -68,6 +68,10 @@ import type { PaginatedSkill } from '../models/PaginatedSkill';
68
68
  import type { PaginatedUserLicense } from '../models/PaginatedUserLicense';
69
69
  import type { PaginatedUserLicenseAssignment } from '../models/PaginatedUserLicenseAssignment';
70
70
  import type { PaginatedUserLicenseGroupAssignment } from '../models/PaginatedUserLicenseGroupAssignment';
71
+ import type { PatchedPlatformApplicationFormUpdate } from '../models/PatchedPlatformApplicationFormUpdate';
72
+ import type { PatchedPlatformApplicationNote } from '../models/PatchedPlatformApplicationNote';
73
+ import type { PatchedPlatformApplicationPlacementUpdate } from '../models/PatchedPlatformApplicationPlacementUpdate';
74
+ import type { PatchedPlatformApplicationUpdate } from '../models/PatchedPlatformApplicationUpdate';
71
75
  import type { Pathway } from '../models/Pathway';
72
76
  import type { PathwayCompletionResponse } from '../models/PathwayCompletionResponse';
73
77
  import type { PathwayCreateUpdateRequest } from '../models/PathwayCreateUpdateRequest';
@@ -81,6 +85,20 @@ import type { PathwaySelfEnrollmentRequest } from '../models/PathwaySelfEnrollme
81
85
  import type { PathwaySuggestionBulkCreate } from '../models/PathwaySuggestionBulkCreate';
82
86
  import type { PathwaySuggestionCreate } from '../models/PathwaySuggestionCreate';
83
87
  import type { PathwaySuggestionDetail } from '../models/PathwaySuggestionDetail';
88
+ import type { PlatformApplicationAdminSubmit } from '../models/PlatformApplicationAdminSubmit';
89
+ import type { PlatformApplicationAttachmentUpload } from '../models/PlatformApplicationAttachmentUpload';
90
+ import type { PlatformApplicationCandidateLink } from '../models/PlatformApplicationCandidateLink';
91
+ import type { PlatformApplicationCourseAssignment } from '../models/PlatformApplicationCourseAssignment';
92
+ import type { PlatformApplicationCreate } from '../models/PlatformApplicationCreate';
93
+ import type { PlatformApplicationDetail } from '../models/PlatformApplicationDetail';
94
+ import type { PlatformApplicationFeeAction } from '../models/PlatformApplicationFeeAction';
95
+ import type { PlatformApplicationFormCreate } from '../models/PlatformApplicationFormCreate';
96
+ import type { PlatformApplicationFormDetail } from '../models/PlatformApplicationFormDetail';
97
+ import type { PlatformApplicationNote } from '../models/PlatformApplicationNote';
98
+ import type { PlatformApplicationPlacementCreate } from '../models/PlatformApplicationPlacementCreate';
99
+ import type { PlatformApplicationSubmit } from '../models/PlatformApplicationSubmit';
100
+ import type { PlatformApplicationTransition } from '../models/PlatformApplicationTransition';
101
+ import type { PlatformApplicationWaiver } from '../models/PlatformApplicationWaiver';
84
102
  import type { PlatformInvitationCreate } from '../models/PlatformInvitationCreate';
85
103
  import type { PlatformInvitationDetail } from '../models/PlatformInvitationDetail';
86
104
  import type { PlatformInvitationRedemption } from '../models/PlatformInvitationRedemption';
@@ -245,6 +263,636 @@ export declare class CatalogService {
245
263
  */
246
264
  platformOrg?: string;
247
265
  }): CancelablePromise<CourseAccessRequestDetail>;
266
+ /**
267
+ * Authenticated applicants, including learners on AXD student tokens.
268
+ *
269
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
270
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
271
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
272
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
273
+ * @returns any Own submissions
274
+ * @throws ApiError
275
+ */
276
+ static catalogApplicationsPlatformRetrieve({ formId, platformKey, platformOrg, }: {
277
+ formId?: number;
278
+ platformKey?: string;
279
+ platformOrg?: string;
280
+ }): CancelablePromise<any>;
281
+ /**
282
+ * Authenticated applicants, including learners on AXD student tokens.
283
+ *
284
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
285
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
286
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
287
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
288
+ * @returns PlatformApplicationDetail
289
+ * @throws ApiError
290
+ */
291
+ static catalogApplicationsPlatformCreate({ requestBody, }: {
292
+ requestBody: PlatformApplicationCreate;
293
+ }): CancelablePromise<PlatformApplicationDetail>;
294
+ /**
295
+ * Authenticated applicants, including learners on AXD student tokens.
296
+ *
297
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
298
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
299
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
300
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
301
+ * @returns PlatformApplicationDetail
302
+ * @throws ApiError
303
+ */
304
+ static catalogApplicationsPlatformRetrieve2({ submissionId, }: {
305
+ submissionId: string;
306
+ }): CancelablePromise<PlatformApplicationDetail>;
307
+ /**
308
+ * Authenticated applicants, including learners on AXD student tokens.
309
+ *
310
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
311
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
312
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
313
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
314
+ * @returns PlatformApplicationDetail
315
+ * @throws ApiError
316
+ */
317
+ static catalogApplicationsPlatformPartialUpdate({ submissionId, requestBody, }: {
318
+ submissionId: string;
319
+ requestBody?: PatchedPlatformApplicationUpdate;
320
+ }): CancelablePromise<PlatformApplicationDetail>;
321
+ /**
322
+ * Authenticated applicants, including learners on AXD student tokens.
323
+ *
324
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
325
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
326
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
327
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
328
+ * @returns any Attachment stored
329
+ * @throws ApiError
330
+ */
331
+ static catalogApplicationsPlatformAttachmentsCreate({ submissionId, formData, }: {
332
+ submissionId: string;
333
+ formData: PlatformApplicationAttachmentUpload;
334
+ }): CancelablePromise<any>;
335
+ /**
336
+ * Authenticated applicants, including learners on AXD student tokens.
337
+ *
338
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
339
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
340
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
341
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
342
+ * @returns void
343
+ * @throws ApiError
344
+ */
345
+ static catalogApplicationsPlatformAttachmentsDestroy({ attachmentId, submissionId, }: {
346
+ attachmentId: string;
347
+ submissionId: string;
348
+ }): CancelablePromise<void>;
349
+ /**
350
+ * Authenticated applicants, including learners on AXD student tokens.
351
+ *
352
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
353
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
354
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
355
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
356
+ * @returns PlatformApplicationDetail
357
+ * @throws ApiError
358
+ */
359
+ static catalogApplicationsPlatformSubmitCreate({ submissionId, requestBody, }: {
360
+ submissionId: string;
361
+ requestBody?: PlatformApplicationSubmit;
362
+ }): CancelablePromise<PlatformApplicationDetail>;
363
+ /**
364
+ * Authenticated applicants, including learners on AXD student tokens.
365
+ *
366
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
367
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
368
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
369
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
370
+ * @returns PlatformApplicationDetail
371
+ * @throws ApiError
372
+ */
373
+ static catalogApplicationsPlatformWithdrawCreate({ submissionId, }: {
374
+ submissionId: string;
375
+ }): CancelablePromise<PlatformApplicationDetail>;
376
+ /**
377
+ * Authenticated applicants, including learners on AXD student tokens.
378
+ *
379
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
380
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
381
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
382
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
383
+ * @returns any Active form
384
+ * @throws ApiError
385
+ */
386
+ static catalogApplicationsPlatformFormRetrieve({ formId, platformKey, platformOrg, }: {
387
+ formId?: number;
388
+ platformKey?: string;
389
+ platformOrg?: string;
390
+ }): CancelablePromise<any>;
391
+ /**
392
+ * Wires RBAC into a DRF view.
393
+ *
394
+ * Two responsibilities:
395
+ *
396
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
397
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
398
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
399
+ * views that set `token_policies_enabled = True`).
400
+ *
401
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
402
+ * Server-to-server tokens authenticate as Django auth users with no
403
+ * relationship to a platform EdxUser. The convention is "we trust this
404
+ * caller — bypass RBAC and serve the request."
405
+ *
406
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
407
+ * the early exit skips all RBAC prep work:
408
+ *
409
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
410
+ * return
411
+ *
412
+ * Use `is_service_account` at any other touch points where caller
413
+ * identity matters (queryset ownership filters, owner attribution on
414
+ * create, serializer context, etc.).
415
+ * @returns any Forms for the platform
416
+ * @throws ApiError
417
+ */
418
+ static catalogApplicationsPlatformFormsManageRetrieve({ platformKey, platformOrg, sort, }: {
419
+ platformKey?: string;
420
+ platformOrg?: string;
421
+ sort?: string;
422
+ }): CancelablePromise<any>;
423
+ /**
424
+ * Wires RBAC into a DRF view.
425
+ *
426
+ * Two responsibilities:
427
+ *
428
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
429
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
430
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
431
+ * views that set `token_policies_enabled = True`).
432
+ *
433
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
434
+ * Server-to-server tokens authenticate as Django auth users with no
435
+ * relationship to a platform EdxUser. The convention is "we trust this
436
+ * caller — bypass RBAC and serve the request."
437
+ *
438
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
439
+ * the early exit skips all RBAC prep work:
440
+ *
441
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
442
+ * return
443
+ *
444
+ * Use `is_service_account` at any other touch points where caller
445
+ * identity matters (queryset ownership filters, owner attribution on
446
+ * create, serializer context, etc.).
447
+ * @returns PlatformApplicationFormDetail
448
+ * @throws ApiError
449
+ */
450
+ static catalogApplicationsPlatformFormsManageCreate({ requestBody, platformKey, platformOrg, sort, }: {
451
+ requestBody: PlatformApplicationFormCreate;
452
+ platformKey?: string;
453
+ platformOrg?: string;
454
+ sort?: string;
455
+ }): CancelablePromise<PlatformApplicationFormDetail>;
456
+ /**
457
+ * Wires RBAC into a DRF view.
458
+ *
459
+ * Two responsibilities:
460
+ *
461
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
462
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
463
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
464
+ * views that set `token_policies_enabled = True`).
465
+ *
466
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
467
+ * Server-to-server tokens authenticate as Django auth users with no
468
+ * relationship to a platform EdxUser. The convention is "we trust this
469
+ * caller — bypass RBAC and serve the request."
470
+ *
471
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
472
+ * the early exit skips all RBAC prep work:
473
+ *
474
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
475
+ * return
476
+ *
477
+ * Use `is_service_account` at any other touch points where caller
478
+ * identity matters (queryset ownership filters, owner attribution on
479
+ * create, serializer context, etc.).
480
+ * @returns PlatformApplicationFormDetail
481
+ * @throws ApiError
482
+ */
483
+ static catalogApplicationsPlatformFormsManageRetrieve2({ formId, platformKey, platformOrg, sort, }: {
484
+ formId: string;
485
+ platformKey?: string;
486
+ platformOrg?: string;
487
+ sort?: string;
488
+ }): CancelablePromise<PlatformApplicationFormDetail>;
489
+ /**
490
+ * Wires RBAC into a DRF view.
491
+ *
492
+ * Two responsibilities:
493
+ *
494
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
495
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
496
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
497
+ * views that set `token_policies_enabled = True`).
498
+ *
499
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
500
+ * Server-to-server tokens authenticate as Django auth users with no
501
+ * relationship to a platform EdxUser. The convention is "we trust this
502
+ * caller — bypass RBAC and serve the request."
503
+ *
504
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
505
+ * the early exit skips all RBAC prep work:
506
+ *
507
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
508
+ * return
509
+ *
510
+ * Use `is_service_account` at any other touch points where caller
511
+ * identity matters (queryset ownership filters, owner attribution on
512
+ * create, serializer context, etc.).
513
+ * @returns PlatformApplicationFormDetail
514
+ * @throws ApiError
515
+ */
516
+ static catalogApplicationsPlatformFormsManagePartialUpdate({ formId, platformKey, platformOrg, sort, requestBody, }: {
517
+ formId: string;
518
+ platformKey?: string;
519
+ platformOrg?: string;
520
+ sort?: string;
521
+ requestBody?: PatchedPlatformApplicationFormUpdate;
522
+ }): CancelablePromise<PlatformApplicationFormDetail>;
523
+ /**
524
+ * Wires RBAC into a DRF view.
525
+ *
526
+ * Two responsibilities:
527
+ *
528
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
529
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
530
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
531
+ * views that set `token_policies_enabled = True`).
532
+ *
533
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
534
+ * Server-to-server tokens authenticate as Django auth users with no
535
+ * relationship to a platform EdxUser. The convention is "we trust this
536
+ * caller — bypass RBAC and serve the request."
537
+ *
538
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
539
+ * the early exit skips all RBAC prep work:
540
+ *
541
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
542
+ * return
543
+ *
544
+ * Use `is_service_account` at any other touch points where caller
545
+ * identity matters (queryset ownership filters, owner attribution on
546
+ * create, serializer context, etc.).
547
+ * @returns any Submissions for the platform
548
+ * @throws ApiError
549
+ */
550
+ static catalogApplicationsPlatformManageRetrieve({ platformKey, platformOrg, search, sort, status, }: {
551
+ platformKey?: string;
552
+ platformOrg?: string;
553
+ search?: string;
554
+ sort?: string;
555
+ status?: string;
556
+ }): CancelablePromise<any>;
557
+ /**
558
+ * Wires RBAC into a DRF view.
559
+ *
560
+ * Two responsibilities:
561
+ *
562
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
563
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
564
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
565
+ * views that set `token_policies_enabled = True`).
566
+ *
567
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
568
+ * Server-to-server tokens authenticate as Django auth users with no
569
+ * relationship to a platform EdxUser. The convention is "we trust this
570
+ * caller — bypass RBAC and serve the request."
571
+ *
572
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
573
+ * the early exit skips all RBAC prep work:
574
+ *
575
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
576
+ * return
577
+ *
578
+ * Use `is_service_account` at any other touch points where caller
579
+ * identity matters (queryset ownership filters, owner attribution on
580
+ * create, serializer context, etc.).
581
+ * @returns any Full submission detail
582
+ * @throws ApiError
583
+ */
584
+ static catalogApplicationsPlatformManageRetrieve2({ submissionId, platformKey, platformOrg, search, sort, status, }: {
585
+ submissionId: string;
586
+ platformKey?: string;
587
+ platformOrg?: string;
588
+ search?: string;
589
+ sort?: string;
590
+ status?: string;
591
+ }): CancelablePromise<any>;
592
+ /**
593
+ * Reviewer download: redirect to the storage's (signed, on S3) file URL.
594
+ *
595
+ * Gated by ``IsDMAdmin | IsPlatformAdmin`` plus the RBAC verb check on the
596
+ * attachment's own platform when RBAC is enabled.
597
+ * @returns void
598
+ * @throws ApiError
599
+ */
600
+ static catalogApplicationsPlatformManageAttachmentsDownloadRetrieve({ attachmentId, submissionId, }: {
601
+ attachmentId: string;
602
+ submissionId: string;
603
+ }): CancelablePromise<void>;
604
+ /**
605
+ * Re-run settlement provisioning for one accepted candidate: links them
606
+ * if an account with their designated email now exists, or re-issues the
607
+ * platform invitation if none is active. Covers the invite-missing state.
608
+ * @returns any Candidate after provisioning
609
+ * @throws ApiError
610
+ */
611
+ static catalogApplicationsPlatformManageCandidatesInviteCreate({ candidateId, submissionId, }: {
612
+ candidateId: string;
613
+ submissionId: string;
614
+ }): CancelablePromise<any>;
615
+ /**
616
+ * Manually link an accepted candidate to an existing account (the
617
+ * account-unlinked state: the family signed up outside invitation
618
+ * redemption, or under a different email than designated).
619
+ * @returns any Candidate linked
620
+ * @throws ApiError
621
+ */
622
+ static catalogApplicationsPlatformManageCandidatesLinkCreate({ candidateId, submissionId, requestBody, }: {
623
+ candidateId: string;
624
+ submissionId: string;
625
+ requestBody?: PlatformApplicationCandidateLink;
626
+ }): CancelablePromise<any>;
627
+ /**
628
+ * Course assignments for a submission (#2134): list, and assign courses to
629
+ * accepted candidates individually or in bulk. Each successful item issues a
630
+ * CourseInvitation that the existing pipeline enrolls.
631
+ * @returns any Assignments for the submission
632
+ * @throws ApiError
633
+ */
634
+ static catalogApplicationsPlatformManageCourseAssignmentsRetrieve({ submissionId, }: {
635
+ submissionId: string;
636
+ }): CancelablePromise<any>;
637
+ /**
638
+ * Course assignments for a submission (#2134): list, and assign courses to
639
+ * accepted candidates individually or in bulk. Each successful item issues a
640
+ * CourseInvitation that the existing pipeline enrolls.
641
+ * @returns any Per-item assignment results
642
+ * @throws ApiError
643
+ */
644
+ static catalogApplicationsPlatformManageCourseAssignmentsCreate({ submissionId, requestBody, }: {
645
+ submissionId: string;
646
+ requestBody: PlatformApplicationCourseAssignment;
647
+ }): CancelablePromise<any>;
648
+ /**
649
+ * Remove one course assignment (§9.2 "enrollment changes after the school
650
+ * year begins" — the record side).
651
+ *
652
+ * Deactivates the assignment and cancels its invitation when the student has
653
+ * not yet been enrolled through it. It never unenrolls an already-enrolled
654
+ * student: platform admins un-enroll deliberately through the catalog
655
+ * enrollment endpoints, not from an admissions record.
656
+ * @returns void
657
+ * @throws ApiError
658
+ */
659
+ static catalogApplicationsPlatformManageCourseAssignmentsDestroy({ assignmentId, submissionId, }: {
660
+ assignmentId: string;
661
+ submissionId: string;
662
+ }): CancelablePromise<void>;
663
+ /**
664
+ * Reviewer/admin view of a submission's application fee (#2132, §5).
665
+ *
666
+ * GET returns the charge and its event history; POST records an out-of-band
667
+ * payment or a waiver/refund/credit. Money collection through Stripe is a
668
+ * later segment; this is the domain side.
669
+ * @returns any Charge + events
670
+ * @throws ApiError
671
+ */
672
+ static catalogApplicationsPlatformManageFeeRetrieve({ submissionId, }: {
673
+ submissionId: string;
674
+ }): CancelablePromise<any>;
675
+ /**
676
+ * Reviewer/admin view of a submission's application fee (#2132, §5).
677
+ *
678
+ * GET returns the charge and its event history; POST records an out-of-band
679
+ * payment or a waiver/refund/credit. Money collection through Stripe is a
680
+ * later segment; this is the domain side.
681
+ * @returns any Charge updated
682
+ * @throws ApiError
683
+ */
684
+ static catalogApplicationsPlatformManageFeeCreate({ submissionId, requestBody, }: {
685
+ submissionId: string;
686
+ requestBody: PlatformApplicationFeeAction;
687
+ }): CancelablePromise<any>;
688
+ /**
689
+ * Internal reviewer notes on a submission (#2089, §6). Never surfaced on
690
+ * applicant endpoints. GET lists (optional ``kind`` filter); POST adds one.
691
+ * @returns any Notes for the submission
692
+ * @throws ApiError
693
+ */
694
+ static catalogApplicationsPlatformManageNotesRetrieve({ submissionId, platformKey, platformOrg, search, sort, status, }: {
695
+ submissionId: string;
696
+ platformKey?: string;
697
+ platformOrg?: string;
698
+ search?: string;
699
+ sort?: string;
700
+ status?: string;
701
+ }): CancelablePromise<any>;
702
+ /**
703
+ * Internal reviewer notes on a submission (#2089, §6). Never surfaced on
704
+ * applicant endpoints. GET lists (optional ``kind`` filter); POST adds one.
705
+ * @returns any Note created
706
+ * @throws ApiError
707
+ */
708
+ static catalogApplicationsPlatformManageNotesCreate({ submissionId, requestBody, }: {
709
+ submissionId: string;
710
+ requestBody: PlatformApplicationNote;
711
+ }): CancelablePromise<any>;
712
+ /**
713
+ * Edit or remove a single internal reviewer note.
714
+ * @returns any Note updated
715
+ * @throws ApiError
716
+ */
717
+ static catalogApplicationsPlatformManageNotesPartialUpdate({ noteId, submissionId, requestBody, }: {
718
+ noteId: string;
719
+ submissionId: string;
720
+ requestBody?: PatchedPlatformApplicationNote;
721
+ }): CancelablePromise<any>;
722
+ /**
723
+ * Edit or remove a single internal reviewer note.
724
+ * @returns void
725
+ * @throws ApiError
726
+ */
727
+ static catalogApplicationsPlatformManageNotesDestroy({ noteId, submissionId, }: {
728
+ noteId: string;
729
+ submissionId: string;
730
+ }): CancelablePromise<void>;
731
+ /**
732
+ * Placements for a submission (#2133): list, and assign a new placement
733
+ * linking an accepted candidate to the placement mentor.
734
+ * @returns any Placements for the submission
735
+ * @throws ApiError
736
+ */
737
+ static catalogApplicationsPlatformManagePlacementsRetrieve({ submissionId, }: {
738
+ submissionId: string;
739
+ }): CancelablePromise<any>;
740
+ /**
741
+ * Placements for a submission (#2133): list, and assign a new placement
742
+ * linking an accepted candidate to the placement mentor.
743
+ * @returns any Per-item placement results
744
+ * @throws ApiError
745
+ */
746
+ static catalogApplicationsPlatformManagePlacementsCreate({ submissionId, requestBody, }: {
747
+ submissionId: string;
748
+ requestBody: PlatformApplicationPlacementCreate;
749
+ }): CancelablePromise<any>;
750
+ /**
751
+ * Advance a single placement: status, the agent's result, admin override.
752
+ * @returns any Placement updated
753
+ * @throws ApiError
754
+ */
755
+ static catalogApplicationsPlatformManagePlacementsPartialUpdate({ placementId, submissionId, requestBody, }: {
756
+ placementId: string;
757
+ submissionId: string;
758
+ requestBody?: PatchedPlatformApplicationPlacementUpdate;
759
+ }): CancelablePromise<any>;
760
+ /**
761
+ * Admin submit-with-exceptions (§2.1 "administratively waived"): push a
762
+ * family's editable application to Submitted, recording a waiver for every
763
+ * required item still missing and bypassing an unpaid fee gate (the charge
764
+ * stays payable/waivable). Present-but-invalid answers still block (400).
765
+ * @returns any Application submitted
766
+ * @throws ApiError
767
+ */
768
+ static catalogApplicationsPlatformManageSubmitCreate({ submissionId, requestBody, }: {
769
+ submissionId: string;
770
+ requestBody?: PlatformApplicationAdminSubmit;
771
+ }): CancelablePromise<any>;
772
+ /**
773
+ * Advance a submission or a single candidate through the review pipeline
774
+ * (#2089, §5-6). A ``candidate_id`` scopes the action to one person; without
775
+ * it the action applies to every candidate that can legally accept it. When
776
+ * ``action`` is ``decline`` and ``block`` is set, the applicant is also added
777
+ * to the platform ban-list (deny-with-block).
778
+ * @returns any Updated submission detail
779
+ * @throws ApiError
780
+ */
781
+ static catalogApplicationsPlatformManageTransitionCreate({ submissionId, requestBody, }: {
782
+ submissionId: string;
783
+ requestBody: PlatformApplicationTransition;
784
+ }): CancelablePromise<any>;
785
+ /**
786
+ * Waive a required item on one application (§2.1 "administratively
787
+ * waived"): POST excuses a missing required field so it no longer blocks
788
+ * submission; DELETE reinstates it. Waivers excuse absence only — a
789
+ * present-but-invalid answer still blocks. The fee is waived through its own
790
+ * fee endpoint action, which also settles the money record.
791
+ * @returns any Waiver recorded
792
+ * @throws ApiError
793
+ */
794
+ static catalogApplicationsPlatformManageWaiversCreate({ submissionId, requestBody, }: {
795
+ submissionId: string;
796
+ requestBody: PlatformApplicationWaiver;
797
+ }): CancelablePromise<any>;
798
+ /**
799
+ * Waive a required item on one application (§2.1 "administratively
800
+ * waived"): POST excuses a missing required field so it no longer blocks
801
+ * submission; DELETE reinstates it. Waivers excuse absence only — a
802
+ * present-but-invalid answer still blocks. The fee is waived through its own
803
+ * fee endpoint action, which also settles the money record.
804
+ * @returns void
805
+ * @throws ApiError
806
+ */
807
+ static catalogApplicationsPlatformManageWaiversDestroy({ submissionId, }: {
808
+ submissionId: string;
809
+ }): CancelablePromise<void>;
810
+ /**
811
+ * List the active application blocks (ban-list) for a platform.
812
+ * @returns any Active blocks
813
+ * @throws ApiError
814
+ */
815
+ static catalogApplicationsPlatformManageBlocksRetrieve({ platformKey, platformOrg, search, sort, status, }: {
816
+ platformKey?: string;
817
+ platformOrg?: string;
818
+ search?: string;
819
+ sort?: string;
820
+ status?: string;
821
+ }): CancelablePromise<any>;
822
+ /**
823
+ * Lift a single active application block (unblock).
824
+ * @returns void
825
+ * @throws ApiError
826
+ */
827
+ static catalogApplicationsPlatformManageBlocksDestroy({ blockId, platformKey, platformOrg, search, sort, status, }: {
828
+ blockId: string;
829
+ platformKey?: string;
830
+ platformOrg?: string;
831
+ search?: string;
832
+ sort?: string;
833
+ status?: string;
834
+ }): CancelablePromise<void>;
835
+ /**
836
+ * Wires RBAC into a DRF view.
837
+ *
838
+ * Two responsibilities:
839
+ *
840
+ * 1. When RBAC is enabled, replace the view's `permission_classes` with
841
+ * `RbacAuthGate` (the gate the RBAC layer assumes — `IsEdxAuthenticated`
842
+ * semantics, plus opt-in acceptance of token-policies PlatformApiKeys for
843
+ * views that set `token_policies_enabled = True`).
844
+ *
845
+ * 2. Detect server-to-server (Django auth) callers via `is_service_account`.
846
+ * Server-to-server tokens authenticate as Django auth users with no
847
+ * relationship to a platform EdxUser. The convention is "we trust this
848
+ * caller — bypass RBAC and serve the request."
849
+ *
850
+ * Combine it with the RBAC-disabled check at the top of `initial()` so
851
+ * the early exit skips all RBAC prep work:
852
+ *
853
+ * if not ConfigFlags.rbac_enabled() or self.is_service_account:
854
+ * return
855
+ *
856
+ * Use `is_service_account` at any other touch points where caller
857
+ * identity matters (queryset ownership filters, owner attribution on
858
+ * create, serializer context, etc.).
859
+ * @returns any Per-status counts
860
+ * @throws ApiError
861
+ */
862
+ static catalogApplicationsPlatformManageStatsRetrieve({ platformKey, platformOrg, search, sort, status, }: {
863
+ platformKey?: string;
864
+ platformOrg?: string;
865
+ search?: string;
866
+ sort?: string;
867
+ status?: string;
868
+ }): CancelablePromise<any>;
869
+ /**
870
+ * Start an annual re-enrollment (#2135): a normal draft create whose
871
+ * responses are pre-filled from the caller's most recent approved submission
872
+ * (current-schema fields only; signatures, consents, files, and fields the
873
+ * form flags fresh are re-asked), linked to that prior submission. With no
874
+ * prior approved submission this behaves as a plain create.
875
+ * @returns PlatformApplicationDetail
876
+ * @throws ApiError
877
+ */
878
+ static catalogApplicationsPlatformRenewCreate({ requestBody, }: {
879
+ requestBody: PlatformApplicationCreate;
880
+ }): CancelablePromise<PlatformApplicationDetail>;
881
+ /**
882
+ * Authenticated applicants, including learners on AXD student tokens.
883
+ *
884
+ * Prepends StudentTokenAuthentication like core UserPlatformSelfLinkView (it is
885
+ * not in the DRF defaults, but learners self-applying use it). An anonymous
886
+ * request returns 401, not 403: DRF's ``permission_denied`` raises
887
+ * ``NotAuthenticated`` whenever no authenticator succeeded.
888
+ * @returns any Gate state
889
+ * @throws ApiError
890
+ */
891
+ static catalogApplicationsPlatformStatusRetrieve({ formId, platformKey, platformOrg, }: {
892
+ formId?: number;
893
+ platformKey?: string;
894
+ platformOrg?: string;
895
+ }): CancelablePromise<any>;
248
896
  /**
249
897
  * GET
250
898
  * Retrieve prerequisite eligibility info for user/course
@@ -1277,6 +1277,20 @@ export declare class CoreService {
1277
1277
  */
1278
1278
  platformKey: string;
1279
1279
  }): CancelablePromise<void>;
1280
+ /**
1281
+ * Discover resources for policy building
1282
+ * GET the resource tree node at `path`.
1283
+ *
1284
+ * Platform comes from the request token (service accounts pass platform_key).
1285
+ * @returns any An entity node (child collections) or a collection node (list_url + search_qps + result_fields).
1286
+ * @throws ApiError
1287
+ */
1288
+ static coreRbacResourcesRetrieve({ path, }: {
1289
+ /**
1290
+ * Discovery path, e.g. '/', '/mentors/', '/mentors/5/'.
1291
+ */
1292
+ path?: string;
1293
+ }): CancelablePromise<any>;
1280
1294
  /**
1281
1295
  * List RBAC roles
1282
1296
  * Retrieve a list of RBAC roles. Can be filtered by platform_key and name.