Skip to content

Commit 6b3404d

Browse files
DropboxBotBrent Bumann
andauthored
Automated Spec Update (#955)
69f7bb2ea7702db5564f12549efb23956c5d6329 Change Notes: files Namespace - Update examples shared_links Namespace - Update get_shared_link_metadata route to include app and user auth team_folders Namespace - Update team_folder/create, team_folder/rename, team_folder/list, team_folder/list/continue, team_folder/get_info, team_folder/activate, team_folder/archive, team_folder/archive/check, team_folder/permanently_delete, team_folder/update_sync_settings routes to include updated scopes team_legal_holds Namespace - Update legal_holds/create_policy, legal_holds/get_policy, legal_holds/list_policies, legal_holds/list_held_revisions, legal_holds/list_held_revisions_continue, legal_holds/update_policy, legal_holds/release_policy routes to include updated scopes team_log_generated Namespace - Update AdminAlertingAlertConfiguration to include text and excluded_file_extensions - Update PlacementRestriction to include us_s3_only - Update examples Co-authored-by: Brent Bumann <bbumann@dropbox.com> ef6b1680d9a05ec7475f503149d771e44db913a2 Change Notes: files Namespace - Add upload_session/start_batch routes - Add UploadSessionStartBatchArg, UploadSessionStartBatchResult structs team_log_generated Namespace - Add ExternalDriveBackupEligibilityStatusCheckedDetails, ExternalDriveBackupStatusChangedDetails, ExternalDriveBackupEligibilityStatusCheckedType, ExternalDriveBackupStatusChangedType structs - Add ExternalDriveBackupEligibilityStatus, ExternalDriveBackupStatus unions Co-authored-by: DropboxBot <DropboxBot@users.noreply.github.com> Co-authored-by: Brent Bumann <bbumann@dropbox.com>
1 parent ca87c0b commit 6b3404d

File tree

7 files changed

+73
-58
lines changed

7 files changed

+73
-58
lines changed

lib/routes.js

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -693,6 +693,7 @@ routes.filesDownload = function (arg) {
693693
* less than 20 GB in size and any single file within must be less than 4 GB in
694694
* size. The resulting zip must have fewer than 10,000 total file and folder
695695
* entries, including the top level folder. The input cannot be a single file.
696+
* Note: this endpoint does not support HTTP range requests.
696697
* Route attributes:
697698
* scope: files.content.read
698699
* @function Dropbox#filesDownloadZip
@@ -1997,7 +1998,7 @@ routes.sharingGetSharedLinkFile = function (arg) {
19971998
* @returns {Promise.<DropboxResponse<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingSharedLinkError>>}
19981999
*/
19992000
routes.sharingGetSharedLinkMetadata = function (arg) {
2000-
return this.request('sharing/get_shared_link_metadata', arg, 'user', 'api', 'rpc', 'sharing.read');
2001+
return this.request('sharing/get_shared_link_metadata', arg, 'app, user', 'api', 'rpc', 'sharing.read');
20012002
};
20022003

20032004
/**
@@ -2673,92 +2674,92 @@ routes.teamGroupsUpdate = function (arg) {
26732674
* Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all
26742675
* teams have the feature. Permission : Team member file access.
26752676
* Route attributes:
2676-
* scope: team_data.member
2677+
* scope: team_data.governance.write
26772678
* @function Dropbox#teamLegalHoldsCreatePolicy
26782679
* @arg {TeamLegalHoldsPolicyCreateArg} arg - The request parameters.
26792680
* @returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsPolicyCreateError>>}
26802681
*/
26812682
routes.teamLegalHoldsCreatePolicy = function (arg) {
2682-
return this.request('team/legal_holds/create_policy', arg, 'team', 'api', 'rpc', 'team_data.member');
2683+
return this.request('team/legal_holds/create_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
26832684
};
26842685

26852686
/**
26862687
* Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams
26872688
* have the feature. Permission : Team member file access.
26882689
* Route attributes:
2689-
* scope: team_data.member
2690+
* scope: team_data.governance.write
26902691
* @function Dropbox#teamLegalHoldsGetPolicy
26912692
* @arg {TeamLegalHoldsGetPolicyArg} arg - The request parameters.
26922693
* @returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsGetPolicyError>>}
26932694
*/
26942695
routes.teamLegalHoldsGetPolicy = function (arg) {
2695-
return this.request('team/legal_holds/get_policy', arg, 'team', 'api', 'rpc', 'team_data.member');
2696+
return this.request('team/legal_holds/get_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
26962697
};
26972698

26982699
/**
26992700
* List the file metadata that's under the hold. Note: Legal Holds is a paid
27002701
* add-on. Not all teams have the feature. Permission : Team member file access.
27012702
* Route attributes:
2702-
* scope: team_data.member
2703+
* scope: team_data.governance.write
27032704
* @function Dropbox#teamLegalHoldsListHeldRevisions
27042705
* @arg {TeamLegalHoldsListHeldRevisionsArg} arg - The request parameters.
27052706
* @returns {Promise.<DropboxResponse<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>}
27062707
*/
27072708
routes.teamLegalHoldsListHeldRevisions = function (arg) {
2708-
return this.request('team/legal_holds/list_held_revisions', arg, 'team', 'api', 'rpc', 'team_data.member');
2709+
return this.request('team/legal_holds/list_held_revisions', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
27092710
};
27102711

27112712
/**
27122713
* Continue listing the file metadata that's under the hold. Note: Legal Holds
27132714
* is a paid add-on. Not all teams have the feature. Permission : Team member
27142715
* file access.
27152716
* Route attributes:
2716-
* scope: team_data.member
2717+
* scope: team_data.governance.write
27172718
* @function Dropbox#teamLegalHoldsListHeldRevisionsContinue
27182719
* @arg {TeamLegalHoldsListHeldRevisionsContinueArg} arg - The request parameters.
27192720
* @returns {Promise.<DropboxResponse<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>}
27202721
*/
27212722
routes.teamLegalHoldsListHeldRevisionsContinue = function (arg) {
2722-
return this.request('team/legal_holds/list_held_revisions_continue', arg, 'team', 'api', 'rpc', 'team_data.member');
2723+
return this.request('team/legal_holds/list_held_revisions_continue', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
27232724
};
27242725

27252726
/**
27262727
* Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all
27272728
* teams have the feature. Permission : Team member file access.
27282729
* Route attributes:
2729-
* scope: team_data.member
2730+
* scope: team_data.governance.write
27302731
* @function Dropbox#teamLegalHoldsListPolicies
27312732
* @arg {TeamLegalHoldsListPoliciesArg} arg - The request parameters.
27322733
* @returns {Promise.<DropboxResponse<TeamLegalHoldsListPoliciesResult>, DropboxResponseError.<TeamLegalHoldsListPoliciesError>>}
27332734
*/
27342735
routes.teamLegalHoldsListPolicies = function (arg) {
2735-
return this.request('team/legal_holds/list_policies', arg, 'team', 'api', 'rpc', 'team_data.member');
2736+
return this.request('team/legal_holds/list_policies', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
27362737
};
27372738

27382739
/**
27392740
* Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all
27402741
* teams have the feature. Permission : Team member file access.
27412742
* Route attributes:
2742-
* scope: team_data.member
2743+
* scope: team_data.governance.write
27432744
* @function Dropbox#teamLegalHoldsReleasePolicy
27442745
* @arg {TeamLegalHoldsPolicyReleaseArg} arg - The request parameters.
27452746
* @returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamLegalHoldsPolicyReleaseError>>}
27462747
*/
27472748
routes.teamLegalHoldsReleasePolicy = function (arg) {
2748-
return this.request('team/legal_holds/release_policy', arg, 'team', 'api', 'rpc', 'team_data.member');
2749+
return this.request('team/legal_holds/release_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
27492750
};
27502751

27512752
/**
27522753
* Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have
27532754
* the feature. Permission : Team member file access.
27542755
* Route attributes:
2755-
* scope: team_data.member
2756+
* scope: team_data.governance.write
27562757
* @function Dropbox#teamLegalHoldsUpdatePolicy
27572758
* @arg {TeamLegalHoldsPolicyUpdateArg} arg - The request parameters.
27582759
* @returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsPolicyUpdateError>>}
27592760
*/
27602761
routes.teamLegalHoldsUpdatePolicy = function (arg) {
2761-
return this.request('team/legal_holds/update_policy', arg, 'team', 'api', 'rpc', 'team_data.member');
2762+
return this.request('team/legal_holds/update_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
27622763
};
27632764

27642765
/**
@@ -3471,129 +3472,129 @@ routes.teamReportsGetStorage = function (arg) {
34713472
* Sets an archived team folder's status to active. Permission : Team member
34723473
* file access.
34733474
* Route attributes:
3474-
* scope: team_data.team_space
3475+
* scope: team_data.content.write
34753476
* @function Dropbox#teamTeamFolderActivate
34763477
* @arg {TeamTeamFolderIdArg} arg - The request parameters.
34773478
* @returns {Promise.<DropboxResponse<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderActivateError>>}
34783479
*/
34793480
routes.teamTeamFolderActivate = function (arg) {
3480-
return this.request('team/team_folder/activate', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3481+
return this.request('team/team_folder/activate', arg, 'team', 'api', 'rpc', 'team_data.content.write');
34813482
};
34823483

34833484
/**
34843485
* Sets an active team folder's status to archived and removes all folder and
34853486
* file members. This endpoint cannot be used for teams that have a shared team
34863487
* space. Permission : Team member file access.
34873488
* Route attributes:
3488-
* scope: team_data.team_space
3489+
* scope: team_data.content.write
34893490
* @function Dropbox#teamTeamFolderArchive
34903491
* @arg {TeamTeamFolderArchiveArg} arg - The request parameters.
34913492
* @returns {Promise.<DropboxResponse<TeamTeamFolderArchiveLaunch>, DropboxResponseError.<TeamTeamFolderArchiveError>>}
34923493
*/
34933494
routes.teamTeamFolderArchive = function (arg) {
3494-
return this.request('team/team_folder/archive', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3495+
return this.request('team/team_folder/archive', arg, 'team', 'api', 'rpc', 'team_data.content.write');
34953496
};
34963497

34973498
/**
34983499
* Returns the status of an asynchronous job for archiving a team folder.
34993500
* Permission : Team member file access.
35003501
* Route attributes:
3501-
* scope: team_data.team_space
3502+
* scope: team_data.content.write
35023503
* @function Dropbox#teamTeamFolderArchiveCheck
35033504
* @arg {AsyncPollArg} arg - The request parameters.
35043505
* @returns {Promise.<DropboxResponse<TeamTeamFolderArchiveJobStatus>, DropboxResponseError.<AsyncPollError>>}
35053506
*/
35063507
routes.teamTeamFolderArchiveCheck = function (arg) {
3507-
return this.request('team/team_folder/archive/check', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3508+
return this.request('team/team_folder/archive/check', arg, 'team', 'api', 'rpc', 'team_data.content.write');
35083509
};
35093510

35103511
/**
35113512
* Creates a new, active, team folder with no members. This endpoint can only be
35123513
* used for teams that do not already have a shared team space. Permission :
35133514
* Team member file access.
35143515
* Route attributes:
3515-
* scope: team_data.team_space
3516+
* scope: team_data.content.write
35163517
* @function Dropbox#teamTeamFolderCreate
35173518
* @arg {TeamTeamFolderCreateArg} arg - The request parameters.
35183519
* @returns {Promise.<DropboxResponse<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderCreateError>>}
35193520
*/
35203521
routes.teamTeamFolderCreate = function (arg) {
3521-
return this.request('team/team_folder/create', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3522+
return this.request('team/team_folder/create', arg, 'team', 'api', 'rpc', 'team_data.content.write');
35223523
};
35233524

35243525
/**
35253526
* Retrieves metadata for team folders. Permission : Team member file access.
35263527
* Route attributes:
3527-
* scope: team_data.team_space
3528+
* scope: team_data.content.read
35283529
* @function Dropbox#teamTeamFolderGetInfo
35293530
* @arg {TeamTeamFolderIdListArg} arg - The request parameters.
35303531
* @returns {Promise.<DropboxResponse<Array.<TeamTeamFolderGetInfoItem>>, DropboxResponseError.<void>>}
35313532
*/
35323533
routes.teamTeamFolderGetInfo = function (arg) {
3533-
return this.request('team/team_folder/get_info', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3534+
return this.request('team/team_folder/get_info', arg, 'team', 'api', 'rpc', 'team_data.content.read');
35343535
};
35353536

35363537
/**
35373538
* Lists all team folders. Permission : Team member file access.
35383539
* Route attributes:
3539-
* scope: team_data.team_space
3540+
* scope: team_data.content.read
35403541
* @function Dropbox#teamTeamFolderList
35413542
* @arg {TeamTeamFolderListArg} arg - The request parameters.
35423543
* @returns {Promise.<DropboxResponse<TeamTeamFolderListResult>, DropboxResponseError.<TeamTeamFolderListError>>}
35433544
*/
35443545
routes.teamTeamFolderList = function (arg) {
3545-
return this.request('team/team_folder/list', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3546+
return this.request('team/team_folder/list', arg, 'team', 'api', 'rpc', 'team_data.content.read');
35463547
};
35473548

35483549
/**
35493550
* Once a cursor has been retrieved from team_folder/list, use this to paginate
35503551
* through all team folders. Permission : Team member file access.
35513552
* Route attributes:
3552-
* scope: team_data.team_space
3553+
* scope: team_data.content.read
35533554
* @function Dropbox#teamTeamFolderListContinue
35543555
* @arg {TeamTeamFolderListContinueArg} arg - The request parameters.
35553556
* @returns {Promise.<DropboxResponse<TeamTeamFolderListResult>, DropboxResponseError.<TeamTeamFolderListContinueError>>}
35563557
*/
35573558
routes.teamTeamFolderListContinue = function (arg) {
3558-
return this.request('team/team_folder/list/continue', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3559+
return this.request('team/team_folder/list/continue', arg, 'team', 'api', 'rpc', 'team_data.content.read');
35593560
};
35603561

35613562
/**
35623563
* Permanently deletes an archived team folder. This endpoint cannot be used for
35633564
* teams that have a shared team space. Permission : Team member file access.
35643565
* Route attributes:
3565-
* scope: team_data.team_space
3566+
* scope: team_data.content.write
35663567
* @function Dropbox#teamTeamFolderPermanentlyDelete
35673568
* @arg {TeamTeamFolderIdArg} arg - The request parameters.
35683569
* @returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamTeamFolderPermanentlyDeleteError>>}
35693570
*/
35703571
routes.teamTeamFolderPermanentlyDelete = function (arg) {
3571-
return this.request('team/team_folder/permanently_delete', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3572+
return this.request('team/team_folder/permanently_delete', arg, 'team', 'api', 'rpc', 'team_data.content.write');
35723573
};
35733574

35743575
/**
35753576
* Changes an active team folder's name. Permission : Team member file access.
35763577
* Route attributes:
3577-
* scope: team_data.team_space
3578+
* scope: team_data.content.write
35783579
* @function Dropbox#teamTeamFolderRename
35793580
* @arg {TeamTeamFolderRenameArg} arg - The request parameters.
35803581
* @returns {Promise.<DropboxResponse<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderRenameError>>}
35813582
*/
35823583
routes.teamTeamFolderRename = function (arg) {
3583-
return this.request('team/team_folder/rename', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3584+
return this.request('team/team_folder/rename', arg, 'team', 'api', 'rpc', 'team_data.content.write');
35843585
};
35853586

35863587
/**
35873588
* Updates the sync settings on a team folder or its contents. Use of this
35883589
* endpoint requires that the team has team selective sync enabled.
35893590
* Route attributes:
3590-
* scope: team_data.team_space
3591+
* scope: team_data.content.write
35913592
* @function Dropbox#teamTeamFolderUpdateSyncSettings
35923593
* @arg {TeamTeamFolderUpdateSyncSettingsArg} arg - The request parameters.
35933594
* @returns {Promise.<DropboxResponse<TeamTeamFolderMetadata>, DropboxResponseError.<TeamTeamFolderUpdateSyncSettingsError>>}
35943595
*/
35953596
routes.teamTeamFolderUpdateSyncSettings = function (arg) {
3596-
return this.request('team/team_folder/update_sync_settings', arg, 'team', 'api', 'rpc', 'team_data.team_space');
3597+
return this.request('team/team_folder/update_sync_settings', arg, 'team', 'api', 'rpc', 'team_data.content.write');
35973598
};
35983599

35993600
/**

lib/types.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7218,6 +7218,8 @@ only present when needed to discriminate between multiple possible subtypes.
72187218
* Sensitivity level.
72197219
* @property {TeamLogRecipientsConfiguration} [recipients_settings] - Recipient
72207220
* settings.
7221+
* @property {string} [text] - Text.
7222+
* @property {string} [excluded_file_extensions] - Excluded file extensions.
72217223
*/
72227224

72237225
/**
@@ -14287,7 +14289,7 @@ subtypes.
1428714289

1428814290
/**
1428914291
* @typedef {Object} TeamLogPlacementRestriction
14290-
* @property {('australia_only'|'europe_only'|'japan_only'|'none'|'uk_only'|'other')} .tag - Tag identifying the union variant.
14292+
* @property {('australia_only'|'europe_only'|'japan_only'|'none'|'uk_only'|'us_s3_only'|'other')} .tag - Tag identifying the union variant.
1429114293
*/
1429214294

1429314295
/**

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dropbox",
3-
"version": "10.29.0",
3+
"version": "10.30.0",
44
"registry": "npm",
55
"description": "The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.",
66
"main": "cjs/index.js",

types/dropbox_types.d.ts

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15948,6 +15948,14 @@
1594815948
* Recipient settings.
1594915949
*/
1595015950
recipients_settings?: RecipientsConfiguration;
15951+
/**
15952+
* Text.
15953+
*/
15954+
text?: string;
15955+
/**
15956+
* Excluded file extensions.
15957+
*/
15958+
excluded_file_extensions?: string;
1595115959
}
1595215960

1595315961
export interface AdminAlertingAlertSensitivityHigh {
@@ -31734,11 +31742,15 @@
3173431742
'.tag': 'uk_only';
3173531743
}
3173631744

31745+
export interface PlacementRestrictionUsS3Only {
31746+
'.tag': 'us_s3_only';
31747+
}
31748+
3173731749
export interface PlacementRestrictionOther {
3173831750
'.tag': 'other';
3173931751
}
3174031752

31741-
export type PlacementRestriction = PlacementRestrictionAustraliaOnly | PlacementRestrictionEuropeOnly | PlacementRestrictionJapanOnly | PlacementRestrictionNone | PlacementRestrictionUkOnly | PlacementRestrictionOther;
31753+
export type PlacementRestriction = PlacementRestrictionAustraliaOnly | PlacementRestrictionEuropeOnly | PlacementRestrictionJapanOnly | PlacementRestrictionNone | PlacementRestrictionUkOnly | PlacementRestrictionUsS3Only | PlacementRestrictionOther;
3174231754

3174331755
export interface PolicyTypeDisposition {
3174431756
'.tag': 'disposition';

0 commit comments

Comments
 (0)