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
<!-- Generated by box-gantry. DO NOT EDIT. -->
# DocgenManager
Reach these methods through the `docgen` field on `client::Client`.
## get_job
`GET /docgen_jobs/{job_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `job_id` | path | `String` | yes |
**Returns:** `DocGenJob`
**Example**
```rust
let result = client.docgen.get_job("JOB_ID".to_string()).await?;
```
## list_jobs
`GET /docgen_jobs`
| Parameter | In | Type | Required |
|---|---|---|---|
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |
**Returns:** `DocGenJobsFull`
**Example**
```rust
let mut pages = client.docgen.list_jobs(None);
while let Some(item) = pages.next().await {
// use item
}
```
Paginated — `list_jobs(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).
## list_batch_job
`GET /docgen_batch_jobs/{batch_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `batch_id` | path | `String` | yes |
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |
**Returns:** `DocGenJobs`
**Example**
```rust
let mut pages = client.docgen.list_batch_job("BATCH_ID".to_string(), None);
while let Some(item) = pages.next().await {
// use item
}
```
Paginated — `list_batch_job(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).
## create_batches
`POST /docgen_batches`
**Request body** (`application/json`): `DocGenBatchCreateRequest`
**Returns:** `DocGenBatchBase`
**Example**
```rust
let result = client.docgen.create_batches(schemas::DocGenBatchCreateRequest { /* … */ }).await?;
```