@groton/canvas-api 0.3.5 → 0.3.7

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 (78) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/get.d.ts +45 -0
  3. package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/get.js +15 -0
  4. package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/index.d.ts +1 -0
  5. package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/index.js +1 -0
  6. package/dist/Endpoints/V1/Career/Enabled/check_if_canvas_career_is_enabled.d.ts +19 -0
  7. package/dist/Endpoints/V1/Career/Enabled/check_if_canvas_career_is_enabled.js +16 -0
  8. package/dist/Endpoints/V1/Career/Enabled/index.d.ts +1 -0
  9. package/dist/Endpoints/V1/Career/Enabled/index.js +1 -0
  10. package/dist/Endpoints/V1/Career/index.d.ts +1 -0
  11. package/dist/Endpoints/V1/Career/index.js +1 -0
  12. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/index.d.ts +2 -0
  13. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/index.js +2 -0
  14. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/list.d.ts +36 -0
  15. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/list.js +16 -0
  16. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/show_student_ai_conversation.d.ts +42 -0
  17. package/dist/Endpoints/V1/Courses/AiExperiences/AiConversations/show_student_ai_conversation.js +16 -0
  18. package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.d.ts +1 -0
  19. package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/index.js +1 -0
  20. package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/show_conversation.d.ts +42 -0
  21. package/dist/Endpoints/V1/Courses/AiExperiences/Conversations/show_conversation.js +16 -0
  22. package/dist/Endpoints/V1/Courses/AiExperiences/index.d.ts +1 -0
  23. package/dist/Endpoints/V1/Courses/AiExperiences/index.js +1 -0
  24. package/dist/Endpoints/V1/Courses/Assignments/AnonymousSubmissions/grade_or_comment_on_submission_by_anonymous_id_courses.d.ts +2 -0
  25. package/dist/Endpoints/V1/Courses/Assignments/DateDetails/get.d.ts +25 -5
  26. package/dist/Endpoints/V1/Courses/Assignments/Submissions/grade_or_comment_on_submission_courses.d.ts +13 -0
  27. package/dist/Endpoints/V1/Courses/Assignments/get.d.ts +1 -1
  28. package/dist/Endpoints/V1/Courses/DiscussionTopics/DateDetails/get.d.ts +25 -5
  29. package/dist/Endpoints/V1/Courses/Files/DateDetails/get.d.ts +25 -5
  30. package/dist/Endpoints/V1/Courses/Folders/ByPath/index.d.ts +1 -1
  31. package/dist/Endpoints/V1/Courses/Folders/ByPath/index.js +1 -1
  32. package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.d.ts +39 -0
  33. package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.js +20 -0
  34. package/dist/Endpoints/V1/Courses/Modules/DateDetails/get.d.ts +25 -5
  35. package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.d.ts +17 -6
  36. package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.js +3 -5
  37. package/dist/Endpoints/V1/Courses/OutcomeRollups/get.d.ts +6 -2
  38. package/dist/Endpoints/V1/Courses/Outcomes/ContributingScores/get.d.ts +61 -0
  39. package/dist/Endpoints/V1/Courses/Outcomes/ContributingScores/get.js +19 -0
  40. package/dist/Endpoints/V1/Courses/Outcomes/ContributingScores/index.d.ts +1 -0
  41. package/dist/Endpoints/V1/Courses/Outcomes/ContributingScores/index.js +1 -0
  42. package/dist/Endpoints/V1/Courses/Outcomes/index.d.ts +1 -0
  43. package/dist/Endpoints/V1/Courses/Outcomes/index.js +1 -0
  44. package/dist/Endpoints/V1/Courses/Pages/DateDetails/get.d.ts +25 -5
  45. package/dist/Endpoints/V1/Courses/Quizzes/DateDetails/get.d.ts +25 -5
  46. package/dist/Endpoints/V1/Courses/Quizzes/Groups/index.d.ts +1 -0
  47. package/dist/Endpoints/V1/Courses/Quizzes/Groups/index.js +1 -0
  48. package/dist/Endpoints/V1/Courses/Quizzes/Groups/list.d.ts +35 -0
  49. package/dist/Endpoints/V1/Courses/Quizzes/Groups/list.js +15 -0
  50. package/dist/Endpoints/V1/Courses/index.d.ts +1 -0
  51. package/dist/Endpoints/V1/Courses/index.js +1 -0
  52. package/dist/Endpoints/V1/Groups/Folders/ByPath/index.d.ts +1 -1
  53. package/dist/Endpoints/V1/Groups/Folders/ByPath/index.js +1 -1
  54. package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.d.ts +39 -0
  55. package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.js +20 -0
  56. package/dist/Endpoints/V1/Groups/Users/list.d.ts +1 -1
  57. package/dist/Endpoints/V1/Planner/Items/list.d.ts +4 -1
  58. package/dist/Endpoints/V1/Sections/Assignments/AnonymousSubmissions/grade_or_comment_on_submission_by_anonymous_id_sections.d.ts +2 -0
  59. package/dist/Endpoints/V1/Sections/Assignments/Submissions/grade_or_comment_on_submission_sections.d.ts +13 -0
  60. package/dist/Endpoints/V1/Sections/Users/index.d.ts +1 -0
  61. package/dist/Endpoints/V1/Sections/Users/index.js +1 -0
  62. package/dist/Endpoints/V1/Sections/Users/list.d.ts +49 -0
  63. package/dist/Endpoints/V1/Sections/Users/list.js +15 -0
  64. package/dist/Endpoints/V1/Sections/index.d.ts +1 -0
  65. package/dist/Endpoints/V1/Sections/index.js +1 -0
  66. package/dist/Endpoints/V1/Users/Folders/ByPath/index.d.ts +1 -1
  67. package/dist/Endpoints/V1/Users/Folders/ByPath/index.js +1 -1
  68. package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.d.ts +39 -0
  69. package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.js +20 -0
  70. package/dist/Endpoints/V1/Users/Planner/Items/list.d.ts +4 -1
  71. package/dist/Overrides.d.ts +4 -0
  72. package/dist/Resources/AccountReports.d.ts +3 -0
  73. package/dist/Resources/Groups.d.ts +2 -2
  74. package/dist/Resources/LearningObjectDates.d.ts +1 -1
  75. package/dist/Resources/LtiRegistrations.d.ts +40 -1
  76. package/dist/Resources/Sections.d.ts +10 -0
  77. package/package.json +8 -8
  78. package/var/render.log +1091 -1075
package/CHANGELOG.md CHANGED
@@ -2,6 +2,21 @@
2
2
 
3
3
  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.
4
4
 
5
+ ## [0.3.7](https://github.com/groton-school/canvas-cli/compare/api/0.3.6...api/0.3.7) (2026-01-29)
6
+
7
+
8
+ ### Features
9
+
10
+ * update to 2026-01-14 release ([91c1a2e](https://github.com/groton-school/canvas-cli/commit/91c1a2e57cb3718096b5ea30e09380b756b6f1a9))
11
+ * update to 2026-01-28 spec ([9ab62f7](https://github.com/groton-school/canvas-cli/commit/9ab62f7c2f6de140a1b24b6aa25ed8b951cbfbb0))
12
+
13
+ ## [0.3.6](https://github.com/groton-school/canvas-cli/compare/api/0.3.5...api/0.3.6) (2026-01-13)
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * convert *full_path wildcard to regular path param ([f0f8b20](https://github.com/groton-school/canvas-cli/commit/f0f8b2079e0d35a5250994777c109d1b344a0be9))
19
+
5
20
  ## [0.3.5](https://github.com/groton-school/canvas-cli/compare/api/0.3.4...api/0.3.5) (2026-01-05)
6
21
 
7
22
 
@@ -0,0 +1,45 @@
1
+ import { JSONValue } from '@battis/typescript-tricks';
2
+ import { Masquerade } from '@groton/canvas-api.client.base';
3
+ export type getPathParameters = {
4
+ /**
5
+ * ID
6
+ *
7
+ * Type: string
8
+ */
9
+ account_id: string | number;
10
+ /**
11
+ * The id of the registration.
12
+ *
13
+ * Type: integer
14
+ *
15
+ * Format: 'int64'
16
+ */
17
+ id: number | string;
18
+ /**
19
+ * The id of the registration update request to retrieve.
20
+ *
21
+ * Type: integer
22
+ *
23
+ * Format: 'int64'
24
+ */
25
+ update_request_id: number | string;
26
+ };
27
+ export type getSearchParameters = Masquerade;
28
+ type Options = {
29
+ pathParams: getPathParameters;
30
+ } & ({
31
+ searchParams?: Partial<getSearchParameters>;
32
+ strict?: false;
33
+ } | {
34
+ searchParams: getSearchParameters;
35
+ strict: true;
36
+ });
37
+ /**
38
+ * Get LTI Registration Update Request
39
+ *
40
+ * Retrieves details about a specific registration update request.
41
+ *
42
+ * Nickname: get_lti_registration_update_request
43
+ */
44
+ export declare function get(options: Options): Promise<JSONValue>;
45
+ export {};
@@ -0,0 +1,15 @@
1
+ import { client } from '../../../../../Client.js';
2
+ /**
3
+ * Get LTI Registration Update Request
4
+ *
5
+ * Retrieves details about a specific registration update request.
6
+ *
7
+ * Nickname: get_lti_registration_update_request
8
+ */
9
+ export async function get(options) {
10
+ const response = await client().fetchAs(`/api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}`, {
11
+ method: 'GET',
12
+ ...options
13
+ });
14
+ return response;
15
+ }
@@ -1 +1,2 @@
1
1
  export * as Apply from './Apply/index.js';
2
+ export * from './get.js';
@@ -1 +1,2 @@
1
1
  export * as Apply from './Apply/index.js';
2
+ export * from './get.js';
@@ -0,0 +1,19 @@
1
+ import { Masquerade } from '@groton/canvas-api.client.base';
2
+ export type check_if_canvas_career_is_enabledSearchParameters = Masquerade;
3
+ type Options = {
4
+ searchParams?: Partial<check_if_canvas_career_is_enabledSearchParameters>;
5
+ strict?: false;
6
+ } | {
7
+ searchParams: check_if_canvas_career_is_enabledSearchParameters;
8
+ strict: true;
9
+ };
10
+ /**
11
+ * Check if Canvas Career is enabled
12
+ *
13
+ * Returns whether the root account has Canvas Career (Horizon) enabled in at
14
+ * least one subaccount.
15
+ *
16
+ * Nickname: check_if_canvas_career_is_enabled
17
+ */
18
+ export declare function check_if_canvas_career_is_enabled(options: Options): Promise<import("@battis/typescript-tricks").JSONValue>;
19
+ export {};
@@ -0,0 +1,16 @@
1
+ import { client } from '../../../../Client.js';
2
+ /**
3
+ * Check if Canvas Career is enabled
4
+ *
5
+ * Returns whether the root account has Canvas Career (Horizon) enabled in at
6
+ * least one subaccount.
7
+ *
8
+ * Nickname: check_if_canvas_career_is_enabled
9
+ */
10
+ export async function check_if_canvas_career_is_enabled(options) {
11
+ const response = await client().fetchAs(`/api/v1/career/enabled`, {
12
+ method: 'GET',
13
+ ...options
14
+ });
15
+ return response;
16
+ }
@@ -0,0 +1 @@
1
+ export * from './check_if_canvas_career_is_enabled.js';
@@ -0,0 +1 @@
1
+ export * from './check_if_canvas_career_is_enabled.js';
@@ -1,3 +1,4 @@
1
+ export * as Enabled from './Enabled/index.js';
1
2
  export * as ExperienceSummary from './ExperienceSummary/index.js';
2
3
  export * as SwitchExperience from './SwitchExperience/index.js';
3
4
  export * as SwitchRole from './SwitchRole/index.js';
@@ -1,3 +1,4 @@
1
+ export * as Enabled from './Enabled/index.js';
1
2
  export * as ExperienceSummary from './ExperienceSummary/index.js';
2
3
  export * as SwitchExperience from './SwitchExperience/index.js';
3
4
  export * as SwitchRole from './SwitchRole/index.js';
@@ -0,0 +1,2 @@
1
+ export * from './list.js';
2
+ export * from './show_student_ai_conversation.js';
@@ -0,0 +1,2 @@
1
+ export * from './list.js';
2
+ export * from './show_student_ai_conversation.js';
@@ -0,0 +1,36 @@
1
+ import { JSONValue } from '@battis/typescript-tricks';
2
+ import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
3
+ export type listPathParameters = {
4
+ /**
5
+ * ID
6
+ *
7
+ * Type: string
8
+ */
9
+ course_id: string | number;
10
+ /**
11
+ * ID
12
+ *
13
+ * Type: string
14
+ */
15
+ id: string | number;
16
+ };
17
+ export type listSearchParameters = Masquerade & Paginated;
18
+ type Options = {
19
+ pathParams: listPathParameters;
20
+ } & ({
21
+ searchParams?: Partial<listSearchParameters>;
22
+ strict?: false;
23
+ } | {
24
+ searchParams: listSearchParameters;
25
+ strict: true;
26
+ });
27
+ /**
28
+ * List student AI conversations
29
+ *
30
+ * Retrieve the latest AI conversation for each student in the course for this
31
+ * AI experience. Only available to teachers and course managers.
32
+ *
33
+ * Nickname: list_student_ai_conversations
34
+ */
35
+ export declare function list(options: Options): Promise<JSONValue[]>;
36
+ export {};
@@ -0,0 +1,16 @@
1
+ import { client } from '../../../../../Client.js';
2
+ /**
3
+ * List student AI conversations
4
+ *
5
+ * Retrieve the latest AI conversation for each student in the course for this
6
+ * AI experience. Only available to teachers and course managers.
7
+ *
8
+ * Nickname: list_student_ai_conversations
9
+ */
10
+ export async function list(options) {
11
+ const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations`, {
12
+ method: 'GET',
13
+ ...options
14
+ });
15
+ return response;
16
+ }
@@ -0,0 +1,42 @@
1
+ import { JSONValue } from '@battis/typescript-tricks';
2
+ import { Masquerade } from '@groton/canvas-api.client.base';
3
+ export type show_student_ai_conversationPathParameters = {
4
+ /**
5
+ * ID
6
+ *
7
+ * Type: string
8
+ */
9
+ course_id: string | number;
10
+ /**
11
+ * ID
12
+ *
13
+ * Type: string
14
+ */
15
+ id: string | number;
16
+ /**
17
+ * ID
18
+ *
19
+ * Type: string
20
+ */
21
+ conversation_id: string | number;
22
+ };
23
+ export type show_student_ai_conversationSearchParameters = Masquerade;
24
+ type Options = {
25
+ pathParams: show_student_ai_conversationPathParameters;
26
+ } & ({
27
+ searchParams?: Partial<show_student_ai_conversationSearchParameters>;
28
+ strict?: false;
29
+ } | {
30
+ searchParams: show_student_ai_conversationSearchParameters;
31
+ strict: true;
32
+ });
33
+ /**
34
+ * Show student AI conversation
35
+ *
36
+ * Retrieve a specific student's AI conversation with full message history. Only
37
+ * available to teachers and course managers.
38
+ *
39
+ * Nickname: show_student_ai_conversation
40
+ */
41
+ export declare function show_student_ai_conversation(options: Options): Promise<JSONValue>;
42
+ export {};
@@ -0,0 +1,16 @@
1
+ import { client } from '../../../../../Client.js';
2
+ /**
3
+ * Show student AI conversation
4
+ *
5
+ * Retrieve a specific student's AI conversation with full message history. Only
6
+ * available to teachers and course managers.
7
+ *
8
+ * Nickname: show_student_ai_conversation
9
+ */
10
+ export async function show_student_ai_conversation(options) {
11
+ const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id}`, {
12
+ method: 'GET',
13
+ ...options
14
+ });
15
+ return response;
16
+ }
@@ -2,3 +2,4 @@ export * from './create.js';
2
2
  export * from './delete_ai_conversation.js';
3
3
  export * from './get.js';
4
4
  export * as Messages from './Messages/index.js';
5
+ export * from './show_conversation.js';
@@ -2,3 +2,4 @@ export * from './create.js';
2
2
  export * from './delete_ai_conversation.js';
3
3
  export * from './get.js';
4
4
  export * as Messages from './Messages/index.js';
5
+ export * from './show_conversation.js';
@@ -0,0 +1,42 @@
1
+ import { JSONValue } from '@battis/typescript-tricks';
2
+ import { Masquerade } from '@groton/canvas-api.client.base';
3
+ export type show_conversationPathParameters = {
4
+ /**
5
+ * ID
6
+ *
7
+ * Type: string
8
+ */
9
+ course_id: string | number;
10
+ /**
11
+ * ID
12
+ *
13
+ * Type: string
14
+ */
15
+ ai_experience_id: string | number;
16
+ /**
17
+ * ID
18
+ *
19
+ * Type: string
20
+ */
21
+ id: string | number;
22
+ };
23
+ export type show_conversationSearchParameters = Masquerade;
24
+ type Options = {
25
+ pathParams: show_conversationPathParameters;
26
+ } & ({
27
+ searchParams?: Partial<show_conversationSearchParameters>;
28
+ strict?: false;
29
+ } | {
30
+ searchParams: show_conversationSearchParameters;
31
+ strict: true;
32
+ });
33
+ /**
34
+ * Show conversation
35
+ *
36
+ * Get a specific conversation by ID (for teachers viewing student
37
+ * conversations)
38
+ *
39
+ * Nickname: show_conversation
40
+ */
41
+ export declare function show_conversation(options: Options): Promise<JSONValue>;
42
+ export {};
@@ -0,0 +1,16 @@
1
+ import { client } from '../../../../../Client.js';
2
+ /**
3
+ * Show conversation
4
+ *
5
+ * Get a specific conversation by ID (for teachers viewing student
6
+ * conversations)
7
+ *
8
+ * Nickname: show_conversation
9
+ */
10
+ export async function show_conversation(options) {
11
+ const response = await client().fetchAs(`/api/v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}`, {
12
+ method: 'GET',
13
+ ...options
14
+ });
15
+ return response;
16
+ }
@@ -1,3 +1,4 @@
1
+ export * as AiConversations from './AiConversations/index.js';
1
2
  export * as Conversations from './Conversations/index.js';
2
3
  export * from './create.js';
3
4
  export * from './delete_ai_experience.js';
@@ -1,3 +1,4 @@
1
+ export * as AiConversations from './AiConversations/index.js';
1
2
  export * as Conversations from './Conversations/index.js';
2
3
  export * from './create.js';
3
4
  export * from './delete_ai_experience.js';
@@ -58,6 +58,8 @@ export type grade_or_comment_on_submission_by_anonymous_id_coursesFormParameters
58
58
  * submission
59
59
  * - "sub_assignment_submissions": Sub-assignment submissions for discussion
60
60
  * checkpoints
61
+ * - "peer_review_submissions": Peer review submission data when peer review
62
+ * allocation and grading is enabled
61
63
  * - "provisional_grades": Provisional grades (only available for moderated
62
64
  * assignments)
63
65
  * - "group": Group information (id and name) for group assignments
@@ -16,13 +16,33 @@ export type getPathParameters = {
16
16
  };
17
17
  export type getSearchParameters = Masquerade & Partial<{
18
18
  /**
19
- * If true, includes peer review sub assignment information and overrides in
20
- * the response. Requires the peer_review_grading feature flag to be
21
- * enabled.
19
+ * Array of strings indicating what additional data to include in the
20
+ * response. Valid values:
22
21
  *
23
- * Type: boolean
22
+ * - "peer_review": includes peer review sub assignment information and
23
+ * overrides in the response. Requires the
24
+ * peer_review_allocation_and_grading feature flag to be enabled.
25
+ * - "child_peer_review_override_dates": each assignment override will include
26
+ * a peer_review_dates field containing the matched peer review override
27
+ * data (id, due_at, unlock_at, lock_at) for that override. The field will
28
+ * be present as null if no matching peer review override exists.
24
29
  */
25
- include_peer_review: boolean | string;
30
+ include: string[];
31
+ /**
32
+ * Array of strings indicating what data to exclude from the response. Valid
33
+ * values:
34
+ *
35
+ * - "peer_review_overrides": when include[]=peer_review is also specified,
36
+ * the peer_review_sub_assignment object will not include the overrides
37
+ * array, reducing the response payload size. This is useful when using
38
+ * include[]=child_peer_review_override_dates since the peer review
39
+ * override data is already embedded in the parent assignment overrides.
40
+ * - "child_override_due_dates": prevents the sub_assignment_due_dates field
41
+ * from being included in assignment override responses, even when
42
+ * discussion checkpoints are enabled. This reduces response payload size
43
+ * when checkpoint due date information is not needed.
44
+ */
45
+ exclude: string[];
26
46
  }>;
27
47
  type Options = {
28
48
  pathParams: getPathParameters;
@@ -66,6 +66,8 @@ export type grade_or_comment_on_submission_coursesFormParameters = Masquerade &
66
66
  * submission
67
67
  * - "sub_assignment_submissions": Sub-assignment submissions for discussion
68
68
  * checkpoints
69
+ * - "peer_review_submissions": Peer review submission data when peer review
70
+ * allocation and grading is enabled
69
71
  * - "provisional_grades": Provisional grades (only available for moderated
70
72
  * assignments)
71
73
  * - "group": Group information (id and name) for group assignments
@@ -127,6 +129,17 @@ export type grade_or_comment_on_submission_coursesFormParameters = Masquerade &
127
129
  * Format: 'int64'
128
130
  */
129
131
  'submission[seconds_late_override]': number | string;
132
+ /**
133
+ * When true, updates the peer review sub assignment submission instead of
134
+ * the parent assignment submission. The parent assignment must have peer
135
+ * reviews enabled, the peer_review_allocation_and_grading feature flag must
136
+ * be enabled for the course, and the assignment must have an associated
137
+ * peer review sub assignment. If any of these conditions are not met, the
138
+ * API will return a 422 error.
139
+ *
140
+ * Type: boolean
141
+ */
142
+ 'submission[peer_review]': boolean | string;
130
143
  /**
131
144
  * Assign a rubric assessment to this assignment submission. The
132
145
  * sub-parameters here depend on the rubric for the assignment. The general
@@ -21,7 +21,7 @@ export type getSearchParameters = Masquerade & Partial<{
21
21
  * turned on. If "observed_users" is passed, submissions for observed users
22
22
  * will also be included. For "score_statistics" to be included, the
23
23
  * "submission" option must also be set. The "peer_review" option requires
24
- * that the Peer Review Grading course feature be turned on.
24
+ * that the Peer Review Allocation and Grading course feature be turned on.
25
25
  */
26
26
  include: string[];
27
27
  /**
@@ -16,13 +16,33 @@ export type getPathParameters = {
16
16
  };
17
17
  export type getSearchParameters = Masquerade & Partial<{
18
18
  /**
19
- * If true, includes peer review sub assignment information and overrides in
20
- * the response. Requires the peer_review_grading feature flag to be
21
- * enabled.
19
+ * Array of strings indicating what additional data to include in the
20
+ * response. Valid values:
22
21
  *
23
- * Type: boolean
22
+ * - "peer_review": includes peer review sub assignment information and
23
+ * overrides in the response. Requires the
24
+ * peer_review_allocation_and_grading feature flag to be enabled.
25
+ * - "child_peer_review_override_dates": each assignment override will include
26
+ * a peer_review_dates field containing the matched peer review override
27
+ * data (id, due_at, unlock_at, lock_at) for that override. The field will
28
+ * be present as null if no matching peer review override exists.
24
29
  */
25
- include_peer_review: boolean | string;
30
+ include: string[];
31
+ /**
32
+ * Array of strings indicating what data to exclude from the response. Valid
33
+ * values:
34
+ *
35
+ * - "peer_review_overrides": when include[]=peer_review is also specified,
36
+ * the peer_review_sub_assignment object will not include the overrides
37
+ * array, reducing the response payload size. This is useful when using
38
+ * include[]=child_peer_review_override_dates since the peer review
39
+ * override data is already embedded in the parent assignment overrides.
40
+ * - "child_override_due_dates": prevents the sub_assignment_due_dates field
41
+ * from being included in assignment override responses, even when
42
+ * discussion checkpoints are enabled. This reduces response payload size
43
+ * when checkpoint due date information is not needed.
44
+ */
45
+ exclude: string[];
26
46
  }>;
27
47
  type Options = {
28
48
  pathParams: getPathParameters;
@@ -16,13 +16,33 @@ export type getPathParameters = {
16
16
  };
17
17
  export type getSearchParameters = Masquerade & Partial<{
18
18
  /**
19
- * If true, includes peer review sub assignment information and overrides in
20
- * the response. Requires the peer_review_grading feature flag to be
21
- * enabled.
19
+ * Array of strings indicating what additional data to include in the
20
+ * response. Valid values:
22
21
  *
23
- * Type: boolean
22
+ * - "peer_review": includes peer review sub assignment information and
23
+ * overrides in the response. Requires the
24
+ * peer_review_allocation_and_grading feature flag to be enabled.
25
+ * - "child_peer_review_override_dates": each assignment override will include
26
+ * a peer_review_dates field containing the matched peer review override
27
+ * data (id, due_at, unlock_at, lock_at) for that override. The field will
28
+ * be present as null if no matching peer review override exists.
24
29
  */
25
- include_peer_review: boolean | string;
30
+ include: string[];
31
+ /**
32
+ * Array of strings indicating what data to exclude from the response. Valid
33
+ * values:
34
+ *
35
+ * - "peer_review_overrides": when include[]=peer_review is also specified,
36
+ * the peer_review_sub_assignment object will not include the overrides
37
+ * array, reducing the response payload size. This is useful when using
38
+ * include[]=child_peer_review_override_dates since the peer review
39
+ * override data is already embedded in the parent assignment overrides.
40
+ * - "child_override_due_dates": prevents the sub_assignment_due_dates field
41
+ * from being included in assignment override responses, even when
42
+ * discussion checkpoints are enabled. This reduces response payload size
43
+ * when checkpoint due date information is not needed.
44
+ */
45
+ exclude: string[];
26
46
  }>;
27
47
  type Options = {
28
48
  pathParams: getPathParameters;
@@ -1,2 +1,2 @@
1
- export * as FullPath from './*fullPath/index.js';
2
1
  export * from './resolve_path_courses.js';
2
+ export * from './resolve_path_courses_full_path.js';
@@ -1,2 +1,2 @@
1
- export * as FullPath from './*fullPath/index.js';
2
1
  export * from './resolve_path_courses.js';
2
+ export * from './resolve_path_courses_full_path.js';
@@ -0,0 +1,39 @@
1
+ import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
2
+ import { Folder } from '../../../../../Resources/Files.js';
3
+ export type resolve_path_courses_full_pathPathParameters = {
4
+ /**
5
+ * ID
6
+ *
7
+ * Type: string
8
+ */
9
+ course_id: string | number;
10
+ /**
11
+ * Identified by @groton/canvas-api.swagger-renderer from the endpoint path:
12
+ * /v1/courses/{course_id}/folders/by_path/*full_path
13
+ */
14
+ full_path: string;
15
+ };
16
+ export type resolve_path_courses_full_pathSearchParameters = Masquerade & Paginated;
17
+ type Options = {
18
+ pathParams: resolve_path_courses_full_pathPathParameters;
19
+ } & ({
20
+ searchParams?: Partial<resolve_path_courses_full_pathSearchParameters>;
21
+ strict?: false;
22
+ } | {
23
+ searchParams: resolve_path_courses_full_pathSearchParameters;
24
+ strict: true;
25
+ });
26
+ /**
27
+ * Resolve path
28
+ *
29
+ * Given the full path to a folder, returns a list of all Folders in the path
30
+ * hierarchy, starting at the root folder, and ending at the requested folder.
31
+ * The given path is relative to the context's root folder and does not include
32
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
33
+ * context's root folder alone is returned. Otherwise, if no folder exists with
34
+ * the given full path, a Not Found error is returned.
35
+ *
36
+ * Nickname: resolve_path_courses_full_path
37
+ */
38
+ export declare function resolve_path_courses_full_path(options: Options): Promise<Folder[]>;
39
+ export {};
@@ -0,0 +1,20 @@
1
+ import { client } from '../../../../../Client.js';
2
+ /**
3
+ * Resolve path
4
+ *
5
+ * Given the full path to a folder, returns a list of all Folders in the path
6
+ * hierarchy, starting at the root folder, and ending at the requested folder.
7
+ * The given path is relative to the context's root folder and does not include
8
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
9
+ * context's root folder alone is returned. Otherwise, if no folder exists with
10
+ * the given full path, a Not Found error is returned.
11
+ *
12
+ * Nickname: resolve_path_courses_full_path
13
+ */
14
+ export async function resolve_path_courses_full_path(options) {
15
+ const response = await client().fetchAs(`/api/v1/courses/{course_id}/folders/by_path/{full_path}`, {
16
+ method: 'GET',
17
+ ...options
18
+ });
19
+ return response;
20
+ }
@@ -16,13 +16,33 @@ export type getPathParameters = {
16
16
  };
17
17
  export type getSearchParameters = Masquerade & Partial<{
18
18
  /**
19
- * If true, includes peer review sub assignment information and overrides in
20
- * the response. Requires the peer_review_grading feature flag to be
21
- * enabled.
19
+ * Array of strings indicating what additional data to include in the
20
+ * response. Valid values:
22
21
  *
23
- * Type: boolean
22
+ * - "peer_review": includes peer review sub assignment information and
23
+ * overrides in the response. Requires the
24
+ * peer_review_allocation_and_grading feature flag to be enabled.
25
+ * - "child_peer_review_override_dates": each assignment override will include
26
+ * a peer_review_dates field containing the matched peer review override
27
+ * data (id, due_at, unlock_at, lock_at) for that override. The field will
28
+ * be present as null if no matching peer review override exists.
24
29
  */
25
- include_peer_review: boolean | string;
30
+ include: string[];
31
+ /**
32
+ * Array of strings indicating what data to exclude from the response. Valid
33
+ * values:
34
+ *
35
+ * - "peer_review_overrides": when include[]=peer_review is also specified,
36
+ * the peer_review_sub_assignment object will not include the overrides
37
+ * array, reducing the response payload size. This is useful when using
38
+ * include[]=child_peer_review_override_dates since the peer review
39
+ * override data is already embedded in the parent assignment overrides.
40
+ * - "child_override_due_dates": prevents the sub_assignment_due_dates field
41
+ * from being included in assignment override responses, even when
42
+ * discussion checkpoints are enabled. This reduces response payload size
43
+ * when checkpoint due date information is not needed.
44
+ */
45
+ exclude: string[];
26
46
  }>;
27
47
  type Options = {
28
48
  pathParams: getPathParameters;