box-open-sdk 0.1.1

Generated Box API SDK for Rust (community, unofficial).
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

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

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

## list_file

`GET /files/{file_id}/comments`

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

**Returns:** `Comments`

Paginated — `list_file(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).

## get

`GET /comments/{comment_id}`

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

**Returns:** `CommentFull`

## update

`PUT /comments/{comment_id}`

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

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

**Returns:** `CommentFull`

## delete

`DELETE /comments/{comment_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `comment_id` | path | `String` | yes |

**Returns:** no content

## create

`POST /comments`

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

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

**Returns:** `CommentFull`