box-open-sdk 0.2.0

Community, unofficial Box API client for Rust — typed models, async managers, and a reqwest runtime with retry, backoff, and token refresh.
Documentation 
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

<!-- 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`

**Example**

```rust
let result = client.folders.get("FOLDER_ID".to_string(), None).await?;
```

## 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`

**Example**

```rust
let result = client.folders.update("FOLDER_ID".to_string(), schemas::FolderUpdateRequest { /* … */ }, None).await?;
```

## 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

**Example**

```rust
client.folders.delete("FOLDER_ID".to_string(), None).await?;
```

## 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`

**Example**

```rust
let mut pages = client.folders.list_items("FOLDER_ID".to_string(), None);
while let Some(item) = pages.next().await {
    // use item
}
```

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`

**Example**

```rust
let result = client.folders.create(schemas::FolderCreateRequest { /* … */ }, None).await?;
```

## 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`

**Example**

```rust
let result = client.folders.copy("FOLDER_ID".to_string(), schemas::FolderCopyRequest { /* … */ }, None).await?;
```