@groton/canvas-api 0.3.3 → 0.3.5

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 {};

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;
+}