box-open-sdk 0.3.0

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

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

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

## list_file_collaborations

`GET /files/{file_id}/collaborations`

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

**Returns:** `Collaborations`

**Example**

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

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

## list_folder_collaborations

`GET /folders/{folder_id}/collaborations`

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

**Returns:** `Collaborations`

**Example**

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

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

## list_collaborations

`GET /collaborations`

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

**Returns:** `CollaborationsOffsetPaginated`

**Example**

```rust
let mut pages = client.list_collaborations.list_collaborations(Default::default(), None);
while let Some(item) = pages.next().await {
    // use item
}
```

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

## list_group_collaborations

`GET /groups/{group_id}/collaborations`

| Parameter | In | Type | Required |
|---|---|---|---|
| `group_id` | path | `String` | yes |
| `limit` | query | `i64` | no |
| `offset` | query | `i64` | no |

**Returns:** `CollaborationsOffsetPaginated`

**Example**

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

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