-
Notifications
You must be signed in to change notification settings - Fork 0
/
canvas.ts
1465 lines (1465 loc) · 64.6 KB
/
canvas.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export class Canvas {
errorReports: {
createErrorReport: (body: any) => Promise<any>;
};
apiTokenScopes: {
listScopes: (accountId: string, query?: any) => Promise<any>;
};
outcomeResults: {
getOutcomeResults: (courseId: string, query?: any) => Promise<any>;
getOutcomeResultRollups: (courseId: string, query?: any) => Promise<any>;
};
courseAuditLog: {
queryByCourse: (courseId: string, query?: any) => Promise<any>;
};
admins: {
makeAccountAdmin: (accountId: string, body: any) => Promise<any>;
removeAccountAdmin: (accountId: string, userId: string, query?: any) => Promise<any>;
listAccountAdmins: (accountId: string, query?: any) => Promise<any>;
};
quizExtensions: {
setExtensionsForStudentQuizSubmissions: (
courseId: string,
quizId: string,
body: any,
) => Promise<any>;
};
gradeChangeLog: {
queryByAssignment: (assignmentId: string, query?: any) => Promise<any>;
queryByCourse: (courseId: string, query?: any) => Promise<any>;
queryByStudent: (studentId: string, query?: any) => Promise<any>;
queryByGrader: (graderId: string, query?: any) => Promise<any>;
};
bookmarks: {
listBookmarks: () => Promise<any>;
createBookmark: (body: any) => Promise<any>;
getBookmark: (bookmarkId: string) => Promise<any>;
updateBookmark: (bookmarkId: string, body: any) => Promise<any>;
deleteBookmark: (bookmarkId: string) => Promise<any>;
};
brandConfigs: {
getBrandConfigVariablesThatShouldBeUsedForThisDomain: () => Promise<any>;
};
services: {
getKalturaConfig: () => Promise<any>;
startKalturaSession: () => Promise<any>;
};
liveAssessments: {
createLiveAssessmentResults: (courseId: string, assessmentId: string) => Promise<any>;
listLiveAssessmentResults: (
courseId: string,
assessmentId: string,
query?: any,
) => Promise<any>;
createOrFindLiveAssessment: (courseId: string) => Promise<any>;
listLiveAssessments: (courseId: string) => Promise<any>;
};
customGradebookColumns: {
listCustomGradebookColumns: (courseId: string, query?: any) => Promise<any>;
createCustomGradebookColumn: (courseId: string, body: any) => Promise<any>;
updateCustomGradebookColumn: (
courseId: string,
customGradebookColumnId: string,
) => Promise<any>;
deleteCustomGradebookColumn: (
courseId: string,
customGradebookColumnId: string,
) => Promise<any>;
reorderCustomColumns: (courseId: string, body: any) => Promise<any>;
listEntriesForColumn: (
courseId: string,
customGradebookColumnId: string,
query?: any,
) => Promise<any>;
updateColumnData: (
courseId: string,
customGradebookColumnId: string,
userId: string,
body: any,
) => Promise<any>;
};
tabs: {
listAvailableTabsForCourseOrGroupCourses: (courseId: string, query?: any) => Promise<any>;
listAvailableTabsForCourseOrGroupGroups: (groupId: string, query?: any) => Promise<any>;
updateTabForCourse: (courseId: string, tabId: string, body: any) => Promise<any>;
};
plannerOverride: {
listPlannerOverrides: () => Promise<any>;
showPlannerOverride: (overrideId: string) => Promise<any>;
updatePlannerOverride: (overrideId: string, body: any) => Promise<any>;
createPlannerOverride: (body: any) => Promise<any>;
deletePlannerOverride: (overrideId: string) => Promise<any>;
};
plagiarismDetectionSubmissions: {
getSingleSubmission: (assignmentId: string, submissionId: string) => Promise<any>;
getHistoryOfSingleSubmission: (assignmentId: string, submissionId: string) => Promise<any>;
};
proficiencyRatings: {
createUpdateProficiencyRatings: (accountId: string, body: any) => Promise<any>;
getProficiencyRatings: (accountId: string) => Promise<any>;
};
quizQuestionGroups: {
getSingleQuizGroup: (courseId: string, quizId: string, groupId: string) => Promise<any>;
createQuestionGroup: (courseId: string, quizId: string, body: any) => Promise<any>;
updateQuestionGroup: (
courseId: string,
quizId: string,
groupId: string,
body: any,
) => Promise<any>;
deleteQuestionGroup: (courseId: string, quizId: string, groupId: string) => Promise<any>;
reorderQuestionGroups: (
courseId: string,
quizId: string,
groupId: string,
body: any,
) => Promise<any>;
};
search: {
findRecipientsConversations: (query?: any) => Promise<any>;
findRecipientsSearch: (query?: any) => Promise<any>;
listAllCourses: (query?: any) => Promise<any>;
};
submissionComments: {
uploadFile: (courseId: string, assignmentId: string, userId: string) => Promise<any>;
};
accountReports: {
listAvailableReports: (accountId: string) => Promise<any>;
startReport: (accountId: string, report: string, body: any) => Promise<any>;
indexOfReports: (accountId: string, report: string) => Promise<any>;
statusOfReport: (accountId: string, report: string, reportId: string) => Promise<any>;
deleteReport: (accountId: string, report: string, reportId: string) => Promise<any>;
};
accountNotifications: {
indexOfActiveGlobalNotificationForUser: (accountId: string) => Promise<any>;
showGlobalNotification: (accountId: string, accountNotificationId: string) => Promise<any>;
closeNotificationForUser: (accountId: string, accountNotificationId: string) => Promise<any>;
createGlobalNotification: (accountId: string, body: any) => Promise<any>;
updateGlobalNotification: (
accountId: string,
accountNotificationId: string,
body: any,
) => Promise<any>;
};
communicationChannels: {
listUserCommunicationChannels: (userId: string) => Promise<any>;
createCommunicationChannel: (userId: string, body: any) => Promise<any>;
deleteCommunicationChannelId: (userId: string, communicationChannelId: string) => Promise<any>;
deleteCommunicationChannelType: (userId: string, type: string, address: string) => Promise<any>;
deletePushNotificationEndpoint: () => Promise<{
success: true;
}>;
};
announcementExternalFeeds: {
listExternalFeedsCourses: (courseId: string) => Promise<any>;
listExternalFeedsGroups: (groupId: string) => Promise<any>;
createExternalFeedCourses: (courseId: string, body: any) => Promise<any>;
createExternalFeedGroups: (groupId: string, body: any) => Promise<any>;
deleteExternalFeedCourses: (courseId: string, externalFeedId: string) => Promise<any>;
deleteExternalFeedGroups: (groupId: string, externalFeedId: string) => Promise<any>;
};
collaborations: {
listCollaborationsCourses: (courseId: string) => Promise<any>;
listCollaborationsGroups: (groupId: string) => Promise<any>;
listMembersOfCollaboration: (collaborationId: string, query?: any) => Promise<any>;
listPotentialMembersCourses: (courseId: string) => Promise<any>;
listPotentialMembersGroups: (groupId: string) => Promise<any>;
};
gradingStandards: {
createNewGradingStandardAccounts: (accountId: string, body: any) => Promise<any>;
createNewGradingStandardCourses: (courseId: string, body: any) => Promise<any>;
listGradingStandardsAvailableInContextCourses: (courseId: string) => Promise<any>;
listGradingStandardsAvailableInContextAccounts: (accountId: string) => Promise<any>;
getSingleGradingStandardInContextCourses: (
courseId: string,
gradingStandardId: string,
) => Promise<any>;
getSingleGradingStandardInContextAccounts: (
accountId: string,
gradingStandardId: string,
) => Promise<any>;
};
courseQuizExtensions: {
setExtensionsForStudentQuizSubmissions: (courseId: string, body: any) => Promise<any>;
};
commMessages: {
listOfCommmessagesForUser: (query: any) => Promise<any>;
};
gradingPeriods: {
listGradingPeriodsAccounts: (accountId: string) => Promise<any>;
listGradingPeriodsCourses: (courseId: string) => Promise<any>;
getSingleGradingPeriod: (courseId: string, gradingPeriodId: string) => Promise<any>;
updateSingleGradingPeriod: (
courseId: string,
gradingPeriodId: string,
body: any,
) => Promise<any>;
deleteGradingPeriodCourses: (courseId: string, gradingPeriodId: string) => Promise<any>;
deleteGradingPeriodAccounts: (accountId: string, gradingPeriodId: string) => Promise<any>;
};
accountDomainLookups: {
searchAccountDomains: (query?: any) => Promise<any>;
};
favorites: {
listFavoriteCourses: (query?: any) => Promise<any>;
listFavoriteGroups: () => Promise<any>;
addCourseToFavorites: (courseId: string) => Promise<any>;
addGroupToFavorites: (groupId: string) => Promise<any>;
removeCourseFromFavorites: (courseId: string) => Promise<any>;
removeGroupFromFavorites: (groupId: string) => Promise<any>;
resetCourseFavorites: () => Promise<any>;
resetGroupFavorites: () => Promise<any>;
};
jwTs: {
createJwt: () => Promise<any>;
refreshJwt: (body: any) => Promise<any>;
};
moderatedGrading: {
listStudentsSelectedForModeration: (courseId: string, assignmentId: string) => Promise<any>;
selectStudentsForModeration: (
courseId: string,
assignmentId: string,
body: any,
) => Promise<any>;
showProvisionalGradeStatusForStudent: (
courseId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
selectProvisionalGrade: (
courseId: string,
assignmentId: string,
provisionalGradeId: string,
) => Promise<any>;
copyProvisionalGrade: (
courseId: string,
assignmentId: string,
provisionalGradeId: string,
) => Promise<any>;
publishProvisionalGradesForAssignment: (courseId: string, assignmentId: string) => Promise<any>;
anonymousProvisionalGrades: (
courseId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
};
outcomes: {
showOutcome: (outcomeId: string) => Promise<any>;
updateOutcome: (outcomeId: string, body: any) => Promise<any>;
};
planner: {
listPlannerItems: (query?: any) => Promise<any>;
};
userObservees: {
listObservees: (userId: string, query?: any) => Promise<any>;
addObserveeWithCredentials: (userId: string, body: any) => Promise<any>;
showObservee: (userId: string, observeeId: string) => Promise<any>;
addObservee: (userId: string, observeeId: string, body: any) => Promise<any>;
removeObservee: (userId: string, observeeId: string, query?: any) => Promise<any>;
};
quizSubmissionFiles: {
uploadFile: (courseId: string, quizId: string, body: any) => Promise<any>;
};
plagiarismDetectionPlatformUsers: {
getSingleUserLti: (userId: string) => Promise<any>;
getAllUsersInGroupLti: (groupId: string) => Promise<any>;
};
gradebookHistory: {
daysInGradebookHistoryForThisCourse: (courseId: any) => Promise<any>;
detailsForGivenDateInGradebookHistoryForThisCourse: (
courseId: any,
date: string,
) => Promise<any>;
listsSubmissions: (
courseId: any,
date: string,
graderId: any,
assignmentId: any,
) => Promise<any>;
listUncollatedSubmissionVersions: (courseId: any, query?: any) => Promise<any>;
};
quizAssignmentOverrides: {
retrieveAssignmentOverriddenDatesForQuizzes: (courseId: string, query?: any) => Promise<any>;
};
plagiarismDetectionPlatformAssignments: {
getSingleAssignmentLti: (assignmentId: string, query?: any) => Promise<any>;
};
enrollmentTerms: {
createEnrollmentTerm: (accountId: string, body: any) => Promise<any>;
updateEnrollmentTerm: (accountId: string, termId: string, body: any) => Promise<any>;
deleteEnrollmentTerm: (accountId: string, termId: string) => Promise<any>;
listEnrollmentTerms: (accountId: string, query?: any) => Promise<any>;
};
logins: {
listUserLoginsAccounts: (accountId: string) => Promise<any>;
listUserLoginsUsers: (userId: string) => Promise<any>;
createUserLogin: (accountId: string, body: any) => Promise<any>;
editUserLogin: (accountId: string, loginId: string, body: any) => Promise<any>;
deleteUserLogin: (userId: string, loginId: string) => Promise<any>;
};
quizIpFilters: {
getAvailableQuizIpFilters: (courseId: string, quizId: string) => Promise<any>;
};
plannerNote: {
listPlannerNotes: (query?: any) => Promise<any>;
showPlannernote: (plannerNoteId: string) => Promise<any>;
updatePlannernote: (plannerNoteId: string, body: any) => Promise<any>;
createPlannerNote: (body: any) => Promise<any>;
deletePlannerNote: (plannerNoteId: string) => Promise<any>;
};
ePubExports: {
listCoursesWithTheirLatestEpubExport: () => Promise<any>;
createEpubExport: (courseId: string) => Promise<any>;
showEpubExport: (courseId: string, epubExportId: string) => Promise<any>;
};
quizSubmissionEvents: {
submitCapturedEvents: (
courseId: string,
quizId: string,
submissionId: string,
body: any,
) => Promise<any>;
retrieveCapturedEvents: (
courseId: string,
quizId: string,
submissionId: string,
query?: any,
) => Promise<any>;
};
sharedBrandConfigs: {
shareBrandconfigTheme: (accountId: string, body: any) => Promise<any>;
updateSharedTheme: (accountId: string, sharedBrandConfigId: string) => Promise<any>;
unShareBrandconfigTheme: (sharedBrandConfigId: string) => Promise<any>;
};
sisImportErrors: {
getSisImportErrorListSisImports: (accountId: string, sisImportId: string) => Promise<any>;
getSisImportErrorListSisImportErrors: (accountId: string) => Promise<any>;
};
pollSessions: {
listPollSessionsForPoll: (pollId: string) => Promise<any>;
getResultsForSinglePollSession: (pollId: string, pollSessionId: string) => Promise<any>;
createSinglePollSession: (pollId: string, body: any) => Promise<any>;
updateSinglePollSession: (pollId: string, pollSessionId: string, body: any) => Promise<any>;
deletePollSession: (pollId: string, pollSessionId: string) => Promise<any>;
openPollSession: (pollId: string, pollSessionId: string) => Promise<any>;
closeOpenedPollSession: (pollId: string, pollSessionId: string) => Promise<any>;
listOpenedPollSessions: () => Promise<any>;
listClosedPollSessions: () => Promise<any>;
};
quizSubmissionQuestions: {
getAllQuizSubmissionQuestions: (quizSubmissionId: string, query?: any) => Promise<any>;
answeringQuestions: (quizSubmissionId: string, body: any) => Promise<any>;
flaggingQuestion: (quizSubmissionId: string, questionId: string, body: any) => Promise<any>;
unflaggingQuestion: (quizSubmissionId: string, questionId: string, body: any) => Promise<any>;
};
announcements: {
listAnnouncements: (query: any) => Promise<any>;
};
originalityReports: {
createOriginalityReport: (
assignmentId: string,
submissionId: string,
body: any,
) => Promise<any>;
editOriginalityReportSubmissions: (
assignmentId: string,
submissionId: string,
originalityReporId: string,
body: any,
) => Promise<any>;
editOriginalityReportFiles: (assignmentId: string, fileId: string, body: any) => Promise<any>;
showOriginalityReportSubmissions: (
assignmentId: string,
submissionId: string,
originalityReporId: string,
) => Promise<any>;
showOriginalityReportFiles: (assignmentId: string, fileId: string) => Promise<any>;
};
analytics: {
getDepartmentLevelParticipationDataTerms: (accountId: string, termId: string) => Promise<any>;
getDepartmentLevelParticipationDataCurrent: (accountId: string) => Promise<any>;
getDepartmentLevelParticipationDataCompleted: (accountId: string) => Promise<any>;
getDepartmentLevelGradeDataTerms: (accountId: string, termId: string) => Promise<any>;
getDepartmentLevelGradeDataCurrent: (accountId: string) => Promise<any>;
getDepartmentLevelGradeDataCompleted: (accountId: string) => Promise<any>;
getDepartmentLevelStatisticsTerms: (accountId: string, termId: string) => Promise<any>;
getDepartmentLevelStatisticsCurrent: (accountId: string) => Promise<any>;
getDepartmentLevelStatisticsCompleted: (accountId: string) => Promise<any>;
getCourseLevelParticipationData: (courseId: string) => Promise<any>;
getCourseLevelAssignmentData: (courseId: string, query?: any) => Promise<any>;
getCourseLevelStudentSummaryData: (courseId: string, query?: any) => Promise<any>;
getUserInACourseLevelParticipationData: (courseId: string, studentId: string) => Promise<any>;
getUserInACourseLevelAssignmentData: (courseId: string, studentId: string) => Promise<any>;
getUserInACourseLevelMessagingData: (courseId: string, studentId: string) => Promise<any>;
};
featureFlags: {
listFeaturesCourses: (courseId: string) => Promise<any>;
listFeaturesAccounts: (accountId: string) => Promise<any>;
listFeaturesUsers: (userId: string) => Promise<any>;
listEnabledFeaturesCourses: (courseId: string) => Promise<any>;
listEnabledFeaturesAccounts: (accountId: string) => Promise<any>;
listEnabledFeaturesUsers: (userId: string) => Promise<any>;
getFeatureFlagCourses: (courseId: string, feature: string) => Promise<any>;
getFeatureFlagAccounts: (accountId: string, feature: string) => Promise<any>;
getFeatureFlagUsers: (userId: string, feature: string) => Promise<any>;
setFeatureFlagCourses: (courseId: string, feature: string, body: any) => Promise<any>;
setFeatureFlagAccounts: (accountId: string, feature: string, body: any) => Promise<any>;
setFeatureFlagUsers: (userId: string, feature: string, body: any) => Promise<any>;
removeFeatureFlagCourses: (courseId: string, feature: string) => Promise<any>;
removeFeatureFlagAccounts: (accountId: string, feature: string) => Promise<any>;
removeFeatureFlagUsers: (userId: string, feature: string) => Promise<any>;
};
quizSubmissions: {
getAllQuizSubmissions: (courseId: string, quizId: string, query?: any) => Promise<any>;
getQuizSubmission: (courseId: string, quizId: string, query?: any) => Promise<any>;
getSingleQuizSubmission: (
courseId: string,
quizId: string,
submissionId: string,
query?: any,
) => Promise<any>;
createQuizSubmissionStartQuizTakingSession: (
courseId: string,
quizId: string,
body: any,
) => Promise<any>;
updateStudentQuestionScoresAndComments: (
courseId: string,
quizId: string,
submissionId: string,
body: any,
) => Promise<any>;
completeQuizSubmissionTurnItIn: (
courseId: string,
quizId: string,
submissionId: string,
body: any,
) => Promise<any>;
getCurrentQuizSubmissionTimes: (
courseId: string,
quizId: string,
submissionId: string,
) => Promise<any>;
};
groupCategories: {
listGroupCategoriesForContextAccounts: (accountId: string) => Promise<any>;
listGroupCategoriesForContextCourses: (courseId: string) => Promise<any>;
getSingleGroupCategory: (groupCategoryId: string) => Promise<any>;
createGroupCategoryAccounts: (accountId: string, body: any) => Promise<any>;
createGroupCategoryCourses: (courseId: string, body: any) => Promise<any>;
updateGroupCategory: (groupCategoryId: string, body: any) => Promise<any>;
deleteGroupCategory: (groupCategoryId: string) => Promise<any>;
listGroupsInGroupCategory: (groupCategoryId: string) => Promise<any>;
listUsersInGroupCategory: (groupCategoryId: string, query?: any) => Promise<any>;
assignUnassignedMembers: (groupCategoryId: string, body: any) => Promise<any>;
};
authenticationsLog: {
queryByLogin: (loginId: string, query?: any) => Promise<any>;
queryByAccount: (accountId: string, query?: any) => Promise<any>;
queryByUser: (userId: string, query?: any) => Promise<any>;
};
notificationPreferences: {
listPreferencesCommunicationChannelId: (
userId: string,
communicationChannelId: string,
) => Promise<any>;
listPreferencesType: (userId: string, type: string, address: string) => Promise<any>;
listOfPreferenceCategories: (userId: string, communicationChannelId: string) => Promise<any>;
getPreferenceCommunicationChannelId: (
userId: string,
communicationChannelId: string,
notification: string,
) => Promise<any>;
getPreferenceType: (
userId: string,
type: string,
address: string,
notification: string,
) => Promise<any>;
updatePreferenceCommunicationChannelId: (
communicationChannelId: string,
notification: string,
body: any,
) => Promise<any>;
updatePreferenceType: (
type: string,
address: string,
notification: string,
body: any,
) => Promise<any>;
updatePreferencesByCategory: (
communicationChannelId: string,
category: string,
body: any,
) => Promise<any>;
updateMultiplePreferencesCommunicationChannelId: (
communicationChannelId: string,
body: any,
) => Promise<any>;
updateMultiplePreferencesType: (type: string, address: string, body: any) => Promise<any>;
};
contentExports: {
listContentExportsCourses: (courseId: string) => Promise<any>;
listContentExportsGroups: (groupId: string) => Promise<any>;
listContentExportsUsers: (userId: string) => Promise<any>;
showContentExportCourses: (courseId: string, contentExportId: string) => Promise<any>;
showContentExportGroups: (groupId: string, contentExportId: string) => Promise<any>;
showContentExportUsers: (userId: string, contentExportId: string) => Promise<any>;
exportContentCourses: (courseId: string, body: any) => Promise<any>;
exportContentGroups: (groupId: string, body: any) => Promise<any>;
exportContentUsers: (userId: string, body: any) => Promise<any>;
};
sections: {
listCourseSections: (courseId: string, query?: any) => Promise<any>;
createCourseSection: (courseId: string, body: any) => Promise<any>;
crossListSection: (sectionId: string, newCourseId: string) => Promise<any>;
deCrossListSection: (sectionId: string) => Promise<any>;
editSection: (sectionId: string, body: any) => Promise<any>;
getSectionInformationCourses: (
courseId: string,
sectionId: string,
query?: any,
) => Promise<any>;
getSectionInformationSections: (sectionId: string, query?: any) => Promise<any>;
deleteSection: (sectionId: string) => Promise<any>;
};
sisImports: {
getSisImportList: (accountId: string, query?: any) => Promise<any>;
importSisData: (accountId: string, body: any) => Promise<any>;
getSisImportStatus: (accountId: string, sisImportId: string) => Promise<any>;
restoreWorkflowStatesOfSisImportedItems: (
accountId: string,
sisImportId: string,
body: any,
) => Promise<any>;
abortSisImport: (accountId: string, sisImportId: string) => Promise<any>;
abortAllPendingSisImports: (accountId: string) => Promise<any>;
};
authenticationProviders: {
listAuthenticationProviders: (accountId: string) => Promise<any>;
addAuthenticationProvider: (accountId: string) => Promise<any>;
updateAuthenticationProvider: (
accountId: string,
authenticationProviderId: string,
) => Promise<any>;
getAuthenticationProvider: (
accountId: string,
authenticationProviderId: string,
) => Promise<any>;
deleteAuthenticationProvider: (
accountId: string,
authenticationProviderId: string,
) => Promise<any>;
showAccountAuthSettings: (accountId: string) => Promise<any>;
updateAccountAuthSettings: (accountId: string) => Promise<any>;
};
blueprintCourses: {
getBlueprintInformation: (courseId: string, templateId: string) => Promise<any>;
getAssociatedCourseInformation: (courseId: string, templateId: string) => Promise<any>;
updateAssociatedCourses: (courseId: string, templateId: string, body: any) => Promise<any>;
beginMigrationToPushToAssociatedCourses: (
courseId: string,
templateId: string,
body: any,
) => Promise<any>;
setOrRemoveRestrictionsOnBlueprintCourseObject: (
courseId: string,
templateId: string,
body: any,
) => Promise<any>;
getUnsyncedChanges: (courseId: string, templateId: string) => Promise<any>;
listBlueprintMigrations: (courseId: string, templateId: string) => Promise<any>;
showBlueprintMigration: (
courseId: string,
templateId: string,
migrationId: string,
) => Promise<any>;
getMigrationDetails: (
courseId: string,
templateId: string,
migrationId: string,
) => Promise<any>;
listBlueprintImports: (courseId: string, subscriptionId: string) => Promise<any>;
showBlueprintImport: (
courseId: string,
subscriptionId: string,
migrationId: string,
) => Promise<any>;
getImportDetails: (
courseId: string,
subscriptionId: string,
migrationId: string,
) => Promise<any>;
};
conversations: {
listConversations: (query?: any) => Promise<any>;
createConversation: (body: any) => Promise<any>;
getRunningBatches: () => Promise<any>;
getSingleConversation: (conversationId: string, query?: any) => Promise<any>;
editConversation: (conversationId: string, body: any) => Promise<any>;
markAllAsRead: () => Promise<any>;
deleteConversation: (conversationId: string) => Promise<any>;
addRecipients: (conversationId: string, body: any) => Promise<any>;
addMessage: (conversationId: string, body: any) => Promise<any>;
deleteMessage: (conversationId: string, body: any) => Promise<any>;
batchUpdateConversations: (body: any) => Promise<any>;
findRecipients: () => Promise<any>;
unreadCount: () => Promise<any>;
};
latePolicy: {
getLatePolicy: (courseId: string) => Promise<any>;
createLatePolicy: (courseId: string, body: any) => Promise<any>;
patchLatePolicy: (courseId: string, body: any) => Promise<any>;
};
groups: {
listYourGroups: (query?: any) => Promise<any>;
listGroupsAvailableInContextAccounts: (accountId: string, query?: any) => Promise<any>;
listGroupsAvailableInContextCourses: (courseId: string, query?: any) => Promise<any>;
getSingleGroup: (groupId: string, query?: any) => Promise<any>;
createGroupGroups: (body: any) => Promise<any>;
createGroupGroupCategories: (groupCategoryId: string, body: any) => Promise<any>;
editGroup: (groupId: string, body: any) => Promise<any>;
deleteGroup: (groupId: string) => Promise<any>;
inviteOthersToGroup: (groupId: string, body: any) => Promise<any>;
listGroupSUsers: (groupId: string, query?: any) => Promise<any>;
uploadFile: (groupId: string) => Promise<any>;
previewProcessedHtml: (groupId: string, body: any) => Promise<any>;
groupActivityStream: (groupId: string) => Promise<any>;
groupActivityStreamSummary: (groupId: string) => Promise<any>;
listGroupMemberships: (groupId: string, query?: any) => Promise<any>;
getSingleGroupMembershipMemberships: (groupId: string, membershipId: string) => Promise<any>;
getSingleGroupMembershipUsers: (groupId: string, userId: string) => Promise<any>;
createMembership: (groupId: string, body: any) => Promise<any>;
updateMembershipMemberships: (groupId: string, membershipId: string, body: any) => Promise<any>;
updateMembershipUsers: (groupId: string, userId: string, body: any) => Promise<any>;
leaveGroupMemberships: (groupId: string, membershipId: string) => Promise<any>;
leaveGroupUsers: (groupId: string, userId: string) => Promise<any>;
};
appointmentGroups: {
listAppointmentGroups: (query?: any) => Promise<any>;
createAppointmentGroup: (body: any) => Promise<any>;
getSingleAppointmentGroup: (appointmentGroupId: string, query?: any) => Promise<any>;
updateAppointmentGroup: (appointmentGroupId: string, body: any) => Promise<any>;
deleteAppointmentGroup: (appointmentGroupId: string, query?: any) => Promise<any>;
listUserParticipants: (appointmentGroupId: string, query?: any) => Promise<any>;
listStudentGroupParticipants: (appointmentGroupId: string, query?: any) => Promise<any>;
getNextAppointment: (query?: any) => Promise<any>;
};
polls: {
listPolls: () => Promise<any>;
getSinglePoll: (pollId: string) => Promise<any>;
createSinglePoll: (body: any) => Promise<any>;
updateSinglePoll: (pollId: string, body: any) => Promise<any>;
deletePoll: (pollId: string) => Promise<any>;
};
calendarEvents: {
listCalendarEvents: (query?: any) => Promise<any>;
listCalendarEventsForUser: (userId: string, query?: any) => Promise<any>;
createCalendarEvent: (body: any) => Promise<any>;
getSingleCalendarEventOrAssignment: (calendarEventId: string) => Promise<any>;
reserveTimeSlot: (calendarEventId: string, body: any) => Promise<any>;
reserveTimeSlotParticipantId: (
calendarEventId: string,
participantId: string,
body: any,
) => Promise<any>;
updateCalendarEvent: (calendarEventId: string, body: any) => Promise<any>;
deleteCalendarEvent: (calendarEventId: string, query?: any) => Promise<any>;
setCourseTimetable: (courseId: string, body: any) => Promise<any>;
getCourseTimetable: (courseId: string) => Promise<any>;
createOrUpdateEventsDirectlyForCourseTimetable: (courseId: string, body: any) => Promise<any>;
};
modules: {
listModules: (courseId: string, query?: any) => Promise<any>;
showModule: (courseId: string, moduleId: string, query?: any) => Promise<any>;
createModule: (courseId: string, body: any) => Promise<any>;
updateModule: (courseId: string, moduleId: string, body: any) => Promise<any>;
deleteModule: (courseId: string, moduleId: string) => Promise<any>;
reLockModuleProgressions: (courseId: string, moduleId: string) => Promise<any>;
listModuleItems: (courseId: string, moduleId: string, query?: any) => Promise<any>;
showModuleItem: (
courseId: string,
moduleId: string,
itemId: string,
query?: any,
) => Promise<any>;
createModuleItem: (courseId: string, moduleId: string, body: any) => Promise<any>;
updateModuleItem: (
courseId: string,
moduleId: string,
itemId: string,
body: any,
) => Promise<any>;
selectMasteryPath: (
courseId: string,
moduleId: string,
itemId: string,
body: any,
) => Promise<any>;
deleteModuleItem: (courseId: string, moduleId: string, itemId: string) => Promise<any>;
markModuleItemAsDoneNotDone: (
courseId: string,
moduleId: string,
itemId: string,
) => Promise<any>;
getModuleItemSequence: (courseId: string, query?: any) => Promise<any>;
markModuleItemRead: (courseId: string, moduleId: string, itemId: string) => Promise<any>;
};
pages: {
showFrontPageCourses: (courseId: string) => Promise<any>;
showFrontPageGroups: (groupId: string) => Promise<any>;
duplicatePage: (courseId: string, url: string) => Promise<any>;
updateCreateFrontPageCourses: (courseId: string, body: any) => Promise<any>;
updateCreateFrontPageGroups: (groupId: string, body: any) => Promise<any>;
listPagesCourses: (courseId: string, query?: any) => Promise<any>;
listPagesGroups: (groupId: string, query?: any) => Promise<any>;
createPageCourses: (courseId: string, body: any) => Promise<any>;
createPageGroups: (groupId: string, body: any) => Promise<any>;
showPageCourses: (courseId: string, url: string) => Promise<any>;
showPageGroups: (groupId: string, url: string) => Promise<any>;
updateCreatePageCourses: (courseId: string, url: string, body: any) => Promise<any>;
updateCreatePageGroups: (groupId: string, url: string, body: any) => Promise<any>;
deletePageCourses: (courseId: string, url: string) => Promise<any>;
deletePageGroups: (groupId: string, url: string) => Promise<any>;
listRevisionsCourses: (courseId: string, url: string) => Promise<any>;
listRevisionsGroups: (groupId: string, url: string) => Promise<any>;
showRevisionCoursesLatest: (courseId: string, url: string, query?: any) => Promise<any>;
showRevisionGroupsLatest: (groupId: string, url: string, query?: any) => Promise<any>;
showRevisionCoursesRevisionId: (
courseId: string,
url: string,
revisionId: string,
query?: any,
) => Promise<any>;
showRevisionGroupsRevisionId: (
groupId: string,
url: string,
revisionId: string,
query?: any,
) => Promise<any>;
revertToRevisionCourses: (courseId: string, url: string, revisionId: any) => Promise<any>;
revertToRevisionGroups: (groupId: string, url: string, revisionId: any) => Promise<any>;
};
quizSubmissionUserList: {
sendMessageToUnsubmittedOrSubmittedUsersForQuiz: (
courseId: string,
quizzeId: string,
body: any,
) => Promise<any>;
};
progress: {
queryProgress: (progresId: string) => Promise<any>;
};
enrollments: {
listEnrollmentsCourses: (courseId: string, query?: any) => Promise<any>;
listEnrollmentsSections: (sectionId: string, query?: any) => Promise<any>;
listEnrollmentsUsers: (userId: string, query?: any) => Promise<any>;
enrollmentById: (accountId: string, enrollmentId: any) => Promise<any>;
enrollUserCourses: (courseId: string, body: any) => Promise<any>;
enrollUserSections: (sectionId: string, body: any) => Promise<any>;
concludeDeactivateOrDeleteEnrollment: (
courseId: string,
enrollmentId: string,
query?: any,
) => Promise<any>;
acceptCourseInvitation: (courseId: string, enrollmentId: string) => Promise<any>;
rejectCourseInvitation: (courseId: string, enrollmentId: string) => Promise<any>;
reActivateEnrollment: (courseId: string, enrollmentId: string) => Promise<any>;
addsLastAttendedDateToStudentEnrollmentInCourse: (
courseId: string,
userId: string,
) => Promise<any>;
};
peerReviews: {
getAllPeerReviewsCoursesPeerReviews: (
courseId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
getAllPeerReviewsSectionsPeerReviews: (
sectionId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
getAllPeerReviewsCoursesSubmissions: (
courseId: string,
assignmentId: string,
submissionId: string,
query?: any,
) => Promise<any>;
getAllPeerReviewsSectionsSubmissions: (
sectionId: string,
assignmentId: string,
submissionId: string,
query?: any,
) => Promise<any>;
createPeerReviewCourses: (
courseId: string,
assignmentId: string,
submissionId: string,
body: any,
) => Promise<any>;
createPeerReviewSections: (
sectionId: string,
assignmentId: string,
submissionId: string,
body: any,
) => Promise<any>;
deletePeerReviewCourses: (
courseId: string,
assignmentId: string,
submissionId: string,
query: any,
) => Promise<any>;
deletePeerReviewSections: (
sectionId: string,
assignmentId: string,
submissionId: string,
query: any,
) => Promise<any>;
};
contentMigrations: {
listMigrationIssuesAccounts: (accountId: string, contentMigrationId: string) => Promise<any>;
listMigrationIssuesCourses: (courseId: string, contentMigrationId: string) => Promise<any>;
listMigrationIssuesGroups: (groupId: string, contentMigrationId: string) => Promise<any>;
listMigrationIssuesUsers: (userId: string, contentMigrationId: string) => Promise<any>;
getMigrationIssueAccounts: (
accountId: string,
contentMigrationId: string,
migrationIssueId: string,
) => Promise<any>;
getMigrationIssueCourses: (
courseId: string,
contentMigrationId: string,
migrationIssueId: string,
) => Promise<any>;
getMigrationIssueGroups: (
groupId: string,
contentMigrationId: string,
migrationIssueId: string,
) => Promise<any>;
getMigrationIssueUsers: (
userId: string,
contentMigrationId: string,
migrationIssueId: string,
) => Promise<any>;
updateMigrationIssueAccounts: (
accountId: string,
contentMigrationId: string,
migrationIssueId: string,
body: any,
) => Promise<any>;
updateMigrationIssueCourses: (
courseId: string,
contentMigrationId: string,
migrationIssueId: string,
body: any,
) => Promise<any>;
updateMigrationIssueGroups: (
groupId: string,
contentMigrationId: string,
migrationIssueId: string,
body: any,
) => Promise<any>;
updateMigrationIssueUsers: (
userId: string,
contentMigrationId: string,
migrationIssueId: string,
body: any,
) => Promise<any>;
listContentMigrationsAccounts: (accountId: string) => Promise<any>;
listContentMigrationsCourses: (courseId: string) => Promise<any>;
listContentMigrationsGroups: (groupId: string) => Promise<any>;
listContentMigrationsUsers: (userId: string) => Promise<any>;
getContentMigrationAccounts: (accountId: string, contentMigrationId: string) => Promise<any>;
getContentMigrationCourses: (courseId: string, contentMigrationId: string) => Promise<any>;
getContentMigrationGroups: (groupId: string, contentMigrationId: string) => Promise<any>;
getContentMigrationUsers: (userId: string, contentMigrationId: string) => Promise<any>;
createContentMigrationAccounts: (accountId: string, body: any) => Promise<any>;
createContentMigrationCourses: (courseId: string, body: any) => Promise<any>;
createContentMigrationGroups: (groupId: string, body: any) => Promise<any>;
createContentMigrationUsers: (userId: string, body: any) => Promise<any>;
updateContentMigrationAccounts: (accountId: string, contentMigrationId: string) => Promise<any>;
updateContentMigrationCourses: (courseId: string, contentMigrationId: string) => Promise<any>;
updateContentMigrationGroups: (groupId: string, contentMigrationId: string) => Promise<any>;
updateContentMigrationUsers: (userId: string, contentMigrationId: string) => Promise<any>;
listMigrationSystemsAccounts: (accountId: string) => Promise<any>;
listMigrationSystemsCourses: (courseId: string) => Promise<any>;
listMigrationSystemsGroups: (groupId: string) => Promise<any>;
listMigrationSystemsUsers: (userId: string) => Promise<any>;
};
pollSubmissions: {
getSinglePollSubmission: (
pollId: string,
pollSessionId: string,
pollSubmissionId: string,
) => Promise<any>;
createSinglePollSubmission: (pollId: string, pollSessionId: string, body: any) => Promise<any>;
};
assignmentGroups: {
listAssignmentGroups: (courseId: string, query?: any) => Promise<any>;
getAssignmentGroup: (courseId: string, assignmentGroupId: string, query?: any) => Promise<any>;
createAssignmentGroup: (courseId: string, body: any) => Promise<any>;
editAssignmentGroup: (courseId: string, assignmentGroupId: string) => Promise<any>;
destroyAssignmentGroup: (
courseId: string,
assignmentGroupId: string,
query?: any,
) => Promise<any>;
};
webhooksSubscriptions: {
createWebhookSubscription: (body: any) => Promise<any>;
deleteWebhookSubscription: (subscriptionId: string) => Promise<any>;
showSingleWebhookSubscription: (subscriptionId: string) => Promise<any>;
updateWebhookSubscription: (subscriptionId: string) => Promise<any>;
listAllWebhookSubscriptionForToolProxy: () => Promise<any>;
};
pollChoices: {
listPollChoicesInPoll: (pollId: string) => Promise<any>;
getSinglePollChoice: (pollId: string, pollChoiceId: string) => Promise<any>;
createSinglePollChoice: (pollId: string, body: any) => Promise<any>;
updateSinglePollChoice: (pollId: string, pollChoiceId: string, body: any) => Promise<any>;
deletePollChoice: (pollId: string, pollChoiceId: string) => Promise<any>;
};
submissions: {
submitAssignmentCourses: (courseId: string, assignmentId: string, body: any) => Promise<any>;
submitAssignmentSections: (sectionId: string, assignmentId: string, body: any) => Promise<any>;
listAssignmentSubmissionsCourses: (
courseId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
listAssignmentSubmissionsSections: (
sectionId: string,
assignmentId: string,
query?: any,
) => Promise<any>;
listSubmissionsForMultipleAssignmentsCourses: (courseId: string, query?: any) => Promise<any>;
listSubmissionsForMultipleAssignmentsSections: (sectionId: string, query?: any) => Promise<any>;
getSingleSubmissionCourses: (
courseId: string,
assignmentId: string,
userId: string,
query?: any,
) => Promise<any>;
getSingleSubmissionSections: (
sectionId: string,
assignmentId: string,
userId: string,
query?: any,
) => Promise<any>;
uploadFileCourses: (courseId: string, assignmentId: string, userId: string) => Promise<any>;
uploadFileSections: (sectionId: string, assignmentId: string, userId: string) => Promise<any>;
gradeOrCommentOnSubmissionCourses: (
courseId: string,
assignmentId: string,
userId: string,
body: any,
) => Promise<any>;
gradeOrCommentOnSubmissionSections: (
sectionId: string,
assignmentId: string,
userId: string,
body: any,
) => Promise<any>;
listGradeableStudents: (courseId: string, assignmentId: string) => Promise<any>;
listMultipleAssignmentsGradeableStudents: (courseId: string, query?: any) => Promise<any>;
gradeOrCommentOnMultipleSubmissionsCoursesSubmissions: (
courseId: string,
body: any,
) => Promise<any>;
gradeOrCommentOnMultipleSubmissionsCoursesAssignments: (
courseId: string,
assignmentId: string,
body: any,
) => Promise<any>;
gradeOrCommentOnMultipleSubmissionsSectionsSubmissions: (
sectionId: string,
body: any,
) => Promise<any>;
gradeOrCommentOnMultipleSubmissionsSectionsAssignments: (
sectionId: string,
assignmentId: string,
body: any,
) => Promise<any>;
markSubmissionAsReadCourses: (
courseId: string,
assignmentId: string,
userId: string,
) => Promise<any>;
markSubmissionAsReadSections: (
sectionId: string,
assignmentId: string,
userId: string,
) => Promise<any>;
markSubmissionAsUnreadCourses: (
courseId: string,
assignmentId: string,
userId: string,
) => Promise<any>;
markSubmissionAsUnreadSections: (