box-open-sdk 0.4.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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

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

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

## list_docgen_templates

`GET /docgen_templates`

| Parameter | In | Type | Required |
|---|---|---|---|
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |

**Returns:** `DocGenTemplates`

**Example**

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

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

## create_docgen_templates

`POST /docgen_templates`

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

**Returns:** `DocGenTemplateBase`

**Example**

```rust
let result = client.docgen_template.create_docgen_templates(schemas::DocGenTemplateCreateRequest { /* … */ }).await?;
```

## get_docgen_template

`GET /docgen_templates/{template_id}`

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

**Returns:** `DocGenTemplate`

**Example**

```rust
let result = client.docgen_template.get_docgen_template("TEMPLATE_ID".to_string()).await?;
```

## delete_docgen_template

`DELETE /docgen_templates/{template_id}`

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

**Returns:** no content

**Example**

```rust
client.docgen_template.delete_docgen_template("TEMPLATE_ID".to_string()).await?;
```

## list_docgen_template_tags

`GET /docgen_templates/{template_id}/tags`

| Parameter | In | Type | Required |
|---|---|---|---|
| `template_id` | path | `String` | yes |
| `template_version_id` | query | `String` | no |
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |

**Returns:** `DocGenTags`

**Example**

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

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

## list_job

`GET /docgen_template_jobs/{template_id}`

| Parameter | In | Type | Required |
|---|---|---|---|
| `template_id` | path | `String` | yes |
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |

**Returns:** `DocGenJobs`

**Example**

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

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