fireblocks-sdk 2.1.0

Rust implementation of the Fireblocks SDK
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
# \SmartTransfersApi

All URIs are relative to *https://api.fireblocks.io/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**approve_dv_p_ticket_term**]SmartTransfersApi.md#approve_dv_p_ticket_term | **PUT** /smart_transfers/{ticketId}/terms/{termId}/dvp/approve | Set funding source and approval
[**cancel_ticket**]SmartTransfersApi.md#cancel_ticket | **PUT** /smart-transfers/{ticketId}/cancel | Cancel Ticket
[**create_ticket**]SmartTransfersApi.md#create_ticket | **POST** /smart-transfers | Create Ticket
[**create_ticket_term**]SmartTransfersApi.md#create_ticket_term | **POST** /smart-transfers/{ticketId}/terms | Create leg (term)
[**find_ticket_by_id**]SmartTransfersApi.md#find_ticket_by_id | **GET** /smart-transfers/{ticketId} | Search Ticket by ID
[**find_ticket_term_by_id**]SmartTransfersApi.md#find_ticket_term_by_id | **GET** /smart-transfers/{ticketId}/terms/{termId} | Get Smart Transfer ticket term
[**fulfill_ticket**]SmartTransfersApi.md#fulfill_ticket | **PUT** /smart-transfers/{ticketId}/fulfill | Fund ticket manually
[**fund_dvp_ticket**]SmartTransfersApi.md#fund_dvp_ticket | **PUT** /smart_transfers/{ticketId}/dvp/fund | Fund dvp ticket
[**fund_ticket_term**]SmartTransfersApi.md#fund_ticket_term | **PUT** /smart-transfers/{ticketId}/terms/{termId}/fund | Define funding source
[**get_smart_transfer_statistic**]SmartTransfersApi.md#get_smart_transfer_statistic | **GET** /smart_transfers/statistic | Get smart transfers statistic
[**get_smart_transfer_user_groups**]SmartTransfersApi.md#get_smart_transfer_user_groups | **GET** /smart-transfers/settings/user-groups | Get user group
[**manually_fund_ticket_term**]SmartTransfersApi.md#manually_fund_ticket_term | **PUT** /smart-transfers/{ticketId}/terms/{termId}/manually-fund | Manually add term transaction
[**remove_ticket_term**]SmartTransfersApi.md#remove_ticket_term | **DELETE** /smart-transfers/{ticketId}/terms/{termId} | Delete ticket leg (term)
[**search_tickets**]SmartTransfersApi.md#search_tickets | **GET** /smart-transfers | Find Ticket
[**set_external_ref_id**]SmartTransfersApi.md#set_external_ref_id | **PUT** /smart-transfers/{ticketId}/external-id | Add external ref. ID
[**set_ticket_expiration**]SmartTransfersApi.md#set_ticket_expiration | **PUT** /smart-transfers/{ticketId}/expires-in | Set expiration
[**set_user_groups**]SmartTransfersApi.md#set_user_groups | **POST** /smart-transfers/settings/user-groups | Set user group
[**submit_ticket**]SmartTransfersApi.md#submit_ticket | **PUT** /smart-transfers/{ticketId}/submit | Submit ticket
[**update_ticket_term**]SmartTransfersApi.md#update_ticket_term | **PUT** /smart-transfers/{ticketId}/terms/{termId} | Update ticket leg (term)



## approve_dv_p_ticket_term

> models::SmartTransferTicketTermResponse approve_dv_p_ticket_term(ticket_id, term_id, smart_transfer_approve_term, idempotency_key)
Set funding source and approval

Set funding source for ticket term and creating approving transaction for contract to transfer asset

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |
**smart_transfer_approve_term** | [**SmartTransferApproveTerm**]SmartTransferApproveTerm.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## cancel_ticket

> models::SmartTransferTicketResponse cancel_ticket(ticket_id, idempotency_key)
Cancel Ticket

Cancel Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_ticket

> models::SmartTransferTicketResponse create_ticket(smart_transfer_create_ticket, idempotency_key)
Create Ticket

Creates new Smart Transfer ticket. Learn more about Fireblocks Smart Transfers in the following [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**smart_transfer_create_ticket** | [**SmartTransferCreateTicket**]SmartTransferCreateTicket.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_ticket_term

> models::SmartTransferTicketTermResponse create_ticket_term(ticket_id, smart_transfer_create_ticket_term, idempotency_key)
Create leg (term)

Creates new smart transfer ticket term (when the ticket status is DRAFT). Learn more about Fireblocks Smart Transfers in the following [guide](https://developers.fireblocks.com/docs/execute-smart-transfers). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**smart_transfer_create_ticket_term** | [**SmartTransferCreateTicketTerm**]SmartTransferCreateTicketTerm.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## find_ticket_by_id

> models::SmartTransferTicketResponse find_ticket_by_id(ticket_id)
Search Ticket by ID

Find Smart Transfer ticket by id. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## find_ticket_term_by_id

> models::SmartTransferTicketTermResponse find_ticket_term_by_id(ticket_id, term_id)
Get Smart Transfer ticket term

Find a specific term of a specific Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## fulfill_ticket

> models::SmartTransferTicketResponse fulfill_ticket(ticket_id, idempotency_key)
Fund ticket manually

Manually fulfill ticket, in case when all terms (legs) are funded manually. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## fund_dvp_ticket

> models::SmartTransferTicketResponse fund_dvp_ticket(ticket_id, smart_transfer_fund_dvp_ticket, idempotency_key)
Fund dvp ticket

Create or fulfill dvp ticket order

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**smart_transfer_fund_dvp_ticket** | [**SmartTransferFundDvpTicket**]SmartTransferFundDvpTicket.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## fund_ticket_term

> models::SmartTransferTicketTermResponse fund_ticket_term(ticket_id, term_id, smart_transfer_fund_term, idempotency_key)
Define funding source

Set funding source for ticket term (in case of ASYNC tickets, this will execute transfer immediately). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |
**smart_transfer_fund_term** | [**SmartTransferFundTerm**]SmartTransferFundTerm.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_smart_transfer_statistic

> models::SmartTransferStatistic get_smart_transfer_statistic()
Get smart transfers statistic

Get smart transfer statistic

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::SmartTransferStatistic**](SmartTransferStatistic.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_smart_transfer_user_groups

> models::SmartTransferUserGroupsResponse get_smart_transfer_user_groups()
Get user group

Get Smart Transfer user groups. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::SmartTransferUserGroupsResponse**](SmartTransferUserGroupsResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## manually_fund_ticket_term

> models::SmartTransferTicketTermResponse manually_fund_ticket_term(ticket_id, term_id, smart_transfer_manually_fund_term, idempotency_key)
Manually add term transaction

Manually set ticket term transaction. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |
**smart_transfer_manually_fund_term** | [**SmartTransferManuallyFundTerm**]SmartTransferManuallyFundTerm.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_ticket_term

> remove_ticket_term(ticket_id, term_id)
Delete ticket leg (term)

Delete ticket term when ticket is in DRAFT status. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## search_tickets

> models::SmartTransferTicketFilteredResponse search_tickets(q, statuses, network_id, created_by_me, expires_after, expires_before, r#type, external_ref_id, after, limit)
Find Ticket

Finds Smart Transfer tickets that match the submitted criteria. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor,   Viewer.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**q** | Option<**String**> | Search string - counterparty name or asset or ticketId. Optional |  |
**statuses** | Option<[**Vec<String>**]String.md> | Ticket statuses for Smart Transfer tickets. Optional |  |[default to []]
**network_id** | Option<**String**> | NetworkId that is used in the ticket . Optional |  |
**created_by_me** | Option<**bool**> | Filter created tickets by created by self or by others. Optional |  |
**expires_after** | Option<**String**> | Lower bound of search range. Optional |  |
**expires_before** | Option<**String**> | Upper bound of search range. Optional |  |
**r#type** | Option<**String**> | Type of transfer. ASYNC executes transfers as they are funded, ATOMIC executes all terms (legs) as one atomic transfer |  |
**external_ref_id** | Option<**String**> | External ref. ID that workspace can use to identify ticket outside of Fireblocks system. |  |
**after** | Option<**String**> | ID of the record after which to fetch $limit records |  |
**limit** | Option<**f64**> | Number of records to fetch. By default, it is 100 |  |

### Return type

[**models::SmartTransferTicketFilteredResponse**](SmartTransferTicketFilteredResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_external_ref_id

> models::SmartTransferTicketResponse set_external_ref_id(ticket_id, smart_transfer_set_ticket_external_id, idempotency_key)
Add external ref. ID

Set external id Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**smart_transfer_set_ticket_external_id** | [**SmartTransferSetTicketExternalId**]SmartTransferSetTicketExternalId.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_ticket_expiration

> models::SmartTransferTicketResponse set_ticket_expiration(ticket_id, smart_transfer_set_ticket_expiration, idempotency_key)
Set expiration

Set expiration date on Smart Transfer ticket. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**smart_transfer_set_ticket_expiration** | [**SmartTransferSetTicketExpiration**]SmartTransferSetTicketExpiration.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_user_groups

> models::SmartTransferUserGroupsResponse set_user_groups(smart_transfer_set_user_groups, idempotency_key)
Set user group

Set Smart Transfers user group to receive email notifications for Smart Transfers. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**smart_transfer_set_user_groups** | [**SmartTransferSetUserGroups**]SmartTransferSetUserGroups.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferUserGroupsResponse**](SmartTransferUserGroupsResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## submit_ticket

> models::SmartTransferTicketResponse submit_ticket(ticket_id, smart_transfer_submit_ticket, idempotency_key)
Submit ticket

Submit Smart Transfer ticket - change status into ready for approval if auto approval is not turned on, or OPEN if auto approval is on. </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**smart_transfer_submit_ticket** | [**SmartTransferSubmitTicket**]SmartTransferSubmitTicket.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketResponse**](SmartTransferTicketResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_ticket_term

> models::SmartTransferTicketTermResponse update_ticket_term(ticket_id, term_id, smart_transfer_update_ticket_term, idempotency_key)
Update ticket leg (term)

Update ticket term (when ticket status is DRAFT). </br>Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ticket_id** | **String** |  | [required] |
**term_id** | **String** |  | [required] |
**smart_transfer_update_ticket_term** | [**SmartTransferUpdateTicketTerm**]SmartTransferUpdateTicketTerm.md |  | [required] |
**idempotency_key** | Option<**String**> | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. |  |

### Return type

[**models::SmartTransferTicketTermResponse**](SmartTransferTicketTermResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)