@groton/canvas-api 0.3.4 → 0.3.5

package/dist/Endpoints/V1/Accounts/RootOutcomeGroup/redirect_to_root_outcome_group_for_context_accounts.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type redirect_to_root_outcome_group_for_context_accountsPathParameters = {
     /**
@@ -25,5 +26,5 @@ type Options = {
  *
  * Nickname: redirect_to_root_outcome_group_for_context_accounts
  */
-export declare function redirect_to_root_outcome_group_for_context_accounts(options: Options): Promise<void>;
+export declare function redirect_to_root_outcome_group_for_context_accounts(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Rubrics/UsedLocations/get.d.ts

@@ -24,11 +24,11 @@ type Options = {
     strict: true;
 });
 /**
- * Get the courses and assignments for
+ * Get the courses and assignments for a rubric
  *
- * Returns the rubric with the given id.
+ * Returns the courses and assignments where a rubric is being used
  *
- * Nickname: get_courses_and_assignments_for_accounts
+ * Nickname: get_courses_and_assignments_for_rubric_accounts
  */
 export declare function get(options: Options): Promise<import("../../../../../Resources/Rubrics.js").Rubric>;
 export {};

package/dist/Endpoints/V1/Accounts/Rubrics/UsedLocations/get.js

@@ -1,10 +1,10 @@
 import { client } from '../../../../../Client.js';
 /**
- * Get the courses and assignments for
+ * Get the courses and assignments for a rubric
  *
- * Returns the rubric with the given id.
+ * Returns the courses and assignments where a rubric is being used
  *
- * Nickname: get_courses_and_assignments_for_accounts
+ * Nickname: get_courses_and_assignments_for_rubric_accounts
  */
 export async function get(options) {
     const response = await client().fetchAs(`/api/v1/accounts/{account_id}/rubrics/{id}/used_locations`, {

package/dist/Endpoints/V1/Accounts/Rubrics/list.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type listPathParameters = {
     /**
@@ -24,5 +25,5 @@ type Options = {
  *
  * Nickname: list_rubrics_accounts
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Search/search_account_domains.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type search_account_domainsSearchParameters = Masquerade & Partial<{
     /** Campus name */
@@ -37,5 +38,5 @@ type Options = {
  *
  * Nickname: search_account_domains
  */
-export declare function search_account_domains(options: Options): Promise<void>;
+export declare function search_account_domains(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Settings/settings.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type settingsPathParameters = {
     /**
@@ -27,5 +28,5 @@ type Options = {
  *
  * Nickname: settings
  */
-export declare function settings(options: Options): Promise<void>;
+export declare function settings(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Tabs/list.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type listPathParameters = {
     /**
@@ -32,5 +33,5 @@ type Options = {
  *
  * Nickname: list_available_tabs_for_course_or_group_accounts
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/index.d.ts

@@ -4,6 +4,7 @@ export * as Admins from './Admins/index.js';
 export * as Analytics from './Analytics/index.js';
 export * as AuthenticationProviders from './AuthenticationProviders/index.js';
 export * as BlackoutDates from './BlackoutDates/index.js';
+export * as BrandVariables from './BrandVariables/index.js';
 export * as BulkEnrollment from './BulkEnrollment/index.js';
 export * as ContentMigrations from './ContentMigrations/index.js';
 export * as Courses from './Courses/index.js';

package/dist/Endpoints/V1/Accounts/index.js

@@ -4,6 +4,7 @@ export * as Admins from './Admins/index.js';
 export * as Analytics from './Analytics/index.js';
 export * as AuthenticationProviders from './AuthenticationProviders/index.js';
 export * as BlackoutDates from './BlackoutDates/index.js';
+export * as BrandVariables from './BrandVariables/index.js';
 export * as BulkEnrollment from './BulkEnrollment/index.js';
 export * as ContentMigrations from './ContentMigrations/index.js';
 export * as Courses from './Courses/index.js';

package/dist/Endpoints/V1/Accounts/update.d.ts

@@ -181,6 +181,18 @@ export type updateFormParameters = Masquerade & {
      * Type: boolean
      */
     'account[settings][conditional_release][locked]': boolean | string;
+    /**
+     * Enable or disable course pacing
+     *
+     * Type: boolean
+     */
+    'account[settings][enable_course_paces][value]': boolean | string;
+    /**
+     * Lock this setting for sub-accounts and courses
+     *
+     * Type: boolean
+     */
+    'account[settings][enable_course_paces][locked]': boolean | string;
     /**
      * Hash of optional password policy configuration parameters for a root
      * account

package/dist/Endpoints/V1/Announcements/list.d.ts

@@ -1,5 +1,5 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
-import { array } from '../../../Overrides.js';
 import { DiscussionTopic } from '../../../Resources/DiscussionTopics.js';
 export type listSearchParameters = Masquerade & Paginated & Partial<{
     /**
@@ -64,7 +64,7 @@ export type listSearchParameters = Masquerade & Paginated & Partial<{
      * root level the total number of users in the topic's context (group or
      * course) that the topic applies to.
      */
-    include: array;
+    include: JSONValue;
 }>;
 type Options = {
     searchParams?: Partial<listSearchParameters>;

package/dist/Endpoints/V1/AppointmentGroups/Groups/list.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type listPathParameters = {
     /**
@@ -29,5 +30,5 @@ type Options = {
  *
  * Nickname: list_student_group_participants
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/Users/list.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type listPathParameters = {
     /**
@@ -29,5 +30,5 @@ type Options = {
  *
  * Nickname: list_user_participants
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/create.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type createSearchParameters = Masquerade;
 export type createFormParameters = Masquerade & {
@@ -92,5 +93,5 @@ type Options = {
  *
  * Nickname: create_appointment_group
  */
-export declare function create(options: Options): Promise<void>;
+export declare function create(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/delete_appointment_group.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type delete_appointment_groupPathParameters = {
     /**
@@ -28,5 +29,5 @@ type Options = {
  *
  * Nickname: delete_appointment_group
  */
-export declare function delete_appointment_group(options: Options): Promise<void>;
+export declare function delete_appointment_group(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/get.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type getPathParameters = {
     /**
@@ -34,5 +35,5 @@ type Options = {
  *
  * Nickname: get_single_appointment_group
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/list.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type listSearchParameters = Masquerade & Partial<{
     /** Defaults to "reservable" */
@@ -36,5 +37,5 @@ type Options = {
  *
  * Nickname: list_appointment_groups
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/AppointmentGroups/update.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type updatePathParameters = {
     /**
@@ -102,5 +103,5 @@ type Options = {
  *
  * Nickname: update_appointment_group
  */
-export declare function update(options: Options): Promise<void>;
+export declare function update(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Audit/Authentication/Accounts/query_by_account.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type query_by_accountPathParameters = {
     /**
@@ -38,5 +39,5 @@ type Options = {
  *
  * Nickname: query_by_account
  */
-export declare function query_by_account(options: Options): Promise<void>;
+export declare function query_by_account(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Audit/Authentication/Logins/query_by_login.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type query_by_loginPathParameters = {
     /**
@@ -38,5 +39,5 @@ type Options = {
  *
  * Nickname: query_by_login
  */
-export declare function query_by_login(options: Options): Promise<void>;
+export declare function query_by_login(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Audit/Authentication/Users/query_by_user.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type query_by_userPathParameters = {
     /**
@@ -38,5 +39,5 @@ type Options = {
  *
  * Nickname: query_by_user
  */
-export declare function query_by_user(options: Options): Promise<void>;
+export declare function query_by_user(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/BrandVariables/get.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type getSearchParameters = Masquerade;
 type Options = {
@@ -17,5 +18,5 @@ type Options = {
  *
  * Nickname: get_brand_config_variables_that_should_be_used_for_this_domain
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/Reservations/reserve_time_slot.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type reserve_time_slotPathParameters = {
     /**
@@ -43,5 +44,5 @@ type Options = {
  *
  * Nickname: reserve_time_slot
  */
-export declare function reserve_time_slot(options: Options): Promise<void>;
+export declare function reserve_time_slot(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/Reservations/reserve_time_slot_participant_id.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type reserve_time_slot_participant_idPathParameters = {
     /**
@@ -45,5 +46,5 @@ type Options = {
  *
  * Nickname: reserve_time_slot_participant_id
  */
-export declare function reserve_time_slot_participant_id(options: Options): Promise<void>;
+export declare function reserve_time_slot_participant_id(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/SaveEnabledAccountCalendars/save_enabled_account_calendars.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type save_enabled_account_calendarsSearchParameters = Masquerade;
 export type save_enabled_account_calendarsFormParameters = Masquerade & {
@@ -27,5 +28,5 @@ type Options = {
  *
  * Nickname: save_enabled_account_calendars
  */
-export declare function save_enabled_account_calendars(options: Options): Promise<void>;
+export declare function save_enabled_account_calendars(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/create.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type createSearchParameters = Masquerade;
 export type createFormParameters = Masquerade & {
@@ -111,5 +112,5 @@ type Options = {
  *
  * Nickname: create_calendar_event
  */
-export declare function create(options: Options): Promise<void>;
+export declare function create(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/delete_calendar_event.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type delete_calendar_eventPathParameters = {
     /**
@@ -33,5 +34,5 @@ type Options = {
  *
  * Nickname: delete_calendar_event
  */
-export declare function delete_calendar_event(options: Options): Promise<void>;
+export declare function delete_calendar_event(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/CalendarEvents/get.d.ts

@@ -21,6 +21,8 @@ type Options = {
 /**
  * Get a single calendar event or assignment
  *
+ * Returns detailed information about a specific calendar event or assignment.
+ *
  * Nickname: get_single_calendar_event_or_assignment
  */
 export declare function get(options: Options): Promise<CalendarEvent>;

package/dist/Endpoints/V1/CalendarEvents/get.js

@@ -2,6 +2,8 @@ import { client } from '../../../Client.js';
 /**
  * Get a single calendar event or assignment
  *
+ * Returns detailed information about a specific calendar event or assignment.
+ *
  * Nickname: get_single_calendar_event_or_assignment
  */
 export async function get(options) {

package/dist/Endpoints/V1/CalendarEvents/update.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type updatePathParameters = {
     /**
@@ -105,5 +106,5 @@ type Options = {
  *
  * Nickname: update_calendar_event
  */
-export declare function update(options: Options): Promise<void>;
+export declare function update(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type add_messagePathParameters = {
     /**
@@ -56,5 +57,5 @@ type Options = {
  *
  * Nickname: add_message
  */
-export declare function add_message(options: Options): Promise<void>;
+export declare function add_message(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type add_recipientsPathParameters = {
     /**
@@ -36,5 +37,5 @@ type Options = {
  *
  * Nickname: add_recipients
  */
-export declare function add_recipients(options: Options): Promise<void>;
+export declare function add_recipients(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Conversations/Batches/get.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type getSearchParameters = Masquerade;
 type Options = {
@@ -17,5 +18,5 @@ type Options = {
  *
  * Nickname: get_running_batches
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type find_recipientsSearchParameters = Masquerade;
 type Options = {
@@ -15,5 +16,5 @@ type Options = {
  *
  * Nickname: find_recipients
  */
-export declare function find_recipients(options: Options): Promise<void>;
+export declare function find_recipients(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type find_recipients_conversationsSearchParameters = Masquerade & Partial<{
     /**
@@ -66,5 +67,5 @@ type Options = {
  *
  * Nickname: find_recipients_conversations
  */
-export declare function find_recipients_conversations(options: Options): Promise<void>;
+export declare function find_recipients_conversations(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type mark_all_as_readSearchParameters = Masquerade;
 type Options = {
@@ -14,5 +15,5 @@ type Options = {
  *
  * Nickname: mark_all_as_read
  */
-export declare function mark_all_as_read(options: Options): Promise<void>;
+export declare function mark_all_as_read(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type delete_messagePathParameters = {
     /**
@@ -32,5 +33,5 @@ type Options = {
  *
  * Nickname: delete_message
  */
-export declare function delete_message(options: Options): Promise<void>;
+export declare function delete_message(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type unread_countSearchParameters = Masquerade;
 type Options = {
@@ -14,5 +15,5 @@ type Options = {
  *
  * Nickname: unread_count
  */
-export declare function unread_count(options: Options): Promise<void>;
+export declare function unread_count(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,13 +1,8 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type createSearchParameters = Masquerade;
 export type createFormParameters = Masquerade & {
-    /**
-     * An array of recipient ids. These may be user ids or course/group ids
-     * prefixed with "course_" or "group_" respectively, e.g.
-     * recipients[]=1&recipients[]=2&recipients[]=course_3. If the course/group
-     * has over 100 enrollments, 'bulk_message' and 'group_conversation' must be
-     * set to true.
-     */
+    /** An array of recipient ids. These may be user ids */
     recipients: string[];
     /**
      * The subject of the conversation. This is ignored when reusing a
@@ -73,6 +68,11 @@ export type createFormParameters = Masquerade & {
      * format as courses or groups in the recipients argument.
      */
     context_code: string;
+    /**
+     * "uuid":: Optionally include an "uuid" key for each user participating in
+     * the conversation
+     */
+    include: string[];
 };
 type Options = {
     searchParams?: Partial<createSearchParameters>;
@@ -89,7 +89,13 @@ type Options = {
  * Create a new conversation with one or more recipients. If there is already an
  * existing private conversation with the given recipients, it will be reused.
  *
+ * (either numeric IDs or UUIDs prefixed with "uuid:"), or course/group ids
+ * prefixed with "course_" or "group_" respectively, e.g.
+ * recipients[]=1&recipients[]=uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCBx&recipients[]=course_3.
+ * If the course/group has over 100 enrollments, 'bulk_message' and
+ * 'group_conversation' must be set to true.
+ *
  * Nickname: create_conversation
  */
-export declare function create(options: Options): Promise<void>;
+export declare function create(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Conversations/create.js

@@ -5,6 +5,12 @@ import { client } from '../../../Client.js';
  * Create a new conversation with one or more recipients. If there is already an
  * existing private conversation with the given recipients, it will be reused.
  *
+ * (either numeric IDs or UUIDs prefixed with "uuid:"), or course/group ids
+ * prefixed with "course_" or "group_" respectively, e.g.
+ * recipients[]=1&recipients[]=uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCBx&recipients[]=course_3.
+ * If the course/group has over 100 enrollments, 'bulk_message' and
+ * 'group_conversation' must be set to true.
+ *
  * Nickname: create_conversation
  */
 export async function create(options) {

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type delete_conversationPathParameters = {
     /**
@@ -27,5 +28,5 @@ type Options = {
  *
  * Nickname: delete_conversation
  */
-export declare function delete_conversation(options: Options): Promise<void>;
+export declare function delete_conversation(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type getPathParameters = {
     /**
@@ -57,5 +58,5 @@ type Options = {
  *
  * Nickname: get_single_conversation
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

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

@@ -10,9 +10,7 @@ export type listSearchParameters = Masquerade & Paginated & Partial<{
     scope: string;
     /**
      * When set, only return conversations for the specified courses, groups or
-     * users. The id should be prefixed with its type, e.g. "user_123" or
-     * "course_456". Can be an array (by setting "filter[]") or single value (by
-     * setting "filter")
+     * users. The id should be prefixed with its type, e.g. "user_123",
      */
     filter: string[];
     /**
@@ -40,7 +38,8 @@ export type listSearchParameters = Masquerade & Paginated & Partial<{
     include_all_conversation_ids: boolean | string;
     /**
      * "participant_avatars":: Optionally include an "avatar_url" key for each
-     * user participanting in the conversation
+     * user participating in the conversation "uuid":: Optionally include an
+     * "uuid" key for each user participating in the conversation
      */
     include: string[];
 }>;
@@ -57,6 +56,10 @@ type Options = {
  * Returns the paginated list of conversations for the current user, most recent
  * ones first.
  *
+ * "uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCB", or "course_456". For users,
+ * you can use either their numeric ID or UUID prefixed with "uuid:". Can be an
+ * array (by setting "filter[]") or single value (by setting "filter")
+ *
  * Nickname: list_conversations
  */
 export declare function list(options: Options): Promise<Conversation[]>;

package/dist/Endpoints/V1/Conversations/list.js

@@ -5,6 +5,10 @@ import { client } from '../../../Client.js';
  * Returns the paginated list of conversations for the current user, most recent
  * ones first.
  *
+ * "uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCB", or "course_456". For users,
+ * you can use either their numeric ID or UUID prefixed with "uuid:". Can be an
+ * array (by setting "filter[]") or single value (by setting "filter")
+ *
  * Nickname: list_conversations
  */
 export async function list(options) {

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type updatePathParameters = {
     /**
@@ -61,5 +62,5 @@ type Options = {
  *
  * Nickname: edit_conversation
  */
-export declare function update(options: Options): Promise<void>;
+export declare function update(options: Options): Promise<JSONValue>;
 export {};

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

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type course_activity_stream_summaryPathParameters = {
     /**
@@ -27,5 +28,5 @@ type Options = {
  *
  * Nickname: course_activity_stream_summary
  */
-export declare function course_activity_stream_summary(options: Options): Promise<void>;
+export declare function course_activity_stream_summary(options: Options): Promise<JSONValue>;
 export {};