@groton/canvas-api 0.3.4 → 0.3.5

package/dist/Endpoints/V1/Accounts/GradingStandards/update.js

@@ -0,0 +1,19 @@
+import { client } from '../../../../Client.js';
+/**
+ * Update a grading standard
+ *
+ * Updates the grading standard with the given id
+ *
+ * If the grading standard has been used for grading, only the title can be
+ * updated. The data, points_based, and scaling_factor cannot be modified once
+ * the grading standard has been used to grade assignments.
+ *
+ * Nickname: update_grading_standard_accounts
+ */
+export async function update(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

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

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

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

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

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

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

package/dist/Endpoints/V1/Accounts/LtiApps/LaunchDefinitions/list.d.ts

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

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

@@ -0,0 +1,39 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type getSearchParameters = Masquerade & Paginated;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get LTI Registration History
+ *
+ * Returns the history entries for the specified LTI registration. This endpoint
+ * provides comprehensive change tracking for all fields associated with the
+ * registration, including registration fields, developer key changes, internal
+ * configuration changes, and overlay changes. Supports pagination using the
+ * `page` and `per_page` parameters. The default page size is 10.
+ *
+ * Nickname: get_lti_registration_history
+ */
+export declare function get(options: Options): Promise<JSONValue[]>;
+export {};

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

@@ -0,0 +1,19 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Get LTI Registration History
+ *
+ * Returns the history entries for the specified LTI registration. This endpoint
+ * provides comprehensive change tracking for all fields associated with the
+ * registration, including registration fields, developer key changes, internal
+ * configuration changes, and overlay changes. Supports pagination using the
+ * `page` and `per_page` parameters. The default page size is 10.
+ *
+ * Nickname: get_lti_registration_history
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/lti_registrations/{id}/history`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

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

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

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

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

@@ -0,0 +1,45 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { LtiOverlayVersion } from '../../../../../Resources/LtiRegistrations.js';
+export type getPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type getSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * The maximum number of history items to return. Defaults to 10. Maximum
+     * allowed is 100.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    limit: number | string;
+}>;
+type Options = {
+    pathParams: getPathParameters;
+} & ({
+    searchParams?: Partial<getSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: getSearchParameters;
+    strict: true;
+});
+/**
+ * Get LTI Registration Overlay History
+ *
+ * Returns the overlay history items for the specified LTI registration.
+ *
+ * Nickname: get_lti_registration_overlay_history
+ */
+export declare function get(options: Options): Promise<LtiOverlayVersion[]>;
+export {};

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

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Get LTI Registration Overlay History
+ *
+ * Returns the overlay history items for the specified LTI registration.
+ *
+ * Nickname: get_lti_registration_overlay_history
+ */
+export async function get(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/lti_registrations/{id}/overlay_history`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

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

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

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

package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/Apply/apply_lti_registration_update_requst.d.ts

@@ -0,0 +1,63 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { LtiConfigurationOverlay } from '../../../../../../Overrides.js';
+import { LtiRegistration } from '../../../../../../Resources/LtiRegistrations.js';
+export type apply_lti_registration_update_requstPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * The id of the registration to update.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    id: number | string;
+    /**
+     * The id of the registration update request to apply.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    update_request_id: number | string;
+};
+export type apply_lti_registration_update_requstSearchParameters = Masquerade;
+export type apply_lti_registration_update_requstFormParameters = Masquerade & {
+    /**
+     * Whether to accept (true) or reject (false) the registration update
+     * request.
+     *
+     * Type: boolean
+     */
+    accepted: boolean | string;
+    /** Optional overlay data to apply on top of the new configuration. */
+    overlay: LtiConfigurationOverlay;
+    /** Optional comment explaining the reason for applying this update. */
+    comment: string;
+};
+type Options = {
+    pathParams: apply_lti_registration_update_requstPathParameters;
+} & ({
+    searchParams?: Partial<apply_lti_registration_update_requstSearchParameters>;
+    params?: Partial<apply_lti_registration_update_requstFormParameters>;
+    strict?: false;
+} | {
+    searchParams: apply_lti_registration_update_requstSearchParameters;
+    params: apply_lti_registration_update_requstFormParameters;
+    strict: true;
+});
+/**
+ * Apply LTI Registration Update Requst
+ *
+ * Applies a registration update request to an existing registration, replacing
+ * the existing configuration and overlay with the new values. If the request is
+ * rejected, marks it as rejected without applying changes.
+ *
+ * Nickname: apply_lti_registration_update_requst
+ */
+export declare function apply_lti_registration_update_requst(options: Options): Promise<LtiRegistration>;
+export {};

package/dist/Endpoints/V1/Accounts/LtiRegistrations/UpdateRequests/Apply/apply_lti_registration_update_requst.js

@@ -0,0 +1,17 @@
+import { client } from '../../../../../../Client.js';
+/**
+ * Apply LTI Registration Update Requst
+ *
+ * Applies a registration update request to an existing registration, replacing
+ * the existing configuration and overlay with the new values. If the request is
+ * rejected, marks it as rejected without applying changes.
+ *
+ * Nickname: apply_lti_registration_update_requst
+ */
+export async function apply_lti_registration_update_requst(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}/apply`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

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

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

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

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

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

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

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

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

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

@@ -2,7 +2,10 @@ export * as Bind from './Bind/index.js';
 export * from './create.js';
 export * from './delete_lti_registration.js';
 export * as Deployments from './Deployments/index.js';
+export * as History from './History/index.js';
 export * from './list.js';
+export * as OverlayHistory from './OverlayHistory/index.js';
 export * as Reset from './Reset/index.js';
 export * from './show_lti_registration.js';
 export * from './update.js';
+export * as UpdateRequests from './UpdateRequests/index.js';

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

@@ -2,7 +2,10 @@ export * as Bind from './Bind/index.js';
 export * from './create.js';
 export * from './delete_lti_registration.js';
 export * as Deployments from './Deployments/index.js';
+export * as History from './History/index.js';
 export * from './list.js';
+export * as OverlayHistory from './OverlayHistory/index.js';
 export * as Reset from './Reset/index.js';
 export * from './show_lti_registration.js';
 export * from './update.js';
+export * as UpdateRequests from './UpdateRequests/index.js';

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

@@ -40,6 +40,11 @@ export type updateFormParameters = Masquerade & {
      * valid for Site Admin registrations.
      */
     workflow_state: string;
+    /**
+     * A comment explaining why this change was made. Cannot exceed 2000
+     * characters.
+     */
+    comment: string;
 };
 type Options = {
     pathParams: updatePathParameters;

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

@@ -32,6 +32,8 @@ type Options = {
 /**
  * Get all outcome links for context
  *
+ * Returns a list of all outcome links in the specified context.
+ *
  * Nickname: get_all_outcome_links_for_context_accounts
  */
 export declare function get(options: Options): Promise<OutcomeLink[]>;

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

@@ -2,6 +2,8 @@ import { client } from '../../../../Client.js';
 /**
  * Get all outcome links for context
  *
+ * Returns a list of all outcome links in the specified context.
+ *
  * Nickname: get_all_outcome_links_for_context_accounts
  */
 export async function get(options) {

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

@@ -21,6 +21,8 @@ type Options = {
 /**
  * Get all outcome groups for context
  *
+ * Returns a list of all outcome groups in the specified context.
+ *
  * Nickname: get_all_outcome_groups_for_context_accounts
  */
 export declare function get(options: Options): Promise<OutcomeGroup[]>;

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

@@ -2,6 +2,8 @@ import { client } from '../../../../Client.js';
 /**
  * Get all outcome groups for context
  *
+ * Returns a list of all outcome groups in the specified context.
+ *
  * Nickname: get_all_outcome_groups_for_context_accounts
  */
 export async function get(options) {

package/dist/Endpoints/V1/Accounts/OutcomeGroups/show_outcome_group_accounts.d.ts

@@ -27,6 +27,8 @@ type Options = {
 /**
  * Show an outcome group
  *
+ * Returns detailed information about a specific outcome group.
+ *
  * Nickname: show_outcome_group_accounts
  */
 export declare function show_outcome_group_accounts(options: Options): Promise<OutcomeGroup>;

package/dist/Endpoints/V1/Accounts/OutcomeGroups/show_outcome_group_accounts.js

@@ -2,6 +2,8 @@ import { client } from '../../../../Client.js';
 /**
  * Show an outcome group
  *
+ * Returns detailed information about a specific outcome group.
+ *
  * Nickname: show_outcome_group_accounts
  */
 export async function show_outcome_group_accounts(options) {

package/dist/Endpoints/V1/Accounts/Permissions/permissions.d.ts

@@ -1,3 +1,4 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
 export type permissionsPathParameters = {
     /**
@@ -10,8 +11,9 @@ export type permissionsPathParameters = {
 export type permissionsSearchParameters = Masquerade & Partial<{
     /**
      * List of permissions to check against the authenticated user. Permission
-     * names are documented in the {api:RoleOverridesController#add_role Create
-     * a role} endpoint.
+     * names are documented in the
+     * {api:RoleOverridesController#manageable_permissions List assignable
+     * permissions} endpoint.
      */
     permissions: string[];
 }>;
@@ -37,5 +39,5 @@ type Options = {
  *
  * Nickname: permissions
  */
-export declare function permissions(options: Options): Promise<void>;
+export declare function permissions(options: Options): Promise<JSONValue>;
 export {};

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

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

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

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

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

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

package/dist/Endpoints/V1/Accounts/Roles/Permissions/list.d.ts

@@ -0,0 +1,42 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Permission } from '../../../../../Resources/Roles.js';
+export type listPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+};
+export type listSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * If provided, return only permissions whose key, label, group, or
+     * group_label match the search string.
+     */
+    search_term: string;
+}>;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * List assignable permissions
+ *
+ * List all permissions that can be granted to roles in the given account.
+ *
+ * This returns largely the same information documented on the
+ * {file:file.permissions.html Permissions list page}, with a few caveats:
+ * Permission labels and group labels returned by this API are localized (the
+ * same text visible in the web UI). This API includes permissions added by
+ * plugins. This API excludes permissions that are disabled in or otherwise do
+ * not apply to the given account.
+ *
+ * Nickname: list_assignable_permissions
+ */
+export declare function list(options: Options): Promise<Permission[]>;
+export {};

package/dist/Endpoints/V1/Accounts/Roles/Permissions/list.js

@@ -0,0 +1,22 @@
+import { client } from '../../../../../Client.js';
+/**
+ * List assignable permissions
+ *
+ * List all permissions that can be granted to roles in the given account.
+ *
+ * This returns largely the same information documented on the
+ * {file:file.permissions.html Permissions list page}, with a few caveats:
+ * Permission labels and group labels returned by this API are localized (the
+ * same text visible in the web UI). This API includes permissions added by
+ * plugins. This API excludes permissions that are disabled in or otherwise do
+ * not apply to the given account.
+ *
+ * Nickname: list_assignable_permissions
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/roles/permissions`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

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

@@ -36,104 +36,8 @@ export type createFormParameters = Masquerade & {
      * Ignored if permission <X> is locked upstream (in an ancestor account).
      *
      * May occur multiple times with unique values for <X>. Recognized
-     * permission names for <X> are:
-     *
-     * [For Account-Level Roles Only] become_user -- Users - act as import_sis
-     * -- SIS Data - import manage_account_memberships -- Admins - add / remove
-     * manage_account_settings -- Account-level settings - manage manage_alerts
-     * -- Global announcements - add / edit / delete manage_catalog -- Catalog -
-     * manage Manage Course Templates granular permissions add_course_template
-     * -- Course Templates - add delete_course_template -- Course Templates -
-     * delete edit_course_template -- Course Templates - edit manage_courses_add
-     * -- Courses - add manage_courses_admin -- Courses - manage / update
-     * manage_developer_keys -- Developer keys - manage manage_feature_flags --
-     * Feature Options - enable / disable manage_master_courses -- Blueprint
-     * Courses - add / edit / associate / delete manage_role_overrides --
-     * Permissions - manage manage_storage_quotas -- Storage Quotas - manage
-     * manage_sis -- SIS data - manage Manage Temporary Enrollments granular
-     * permissions temporary_enrollments_add -- Temporary Enrollments - add
-     * temporary_enrollments_edit -- Temporary Enrollments - edit
-     * temporary_enrollments_delete -- Temporary Enrollments - delete
-     * manage_user_logins -- Users - manage login details manage_user_observers
-     * -- Users - manage observers manage_users_in_bulk -- Bulk actions - People
-     * page moderate_user_content -- Users - moderate content
-     * read_course_content -- Course Content - view read_course_list -- Courses
-     * - view list view_course_changes -- Courses - view change logs
-     * view_feature_flags -- Feature Options - view view_grade_changes -- Grades
-     * - view change logs view_notifications -- Notifications - view
-     * view_quiz_answer_audits -- Quizzes - view submission log view_statistics
-     * -- Statistics - view undelete_courses -- Courses - undelete
-     *
-     * [For both Account-Level and Course-Level roles] Note: Applicable
-     * enrollment types for course-level roles are given in brackets: S =
-     * student, T = teacher (instructor), A = TA, D = designer, O = observer.
-     * Lower-case letters indicate permissions that are off by default. A
-     * missing letter indicates the permission cannot be enabled for the role or
-     * any derived custom roles. allow_course_admin_actions -- [ Tad ] Users -
-     * allow administrative actions in courses create_collaborations -- [STADo]
-     * Student Collaborations - create create_conferences -- [STADo] Web
-     * conferences - create create_forum -- [STADo] Discussions - create
-     * generate_observer_pairing_code -- [ tado] Users - Generate observer
-     * pairing codes for students import_outcomes -- [ TaDo] Learning Outcomes -
-     * import manage_account_banks -- [ td ] Item Banks - manage account
-     * share_banks_with_subaccounts -- [ tad ] Item Banks - share with
-     * subaccounts Manage Assignments and Quizzes granular permissions
-     * manage_assignments_add -- [ TADo] Assignments and Quizzes - add
-     * manage_assignments_edit -- [ TADo] Assignments and Quizzes - edit /
-     * manage manage_assignments_delete -- [ TADo] Assignments and Quizzes -
-     * delete manage_calendar -- [sTADo] Course Calendar - add / edit / delete
-     * Manage Course Content granular permissions manage_course_content_add -- [
-     * TADo] Course Content - add manage_course_content_edit -- [ TADo] Course
-     * Content - edit manage_course_content_delete -- [ TADo] Course Content -
-     * delete manage_course_visibility -- [ TAD ] Course - change visibility
-     * Manage Courses granular permissions manage_courses_conclude -- [ TaD ]
-     * Courses - conclude manage_courses_delete -- [ TaD ] Courses - delete
-     * manage_courses_publish -- [ TaD ] Courses - publish manage_courses_reset
-     * -- [ TaD ] Courses - reset Manage Files granular permissions
-     * manage_files_add -- [ TADo] Course Files - add manage_files_edit -- [
-     * TADo] Course Files - edit manage_files_delete -- [ TADo] Course Files -
-     * delete manage_grades -- [ TA ] Grades - edit Manage Groups granular
-     * permissions manage_groups_add -- [ TAD ] Groups - add
-     * manage_groups_delete -- [ TAD ] Groups - delete manage_groups_manage -- [
-     * TAD ] Groups - manage manage_interaction_alerts -- [ Ta ] Alerts - add /
-     * edit / delete manage_outcomes -- [sTaDo] Learning Outcomes - add / edit /
-     * delete manage_proficiency_calculations -- [ t d ] Outcome Proficiency
-     * Calculations - add / edit / delete manage_proficiency_scales -- [ t d ]
-     * Outcome Proficiency/Mastery Scales - add / edit / delete Manage Sections
-     * granular permissions manage_sections_add -- [ TaD ] Course Sections - add
-     * manage_sections_edit -- [ TaD ] Course Sections - edit
-     * manage_sections_delete -- [ TaD ] Course Sections - delete
-     * manage_students -- [ TAD ] Users - manage students in courses
-     * manage_rubrics -- [ TAD ] Rubrics - add / edit / delete Manage Pages
-     * granular permissions manage_wiki_create -- [ TADo] Pages - create
-     * manage_wiki_delete -- [ TADo] Pages - delete manage_wiki_update -- [
-     * TADo] Pages - update moderate_forum -- [sTADo] Discussions - moderate
-     * post_to_forum -- [STADo] Discussions - post read_announcements -- [STADO]
-     * Announcements - view read_email_addresses -- [sTAdo] Users - view primary
-     * email address read_forum -- [STADO] Discussions - view
-     * read_question_banks -- [ TADo] Question banks - view and link
-     * read_reports -- [ TAD ] Reports - manage read_roster -- [STADo] Users -
-     * view list read_sis -- [sTa ] SIS Data - read select_final_grade -- [ TA ]
-     * Grades - select final grade for moderation send_messages -- [STADo]
-     * Conversations - send messages to individual course members
-     * send_messages_all -- [sTADo] Conversations - send messages to entire
-     * class Users - Teacher granular permissions add_teacher_to_course -- [ Tad
-     * ] Add a teacher enrollment to a course remove_teacher_from_course -- [
-     * Tad ] Remove a Teacher enrollment from a course Users - TA granular
-     * permissions add_ta_to_course -- [ Tad ] Add a TA enrollment to a course
-     * remove_ta_from_course -- [ Tad ] Remove a TA enrollment from a course
-     * Users - Designer granular permissions add_designer_to_course -- [ Tad ]
-     * Add a designer enrollment to a course remove_designer_from_course -- [
-     * Tad ] Remove a designer enrollment from a course Users - Observer
-     * granular permissions add_observer_to_course -- [ Tad ] Add an observer
-     * enrollment to a course remove_observer_from_course -- [ Tad ] Remove an
-     * observer enrollment from a course Users - Student granular permissions
-     * add_student_to_course -- [ Tad ] Add a student enrollment to a course
-     * remove_student_from_course -- [ Tad ] Remove a student enrollment from a
-     * course view_all_grades -- [ TAd ] Grades - view all grades view_analytics
-     * -- [sTA ] Analytics - view pages view_audit_trail -- [ t ] Grades - view
-     * audit trail view_group_pages -- [sTADo] Groups - view all student groups
-     * view_user_logins -- [ TA ] Users - view login IDs
+     * permission names for <X> can be found on the {file:file.permissions.html
+     * Permissions list page}.
      *
      * Some of these permissions are applicable only for roles on the site admin
      * account, on a root account, or for course-level roles with a particular

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

@@ -3,4 +3,5 @@ export * from './create.js';
 export * from './deactivate_role.js';
 export * from './get.js';
 export * from './list.js';
+export * as Permissions from './Permissions/index.js';
 export * from './update.js';

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

@@ -3,4 +3,5 @@ export * from './create.js';
 export * from './deactivate_role.js';
 export * from './get.js';
 export * from './list.js';
+export * as Permissions from './Permissions/index.js';
 export * from './update.js';

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

@@ -29,7 +29,9 @@ export type updateFormParameters = Masquerade & {
     'permissions[<X>][explicit]': boolean | string;
     /**
      * These arguments are described in the documentation for the
-     * {api:RoleOverridesController#add_role add_role method}.
+     * {api:RoleOverridesController#add_role add_role method}. The list of
+     * available permissions can be found on the {file:file.permissions.html
+     * Permissions list page}.
      *
      * Type: boolean
      */