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
<!-- Generated by box-gantry. DO NOT EDIT. -->
# SignRequestsManager
Reach these methods through the `sign_requests` field on `client::Client`.
## cancel
`POST /sign_requests/{sign_request_id}/cancel`
| Parameter | In | Type | Required |
|---|---|---|---|
| `sign_request_id` | path | `String` | yes |
**Request body** (`application/json`): `SignRequestCancelRequest`
**Returns:** `SignRequest`
**Example**
```rust
let result = client.sign_requests.cancel("SIGN_REQUEST_ID".to_string(), schemas::SignRequestCancelRequest { /* … */ }).await?;
```
## resend
`POST /sign_requests/{sign_request_id}/resend`
| Parameter | In | Type | Required |
|---|---|---|---|
| `sign_request_id` | path | `String` | yes |
**Returns:** no content
**Example**
```rust
client.sign_requests.resend("SIGN_REQUEST_ID".to_string()).await?;
```
## get
`GET /sign_requests/{sign_request_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `sign_request_id` | path | `String` | yes |
**Returns:** `SignRequest`
**Example**
```rust
let result = client.sign_requests.get("SIGN_REQUEST_ID".to_string()).await?;
```
## list
`GET /sign_requests`
| Parameter | In | Type | Required |
|---|---|---|---|
| `marker` | query | `String` | no |
| `limit` | query | `i64` | no |
| `senders` | query | `Vec<String>` | no |
| `shared_requests` | query | `bool` | no |
**Returns:** `SignRequests`
**Example**
```rust
let mut pages = client.sign_requests.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 /sign_requests`
**Request body** (`application/json`): `SignRequestCreateRequest`
**Returns:** `SignRequest`
**Example**
```rust
let result = client.sign_requests.create(schemas::SignRequestCreateRequest { /* … */ }).await?;
```