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/Career/SwitchRole/switch_role.d.ts CHANGED Viewed

@@ -12,15 +12,19 @@ type Options = {
     /** @deprecated Use {@link Options.body} */
     params?: Partial<switch_roleFormParameters>;
     strict?: false;
+} | (({
+    query: switch_roleSearchParameters;
 } | {
-    query?: Partial<switch_roleSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: switch_roleSearchParameters;
-    body?: Partial<switch_roleFormParameters>;
+}) & ({
+    body: switch_roleFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: switch_roleFormParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Switch role
  *

package/dist/Endpoints/V1/Collaborations/Members/list.d.ts CHANGED Viewed

@@ -27,12 +27,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 members of a collaboration.
  *

package/dist/Endpoints/V1/CommMessages/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 of CommMessages for a user
  *

package/dist/Endpoints/V1/Conferences/list.d.ts CHANGED Viewed

@@ -13,12 +13,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 conferences for the current user
  *

package/dist/Endpoints/V1/Conversations/AddMessage/add_message.d.ts CHANGED Viewed

@@ -42,15 +42,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<add_messageFormParameters>;
     strict?: false;
+} | (({
+    query: add_messageSearchParameters;
 } | {
-    query?: Partial<add_messageSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: add_messageSearchParameters;
-    body?: Partial<add_messageFormParameters>;
+}) & ({
+    body: add_messageFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: add_messageFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Add a message
  *

package/dist/Endpoints/V1/Conversations/AddRecipients/add_recipients.d.ts CHANGED Viewed

@@ -30,15 +30,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<add_recipientsFormParameters>;
     strict?: false;
+} | (({
+    query: add_recipientsSearchParameters;
 } | {
-    query?: Partial<add_recipientsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: add_recipientsSearchParameters;
-    body?: Partial<add_recipientsFormParameters>;
+}) & ({
+    body: add_recipientsFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: add_recipientsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Add recipients
  *

package/dist/Endpoints/V1/Conversations/Batches/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 running batches
  *

package/dist/Endpoints/V1/Conversations/FindRecipients/find_recipients.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Conversations/FindRecipients/find_recipients_conversations.d.ts CHANGED Viewed

@@ -54,12 +54,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<find_recipients_conversationsSearchParameters>;
     strict?: false;
+} | (({
+    query: find_recipients_conversationsSearchParameters;
 } | {
-    query?: Partial<find_recipients_conversationsSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: find_recipients_conversationsSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Find recipients
  *

package/dist/Endpoints/V1/Conversations/MarkAllAsRead/mark_all_as_read.d.ts CHANGED Viewed

@@ -6,12 +6,14 @@ type Options = {
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<mark_all_as_readSearchParameters>;
     strict?: false;
+} | (({
+    query: mark_all_as_readSearchParameters;
 } | {
-    query?: Partial<mark_all_as_readSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: mark_all_as_readSearchParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Mark all as read
  *

package/dist/Endpoints/V1/Conversations/RemoveMessages/delete_message.d.ts CHANGED Viewed

@@ -26,15 +26,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<delete_messageFormParameters>;
     strict?: false;
+} | (({
+    query: delete_messageSearchParameters;
 } | {
-    query?: Partial<delete_messageSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: delete_messageSearchParameters;
-    body?: Partial<delete_messageFormParameters>;
+}) & ({
+    body: delete_messageFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: delete_messageFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Delete a message
  *

package/dist/Endpoints/V1/Conversations/UnreadCount/unread_count.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Conversations/batchUpdate.d.ts CHANGED Viewed

@@ -15,15 +15,19 @@ type Options = {
     /** @deprecated Use {@link Options.body} */
     params?: Partial<batchUpdateFormParameters>;
     strict?: false;
+} | (({
+    query: batchUpdateSearchParameters;
 } | {
-    query?: Partial<batchUpdateSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: batchUpdateSearchParameters;
-    body?: Partial<batchUpdateFormParameters>;
+}) & ({
+    body: batchUpdateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: batchUpdateFormParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Batch update conversations
  *

package/dist/Endpoints/V1/Conversations/create.d.ts CHANGED Viewed

@@ -82,15 +82,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 conversation
  *

package/dist/Endpoints/V1/Conversations/delete_conversation.d.ts CHANGED Viewed

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

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

@@ -50,12 +50,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 single conversation
  *

package/dist/Endpoints/V1/Conversations/list.d.ts CHANGED Viewed

@@ -48,12 +48,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 conversations
  *

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

@@ -57,15 +57,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 conversation
  *

package/dist/Endpoints/V1/CourseAccounts/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 accounts for course admins
  *

package/dist/Endpoints/V1/CourseCreationAccounts/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 accounts that users can create courses in
  *

package/dist/Endpoints/V1/Courses/ActivityStream/Summary/course_activity_stream_summary.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/ActivityStream/course_activity_stream.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/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 student AI conversations
  *

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/show_student_ai_conversation.d.ts CHANGED Viewed

@@ -31,12 +31,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<show_student_ai_conversationSearchParameters>;
     strict?: false;
+} | (({
+    query: show_student_ai_conversationSearchParameters;
 } | {
-    query?: Partial<show_student_ai_conversationSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: show_student_ai_conversationSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show student AI conversation
  *

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/Messages/post_message_to_conversation.d.ts CHANGED Viewed

@@ -38,15 +38,19 @@ type Options = ({
     /** @deprecated Use {@link Options.body} */
     params?: Partial<post_message_to_conversationFormParameters>;
     strict?: false;
+} | (({
+    query: post_message_to_conversationSearchParameters;
 } | {
-    query?: Partial<post_message_to_conversationSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: post_message_to_conversationSearchParameters;
-    body?: Partial<post_message_to_conversationFormParameters>;
+}) & ({
+    body: post_message_to_conversationFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: post_message_to_conversationFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Post message to conversation
  *

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/create.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/delete_ai_conversation.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/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 active conversation
  *

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/show_conversation.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/Edit/show_edit_ai_experience_form.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/New/show_new_ai_experience_form.d.ts CHANGED Viewed

@@ -19,12 +19,14 @@ type Options = ({
     /** @deprecated Use {Options.query} */
     searchParams?: Partial<show_new_ai_experience_formSearchParameters>;
     strict?: false;
+} | (({
+    query: show_new_ai_experience_formSearchParameters;
 } | {
-    query?: Partial<show_new_ai_experience_formSearchParameters>;
     /** @deprecated Use {Options.query} */
     searchParams: show_new_ai_experience_formSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show new AI experience form
  *

package/dist/Endpoints/V1/Courses/AiExperiences/create.d.ts CHANGED Viewed

@@ -39,15 +39,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 an AI experience
  *

package/dist/Endpoints/V1/Courses/AiExperiences/delete_ai_experience.d.ts CHANGED Viewed

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

package/dist/Endpoints/V1/Courses/AiExperiences/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 AI experiences
  *