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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

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

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

## list

`GET /users`

| Parameter | In | Type | Required |
|---|---|---|---|
| `filter_term` | query | `String` | no |
| `user_type` | query | `GetUserType` | no |
| `external_app_user_id` | query | `String` | no |
| `fields` | query | `Vec<String>` | no |
| `offset` | query | `i64` | no |
| `limit` | query | `i64` | no |
| `usemarker` | query | `bool` | no |
| `marker` | query | `String` | no |

**Returns:** `Users`

**Example**

```rust
let mut pages = client.users.list(None);
while let Some(item) = pages.next().await {
    // use item
}
```

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

## create

`POST /users`

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

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

**Returns:** `UserFull`

**Example**

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

## get_me

`GET /users/me`

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

**Returns:** `UserFull`

**Example**

```rust
let result = client.users.get_me(None).await?;
```

## get

`GET /users/{user_id}`

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

**Returns:** `UserFull`

**Example**

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

## update

`PUT /users/{user_id}`

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

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

**Returns:** `UserFull`

**Example**

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

## delete

`DELETE /users/{user_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `user_id` | path | `String` | yes |
| `notify` | query | `bool` | no |
| `force` | query | `bool` | no |

**Returns:** no content

**Example**

```rust
client.users.delete("USER_ID".to_string(), None).await?;
```