@groton/canvas-api 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.3.3](https://github.com/groton-school/canvas-cli/compare/api/0.3.2...api/0.3.3) (2025-09-02)
+
+
+### Bug Fixes
+
+* get_custom_colors now recognized as list() ([f5512ed](https://github.com/groton-school/canvas-cli/commit/f5512ed819958500b1bba28e05f9e3f6f972a78c))
+
+## [0.3.2](https://github.com/groton-school/canvas-cli/compare/api/0.3.1...api/0.3.2) (2025-08-14)
+
+
+### Bug Fixes
+
+* manually edited spec to make `*full_path` a path parameter ([8d21bde](https://github.com/groton-school/canvas-cli/commit/8d21bde17928492ee7c37cf222d1fc1ce5fe21f9))
+
 ## [0.3.1](https://github.com/groton-school/canvas-cli/compare/api/0.3.0...api/0.3.1) (2025-08-13)
 
 

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

@@ -16,17 +16,6 @@ export type updatePathParameters = {
 };
 export type updateSearchParameters = Masquerade;
 export type updateFormParameters = Masquerade & {
-    /** The assignment name. */
-    'assignment[name]': string;
-    /**
-     * The position of this assignment in the group when displaying assignment
-     * lists.
-     *
-     * Type: integer
-     *
-     * Format: 'int64'
-     */
-    'assignment[position]': number | string;
     /**
      * Only applies if the assignment doesn't have student submissions.
      *
@@ -44,6 +33,17 @@ export type updateFormParameters = Masquerade & {
      * valid when the Kaltura plugin is enabled) "student_annotation"
      */
     'assignment[submission_types]'?: ('online_quiz' | 'none' | 'on_paper' | 'discussion_topic' | 'external_tool' | 'online_upload' | 'online_text_entry' | 'online_url' | 'media_recording' | 'student_annotation')[];
+    /** The assignment name. */
+    'assignment[name]': string;
+    /**
+     * The position of this assignment in the group when displaying assignment
+     * lists.
+     *
+     * Type: integer
+     *
+     * Format: 'int64'
+     */
+    'assignment[position]': number | string;
     /**
      * Allowed extensions if submission_types includes "online_upload"
      *

package/dist/Endpoints/V1/Courses/Folders/ByPath/index.d.ts

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_courses.js';
+export * from './resolve_path_courses_full_path.js';

package/dist/Endpoints/V1/Courses/Folders/ByPath/index.js

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_courses.js';
+export * from './resolve_path_courses_full_path.js';

package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.d.ts

@@ -0,0 +1,36 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Folder } from '../../../../../Resources/Files.js';
+export type resolve_path_courses_full_pathPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    course_id: string | number;
+    /** Full path to folder */
+    full_path: string;
+};
+export type resolve_path_courses_full_pathSearchParameters = Masquerade & Paginated;
+type Options = {
+    pathParams: resolve_path_courses_full_pathPathParameters;
+} & ({
+    searchParams?: Partial<resolve_path_courses_full_pathSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: resolve_path_courses_full_pathSearchParameters;
+    strict: true;
+});
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_courses_full_path
+ */
+export declare function resolve_path_courses_full_path(options: Options): Promise<Folder[]>;
+export {};

package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.js

@@ -0,0 +1,20 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_courses_full_path
+ */
+export async function resolve_path_courses_full_path(options) {
+    const response = await client().fetchAs(`/api/v1/courses/{course_id}/folders/by_path/{full_path}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Courses/Quizzes/Submissions/Self/Files/upload.d.ts

@@ -22,15 +22,6 @@ export type uploadFormParameters = Masquerade & {
      * a sub-folder.
      */
     name: string;
-    /**
-     * How to handle duplicate filenames. If `overwrite`, then this file upload
-     * will overwrite any other file in the folder with the same name. If
-     * `rename`, then this file will be renamed if another file in the folder
-     * exists with the given name. If no parameter is given, the default is
-     * `overwrite`. This doesn't apply to file uploads in a context that doesn't
-     * have folders.
-     */
-    on_duplicate?: 'overwrite' | 'rename';
     /**
      * The size of the file, in bytes. This field is recommended, as it will let
      * you find out if there's a quota issue before uploading the raw file.
@@ -74,6 +65,15 @@ export type uploadFormParameters = Masquerade & {
      * @deprecated Use parent_folder_path instead.
      */
     folder?: string;
+    /**
+     * How to handle duplicate filenames. If `overwrite`, then this file upload
+     * will overwrite any other file in the folder with the same name. If
+     * `rename`, then this file will be renamed if another file in the folder
+     * exists with the given name. If no parameter is given, the default is
+     * `overwrite`. This doesn't apply to file uploads in a context that doesn't
+     * have folders.
+     */
+    on_duplicate?: 'overwrite' | 'rename';
     /**
      * An array of additional information to include in the upload success
      * response. See Files API for more information.

package/dist/Endpoints/V1/Groups/Folders/ByPath/index.d.ts

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_groups.js';
+export * from './resolve_path_groups_full_path.js';

package/dist/Endpoints/V1/Groups/Folders/ByPath/index.js

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_groups.js';
+export * from './resolve_path_groups_full_path.js';

package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.d.ts

@@ -0,0 +1,36 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Folder } from '../../../../../Resources/Files.js';
+export type resolve_path_groups_full_pathPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    group_id: string | number;
+    /** Full path to folder */
+    full_path: string;
+};
+export type resolve_path_groups_full_pathSearchParameters = Masquerade & Paginated;
+type Options = {
+    pathParams: resolve_path_groups_full_pathPathParameters;
+} & ({
+    searchParams?: Partial<resolve_path_groups_full_pathSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: resolve_path_groups_full_pathSearchParameters;
+    strict: true;
+});
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_groups_full_path
+ */
+export declare function resolve_path_groups_full_path(options: Options): Promise<Folder[]>;
+export {};

package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.js

@@ -0,0 +1,20 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_groups_full_path
+ */
+export async function resolve_path_groups_full_path(options) {
+    const response = await client().fetchAs(`/api/v1/groups/{group_id}/folders/by_path/{full_path}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Colors/index.d.ts

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

package/dist/Endpoints/V1/Users/Colors/index.js

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

package/dist/Endpoints/V1/Users/Colors/list.d.ts

@@ -0,0 +1,28 @@
+import { Masquerade } from '@groton/canvas-api.client.base';
+export type listPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    id: string | number;
+};
+export type listSearchParameters = Masquerade;
+type Options = {
+    pathParams: listPathParameters;
+} & ({
+    searchParams?: Partial<listSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: listSearchParameters;
+    strict: true;
+});
+/**
+ * Get custom colors
+ *
+ * Returns all custom colors that have been saved for a user.
+ *
+ * Nickname: get_custom_colors
+ */
+export declare function list(options: Options): Promise<void>;
+export {};

package/dist/Endpoints/V1/Users/Colors/list.js

@@ -0,0 +1,15 @@
+import { client } from '../../../../Client.js';
+/**
+ * Get custom colors
+ *
+ * Returns all custom colors that have been saved for a user.
+ *
+ * Nickname: get_custom_colors
+ */
+export async function list(options) {
+    const response = await client().fetchAs(`/api/v1/users/{id}/colors`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/dist/Endpoints/V1/Users/Folders/ByPath/index.d.ts

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_users.js';
+export * from './resolve_path_users_full_path.js';

package/dist/Endpoints/V1/Users/Folders/ByPath/index.js

@@ -1,2 +1,2 @@
-export * as FullPath from './*fullPath/index.js';
 export * from './resolve_path_users.js';
+export * from './resolve_path_users_full_path.js';

package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.d.ts

@@ -0,0 +1,36 @@
+import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
+import { Folder } from '../../../../../Resources/Files.js';
+export type resolve_path_users_full_pathPathParameters = {
+    /**
+     * ID
+     *
+     * Type: string
+     */
+    user_id: string | number;
+    /** Full path to folder */
+    full_path: string;
+};
+export type resolve_path_users_full_pathSearchParameters = Masquerade & Paginated;
+type Options = {
+    pathParams: resolve_path_users_full_pathPathParameters;
+} & ({
+    searchParams?: Partial<resolve_path_users_full_pathSearchParameters>;
+    strict?: false;
+} | {
+    searchParams: resolve_path_users_full_pathSearchParameters;
+    strict: true;
+});
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_users_full_path
+ */
+export declare function resolve_path_users_full_path(options: Options): Promise<Folder[]>;
+export {};

package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.js

@@ -0,0 +1,20 @@
+import { client } from '../../../../../Client.js';
+/**
+ * Resolve path
+ *
+ * Given the full path to a folder, returns a list of all Folders in the path
+ * hierarchy, starting at the root folder, and ending at the requested folder.
+ * The given path is relative to the context's root folder and does not include
+ * the root folder's name (e.g., "course files"). If an empty path is given, the
+ * context's root folder alone is returned. Otherwise, if no folder exists with
+ * the given full path, a Not Found error is returned.
+ *
+ * Nickname: resolve_path_users_full_path
+ */
+export async function resolve_path_users_full_path(options) {
+    const response = await client().fetchAs(`/api/v1/users/{user_id}/folders/by_path/{full_path}`, {
+        method: 'GET',
+        ...options
+    });
+    return response;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@groton/canvas-api",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Typed access to Canvas LMS API with embedded documentation",
   "homepage": "https://github.com/groton-school/canvas-cli/tree/main/packages/api/canvas-api#readme",
   "repository": {
@@ -28,7 +28,7 @@
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
     "typescript": "~5.8.3",
-    "@groton/canvas-api.swagger-renderer": "0.1.1"
+    "@groton/canvas-api.swagger-renderer": "0.1.2"
   },
   "scripts": {
     "clean": "run-s clean:*",