@groton/canvas-api 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.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/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/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/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.2",
   "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": {