Skip to content

Commit 82ab898

Browse files
authored
Automated Spec Update (#920)
9daf01c5b7ac6936956f085792c573c06fb3c905 Change Notes: files Namespace - Update UploadArg - content_hash doc string sharing_folders Namespace - Add traverse to AccessLevel team_log_generated Namespace - Example and docstring updates
1 parent cf7ea0f commit 82ab898

File tree

5 files changed

+59
-49
lines changed

5 files changed

+59
-49
lines changed

lib/types.js

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2287,10 +2287,10 @@ only present when needed to discriminate between multiple possible subtypes.
22872287
* WriteMode.update and the given "rev" doesn't match the existing file's "rev",
22882288
* even if the existing file has been deleted. This also forces a conflict even
22892289
* when the target path refers to a file with identical contents.
2290-
* @property {string} [content_hash] - NOT YET SUPPORTED. A hash of the file
2291-
* content uploaded in this call. If provided and the uploaded content does not
2292-
* match this hash, an error will be returned. For more information see our
2293-
* Content hash https://www.dropbox.com/developers/reference/content-hash page.
2290+
* @property {string} [content_hash] - A hash of the file content uploaded in
2291+
* this call. If provided and the uploaded content does not match this hash, an
2292+
* error will be returned. For more information see our Content hash
2293+
* https://www.dropbox.com/developers/reference/content-hash page.
22942294
*/
22952295

22962296
/**
@@ -2311,10 +2311,10 @@ only present when needed to discriminate between multiple possible subtypes.
23112311
* @property {boolean} close - If true, the current session will be closed, at
23122312
* which point you won't be able to call upload_session/append:2 anymore with
23132313
* the current session.
2314-
* @property {string} [content_hash] - NOT YET SUPPORTED. A hash of the file
2315-
* content uploaded in this call. If provided and the uploaded content does not
2316-
* match this hash, an error will be returned. For more information see our
2317-
* Content hash https://www.dropbox.com/developers/reference/content-hash page.
2314+
* @property {string} [content_hash] - A hash of the file content uploaded in
2315+
* this call. If provided and the uploaded content does not match this hash, an
2316+
* error will be returned. For more information see our Content hash
2317+
* https://www.dropbox.com/developers/reference/content-hash page.
23182318
*/
23192319

23202320
/**
@@ -2344,10 +2344,10 @@ only present when needed to discriminate between multiple possible subtypes.
23442344
* and the offset.
23452345
* @property {FilesCommitInfo} commit - Contains the path and other optional
23462346
* modifiers for the commit.
2347-
* @property {string} [content_hash] - NOT YET SUPPORTED. A hash of the file
2348-
* content uploaded in this call. If provided and the uploaded content does not
2349-
* match this hash, an error will be returned. For more information see our
2350-
* Content hash https://www.dropbox.com/developers/reference/content-hash page.
2347+
* @property {string} [content_hash] - A hash of the file content uploaded in
2348+
* this call. If provided and the uploaded content does not match this hash, an
2349+
* error will be returned. For more information see our Content hash
2350+
* https://www.dropbox.com/developers/reference/content-hash page.
23512351
*/
23522352

23532353
/**
@@ -2428,10 +2428,10 @@ only present when needed to discriminate between multiple possible subtypes.
24282428
* the current session.
24292429
* @property {FilesUploadSessionType} [session_type] - Type of upload session
24302430
* you want to start. If not specified, default is UploadSessionType.sequential.
2431-
* @property {string} [content_hash] - NOT YET SUPPORTED. A hash of the file
2432-
* content uploaded in this call. If provided and the uploaded content does not
2433-
* match this hash, an error will be returned. For more information see our
2434-
* Content hash https://www.dropbox.com/developers/reference/content-hash page.
2431+
* @property {string} [content_hash] - A hash of the file content uploaded in
2432+
* this call. If provided and the uploaded content does not match this hash, an
2433+
* error will be returned. For more information see our Content hash
2434+
* https://www.dropbox.com/developers/reference/content-hash page.
24352435
*/
24362436

24372437
/**
@@ -2929,7 +2929,7 @@ only present when needed to discriminate between multiple possible subtypes.
29292929
/**
29302930
* Defines the access levels for collaborators.
29312931
* @typedef {Object} SharingAccessLevel
2932-
* @property {('owner'|'editor'|'viewer'|'viewer_no_comment'|'other')} .tag - Tag identifying the union variant.
2932+
* @property {('owner'|'editor'|'viewer'|'viewer_no_comment'|'traverse'|'other')} .tag - Tag identifying the union variant.
29332933
*/
29342934

29352935
/**
@@ -8286,13 +8286,13 @@ is only present when needed to discriminate between multiple possible subtypes.
82868286
*/
82878287

82888288
/**
8289-
* Policy for deciding whether a team can use Email to my Dropbox feature
8289+
* Policy for deciding whether a team can use Email to Dropbox feature
82908290
* @typedef {Object} TeamLogEmailIngestPolicy
82918291
* @property {('disabled'|'enabled'|'other')} .tag - Tag identifying the union variant.
82928292
*/
82938293

82948294
/**
8295-
* Changed email to my Dropbox policy for team.
8295+
* Changed email to Dropbox policy for team.
82968296
* @typedef {Object} TeamLogEmailIngestPolicyChangedDetails
82978297
* @property {TeamLogEmailIngestPolicy} new_value - To.
82988298
* @property {TeamLogEmailIngestPolicy} previous_value - From.
@@ -8304,7 +8304,7 @@ is only present when needed to discriminate between multiple possible subtypes.
83048304
*/
83058305

83068306
/**
8307-
* Received files via Email to my Dropbox.
8307+
* Received files via Email to Dropbox.
83088308
* @typedef {Object} TeamLogEmailIngestReceiveFileDetails
83098309
* @property {string} inbox_name - Inbox name.
83108310
* @property {Array.<string>} attachment_names - Submitted file names.
@@ -10041,7 +10041,7 @@ is only present when needed to discriminate between multiple possible subtypes.
1004110041
* .tag is user_tags_removed. (file_operations) Removed tags
1004210042
* @property {TeamLogEmailIngestReceiveFileType} [email_ingest_receive_file] -
1004310043
* Available if .tag is email_ingest_receive_file. (file_requests) Received
10044-
* files via Email to my Dropbox
10044+
* files via Email to Dropbox
1004510045
* @property {TeamLogFileRequestChangeType} [file_request_change] - Available if
1004610046
* .tag is file_request_change. (file_requests) Changed file request
1004710047
* @property {TeamLogFileRequestCloseType} [file_request_close] - Available if
@@ -10860,7 +10860,7 @@ is only present when needed to discriminate between multiple possible subtypes.
1086010860
* directory restrictions list
1086110861
* @property {TeamLogEmailIngestPolicyChangedType} [email_ingest_policy_changed]
1086210862
* - Available if .tag is email_ingest_policy_changed. (team_policies) Changed
10863-
* email to my Dropbox policy for team
10863+
* email to Dropbox policy for team
1086410864
* @property {TeamLogEmmAddExceptionType} [emm_add_exception] - Available if
1086510865
* .tag is emm_add_exception. (team_policies) Added members to EMM exception
1086610866
* list

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.25.0",
3+
"version": "10.26.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: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4810,9 +4810,9 @@
48104810
*/
48114811
contents?: Object;
48124812
/**
4813-
* NOT YET SUPPORTED. A hash of the file content uploaded in this call. If
4814-
* provided and the uploaded content does not match this hash, an error
4815-
* will be returned. For more information see our [Content hash]{@link
4813+
* A hash of the file content uploaded in this call. If provided and the
4814+
* uploaded content does not match this hash, an error will be returned.
4815+
* For more information see our [Content hash]{@link
48164816
* https://www.dropbox.com/developers/reference/content-hash} page.
48174817
*/
48184818
content_hash?: Sha256HexHash;
@@ -4869,9 +4869,9 @@
48694869
*/
48704870
close?: boolean;
48714871
/**
4872-
* NOT YET SUPPORTED. A hash of the file content uploaded in this call. If
4873-
* provided and the uploaded content does not match this hash, an error
4874-
* will be returned. For more information see our [Content hash]{@link
4872+
* A hash of the file content uploaded in this call. If provided and the
4873+
* uploaded content does not match this hash, an error will be returned.
4874+
* For more information see our [Content hash]{@link
48754875
* https://www.dropbox.com/developers/reference/content-hash} page.
48764876
*/
48774877
content_hash?: Sha256HexHash;
@@ -4918,9 +4918,9 @@
49184918
*/
49194919
commit: CommitInfo;
49204920
/**
4921-
* NOT YET SUPPORTED. A hash of the file content uploaded in this call. If
4922-
* provided and the uploaded content does not match this hash, an error
4923-
* will be returned. For more information see our [Content hash]{@link
4921+
* A hash of the file content uploaded in this call. If provided and the
4922+
* uploaded content does not match this hash, an error will be returned.
4923+
* For more information see our [Content hash]{@link
49244924
* https://www.dropbox.com/developers/reference/content-hash} page.
49254925
*/
49264926
content_hash?: Sha256HexHash;
@@ -5153,9 +5153,9 @@
51535153
*/
51545154
session_type?: UploadSessionType;
51555155
/**
5156-
* NOT YET SUPPORTED. A hash of the file content uploaded in this call. If
5157-
* provided and the uploaded content does not match this hash, an error
5158-
* will be returned. For more information see our [Content hash]{@link
5156+
* A hash of the file content uploaded in this call. If provided and the
5157+
* uploaded content does not match this hash, an error will be returned.
5158+
* For more information see our [Content hash]{@link
51595159
* https://www.dropbox.com/developers/reference/content-hash} page.
51605160
*/
51615161
content_hash?: Sha256HexHash;
@@ -6550,14 +6550,22 @@
65506550
'.tag': 'viewer_no_comment';
65516551
}
65526552

6553+
/**
6554+
* The collaborator can only view the shared folder that they have access
6555+
* to.
6556+
*/
6557+
export interface AccessLevelTraverse {
6558+
'.tag': 'traverse';
6559+
}
6560+
65536561
export interface AccessLevelOther {
65546562
'.tag': 'other';
65556563
}
65566564

65576565
/**
65586566
* Defines the access levels for collaborators.
65596567
*/
6560-
export type AccessLevel = AccessLevelOwner | AccessLevelEditor | AccessLevelViewer | AccessLevelViewerNoComment | AccessLevelOther;
6568+
export type AccessLevel = AccessLevelOwner | AccessLevelEditor | AccessLevelViewer | AccessLevelViewerNoComment | AccessLevelTraverse | AccessLevelOther;
65616569

65626570
/**
65636571
* Only the owner can update the ACL.
@@ -6610,8 +6618,9 @@
66106618
* Defaults to TagRef(Union('AccessLevel', [UnionField('owner', Void,
66116619
* False, None), UnionField('editor', Void, False, None),
66126620
* UnionField('viewer', Void, False, None),
6613-
* UnionField('viewer_no_comment', Void, False, None), UnionField('other',
6614-
* Void, True, None)]), 'viewer').
6621+
* UnionField('viewer_no_comment', Void, False, None),
6622+
* UnionField('traverse', Void, False, None), UnionField('other', Void,
6623+
* True, None)]), 'viewer').
66156624
*/
66166625
access_level?: AccessLevel;
66176626
/**
@@ -6792,8 +6801,9 @@
67926801
* Defaults to TagRef(Union('AccessLevel', [UnionField('owner', Void,
67936802
* False, None), UnionField('editor', Void, False, None),
67946803
* UnionField('viewer', Void, False, None),
6795-
* UnionField('viewer_no_comment', Void, False, None), UnionField('other',
6796-
* Void, True, None)]), 'viewer').
6804+
* UnionField('viewer_no_comment', Void, False, None),
6805+
* UnionField('traverse', Void, False, None), UnionField('other', Void,
6806+
* True, None)]), 'viewer').
67976807
*/
67986808
access_level?: AccessLevel;
67996809
}
@@ -17756,12 +17766,12 @@
1775617766
}
1775717767

1775817768
/**
17759-
* Policy for deciding whether a team can use Email to my Dropbox feature
17769+
* Policy for deciding whether a team can use Email to Dropbox feature
1776017770
*/
1776117771
export type EmailIngestPolicy = EmailIngestPolicyDisabled | EmailIngestPolicyEnabled | EmailIngestPolicyOther;
1776217772

1776317773
/**
17764-
* Changed email to my Dropbox policy for team.
17774+
* Changed email to Dropbox policy for team.
1776517775
*/
1776617776
export interface EmailIngestPolicyChangedDetails {
1776717777
/**
@@ -17779,7 +17789,7 @@
1777917789
}
1778017790

1778117791
/**
17782-
* Received files via Email to my Dropbox.
17792+
* Received files via Email to Dropbox.
1778317793
*/
1778417794
export interface EmailIngestReceiveFileDetails {
1778517795
/**
@@ -20765,7 +20775,7 @@
2076520775
}
2076620776

2076720777
/**
20768-
* (file_requests) Received files via Email to my Dropbox
20778+
* (file_requests) Received files via Email to Dropbox
2076920779
*/
2077020780
export interface EventTypeEmailIngestReceiveFile extends EmailIngestReceiveFileType {
2077120781
'.tag': 'email_ingest_receive_file';
@@ -22698,7 +22708,7 @@
2269822708
}
2269922709

2270022710
/**
22701-
* (team_policies) Changed email to my Dropbox policy for team
22711+
* (team_policies) Changed email to Dropbox policy for team
2270222712
*/
2270322713
export interface EventTypeEmailIngestPolicyChanged extends EmailIngestPolicyChangedType {
2270422714
'.tag': 'email_ingest_policy_changed';
@@ -24201,7 +24211,7 @@
2420124211
}
2420224212

2420324213
/**
24204-
* (file_requests) Received files via Email to my Dropbox
24214+
* (file_requests) Received files via Email to Dropbox
2420524215
*/
2420624216
export interface EventTypeArgEmailIngestReceiveFile {
2420724217
'.tag': 'email_ingest_receive_file';
@@ -26134,7 +26144,7 @@
2613426144
}
2613526145

2613626146
/**
26137-
* (team_policies) Changed email to my Dropbox policy for team
26147+
* (team_policies) Changed email to Dropbox policy for team
2613826148
*/
2613926149
export interface EventTypeArgEmailIngestPolicyChanged {
2614026150
'.tag': 'email_ingest_policy_changed';

0 commit comments

Comments
 (0)