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

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

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

## list_file_metadata

`GET /files/{file_id}/metadata`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `view` | query | `String` | no |

**Returns:** `Metadatas`

**Example**

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

## get_file_metadata

`GET /files/{file_id}/metadata/{scope}/{template_key}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
| `template_key` | path | `String` | yes |
| `view` | query | `String` | no |

**Returns:** `MetadataFull`

**Example**

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

## update_file_metadata

`PUT /files/{file_id}/metadata/{scope}/{template_key}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
| `template_key` | path | `String` | yes |

**Request body** (`application/json-patch+json`): `Vec<FileMetadataUpdateRequest>`

**Returns:** `MetadataFull`

**Example**

```rust
let result = client.file_metadata.update_file_metadata("FILE_ID".to_string(), Default::default(), "TEMPLATE_KEY".to_string(), vec![]).await?;
```

## create_file_metadata

`POST /files/{file_id}/metadata/{scope}/{template_key}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
| `template_key` | path | `String` | yes |

**Request body** (`application/json`): `std::collections::HashMap<String, serde_json::Value>`

**Returns:** `MetadataFull`

**Example**

```rust
let result = client.file_metadata.create_file_metadata("FILE_ID".to_string(), Default::default(), "TEMPLATE_KEY".to_string(), Default::default()).await?;
```

## delete_file_metadata

`DELETE /files/{file_id}/metadata/{scope}/{template_key}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `file_id` | path | `String` | yes |
| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
| `template_key` | path | `String` | yes |

**Returns:** no content

**Example**

```rust
client.file_metadata.delete_file_metadata("FILE_ID".to_string(), Default::default(), "TEMPLATE_KEY".to_string()).await?;
```