box-open-sdk 0.3.1

Box API client for Rust (open source, community, punk rock) — 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

<!-- Generated by box-gantry. DO NOT EDIT. -->
# FilesManager

Reach these methods through the `files` field on `client::Client`.

## get

`GET /files/{file_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `if-none-match` | header | `String` | no |
| `boxapi` | header | `String` | no |
| `x-rep-hints` | header | `String` | no |

**Returns:** `FileFull`

**Example**

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

## update

`PUT /files/{file_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `if-match` | header | `String` | no |

**Request body** (`application/json`): `FileUpdateRequest`

**Returns:** `FileFull`

**Example**

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

## delete

`DELETE /files/{file_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `if-match` | header | `String` | no |

**Returns:** no content

**Example**

```rust
client.files.delete("FILE_ID".to_string(), None).await?;
```

## copy

`POST /files/{file_id}/copy`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |

**Request body** (`application/json`): `FileCopyRequest`

**Returns:** `FileFull`

**Example**

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

## get_thumbnail

`GET /files/{file_id}/thumbnail.{extension}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `extension` | path | `GetIdThumbnailIdExtension` | yes |
| `min_height` | query | `i64` | no |
| `min_width` | query | `i64` | no |
| `max_height` | query | `i64` | no |
| `max_width` | query | `i64` | no |

**Returns:** a binary stream (`runtime::Stream`)

**Example**

```rust
let result = client.files.get_thumbnail("FILE_ID".to_string(), Default::default(), None).await?;
```