@groton/canvas-api 0.3.4 → 0.3.5

package/dist/Endpoints/V1/Courses/GradingPeriods/update.d.ts

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

package/dist/Endpoints/V1/Courses/GradingStandards/delete_grading_standard_courses.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_coursesPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    grading_standard_id: string | number;
+};
+export type delete_grading_standard_coursesSearchParameters = Masquerade;
+type Options = {
+    pathParams: delete_grading_standard_coursesPathParameters;
+} & ({
+    searchParams?: Partial<delete_grading_standard_coursesSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: delete_grading_standard_coursesSearchParameters;
+    strict: true;
+});
+/**
+ * Delete a grading standard
+ *
+ * Deletes the grading standard with the given id
+ *
+ * Nickname: delete_grading_standard_courses
+ */
+export declare function delete_grading_standard_courses(options: Options): Promise<GradingStandard>;
+export {};

package/dist/Endpoints/V1/Courses/GradingStandards/delete_grading_standard_courses.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_courses
+ */
+export async function delete_grading_standard_courses(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/grading_standards/{grading_standard_id}`, {
+        method: 'DELETE',
+        ...options
+    });
+    return response;
+}

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

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

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

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

package/dist/Endpoints/V1/Courses/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
+     */
+    course_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_courses
+ */
+export declare function update(options: Options): Promise<GradingStandard>;
+export {};

package/dist/Endpoints/V1/Courses/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_courses
+ */
+export async function update(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/grading_standards/{grading_standard_id}`, {
+        method: 'PUT',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/GroupCategories/ExportTags/export_tags_and_users_in_course.d.ts

@@ -0,0 +1,29 @@
+import { JSONValue } from '@battis/typescript-tricks';
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type export_tags_and_users_in_coursePathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+};
+export type export_tags_and_users_in_courseSearchParameters = Masquerade;
+type Options = {
+    pathParams: export_tags_and_users_in_coursePathParameters;
+} & ({
+    searchParams?: Partial<export_tags_and_users_in_courseSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: export_tags_and_users_in_courseSearchParameters;
+    strict: true;
+});
+/**
+ * Export tags and users in course
+ *
+ * Returns a csv file of users in format ready to import.
+ *
+ * Nickname: export_tags_and_users_in_course
+ */
+export declare function export_tags_and_users_in_course(options: Options): Promise<JSONValue>;
+export {};

package/dist/Endpoints/V1/Courses/GroupCategories/ExportTags/export_tags_and_users_in_course.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Export tags and users in course
+ *
+ * Returns a csv file of users in format ready to import.
+ *
+ * Nickname: export_tags_and_users_in_course
+ */
+export async function export_tags_and_users_in_course(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/group_categories/export_tags`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/GroupCategories/ExportTags/index.d.ts

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

package/dist/Endpoints/V1/Courses/GroupCategories/ExportTags/index.js

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

package/dist/Endpoints/V1/Courses/GroupCategories/ImportTags/import_differentiation_tags.d.ts

@@ -0,0 +1,57 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+import { Progress } from '../../../../../Resources/CoursePace.js';
+export type import_differentiation_tagsPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+};
+export type import_differentiation_tagsSearchParameters = Masquerade;
+export type import_differentiation_tagsFormParameters = Masquerade & {
+    /**
+     * There are two ways to post differentiation tag import data - either via a
+     * multipart/form-data form-field-style attachment, or via a non-multipart
+     * raw post request.
+     *
+     * 'attachment' is required for multipart/form-data style posts. Assumed to
+     * be tag data from a file upload form field named 'attachment'.
+     *
+     * Examples: curl -F attachment=@<filename> -H "Authorization: Bearer
+     * <token>"\
+     * 'https://<canvas>/api/v1/group_categories/import_tags'
+     *
+     * If you decide to do a raw post, you can skip the 'attachment' argument,
+     * but you will then be required to provide a suitable Content-Type header.
+     * You are encouraged to also provide the 'extension' argument.
+     *
+     * Examples: curl -H 'Content-Type: text/csv' --data-binary @<filename>.csv\
+     * -H "Authorization: Bearer <token>"\
+     * 'https://<canvas>/api/v1/group_categories_tags'
+     */
+    attachment: string;
+};
+type Options = {
+    pathParams: import_differentiation_tagsPathParameters;
+} & ({
+    searchParams?: Partial<import_differentiation_tagsSearchParameters>;
+    params?: Partial<import_differentiation_tagsFormParameters>;
+    strict?: false;
+} | {
+    searchParams: import_differentiation_tagsSearchParameters;
+    params: import_differentiation_tagsFormParameters;
+    strict: true;
+});
+/**
+ * Import differentiation tags
+ *
+ * Create Differentiation Tags through a CSV import
+ *
+ * For more information on the format that's expected here, please see the
+ * "Differentiation Tag CSV" section in the API docs.
+ *
+ * Nickname: import_differentiation_tags
+ */
+export declare function import_differentiation_tags(options: Options): Promise<Progress>;
+export {};

package/dist/Endpoints/V1/Courses/GroupCategories/ImportTags/import_differentiation_tags.js

@@ -0,0 +1,18 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Import differentiation tags
+ *
+ * Create Differentiation Tags through a CSV import
+ *
+ * For more information on the format that's expected here, please see the
+ * "Differentiation Tag CSV" section in the API docs.
+ *
+ * Nickname: import_differentiation_tags
+ */
+export async function import_differentiation_tags(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/group_categories/import_tags`, {
+        method: 'POST',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/GroupCategories/ImportTags/index.d.ts

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

package/dist/Endpoints/V1/Courses/GroupCategories/ImportTags/index.js

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

package/dist/Endpoints/V1/Courses/GroupCategories/index.d.ts

@@ -1,3 +1,5 @@
 export * as BulkManageDifferentiationTag from './BulkManageDifferentiationTag/index.js';
 export * from './create.js';
+export * as ExportTags from './ExportTags/index.js';
+export * as ImportTags from './ImportTags/index.js';
 export * from './list.js';

package/dist/Endpoints/V1/Courses/GroupCategories/index.js

@@ -1,3 +1,5 @@
 export * as BulkManageDifferentiationTag from './BulkManageDifferentiationTag/index.js';
 export * from './create.js';
+export * as ExportTags from './ExportTags/index.js';
+export * as ImportTags from './ImportTags/index.js';
 export * from './list.js';

package/dist/Endpoints/V1/Courses/LatePolicy/create.d.ts

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

package/dist/Endpoints/V1/Courses/LatePolicy/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_late_policy
  */
-export declare function get(options: Options): Promise<void>;
+export declare function get(options: Options): Promise<JSONValue>;
 export {};

package/dist/Endpoints/V1/Courses/LatePolicy/patch_late_policy.d.ts

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

package/dist/Endpoints/V1/Courses/LiveAssessments/Results/create.d.ts

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

package/dist/Endpoints/V1/Courses/LiveAssessments/Results/list.d.ts

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

package/dist/Endpoints/V1/Courses/LiveAssessments/create.d.ts

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

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

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

package/dist/Endpoints/V1/Courses/Modules/AssignmentOverrides/update.d.ts

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

package/dist/Endpoints/V1/Courses/Modules/DateDetails/get.d.ts

@@ -14,7 +14,16 @@ export type getPathParameters = {
      */
     context_module_id: string | number;
 };
-export type getSearchParameters = Masquerade;
+export type getSearchParameters = Masquerade & Partial<{
+    /**
+     * If true, includes peer review sub assignment information and overrides in
+     * the response. Requires the peer_review_grading feature flag to be
+     * enabled.
+     *
+     * Type: boolean
+     */
+    include_peer_review: boolean | string;
+}>;
 type Options = {
     pathParams: getPathParameters;
 } & ({

package/dist/Endpoints/V1/Courses/Modules/Items/Done/mark_module_item_as_done_not_done.d.ts

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

package/dist/Endpoints/V1/Courses/Modules/Items/MarkRead/mark_module_item_read.d.ts

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

package/dist/Endpoints/V1/Courses/Modules/Items/SelectMasteryPath/select_mastery_path.d.ts

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

package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.d.ts

@@ -32,6 +32,9 @@ type Options = {
 /**
  * Get aligned assignments for an outcome in a course for a particular student
  *
+ * Returns all assignments aligned to a specific outcome for a student in a
+ * course.
+ *
  * Nickname:
  * get_aligned_assignments_for_outcome_in_course_for_particular_student
  */

package/dist/Endpoints/V1/Courses/OutcomeAlignments/get.js

@@ -2,6 +2,9 @@ import { client } from '../../../../Client.js';
 /**
  * Get aligned assignments for an outcome in a course for a particular student
  *
+ * Returns all assignments aligned to a specific outcome for a student in a
+ * course.
+ *
  * Nickname:
  * get_aligned_assignments_for_outcome_in_course_for_particular_student
  */

package/dist/Endpoints/V1/Courses/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_courses
  */
 export declare function get(options: Options): Promise<OutcomeLink[]>;

package/dist/Endpoints/V1/Courses/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_courses
  */
 export async function get(options) {

package/dist/Endpoints/V1/Courses/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_courses
  */
 export declare function get(options: Options): Promise<OutcomeGroup[]>;

package/dist/Endpoints/V1/Courses/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_courses
  */
 export async function get(options) {

package/dist/Endpoints/V1/Courses/OutcomeGroups/show_outcome_group_courses.d.ts

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

package/dist/Endpoints/V1/Courses/OutcomeGroups/show_outcome_group_courses.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_courses
  */
 export async function show_outcome_group_courses(options) {

package/dist/Endpoints/V1/Courses/OutcomeResults/get.d.ts

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

package/dist/Endpoints/V1/Courses/OutcomeRollups/get.d.ts

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

package/dist/Endpoints/V1/Courses/Pages/DateDetails/get.d.ts

@@ -14,7 +14,16 @@ export type getPathParameters = {
      */
     url_or_id: string | number;
 };
-export type getSearchParameters = Masquerade;
+export type getSearchParameters = Masquerade & Partial<{
+    /**
+     * If true, includes peer review sub assignment information and overrides in
+     * the response. Requires the peer_review_grading feature flag to be
+     * enabled.
+     *
+     * Type: boolean
+     */
+    include_peer_review: boolean | string;
+}>;
 type Options = {
     pathParams: getPathParameters;
 } & ({

package/dist/Endpoints/V1/Courses/Pages/DateDetails/update.d.ts

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