@groton/canvas-api 0.3.8 → 0.3.10

package/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 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.10](https://github.com/groton-school/canvas-cli/compare/api/0.3.9...api/0.3.10) (2026-04-06)
+
+
+### Bug Fixes
+
+* missing Intellisense link on searchParams deprecation inserted ([e3ff023](https://github.com/groton-school/canvas-cli/commit/e3ff0231d0c52c8bbd73263ffd41fabec468839f))
+* update README to match non-deprecated usage ([2988065](https://github.com/groton-school/canvas-cli/commit/298806550596944a295ec3823ef75bce31a277ad))
+
+## [0.3.9](https://github.com/groton-school/canvas-cli/compare/api/0.3.8...api/0.3.9) (2026-04-06)
+
+
+### Bug Fixes
+
+* restore strict param functionality ([e424e2e](https://github.com/groton-school/canvas-cli/commit/e424e2e820633e5c13f2ae622df8a359d872ddce))
+
 ## [0.3.8](https://github.com/groton-school/canvas-cli/compare/api/0.3.7...api/0.3.8) (2026-04-06)
 
 

package/README.md

@@ -8,7 +8,7 @@ Typed access to Canvas LMS API with embedded documentation
 
 This started as a component of [@groton/canvas-cli](https://www.npmjs.com/package/@groton/canvas-cli), a command-line set of administrative scripts that I have banged together. However, access to the inline documentation and IntelliSense autocompletions in a few front-end applications evolved this package into an API-only package that depends on purpose-dependent clients for use:
 
-- [@groton/canvas-api.client.base](https://www.npmjs.com/package/@groton/canvas-api.client.base) provides interfaces and types to be used by any implementing packages.
+- [Canvas.Client.Base](./src//Client//Base.ts) provides interfaces and types to be used by any implementing packages.
 - [@oauth2-cli/canvas](https://www.npmjs.com/package/@oauth2-cli/canvas) is a client for use in Node command-line apps, which takes advantage of the [oauth2-cli](https://www.npmjs.com/package/oauth2-cli) to handle authentication to a Canvas LMS instance from the command-line, provides an easy-to-work-with `Canvas` object to call the API endpoints through, and can be used as a [@qui-cli/plugin](https://npmjs.com/package/@qui-cli/plugin) when building a CLI tool.
 - [@groton/canvas-api.client.web](https://www.npmjs.com/package/@groton/canvas-api.client.web) pairs with [groton-school/slim-canvas-api-proxy](https://packagist.org/packages/groton-school/slim-canvas-api-proxy) to support making browser-based calls to the Canvas LMS API (for example, as part of [an LTI tool](https://github.com/groton-school/planner-lti)).
 
@@ -29,7 +29,7 @@ import * as Canvas from '@groton/canvas-api';
 
 // pull a paginated list of typed users from the API
 for (const user of await Canvas.v1.Accounts.Users.list({
-  pathParams: { account_id: 1 }
+  path: { account_id: 1 }
 })) {
   console.log(user.name);
 }
@@ -65,11 +65,11 @@ GET /api/v1/accounts/{account_id}/outcome_groups/{id}/subgroups
 
 ```ts
 await Canvas.v1.Accounts.OutcomeGroups.Subgroups.list({
-  pathParams: {
+  path: {
     account_id: 123,
     id: 456
   },
-  searchParams: {
+  query: {
     as_user_id: 789,
     per_page: 20
   }
@@ -81,7 +81,7 @@ await Canvas.v1.Accounts.OutcomeGroups.Subgroups.list({
 - `snake_case` becomes `CamelCase` for namespaces and objects and `pascalCase` for methods.
 - Method names are shortened from their nicknames (`list_subgroups_accounts`) to remove redundancies in the TypeScript API.
 - All method calls are asynchronous.
-- Path parameters are passed as properties of the `pathParams` property, search/query parameters are passed as properties of the `searchParams` property, and body/form parameters are passed as properties of the `params` property.
+- Path parameters are passed as properties of the `path` property, search/query parameters are passed as properties of the `query` property, and body/form parameters are passed as properties of the `body` property.
 - Methods that upload files also require a `file` property, which may have either a `filePath` property or a `url` property. (Not all clients support both local and URL uploads).
 - All methods support masquerading via the `as_user_id` parameter passed as either in `searchParams` or the body `params` (if available).
 - Methods that return paginated responses can adjust the pagination via `per_pages` and will return the complete list as a result of the method.

package/dist/Endpoints/Lti/Accounts/get.d.ts

@@ -16,15 +16,17 @@ type Options = ({
     pathParams: getPathParameters;
 }) & ({
     query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get account
  *

package/dist/Endpoints/Lti/Assignments/Files/OriginalityReport/show_originality_report_files.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: show_originality_report_filesPathParameters;
 }) & ({
     query?: Partial<show_originality_report_filesSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<show_originality_report_filesSearchParameters>;
     strict?: false;
+} | (({
+    query: show_originality_report_filesSearchParameters;
 } | {
-    query?: Partial<show_originality_report_filesSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: show_originality_report_filesSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show an Originality Report
  *

package/dist/Endpoints/Lti/Assignments/Files/OriginalityReport/update.d.ts

@@ -68,21 +68,25 @@ type Options = ({
     pathParams: updatePathParameters;
 }) & ({
     query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<updateSearchParameters>;
     body?: Partial<updateFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Edit an Originality Report
  *

package/dist/Endpoints/Lti/Assignments/Submissions/History/get.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: getPathParameters;
 }) & ({
     query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get the history of a single submission
  *

package/dist/Endpoints/Lti/Assignments/Submissions/OriginalityReport/create.d.ts

@@ -90,21 +90,25 @@ type Options = ({
     pathParams: createPathParameters;
 }) & ({
     query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<createSearchParameters>;
     body?: Partial<createFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
+} | (({
+    query: createSearchParameters;
 } | {
-    query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: createSearchParameters;
-    body?: Partial<createFormParameters>;
+}) & ({
+    body: createFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create an Originality Report
  *

package/dist/Endpoints/Lti/Assignments/Submissions/OriginalityReport/show_originality_report_submissions.d.ts

@@ -28,15 +28,17 @@ type Options = ({
     pathParams: show_originality_report_submissionsPathParameters;
 }) & ({
     query?: Partial<show_originality_report_submissionsSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<show_originality_report_submissionsSearchParameters>;
     strict?: false;
+} | (({
+    query: show_originality_report_submissionsSearchParameters;
 } | {
-    query?: Partial<show_originality_report_submissionsSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: show_originality_report_submissionsSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show an Originality Report
  *

package/dist/Endpoints/Lti/Assignments/Submissions/OriginalityReport/update.d.ts

@@ -74,21 +74,25 @@ type Options = ({
     pathParams: updatePathParameters;
 }) & ({
     query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<updateSearchParameters>;
     body?: Partial<updateFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Edit an Originality Report
  *

package/dist/Endpoints/Lti/Assignments/Submissions/get.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: getPathParameters;
 }) & ({
     query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get a single submission
  *

package/dist/Endpoints/Lti/Assignments/get.d.ts

@@ -19,15 +19,17 @@ type Options = ({
     pathParams: getPathParameters;
 }) & ({
     query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get a single assignment (lti)
  *

package/dist/Endpoints/Lti/Courses/LineItems/Results/show_collection_of_results.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: show_collection_of_resultsPathParameters;
 }) & ({
     query?: Partial<show_collection_of_resultsSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<show_collection_of_resultsSearchParameters>;
     strict?: false;
+} | (({
+    query: show_collection_of_resultsSearchParameters;
 } | {
-    query?: Partial<show_collection_of_resultsSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: show_collection_of_resultsSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show a collection of Results
  *

package/dist/Endpoints/Lti/Courses/LineItems/Results/show_result.d.ts

@@ -28,15 +28,17 @@ type Options = ({
     pathParams: show_resultPathParameters;
 }) & ({
     query?: Partial<show_resultSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<show_resultSearchParameters>;
     strict?: false;
+} | (({
+    query: show_resultSearchParameters;
 } | {
-    query?: Partial<show_resultSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: show_resultSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show a Result
  *

package/dist/Endpoints/Lti/Courses/LineItems/Scores/create.d.ts

@@ -133,21 +133,25 @@ type Options = ({
     pathParams: createPathParameters;
 }) & ({
     query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<createSearchParameters>;
     body?: Partial<createFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
+} | (({
+    query: createSearchParameters;
 } | {
-    query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: createSearchParameters;
-    body?: Partial<createFormParameters>;
+}) & ({
+    body: createFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a Score
  *

package/dist/Endpoints/Lti/Courses/LineItems/create.d.ts

@@ -69,21 +69,25 @@ type Options = ({
     pathParams: createPathParameters;
 }) & ({
     query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<createSearchParameters>;
     body?: Partial<createFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
+} | (({
+    query: createSearchParameters;
 } | {
-    query?: Partial<createSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: createSearchParameters;
-    body?: Partial<createFormParameters>;
+}) & ({
+    body: createFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a Line Item
  *

package/dist/Endpoints/Lti/Courses/LineItems/delete_line_item.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: delete_line_itemPathParameters;
 }) & ({
     query?: Partial<delete_line_itemSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<delete_line_itemSearchParameters>;
     strict?: false;
+} | (({
+    query: delete_line_itemSearchParameters;
 } | {
-    query?: Partial<delete_line_itemSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: delete_line_itemSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Delete a Line Item
  *

package/dist/Endpoints/Lti/Courses/LineItems/list.d.ts

@@ -35,15 +35,17 @@ type Options = ({
     pathParams: listPathParameters;
 }) & ({
     query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List line Items
  *

package/dist/Endpoints/Lti/Courses/LineItems/show_line_item.d.ts

@@ -30,15 +30,17 @@ type Options = ({
     pathParams: show_line_itemPathParameters;
 }) & ({
     query?: Partial<show_line_itemSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<show_line_itemSearchParameters>;
     strict?: false;
+} | (({
+    query: show_line_itemSearchParameters;
 } | {
-    query?: Partial<show_line_itemSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: show_line_itemSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Show a Line Item
  *

package/dist/Endpoints/Lti/Courses/LineItems/update.d.ts

@@ -59,21 +59,25 @@ type Options = ({
     pathParams: updatePathParameters;
 }) & ({
     query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<updateSearchParameters>;
     body?: Partial<updateFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Update a Line Item
  *

package/dist/Endpoints/Lti/Courses/NamesAndRoles/list.d.ts

@@ -37,15 +37,17 @@ type Options = ({
     pathParams: listPathParameters;
 }) & ({
     query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List Course Memberships
  *

package/dist/Endpoints/Lti/Courses/Progress/query_progress.d.ts

@@ -22,15 +22,17 @@ type Options = ({
     pathParams: query_progressPathParameters;
 }) & ({
     query?: Partial<query_progressSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<query_progressSearchParameters>;
     strict?: false;
+} | (({
+    query: query_progressSearchParameters;
 } | {
-    query?: Partial<query_progressSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: query_progressSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Query progress
  *

package/dist/Endpoints/Lti/DeveloperKey/UpdatePublicJwk/update.d.ts

@@ -12,21 +12,25 @@ export type updateFormParameters = Masquerade & {
 };
 type Options = {
     query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<updateSearchParameters>;
     body?: Partial<updateFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
+} | (({
+    query: updateSearchParameters;
 } | {
-    query?: Partial<updateSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: updateSearchParameters;
-    body?: Partial<updateFormParameters>;
+}) & ({
+    body: updateFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-};
+});
 /**
  * Update Public JWK
  *

package/dist/Endpoints/Lti/Groups/NamesAndRoles/list.d.ts

@@ -39,15 +39,17 @@ type Options = ({
     pathParams: listPathParameters;
 }) & ({
     query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
-    query?: Partial<listSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List Group Memberships
  *

package/dist/Endpoints/Lti/Groups/Users/get.d.ts

@@ -16,15 +16,17 @@ type Options = ({
     pathParams: getPathParameters;
 }) & ({
     query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
+} | (({
+    query: getSearchParameters;
 } | {
-    query?: Partial<getSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get all users in a group (lti)
  *

package/dist/Endpoints/Lti/Notice-handlers/set_notice_handler.d.ts

@@ -30,21 +30,25 @@ type Options = ({
     pathParams: set_notice_handlerPathParameters;
 }) & ({
     query?: Partial<set_notice_handlerSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams?: Partial<set_notice_handlerSearchParameters>;
     body?: Partial<set_notice_handlerFormParameters>;
     /** @deprecated Use {@link Options.body} */
     params?: Partial<set_notice_handlerFormParameters>;
     strict?: false;
+} | (({
+    query: set_notice_handlerSearchParameters;
 } | {
-    query?: Partial<set_notice_handlerSearchParameters>;
-    /** @deprecated Use {Options.query} */
+    /** @deprecated Use {@link Options.query} */
     searchParams: set_notice_handlerSearchParameters;
-    body?: Partial<set_notice_handlerFormParameters>;
+}) & ({
+    body: set_notice_handlerFormParameters;
+} | {
     /** @deprecated Use {@link Options.body} */
     params: set_notice_handlerFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Set notice handler
  *