-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.ts
12079 lines (11269 loc) · 514 KB
/
api.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
/* tslint:disable */
/* eslint-disable */
/**
* Aspera on Cloud API
* A REST API for the Files, Packages, and Admin applications in Aspera’s premier SaaS offering, [Aspera on Cloud](https://www.ibm.com/cloud/aspera) (AoC). With the Aspera on Cloud API, you can quickly and reliably send and share files of any size across a hybrid cloud environment. Using AoC, organizations can store and readily access files and folders in multiple cloud-based and on-premises storage systems.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { Configuration } from './configuration';
import globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
/**
*
* @export
* @interface AppMembershipsParams
*/
export interface AppMembershipsParams {
/**
* The ID of the member that this membership belongs to.
* @type {string}
* @memberof AppMembershipsParams
*/
member_id?: string;
/**
*
* @type {MemberType}
* @memberof AppMembershipsParams
*/
member_type?: MemberType;
}
/**
*
* @export
* @interface AppMembershipsResponse
*/
export interface AppMembershipsResponse {
/**
* Name of the app that the membership belongs to.
* @type {string}
* @memberof AppMembershipsResponse
*/
app_name?: string;
/**
*
* @type {AppType}
* @memberof AppMembershipsResponse
*/
app_type?: AppType;
/**
* ID of the app membership.
* @type {string}
* @memberof AppMembershipsResponse
*/
id?: string;
/**
*
* @type {string}
* @memberof AppMembershipsResponse
*/
member_id?: string;
/**
*
* @type {MemberType1}
* @memberof AppMembershipsResponse
*/
member_type?: MemberType1;
}
/**
* Type of app that the membership belongs to.
* @export
* @enum {string}
*/
export enum AppType {
Activity = 'activity',
Automation = 'automation'
}
/**
*
* @export
* @interface AppsNewPackagesRequest
*/
export interface AppsNewPackagesRequest {
/**
* Make all sent packages accessible to all workspace members
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
allow_access_sent?: boolean;
/**
* Allow senders to set package expiration
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
allow_package_level_expirations?: boolean;
/**
* Managers can send packages to the entire workspace. The parameter can_users_send_to_workspace must be set to true.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
can_managers_send_to_workspace?: boolean;
/**
* Users can send packages to the entire workspace
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
can_users_send_to_workspace?: boolean;
/**
* Eligible external users allowlist is enabled. To set allowed users, groups, or emails, send a POST request to /admin/app_collaborators.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
collaboration_whitelist_enabled?: boolean;
/**
* Allow external users with any email. The user does not have to be a specific registered user or group.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
collaboration_with_emails_allowed?: boolean;
/**
* Delete this package after the specified time (in seconds)
* @type {number}
* @memberof AppsNewPackagesRequest
*/
content_retention_duration?: number;
/**
* Automatically apply encryption at rest to all packages
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
default_ear_setting?: boolean;
/**
* Delete recalled packages after the specified time (in seconds)
* @type {number}
* @memberof AppsNewPackagesRequest
*/
draft_expiration_duration?: number;
/**
* The Packages app is enabled
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
enabled?: boolean;
/**
* Require external users to log in in order to receive packages
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
external_package_authentication_required?: boolean;
/**
* Users can send packages to external users (outside of AoC)
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
external_package_sending_allowed?: boolean;
/**
* Managers can send packages to external users (outside of AoC). The parameter external_package_sending_allowed must be set to true.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
external_package_sending_allowed_by_managers?: boolean;
/**
* External senders must enter their email and name before sendng a package
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
external_sender_email_and_name_required?: boolean;
/**
* The Packages app corresponding to the current app_id inherits the global app settings. The setting applies to the Packages app only at the workspace level.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
inherit_organization_app_settings?: boolean;
/**
* Show the download count within package details
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
package_download_counts_enabled?: boolean;
/**
* Automatically create a JSON file within all packages. This file includes shared inbox metadata and additional package information.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
package_sidecar_enabled?: boolean;
/**
* Users can create personalized URLs for public and authenticated links. The parameter url_shortening_enabled must be set to true.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
personalized_urls_enabled?: boolean;
/**
* Any user can request packages by sharing submission links.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
public_invites_allowed?: boolean;
/**
* Managers can request packages by sharing public submission links. The parameter public_invites_allowed must be set to true.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
public_invites_allowed_by_managers?: boolean;
/**
* If the workspace is attached to a node with a watermarking profile, you can enable package level watermarking.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
watermarking_allowed?: boolean;
/**
* Require watermarking on all sent packages. The parameter watermarking_allowed must be set to true.
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
watermarking_required?: boolean;
/**
* Users can shorten URLs from their standard length, to something like aspera.pub/2da3xfa
* @type {boolean}
* @memberof AppsNewPackagesRequest
*/
url_shortening_enabled?: boolean;
}
/**
*
* @export
* @enum {string}
*/
export enum AsperaAppType {
Activity = 'activity',
Automation = 'automation'
}
/**
* Asset for a file
* @export
* @interface Asset
*/
export interface Asset {
/**
* File path, relative to the docroot
* @type {string}
* @memberof Asset
*/
source: string;
/**
* Watermark identifier for the file
* @type {number}
* @memberof Asset
*/
job_id: number;
/**
* If true, this file is watermarked
* @type {boolean}
* @memberof Asset
*/
watermark: boolean;
}
/**
* For Aspera Transfer Service nodes, this field defines which type of storage is used.
* @export
* @enum {string}
*/
export enum AtsStorageType {
AwsS3 = 'aws_s3',
Azure = 'azure',
AzureFiles = 'azure-files',
AzureSas = 'azure_sas',
GoogleGcs = 'google-gcs',
IbmS3 = 'ibm-s3',
SoftlayerSwift = 'softlayer_swift'
}
/**
*
* @export
* @interface Capability
*/
export interface Capability {
/**
*
* @type {string}
* @memberof Capability
*/
name?: string;
/**
*
* @type {boolean}
* @memberof Capability
*/
value?: boolean;
}
/**
*
* @export
* @interface ClientAccessKeysParams
*/
export interface ClientAccessKeysParams {
/**
* Id of the client access key.
* @type {string}
* @memberof ClientAccessKeysParams
*/
id: string;
/**
* The name of the client access key
* @type {string}
* @memberof ClientAccessKeysParams
*/
name?: string;
/**
* Id of the node to which the client access key belongs.
* @type {string}
* @memberof ClientAccessKeysParams
*/
node_id: string;
/**
*
* @type {string}
* @memberof ClientAccessKeysParams
*/
permission_id?: string;
/**
* The id of the directory that this access key grants permissions for.
* @type {string}
* @memberof ClientAccessKeysParams
*/
root_file_id: string;
}
/**
*
* @export
* @interface ClientAccessKeysRequest
*/
export interface ClientAccessKeysRequest {
/**
* The name of the client access key
* @type {string}
* @memberof ClientAccessKeysRequest
*/
name?: string;
}
/**
*
* @export
* @interface ClientAccessKeysResponse
*/
export interface ClientAccessKeysResponse {
/**
* The date at which the client access key was created.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
created_at?: string;
/**
* Id of the client access key.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
id?: string;
/**
* The name of the client access key
* @type {string}
* @memberof ClientAccessKeysResponse
*/
name?: string;
/**
* Id of the node to which the client access key belongs.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
node_id?: string;
/**
*
* @type {string}
* @memberof ClientAccessKeysResponse
*/
permission_id?: string;
/**
* The id of the directory that this access key grants permissions for.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
root_file_id?: string;
/**
* The date at which the client access key was last updated.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
updated_at?: string;
/**
* Id of the workspace to which the client access key belongs.
* @type {string}
* @memberof ClientAccessKeysResponse
*/
workspace_id?: string;
}
/**
*
* @export
* @interface ClientAuthorizationsParams
*/
export interface ClientAuthorizationsParams {
/**
* The ID of the client.
* @type {string}
* @memberof ClientAuthorizationsParams
*/
client_id: string;
/**
* The ID of the entity that can be authorized.
* @type {number}
* @memberof ClientAuthorizationsParams
*/
entity_id: number;
/**
*
* @type {EntityType}
* @memberof ClientAuthorizationsParams
*/
entity_type: EntityType;
}
/**
*
* @export
* @interface ClientAuthorizationsResponse
*/
export interface ClientAuthorizationsResponse {
/**
* The ID of the client.
* @type {string}
* @memberof ClientAuthorizationsResponse
*/
client_id?: string;
/**
* The timestamp of authorization.
* @type {string}
* @memberof ClientAuthorizationsResponse
*/
created_at?: string;
/**
* The ID of the entity that can be authorized.
* @type {number}
* @memberof ClientAuthorizationsResponse
*/
entity_id?: number;
/**
*
* @type {EntityType}
* @memberof ClientAuthorizationsResponse
*/
entity_type?: EntityType;
/**
* The client ID
* @type {string}
* @memberof ClientAuthorizationsResponse
*/
id?: string;
/**
* The timestamp of the most recent update.
* @type {string}
* @memberof ClientAuthorizationsResponse
*/
updated_at?: string;
}
/**
*
* @export
* @interface ClientsParams
*/
export interface ClientsParams {
/**
* If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Admin permissions required. Defaults to false.
* @type {boolean}
* @memberof ClientsParams
*/
admin_node_token_retrieval_enabled?: boolean;
/**
* Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Admin permissions required. Defaults to true.
* @type {boolean}
* @memberof ClientsParams
*/
explicit_authorization_required?: boolean;
/**
* Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Admin permissions required.
* @type {boolean}
* @memberof ClientsParams
*/
jwt_grant_enabled?: boolean;
/**
* The name of the client app to register. Admin permissions required. POST: required. PUT: not required.
* @type {string}
* @memberof ClientsParams
*/
name: string;
/**
* The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Array of JSON origins (strings) Admin permissions required. Separate multiple origins with commas. Maximum characters: 65535.
* @type {Array<string>}
* @memberof ClientsParams
*/
origins?: Array<string>;
/**
* RSA public key in PEM format. The corresponding private key can be used to generate a JWT assertion for any user in the organization. Admin permissions required. Maximum characters: 65535.
* @type {string}
* @memberof ClientsParams
*/
public_key?: string;
/**
* The allowable list of redirect URIs for the client. A redirect URI (protocol-host-port) is an absolute URI invoked after the authentication flow to return the user to the client app. Array of JSON redirect URIs (strings) Admin permissions required. Separate multiple redirect URIs with commas. Maximum characters: 65535.
* @type {Array<string>}
* @memberof ClientsParams
*/
redirect_uris?: Array<string>;
/**
* Enable creation of a specific list of users and groups eligible to receive an access token. To create the whitelist, see /client_authorizations. Admin permissions required. Pertains to JWT grants. Default is false.
* @type {boolean}
* @memberof ClientsParams
*/
whitelist_enabled?: boolean;
}
/**
*
* @export
* @interface ClientsResponse
*/
export interface ClientsResponse {
/**
* If you use the JWT grant type (jwt_grant_enabled=true), whether or not to allow users of this client who are AoC administrators to retrieve admin-scoped node access tokens. Such a token provides the user with admin privileges on the node itself. Default is false.
* @type {boolean}
* @memberof ClientsResponse
*/
admin_node_token_retrieval_enabled?: boolean;
/**
* Whether or not to allow the client app to obtain an access token directly from the authorization endpoint, without contacting the token endpoint or authenticating the client.
* @type {boolean}
* @memberof ClientsResponse
*/
allow_implicit_grant?: boolean;
/**
* Timestamp of original creation of the client. Datetime.
* @type {string}
* @memberof ClientsResponse
*/
created_at?: string;
/**
* ID of the user who created the client.
* @type {string}
* @memberof ClientsResponse
*/
creator_id?: string;
/**
* Use with browser-based authorization. When users log in using the client app via a browser, prompt them to explicitly allow access to AoC features. Default is true.
* @type {boolean}
* @memberof ClientsResponse
*/
explicit_authorization_required?: boolean;
/**
* ID of the client app.
* @type {string}
* @memberof ClientsResponse
*/
id?: string;
/**
* Allow the client to authenticate using the JSON web token method. The JWT grant allows the users of the client to log in without having to use a web browser. Default is false.
* @type {boolean}
* @memberof ClientsResponse
*/
jwt_grant_enabled?: boolean;
/**
* Name assigned to the client. Maximum length: 255 characters.
* @type {string}
* @memberof ClientsResponse
*/
name?: string;
/**
* ID of the AoC organization to which the client belongs.
* @type {string}
* @memberof ClientsResponse
*/
organization_id?: string;
/**
* The allowable list of origins for the client. An origin is the URI or protocol-host-port of the client app initial login page, from which the user must arrive to the authentication flow. Separate multiple origins with commas. Maximum characters: 65535. Array of json origins (strings).
* @type {Array<string>}
* @memberof ClientsResponse
*/
origins?: Array<string>;
/**
* The public portion of the RSA key pair. Maximum characters: 65535.
* @type {string}
* @memberof ClientsResponse
*/
public_key?: string;
/**
* The allowable list of redirect URIs for this client. A redirect URI, or protocol-host-port, is an absolute URI invoked after the authentication flow to return the user to the client app. Separate multiple redirect URIs with commas. Maximum characters: 65535.
* @type {Array<string>}
* @memberof ClientsResponse
*/
redirect_uris?: Array<string>;
/**
* The secret associated with this client.
* @type {string}
* @memberof ClientsResponse
*/
secret?: string;
/**
* Timestamp of last modification to the client. datetime
* @type {string}
* @memberof ClientsResponse
*/
updated_at?: string;
/**
* Enable creation of a specific list of users and groups eligible to receive an access token. Pertains to JWT grants. Default is false. See /client_authorizations.
* @type {boolean}
* @memberof ClientsResponse
*/
whitelist_enabled?: boolean;
}
/**
*
* @export
* @interface Config
*/
export interface Config {
/**
* Endpoint of IBM Key Protect instance
* @type {string}
* @memberof Config
*/
endpoint?: string;
/**
* Instance ID of IBM Key Protect instance
* @type {string}
* @memberof Config
*/
instance_id?: string;
/**
* Root key ID that acts as the master encryption key
* @type {string}
* @memberof Config
*/
root_key_id?: string;
/**
* API key for IBM Key Protect instance
* @type {string}
* @memberof Config
*/
api_key?: string;
}
/**
*
* @export
* @interface Config1
*/
export interface Config1 {
/**
* Endpoint of your IBM Key Protect instance
* @type {string}
* @memberof Config1
*/
endpoint?: string;
/**
* Instance ID of your IBM Key Protect instance
* @type {string}
* @memberof Config1
*/
instance_id?: string;
/**
* Root key ID that acts as the master encryption key
* @type {string}
* @memberof Config1
*/
root_key_id?: string;
}
/**
*
* @export
* @interface Config3
*/
export interface Config3 {
/**
* API key used by the Aspera KMS integration service
* @type {string}
* @memberof Config3
*/
api_key?: string;
}
/**
*
* @export
* @interface DropboxMembershipsParams
*/
export interface DropboxMembershipsParams {
/**
* Indicates whether this member can receive packages.
* @type {boolean}
* @memberof DropboxMembershipsParams
*/
can_receive_packages?: boolean;
/**
* Indicates whether this member can submit packages.
* @type {boolean}
* @memberof DropboxMembershipsParams
*/
can_submit_packages?: boolean;
/**
* ID of the dropbox to which this membership belongs.
* @type {string}
* @memberof DropboxMembershipsParams
*/
dropbox_id: string;
/**
* Indicates whether this member is a dropbox manager.
* @type {boolean}
* @memberof DropboxMembershipsParams
*/
manager?: boolean;
/**
* ID of the member to which this membership belongs.
* @type {string}
* @memberof DropboxMembershipsParams
*/
member_id: string;
/**
*
* @type {MemberType2}
* @memberof DropboxMembershipsParams
*/
member_type?: MemberType2;
/**
* Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.
* @type {string}
* @memberof DropboxMembershipsParams
*/
submit_expires_at?: string;
}
/**
*
* @export
* @interface DropboxMembershipsResponse
*/
export interface DropboxMembershipsResponse {
/**
* Indicates whether this member can receive packages.
* @type {boolean}
* @memberof DropboxMembershipsResponse
*/
can_receive_packages?: boolean;
/**
* Indicates whether this member can submit packages.
* @type {boolean}
* @memberof DropboxMembershipsResponse
*/
can_submit_packages?: boolean;
/**
* ID of the user who created this membership.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
creator_id?: string;
/**
* ID of the dropbox to which this membership belongs.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
dropbox_id?: string;
/**
* ID of this dropbox membership.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
id?: string;
/**
* Indicates whether this member is a dropbox manager.
* @type {boolean}
* @memberof DropboxMembershipsResponse
*/
manager?: boolean;
/**
* ID of the member to which this membership belongs.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
member_id?: string;
/**
*
* @type {MemberType2}
* @memberof DropboxMembershipsResponse
*/
member_type?: MemberType2;
/**
* Indicates whether the member may make a submission to the dropbox.
* @type {boolean}
* @memberof DropboxMembershipsResponse
*/
submit_expired?: boolean;
/**
* Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
submit_expires_at?: string;
/**
* The ID of the workspace to which this dropbox membership belongs.
* @type {string}
* @memberof DropboxMembershipsResponse
*/
workspace_id?: string;
}
/**
*
* @export
* @interface DropboxMembershipsUpdateParams
*/
export interface DropboxMembershipsUpdateParams {
/**
* Indicates whether this member can receive packages.
* @type {boolean}
* @memberof DropboxMembershipsUpdateParams
*/
can_receive_packages?: boolean;
/**
* Indicates whether this member can submit packages.
* @type {boolean}
* @memberof DropboxMembershipsUpdateParams
*/
can_submit_packages?: boolean;
/**
* Indicates whether this member is a dropbox manager.
* @type {boolean}
* @memberof DropboxMembershipsUpdateParams
*/
manager?: boolean;
/**
* Defines the time at which the dropbox will be closed to submission for a specific dropbox member. If null, the dropbox has no submission deadline.
* @type {string}
* @memberof DropboxMembershipsUpdateParams
*/
submit_expires_at?: string;
}
/**
*
* @export
* @interface DropboxNotificationRecipient
*/
export interface DropboxNotificationRecipient {
/**
* For type = user | group, id denotes the integer ID of that user or group (e.g., \"123\"). For type = email, id denotes the email address of the intended addressee (e.g., \"email@foo.co\").
* @type {string}
* @memberof DropboxNotificationRecipient
*/
id?: string;
/**
*
* @type {Type}
* @memberof DropboxNotificationRecipient
*/
type?: Type;
}
/**
*
* @export
* @interface DropboxesParams
*/
export interface DropboxesParams {
/**
* Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {number}
* @memberof DropboxesParams
*/
content_retention_duration?: number;
/**
* For a package sent to a shared inbox, this parameter determines whether notifications are sent to all package addressees or to a user-defined list of addressees for the shared inbox (see dropbox_notification_recipients). Defaults to false. Valid values: true to send notifications to a user-defined list or false to send notifications to all package addressees. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.
* @type {boolean}
* @memberof DropboxesParams
*/
custom_notification_list_enabled?: boolean;
/**
* Configure a download-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured by this parameter has passed, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the delete_package_content_after_download_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {number}
* @memberof DropboxesParams
*/
delete_package_content_after_download_duration?: number;
/**
* A description for the shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. RESPONSE: Admin scope.
* @type {string}
* @memberof DropboxesParams
*/
description: string;
/**
* Configure a time-based expiration policy for draft packages in this shared inbox by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {number}
* @memberof DropboxesParams
*/
draft_expiration_duration?: number;
/**
* With custom_notification_list_enabled = true, this parameter defines a list of addressees who should receive notifications regarding packages addressed to this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {Array<DropboxNotificationRecipient>}
* @memberof DropboxesParams
*/
dropbox_notification_recipients?: Array<DropboxNotificationRecipient>;
/**
*
* @type {EmailNotificationSettings}
* @memberof DropboxesParams
*/
email_notification_settings?: EmailNotificationSettings;
/**
* If inherit_email_templates is set to false, you can enable or disable the ability to configure email templates specifically for users outside this shared inbox. When this parameter is set to false, external recipients receive the same email notification messages that users in the shared inbox receive. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {boolean}
* @memberof DropboxesParams
*/
enable_external_email_templates?: boolean;
/**
* The image data for the shared inbox logo encoded as a string. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {string}
* @memberof DropboxesParams
*/
image_data?: string;
/**
* The image type of the shared inbox logo. For example, image/png or image/jpg. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {string}
* @memberof DropboxesParams
*/
image_type?: string;
/**
* Inherit the email notification settings configured at the workspace level. POST Admin or Manager permission required. PUT Admin or Manager permission required.
* @type {boolean}
* @memberof DropboxesParams
*/
inherit_email_notification_settings?: boolean;
/**
* Inherit the email templates configured at the workspace level. If false, you can configure email template settings for this shared inbox. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {boolean}
* @memberof DropboxesParams
*/
inherit_email_templates?: boolean;
/**
* Inherit the content_retention_duration settings configured at the workspace level. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {boolean}
* @memberof DropboxesParams
*/
inherit_workspace_expiration_settings?: boolean;
/**
* User-defined instructions for potential shared inbox submissions. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {string}
* @memberof DropboxesParams
*/
instructions: string;
/**
* A metadata schema is used to present a form to a user when the user is submitting content to a dropbox. It is an array with \"Field\" objects, and each Field object defines one field that the user can fill out when submitting content to a dropbox. Note that the order of the fields in the metadata schema array will be the order in which they are shown to the user.
* @type {Array<Metadatum>}
* @memberof DropboxesParams
*/
metadata_schema?: Array<Metadatum>;
/**
* Shared inbox name. A query parameter for the GET method. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {string}
* @memberof DropboxesParams
*/
name: string;
/**
* Defines illegal characters and/or max length for the name and message fields for package submissions to this shared inbox. Defaults to an empty array ([]). POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {Array<PackageNameAndMessageValidationSchema>}
* @memberof DropboxesParams
*/
package_name_and_message_validation_schema?: Array<PackageNameAndMessageValidationSchema>;
/**
* Enable members of this shared inbox to configure personalized URLs to send when inviting people to submit packages. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {boolean}
* @memberof DropboxesParams
*/
personalized_urls_enabled?: boolean;
/**
* ID of the workspace to which this shared inbox belongs. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
* @type {string}
* @memberof DropboxesParams
*/
workspace_id: string;
}
/**
*
* @export
* @interface DropboxesResponse
*/
export interface DropboxesResponse {
/**
* Configure a time-based expiration policy for packages in this shared inbox by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained and includes details about the sender, recipients, contents, and transfer). If null, this shared inbox inherits the content_retention_duration settings of its workspace. Valid values: null - 10 years. Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required. Write only.
* @type {number}
* @memberof DropboxesResponse