1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<!-- Generated by box-gantry. DO NOT EDIT. -->
# FoldersManager
Reach these methods through the `folders` field on `client::Client`.
## get
`GET /folders/{folder_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `folder_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `if-none-match` | header | `String` | no |
| `boxapi` | header | `String` | no |
| `sort` | query | `GetIdSort` | no |
| `direction` | query | `OrderDirection` | no |
| `offset` | query | `i64` | no |
| `limit` | query | `i64` | no |
**Returns:** `FolderFull`
## update
`PUT /folders/{folder_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `folder_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `if-match` | header | `String` | no |
**Request body** (`application/json`): `FolderUpdateRequest`
**Returns:** `FolderFull`
## delete
`DELETE /folders/{folder_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `folder_id` | path | `String` | yes |
| `if-match` | header | `String` | no |
| `recursive` | query | `bool` | no |
**Returns:** no content
## list_items
`GET /folders/{folder_id}/items`
| Parameter | In | Type | Required |
|---|---|---|---|
| `folder_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `usemarker` | query | `bool` | no |
| `marker` | query | `String` | no |
| `offset` | query | `i64` | no |
| `limit` | query | `i64` | no |
| `boxapi` | header | `String` | no |
| `sort` | query | `GetIdSort` | no |
| `direction` | query | `OrderDirection` | no |
**Returns:** `Items`
Paginated — `list_items(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).
## create
`POST /folders`
| Parameter | In | Type | Required |
|---|---|---|---|
| `fields` | query | `Vec<String>` | no |
**Request body** (`application/json`): `FolderCreateRequest`
**Returns:** `FolderFull`
## copy
`POST /folders/{folder_id}/copy`
| Parameter | In | Type | Required |
|---|---|---|---|
| `folder_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
**Request body** (`application/json`): `FolderCopyRequest`
**Returns:** `FolderFull`