Automated Spec Update (#849)

6e0a08f15d3f28359208e079656780789361a95f

 Change Notes:

files Namespace
- Update list_folder route to include app auth
- Update list_folder/continue route to include app auth
- Update Examples

Add file_tagging Namespace

Co-authored-by: DropboxBot <DropboxBot@users.noreply.github.com>

Author: DropboxBot

generator/dropbox-api-spec

@@ -765,7 +765,7 @@ routes.filesGetThumbnailBatch = function (arg) {
  * @returns {Promise.<DropboxResponse<FilesListFolderResult>, DropboxResponseError.<FilesListFolderError>>}
  */
 routes.filesListFolder = function (arg) {
-  return this.request('files/list_folder', arg, 'user', 'api', 'rpc');
+  return this.request('files/list_folder', arg, 'app, user', 'api', 'rpc');
 };
 
 /**
@@ -777,7 +777,7 @@ routes.filesListFolder = function (arg) {
  * @returns {Promise.<DropboxResponse<FilesListFolderResult>, DropboxResponseError.<FilesListFolderContinueError>>}
  */
 routes.filesListFolderContinue = function (arg) {
-  return this.request('files/list_folder/continue', arg, 'user', 'api', 'rpc');
+  return this.request('files/list_folder/continue', arg, 'app, user', 'api', 'rpc');
 };
 
 /**
@@ -1081,6 +1081,37 @@ routes.filesSearchContinueV2 = function (arg) {
   return this.request('files/search/continue_v2', arg, 'user', 'api', 'rpc');
 };
 
+/**
+ * Add a tag to an item. A tag is a string. No more than 20 tags can be added to
+ * a given item.
+ * @function Dropbox#filesTagsAdd
+ * @arg {FilesAddTagArg} arg - The request parameters.
+ * @returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesAddTagError>>}
+ */
+routes.filesTagsAdd = function (arg) {
+  return this.request('files/tags/add', arg, 'user', 'api', 'rpc');
+};
+
+/**
+ * Get list of tags assigned to items.
+ * @function Dropbox#filesTagsGet
+ * @arg {FilesGetTagsArg} arg - The request parameters.
+ * @returns {Promise.<DropboxResponse<FilesGetTagsResult>, DropboxResponseError.<FilesBaseTagError>>}
+ */
+routes.filesTagsGet = function (arg) {
+  return this.request('files/tags/get', arg, 'user', 'api', 'rpc');
+};
+
+/**
+ * Remove a tag from an item.
+ * @function Dropbox#filesTagsRemove
+ * @arg {FilesRemoveTagArg} arg - The request parameters.
+ * @returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesRemoveTagError>>}
+ */
+routes.filesTagsRemove = function (arg) {
+  return this.request('files/tags/remove', arg, 'user', 'api', 'rpc');
+};
+
 /**
  * Unlock the files at the given paths. A locked file can only be unlocked by
  * the lock holder or, if a business account, a team admin. A successful

lib/routes.js

@@ -773,6 +773,17 @@ only present when needed to discriminate between multiple possible subtypes.
  * @property {('disabled_for_team'|'other'|'not_found'|'not_a_folder'|'app_lacks_access'|'no_permission'|'email_unverified'|'validation_error')} .tag - Tag identifying the union variant.
  */
 
+/**
+ * @typedef {Object} FilesAddTagArg
+ * @property {string} path - Path to the item to be tagged.
+ * @property {string} tag_text - The value of the tag to add.
+ */
+
+/**
+ * @typedef {Object} FilesAddTagError
+ * @property {('unknown'|'transient'|'input_validation'|'cancelled'|'other'|'feature_not_supported'|'path_not_found'|'too_many_tags')} .tag - Tag identifying the union variant.
+ */
+
 /**
  * @typedef {Object} FilesAlphaGetMetadataArg
  * @property {string} path - The path of a file or folder on Dropbox.
@@ -801,6 +812,16 @@ only present when needed to discriminate between multiple possible subtypes.
  * @property {('path'|'properties_error')} .tag - Tag identifying the union variant.
  */
 
+/**
+ * @typedef {Object} FilesBaseError
+ * @property {('unknown'|'transient'|'input_validation'|'cancelled'|'other')} .tag - Tag identifying the union variant.
+ */
+
+/**
+ * @typedef {Object} FilesBaseTagError
+ * @property {('unknown'|'transient'|'input_validation'|'cancelled'|'other'|'feature_not_supported'|'path_not_found')} .tag - Tag identifying the union variant.
+ */
+
 /**
  * @typedef {Object} FilesCommitInfo
  * @property {Object} [contents] - The file contents to be uploaded.
@@ -1318,6 +1339,17 @@ is only present when needed to discriminate between multiple possible subtypes.
  * @property {'path'} .tag - Tag identifying the union variant.
  */
 
+/**
+ * @typedef {Object} FilesGetTagsArg
+ * @property {Array.<Object>} paths - Path to the items.
+ */
+
+/**
+ * @typedef {Object} FilesGetTagsResult
+ * @property {Array.<FilesPathToTags>} paths_to_tags - List of paths and their
+ * corresponding tags.
+ */
+
 /**
  * @typedef {Object} FilesGetTemporaryLinkArg
  * @property {string} path - The path to the file you want a temporary link to.
@@ -1730,6 +1762,12 @@ variant.
  * @property {('path'|'link'|'other')} .tag - Tag identifying the union variant.
  */
 
+/**
+ * @typedef {Object} FilesPathToTags
+ * @property {string} path - Path of the item.
+ * @property {Array.<FilesTag>} tags - Tags assigned to this item.
+ */
+
 /**
  * Metadata for a photo.
  * @typedef {Object} FilesPhotoMetadata
@@ -1913,6 +1951,17 @@ only present when needed to discriminate between multiple possible subtypes.
  * metadata - Metadata of the relocated object.
  */
 
+/**
+ * @typedef {Object} FilesRemoveTagArg
+ * @property {string} path - Path to the item to tag.
+ * @property {string} tag_text - The tag to remove.
+ */
+
+/**
+ * @typedef {Object} FilesRemoveTagError
+ * @property {('unknown'|'transient'|'input_validation'|'cancelled'|'other'|'feature_not_supported'|'path_not_found'|'tag_not_exists_for_this_path')} .tag - Tag identifying the union variant.
+ */
+
 /**
  * @typedef {Object} FilesRestoreArg
  * @property {string} path - The path to save the restored file.
@@ -2159,6 +2208,14 @@ only present when needed to discriminate between multiple possible subtypes.
  * @property {('path'|'unsupported_combination'|'unsupported_configuration'|'other')} .tag - Tag identifying the union variant.
  */
 
+/**
+ * Tag that can be added in multiple ways.
+ * @typedef {Object} FilesTag
+ * @property {FilesUserGeneratedTag} [user_generated_tag] - Available if .tag is
+ * user_generated_tag. Tag generated by the user.
+ * @property {('user_generated_tag'|'other')} .tag - Tag identifying the union variant.
+ */
+
 /**
  * @typedef {Object} FilesThumbnailArg
  * @property {string} path - The path to the image file you want to thumbnail.
@@ -2378,6 +2435,11 @@ only present when needed to discriminate between multiple possible subtypes.
  * used to retry the commit with upload_session/finish.
  */
 
+/**
+ * @typedef {Object} FilesUserGeneratedTag
+ * @property {string} tag_text
+ */
+
 /**
  * Metadata for a video.
  * @typedef {Object} FilesVideoMetadata

lib/types.js

@@ -1,6 +1,6 @@
 {
     "name": "dropbox",
-    "version": "10.16.0",
+    "version": "10.17.0",
     "registry": "npm",
     "description": "The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.",
     "main": "cjs/index.js",

package-lock.json

@@ -1633,6 +1633,26 @@
    * This namespace contains endpoints and data types for basic file operations.
    */
   export namespace files {
+    export interface AddTagArg {
+      /**
+       * Path to the item to be tagged.
+       */
+      path: Path;
+      /**
+       * The value of the tag to add.
+       */
+      tag_text: TagText;
+    }
+
+    /**
+     * Item already has max supported tags.
+     */
+    export interface AddTagErrorTooManyTags {
+      '.tag': 'too_many_tags';
+    }
+
+    export type AddTagError = BaseTagError | AddTagErrorTooManyTags;
+
     export interface AlphaGetMetadataArg extends GetMetadataArg {
       /**
        * If set to a valid list of template IDs, FileMetadata.property_groups is
@@ -1648,6 +1668,56 @@
 
     export type AlphaGetMetadataError = GetMetadataError | AlphaGetMetadataErrorPropertiesError;
 
+    /**
+     * Action failed.
+     */
+    export interface BaseErrorUnknown {
+      '.tag': 'unknown';
+    }
+
+    /**
+     * Action failed. Try again.
+     */
+    export interface BaseErrorTransient {
+      '.tag': 'transient';
+    }
+
+    /**
+     * Action failed due to wrong params.
+     */
+    export interface BaseErrorInputValidation {
+      '.tag': 'input_validation';
+    }
+
+    /**
+     * Action cancelled.
+     */
+    export interface BaseErrorCancelled {
+      '.tag': 'cancelled';
+    }
+
+    export interface BaseErrorOther {
+      '.tag': 'other';
+    }
+
+    export type BaseError = BaseErrorUnknown | BaseErrorTransient | BaseErrorInputValidation | BaseErrorCancelled | BaseErrorOther;
+
+    /**
+     * Tags are not turned on for your team. Please turn on the feature.
+     */
+    export interface BaseTagErrorFeatureNotSupported {
+      '.tag': 'feature_not_supported';
+    }
+
+    /**
+     * Path not found.
+     */
+    export interface BaseTagErrorPathNotFound {
+      '.tag': 'path_not_found';
+    }
+
+    export type BaseTagError = BaseError | BaseTagErrorFeatureNotSupported | BaseTagErrorPathNotFound;
+
     export interface CommitInfo {
       /**
        * The file contents to be uploaded.
@@ -2535,6 +2605,20 @@
 
     export type GetMetadataError = GetMetadataErrorPath;
 
+    export interface GetTagsArg {
+      /**
+       * Path to the items.
+       */
+      paths: Array<Path>;
+    }
+
+    export interface GetTagsResult {
+      /**
+       * List of paths and their corresponding tags.
+       */
+      paths_to_tags: Array<PathToTags>;
+    }
+
     export interface GetTemporaryLinkArg {
       /**
        * The path to the file you want a temporary link to.
@@ -3490,6 +3574,17 @@
 
     export type PathOrLink = PathOrLinkPath | PathOrLinkLink | PathOrLinkOther;
 
+    export interface PathToTags {
+      /**
+       * Path of the item.
+       */
+      path: Path;
+      /**
+       * Tags assigned to this item.
+       */
+      tags: Array<Tag>;
+    }
+
     /**
      * Metadata for a photo.
      */
@@ -3850,6 +3945,26 @@
       metadata: FileMetadataReference|FolderMetadataReference|DeletedMetadataReference;
     }
 
+    export interface RemoveTagArg {
+      /**
+       * Path to the item to tag.
+       */
+      path: Path;
+      /**
+       * The tag to remove.
+       */
+      tag_text: TagText;
+    }
+
+    /**
+     * That tag doesn't exist at this path.
+     */
+    export interface RemoveTagErrorTagNotExistsForThisPath {
+      '.tag': 'tag_not_exists_for_this_path';
+    }
+
+    export type RemoveTagError = BaseTagError | RemoveTagErrorTagNotExistsForThisPath;
+
     export interface RestoreArg {
       /**
        * The path to save the restored file.
@@ -4449,6 +4564,22 @@
 
     export type SyncSettingsError = SyncSettingsErrorPath | SyncSettingsErrorUnsupportedCombination | SyncSettingsErrorUnsupportedConfiguration | SyncSettingsErrorOther;
 
+    /**
+     * Tag generated by the user.
+     */
+    export interface TagUserGeneratedTag extends UserGeneratedTag {
+      '.tag': 'user_generated_tag';
+    }
+
+    export interface TagOther {
+      '.tag': 'other';
+    }
+
+    /**
+     * Tag that can be added in multiple ways.
+     */
+    export type Tag = TagUserGeneratedTag | TagOther;
+
     export interface ThumbnailArg {
       /**
        * The path to the image file you want to thumbnail.
@@ -5040,6 +5171,10 @@
       upload_session_id: string;
     }
 
+    export interface UserGeneratedTag {
+      tag_text: TagText;
+    }
+
     /**
      * Metadata for a video.
      */
@@ -5232,6 +5367,8 @@
 
     export type SharedLinkUrl = string;
 
+    export type TagText = string;
+
     export type WritePath = string;
 
     export type WritePathOrId = string;