-
Notifications
You must be signed in to change notification settings - Fork 16
/
dropbox.d.ts
1438 lines (1305 loc) · 61 KB
/
dropbox.d.ts
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
/// <reference path="./dropbox_types.d.ts"/>
declare module DropboxTypes {
export class Dropbox extends DropboxBase {
/**
* The Dropbox SDK class.
*/
constructor(options: DropboxOptions);
/**
* Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access
* token.
*
* When an error occurs, the route rejects the promise with type
* Error<auth.TokenFromOAuth1Error>.
* @param arg The request parameters.
*/
public authTokenFromOauth1(arg: auth.TokenFromOAuth1Arg): Promise<auth.TokenFromOAuth1Result>;
/**
* Disables the access token used to authenticate the call.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public authTokenRevoke(arg: void): Promise<void>;
/**
* Add property groups to a Dropbox file. See templatesAddForUser() or
* templatesAddForTeam() to create new templates.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.AddPropertiesError>.
* @param arg The request parameters.
*/
public filePropertiesPropertiesAdd(arg: file_properties.AddPropertiesArg): Promise<void>;
/**
* Overwrite property groups associated with a file. This endpoint should be
* used instead of propertiesUpdate() when property groups are being updated
* via a "snapshot" instead of via a "delta". In other words, this endpoint
* will delete all omitted fields from a property group, whereas
* propertiesUpdate() will only delete fields that are explicitly marked for
* deletion.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.InvalidPropertyGroupError>.
* @param arg The request parameters.
*/
public filePropertiesPropertiesOverwrite(arg: file_properties.OverwritePropertyGroupArg): Promise<void>;
/**
* Remove the specified property group from the file. To remove specific
* property field key value pairs, see route propertiesUpdate(). To update a
* template, see templatesUpdateForUser() or templatesUpdateForTeam().
* Templates can't be removed once created.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.RemovePropertiesError>.
* @param arg The request parameters.
*/
public filePropertiesPropertiesRemove(arg: file_properties.RemovePropertiesArg): Promise<void>;
/**
* Search across property templates for particular property field values.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.PropertiesSearchError>.
* @param arg The request parameters.
*/
public filePropertiesPropertiesSearch(arg: file_properties.PropertiesSearchArg): Promise<file_properties.PropertiesSearchResult>;
/**
* Add, update or remove properties associated with the supplied file and
* templates. This endpoint should be used instead of propertiesOverwrite()
* when property groups are being updated via a "delta" instead of via a
* "snapshot" . In other words, this endpoint will not delete any omitted
* fields from a property group, whereas propertiesOverwrite() will delete
* any fields that are omitted from a property group.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.UpdatePropertiesError>.
* @param arg The request parameters.
*/
public filePropertiesPropertiesUpdate(arg: file_properties.UpdatePropertiesArg): Promise<void>;
/**
* Add a template associated with a team. See route propertiesAdd() to add
* properties to a file or folder.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.ModifyTemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesAddForTeam(arg: file_properties.AddTemplateArg): Promise<file_properties.AddTemplateResult>;
/**
* Add a template associated with a user. See route propertiesAdd() to add
* properties to a file.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.ModifyTemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesAddForUser(arg: file_properties.AddTemplateArg): Promise<file_properties.AddTemplateResult>;
/**
* Get the schema for a specified template.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesGetForTeam(arg: file_properties.GetTemplateArg): Promise<file_properties.GetTemplateResult>;
/**
* Get the schema for a specified template.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesGetForUser(arg: file_properties.GetTemplateArg): Promise<file_properties.GetTemplateResult>;
/**
* Get the template identifiers for a team. To get the schema of each
* template use templatesGetForTeam().
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesListForTeam(arg: void): Promise<file_properties.ListTemplateResult>;
/**
* Get the template identifiers for a team. To get the schema of each
* template use templatesGetForUser().
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesListForUser(arg: void): Promise<file_properties.ListTemplateResult>;
/**
* Update a template associated with a team. This route can update the
* template name, the template description and add optional properties to
* templates.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.ModifyTemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesUpdateForTeam(arg: file_properties.UpdateTemplateArg): Promise<file_properties.UpdateTemplateResult>;
/**
* Update a template associated with a user. This route can update the
* template name, the template description and add optional properties to
* templates.
*
* When an error occurs, the route rejects the promise with type
* Error<file_properties.ModifyTemplateError>.
* @param arg The request parameters.
*/
public filePropertiesTemplatesUpdateForUser(arg: file_properties.UpdateTemplateArg): Promise<file_properties.UpdateTemplateResult>;
/**
* Creates a file request for this user.
*
* When an error occurs, the route rejects the promise with type
* Error<file_requests.CreateFileRequestError>.
* @param arg The request parameters.
*/
public fileRequestsCreate(arg: file_requests.CreateFileRequestArgs): Promise<file_requests.FileRequest>;
/**
* Returns the specified file request.
*
* When an error occurs, the route rejects the promise with type
* Error<file_requests.GetFileRequestError>.
* @param arg The request parameters.
*/
public fileRequestsGet(arg: file_requests.GetFileRequestArgs): Promise<file_requests.FileRequest>;
/**
* Returns a list of file requests owned by this user. For apps with the app
* folder permission, this will only return file requests with destinations
* in the app folder.
*
* When an error occurs, the route rejects the promise with type
* Error<file_requests.ListFileRequestsError>.
* @param arg The request parameters.
*/
public fileRequestsList(arg: void): Promise<file_requests.ListFileRequestsResult>;
/**
* Update a file request.
*
* When an error occurs, the route rejects the promise with type
* Error<file_requests.UpdateFileRequestError>.
* @param arg The request parameters.
*/
public fileRequestsUpdate(arg: file_requests.UpdateFileRequestArgs): Promise<file_requests.FileRequest>;
/**
* Returns the metadata for a file or folder. This is an alpha endpoint
* compatible with the properties API. Note: Metadata for the root folder is
* unsupported.
*
* When an error occurs, the route rejects the promise with type
* Error<files.AlphaGetMetadataError>.
* @param arg The request parameters.
*/
public filesAlphaGetMetadata(arg: files.AlphaGetMetadataArg): Promise<files.FileMetadataReference|files.FolderMetadataReference|files.DeletedMetadataReference>;
/**
* Create a new file with the contents provided in the request. Note that
* this endpoint is part of the properties API alpha and is slightly
* different from upload(). Do not use this to upload a file larger than 150
* MB. Instead, create an upload session with uploadSessionStart().
*
* When an error occurs, the route rejects the promise with type
* Error<files.UploadErrorWithProperties>.
* @param arg The request parameters.
*/
public filesAlphaUpload(arg: files.CommitInfoWithProperties): Promise<files.FileMetadata>;
/**
* Copy a file or folder to a different location in the user's Dropbox. If
* the source path is a folder all its contents will be copied.
*
* When an error occurs, the route rejects the promise with type
* Error<files.RelocationError>.
* @deprecated
* @param arg The request parameters.
*/
public filesCopy(arg: files.RelocationArg): Promise<files.FileMetadataReference|files.FolderMetadataReference|files.DeletedMetadataReference>;
/**
* Copy multiple files or folders to different locations at once in the
* user's Dropbox. If RelocationBatchArg.allow_shared_folder is false, this
* route is atomic. If on entry failes, the whole transaction will abort. If
* RelocationBatchArg.allow_shared_folder is true, not atomicity is
* guaranteed, but you will be able to copy the contents of shared folders
* to new locations. This route will return job ID immediately and do the
* async copy job in background. Please use copyBatchCheck() to check the
* job status.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public filesCopyBatch(arg: files.RelocationBatchArg): Promise<files.RelocationBatchLaunch>;
/**
* Returns the status of an asynchronous job for copyBatch(). If success, it
* returns list of results for each entry.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public filesCopyBatchCheck(arg: async.PollArg): Promise<files.RelocationBatchJobStatus>;
/**
* Get a copy reference to a file or folder. This reference string can be
* used to save that file or folder to another user's Dropbox by passing it
* to copyReferenceSave().
*
* When an error occurs, the route rejects the promise with type
* Error<files.GetCopyReferenceError>.
* @param arg The request parameters.
*/
public filesCopyReferenceGet(arg: files.GetCopyReferenceArg): Promise<files.GetCopyReferenceResult>;
/**
* Save a copy reference returned by copyReferenceGet() to the user's
* Dropbox.
*
* When an error occurs, the route rejects the promise with type
* Error<files.SaveCopyReferenceError>.
* @param arg The request parameters.
*/
public filesCopyReferenceSave(arg: files.SaveCopyReferenceArg): Promise<files.SaveCopyReferenceResult>;
/**
* Copy a file or folder to a different location in the user's Dropbox. If
* the source path is a folder all its contents will be copied.
*
* When an error occurs, the route rejects the promise with type
* Error<files.RelocationError>.
* @param arg The request parameters.
*/
public filesCopyV2(arg: files.RelocationArg): Promise<files.RelocationResult>;
/**
* Create a folder at a given path.
*
* When an error occurs, the route rejects the promise with type
* Error<files.CreateFolderError>.
* @deprecated
* @param arg The request parameters.
*/
public filesCreateFolder(arg: files.CreateFolderArg): Promise<files.FolderMetadata>;
/**
* Create a folder at a given path.
*
* When an error occurs, the route rejects the promise with type
* Error<files.CreateFolderError>.
* @param arg The request parameters.
*/
public filesCreateFolderV2(arg: files.CreateFolderArg): Promise<files.CreateFolderResult>;
/**
* Delete the file or folder at a given path. If the path is a folder, all
* its contents will be deleted too. A successful response indicates that
* the file or folder was deleted. The returned metadata will be the
* corresponding FileMetadata or FolderMetadata for the item at time of
* deletion, and not a DeletedMetadata object.
*
* When an error occurs, the route rejects the promise with type
* Error<files.DeleteError>.
* @deprecated
* @param arg The request parameters.
*/
public filesDelete(arg: files.DeleteArg): Promise<files.FileMetadataReference|files.FolderMetadataReference|files.DeletedMetadataReference>;
/**
* Delete multiple files/folders at once. This route is asynchronous, which
* returns a job ID immediately and runs the delete batch asynchronously.
* Use deleteBatchCheck() to check the job status.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public filesDeleteBatch(arg: files.DeleteBatchArg): Promise<files.DeleteBatchLaunch>;
/**
* Returns the status of an asynchronous job for deleteBatch(). If success,
* it returns list of result for each entry.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public filesDeleteBatchCheck(arg: async.PollArg): Promise<files.DeleteBatchJobStatus>;
/**
* Delete the file or folder at a given path. If the path is a folder, all
* its contents will be deleted too. A successful response indicates that
* the file or folder was deleted. The returned metadata will be the
* corresponding FileMetadata or FolderMetadata for the item at time of
* deletion, and not a DeletedMetadata object.
*
* When an error occurs, the route rejects the promise with type
* Error<files.DeleteError>.
* @param arg The request parameters.
*/
public filesDeleteV2(arg: files.DeleteArg): Promise<files.DeleteResult>;
/**
* Download a file from a user's Dropbox.
*
* When an error occurs, the route rejects the promise with type
* Error<files.DownloadError>.
* @param arg The request parameters.
*/
public filesDownload(arg: files.DownloadArg): Promise<files.FileMetadata>;
/**
* Returns the metadata for a file or folder. Note: Metadata for the root
* folder is unsupported.
*
* When an error occurs, the route rejects the promise with type
* Error<files.GetMetadataError>.
* @param arg The request parameters.
*/
public filesGetMetadata(arg: files.GetMetadataArg): Promise<files.FileMetadataReference|files.FolderMetadataReference|files.DeletedMetadataReference>;
/**
* Get a preview for a file. Currently, PDF previews are generated for files
* with the following extensions: .ai, .doc, .docm, .docx, .eps, .odp, .odt,
* .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. HTML previews are generated
* for files with the following extensions: .csv, .ods, .xls, .xlsm, .xlsx.
* Other formats will return an unsupported extension error.
*
* When an error occurs, the route rejects the promise with type
* Error<files.PreviewError>.
* @param arg The request parameters.
*/
public filesGetPreview(arg: files.PreviewArg): Promise<files.FileMetadata>;
/**
* Get a temporary link to stream content of a file. This link will expire
* in four hours and afterwards you will get 410 Gone. Content-Type of the
* link is determined automatically by the file's mime type.
*
* When an error occurs, the route rejects the promise with type
* Error<files.GetTemporaryLinkError>.
* @param arg The request parameters.
*/
public filesGetTemporaryLink(arg: files.GetTemporaryLinkArg): Promise<files.GetTemporaryLinkResult>;
/**
* Get a thumbnail for an image. This method currently supports files with
* the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp.
* Photos that are larger than 20MB in size won't be converted to a
* thumbnail.
*
* When an error occurs, the route rejects the promise with type
* Error<files.ThumbnailError>.
* @param arg The request parameters.
*/
public filesGetThumbnail(arg: files.ThumbnailArg): Promise<files.FileMetadata>;
/**
* Get thumbnails for a list of images. We allow up to 25 thumbnails in a
* single batch. This method currently supports files with the following
* file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are
* larger than 20MB in size won't be converted to a thumbnail.
*
* When an error occurs, the route rejects the promise with type
* Error<files.GetThumbnailBatchError>.
* @param arg The request parameters.
*/
public filesGetThumbnailBatch(arg: files.GetThumbnailBatchArg): Promise<files.GetThumbnailBatchResult>;
/**
* Starts returning the contents of a folder. If the result's
* ListFolderResult.has_more field is true, call listFolderContinue() with
* the returned ListFolderResult.cursor to retrieve more entries. If you're
* using ListFolderArg.recursive set to true to keep a local cache of the
* contents of a Dropbox account, iterate through each entry in order and
* process them as follows to keep your local state in sync: For each
* FileMetadata, store the new entry at the given path in your local state.
* If the required parent folders don't exist yet, create them. If there's
* already something else at the given path, replace it and remove all its
* children. For each FolderMetadata, store the new entry at the given path
* in your local state. If the required parent folders don't exist yet,
* create them. If there's already something else at the given path, replace
* it but leave the children as they are. Check the new entry's
* FolderSharingInfo.read_only and set all its children's read-only statuses
* to match. For each DeletedMetadata, if your local state has something at
* the given path, remove it and all its children. If there's nothing at the
* given path, ignore this entry. Note: auth.RateLimitError may be returned
* if multiple listFolder() or listFolderContinue() calls with same
* parameters are made simultaneously by same API app for same user. If your
* app implements retry logic, please hold off the retry until the previous
* request finishes.
*
* When an error occurs, the route rejects the promise with type
* Error<files.ListFolderError>.
* @param arg The request parameters.
*/
public filesListFolder(arg: files.ListFolderArg): Promise<files.ListFolderResult>;
/**
* Once a cursor has been retrieved from listFolder(), use this to paginate
* through all files and retrieve updates to the folder, following the same
* rules as documented for listFolder().
*
* When an error occurs, the route rejects the promise with type
* Error<files.ListFolderContinueError>.
* @param arg The request parameters.
*/
public filesListFolderContinue(arg: files.ListFolderContinueArg): Promise<files.ListFolderResult>;
/**
* A way to quickly get a cursor for the folder's state. Unlike
* listFolder(), listFolderGetLatestCursor() doesn't return any entries.
* This endpoint is for app which only needs to know about new files and
* modifications and doesn't need to know about files that already exist in
* Dropbox.
*
* When an error occurs, the route rejects the promise with type
* Error<files.ListFolderError>.
* @param arg The request parameters.
*/
public filesListFolderGetLatestCursor(arg: files.ListFolderArg): Promise<files.ListFolderGetLatestCursorResult>;
/**
* A longpoll endpoint to wait for changes on an account. In conjunction
* with listFolderContinue(), this call gives you a low-latency way to
* monitor an account for file changes. The connection will block until
* there are changes available or a timeout occurs. This endpoint is useful
* mostly for client-side apps. If you're looking for server-side
* notifications, check out our [webhooks documentation]{@link
* https://www.dropbox.com/developers/reference/webhooks}.
*
* When an error occurs, the route rejects the promise with type
* Error<files.ListFolderLongpollError>.
* @param arg The request parameters.
*/
public filesListFolderLongpoll(arg: files.ListFolderLongpollArg): Promise<files.ListFolderLongpollResult>;
/**
* Return revisions of a file.
*
* When an error occurs, the route rejects the promise with type
* Error<files.ListRevisionsError>.
* @param arg The request parameters.
*/
public filesListRevisions(arg: files.ListRevisionsArg): Promise<files.ListRevisionsResult>;
/**
* Move a file or folder to a different location in the user's Dropbox. If
* the source path is a folder all its contents will be moved.
*
* When an error occurs, the route rejects the promise with type
* Error<files.RelocationError>.
* @deprecated
* @param arg The request parameters.
*/
public filesMove(arg: files.RelocationArg): Promise<files.FileMetadataReference|files.FolderMetadataReference|files.DeletedMetadataReference>;
/**
* Move multiple files or folders to different locations at once in the
* user's Dropbox. This route is 'all or nothing', which means if one entry
* fails, the whole transaction will abort. This route will return job ID
* immediately and do the async moving job in background. Please use
* moveBatchCheck() to check the job status.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public filesMoveBatch(arg: files.RelocationBatchArg): Promise<files.RelocationBatchLaunch>;
/**
* Returns the status of an asynchronous job for moveBatch(). If success, it
* returns list of results for each entry.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public filesMoveBatchCheck(arg: async.PollArg): Promise<files.RelocationBatchJobStatus>;
/**
* Move a file or folder to a different location in the user's Dropbox. If
* the source path is a folder all its contents will be moved.
*
* When an error occurs, the route rejects the promise with type
* Error<files.RelocationError>.
* @param arg The request parameters.
*/
public filesMoveV2(arg: files.RelocationArg): Promise<files.RelocationResult>;
/**
* Permanently delete the file or folder at a given path (see
* https://www.dropbox.com/en/help/40). Note: This endpoint is only
* available for Dropbox Business apps.
*
* When an error occurs, the route rejects the promise with type
* Error<files.DeleteError>.
* @param arg The request parameters.
*/
public filesPermanentlyDelete(arg: files.DeleteArg): Promise<void>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.AddPropertiesError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesAdd(arg: file_properties.AddPropertiesArg): Promise<void>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.InvalidPropertyGroupError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesOverwrite(arg: file_properties.OverwritePropertyGroupArg): Promise<void>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.RemovePropertiesError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesRemove(arg: file_properties.RemovePropertiesArg): Promise<void>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesTemplateGet(arg: file_properties.GetTemplateArg): Promise<file_properties.GetTemplateResult>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.TemplateError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesTemplateList(arg: void): Promise<file_properties.ListTemplateResult>;
/**
* When an error occurs, the route rejects the promise with type
* Error<file_properties.UpdatePropertiesError>.
* @deprecated
* @param arg The request parameters.
*/
public filesPropertiesUpdate(arg: file_properties.UpdatePropertiesArg): Promise<void>;
/**
* Restore a file to a specific revision.
*
* When an error occurs, the route rejects the promise with type
* Error<files.RestoreError>.
* @param arg The request parameters.
*/
public filesRestore(arg: files.RestoreArg): Promise<files.FileMetadata>;
/**
* Save a specified URL into a file in user's Dropbox. If the given path
* already exists, the file will be renamed to avoid the conflict (e.g.
* myfile (1).txt).
*
* When an error occurs, the route rejects the promise with type
* Error<files.SaveUrlError>.
* @param arg The request parameters.
*/
public filesSaveUrl(arg: files.SaveUrlArg): Promise<files.SaveUrlResult>;
/**
* Check the status of a saveUrl() job.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public filesSaveUrlCheckJobStatus(arg: async.PollArg): Promise<files.SaveUrlJobStatus>;
/**
* Searches for files and folders. Note: Recent changes may not immediately
* be reflected in search results due to a short delay in indexing.
*
* When an error occurs, the route rejects the promise with type
* Error<files.SearchError>.
* @param arg The request parameters.
*/
public filesSearch(arg: files.SearchArg): Promise<files.SearchResult>;
/**
* Create a new file with the contents provided in the request. Do not use
* this to upload a file larger than 150 MB. Instead, create an upload
* session with uploadSessionStart().
*
* When an error occurs, the route rejects the promise with type
* Error<files.UploadError>.
* @param arg The request parameters.
*/
public filesUpload(arg: files.CommitInfo): Promise<files.FileMetadata>;
/**
* Append more data to an upload session. A single request should not upload
* more than 150 MB.
*
* When an error occurs, the route rejects the promise with type
* Error<files.UploadSessionLookupError>.
* @deprecated
* @param arg The request parameters.
*/
public filesUploadSessionAppend(arg: files.UploadSessionCursor): Promise<void>;
/**
* Append more data to an upload session. When the parameter close is set,
* this call will close the session. A single request should not upload more
* than 150 MB.
*
* When an error occurs, the route rejects the promise with type
* Error<files.UploadSessionLookupError>.
* @param arg The request parameters.
*/
public filesUploadSessionAppendV2(arg: files.UploadSessionAppendArg): Promise<void>;
/**
* Finish an upload session and save the uploaded data to the given file
* path. A single request should not upload more than 150 MB.
*
* When an error occurs, the route rejects the promise with type
* Error<files.UploadSessionFinishError>.
* @param arg The request parameters.
*/
public filesUploadSessionFinish(arg: files.UploadSessionFinishArg): Promise<files.FileMetadata>;
/**
* This route helps you commit many files at once into a user's Dropbox. Use
* uploadSessionStart() and uploadSessionAppendV2() to upload file contents.
* We recommend uploading many files in parallel to increase throughput.
* Once the file contents have been uploaded, rather than calling
* uploadSessionFinish(), use this route to finish all your upload sessions
* in a single request. UploadSessionStartArg.close or
* UploadSessionAppendArg.close needs to be true for the last
* uploadSessionStart() or uploadSessionAppendV2() call. This route will
* return a job_id immediately and do the async commit job in background.
* Use uploadSessionFinishBatchCheck() to check the job status. For the same
* account, this route should be executed serially. That means you should
* not start the next job before current job finishes. We allow up to 1000
* entries in a single request.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public filesUploadSessionFinishBatch(arg: files.UploadSessionFinishBatchArg): Promise<files.UploadSessionFinishBatchLaunch>;
/**
* Returns the status of an asynchronous job for uploadSessionFinishBatch().
* If success, it returns list of result for each entry.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public filesUploadSessionFinishBatchCheck(arg: async.PollArg): Promise<files.UploadSessionFinishBatchJobStatus>;
/**
* Upload sessions allow you to upload a single file in one or more
* requests, for example where the size of the file is greater than 150 MB.
* This call starts a new upload session with the given data. You can then
* use uploadSessionAppendV2() to add more data and uploadSessionFinish() to
* save all the data to a file in Dropbox. A single request should not
* upload more than 150 MB. An upload session can be used for a maximum of
* 48 hours. Attempting to use an UploadSessionStartResult.session_id with
* uploadSessionAppendV2() or uploadSessionFinish() more than 48 hours after
* its creation will return a UploadSessionLookupError.not_found.
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public filesUploadSessionStart(arg: files.UploadSessionStartArg): Promise<files.UploadSessionStartResult>;
/**
* Marks the given Paper doc as archived. Note: This action can be performed
* or undone by anyone with edit permissions to the doc.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsArchive(arg: paper.RefPaperDoc): Promise<void>;
/**
* Creates a new Paper doc with the provided content.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.PaperDocCreateError>.
* @param arg The request parameters.
*/
public paperDocsCreate(arg: paper.PaperDocCreateArgs): Promise<paper.PaperDocCreateUpdateResult>;
/**
* Exports and downloads Paper doc either as HTML or markdown.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsDownload(arg: paper.PaperDocExport): Promise<paper.PaperDocExportResult>;
/**
* Lists the users who are explicitly invited to the Paper folder in which
* the Paper doc is contained. For private folders all users (including
* owner) shared on the folder are listed and for team folders all non-team
* users shared on the folder are returned.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsFolderUsersList(arg: paper.ListUsersOnFolderArgs): Promise<paper.ListUsersOnFolderResponse>;
/**
* Once a cursor has been retrieved from docsFolderUsersList(), use this to
* paginate through all users on the Paper folder.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.ListUsersCursorError>.
* @param arg The request parameters.
*/
public paperDocsFolderUsersListContinue(arg: paper.ListUsersOnFolderContinueArgs): Promise<paper.ListUsersOnFolderResponse>;
/**
* Retrieves folder information for the given Paper doc. This includes: -
* folder sharing policy; permissions for subfolders are set by the
* top-level folder. - full 'filepath', i.e. the list of folders (both
* folderId and folderName) from the root folder to the folder directly
* containing the Paper doc. Note: If the Paper doc is not in any folder
* (aka unfiled) the response will be empty.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsGetFolderInfo(arg: paper.RefPaperDoc): Promise<paper.FoldersContainingPaperDoc>;
/**
* Return the list of all Paper docs according to the argument
* specifications. To iterate over through the full pagination, pass the
* cursor to docsListContinue().
*
* When an error occurs, the route rejects the promise with type
* Error<void>.
* @param arg The request parameters.
*/
public paperDocsList(arg: paper.ListPaperDocsArgs): Promise<paper.ListPaperDocsResponse>;
/**
* Once a cursor has been retrieved from docsList(), use this to paginate
* through all Paper doc.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.ListDocsCursorError>.
* @param arg The request parameters.
*/
public paperDocsListContinue(arg: paper.ListPaperDocsContinueArgs): Promise<paper.ListPaperDocsResponse>;
/**
* Permanently deletes the given Paper doc. This operation is final as the
* doc cannot be recovered. Note: This action can be performed only by the
* doc owner.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsPermanentlyDelete(arg: paper.RefPaperDoc): Promise<void>;
/**
* Gets the default sharing policy for the given Paper doc.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsSharingPolicyGet(arg: paper.RefPaperDoc): Promise<paper.SharingPolicy>;
/**
* Sets the default sharing policy for the given Paper doc. The default
* 'team_sharing_policy' can be changed only by teams, omit this field for
* personal accounts. Note: 'public_sharing_policy' cannot be set to the
* value 'disabled' because this setting can be changed only via the team
* admin console.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsSharingPolicySet(arg: paper.PaperDocSharingPolicy): Promise<void>;
/**
* Updates an existing Paper doc with the provided content.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.PaperDocUpdateError>.
* @param arg The request parameters.
*/
public paperDocsUpdate(arg: paper.PaperDocUpdateArgs): Promise<paper.PaperDocCreateUpdateResult>;
/**
* Allows an owner or editor to add users to a Paper doc or change their
* permissions using their email address or Dropbox account ID. Note: The
* Doc owner's permissions cannot be changed.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsUsersAdd(arg: paper.AddPaperDocUser): Promise<Array<paper.AddPaperDocUserMemberResult>>;
/**
* Lists all users who visited the Paper doc or users with explicit access.
* This call excludes users who have been removed. The list is sorted by the
* date of the visit or the share date. The list will include both users,
* the explicitly shared ones as well as those who came in using the Paper
* url link.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsUsersList(arg: paper.ListUsersOnPaperDocArgs): Promise<paper.ListUsersOnPaperDocResponse>;
/**
* Once a cursor has been retrieved from docsUsersList(), use this to
* paginate through all users on the Paper doc.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.ListUsersCursorError>.
* @param arg The request parameters.
*/
public paperDocsUsersListContinue(arg: paper.ListUsersOnPaperDocContinueArgs): Promise<paper.ListUsersOnPaperDocResponse>;
/**
* Allows an owner or editor to remove users from a Paper doc using their
* email address or Dropbox account ID. Note: Doc owner cannot be removed.
*
* When an error occurs, the route rejects the promise with type
* Error<paper.DocLookupError>.
* @param arg The request parameters.
*/
public paperDocsUsersRemove(arg: paper.RemovePaperDocUser): Promise<void>;
/**
* Adds specified members to a file.
*
* When an error occurs, the route rejects the promise with type
* Error<sharing.AddFileMemberError>.
* @param arg The request parameters.
*/
public sharingAddFileMember(arg: sharing.AddFileMemberArgs): Promise<Array<sharing.FileMemberActionResult>>;
/**
* Allows an owner or editor (if the ACL update policy allows) of a shared
* folder to add another member. For the new member to get access to all the
* functionality for this folder, you will need to call mountFolder() on
* their behalf. Apps must have full Dropbox access to use this endpoint.
*
* When an error occurs, the route rejects the promise with type
* Error<sharing.AddFolderMemberError>.
* @param arg The request parameters.
*/
public sharingAddFolderMember(arg: sharing.AddFolderMemberArg): Promise<void>;
/**
* Identical to update_file_member but with less information returned.
*
* When an error occurs, the route rejects the promise with type
* Error<sharing.FileMemberActionError>.
* @deprecated
* @param arg The request parameters.
*/
public sharingChangeFileMemberAccess(arg: sharing.ChangeFileMemberAccessArgs): Promise<sharing.FileMemberActionResult>;
/**
* Returns the status of an asynchronous job. Apps must have full Dropbox
* access to use this endpoint.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public sharingCheckJobStatus(arg: async.PollArg): Promise<sharing.JobStatus>;
/**
* Returns the status of an asynchronous job for sharing a folder. Apps must
* have full Dropbox access to use this endpoint.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public sharingCheckRemoveMemberJobStatus(arg: async.PollArg): Promise<sharing.RemoveMemberJobStatus>;
/**
* Returns the status of an asynchronous job for sharing a folder. Apps must
* have full Dropbox access to use this endpoint.
*
* When an error occurs, the route rejects the promise with type
* Error<async.PollError>.
* @param arg The request parameters.
*/
public sharingCheckShareJobStatus(arg: async.PollArg): Promise<sharing.ShareFolderJobStatus>;
/**
* Create a shared link. If a shared link already exists for the given path,
* that link is returned. Note that in the returned PathLinkMetadata, the
* PathLinkMetadata.url field is the shortened URL if
* CreateSharedLinkArg.short_url argument is set to true. Previously, it was
* technically possible to break a shared link by moving or renaming the
* corresponding file or folder. In the future, this will no longer be the
* case, so your app shouldn't rely on this behavior. Instead, if your app
* needs to revoke a shared link, use revokeSharedLink().
*
* When an error occurs, the route rejects the promise with type
* Error<sharing.CreateSharedLinkError>.
* @deprecated
* @param arg The request parameters.
*/
public sharingCreateSharedLink(arg: sharing.CreateSharedLinkArg): Promise<sharing.PathLinkMetadata>;
/**
* Create a shared link with custom settings. If no settings are given then
* the default visibility is RequestedVisibility.public (The resolved
* visibility, though, may depend on other aspects such as team and shared
* folder settings).
*
* When an error occurs, the route rejects the promise with type
* Error<sharing.CreateSharedLinkWithSettingsError>.
* @param arg The request parameters.