@groton/canvas-api 0.3.6 → 0.3.7

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.3.7](https://github.com/groton-school/canvas-cli/compare/api/0.3.6...api/0.3.7) (2026-01-29)
+
+
+### Features
+
+* update to 2026-01-14 release ([91c1a2e](https://github.com/groton-school/canvas-cli/commit/91c1a2e57cb3718096b5ea30e09380b756b6f1a9))
+* update to 2026-01-28 spec ([9ab62f7](https://github.com/groton-school/canvas-cli/commit/9ab62f7c2f6de140a1b24b6aa25ed8b951cbfbb0))
+
 ## [0.3.6](https://github.com/groton-school/canvas-cli/compare/api/0.3.5...api/0.3.6) (2026-01-13)
 
 

package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/get.d.ts

@@ -0,0 +1,45 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * The id of the registration.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    id: number | string;
+    /**
+     * The id of the registration update request to retrieve.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    update_request_id: number | string;
+};
+export type getSearchParameters = Masquerade;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get LTI Registration Update Request
+ *
+ * Retrieves details about a specific registration update request.
+ *
+ * Nickname: get_lti_registration_update_request
+ */
+export declare function get(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/get.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Get LTI Registration Update Request
+ *
+ * Retrieves details about a specific registration update request.
+ *
+ * Nickname: get_lti_registration_update_request
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

@@ -1 +1,2 @@
 export * as Apply from './Apply/index.js';
+export * from './get.js';

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

@@ -1 +1,2 @@
 export * as Apply from './Apply/index.js';
+export * from './get.js';

package/dist/Endpoints/V1/Career/Enabled/check_if_canvas_career_is_enabled.d.ts

@@ -0,0 +1,19 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type check_if_canvas_career_is_enabledSearchParameters = Masquerade;
+type Options = {
+    searchParams?: Partial<check_if_canvas_career_is_enabledSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: check_if_canvas_career_is_enabledSearchParameters;
+    strict: true;
+};
+/**
+ * Check if Canvas Career is enabled
+ *
+ * Returns whether the root account has Canvas Career (Horizon) enabled in at
+ * least one subaccount.
+ *
+ * Nickname: check_if_canvas_career_is_enabled
+ */
+export declare function check_if_canvas_career_is_enabled(options: Options): Promise<import("@battis/typescript-tricks").JSONValue>;
+export {};

package/dist/Endpoints/V1/Career/Enabled/check_if_canvas_career_is_enabled.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../Client.js';
+/**
+ * Check if Canvas Career is enabled
+ *
+ * Returns whether the root account has Canvas Career (Horizon) enabled in at
+ * least one subaccount.
+ *
+ * Nickname: check_if_canvas_career_is_enabled
+ */
+export async function check_if_canvas_career_is_enabled(options) {
+    const response = await client().fetchAs(`/api/v1/career/enabled`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Career/Enabled/index.d.ts

@@ -0,0 +1 @@
+export * from './check_if_canvas_career_is_enabled.js';

package/dist/Endpoints/V1/Career/Enabled/index.js

@@ -0,0 +1 @@
+export * from './check_if_canvas_career_is_enabled.js';

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

@@ -1,3 +1,4 @@
+export * as Enabled from './Enabled/index.js';
 export * as ExperienceSummary from './ExperienceSummary/index.js';
 export * as SwitchExperience from './SwitchExperience/index.js';
 export * as SwitchRole from './SwitchRole/index.js';

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

@@ -1,3 +1,4 @@
+export * as Enabled from './Enabled/index.js';
 export * as ExperienceSummary from './ExperienceSummary/index.js';
 export * as SwitchExperience from './SwitchExperience/index.js';
 export * as SwitchRole from './SwitchRole/index.js';

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list.js';
+export * from './show_student_ai_conversation.js';

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/index.js

@@ -0,0 +1,2 @@
+export * from './list.js';
+export * from './show_student_ai_conversation.js';

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/list.d.ts

@@ -0,0 +1,36 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+export type listPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type listSearchParameters = Masquerade & Paginated;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * List student AI conversations
+ *
+ * Retrieve the latest AI conversation for each student in the course for this
+ * AI experience. Only available to teachers and course managers.
+ *
+ * Nickname: list_student_ai_conversations
+ */
+export declare function list(options: Options): Promise<JSONValue[]>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/list.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../../Client.js';
+/**
+ * List student AI conversations
+ *
+ * Retrieve the latest AI conversation for each student in the course for this
+ * AI experience. Only available to teachers and course managers.
+ *
+ * Nickname: list_student_ai_conversations
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

@@ -0,0 +1,42 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type show_student_ai_conversationPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    conversation_id: string | number;
+};
+export type show_student_ai_conversationSearchParameters = Masquerade;
+type Options = {
+    pathParams: show_student_ai_conversationPathParameters;
+} & ({
+    searchParams?: Partial<show_student_ai_conversationSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: show_student_ai_conversationSearchParameters;
+    strict: true;
+});
+/**
+ * Show student AI conversation
+ *
+ * Retrieve a specific student's AI conversation with full message history. Only
+ * available to teachers and course managers.
+ *
+ * Nickname: show_student_ai_conversation
+ */
+export declare function show_student_ai_conversation(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/show_student_ai_conversation.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Show student AI conversation
+ *
+ * Retrieve a specific student's AI conversation with full message history. Only
+ * available to teachers and course managers.
+ *
+ * Nickname: show_student_ai_conversation
+ */
+export async function show_student_ai_conversation(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.d.ts

@@ -2,3 +2,4 @@ export * from './create.js';
 export * from './delete_ai_conversation.js';
 export * from './get.js';
 export * as Messages from './Messages/index.js';
+export * from './show_conversation.js';

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.js

@@ -2,3 +2,4 @@ export * from './create.js';
 export * from './delete_ai_conversation.js';
 export * from './get.js';
 export * as Messages from './Messages/index.js';
+export * from './show_conversation.js';

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

@@ -0,0 +1,42 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type show_conversationPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    ai_experience_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type show_conversationSearchParameters = Masquerade;
+type Options = {
+    pathParams: show_conversationPathParameters;
+} & ({
+    searchParams?: Partial<show_conversationSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: show_conversationSearchParameters;
+    strict: true;
+});
+/**
+ * Show conversation
+ *
+ * Get a specific conversation by ID (for teachers viewing student
+ * conversations)
+ *
+ * Nickname: show_conversation
+ */
+export declare function show_conversation(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/show_conversation.js

@@ -0,0 +1,16 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Show conversation
+ *
+ * Get a specific conversation by ID (for teachers viewing student
+ * conversations)
+ *
+ * Nickname: show_conversation
+ */
+export async function show_conversation(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/AiExperiences/index.d.ts

@@ -1,3 +1,4 @@
+export * as AiConversations from './AiConversations/index.js';
 export * as Conversations from './Conversations/index.js';
 export * from './create.js';
 export * from './delete_ai_experience.js';

package/dist/Endpoints/V1/Courses/AiExperiences/index.js

@@ -1,3 +1,4 @@
+export * as AiConversations from './AiConversations/index.js';
 export * as Conversations from './Conversations/index.js';
 export * from './create.js';
 export * from './delete_ai_experience.js';

package/dist/Endpoints/V1/Courses/Assignments/AnonymousSubmissions/grade_or_comment_on_submission_by_anonymous_id_courses.d.ts

@@ -58,6 +58,8 @@ export type grade_or_comment_on_submission_by_anonymous_id_coursesFormParameters
      *   submission
      * - "sub_assignment_submissions": Sub-assignment submissions for discussion
      *   checkpoints
+     * - "peer_review_submissions": Peer review submission data when peer review
+     *   allocation and grading is enabled
      * - "provisional_grades": Provisional grades (only available for moderated
      *   assignments)
      * - "group": Group information (id and name) for group assignments

package/dist/Endpoints/V1/Courses/Assignments/DateDetails/get.d.ts

@@ -16,13 +16,33 @@ export type getPathParameters = {
 };
 export type getSearchParameters = Masquerade & Partial<{
     /**
-     * If true, includes peer review sub assignment information and overrides in
-     * the response. Requires the peer_review_grading feature flag to be
-     * enabled.
+     * Array of strings indicating what additional data to include in the
+     * response. Valid values:
      *
-     * Type: boolean
+     * - "peer_review": includes peer review sub assignment information and
+     *   overrides in the response. Requires the
+     *   peer_review_allocation_and_grading feature flag to be enabled.
+     * - "child_peer_review_override_dates": each assignment override will include
+     *   a peer_review_dates field containing the matched peer review override
+     *   data (id, due_at, unlock_at, lock_at) for that override. The field will
+     *   be present as null if no matching peer review override exists.
      */
-    include_peer_review: boolean | string;
+    include: string[];
+    /**
+     * Array of strings indicating what data to exclude from the response. Valid
+     * values:
+     *
+     * - "peer_review_overrides": when include[]=peer_review is also specified,
+     *   the peer_review_sub_assignment object will not include the overrides
+     *   array, reducing the response payload size. This is useful when using
+     *   include[]=child_peer_review_override_dates since the peer review
+     *   override data is already embedded in the parent assignment overrides.
+     * - "child_override_due_dates": prevents the sub_assignment_due_dates field
+     *   from being included in assignment override responses, even when
+     *   discussion checkpoints are enabled. This reduces response payload size
+     *   when checkpoint due date information is not needed.
+     */
+    exclude: string[];
 }>;
 type Options = {
     pathParams: getPathParameters;

package/dist/Endpoints/V1/Courses/Assignments/Submissions/grade_or_comment_on_submission_courses.d.ts

@@ -66,6 +66,8 @@ export type grade_or_comment_on_submission_coursesFormParameters = Masquerade &
      *   submission
      * - "sub_assignment_submissions": Sub-assignment submissions for discussion
      *   checkpoints
+     * - "peer_review_submissions": Peer review submission data when peer review
+     *   allocation and grading is enabled
      * - "provisional_grades": Provisional grades (only available for moderated
      *   assignments)
      * - "group": Group information (id and name) for group assignments
@@ -127,6 +129,17 @@ export type grade_or_comment_on_submission_coursesFormParameters = Masquerade &
      * Format: 'int64'
      */
     'submission[seconds_late_override]': number | string;
+    /**
+     * When true, updates the peer review sub assignment submission instead of
+     * the parent assignment submission. The parent assignment must have peer
+     * reviews enabled, the peer_review_allocation_and_grading feature flag must
+     * be enabled for the course, and the assignment must have an associated
+     * peer review sub assignment. If any of these conditions are not met, the
+     * API will return a 422 error.
+     *
+     * Type: boolean
+     */
+    'submission[peer_review]': boolean | string;
     /**
      * Assign a rubric assessment to this assignment submission. The
      * sub-parameters here depend on the rubric for the assignment. The general

package/dist/Endpoints/V1/Courses/Assignments/get.d.ts

@@ -21,7 +21,7 @@ export type getSearchParameters = Masquerade & Partial<{
      * turned on. If "observed_users" is passed, submissions for observed users
      * will also be included. For "score_statistics" to be included, the
      * "submission" option must also be set. The "peer_review" option requires
-     * that the Peer Review Grading course feature be turned on.
+     * that the Peer Review Allocation and Grading course feature be turned on.
      */
     include: string[];
     /**

package/dist/Endpoints/V1/Courses/DiscussionTopics/DateDetails/get.d.ts

@@ -16,13 +16,33 @@ export type getPathParameters = {
 };
 export type getSearchParameters = Masquerade & Partial<{
     /**
-     * If true, includes peer review sub assignment information and overrides in
-     * the response. Requires the peer_review_grading feature flag to be
-     * enabled.
+     * Array of strings indicating what additional data to include in the
+     * response. Valid values:
      *
-     * Type: boolean
+     * - "peer_review": includes peer review sub assignment information and
+     *   overrides in the response. Requires the
+     *   peer_review_allocation_and_grading feature flag to be enabled.
+     * - "child_peer_review_override_dates": each assignment override will include
+     *   a peer_review_dates field containing the matched peer review override
+     *   data (id, due_at, unlock_at, lock_at) for that override. The field will
+     *   be present as null if no matching peer review override exists.
      */
-    include_peer_review: boolean | string;
+    include: string[];
+    /**
+     * Array of strings indicating what data to exclude from the response. Valid
+     * values:
+     *
+     * - "peer_review_overrides": when include[]=peer_review is also specified,
+     *   the peer_review_sub_assignment object will not include the overrides
+     *   array, reducing the response payload size. This is useful when using
+     *   include[]=child_peer_review_override_dates since the peer review
+     *   override data is already embedded in the parent assignment overrides.
+     * - "child_override_due_dates": prevents the sub_assignment_due_dates field
+     *   from being included in assignment override responses, even when
+     *   discussion checkpoints are enabled. This reduces response payload size
+     *   when checkpoint due date information is not needed.
+     */
+    exclude: string[];
 }>;
 type Options = {
     pathParams: getPathParameters;

package/dist/Endpoints/V1/Courses/Files/DateDetails/get.d.ts

@@ -16,13 +16,33 @@ export type getPathParameters = {
 };
 export type getSearchParameters = Masquerade & Partial<{
     /**
-     * If true, includes peer review sub assignment information and overrides in
-     * the response. Requires the peer_review_grading feature flag to be
-     * enabled.
+     * Array of strings indicating what additional data to include in the
+     * response. Valid values:
      *
-     * Type: boolean
+     * - "peer_review": includes peer review sub assignment information and
+     *   overrides in the response. Requires the
+     *   peer_review_allocation_and_grading feature flag to be enabled.
+     * - "child_peer_review_override_dates": each assignment override will include
+     *   a peer_review_dates field containing the matched peer review override
+     *   data (id, due_at, unlock_at, lock_at) for that override. The field will
+     *   be present as null if no matching peer review override exists.
      */
-    include_peer_review: boolean | string;
+    include: string[];
+    /**
+     * Array of strings indicating what data to exclude from the response. Valid
+     * values:
+     *
+     * - "peer_review_overrides": when include[]=peer_review is also specified,
+     *   the peer_review_sub_assignment object will not include the overrides
+     *   array, reducing the response payload size. This is useful when using
+     *   include[]=child_peer_review_override_dates since the peer review
+     *   override data is already embedded in the parent assignment overrides.
+     * - "child_override_due_dates": prevents the sub_assignment_due_dates field
+     *   from being included in assignment override responses, even when
+     *   discussion checkpoints are enabled. This reduces response payload size
+     *   when checkpoint due date information is not needed.
+     */
+    exclude: string[];
 }>;
 type Options = {
     pathParams: getPathParameters;

package/dist/Endpoints/V1/Courses/Modules/DateDetails/get.d.ts

@@ -16,13 +16,33 @@ export type getPathParameters = {
 };
 export type getSearchParameters = Masquerade & Partial<{
     /**
-     * If true, includes peer review sub assignment information and overrides in
-     * the response. Requires the peer_review_grading feature flag to be
-     * enabled.
+     * Array of strings indicating what additional data to include in the
+     * response. Valid values:
      *
-     * Type: boolean
+     * - "peer_review": includes peer review sub assignment information and
+     *   overrides in the response. Requires the
+     *   peer_review_allocation_and_grading feature flag to be enabled.
+     * - "child_peer_review_override_dates": each assignment override will include
+     *   a peer_review_dates field containing the matched peer review override
+     *   data (id, due_at, unlock_at, lock_at) for that override. The field will
+     *   be present as null if no matching peer review override exists.
      */
-    include_peer_review: boolean | string;
+    include: string[];
+    /**
+     * Array of strings indicating what data to exclude from the response. Valid
+     * values:
+     *
+     * - "peer_review_overrides": when include[]=peer_review is also specified,
+     *   the peer_review_sub_assignment object will not include the overrides
+     *   array, reducing the response payload size. This is useful when using
+     *   include[]=child_peer_review_override_dates since the peer review
+     *   override data is already embedded in the parent assignment overrides.
+     * - "child_override_due_dates": prevents the sub_assignment_due_dates field
+     *   from being included in assignment override responses, even when
+     *   discussion checkpoints are enabled. This reduces response payload size
+     *   when checkpoint due date information is not needed.
+     */
+    exclude: string[];
 }>;
 type Options = {
     pathParams: getPathParameters;

package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.d.ts

@@ -12,13 +12,26 @@ export type getPathParameters = {
 };
 export type getSearchParameters = Masquerade & Paginated & Partial<{
     /**
-     * The id of the student
+     * The id of the student. Returns alignments filtered by student
+     * submissions. Can be combined with assignment_id to filter to a specific
+     * assignment.
      *
      * Type: integer
      *
      * Format: 'int64'
      */
     student_id: number | string;
+    /**
+     * The id of the assignment. When provided without student_id, returns all
+     * outcome alignments for the assignment (requires manage_grades or
+     * view_all_grades permission). When provided with student_id, filters to
+     * that student's submission.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    assignment_id: number | string;
 }>;
 type Options = {
     pathParams: getPathParameters;
@@ -30,13 +43,11 @@ type Options = {
     strict: true;
 });
 /**
- * Get aligned assignments for an outcome in a course for a particular student
+ * Get outcome alignments for a student or assignment
  *
- * Returns all assignments aligned to a specific outcome for a student in a
- * course.
+ * Returns outcome alignments for a student or assignment in a course.
  *
- * Nickname:
- * get_aligned_assignments_for_outcome_in_course_for_particular_student
+ * Nickname: get_outcome_alignments_for_student_or_assignment
  */
 export declare function get(options: Options): Promise<OutcomeAlignment[]>;
 export {};

package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.js

@@ -1,12 +1,10 @@
 import { client } from '../../../../Client.js';
 /**
- * Get aligned assignments for an outcome in a course for a particular student
+ * Get outcome alignments for a student or assignment
  *
- * Returns all assignments aligned to a specific outcome for a student in a
- * course.
+ * Returns outcome alignments for a student or assignment in a course.
  *
- * Nickname:
- * get_aligned_assignments_for_outcome_in_course_for_particular_student
+ * Nickname: get_outcome_alignments_for_student_or_assignment
  */
 export async function get(options) {
     const response = await client().fetchAs(`/api/v1/courses/{course_id}/outcome_alignments`, {

package/dist/Endpoints/V1/Courses/OutcomeRollups/get.d.ts

@@ -45,7 +45,8 @@ export type getSearchParameters = Masquerade & Partial<{
     include: string[];
     /**
      * Specify additional values to exclude. "missing_user_rollups" excludes
-     * rollups for users without results.
+     * rollups for users without results. "missing_outcome_results" excludes
+     * outcomes without results.
      */
     exclude: string[];
     /**
@@ -78,7 +79,10 @@ export type getSearchParameters = Masquerade & Partial<{
      */
     add_defaults: boolean | string;
     /**
-     * If contributing scores are requested, then each individual outcome score
+     * **DEPRECATED**: This parameter is deprecated. Use the separate GET
+     * /api/v1/courses/:course_id/outcomes/:outcome_id/contributing_scores
+     * endpoint instead to fetch contributing scores for a specific outcome. If
+     * contributing scores are requested, then each individual outcome score
      * will also include all graded artifacts that contributed to the outcome
      * score
      *