@groton/canvas-api 0.3.5 → 0.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/Endpoints/V1/Courses/Folders/ByPath/index.d.ts +1 -1
- package/dist/Endpoints/V1/Courses/Folders/ByPath/index.js +1 -1
- package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.d.ts +39 -0
- package/dist/Endpoints/V1/Courses/Folders/ByPath/resolve_path_courses_full_path.js +20 -0
- package/dist/Endpoints/V1/Groups/Folders/ByPath/index.d.ts +1 -1
- package/dist/Endpoints/V1/Groups/Folders/ByPath/index.js +1 -1
- package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.d.ts +39 -0
- package/dist/Endpoints/V1/Groups/Folders/ByPath/resolve_path_groups_full_path.js +20 -0
- package/dist/Endpoints/V1/Users/Folders/ByPath/index.d.ts +1 -1
- package/dist/Endpoints/V1/Users/Folders/ByPath/index.js +1 -1
- package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.d.ts +39 -0
- package/dist/Endpoints/V1/Users/Folders/ByPath/resolve_path_users_full_path.js +20 -0
- package/package.json +2 -2
- package/var/render.log +1075 -1075
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
+
## [0.3.6](https://github.com/groton-school/canvas-cli/compare/api/0.3.5...api/0.3.6) (2026-01-13)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* convert *full_path wildcard to regular path param ([f0f8b20](https://github.com/groton-school/canvas-cli/commit/f0f8b2079e0d35a5250994777c109d1b344a0be9))
|
|
11
|
+
|
|
5
12
|
## [0.3.5](https://github.com/groton-school/canvas-cli/compare/api/0.3.4...api/0.3.5) (2026-01-05)
|
|
6
13
|
|
|
7
14
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
|
|
2
|
+
import { Folder } from '../../../../../Resources/Files.js';
|
|
3
|
+
export type resolve_path_courses_full_pathPathParameters = {
|
|
4
|
+
/**
|
|
5
|
+
* ID
|
|
6
|
+
*
|
|
7
|
+
* Type: string
|
|
8
|
+
*/
|
|
9
|
+
course_id: string | number;
|
|
10
|
+
/**
|
|
11
|
+
* Identified by @groton/canvas-api.swagger-renderer from the endpoint path:
|
|
12
|
+
* /v1/courses/{course_id}/folders/by_path/*full_path
|
|
13
|
+
*/
|
|
14
|
+
full_path: string;
|
|
15
|
+
};
|
|
16
|
+
export type resolve_path_courses_full_pathSearchParameters = Masquerade & Paginated;
|
|
17
|
+
type Options = {
|
|
18
|
+
pathParams: resolve_path_courses_full_pathPathParameters;
|
|
19
|
+
} & ({
|
|
20
|
+
searchParams?: Partial<resolve_path_courses_full_pathSearchParameters>;
|
|
21
|
+
strict?: false;
|
|
22
|
+
} | {
|
|
23
|
+
searchParams: resolve_path_courses_full_pathSearchParameters;
|
|
24
|
+
strict: true;
|
|
25
|
+
});
|
|
26
|
+
/**
|
|
27
|
+
* Resolve path
|
|
28
|
+
*
|
|
29
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
30
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
31
|
+
* The given path is relative to the context's root folder and does not include
|
|
32
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
33
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
34
|
+
* the given full path, a Not Found error is returned.
|
|
35
|
+
*
|
|
36
|
+
* Nickname: resolve_path_courses_full_path
|
|
37
|
+
*/
|
|
38
|
+
export declare function resolve_path_courses_full_path(options: Options): Promise<Folder[]>;
|
|
39
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { client } from '../../../../../Client.js';
|
|
2
|
+
/**
|
|
3
|
+
* Resolve path
|
|
4
|
+
*
|
|
5
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
6
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
7
|
+
* The given path is relative to the context's root folder and does not include
|
|
8
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
9
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
10
|
+
* the given full path, a Not Found error is returned.
|
|
11
|
+
*
|
|
12
|
+
* Nickname: resolve_path_courses_full_path
|
|
13
|
+
*/
|
|
14
|
+
export async function resolve_path_courses_full_path(options) {
|
|
15
|
+
const response = await client().fetchAs(`/api/v1/courses/{course_id}/folders/by_path/{full_path}`, {
|
|
16
|
+
method: 'GET',
|
|
17
|
+
...options
|
|
18
|
+
});
|
|
19
|
+
return response;
|
|
20
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
|
|
2
|
+
import { Folder } from '../../../../../Resources/Files.js';
|
|
3
|
+
export type resolve_path_groups_full_pathPathParameters = {
|
|
4
|
+
/**
|
|
5
|
+
* ID
|
|
6
|
+
*
|
|
7
|
+
* Type: string
|
|
8
|
+
*/
|
|
9
|
+
group_id: string | number;
|
|
10
|
+
/**
|
|
11
|
+
* Identified by @groton/canvas-api.swagger-renderer from the endpoint path:
|
|
12
|
+
* /v1/groups/{group_id}/folders/by_path/*full_path
|
|
13
|
+
*/
|
|
14
|
+
full_path: string;
|
|
15
|
+
};
|
|
16
|
+
export type resolve_path_groups_full_pathSearchParameters = Masquerade & Paginated;
|
|
17
|
+
type Options = {
|
|
18
|
+
pathParams: resolve_path_groups_full_pathPathParameters;
|
|
19
|
+
} & ({
|
|
20
|
+
searchParams?: Partial<resolve_path_groups_full_pathSearchParameters>;
|
|
21
|
+
strict?: false;
|
|
22
|
+
} | {
|
|
23
|
+
searchParams: resolve_path_groups_full_pathSearchParameters;
|
|
24
|
+
strict: true;
|
|
25
|
+
});
|
|
26
|
+
/**
|
|
27
|
+
* Resolve path
|
|
28
|
+
*
|
|
29
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
30
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
31
|
+
* The given path is relative to the context's root folder and does not include
|
|
32
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
33
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
34
|
+
* the given full path, a Not Found error is returned.
|
|
35
|
+
*
|
|
36
|
+
* Nickname: resolve_path_groups_full_path
|
|
37
|
+
*/
|
|
38
|
+
export declare function resolve_path_groups_full_path(options: Options): Promise<Folder[]>;
|
|
39
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { client } from '../../../../../Client.js';
|
|
2
|
+
/**
|
|
3
|
+
* Resolve path
|
|
4
|
+
*
|
|
5
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
6
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
7
|
+
* The given path is relative to the context's root folder and does not include
|
|
8
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
9
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
10
|
+
* the given full path, a Not Found error is returned.
|
|
11
|
+
*
|
|
12
|
+
* Nickname: resolve_path_groups_full_path
|
|
13
|
+
*/
|
|
14
|
+
export async function resolve_path_groups_full_path(options) {
|
|
15
|
+
const response = await client().fetchAs(`/api/v1/groups/{group_id}/folders/by_path/{full_path}`, {
|
|
16
|
+
method: 'GET',
|
|
17
|
+
...options
|
|
18
|
+
});
|
|
19
|
+
return response;
|
|
20
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { Masquerade, Paginated } from '@groton/canvas-api.client.base';
|
|
2
|
+
import { Folder } from '../../../../../Resources/Files.js';
|
|
3
|
+
export type resolve_path_users_full_pathPathParameters = {
|
|
4
|
+
/**
|
|
5
|
+
* ID
|
|
6
|
+
*
|
|
7
|
+
* Type: string
|
|
8
|
+
*/
|
|
9
|
+
user_id: string | number;
|
|
10
|
+
/**
|
|
11
|
+
* Identified by @groton/canvas-api.swagger-renderer from the endpoint path:
|
|
12
|
+
* /v1/users/{user_id}/folders/by_path/*full_path
|
|
13
|
+
*/
|
|
14
|
+
full_path: string;
|
|
15
|
+
};
|
|
16
|
+
export type resolve_path_users_full_pathSearchParameters = Masquerade & Paginated;
|
|
17
|
+
type Options = {
|
|
18
|
+
pathParams: resolve_path_users_full_pathPathParameters;
|
|
19
|
+
} & ({
|
|
20
|
+
searchParams?: Partial<resolve_path_users_full_pathSearchParameters>;
|
|
21
|
+
strict?: false;
|
|
22
|
+
} | {
|
|
23
|
+
searchParams: resolve_path_users_full_pathSearchParameters;
|
|
24
|
+
strict: true;
|
|
25
|
+
});
|
|
26
|
+
/**
|
|
27
|
+
* Resolve path
|
|
28
|
+
*
|
|
29
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
30
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
31
|
+
* The given path is relative to the context's root folder and does not include
|
|
32
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
33
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
34
|
+
* the given full path, a Not Found error is returned.
|
|
35
|
+
*
|
|
36
|
+
* Nickname: resolve_path_users_full_path
|
|
37
|
+
*/
|
|
38
|
+
export declare function resolve_path_users_full_path(options: Options): Promise<Folder[]>;
|
|
39
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { client } from '../../../../../Client.js';
|
|
2
|
+
/**
|
|
3
|
+
* Resolve path
|
|
4
|
+
*
|
|
5
|
+
* Given the full path to a folder, returns a list of all Folders in the path
|
|
6
|
+
* hierarchy, starting at the root folder, and ending at the requested folder.
|
|
7
|
+
* The given path is relative to the context's root folder and does not include
|
|
8
|
+
* the root folder's name (e.g., "course files"). If an empty path is given, the
|
|
9
|
+
* context's root folder alone is returned. Otherwise, if no folder exists with
|
|
10
|
+
* the given full path, a Not Found error is returned.
|
|
11
|
+
*
|
|
12
|
+
* Nickname: resolve_path_users_full_path
|
|
13
|
+
*/
|
|
14
|
+
export async function resolve_path_users_full_path(options) {
|
|
15
|
+
const response = await client().fetchAs(`/api/v1/users/{user_id}/folders/by_path/{full_path}`, {
|
|
16
|
+
method: 'GET',
|
|
17
|
+
...options
|
|
18
|
+
});
|
|
19
|
+
return response;
|
|
20
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@groton/canvas-api",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.6",
|
|
4
4
|
"description": "Typed access to Canvas LMS API with embedded documentation",
|
|
5
5
|
"homepage": "https://github.com/groton-school/canvas-cli/tree/main/packages/api/canvas-api#readme",
|
|
6
6
|
"repository": {
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"del-cli": "^6.0.0",
|
|
28
28
|
"npm-run-all": "^4.1.5",
|
|
29
29
|
"typescript": "~5.8.3",
|
|
30
|
-
"@groton/canvas-api.swagger-renderer": "0.1.
|
|
30
|
+
"@groton/canvas-api.swagger-renderer": "0.1.4"
|
|
31
31
|
},
|
|
32
32
|
"scripts": {
|
|
33
33
|
"clean": "run-s clean:*",
|