-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathSignatureRequestApi.java
More file actions
1563 lines (1431 loc) · 86.4 KB
/
Copy pathSignatureRequestApi.java
File metadata and controls
1563 lines (1431 loc) · 86.4 KB
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
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package com.dropbox.sign.api;
import com.dropbox.sign.ApiException;
import com.dropbox.sign.ApiClient;
import com.dropbox.sign.ApiResponse;
import com.dropbox.sign.Configuration;
import com.dropbox.sign.Pair;
import jakarta.ws.rs.core.GenericType;
import com.dropbox.sign.model.BulkSendJobSendResponse;
import com.dropbox.sign.model.ErrorResponse;
import java.io.File;
import com.dropbox.sign.model.FileResponse;
import com.dropbox.sign.model.FileResponseDataUri;
import com.dropbox.sign.model.SignatureRequestBulkCreateEmbeddedWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestBulkSendWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestCreateEmbeddedRequest;
import com.dropbox.sign.model.SignatureRequestCreateEmbeddedWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestEditEmbeddedRequest;
import com.dropbox.sign.model.SignatureRequestEditEmbeddedWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestEditRequest;
import com.dropbox.sign.model.SignatureRequestEditWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestGetResponse;
import com.dropbox.sign.model.SignatureRequestListResponse;
import com.dropbox.sign.model.SignatureRequestRemindRequest;
import com.dropbox.sign.model.SignatureRequestSendRequest;
import com.dropbox.sign.model.SignatureRequestSendWithTemplateRequest;
import com.dropbox.sign.model.SignatureRequestUpdateRequest;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0")
public class SignatureRequestApi {
private ApiClient apiClient;
public SignatureRequestApi() {
this(Configuration.getDefaultApiClient());
}
public SignatureRequestApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Get the API client
*
* @return API client
*/
public ApiClient getApiClient() {
return apiClient;
}
/**
* Set the API client
*
* @param apiClient an instance of API client
*/
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
* Embedded Bulk Send with Template
* Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
* @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required)
* @return BulkSendJobSendResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public BulkSendJobSendResponse signatureRequestBulkCreateEmbeddedWithTemplate(SignatureRequestBulkCreateEmbeddedWithTemplateRequest signatureRequestBulkCreateEmbeddedWithTemplateRequest) throws ApiException {
return signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(signatureRequestBulkCreateEmbeddedWithTemplateRequest).getData();
}
/**
* Embedded Bulk Send with Template
* Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter to be signed in an embedded iFrame. These embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Only available for Standard plan and higher.
* @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required)
* @return ApiResponse<BulkSendJobSendResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<BulkSendJobSendResponse> signatureRequestBulkCreateEmbeddedWithTemplateWithHttpInfo(SignatureRequestBulkCreateEmbeddedWithTemplateRequest signatureRequestBulkCreateEmbeddedWithTemplateRequest) throws ApiException {
// Check required parameters
if (signatureRequestBulkCreateEmbeddedWithTemplateRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestBulkCreateEmbeddedWithTemplateRequest' when calling signatureRequestBulkCreateEmbeddedWithTemplate");
}
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestBulkCreateEmbeddedWithTemplateRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key"};
GenericType<BulkSendJobSendResponse> localVarReturnType = new GenericType<BulkSendJobSendResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate",
"/signature_request/bulk_create_embedded_with_template",
"POST",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestBulkCreateEmbeddedWithTemplateRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Bulk Send with Template
* Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
* @param signatureRequestBulkSendWithTemplateRequest (required)
* @return BulkSendJobSendResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public BulkSendJobSendResponse signatureRequestBulkSendWithTemplate(SignatureRequestBulkSendWithTemplateRequest signatureRequestBulkSendWithTemplateRequest) throws ApiException {
return signatureRequestBulkSendWithTemplateWithHttpInfo(signatureRequestBulkSendWithTemplateRequest).getData();
}
/**
* Bulk Send with Template
* Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of the provided Template(s) specified with the `template_ids` parameter. **NOTE:** Only available for Standard plan and higher.
* @param signatureRequestBulkSendWithTemplateRequest (required)
* @return ApiResponse<BulkSendJobSendResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<BulkSendJobSendResponse> signatureRequestBulkSendWithTemplateWithHttpInfo(SignatureRequestBulkSendWithTemplateRequest signatureRequestBulkSendWithTemplateRequest) throws ApiException {
// Check required parameters
if (signatureRequestBulkSendWithTemplateRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestBulkSendWithTemplateRequest' when calling signatureRequestBulkSendWithTemplate");
}
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestBulkSendWithTemplateRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<BulkSendJobSendResponse> localVarReturnType = new GenericType<BulkSendJobSendResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestBulkSendWithTemplate",
"/signature_request/bulk_send_with_template",
"POST",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestBulkSendWithTemplateRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Cancel Incomplete Signature Request
* Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
* @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required)
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public void signatureRequestCancel(String signatureRequestId) throws ApiException {
signatureRequestCancelWithHttpInfo(signatureRequestId);
}
/**
* Cancel Incomplete Signature Request
* Cancels an incomplete signature request. This action is **not reversible**. The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued. This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary. To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled. **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
* @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required)
* @return ApiResponse<Void>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<Void> signatureRequestCancelWithHttpInfo(String signatureRequestId) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestCancel");
}
// Path parameters
String localVarPath = "/signature_request/cancel/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = new HashMap<String, Object>();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType();
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestCancel",
localVarPath,
"POST",
new ArrayList<>(),
null,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
null,
false
);
}
/**
* Create Embedded Signature Request
* Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
* @param signatureRequestCreateEmbeddedRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestCreateEmbedded(SignatureRequestCreateEmbeddedRequest signatureRequestCreateEmbeddedRequest) throws ApiException {
return signatureRequestCreateEmbeddedWithHttpInfo(signatureRequestCreateEmbeddedRequest).getData();
}
/**
* Create Embedded Signature Request
* Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
* @param signatureRequestCreateEmbeddedRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestCreateEmbeddedWithHttpInfo(SignatureRequestCreateEmbeddedRequest signatureRequestCreateEmbeddedRequest) throws ApiException {
// Check required parameters
if (signatureRequestCreateEmbeddedRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestCreateEmbeddedRequest' when calling signatureRequestCreateEmbedded");
}
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestCreateEmbeddedRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestCreateEmbedded",
"/signature_request/create_embedded",
"POST",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestCreateEmbeddedRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Create Embedded Signature Request with Template
* Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
* @param signatureRequestCreateEmbeddedWithTemplateRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest) throws ApiException {
return signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(signatureRequestCreateEmbeddedWithTemplateRequest).getData();
}
/**
* Create Embedded Signature Request with Template
* Creates a new SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.
* @param signatureRequestCreateEmbeddedWithTemplateRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestCreateEmbeddedWithTemplateWithHttpInfo(SignatureRequestCreateEmbeddedWithTemplateRequest signatureRequestCreateEmbeddedWithTemplateRequest) throws ApiException {
// Check required parameters
if (signatureRequestCreateEmbeddedWithTemplateRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestCreateEmbeddedWithTemplateRequest' when calling signatureRequestCreateEmbeddedWithTemplate");
}
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestCreateEmbeddedWithTemplateRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestCreateEmbeddedWithTemplate",
"/signature_request/create_embedded_with_template",
"POST",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestCreateEmbeddedWithTemplateRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Edit Signature Request
* Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestEdit(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException {
return signatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest).getData();
}
/**
* Edit Signature Request
* Edits and sends a SignatureRequest with the submitted documents. If `form_fields_per_document` is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestEditWithHttpInfo(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEdit");
}
if (signatureRequestEditRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestEditRequest' when calling signatureRequestEdit");
}
// Path parameters
String localVarPath = "/signature_request/edit/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestEditRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestEdit",
localVarPath,
"PUT",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestEditRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Edit Embedded Signature Request
* Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditEmbeddedRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestEditEmbedded(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException {
return signatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest).getData();
}
/**
* Edit Embedded Signature Request
* Edits a SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditEmbeddedRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestEditEmbeddedWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbedded");
}
if (signatureRequestEditEmbeddedRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedRequest' when calling signatureRequestEditEmbedded");
}
// Path parameters
String localVarPath = "/signature_request/edit_embedded/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestEditEmbeddedRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestEditEmbedded",
localVarPath,
"PUT",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestEditEmbeddedRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Edit Embedded Signature Request with Template
* Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditEmbeddedWithTemplateRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException {
return signatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest).getData();
}
/**
* Edit Embedded Signature Request with Template
* Edits a SignatureRequest based on the given Template(s) to be signed in an embedded iFrame. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditEmbeddedWithTemplateRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestEditEmbeddedWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbeddedWithTemplate");
}
if (signatureRequestEditEmbeddedWithTemplateRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' when calling signatureRequestEditEmbeddedWithTemplate");
}
// Path parameters
String localVarPath = "/signature_request/edit_embedded_with_template/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestEditEmbeddedWithTemplateRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestEditEmbeddedWithTemplate",
localVarPath,
"PUT",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestEditEmbeddedWithTemplateRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Edit Signature Request With Template
* Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditWithTemplateRequest (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestEditWithTemplate(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException {
return signatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest).getData();
}
/**
* Edit Signature Request With Template
* Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend *will* deduct your signature request quota.
* @param signatureRequestId The id of the SignatureRequest to edit. (required)
* @param signatureRequestEditWithTemplateRequest (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestEditWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditWithTemplate");
}
if (signatureRequestEditWithTemplateRequest == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestEditWithTemplateRequest' when calling signatureRequestEditWithTemplate");
}
// Path parameters
String localVarPath = "/signature_request/edit_with_template/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = signatureRequestEditWithTemplateRequest.createFormData();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType("application/json", "multipart/form-data");
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestEditWithTemplate",
localVarPath,
"PUT",
new ArrayList<>(),
isFileTypeFound ? null : signatureRequestEditWithTemplateRequest,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Download Files
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf)
* @return File
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public File signatureRequestFiles(String signatureRequestId, String fileType) throws ApiException {
return signatureRequestFilesWithHttpInfo(signatureRequestId, fileType).getData();
}
/**
* @see SignatureRequestApi#signatureRequestFiles(String, String)
*/
public File signatureRequestFiles(String signatureRequestId) throws ApiException {
String fileType = "pdf";
return signatureRequestFilesWithHttpInfo(signatureRequestId, fileType).getData();
}
/**
* @see SignatureRequestApi#signatureRequestFilesWithHttpInfo(String, String)
*/
public ApiResponse<File> signatureRequestFilesWithHttpInfo(String signatureRequestId) throws ApiException {
String fileType = "pdf";
return signatureRequestFilesWithHttpInfo(signatureRequestId, fileType);
}
/**
* Download Files
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @param fileType Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional, default to pdf)
* @return ApiResponse<File>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<File> signatureRequestFilesWithHttpInfo(String signatureRequestId, String fileType) throws ApiException {
if (fileType == null) {
fileType = "pdf";
}
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestFiles");
}
// Path parameters
String localVarPath = "/signature_request/files/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
// Query parameters
List<Pair> localVarQueryParams = new ArrayList<>(
apiClient.parameterToPairs("", "file_type", fileType)
);
String localVarAccept = apiClient.selectHeaderAccept("application/pdf", "application/zip", "application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = new HashMap<String, Object>();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType();
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<File> localVarReturnType = new GenericType<File>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestFiles",
localVarPath,
"GET",
localVarQueryParams,
null,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Download Files as Data Uri
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @return FileResponseDataUri
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public FileResponseDataUri signatureRequestFilesAsDataUri(String signatureRequestId) throws ApiException {
return signatureRequestFilesAsDataUriWithHttpInfo(signatureRequestId).getData();
}
/**
* Download Files as Data Uri
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a `data_uri` representing the base64 encoded file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @return ApiResponse<FileResponseDataUri>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<FileResponseDataUri> signatureRequestFilesAsDataUriWithHttpInfo(String signatureRequestId) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestFilesAsDataUri");
}
// Path parameters
String localVarPath = "/signature_request/files_as_data_uri/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = new HashMap<String, Object>();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType();
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<FileResponseDataUri> localVarReturnType = new GenericType<FileResponseDataUri>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestFilesAsDataUri",
localVarPath,
"GET",
new ArrayList<>(),
null,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Download Files as File Url
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
* @return FileResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public FileResponse signatureRequestFilesAsFileUrl(String signatureRequestId, Integer forceDownload) throws ApiException {
return signatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload).getData();
}
/**
* @see SignatureRequestApi#signatureRequestFilesAsFileUrl(String, Integer)
*/
public FileResponse signatureRequestFilesAsFileUrl(String signatureRequestId) throws ApiException {
Integer forceDownload = 1;
return signatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload).getData();
}
/**
* @see SignatureRequestApi#signatureRequestFilesAsFileUrlWithHttpInfo(String, Integer)
*/
public ApiResponse<FileResponse> signatureRequestFilesAsFileUrlWithHttpInfo(String signatureRequestId) throws ApiException {
Integer forceDownload = 1;
return signatureRequestFilesAsFileUrlWithHttpInfo(signatureRequestId, forceDownload);
}
/**
* Download Files as File Url
* Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only). If the files are currently being prepared, a status code of `409` will be returned instead.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @param forceDownload By default when opening the `file_url` a browser will download the PDF and save it locally. When set to `0` the PDF file will be displayed in the browser. (optional, default to 1)
* @return ApiResponse<FileResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<FileResponse> signatureRequestFilesAsFileUrlWithHttpInfo(String signatureRequestId, Integer forceDownload) throws ApiException {
if (forceDownload == null) {
forceDownload = 1;
}
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestFilesAsFileUrl");
}
// Path parameters
String localVarPath = "/signature_request/files_as_file_url/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
// Query parameters
List<Pair> localVarQueryParams = new ArrayList<>(
apiClient.parameterToPairs("", "force_download", forceDownload)
);
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = new HashMap<String, Object>();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType();
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<FileResponse> localVarReturnType = new GenericType<FileResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestFilesAsFileUrl",
localVarPath,
"GET",
localVarQueryParams,
null,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* Get Signature Request
* Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @return SignatureRequestGetResponse
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public SignatureRequestGetResponse signatureRequestGet(String signatureRequestId) throws ApiException {
return signatureRequestGetWithHttpInfo(signatureRequestId).getData();
}
/**
* Get Signature Request
* Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
* @param signatureRequestId The id of the SignatureRequest to retrieve. (required)
* @return ApiResponse<SignatureRequestGetResponse>
* @throws ApiException if fails to make API call
* @http.response.details
<table border="1">
<caption>Response Details</caption>
<tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
<tr><td> 200 </td><td> successful operation </td><td> * X-RateLimit-Limit - <br> * X-RateLimit-Remaining - <br> * X-Ratelimit-Reset - <br> </td></tr>
<tr><td> 4XX </td><td> failed_operation </td><td> - </td></tr>
</table>
*/
public ApiResponse<SignatureRequestGetResponse> signatureRequestGetWithHttpInfo(String signatureRequestId) throws ApiException {
// Check required parameters
if (signatureRequestId == null) {
throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestGet");
}
// Path parameters
String localVarPath = "/signature_request/{signature_request_id}"
.replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString()));
String localVarAccept = apiClient.selectHeaderAccept("application/json");
Map<String, Object> localVarFormParams = new LinkedHashMap<>();
localVarFormParams = new HashMap<String, Object>();
boolean isFileTypeFound = !localVarFormParams.isEmpty();
String localVarContentType = isFileTypeFound? "multipart/form-data" : apiClient.selectHeaderContentType();
String[] localVarAuthNames = new String[] {"api_key", "oauth2"};
GenericType<SignatureRequestGetResponse> localVarReturnType = new GenericType<SignatureRequestGetResponse>() {};
return apiClient.invokeAPI(
"SignatureRequestApi.signatureRequestGet",
localVarPath,
"GET",
new ArrayList<>(),
null,
new LinkedHashMap<>(),
new LinkedHashMap<>(),
localVarFormParams,
localVarAccept,
localVarContentType,
localVarAuthNames,
localVarReturnType,
false
);
}
/**
* List Signature Requests
* Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on. Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests.