npm - @groton/canvas-api - Versions diffs - 0.3.8 → 0.3.9 - Mend

@groton/canvas-api 0.3.8 → 0.3.9

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 (1051) hide show

package/dist/Endpoints/V1/Sections/Assignments/Submissions/submit_assignment_sections.d.ts CHANGED Viewed

@@ -118,15 +118,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<submit_assignment_sectionsFormParameters>;
     strict?: false;
+} | (({
+    query: submit_assignment_sectionsSearchParameters;
 } | {
-    query?: Partial<submit_assignment_sectionsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: submit_assignment_sectionsSearchParameters;
-    body?: Partial<submit_assignment_sectionsFormParameters>;
+}) & ({
+    body: submit_assignment_sectionsFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: submit_assignment_sectionsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Submit an assignment
  *

package/dist/Endpoints/V1/Sections/Crosslist/cross_list_section.d.ts CHANGED Viewed

@@ -38,15 +38,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<cross_list_sectionFormParameters>;
     strict?: false;
+} | (({
+    query: cross_list_sectionSearchParameters;
 } | {
-    query?: Partial<cross_list_sectionSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: cross_list_sectionSearchParameters;
-    body?: Partial<cross_list_sectionFormParameters>;
+}) & ({
+    body: cross_list_sectionFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: cross_list_sectionFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Cross-list a Section
  *

package/dist/Endpoints/V1/Sections/Crosslist/de_cross_list_section.d.ts CHANGED Viewed

@@ -28,12 +28,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<de_cross_list_sectionSearchParameters>;
     strict?: false;
+} | (({
+    query: de_cross_list_sectionSearchParameters;
 } | {
-    query?: Partial<de_cross_list_sectionSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: de_cross_list_sectionSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * De-cross-list a Section
  *

package/dist/Endpoints/V1/Sections/Enrollments/enroll_user_sections.d.ts CHANGED Viewed

@@ -141,15 +141,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<enroll_user_sectionsFormParameters>;
     strict?: false;
+} | (({
+    query: enroll_user_sectionsSearchParameters;
 } | {
-    query?: Partial<enroll_user_sectionsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: enroll_user_sectionsSearchParameters;
-    body?: Partial<enroll_user_sectionsFormParameters>;
+}) & ({
+    body: enroll_user_sectionsFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: enroll_user_sectionsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Enroll a user
  *

package/dist/Endpoints/V1/Sections/Enrollments/list.d.ts CHANGED Viewed

@@ -107,12 +107,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List enrollments
  *

package/dist/Endpoints/V1/Sections/Students/Submissions/list.d.ts CHANGED Viewed

@@ -108,12 +108,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List submissions for multiple assignments
  *

package/dist/Endpoints/V1/Sections/Submissions/BulkMarkRead/mark_bulk_submissions_as_read_sections.d.ts CHANGED Viewed

@@ -26,15 +26,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<mark_bulk_submissions_as_read_sectionsFormParameters>;
     strict?: false;
+} | (({
+    query: mark_bulk_submissions_as_read_sectionsSearchParameters;
 } | {
-    query?: Partial<mark_bulk_submissions_as_read_sectionsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: mark_bulk_submissions_as_read_sectionsSearchParameters;
-    body?: Partial<mark_bulk_submissions_as_read_sectionsFormParameters>;
+}) & ({
+    body: mark_bulk_submissions_as_read_sectionsFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: mark_bulk_submissions_as_read_sectionsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Mark bulk submissions as read
  *

package/dist/Endpoints/V1/Sections/Submissions/ClearUnread/clear_unread_status_for_all_submissions_sections.d.ts CHANGED Viewed

@@ -25,12 +25,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<clear_unread_status_for_all_submissions_sectionsSearchParameters>;
     strict?: false;
+} | (({
+    query: clear_unread_status_for_all_submissions_sectionsSearchParameters;
 } | {
-    query?: Partial<clear_unread_status_for_all_submissions_sectionsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: clear_unread_status_for_all_submissions_sectionsSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Clear unread status for all submissions.
  *

package/dist/Endpoints/V1/Sections/Submissions/UpdateGrades/grade_or_comment_on_multiple_submissions_sections_submissions.d.ts CHANGED Viewed

@@ -70,15 +70,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<grade_or_comment_on_multiple_submissions_sections_submissionsFormParameters>;
     strict?: false;
+} | (({
+    query: grade_or_comment_on_multiple_submissions_sections_submissionsSearchParameters;
 } | {
-    query?: Partial<grade_or_comment_on_multiple_submissions_sections_submissionsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: grade_or_comment_on_multiple_submissions_sections_submissionsSearchParameters;
-    body?: Partial<grade_or_comment_on_multiple_submissions_sections_submissionsFormParameters>;
+}) & ({
+    body: grade_or_comment_on_multiple_submissions_sections_submissionsFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: grade_or_comment_on_multiple_submissions_sections_submissionsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Grade or comment on multiple submissions
  *

package/dist/Endpoints/V1/Sections/Users/list.d.ts CHANGED Viewed

@@ -39,12 +39,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List section's users
  *

package/dist/Endpoints/V1/Sections/delete_section.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_sectionSearchParameters>;
     strict?: false;
+} | (({
+    query: delete_sectionSearchParameters;
 } | {
-    query?: Partial<delete_sectionSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: delete_sectionSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Delete a section
  *

package/dist/Endpoints/V1/Sections/get.d.ts CHANGED Viewed

@@ -33,12 +33,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get section information
  *

package/dist/Endpoints/V1/Sections/update.d.ts CHANGED Viewed

@@ -60,15 +60,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Edit a section
  *

package/dist/Endpoints/V1/Services/Kaltura/get.d.ts CHANGED Viewed

@@ -6,12 +6,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Get Kaltura config
  *

package/dist/Endpoints/V1/Services/KalturaSession/start_kaltura_session.d.ts CHANGED Viewed

@@ -6,12 +6,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<start_kaltura_sessionSearchParameters>;
     strict?: false;
+} | (({
+    query: start_kaltura_sessionSearchParameters;
 } | {
-    query?: Partial<start_kaltura_sessionSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: start_kaltura_sessionSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Start Kaltura session
  *

package/dist/Endpoints/V1/Settings/Environment/list.d.ts CHANGED Viewed

@@ -6,12 +6,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * List environment settings
  *

package/dist/Endpoints/V1/SharedBrandConfigs/un_share_brandconfig_theme.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<un_share_brandconfig_themeSearchParameters>;
     strict?: false;
+} | (({
+    query: un_share_brandconfig_themeSearchParameters;
 } | {
-    query?: Partial<un_share_brandconfig_themeSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: un_share_brandconfig_themeSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Un-share a BrandConfig (Theme)
  *

package/dist/Endpoints/V1/Submissions/WhatIfGrades/update.d.ts CHANGED Viewed

@@ -32,15 +32,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Update a submission's what-if score and calculate grades
  *

package/dist/Endpoints/V1/Users/ActivityStream/list.d.ts CHANGED Viewed

@@ -14,12 +14,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * List the activity stream
  *

package/dist/Endpoints/V1/Users/Avatars/list.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List avatar options
  *

package/dist/Endpoints/V1/Users/CalendarEvents/list.d.ts CHANGED Viewed

@@ -98,12 +98,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List calendar events for a user
  *

package/dist/Endpoints/V1/Users/Colors/get.d.ts CHANGED Viewed

@@ -21,12 +21,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get custom color
  *

package/dist/Endpoints/V1/Users/Colors/list.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get custom colors
  *

package/dist/Endpoints/V1/Users/Colors/update.d.ts CHANGED Viewed

@@ -32,15 +32,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Update custom color
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/NotificationPreferenceCategories/list.d.ts CHANGED Viewed

@@ -25,12 +25,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List of preference categories
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/NotificationPreferences/get.d.ts CHANGED Viewed

@@ -25,12 +25,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get a preference
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/NotificationPreferences/list.d.ts CHANGED Viewed

@@ -23,12 +23,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List preferences
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/create.d.ts CHANGED Viewed

@@ -50,15 +50,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
+} | (({
+    query: createSearchParameters;
 } | {
-    query?: Partial<createSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
-    body?: Partial<createFormParameters>;
+}) & ({
+    body: createFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a communication channel
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/delete_communication_channel_id.d.ts CHANGED Viewed

@@ -25,12 +25,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_communication_channel_idSearchParameters>;
     strict?: false;
+} | (({
+    query: delete_communication_channel_idSearchParameters;
 } | {
-    query?: Partial<delete_communication_channel_idSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: delete_communication_channel_idSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Delete a communication channel
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/delete_communication_channel_type.d.ts CHANGED Viewed

@@ -23,12 +23,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_communication_channel_typeSearchParameters>;
     strict?: false;
+} | (({
+    query: delete_communication_channel_typeSearchParameters;
 } | {
-    query?: Partial<delete_communication_channel_typeSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: delete_communication_channel_typeSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Delete a communication channel
  *

package/dist/Endpoints/V1/Users/CommunicationChannels/list.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List user communication channels
  *

package/dist/Endpoints/V1/Users/ContentExports/export_content_users.d.ts CHANGED Viewed

@@ -53,15 +53,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<export_content_usersFormParameters>;
     strict?: false;
+} | (({
+    query: export_content_usersSearchParameters;
 } | {
-    query?: Partial<export_content_usersSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: export_content_usersSearchParameters;
-    body?: Partial<export_content_usersFormParameters>;
+}) & ({
+    body: export_content_usersFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: export_content_usersFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Export content
  *

package/dist/Endpoints/V1/Users/ContentExports/list.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List content exports
  *

package/dist/Endpoints/V1/Users/ContentExports/show_content_export_users.d.ts CHANGED Viewed

@@ -25,12 +25,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<show_content_export_usersSearchParameters>;
     strict?: false;
+} | (({
+    query: show_content_export_usersSearchParameters;
 } | {
-    query?: Partial<show_content_export_usersSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: show_content_export_usersSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show content export
  *