@groton/canvas-api 0.3.7 → 0.3.8

package/dist/Endpoints/V1/Courses/Reports/start_report.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Hash } from '../../../../Overrides.js';
 import { Report } from '../../../../Resources/AccountReports.js';
 export type start_reportPathParameters = {
@@ -29,14 +29,25 @@ export type start_reportFormParameters = Masquerade & {
      */
     'parameters[section_ids]': number | string[];
 };
-type Options = {
+type Options = ({
+    path: start_reportPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: start_reportPathParameters;
-} & ({
+}) & ({
+    query?: Partial<start_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<start_reportSearchParameters>;
+    body?: Partial<start_reportFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<start_reportFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<start_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: start_reportSearchParameters;
+    body?: Partial<start_reportFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: start_reportFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Reports/start_report.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Start a Report
  *

package/dist/Endpoints/V1/Courses/Reports/status_of_last_report.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Report } from '../../../../Resources/AccountReports.js';
 export type status_of_last_reportPathParameters = {
     /**
@@ -11,12 +11,19 @@ export type status_of_last_reportPathParameters = {
     report_type: string;
 };
 export type status_of_last_reportSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: status_of_last_reportPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: status_of_last_reportPathParameters;
-} & ({
+}) & ({
+    query?: Partial<status_of_last_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<status_of_last_reportSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<status_of_last_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: status_of_last_reportSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Reports/status_of_last_report.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Status of last Report
  *

package/dist/Endpoints/V1/Courses/Reports/status_of_report.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Report } from '../../../../Resources/AccountReports.js';
 export type status_of_reportPathParameters = {
     /**
@@ -17,12 +17,19 @@ export type status_of_reportPathParameters = {
     id: string | number;
 };
 export type status_of_reportSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: status_of_reportPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: status_of_reportPathParameters;
-} & ({
+}) & ({
+    query?: Partial<status_of_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<status_of_reportSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<status_of_reportSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: status_of_reportSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Reports/status_of_report.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Status of a Report
  *

package/dist/Endpoints/V1/Courses/ResetContent/reset_course.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Course } from '../../../../Resources/Courses.js';
 export type reset_coursePathParameters = {
     /**
@@ -9,12 +9,19 @@ export type reset_coursePathParameters = {
     course_id: string | number;
 };
 export type reset_courseSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: reset_coursePathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: reset_coursePathParameters;
-} & ({
+}) & ({
+    query?: Partial<reset_courseSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<reset_courseSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<reset_courseSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: reset_courseSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/ResetContent/reset_course.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Reset a course
  *

package/dist/Endpoints/V1/Courses/Restore/restore_course_version.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Course } from '../../../../Resources/Courses.js';
 export type restore_course_versionPathParameters = {
     /**
@@ -18,12 +18,19 @@ export type restore_course_versionPathParameters = {
     version_id: number | string;
 };
 export type restore_course_versionSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: restore_course_versionPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: restore_course_versionPathParameters;
-} & ({
+}) & ({
+    query?: Partial<restore_course_versionSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<restore_course_versionSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<restore_course_versionSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: restore_course_versionSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Restore/restore_course_version.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Restore course version
  *

package/dist/Endpoints/V1/Courses/RootOutcomeGroup/redirect_to_root_outcome_group_for_context_courses.d.ts

@@ -1,5 +1,5 @@
+import { Masquerade } from '#client';
 import { JSONValue } from '@battis/typescript-tricks';
-import { Masquerade } from '@groton/canvas-api.client.base';
 export type redirect_to_root_outcome_group_for_context_coursesPathParameters = {
     /**
      * ID
@@ -9,12 +9,19 @@ export type redirect_to_root_outcome_group_for_context_coursesPathParameters = {
     course_id: string | number;
 };
 export type redirect_to_root_outcome_group_for_context_coursesSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: redirect_to_root_outcome_group_for_context_coursesPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: redirect_to_root_outcome_group_for_context_coursesPathParameters;
-} & ({
+}) & ({
+    query?: Partial<redirect_to_root_outcome_group_for_context_coursesSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<redirect_to_root_outcome_group_for_context_coursesSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<redirect_to_root_outcome_group_for_context_coursesSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: redirect_to_root_outcome_group_for_context_coursesSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RootOutcomeGroup/redirect_to_root_outcome_group_for_context_courses.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Redirect to root outcome group for context
  *

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/create.d.ts

@@ -1,5 +1,5 @@
+import { Masquerade } from '#client';
 import { JSONObject, JSONValue } from '@battis/typescript-tricks';
-import { Masquerade } from '@groton/canvas-api.client.base';
 export type createPathParameters = {
     /**
      * The id of the course
@@ -52,14 +52,25 @@ export type createFormParameters = Masquerade & {
      */
     rubric_assessment: JSONObject;
 };
-type Options = {
+type Options = ({
+    path: createPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: createPathParameters;
-} & ({
+}) & ({
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<createSearchParameters>;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/create.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Create a single rubric assessment
  *

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/delete_single_rubric_assessment.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { RubricAssessment } from '../../../../../Resources/Rubrics.js';
 export type delete_single_rubric_assessmentPathParameters = {
     /**
@@ -21,12 +21,19 @@ export type delete_single_rubric_assessmentPathParameters = {
     id: string | number;
 };
 export type delete_single_rubric_assessmentSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: delete_single_rubric_assessmentPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: delete_single_rubric_assessmentPathParameters;
-} & ({
+}) & ({
+    query?: Partial<delete_single_rubric_assessmentSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_single_rubric_assessmentSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<delete_single_rubric_assessmentSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: delete_single_rubric_assessmentSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/delete_single_rubric_assessment.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Delete a single rubric assessment
  *

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/update.d.ts

@@ -1,5 +1,5 @@
+import { Masquerade } from '#client';
 import { JSONObject, JSONValue } from '@battis/typescript-tricks';
-import { Masquerade } from '@groton/canvas-api.client.base';
 export type updatePathParameters = {
     /**
      * The id of the rubric assessment
@@ -60,14 +60,25 @@ export type updateFormParameters = Masquerade & {
      */
     rubric_assessment: JSONObject;
 };
-type Options = {
+type Options = ({
+    path: updatePathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: updatePathParameters;
-} & ({
+}) & ({
+    query?: Partial<updateSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<updateSearchParameters>;
+    body?: Partial<updateFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<updateSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
+    body?: Partial<updateFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/RubricAssessments/update.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Update a single rubric assessment
  *

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

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { RubricAssociation } from '../../../../Resources/Rubrics.js';
 export type createPathParameters = {
     /**
@@ -56,14 +56,25 @@ export type createFormParameters = Masquerade & {
      */
     'rubric_association[bookmarked]': boolean | string;
 };
-type Options = {
+type Options = ({
+    path: createPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: createPathParameters;
-} & ({
+}) & ({
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<createSearchParameters>;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/create.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Create a RubricAssociation
  *

package/dist/Endpoints/V1/Courses/RubricAssociations/delete_rubricassociation.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { RubricAssociation } from '../../../../Resources/Rubrics.js';
 export type delete_rubricassociationPathParameters = {
     /**
@@ -15,12 +15,19 @@ export type delete_rubricassociationPathParameters = {
     id: string | number;
 };
 export type delete_rubricassociationSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: delete_rubricassociationPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: delete_rubricassociationPathParameters;
-} & ({
+}) & ({
+    query?: Partial<delete_rubricassociationSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_rubricassociationSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<delete_rubricassociationSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: delete_rubricassociationSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/delete_rubricassociation.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Delete a RubricAssociation
  *

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

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { RubricAssociation } from '../../../../Resources/Rubrics.js';
 export type updatePathParameters = {
     /**
@@ -64,14 +64,25 @@ export type updateFormParameters = Masquerade & {
      */
     'rubric_association[bookmarked]': boolean | string;
 };
-type Options = {
+type Options = ({
+    path: updatePathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: updatePathParameters;
-} & ({
+}) & ({
+    query?: Partial<updateSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<updateSearchParameters>;
+    body?: Partial<updateFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<updateFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<updateSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
+    body?: Partial<updateFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/RubricAssociations/update.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Update a RubricAssociation
  *

package/dist/Endpoints/V1/Courses/Rubrics/Upload/creates_rubric_using_csv_file_courses.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 export type creates_rubric_using_csv_file_coursesPathParameters = {
     /**
      * ID
@@ -8,12 +8,19 @@ export type creates_rubric_using_csv_file_coursesPathParameters = {
     course_id: string | number;
 };
 export type creates_rubric_using_csv_file_coursesSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: creates_rubric_using_csv_file_coursesPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: creates_rubric_using_csv_file_coursesPathParameters;
-} & ({
+}) & ({
+    query?: Partial<creates_rubric_using_csv_file_coursesSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<creates_rubric_using_csv_file_coursesSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<creates_rubric_using_csv_file_coursesSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: creates_rubric_using_csv_file_coursesSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Rubrics/Upload/creates_rubric_using_csv_file_courses.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Creates a rubric using a CSV file
  *

package/dist/Endpoints/V1/Courses/Rubrics/Upload/get.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 export type getPathParameters = {
     /**
      * ID
@@ -14,12 +14,19 @@ export type getPathParameters = {
     id: string | number;
 };
 export type getSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: getPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: getPathParameters;
-} & ({
+}) & ({
+    query?: Partial<getSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<getSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Rubrics/Upload/get.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Get the status of a rubric import
  *

package/dist/Endpoints/V1/Courses/Rubrics/UsedLocations/get.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 export type getPathParameters = {
     /**
      * ID
@@ -14,12 +14,19 @@ export type getPathParameters = {
     id: string | number;
 };
 export type getSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: getPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: getPathParameters;
-} & ({
+}) & ({
+    query?: Partial<getSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<getSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<getSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Rubrics/UsedLocations/get.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Get the courses and assignments for a rubric
  *

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

@@ -1,5 +1,5 @@
+import { Masquerade } from '#client';
 import { JSONObject, JSONValue } from '@battis/typescript-tricks';
-import { Masquerade } from '@groton/canvas-api.client.base';
 export type createPathParameters = {
     /**
      * ID
@@ -75,14 +75,25 @@ export type createFormParameters = Masquerade & {
      */
     'rubric[criteria]': JSONObject;
 };
-type Options = {
+type Options = ({
+    path: createPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: createPathParameters;
-} & ({
+}) & ({
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<createSearchParameters>;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<createFormParameters>;
     strict?: false;
 } | {
+    query?: Partial<createSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+    body?: Partial<createFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Rubrics/create.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Create a single rubric
  *

package/dist/Endpoints/V1/Courses/Rubrics/delete_single.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Rubric } from '../../../../Resources/Rubrics.js';
 export type delete_singlePathParameters = {
     /**
@@ -15,12 +15,19 @@ export type delete_singlePathParameters = {
     id: string | number;
 };
 export type delete_singleSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: delete_singlePathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: delete_singlePathParameters;
-} & ({
+}) & ({
+    query?: Partial<delete_singleSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<delete_singleSearchParameters>;
     strict?: false;
 } | {
+    query?: Partial<delete_singleSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams: delete_singleSearchParameters;
     strict: true;
 });

package/dist/Endpoints/V1/Courses/Rubrics/delete_single.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Delete a single
  *