@groton/canvas-api 0.3.4 → 0.3.5

package/dist/Endpoints/V1/Accounts/ExternalTools/RceFavorites/unmark_tool_as_rce_favorite.d.ts

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

package/dist/Endpoints/V1/Accounts/ExternalTools/SessionlessLaunch/get.d.ts

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

package/dist/Endpoints/V1/Accounts/ExternalTools/TopNavFavorites/add_tool_to_top_navigation_favorites.d.ts

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

package/dist/Endpoints/V1/Accounts/ExternalTools/TopNavFavorites/remove_tool_from_top_navigation_favorites.d.ts

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

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

@@ -1,4 +1,6 @@
+import { JSONValue } from '@battis/typescript-tricks';
 import { Masquerade } from '@groton/canvas-api.client.base';
+import { ContextExternalTool } from '../../../../Resources/ExternalTools.js';
 export type createPathParameters = {
     /**
      * ID
@@ -54,205 +56,29 @@ export type createFormParameters = Masquerade & {
      * Type: boolean
      */
     is_rce_favorite: boolean | string;
-    /** The url of the external tool for account navigation */
-    'account_navigation[url]': string;
     /**
-     * Set this to enable this feature
+     * Set the <placement_configuration_key> value for a specific placement.
      *
-     * Type: boolean
-     */
-    'account_navigation[enabled]': boolean | string;
-    /** The text that will show on the left-tab in the account navigation */
-    'account_navigation[text]': string;
-    /** The width of the dialog the tool is launched in */
-    'account_navigation[selection_width]': string;
-    /** The height of the dialog the tool is launched in */
-    'account_navigation[selection_height]': string;
-    /**
-     * The layout type to use when launching the tool. Must be "full_width",
-     * "full_width_in_context", "full_width_with_nav", "in_nav_context",
-     * "borderless", or "default"
-     */
-    'account_navigation[display_type]': string;
-    /** The url of the external tool for user navigation */
-    'user_navigation[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'user_navigation[enabled]': boolean | string;
-    /** The text that will show on the left-tab in the user navigation */
-    'user_navigation[text]': string;
-    /**
-     * Who will see the navigation tab. "admins" for admins, "public" or
-     * "members" for everyone. Setting this to `null` will remove this
-     * configuration and use the default behavior, which is "public".
-     */
-    'user_navigation[visibility]': string;
-    /** The url of the external tool for right-side course home navigation menu */
-    'course_home_sub_navigation[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'course_home_sub_navigation[enabled]': boolean | string;
-    /** The text that will show on the right-side course home navigation menu */
-    'course_home_sub_navigation[text]': string;
-    /** The url of the icon to show in the right-side course home navigation menu */
-    'course_home_sub_navigation[icon_url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'course_navigation[enabled]': boolean | string;
-    /** The text that will show on the left-tab in the course navigation */
-    'course_navigation[text]': string;
-    /**
-     * Who will see the navigation tab. "admins" for course admins, "members"
-     * for students, "public" for everyone. Setting this to `null` will remove
-     * this configuration and use the default behavior, which is "public".
-     */
-    'course_navigation[visibility]': string;
-    /**
-     * Determines how the navigation tab will be opened. "_blank" Launches the
-     * external tool in a new window or tab. "_self" (Default) Launches the
-     * external tool in an iframe inside of Canvas.
-     */
-    'course_navigation[windowTarget]': string;
-    /**
-     * If set to "disabled" the tool will not appear in the course navigation
-     * until a teacher explicitly enables it.
-     *
-     * If set to "enabled" the tool will appear in the course navigation without
-     * requiring a teacher to explicitly enable it.
-     *
-     * Defaults to "enabled"
-     */
-    'course_navigation[default]': string;
-    /**
-     * The layout type to use when launching the tool. Must be "full_width",
-     * "full_width_in_context", "full_width_with_nav", "in_nav_context",
-     * "borderless", or "default"
-     */
-    'course_navigation[display_type]': string;
-    /** The url of the external tool */
-    'editor_button[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'editor_button[enabled]': boolean | string;
-    /** The url of the icon to show in the WYSIWYG editor */
-    'editor_button[icon_url]': string;
-    /** The width of the dialog the tool is launched in */
-    'editor_button[selection_width]': string;
-    /** The height of the dialog the tool is launched in */
-    'editor_button[selection_height]': string;
-    /**
-     * Set this to ContentItemSelectionRequest to tell the tool to use
-     * content-item; otherwise, omit
+     * Variable
      */
-    'editor_button[message_type]': string;
-    /** The url of the external tool */
-    'homework_submission[url]': string;
+    '<placement_name>[<placement_configuration_key>]': JSONValue;
     /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'homework_submission[enabled]': boolean | string;
-    /** The text that will show on the homework submission tab */
-    'homework_submission[text]': string;
-    /**
-     * Set this to ContentItemSelectionRequest to tell the tool to use
-     * content-item; otherwise, omit
-     */
-    'homework_submission[message_type]': string;
-    /** The url of the external tool */
-    'link_selection[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'link_selection[enabled]': boolean | string;
-    /** The text that will show for the link selection text */
-    'link_selection[text]': string;
-    /**
-     * Set this to ContentItemSelectionRequest to tell the tool to use
-     * content-item; otherwise, omit
-     */
-    'link_selection[message_type]': string;
-    /** The url of the external tool */
-    'migration_selection[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'migration_selection[enabled]': boolean | string;
-    /**
-     * Set this to ContentItemSelectionRequest to tell the tool to use
-     * content-item; otherwise, omit
-     */
-    'migration_selection[message_type]': string;
-    /** The url of the external tool */
-    'tool_configuration[url]': string;
-    /**
-     * Set this to enable this feature
-     *
-     * Type: boolean
-     */
-    'tool_configuration[enabled]': boolean | string;
-    /**
-     * Set this to ContentItemSelectionRequest to tell the tool to use
-     * content-item; otherwise, omit
-     */
-    'tool_configuration[message_type]': string;
-    /**
-     * Set this to default the lis_person_contact_email_primary to prefer
-     * provisioned sis_email; otherwise, omit
-     *
-     * Type: boolean
-     */
-    'tool_configuration[prefer_sis_email]': boolean | string;
-    /** The url of the external tool */
-    'resource_selection[url]': string;
-    /**
-     * Set this to enable this feature. If set to false, not_selectable must
-     * also be set to true in order to hide this tool from the selection UI in
-     * modules and assignments.
-     *
-     * Type: boolean
-     */
-    'resource_selection[enabled]': boolean | string;
-    /** The url of the icon to show in the module external tool list */
-    'resource_selection[icon_url]': string;
-    /** The width of the dialog the tool is launched in */
-    'resource_selection[selection_width]': string;
-    /** The height of the dialog the tool is launched in */
-    'resource_selection[selection_height]': string;
-    /**
-     * Configuration can be passed in as CC xml instead of using query
-     * parameters. If this value is "by_url" or "by_xml" then an xml
+     * Configuration can be passed in as Common Cartridge XML instead of using
+     * query parameters. If this value is "by_url" or "by_xml" then an XML
      * configuration will be expected in either the "config_xml" or "config_url"
      * parameter. Note that the name parameter overrides the tool name provided
-     * in the xml
+     * in the XML.
      */
     config_type: string;
     /**
-     * XML tool configuration, as specified in the CC xml specification. This is
-     * required if "config_type" is set to "by_xml"
+     * XML tool configuration, as specified in the Common Cartridge XML
+     * specification. This is required if "config_type" is set to "by_xml"
      */
     config_xml: string;
     /**
      * URL where the server can retrieve an XML tool configuration, as specified
-     * in the CC xml specification. This is required if "config_type" is set to
-     * "by_url"
+     * in the Common Cartridge XML specification. This is required if
+     * "config_type" is set to "by_url"
      */
     config_url: string;
     /**
@@ -292,7 +118,11 @@ type Options = {
  * supplied canvas will attempt to create a context external tool using the LTI
  * 1.3 standard.
  *
+ * See the <a href="file.lti_dev_key_config.html#placements-params">Placements
+ * Documentation</a> for more information on what placements are available, the
+ * possible fields, and their accepted values.
+ *
  * Nickname: create_external_tool_accounts
  */
-export declare function create(options: Options): Promise<void>;
+export declare function create(options: Options): Promise<ContextExternalTool>;
 export {};

package/dist/Endpoints/V1/Accounts/ExternalTools/create.js

@@ -7,6 +7,10 @@ import { client } from '../../../../Client.js';
  * supplied canvas will attempt to create a context external tool using the LTI
  * 1.3 standard.
  *
+ * See the <a href="file.lti_dev_key_config.html#placements-params">Placements
+ * Documentation</a> for more information on what placements are available, the
+ * possible fields, and their accepted values.
+ *
  * Nickname: create_external_tool_accounts
  */
 export async function create(options) {

package/dist/Endpoints/V1/Accounts/ExternalTools/delete_external_tool_accounts.d.ts

@@ -1,4 +1,5 @@
 import { Masquerade } from '@groton/canvas-api.client.base';
+import { ContextExternalTool } from '../../../../Resources/ExternalTools.js';
 export type delete_external_tool_accountsPathParameters = {
     /**
      * ID
@@ -30,5 +31,5 @@ type Options = {
  *
  * Nickname: delete_external_tool_accounts
  */
-export declare function delete_external_tool_accounts(options: Options): Promise<void>;
+export declare function delete_external_tool_accounts(options: Options): Promise<ContextExternalTool>;
 export {};

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

@@ -1,4 +1,5 @@
 import { Masquerade } from '@groton/canvas-api.client.base';
+import { ContextExternalTool } from '../../../../Resources/ExternalTools.js';
 export type getPathParameters = {
     /**
      * ID
@@ -30,5 +31,5 @@ type Options = {
  *
  * Nickname: get_single_external_tool_accounts
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<ContextExternalTool>;
 export {};

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

@@ -1,4 +1,5 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { ContextExternalTool } from '../../../../Resources/ExternalTools.js';
 export type listPathParameters = {
     /**
      * ID
@@ -7,7 +8,7 @@ export type listPathParameters = {
      */
     account_id: string | number;
 };
-export type listSearchParameters = Masquerade & Partial<{
+export type listSearchParameters = Masquerade & Paginated & Partial<{
     /** The partial name of the tools to match and return. */
     search_term: string;
     /**
@@ -23,7 +24,13 @@ export type listSearchParameters = Masquerade & Partial<{
      * Type: boolean
      */
     include_parents: boolean | string;
-    /** The placement type to filter by. */
+    /**
+     * The placement type to filter by.
+     *
+     * Return all tools at the current context as well as all tools from the
+     * parent, and filter the tools list to only those with a placement of
+     * 'editor_button'
+     */
     placement: string;
 }>;
 type Options = {
@@ -44,5 +51,5 @@ type Options = {
  *
  * Nickname: list_external_tools_accounts
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<ContextExternalTool[]>;
 export {};

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

@@ -1,4 +1,5 @@
 import { Masquerade } from '@groton/canvas-api.client.base';
+import { ContextExternalTool } from '../../../../Resources/ExternalTools.js';
 export type updatePathParameters = {
     /**
      * ID
@@ -26,9 +27,15 @@ type Options = {
 /**
  * Edit an external tool
  *
- * Update the specified external tool. Uses same parameters as create
+ * Update the specified external tool. Uses same parameters as create. Returns
+ * the updated tool.
+ *
+ * NOTE: Any updates made to LTI 1.3 tools with this API will be overridden if
+ * any changes are made to the tool's associated LTI Registration/Developer Key
+ * configuration. In almost all cases, changes should be made to the tool's
+ * associated LTI Registration configuration, not individual tools.
  *
  * Nickname: edit_external_tool_accounts
  */
-export declare function update(options: Options): Promise<void>;
+export declare function update(options: Options): Promise<ContextExternalTool>;
 export {};

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

@@ -2,7 +2,13 @@ import { client } from '../../../../Client.js';
 /**
  * Edit an external tool
  *
- * Update the specified external tool. Uses same parameters as create
+ * Update the specified external tool. Uses same parameters as create. Returns
+ * the updated tool.
+ *
+ * NOTE: Any updates made to LTI 1.3 tools with this API will be overridden if
+ * any changes are made to the tool's associated LTI Registration/Developer Key
+ * configuration. In almost all cases, changes should be made to the tool's
+ * associated LTI Registration configuration, not individual tools.
  *
  * Nickname: edit_external_tool_accounts
  */

package/dist/Endpoints/V1/Accounts/Features/Enabled/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_enabled_features_accounts
  */
-export declare function list(options: Options): Promise<void>;
+export declare function list(options: Options): Promise<JSONValue>;
 export {};

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

@@ -8,7 +8,15 @@ export type listPathParameters = {
      */
     account_id: string | number;
 };
-export type listSearchParameters = Masquerade & Paginated;
+export type listSearchParameters = Masquerade & Paginated & Partial<{
+    /**
+     * When true, feature flags that are enabled in a higher context and cannot
+     * be overridden will be omitted.
+     *
+     * Type: boolean
+     */
+    hide_inherited_enabled: boolean | string;
+}>;
 type Options = {
     pathParams: listPathParameters;
 } & ({

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

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

package/dist/Endpoints/V1/Accounts/GradingPeriodSets/delete_grading_period_set.d.ts

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

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

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

package/dist/Endpoints/V1/Accounts/GradingPeriodSets/update_grading_period_set.d.ts

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

package/dist/Endpoints/V1/Accounts/GradingPeriods/delete_grading_period_accounts.d.ts

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

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

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

package/dist/Endpoints/V1/Accounts/GradingStandards/delete_grading_standard_accounts.d.ts

@@ -0,0 +1,35 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { GradingStandard } from '../../../../Resources/GradingStandards.js';
+export type delete_grading_standard_accountsPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    grading_standard_id: string | number;
+};
+export type delete_grading_standard_accountsSearchParameters = Masquerade;
+type Options = {
+    pathParams: delete_grading_standard_accountsPathParameters;
+} & ({
+    searchParams?: Partial<delete_grading_standard_accountsSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: delete_grading_standard_accountsSearchParameters;
+    strict: true;
+});
+/**
+ * Delete a grading standard
+ *
+ * Deletes the grading standard with the given id
+ *
+ * Nickname: delete_grading_standard_accounts
+ */
+export declare function delete_grading_standard_accounts(options: Options): Promise<GradingStandard>;
+export {};

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

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Delete a grading standard
+ *
+ * Deletes the grading standard with the given id
+ *
+ * Nickname: delete_grading_standard_accounts
+ */
+export async function delete_grading_standard_accounts(options) {
+    const response = await client().fetchAs(`/api/v1/accounts/{account_id}/grading_standards/{grading_standard_id}`, {
+        method: 'DELETE',
+        ...options
+    });
+    return response;
+}

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

@@ -1,3 +1,5 @@
 export * from './create.js';
+export * from './delete_grading_standard_accounts.js';
 export * from './get.js';
 export * from './list.js';
+export * from './update.js';

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

@@ -1,3 +1,5 @@
 export * from './create.js';
+export * from './delete_grading_standard_accounts.js';
 export * from './get.js';
 export * from './list.js';
+export * from './update.js';

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

@@ -0,0 +1,77 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { GradingStandard } from '../../../../Resources/GradingStandards.js';
+export type updatePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    account_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    grading_standard_id: string | number;
+};
+export type updateSearchParameters = Masquerade;
+export type updateFormParameters = Masquerade & {
+    /** The title for the Grading Standard */
+    title: string;
+    /**
+     * Whether or not a grading scheme is points based. Defaults to false.
+     *
+     * Type: boolean
+     */
+    points_based: boolean | string;
+    /**
+     * The factor by which to scale a percentage into a points based scheme
+     * grade. This is the maximum number of points possible in the grading
+     * scheme. Defaults to 1. Not required for percentage based grading
+     * schemes.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    scaling_factor: number | string;
+    /**
+     * The name for an entry value within a GradingStandard that describes the
+     * range of the value e.g. A-
+     */
+    'grading_scheme_entry[name]': string[];
+    /**
+     * The value for the name of the entry within a GradingStandard. The entry
+     * represents the lower bound of the range for the entry. This range
+     * includes the value up to the next entry in the GradingStandard, or 100 if
+     * there is no upper bound. The lowest value will have a lower bound range
+     * of 0. e.g. 93
+     *
+     * Format: 'int64'
+     */
+    'grading_scheme_entry[value]': number | string[];
+};
+type Options = {
+    pathParams: updatePathParameters;
+} & ({
+    searchParams?: Partial<updateSearchParameters>;
+    params?: Partial<updateFormParameters>;
+    strict?: false;
+} | {
+    searchParams: updateSearchParameters;
+    params: updateFormParameters;
+    strict: true;
+});
+/**
+ * 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 declare function update(options: Options): Promise<GradingStandard>;
+export {};