-
Notifications
You must be signed in to change notification settings - Fork 18
Expand file tree
/
Copy pathTemplateApi.cs
More file actions
3012 lines (2650 loc) · 195 KB
/
TemplateApi.cs
File metadata and controls
3012 lines (2650 loc) · 195 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
/*
* Dropbox Sign API
*
* Dropbox Sign v3 API
*
* The version of the OpenAPI document: 3.0.0
* Contact: apisupport@hellosign.com
* Generated by: https://github.com/openapitools/openapi-generator.git
*/
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Net;
using System.Net.Mime;
using Dropbox.Sign.Client;
using Dropbox.Sign.Model;
namespace Dropbox.Sign.Api
{
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public interface ITemplateApiSync : IApiAccessor
{
#region Synchronous Operations
/// <summary>
/// Add User to Template
/// </summary>
/// <remarks>
/// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateGetResponse</returns>
TemplateGetResponse TemplateAddUser(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0);
/// <summary>
/// Add User to Template
/// </summary>
/// <remarks>
/// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateGetResponse</returns>
ApiResponse<TemplateGetResponse> TemplateAddUserWithHttpInfo(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0);
/// <summary>
/// Create Template
/// </summary>
/// <remarks>
/// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateCreateResponse</returns>
TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreateRequest, int operationIndex = 0);
/// <summary>
/// Create Template
/// </summary>
/// <remarks>
/// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateCreateResponse</returns>
ApiResponse<TemplateCreateResponse> TemplateCreateWithHttpInfo(TemplateCreateRequest templateCreateRequest, int operationIndex = 0);
/// <summary>
/// Create Embedded Template Draft
/// </summary>
/// <remarks>
/// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateEmbeddedDraftRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateCreateEmbeddedDraftResponse</returns>
TemplateCreateEmbeddedDraftResponse TemplateCreateEmbeddedDraft(TemplateCreateEmbeddedDraftRequest templateCreateEmbeddedDraftRequest, int operationIndex = 0);
/// <summary>
/// Create Embedded Template Draft
/// </summary>
/// <remarks>
/// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateEmbeddedDraftRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateCreateEmbeddedDraftResponse</returns>
ApiResponse<TemplateCreateEmbeddedDraftResponse> TemplateCreateEmbeddedDraftWithHttpInfo(TemplateCreateEmbeddedDraftRequest templateCreateEmbeddedDraftRequest, int operationIndex = 0);
/// <summary>
/// Delete Template
/// </summary>
/// <remarks>
/// Completely deletes the template specified from the account.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to delete.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns></returns>
void TemplateDelete(string templateId, int operationIndex = 0);
/// <summary>
/// Delete Template
/// </summary>
/// <remarks>
/// Completely deletes the template specified from the account.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to delete.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of Object(void)</returns>
ApiResponse<Object> TemplateDeleteWithHttpInfo(string templateId, int operationIndex = 0);
/// <summary>
/// Get Template Files
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="fileType">Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>System.IO.Stream</returns>
System.IO.Stream TemplateFiles(string templateId, string? fileType = default(string?), int operationIndex = 0);
/// <summary>
/// Get Template Files
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="fileType">Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of System.IO.Stream</returns>
ApiResponse<System.IO.Stream> TemplateFilesWithHttpInfo(string templateId, string? fileType = default(string?), int operationIndex = 0);
/// <summary>
/// Get Template Files as Data Uri
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>FileResponseDataUri</returns>
FileResponseDataUri TemplateFilesAsDataUri(string templateId, int operationIndex = 0);
/// <summary>
/// Get Template Files as Data Uri
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of FileResponseDataUri</returns>
ApiResponse<FileResponseDataUri> TemplateFilesAsDataUriWithHttpInfo(string templateId, int operationIndex = 0);
/// <summary>
/// Get Template Files as File Url
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="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)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>FileResponse</returns>
FileResponse TemplateFilesAsFileUrl(string templateId, int? forceDownload = default(int?), int operationIndex = 0);
/// <summary>
/// Get Template Files as File Url
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="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)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of FileResponse</returns>
ApiResponse<FileResponse> TemplateFilesAsFileUrlWithHttpInfo(string templateId, int? forceDownload = default(int?), int operationIndex = 0);
/// <summary>
/// Get Template
/// </summary>
/// <remarks>
/// Returns the Template specified by the `template_id` parameter.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateGetResponse</returns>
TemplateGetResponse TemplateGet(string templateId, int operationIndex = 0);
/// <summary>
/// Get Template
/// </summary>
/// <remarks>
/// Returns the Template specified by the `template_id` parameter.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateGetResponse</returns>
ApiResponse<TemplateGetResponse> TemplateGetWithHttpInfo(string templateId, int operationIndex = 0);
/// <summary>
/// List Templates
/// </summary>
/// <remarks>
/// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountId">Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)</param>
/// <param name="page">Which page number of the Template List to return. Defaults to `1`. (optional, default to 1)</param>
/// <param name="pageSize">Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)</param>
/// <param name="query">String that includes search terms and/or fields to be used to filter the Template objects. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateListResponse</returns>
TemplateListResponse TemplateList(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), string? query = default(string?), int operationIndex = 0);
/// <summary>
/// List Templates
/// </summary>
/// <remarks>
/// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountId">Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)</param>
/// <param name="page">Which page number of the Template List to return. Defaults to `1`. (optional, default to 1)</param>
/// <param name="pageSize">Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)</param>
/// <param name="query">String that includes search terms and/or fields to be used to filter the Template objects. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateListResponse</returns>
ApiResponse<TemplateListResponse> TemplateListWithHttpInfo(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), string? query = default(string?), int operationIndex = 0);
/// <summary>
/// Remove User from Template
/// </summary>
/// <remarks>
/// Removes the specified Account's access to the specified Template.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to remove the Account's access to.</param>
/// <param name="templateRemoveUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateGetResponse</returns>
TemplateGetResponse TemplateRemoveUser(string templateId, TemplateRemoveUserRequest templateRemoveUserRequest, int operationIndex = 0);
/// <summary>
/// Remove User from Template
/// </summary>
/// <remarks>
/// Removes the specified Account's access to the specified Template.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to remove the Account's access to.</param>
/// <param name="templateRemoveUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateGetResponse</returns>
ApiResponse<TemplateGetResponse> TemplateRemoveUserWithHttpInfo(string templateId, TemplateRemoveUserRequest templateRemoveUserRequest, int operationIndex = 0);
/// <summary>
/// Update Template
/// </summary>
/// <remarks>
/// Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template to update.</param>
/// <param name="templateUpdateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateGetResponse</returns>
TemplateGetResponse TemplateUpdate(string templateId, TemplateUpdateRequest templateUpdateRequest, int operationIndex = 0);
/// <summary>
/// Update Template
/// </summary>
/// <remarks>
/// Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template to update.</param>
/// <param name="templateUpdateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateGetResponse</returns>
ApiResponse<TemplateGetResponse> TemplateUpdateWithHttpInfo(string templateId, TemplateUpdateRequest templateUpdateRequest, int operationIndex = 0);
/// <summary>
/// Update Template Files
/// </summary>
/// <remarks>
/// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template whose files to update.</param>
/// <param name="templateUpdateFilesRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateUpdateFilesResponse</returns>
TemplateUpdateFilesResponse TemplateUpdateFiles(string templateId, TemplateUpdateFilesRequest templateUpdateFilesRequest, int operationIndex = 0);
/// <summary>
/// Update Template Files
/// </summary>
/// <remarks>
/// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template whose files to update.</param>
/// <param name="templateUpdateFilesRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateUpdateFilesResponse</returns>
ApiResponse<TemplateUpdateFilesResponse> TemplateUpdateFilesWithHttpInfo(string templateId, TemplateUpdateFilesRequest templateUpdateFilesRequest, int operationIndex = 0);
#endregion Synchronous Operations
}
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public interface ITemplateApiAsync : IApiAccessor
{
#region Asynchronous Operations
/// <summary>
/// Add User to Template
/// </summary>
/// <remarks>
/// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateGetResponse</returns>
System.Threading.Tasks.Task<TemplateGetResponse> TemplateAddUserAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Add User to Template
/// </summary>
/// <remarks>
/// Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateGetResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateGetResponse>> TemplateAddUserWithHttpInfoAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Create Template
/// </summary>
/// <remarks>
/// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateCreateResponse</returns>
System.Threading.Tasks.Task<TemplateCreateResponse> TemplateCreateAsync(TemplateCreateRequest templateCreateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Create Template
/// </summary>
/// <remarks>
/// Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateCreateResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateCreateResponse>> TemplateCreateWithHttpInfoAsync(TemplateCreateRequest templateCreateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Create Embedded Template Draft
/// </summary>
/// <remarks>
/// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateEmbeddedDraftRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateCreateEmbeddedDraftResponse</returns>
System.Threading.Tasks.Task<TemplateCreateEmbeddedDraftResponse> TemplateCreateEmbeddedDraftAsync(TemplateCreateEmbeddedDraftRequest templateCreateEmbeddedDraftRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Create Embedded Template Draft
/// </summary>
/// <remarks>
/// The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateEmbeddedDraftRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateCreateEmbeddedDraftResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateCreateEmbeddedDraftResponse>> TemplateCreateEmbeddedDraftWithHttpInfoAsync(TemplateCreateEmbeddedDraftRequest templateCreateEmbeddedDraftRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Delete Template
/// </summary>
/// <remarks>
/// Completely deletes the template specified from the account.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to delete.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of void</returns>
System.Threading.Tasks.Task TemplateDeleteAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Delete Template
/// </summary>
/// <remarks>
/// Completely deletes the template specified from the account.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to delete.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse</returns>
System.Threading.Tasks.Task<ApiResponse<Object>> TemplateDeleteWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="fileType">Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of System.IO.Stream</returns>
System.Threading.Tasks.Task<System.IO.Stream> TemplateFilesAsync(string templateId, string? fileType = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="fileType">Set to `pdf` for a single merged document or `zip` for a collection of individual documents. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (System.IO.Stream)</returns>
System.Threading.Tasks.Task<ApiResponse<System.IO.Stream>> TemplateFilesWithHttpInfoAsync(string templateId, string? fileType = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files as Data Uri
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of FileResponseDataUri</returns>
System.Threading.Tasks.Task<FileResponseDataUri> TemplateFilesAsDataUriAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files as Data Uri
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (FileResponseDataUri)</returns>
System.Threading.Tasks.Task<ApiResponse<FileResponseDataUri>> TemplateFilesAsDataUriWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files as File Url
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="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)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of FileResponse</returns>
System.Threading.Tasks.Task<FileResponse> TemplateFilesAsFileUrlAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template Files as File Url
/// </summary>
/// <remarks>
/// Obtain a copy of the current documents specified by the `template_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. In this case please wait for the `template_created` callback event.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the template files to retrieve.</param>
/// <param name="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)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (FileResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<FileResponse>> TemplateFilesAsFileUrlWithHttpInfoAsync(string templateId, int? forceDownload = default(int?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template
/// </summary>
/// <remarks>
/// Returns the Template specified by the `template_id` parameter.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateGetResponse</returns>
System.Threading.Tasks.Task<TemplateGetResponse> TemplateGetAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Get Template
/// </summary>
/// <remarks>
/// Returns the Template specified by the `template_id` parameter.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to retrieve.</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateGetResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateGetResponse>> TemplateGetWithHttpInfoAsync(string templateId, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// List Templates
/// </summary>
/// <remarks>
/// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountId">Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)</param>
/// <param name="page">Which page number of the Template List to return. Defaults to `1`. (optional, default to 1)</param>
/// <param name="pageSize">Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)</param>
/// <param name="query">String that includes search terms and/or fields to be used to filter the Template objects. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateListResponse</returns>
System.Threading.Tasks.Task<TemplateListResponse> TemplateListAsync(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), string? query = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// List Templates
/// </summary>
/// <remarks>
/// Returns a list of the Templates that are accessible by you. Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountId">Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. (optional)</param>
/// <param name="page">Which page number of the Template List to return. Defaults to `1`. (optional, default to 1)</param>
/// <param name="pageSize">Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. (optional, default to 20)</param>
/// <param name="query">String that includes search terms and/or fields to be used to filter the Template objects. (optional)</param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateListResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateListResponse>> TemplateListWithHttpInfoAsync(string? accountId = default(string?), int? page = default(int?), int? pageSize = default(int?), string? query = default(string?), int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Remove User from Template
/// </summary>
/// <remarks>
/// Removes the specified Account's access to the specified Template.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to remove the Account's access to.</param>
/// <param name="templateRemoveUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateGetResponse</returns>
System.Threading.Tasks.Task<TemplateGetResponse> TemplateRemoveUserAsync(string templateId, TemplateRemoveUserRequest templateRemoveUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Remove User from Template
/// </summary>
/// <remarks>
/// Removes the specified Account's access to the specified Template.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to remove the Account's access to.</param>
/// <param name="templateRemoveUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateGetResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateGetResponse>> TemplateRemoveUserWithHttpInfoAsync(string templateId, TemplateRemoveUserRequest templateRemoveUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Update Template
/// </summary>
/// <remarks>
/// Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template to update.</param>
/// <param name="templateUpdateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateGetResponse</returns>
System.Threading.Tasks.Task<TemplateGetResponse> TemplateUpdateAsync(string templateId, TemplateUpdateRequest templateUpdateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Update Template
/// </summary>
/// <remarks>
/// Update template fields. Every field is optional and the endpoint will only change whatever is provided. The fields not included in the request payload will remain unchanged.
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template to update.</param>
/// <param name="templateUpdateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateGetResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateGetResponse>> TemplateUpdateWithHttpInfoAsync(string templateId, TemplateUpdateRequest templateUpdateRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Update Template Files
/// </summary>
/// <remarks>
/// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template whose files to update.</param>
/// <param name="templateUpdateFilesRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateUpdateFilesResponse</returns>
System.Threading.Tasks.Task<TemplateUpdateFilesResponse> TemplateUpdateFilesAsync(string templateId, TemplateUpdateFilesRequest templateUpdateFilesRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
/// <summary>
/// Update Template Files
/// </summary>
/// <remarks>
/// Overlays a new file with the overlay of an existing template. The new file(s) must: 1. have the same or higher page count 2. the same orientation as the file(s) being replaced. This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota. Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. 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 and retry the request if necessary. If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
/// </remarks>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The ID of the template whose files to update.</param>
/// <param name="templateUpdateFilesRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateUpdateFilesResponse)</returns>
System.Threading.Tasks.Task<ApiResponse<TemplateUpdateFilesResponse>> TemplateUpdateFilesWithHttpInfoAsync(string templateId, TemplateUpdateFilesRequest templateUpdateFilesRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken));
#endregion Asynchronous Operations
}
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public interface ITemplateApi : ITemplateApiSync, ITemplateApiAsync
{
}
/// <summary>
/// Represents a collection of functions to interact with the API endpoints
/// </summary>
public partial class TemplateApi : ITemplateApi
{
private Dropbox.Sign.Client.ExceptionFactory _exceptionFactory = (name, response) => null;
/// <summary>
/// Initializes a new instance of the <see cref="TemplateApi"/> class.
/// </summary>
/// <returns></returns>
public TemplateApi() : this((string)null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="TemplateApi"/> class.
/// </summary>
/// <returns></returns>
public TemplateApi(string basePath)
{
this.Configuration = Dropbox.Sign.Client.Configuration.MergeConfigurations(
Dropbox.Sign.Client.GlobalConfiguration.Instance,
new Dropbox.Sign.Client.Configuration { BasePath = basePath }
);
this.Client = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath);
this.AsynchronousClient = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath);
this.ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory;
}
/// <summary>
/// Initializes a new instance of the <see cref="TemplateApi"/> class
/// using Configuration object
/// </summary>
/// <param name="configuration">An instance of Configuration</param>
/// <returns></returns>
public TemplateApi(Dropbox.Sign.Client.Configuration configuration)
{
if (configuration == null) throw new ArgumentNullException("configuration");
this.Configuration = Dropbox.Sign.Client.Configuration.MergeConfigurations(
Dropbox.Sign.Client.GlobalConfiguration.Instance,
configuration
);
this.Client = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath);
this.AsynchronousClient = new Dropbox.Sign.Client.ApiClient(this.Configuration.BasePath);
ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory;
}
/// <summary>
/// Initializes a new instance of the <see cref="TemplateApi"/> class
/// using a Configuration object and client instance.
/// </summary>
/// <param name="client">The client interface for synchronous API access.</param>
/// <param name="asyncClient">The client interface for asynchronous API access.</param>
/// <param name="configuration">The configuration object.</param>
public TemplateApi(Dropbox.Sign.Client.ISynchronousClient client, Dropbox.Sign.Client.IAsynchronousClient asyncClient, Dropbox.Sign.Client.IReadableConfiguration configuration)
{
if (client == null) throw new ArgumentNullException("client");
if (asyncClient == null) throw new ArgumentNullException("asyncClient");
if (configuration == null) throw new ArgumentNullException("configuration");
this.Client = client;
this.AsynchronousClient = asyncClient;
this.Configuration = configuration;
this.ExceptionFactory = Dropbox.Sign.Client.Configuration.DefaultExceptionFactory;
}
/// <summary>
/// The client for accessing this underlying API asynchronously.
/// </summary>
public Dropbox.Sign.Client.IAsynchronousClient AsynchronousClient { get; set; }
/// <summary>
/// The client for accessing this underlying API synchronously.
/// </summary>
public Dropbox.Sign.Client.ISynchronousClient Client { get; set; }
/// <summary>
/// Gets the base path of the API client.
/// </summary>
/// <value>The base path</value>
public string GetBasePath()
{
return this.Configuration.BasePath;
}
/// <summary>
/// Gets or sets the configuration object
/// </summary>
/// <value>An instance of the Configuration</value>
public Dropbox.Sign.Client.IReadableConfiguration Configuration { get; set; }
/// <summary>
/// Provides a factory method hook for the creation of exceptions.
/// </summary>
public Dropbox.Sign.Client.ExceptionFactory ExceptionFactory
{
get
{
if (_exceptionFactory != null && _exceptionFactory.GetInvocationList().Length > 1)
{
throw new InvalidOperationException("Multicast delegate for ExceptionFactory is unsupported.");
}
return _exceptionFactory;
}
set { _exceptionFactory = value; }
}
/// <summary>
/// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateGetResponse</returns>
public TemplateGetResponse TemplateAddUser(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0)
{
Dropbox.Sign.Client.ApiResponse<TemplateGetResponse> localVarResponse = TemplateAddUserWithHttpInfo(templateId, templateAddUserRequest);
return localVarResponse.Data;
}
/// <summary>
/// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateGetResponse</returns>
public Dropbox.Sign.Client.ApiResponse<TemplateGetResponse> TemplateAddUserWithHttpInfo(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0)
{
// verify the required parameter 'templateId' is set
if (templateId == null)
{
throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'templateId' when calling TemplateApi->TemplateAddUser");
}
// verify the required parameter 'templateAddUserRequest' is set
if (templateAddUserRequest == null)
{
throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'templateAddUserRequest' when calling TemplateApi->TemplateAddUser");
}
Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions();
var localVarContentType = "";
var openApiTypes = templateAddUserRequest.GetOpenApiTypes();
if (ClientUtils.HasFileType(openApiTypes))
{
ClientUtils.SetFormData(localVarRequestOptions, openApiTypes);
localVarContentType = "multipart/form-data";
}
else
{
localVarContentType = "application/json";
localVarRequestOptions.Data = templateAddUserRequest;
}
// to determine the Accept header
string[] _accepts = new string[] {
"application/json"
};
if (localVarContentType != null)
{
localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType);
}
var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts);
if (localVarAccept != null)
{
localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);
}
localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter
localVarRequestOptions.Operation = "TemplateApi.TemplateAddUser";
localVarRequestOptions.OperationIndex = operationIndex;
// authentication (api_key) required
// http basic authentication required
if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization"))
{
localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password));
}
// authentication (oauth2) required
// bearer authentication required
if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization"))
{
localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken);
}
// make the HTTP request
var localVarResponse = this.Client.Post<TemplateGetResponse>("/template/add_user/{template_id}", localVarRequestOptions, this.Configuration);
if (this.ExceptionFactory != null)
{
Exception _exception = this.ExceptionFactory("TemplateAddUser", localVarResponse);
if (_exception != null)
{
throw _exception;
}
}
return localVarResponse;
}
/// <summary>
/// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of TemplateGetResponse</returns>
public async System.Threading.Tasks.Task<TemplateGetResponse> TemplateAddUserAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken))
{
Dropbox.Sign.Client.ApiResponse<TemplateGetResponse> localVarResponse = await TemplateAddUserWithHttpInfoAsync(templateId, templateAddUserRequest, operationIndex, cancellationToken).ConfigureAwait(false);
return localVarResponse.Data;
}
/// <summary>
/// Add User to Template Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateId">The id of the Template to give the Account access to.</param>
/// <param name="templateAddUserRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of ApiResponse (TemplateGetResponse)</returns>
public async System.Threading.Tasks.Task<Dropbox.Sign.Client.ApiResponse<TemplateGetResponse>> TemplateAddUserWithHttpInfoAsync(string templateId, TemplateAddUserRequest templateAddUserRequest, int operationIndex = 0, System.Threading.CancellationToken cancellationToken = default(global::System.Threading.CancellationToken))
{
// verify the required parameter 'templateId' is set
if (templateId == null)
{
throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'templateId' when calling TemplateApi->TemplateAddUser");
}
// verify the required parameter 'templateAddUserRequest' is set
if (templateAddUserRequest == null)
{
throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'templateAddUserRequest' when calling TemplateApi->TemplateAddUser");
}
Dropbox.Sign.Client.RequestOptions localVarRequestOptions = new Dropbox.Sign.Client.RequestOptions();
var localVarContentType = "";
var openApiTypes = templateAddUserRequest.GetOpenApiTypes();
if (ClientUtils.HasFileType(openApiTypes))
{
ClientUtils.SetFormData(localVarRequestOptions, openApiTypes);
localVarContentType = "multipart/form-data";
}
else
{
localVarContentType = "application/json";
localVarRequestOptions.Data = templateAddUserRequest;
}
// to determine the Accept header
string[] _accepts = new string[] {
"application/json"
};
if (localVarContentType != null)
{
localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType);
}
var localVarAccept = Dropbox.Sign.Client.ClientUtils.SelectHeaderAccept(_accepts);
if (localVarAccept != null)
{
localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);
}
localVarRequestOptions.PathParameters.Add("template_id", Dropbox.Sign.Client.ClientUtils.ParameterToString(templateId)); // path parameter
localVarRequestOptions.Operation = "TemplateApi.TemplateAddUser";
localVarRequestOptions.OperationIndex = operationIndex;
// authentication (api_key) required
// http basic authentication required
if (!string.IsNullOrEmpty(this.Configuration.Username) || !string.IsNullOrEmpty(this.Configuration.Password) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization"))
{
localVarRequestOptions.HeaderParameters.Add("Authorization", "Basic " + Dropbox.Sign.Client.ClientUtils.Base64Encode(this.Configuration.Username + ":" + this.Configuration.Password));
}
// authentication (oauth2) required
// bearer authentication required
if (!string.IsNullOrEmpty(this.Configuration.AccessToken) && !localVarRequestOptions.HeaderParameters.ContainsKey("Authorization"))
{
localVarRequestOptions.HeaderParameters.Add("Authorization", "Bearer " + this.Configuration.AccessToken);
}
// make the HTTP request
var localVarResponse = await this.AsynchronousClient.PostAsync<TemplateGetResponse>("/template/add_user/{template_id}", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false);
if (this.ExceptionFactory != null)
{
Exception _exception = this.ExceptionFactory("TemplateAddUser", localVarResponse);
if (_exception != null)
{
throw _exception;
}
}
return localVarResponse;
}
/// <summary>
/// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>TemplateCreateResponse</returns>
public TemplateCreateResponse TemplateCreate(TemplateCreateRequest templateCreateRequest, int operationIndex = 0)
{
Dropbox.Sign.Client.ApiResponse<TemplateCreateResponse> localVarResponse = TemplateCreateWithHttpInfo(templateCreateRequest);
return localVarResponse.Data;
}
/// <summary>
/// Create Template Creates a template that can be used in future signature requests. If `client_id` is provided, the template will be created as an embedded template. Embedded templates can be used for embedded signature requests and can be edited later by generating a new `edit_url` with [/embedded/edit_url/{template_id}](/api/reference/operation/embeddedEditUrl/). Template creation may complete asynchronously after the initial request is accepted. It is recommended that a callback be implemented to listen for the callback event. A `template_created` event indicates the template is ready to use, while a `template_error` event indicates there was a problem while creating the template. 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 and retry the request if necessary.
/// </summary>
/// <exception cref="Dropbox.Sign.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="templateCreateRequest"></param>
/// <param name="operationIndex">Index associated with the operation.</param>
/// <returns>ApiResponse of TemplateCreateResponse</returns>
public Dropbox.Sign.Client.ApiResponse<TemplateCreateResponse> TemplateCreateWithHttpInfo(TemplateCreateRequest templateCreateRequest, int operationIndex = 0)
{
// verify the required parameter 'templateCreateRequest' is set
if (templateCreateRequest == null)
{
throw new Dropbox.Sign.Client.ApiException(400, "Missing required parameter 'templateCreateRequest' when calling TemplateApi->TemplateCreate");
}