@groton/canvas-api 0.3.3 → 0.3.5

package/CHANGELOG.md

@@ -2,26 +2,40 @@
 
 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.3](https://github.com/groton-school/canvas-cli/compare/api/0.3.2...api/0.3.3) (2025-09-02)
+## [0.3.5](https://github.com/groton-school/canvas-cli/compare/api/0.3.4...api/0.3.5) (2026-01-05)
+
+
+### Features
+
+* update Node target to active v24 ([5ecece1](https://github.com/groton-school/canvas-cli/commit/5ecece144945861343f008c0d9043ac631b08c34))
+* update overrides to handle API spec as of 2025-12-17 ([13219e8](https://github.com/groton-school/canvas-cli/commit/13219e8c8e941cef54b1da6b33fb0e222bd6b057))
 
 
 ### Bug Fixes
 
-* get_custom_colors now recognized as list() ([f5512ed](https://github.com/groton-school/canvas-cli/commit/f5512ed819958500b1bba28e05f9e3f6f972a78c))
+* download spec if not present ([71b4f4d](https://github.com/groton-school/canvas-cli/commit/71b4f4d1ce1f3cd75e1e73f99a4343e76dd747b1))
 
-## [0.3.2](https://github.com/groton-school/canvas-cli/compare/api/0.3.1...api/0.3.2) (2025-08-14)
+## [0.3.4](https://github.com/groton-school/canvas-cli/compare/api/0.3.3...api/0.3.4) (2025-09-02)
+
+Actually compiled dist
 
+## [0.3.3](https://github.com/groton-school/canvas-cli/compare/api/0.3.2...api/0.3.3) (2025-09-02)
 
 ### Bug Fixes
 
-* manually edited spec to make `*full_path` a path parameter ([8d21bde](https://github.com/groton-school/canvas-cli/commit/8d21bde17928492ee7c37cf222d1fc1ce5fe21f9))
+- get_custom_colors now recognized as list() ([f5512ed](https://github.com/groton-school/canvas-cli/commit/f5512ed819958500b1bba28e05f9e3f6f972a78c))
 
-## [0.3.1](https://github.com/groton-school/canvas-cli/compare/api/0.3.0...api/0.3.1) (2025-08-13)
+## [0.3.2](https://github.com/groton-school/canvas-cli/compare/api/0.3.1...api/0.3.2) (2025-08-14)
 
+### Bug Fixes
+
+- manually edited spec to make `*full_path` a path parameter ([8d21bde](https://github.com/groton-school/canvas-cli/commit/8d21bde17928492ee7c37cf222d1fc1ce5fe21f9))
+
+## [0.3.1](https://github.com/groton-school/canvas-cli/compare/api/0.3.0...api/0.3.1) (2025-08-13)
 
 ### Bug Fixes
 
-* use updated swagger-renderer for cleaner relative paths ([b2eded2](https://github.com/groton-school/canvas-cli/commit/b2eded21170633d7914376deda3312a17248e7b9))
+- use updated swagger-renderer for cleaner relative paths ([b2eded2](https://github.com/groton-school/canvas-cli/commit/b2eded21170633d7914376deda3312a17248e7b9))
 
 ## [0.3.0](https://github.com/groton-school/canvas-cli/compare/api/0.2.0...api/0.3.0) (2025-08-01)
 

package/README.md

@@ -6,18 +6,18 @@ Typed access to Canvas LMS API with embedded documentation
 
 ## Clients
 
-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 client for use:
+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 classes.
-- [@groton/canvas-api.client.node-cli](https://www.npmjs.com/package/@groton/canvas-api.client.node-cli) is a client for use in Node command-line apps, which takes advantage of the [@oauth2-cli/canvas](https://www.npmjs.com/package/@oauth2-cli/canvas) to handle authentication to a Canvas LMS instance from the command-line.
-- [@groton/canvas-api.client.qui-cli](https://www.npmjs.com/package/@groton/canvas-api.client.qui-clii) encapsulates the Node client in a [@battis/qui-cli.plugin](https://www.npmjs.com/package/@battis/qui-cli.plugin) for ease of use within that small ecosystme for rapidly developing Node command-line apps.
+- [@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.
+- [@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)).
 
 ## Install
 
 Using the Node client.
 
 ```sh
-npm install @groton/canvas-api @groton/canvas-api.client.node-cli
+npm install @groton/canvas-api @oauth2-cli/canvas
 ```
 
 ## Usage
@@ -26,17 +26,6 @@ Again, using the Node client. See [@groton/canvas-cli](https://www.npmjs.com/pac
 
 ```ts
 import * as Canvas from '@groton/canvas-api';
-import { Client } from '@groton/canvas-api.client.node-cli';
-
-// initialize the client from environment variables
-Canvas.init(
-  new Client({
-    instance_url: process.env.INSTANCE_URL,
-    client_id: process.env.CLIENT_ID,
-    client_secret: process.env.CLIENT_SECRET,
-    redirect_uri: process.env.REDIRECT_URI
-  })
-);
 
 // pull a paginated list of typed users from the API
 for (const user of await Canvas.v1.Accounts.Users.list({

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

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

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

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

package/dist/Endpoints/Lti/Subscriptions/create.d.ts

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

package/dist/Endpoints/Lti/Subscriptions/delete_webhook_subscription.d.ts

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

package/dist/Endpoints/Lti/Subscriptions/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;
 type Options = {
@@ -21,5 +22,5 @@ type Options = {
  *
  * Nickname: list_all_webhook_subscription_for_tool_proxy
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/Lti/Subscriptions/show_single_webhook_subscription.d.ts

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

package/dist/Endpoints/Lti/Subscriptions/update.d.ts

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

package/dist/Endpoints/Lti/UuidMap/download_uuid_mapping_for_this_sandbox.d.ts

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

package/dist/Endpoints/Quiz/V1/Courses/Quizzes/Items/MediaUploadUrl/get.d.ts

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

package/dist/Endpoints/Sis/Accounts/Assignments/retrieve_assignments_enabled_for_grade_export_to_sis_accounts.d.ts

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

package/dist/Endpoints/Sis/Courses/Assignments/retrieve_assignments_enabled_for_grade_export_to_sis_courses.d.ts

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

package/dist/Endpoints/Sis/Courses/DisablePostToSis/disable_assignments_currently_enabled_for_grade_export_to_sis.d.ts

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

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

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

package/dist/Endpoints/V1/Accounts/AccountNotifications/create.d.ts

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

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

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

package/dist/Endpoints/V1/Accounts/Analytics/Completed/Activity/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Completed/Grades/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_department_level_grade_data_completed
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Analytics/Completed/Statistics/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Completed/StatisticsBySubaccount/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Current/Activity/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Current/Grades/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_department_level_grade_data_current
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Accounts/Analytics/Current/Statistics/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Current/StatisticsBySubaccount/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Terms/Activity/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Terms/Grades/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Terms/Statistics/get.d.ts

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

package/dist/Endpoints/V1/Accounts/Analytics/Terms/StatisticsBySubaccount/get.d.ts

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

package/dist/Endpoints/V1/Accounts/AuthenticationProviders/delete_authentication_provider.d.ts

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

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

@@ -0,0 +1,32 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+};
+export type getSearchParameters = Masquerade;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get the brand config variables for a sub-account or course
+ *
+ * Will redirect to a static json file that has all of the brand variables used
+ * by the provided context. Even though this is a redirect, do not store the
+ * redirected url since if the sub-account makes any changes it will redirect to
+ * a new url.
+ *
+ * Nickname: get_brand_config_variables_for_sub_account_or_course_accounts
+ */
+export declare function get(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Accounts/BrandVariables/get.js

@@ -0,0 +1,18 @@
+import { client } from '../../../../Client.js';
+/**
+ * Get the brand config variables for a sub-account or course
+ *
+ * Will redirect to a static json file that has all of the brand variables used
+ * by the provided context. Even though this is a redirect, do not store the
+ * redirected url since if the sub-account makes any changes it will redirect to
+ * a new url.
+ *
+ * Nickname: get_brand_config_variables_for_sub_account_or_course_accounts
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/brand_variables`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

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

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

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

package/dist/Endpoints/V1/Accounts/BulkEnrollment/enroll_multiple_users_to_one_or_more_courses.d.ts

@@ -22,6 +22,11 @@ export type enroll_multiple_users_to_one_or_more_coursesFormParameters = Masquer
      * Format: 'int64'
      */
     course_ids: number | string[];
+    /**
+     * Enroll each user as a student, teacher, TA, observer, or designer. If no
+     * value is given, the type will be 'StudentEnrollment'.
+     */
+    enrollment_type: string;
 };
 type Options = {
     pathParams: enroll_multiple_users_to_one_or_more_coursesPathParameters;
@@ -37,6 +42,8 @@ type Options = {
 /**
  * Enroll multiple users to one or more courses
  *
+ * Enrolls multiple users in one or more courses in a single operation.
+ *
  * Nickname: enroll_multiple_users_to_one_or_more_courses
  */
 export declare function enroll_multiple_users_to_one_or_more_courses(options: Options): Promise<Progress>;

package/dist/Endpoints/V1/Accounts/BulkEnrollment/enroll_multiple_users_to_one_or_more_courses.js

@@ -2,6 +2,8 @@ import { client } from '../../../../Client.js';
 /**
  * Enroll multiple users to one or more courses
  *
+ * Enrolls multiple users in one or more courses in a single operation.
+ *
  * Nickname: enroll_multiple_users_to_one_or_more_courses
  */
 export async function enroll_multiple_users_to_one_or_more_courses(options) {

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/BatchCreate/add_multiple_allowed_domains_to_account.d.ts

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

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/add_allowed_domain_to_account.d.ts

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

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/remove_domain_from_account.d.ts

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

package/dist/Endpoints/V1/Accounts/CspSettings/Lock/lock_or_unlock_current_csp_settings_for_sub_accounts_and_courses.d.ts

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

package/dist/Endpoints/V1/Accounts/CspSettings/enable_disable_or_clear_explicit_csp_setting_accounts.d.ts

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

package/dist/Endpoints/V1/Accounts/CspSettings/get.d.ts

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