@groton/canvas-api 0.3.7 → 0.3.9

package/dist/Endpoints/V1/Accounts/Courses/create.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 createPathParameters = {
     /**
@@ -202,17 +202,32 @@ export type createFormParameters = Masquerade & {
      */
     enable_sis_reactivation: 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: createSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+}) & ({
+    body: createFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a new course
  *

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

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

package/dist/Endpoints/V1/Accounts/Courses/get.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 getPathParameters = {
     /**
@@ -42,15 +42,24 @@ export type getSearchParameters = Masquerade & Partial<{
      */
     teacher_limit: number | string;
 }>;
-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: getSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get a single course
  *

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

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

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

@@ -1,4 +1,4 @@
-import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Masquerade, Paginated } from '#client';
 import { Course } from '../../../../Resources/Courses.js';
 export type listPathParameters = {
     /**
@@ -145,15 +145,24 @@ export type listSearchParameters = Masquerade & Paginated & Partial<{
      */
     homeroom: boolean | string;
 }>;
-type Options = {
+type Options = ({
+    path: listPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: listPathParameters;
-} & ({
+}) & ({
+    query?: Partial<listSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List active courses in an account
  *

package/dist/Endpoints/V1/Accounts/Courses/list.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * List active courses in an account
  *

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

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Progress } from '../../../../Resources/CoursePace.js';
 export type updatePathParameters = {
     /**
@@ -31,17 +31,32 @@ export type updateFormParameters = Masquerade & {
      */
     event: 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: updateSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: updateSearchParameters;
+}) & ({
+    body: updateFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: updateFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Update courses
  *

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

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

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/BatchCreate/add_multiple_allowed_domains_to_account.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 add_multiple_allowed_domains_to_accountPathParameters = {
     /**
      * ID
@@ -17,17 +17,32 @@ export type add_multiple_allowed_domains_to_accountFormParameters = Masquerade &
      */
     domains: string[];
 };
-type Options = {
+type Options = ({
+    path: add_multiple_allowed_domains_to_accountPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: add_multiple_allowed_domains_to_accountPathParameters;
-} & ({
+}) & ({
+    query?: Partial<add_multiple_allowed_domains_to_accountSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<add_multiple_allowed_domains_to_accountSearchParameters>;
+    body?: Partial<add_multiple_allowed_domains_to_accountFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<add_multiple_allowed_domains_to_accountFormParameters>;
     strict?: false;
+} | (({
+    query: add_multiple_allowed_domains_to_accountSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: add_multiple_allowed_domains_to_accountSearchParameters;
+}) & ({
+    body: add_multiple_allowed_domains_to_accountFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: add_multiple_allowed_domains_to_accountFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Add multiple allowed domains to an account
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/BatchCreate/add_multiple_allowed_domains_to_account.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../../Client.js';
+import { client } from '#client';
 /**
  * Add multiple allowed domains to an account
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/add_allowed_domain_to_account.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 add_allowed_domain_to_accountPathParameters = {
     /**
      * ID
@@ -13,17 +13,32 @@ export type add_allowed_domain_to_accountFormParameters = Masquerade & {
     /** No description */
     domain: string;
 };
-type Options = {
+type Options = ({
+    path: add_allowed_domain_to_accountPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: add_allowed_domain_to_accountPathParameters;
-} & ({
+}) & ({
+    query?: Partial<add_allowed_domain_to_accountSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<add_allowed_domain_to_accountSearchParameters>;
+    body?: Partial<add_allowed_domain_to_accountFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<add_allowed_domain_to_accountFormParameters>;
     strict?: false;
+} | (({
+    query: add_allowed_domain_to_accountSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: add_allowed_domain_to_accountSearchParameters;
+}) & ({
+    body: add_allowed_domain_to_accountFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: add_allowed_domain_to_accountFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Add an allowed domain to account
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/add_allowed_domain_to_account.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Add an allowed domain to account
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/remove_domain_from_account.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 remove_domain_from_accountPathParameters = {
     /**
      * ID
@@ -12,15 +12,24 @@ export type remove_domain_from_accountSearchParameters = Masquerade & Partial<{
     /** No description */
     domain: string;
 }>;
-type Options = {
+type Options = ({
+    path: remove_domain_from_accountPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: remove_domain_from_accountPathParameters;
-} & ({
+}) & ({
+    query?: Partial<remove_domain_from_accountSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<remove_domain_from_accountSearchParameters>;
     strict?: false;
+} | (({
+    query: remove_domain_from_accountSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: remove_domain_from_accountSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Remove a domain from account
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Domains/remove_domain_from_account.js

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

package/dist/Endpoints/V1/Accounts/CspSettings/Lock/lock_or_unlock_current_csp_settings_for_sub_accounts_and_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 lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesPathParameters = {
     /**
      * ID
@@ -18,17 +18,32 @@ export type lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesForm
      */
     settings_locked: boolean | string;
 };
-type Options = {
+type Options = ({
+    path: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesPathParameters;
-} & ({
+}) & ({
+    query?: Partial<lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesSearchParameters>;
+    body?: Partial<lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesFormParameters>;
     strict?: false;
+} | (({
+    query: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesSearchParameters;
+}) & ({
+    body: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: lock_or_unlock_current_csp_settings_for_sub_accounts_and_coursesFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Lock or unlock current CSP settings for sub-accounts and courses
  *

package/dist/Endpoints/V1/Accounts/CspSettings/Lock/lock_or_unlock_current_csp_settings_for_sub_accounts_and_courses.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../../Client.js';
+import { client } from '#client';
 /**
  * Lock or unlock current CSP settings for sub-accounts and courses
  *

package/dist/Endpoints/V1/Accounts/CspSettings/enable_disable_or_clear_explicit_csp_setting_accounts.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 enable_disable_or_clear_explicit_csp_setting_accountsPathParameters = {
     /**
      * ID
@@ -21,17 +21,32 @@ export type enable_disable_or_clear_explicit_csp_setting_accountsFormParameters
      */
     status: string;
 };
-type Options = {
+type Options = ({
+    path: enable_disable_or_clear_explicit_csp_setting_accountsPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: enable_disable_or_clear_explicit_csp_setting_accountsPathParameters;
-} & ({
+}) & ({
+    query?: Partial<enable_disable_or_clear_explicit_csp_setting_accountsSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<enable_disable_or_clear_explicit_csp_setting_accountsSearchParameters>;
+    body?: Partial<enable_disable_or_clear_explicit_csp_setting_accountsFormParameters>;
+    /** @deprecated Use {@link Options.body} */
     params?: Partial<enable_disable_or_clear_explicit_csp_setting_accountsFormParameters>;
     strict?: false;
+} | (({
+    query: enable_disable_or_clear_explicit_csp_setting_accountsSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: enable_disable_or_clear_explicit_csp_setting_accountsSearchParameters;
+}) & ({
+    body: enable_disable_or_clear_explicit_csp_setting_accountsFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: enable_disable_or_clear_explicit_csp_setting_accountsFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Enable, disable, or clear explicit CSP setting
  *

package/dist/Endpoints/V1/Accounts/CspSettings/enable_disable_or_clear_explicit_csp_setting_accounts.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Enable, disable, or clear explicit CSP setting
  *

package/dist/Endpoints/V1/Accounts/CspSettings/get.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 getPathParameters = {
     /**
      * ID
@@ -9,15 +9,24 @@ export type getPathParameters = {
     account_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: getSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: getSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Get current settings for account or course
  *

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

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Get current settings for account or course
  *

package/dist/Endpoints/V1/Accounts/DeveloperKeys/DeveloperKeyAccountBindings/create.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { DeveloperKeyAccountBinding } from '../../../../../Resources/DeveloperKeyAccountBindings.js';
 export type createPathParameters = {
     /**
@@ -22,17 +22,32 @@ export type createFormParameters = Masquerade & {
      */
     workflow_state: 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: createSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+}) & ({
+    body: createFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a Developer Key Account Binding
  *

package/dist/Endpoints/V1/Accounts/DeveloperKeys/DeveloperKeyAccountBindings/create.js

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

package/dist/Endpoints/V1/Accounts/DeveloperKeys/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';
 import { DeveloperKey } from '../../../../Resources/DeveloperKeys.js';
 export type createPathParameters = {
     /**
@@ -72,17 +72,32 @@ export type createFormParameters = Masquerade & {
      */
     'developer_key[allow_includes]': 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: createSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: createSearchParameters;
+}) & ({
+    body: createFormParameters;
+} | {
+    /** @deprecated Use {@link Options.body} */
     params: createFormParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Create a Developer Key
  *

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

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

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

@@ -1,4 +1,4 @@
-import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Masquerade, Paginated } from '#client';
 import { DeveloperKey } from '../../../../Resources/DeveloperKeys.js';
 export type listPathParameters = {
     /**
@@ -17,15 +17,24 @@ export type listSearchParameters = Masquerade & Paginated & Partial<{
      */
     inherited: boolean | string;
 }>;
-type Options = {
+type Options = ({
+    path: listPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: listPathParameters;
-} & ({
+}) & ({
+    query?: Partial<listSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<listSearchParameters>;
     strict?: false;
+} | (({
+    query: listSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: listSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * List Developer Keys
  *

package/dist/Endpoints/V1/Accounts/DeveloperKeys/list.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * List Developer Keys
  *

package/dist/Endpoints/V1/Accounts/Enrollments/enrollment_by_id.d.ts

@@ -1,4 +1,4 @@
-import { Masquerade } from '@groton/canvas-api.client.base';
+import { Masquerade } from '#client';
 import { Enrollment } from '../../../../Resources/Enrollments.js';
 export type enrollment_by_idPathParameters = {
     /**
@@ -17,15 +17,24 @@ export type enrollment_by_idPathParameters = {
     id: number | string;
 };
 export type enrollment_by_idSearchParameters = Masquerade;
-type Options = {
+type Options = ({
+    path: enrollment_by_idPathParameters;
+} | {
+    /** @deprecated Use {@link Options.path} */
     pathParams: enrollment_by_idPathParameters;
-} & ({
+}) & ({
+    query?: Partial<enrollment_by_idSearchParameters>;
+    /** @deprecated Use {Options.query} */
     searchParams?: Partial<enrollment_by_idSearchParameters>;
     strict?: false;
+} | (({
+    query: enrollment_by_idSearchParameters;
 } | {
+    /** @deprecated Use {Options.query} */
     searchParams: enrollment_by_idSearchParameters;
+}) & {
     strict: true;
-});
+}));
 /**
  * Enrollment by ID
  *

package/dist/Endpoints/V1/Accounts/Enrollments/enrollment_by_id.js

@@ -1,4 +1,4 @@
-import { client } from '../../../../Client.js';
+import { client } from '#client';
 /**
  * Enrollment by ID
  *