box-node-sdk 1.36.0 → 1.38.0

package/lib/managers/folders.js

@@ -1,28 +1,22 @@
+"use strict";
 /**
  * @fileoverview Manager for the Box Folders Resource
  */
-
-'use strict';
-
-// ------------------------------------------------------------------------------
-// Requirements
-// ------------------------------------------------------------------------------
-var urlPath = require('../util/url-path'),
-	errors = require('../util/errors');
-
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
+var errors_1 = __importDefault(require("../util/errors"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
-var BASE_PATH = '/folders',
-	FOLDER_LOCK = '/folder_locks',
-	WATERMARK_SUBRESOURCE = '/watermark';
-
-
+var BASE_PATH = '/folders', FOLDER_LOCK = '/folder_locks', WATERMARK_SUBRESOURCE = '/watermark';
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all 'Folder' endpoints and actions.
  *
@@ -30,618 +24,545 @@ var BASE_PATH = '/folders',
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function Folders(client) {
-	this.client = client;
-}
-
-/**
- * Requests a folder object with the given ID.
- *
- * API Endpoint: '/folders/:folderID'
- * Method: GET
- *
- * @param {string} folderID - Box ID of the folder being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the folder object
- */
-Folders.prototype.get = function(folderID, options, callback) {
-	var params = {
-		qs: options
-	};
-	var apiPath = urlPath(BASE_PATH, folderID);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Requests items contained within a given folder.
- *
- * API Endpoint: '/folders/:folderID/items'
- * Method: GET
- *
- * @param {string} folderID - Box ID of the folder being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the collection of the items in the folder
- */
-Folders.prototype.getItems = function(folderID, options, callback) {
-	var params = {
-		qs: options
-	};
-	var apiPath = urlPath(BASE_PATH, folderID, '/items');
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Requests collaborations on a given folder.
- *
- * API Endpoint: '/folders/:folderID/collaborations'
- * Method: GET
- *
- * @param {string} folderID - Box ID of the folder being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the collection of collaborations
- */
-Folders.prototype.getCollaborations = function(folderID, options, callback) {
-	var params = {
-		qs: options
-	};
-	var apiPath = urlPath(BASE_PATH, folderID, '/collaborations');
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Creates a new Folder within a parent folder
- *
- * API Endpoint: '/folders
- * Method: POST
- *
- * @param {string} parentFolderID - Box folder id of the folder to add into
- * @param {string} name - The name for the new folder
- * @param {Function} [callback] - passed the new folder info if call was successful
- * @returns {Promise<Object>} A promise resolving to the created folder object
- */
-Folders.prototype.create = function(parentFolderID, name, callback) {
-	var params = {
-		body: {
-			name,
-			parent: {
-				id: parentFolderID
-			}
-		}
-	};
-	return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
-};
-
-/**
- * Copy a folder into a new, different folder
- *
- * API Endpoint: '/folders/:folderID/copy
- * Method: POST
- *
- * @param {string} folderID - The Box ID of the folder being requested
- * @param {string} newParentID - The Box ID for the new parent folder. '0' to copy to All Files.
- * @param {Object} [options] - Optional parameters for the copy operation, can be left null in most cases
- * @param {string} [options.name] - A new name to use if there is an identically-named item in the new parent folder
- * @param {Function} [callback] - passed the new folder info if call was successful
- * @returns {Promise<Object>} A promise resolving to the new folder object
- */
-Folders.prototype.copy = function(folderID, newParentID, options, callback) {
-
-	// @NOTE(mwiller) 2016-10-25: Shuffle arguments to maintain backward compatibility
-	//  This can be removed at the v2.0 update
-	if (typeof options === 'function') {
-		callback = options;
-		options = {};
-	}
-
-	options = options || {};
-
-	options.parent = {
-		id: newParentID
-	};
-
-	var params = {
-		body: options
-	};
-	var apiPath = urlPath(BASE_PATH, folderID, '/copy');
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Update some information about a given folder.
- *
- * API Endpoint: '/folders/:folderID'
- * Method: PUT
- *
- * @param {string} folderID - The Box ID of the folder being requested
- * @param {Object} updates - Folder fields to update
- * @param {string} [updates.etag] Only update the folder if the ETag matches
- * @param {Function} [callback] - Passed the updated folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the updated folder object
- */
-Folders.prototype.update = function(folderID, updates, callback) {
-	var params = {
-		body: updates
-	};
-
-	if (updates && updates.etag) {
-		params.headers = {
-			'If-Match': updates.etag
-		};
-		delete updates.etag;
-	}
-
-	var apiPath = urlPath(BASE_PATH, folderID);
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * Add a folder to a given collection
- *
- * API Endpoint: '/folders/:folderID'
- * Method: PUT
- *
- * @param {string} folderID - The folder to add to the collection
- * @param {string} collectionID - The collection to add the folder to
- * @param {Function} [callback] - Passed the updated folder if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the updated folder object
- */
-Folders.prototype.addToCollection = function(folderID, collectionID, callback) {
-
-	return this.get(folderID, {fields: 'collections'})
-		.then(data => {
-
-			var collections = data.collections || [];
-
-			// Convert to correct format
-			collections = collections.map(c => ({id: c.id}));
-
-			if (!collections.find(c => c.id === collectionID)) {
-
-				collections.push({id: collectionID});
-			}
-
-			return this.update(folderID, {collections});
-		})
-		.asCallback(callback);
-};
-
-/**
- * Remove a folder from a given collection
- *
- * API Endpoint: '/folders/:folderID'
- * Method: PUT
- *
- * @param {string} folderID - The folder to remove from the collection
- * @param {string} collectionID - The collection to remove the folder from
- * @param {Function} [callback] - Passed the updated folder if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the updated folder object
- */
-Folders.prototype.removeFromCollection = function(folderID, collectionID, callback) {
-
-	return this.get(folderID, {fields: 'collections'})
-		.then(data => {
-
-			var collections = data.collections || [];
-			// Convert to correct object format and remove the specified collection
-			collections = collections.map(c => ({id: c.id})).filter(c => c.id !== collectionID);
-
-			return this.update(folderID, {collections});
-		})
-		.asCallback(callback);
-};
-
-/**
- * Move a folder into a new parent folder.
- *
- * API Endpoint: '/folders/:folderID'
- * Method: PUT
- *
- * @param {string} folderID - The Box ID of the folder being requested
- * @param {string} newParentID - The Box ID for the new parent folder. '0' to move to All Files.
- * @param {Function} [callback] - Passed the updated folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the updated folder object
- */
-Folders.prototype.move = function(folderID, newParentID, callback) {
-	var params = {
-		body: {
-			parent: {
-				id: newParentID
-			}
-		}
-	};
-	var apiPath = urlPath(BASE_PATH, folderID);
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * Delete a given folder.
- *
- * API Endpoint: '/folders/:folderID'
- * Method: DELETE
- *
- * @param {string} folderID - Box ID of the folder being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {string} [options.etag] Only delete the folder if the ETag matches
- * @param {Function} [callback] - Empty response body passed if successful.
- * @returns {Promise<void>} A promise resolving to nothing
- */
-Folders.prototype.delete = function(folderID, options, callback) {
-
-	var params = {
-		qs: options
-	};
-
-	if (options && options.etag) {
-		params.headers = {
-			'If-Match': options.etag
-		};
-		delete options.etag;
-	}
-
-	var apiPath = urlPath(BASE_PATH, folderID);
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
-};
-
-/**
- * Retrieves all metadata associated with a folder.
- *
- * API Endpoint: '/folders/:folderID/metadata'
- * Method: GET
- *
- * @param {string} folderID - the ID of the folder to get metadata for
- * @param {Function} [callback] - called with an array of metadata when successful
- * @returns {Promise<Object>} A promise resolving to the collection of metadata on the folder
- */
-Folders.prototype.getAllMetadata = function(folderID, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'metadata');
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
-};
-
-/**
- * Retrieve a single metadata template instance for a folder.
- *
- * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
- * Method: GET
- *
- * @param {string} folderID - The ID of the folder to retrive the metadata of
- * @param {string} scope - The scope of the metadata template, e.g. "global"
- * @param {string} template - The metadata template to retrieve
- * @param {Function} [callback] - Passed the metadata template if successful
- * @returns {Promise<Object>} A promise resolving to the metadata template
- */
-Folders.prototype.getMetadata = function(folderID, scope, template, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'metadata', scope, template);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
-};
-
-/**
- * Adds metadata to a folder.  Metadata must either match a template schema or
- * be placed into the unstructured "properties" template in global scope.
- *
- * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
- * Method: POST
- *
- * @param {string} folderID - The ID of the folder to add metadata to
- * @param {string} scope - The scope of the metadata template, e.g. "enterprise"
- * @param {string} template - The metadata template schema to add
- * @param {Object} data - Key/value pairs tp add as metadata
- * @param {Function} [callback] - Called with error if unsuccessful
- * @returns {Promise<Object>} A promise resolving to the created metadata
- */
-Folders.prototype.addMetadata = function(folderID, scope, template, data, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'metadata', scope, template),
-		params = {
-			body: data
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Updates a metadata template instance with JSON Patch-formatted data.
- *
- * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
- * Method: PUT
- *
- * @param {string} folderID - The folder to update metadata for
- * @param {string} scope - The scope of the template to update
- * @param {string} template - The template to update
- * @param {Object} patch - The patch data
- * @param {Function} [callback] - Called with updated metadata if successful
- * @returns {Promise<Object>} A promise resolving to the updated metadata
- */
-Folders.prototype.updateMetadata = function(folderID, scope, template, patch, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'metadata', scope, template),
-		params = {
-			body: patch,
-			headers: {
-				'Content-Type': 'application/json-patch+json'
-			}
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * Sets metadata on a folder, overwriting any metadata that exists for the provided keys.
- *
- * @param {string} folderID - The folder to set metadata on
- * @param {string} scope - The scope of the metadata template
- * @param {string} template - The key of the metadata template
- * @param {Object} metadata - The metadata to set
- * @param {Function} [callback] - Called with updated metadata if successful
- * @returns {Promise<Object>} A promise resolving to the updated metadata
- */
-Folders.prototype.setMetadata = function(folderID, scope, template, metadata, callback) {
-
-	return this.addMetadata(folderID, scope, template, metadata)
-		.catch(err => {
-
-			if (err.statusCode !== 409) {
-				throw err;
-			}
-
-			// Metadata already exists on the file; update instead
-			var updates = Object.keys(metadata).map(key => ({
-				op: 'add',
-				path: `/${key}`,
-				value: metadata[key],
-			}));
-
-			return this.updateMetadata(folderID, scope, template, updates);
-		})
-		.asCallback(callback);
-};
-
-/**
- * Deletes a metadata template from a folder.
- *
- * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
- * Method: DELETE
- *
- * @param {string} folderID - The ID of the folder to remove metadata from
- * @param {string} scope - The scope of the metadata template
- * @param {string} template - The template to remove from the folder
- * @param {Function} [callback] - Called with nothing if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to nothing
- */
-Folders.prototype.deleteMetadata = function(folderID, scope, template, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'metadata', scope, template);
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
-/**
- * Retrieves a folder that has been moved to the trash
- *
- * API Endpoint: '/folders/:folderID/trash'
- * Method: GET
- *
- * @param  {string} folderID  - The ID of the folder being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param  {Funnction} [callback]  - Passed the folder information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the trashed folder object
- */
-Folders.prototype.getTrashedFolder = function(folderID, options, callback) {
-	var params = {
-		qs: options
-	};
-
-	var apiPath = urlPath(BASE_PATH, folderID, 'trash');
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Restores an item that has been moved to the trash. Default behavior is to restore the item
- * to the folder it was in before it was moved to the trash. If that parent folder no longer
- * exists or if there is now an item with the same name in that parent folder, the new parent
- * older and/or new name will need to be included in the request.
- *
- * API Endpoint: '/folders/:folderID'
- * Method: POST
- *
- * @param {string} folderID - The ID of the folder to restore
- * @param {Object} [options] - Optional parameters, can be left null
- * @param {?string} [options.name] - The new name for this item
- * @param {string} [options.parent_id] - The new parent folder for this item
- * @param {Function} [callback] - Called with folder information if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the restored folder object
- */
-Folders.prototype.restoreFromTrash = function(folderID, options, callback) {
-
-	// Set up the parent_id parameter
-	if (options && options.parent_id) {
-
-		options.parent = {
-			id: options.parent_id
-		};
-
-		delete options.parent_id;
-	}
-
-	var apiPath = urlPath(BASE_PATH, folderID),
-		params = {
-			body: options || {}
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone
- *
- * API Endpoint: '/folders/:folderID/trash'
- * Method: DELETE
- *
- * @param  {string} folderID Box ID of the folder being requested
- * @param {Object} [options] Optional parameters
- * @param {string} [options.etag] Only delete the folder if the ETag matches
- * @param  {Function} [callback] Called with nothing if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to nothing
- */
-Folders.prototype.deletePermanently = function(folderID, options, callback) {
-
-	// Switch around arguments if necessary for backwards compatibility
-	if (typeof options === 'function') {
-		callback = options;
-		options = {};
-	}
-
-	var params = {};
-
-	if (options && options.etag) {
-		params.headers = {
-			'If-Match': options.etag
-		};
-	}
-
-	var apiPath = urlPath(BASE_PATH, folderID, '/trash');
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
-};
-
-/**
- * Used to retrieve the watermark for a corresponding Box folder.
- *
- * API Endpoint: '/folders/:folderID/watermark'
- * Method: GET
- *
- * @param {string} folderID - The Box ID of the folder to get watermark for
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the watermark information if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the watermark info
- */
-Folders.prototype.getWatermark = function(folderID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, WATERMARK_SUBRESOURCE),
-		params = {
-			qs: options
-		};
-
-	return this.client.get(apiPath, params)
-		.then(response => {
-
-			if (response.statusCode !== 200) {
-				throw errors.buildUnexpectedResponseError(response);
-			}
-
-			return response.body.watermark;
-		})
-		.asCallback(callback);
-};
-
-/**
- * Used to apply or update the watermark for a corresponding Box folder.
- *
- * API Endpoint: '/folders/:folderID/watermark'
- * Method: PUT
- *
- * @param {string} folderID - The Box ID of the folder to update watermark for
- * @param {Object} [options] - Optional parameters, can be left null
- * @param {Function} [callback] - Passed the watermark information if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the watermark info
- */
-Folders.prototype.applyWatermark = function(folderID, options, callback) {
-	var apiPath = urlPath(BASE_PATH, folderID, WATERMARK_SUBRESOURCE),
-		params = {
-			body: {
-				watermark: {
-					imprint: 'default' // Currently the API only supports default imprint
-				}
-			}
-		};
-
-	Object.assign(params.body.watermark, options);
-
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * Used to remove the watermark for a corresponding Box folder.
- *
- * API Endpoint: '/folders/:folderID/watermark'
- * Method: DELETE
- *
- * @param {string} folderID - The Box ID of the folder to remove watermark from
- * @param {Function} [callback] - Empty response body passed if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to nothing
- */
-Folders.prototype.removeWatermark = function(folderID, callback) {
-
-	var apiPath = urlPath(BASE_PATH, folderID, WATERMARK_SUBRESOURCE);
-
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
-/**
- * Used to lock a Box folder.
- *
- * API Endpoint: '/folder_locks'
- * Method: POST
- *
- * @param {string} folderID - The Box ID of the folder to lock
- * @param {Function} [callback] - Passed the folder lock object if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to a folder lock object
- */
-Folders.prototype.lock = function(folderID, callback) {
-	var params = {
-		body: {
-			folder: {
-				type: 'folder',
-				id: folderID
-			},
-			locked_operations: {
-				move: true,
-				delete: true
-			}
-		}
-	};
-	return this.client.wrapWithDefaultHandler(this.client.post)(FOLDER_LOCK, params, callback);
-};
-
-/**
- * Used to get all locks on a folder.
- *
- * API Endpoint: '/folder_locks'
- * Method: GET
- *
- * @param {string} folderID - The Box ID of the folder to lock
- * @param {Function} [callback] - Passed a collection of folder lock objects if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to a collection of folder lock objects
- */
-Folders.prototype.getLocks = function(folderID, callback) {
-	var params = {
-		qs: {
-			folder_id: folderID
-		}
-	};
-	return this.client.wrapWithDefaultHandler(this.client.get)(FOLDER_LOCK, params, callback);
-};
-
-/**
- * Used to delete a lock on a folder.
- *
- * API Endpoint: '/folder_locks/:folderLockID'
- * Method: DELETE
- *
- * @param {string} folderLockID - The Box ID of the folder lock
- * @param {Function} [callback] - Empty response body passed if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to nothing
- */
-Folders.prototype.deleteLock = function(folderLockID, callback) {
-
-	var apiPath = urlPath(FOLDER_LOCK, folderLockID);
-
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-/**
- * @module box-node-sdk/lib/managers/folders
- * @see {@Link Folders}
- */
+var Folders = /** @class */ (function () {
+    function Folders(client) {
+        this.client = client;
+    }
+    /**
+     * Requests a folder object with the given ID.
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: GET
+     *
+     * @param {string} folderID - Box ID of the folder being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the folder object
+     */
+    Folders.prototype.get = function (folderID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Requests items contained within a given folder.
+     *
+     * API Endpoint: '/folders/:folderID/items'
+     * Method: GET
+     *
+     * @param {string} folderID - Box ID of the folder being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of the items in the folder
+     */
+    Folders.prototype.getItems = function (folderID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID, '/items');
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Requests collaborations on a given folder.
+     *
+     * API Endpoint: '/folders/:folderID/collaborations'
+     * Method: GET
+     *
+     * @param {string} folderID - Box ID of the folder being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of collaborations
+     */
+    Folders.prototype.getCollaborations = function (folderID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID, '/collaborations');
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Creates a new Folder within a parent folder
+     *
+     * API Endpoint: '/folders
+     * Method: POST
+     *
+     * @param {string} parentFolderID - Box folder id of the folder to add into
+     * @param {string} name - The name for the new folder
+     * @param {Function} [callback] - passed the new folder info if call was successful
+     * @returns {Promise<Object>} A promise resolving to the created folder object
+     */
+    Folders.prototype.create = function (parentFolderID, name, callback) {
+        var params = {
+            body: {
+                name: name,
+                parent: {
+                    id: parentFolderID,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    };
+    /**
+     * Copy a folder into a new, different folder
+     *
+     * API Endpoint: '/folders/:folderID/copy
+     * Method: POST
+     *
+     * @param {string} folderID - The Box ID of the folder being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to copy to All Files.
+     * @param {Object} [options] - Optional parameters for the copy operation, can be left null in most cases
+     * @param {string} [options.name] - A new name to use if there is an identically-named item in the new parent folder
+     * @param {Function} [callback] - passed the new folder info if call was successful
+     * @returns {Promise<Object>} A promise resolving to the new folder object
+     */
+    Folders.prototype.copy = function (folderID, newParentID, options, callback) {
+        // @NOTE(mwiller) 2016-10-25: Shuffle arguments to maintain backward compatibility
+        //  This can be removed at the v2.0 update
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        options = options || {};
+        options.parent = {
+            id: newParentID,
+        };
+        var params = {
+            body: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID, '/copy');
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Update some information about a given folder.
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: PUT
+     *
+     * @param {string} folderID - The Box ID of the folder being requested
+     * @param {Object} updates - Folder fields to update
+     * @param {string} [updates.etag] Only update the folder if the ETag matches
+     * @param {Function} [callback] - Passed the updated folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated folder object
+     */
+    Folders.prototype.update = function (folderID, updates, callback) {
+        var params = {
+            body: updates,
+        };
+        if (updates && updates.etag) {
+            params.headers = {
+                'If-Match': updates.etag,
+            };
+            delete updates.etag;
+        }
+        var apiPath = url_path_1.default(BASE_PATH, folderID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * Add a folder to a given collection
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: PUT
+     *
+     * @param {string} folderID - The folder to add to the collection
+     * @param {string} collectionID - The collection to add the folder to
+     * @param {Function} [callback] - Passed the updated folder if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated folder object
+     */
+    Folders.prototype.addToCollection = function (folderID, collectionID, callback) {
+        var _this = this;
+        return this.get(folderID, { fields: 'collections' })
+            .then(function (data /* FIXME */) {
+            var collections = data.collections || [];
+            // Convert to correct format
+            collections = collections.map(function (c /* FIXME */) { return ({ id: c.id }); });
+            if (!collections.find(function (c /* FIXME */) { return c.id === collectionID; })) {
+                collections.push({ id: collectionID });
+            }
+            return _this.update(folderID, { collections: collections });
+        })
+            .asCallback(callback);
+    };
+    /**
+     * Remove a folder from a given collection
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: PUT
+     *
+     * @param {string} folderID - The folder to remove from the collection
+     * @param {string} collectionID - The collection to remove the folder from
+     * @param {Function} [callback] - Passed the updated folder if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated folder object
+     */
+    Folders.prototype.removeFromCollection = function (folderID, collectionID, callback) {
+        var _this = this;
+        return this.get(folderID, { fields: 'collections' })
+            .then(function (data /* FIXME */) {
+            var collections = data.collections || [];
+            // Convert to correct object format and remove the specified collection
+            collections = collections
+                .map(function (c /* FIXME */) { return ({ id: c.id }); })
+                .filter(function (c /* FIXME */) { return c.id !== collectionID; });
+            return _this.update(folderID, { collections: collections });
+        })
+            .asCallback(callback);
+    };
+    /**
+     * Move a folder into a new parent folder.
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: PUT
+     *
+     * @param {string} folderID - The Box ID of the folder being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to move to All Files.
+     * @param {Function} [callback] - Passed the updated folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated folder object
+     */
+    Folders.prototype.move = function (folderID, newParentID, callback) {
+        var params = {
+            body: {
+                parent: {
+                    id: newParentID,
+                },
+            },
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * Delete a given folder.
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: DELETE
+     *
+     * @param {string} folderID - Box ID of the folder being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.etag] Only delete the folder if the ETag matches
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    Folders.prototype.delete = function (folderID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        if (options && options.etag) {
+            params.headers = {
+                'If-Match': options.etag,
+            };
+            delete options.etag;
+        }
+        var apiPath = url_path_1.default(BASE_PATH, folderID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    };
+    /**
+     * Retrieves all metadata associated with a folder.
+     *
+     * API Endpoint: '/folders/:folderID/metadata'
+     * Method: GET
+     *
+     * @param {string} folderID - the ID of the folder to get metadata for
+     * @param {Function} [callback] - called with an array of metadata when successful
+     * @returns {Promise<Object>} A promise resolving to the collection of metadata on the folder
+     */
+    Folders.prototype.getAllMetadata = function (folderID, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'metadata');
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    };
+    /**
+     * Retrieve a single metadata template instance for a folder.
+     *
+     * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
+     * Method: GET
+     *
+     * @param {string} folderID - The ID of the folder to retrive the metadata of
+     * @param {string} scope - The scope of the metadata template, e.g. "global"
+     * @param {string} template - The metadata template to retrieve
+     * @param {Function} [callback] - Passed the metadata template if successful
+     * @returns {Promise<Object>} A promise resolving to the metadata template
+     */
+    Folders.prototype.getMetadata = function (folderID, scope, template, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'metadata', scope, template);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    };
+    /**
+     * Adds metadata to a folder.  Metadata must either match a template schema or
+     * be placed into the unstructured "properties" template in global scope.
+     *
+     * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
+     * Method: POST
+     *
+     * @param {string} folderID - The ID of the folder to add metadata to
+     * @param {string} scope - The scope of the metadata template, e.g. "enterprise"
+     * @param {string} template - The metadata template schema to add
+     * @param {Object} data - Key/value pairs to add as metadata
+     * @param {Function} [callback] - Called with error if unsuccessful
+     * @returns {Promise<Object>} A promise resolving to the created metadata
+     */
+    Folders.prototype.addMetadata = function (folderID, scope, template, data, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'metadata', scope, template), params = {
+            body: data,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Updates a metadata template instance with JSON Patch-formatted data.
+     *
+     * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
+     * Method: PUT
+     *
+     * @param {string} folderID - The folder to update metadata for
+     * @param {string} scope - The scope of the template to update
+     * @param {string} template - The template to update
+     * @param {Object} patch - The patch data
+     * @param {Function} [callback] - Called with updated metadata if successful
+     * @returns {Promise<Object>} A promise resolving to the updated metadata
+     */
+    Folders.prototype.updateMetadata = function (folderID, scope, template, patch, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'metadata', scope, template), params = {
+            body: patch,
+            headers: {
+                'Content-Type': 'application/json-patch+json',
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * Sets metadata on a folder, overwriting any metadata that exists for the provided keys.
+     *
+     * @param {string} folderID - The folder to set metadata on
+     * @param {string} scope - The scope of the metadata template
+     * @param {string} template - The key of the metadata template
+     * @param {Object} metadata - The metadata to set
+     * @param {Function} [callback] - Called with updated metadata if successful
+     * @returns {Promise<Object>} A promise resolving to the updated metadata
+     */
+    Folders.prototype.setMetadata = function (folderID, scope, template, metadata, callback) {
+        var _this = this;
+        return this.addMetadata(folderID, scope, template, metadata)
+            .catch(function (err /* FIXME */) {
+            if (err.statusCode !== 409) {
+                throw err;
+            }
+            // Metadata already exists on the file; update instead
+            var updates = Object.keys(metadata).map(function (key) { return ({
+                op: 'add',
+                path: "/" + key,
+                value: metadata[key],
+            }); });
+            return _this.updateMetadata(folderID, scope, template, updates);
+        })
+            .asCallback(callback);
+    };
+    /**
+     * Deletes a metadata template from a folder.
+     *
+     * API Endpoint: '/folders/:folderID/metadata/:scope/:template'
+     * Method: DELETE
+     *
+     * @param {string} folderID - The ID of the folder to remove metadata from
+     * @param {string} scope - The scope of the metadata template
+     * @param {string} template - The template to remove from the folder
+     * @param {Function} [callback] - Called with nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    Folders.prototype.deleteMetadata = function (folderID, scope, template, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'metadata', scope, template);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    /**
+     * Retrieves a folder that has been moved to the trash
+     *
+     * API Endpoint: '/folders/:folderID/trash'
+     * Method: GET
+     *
+     * @param  {string} folderID  - The ID of the folder being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param  {Funnction} [callback]  - Passed the folder information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the trashed folder object
+     */
+    Folders.prototype.getTrashedFolder = function (folderID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH, folderID, 'trash');
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Restores an item that has been moved to the trash. Default behavior is to restore the item
+     * to the folder it was in before it was moved to the trash. If that parent folder no longer
+     * exists or if there is now an item with the same name in that parent folder, the new parent
+     * older and/or new name will need to be included in the request.
+     *
+     * API Endpoint: '/folders/:folderID'
+     * Method: POST
+     *
+     * @param {string} folderID - The ID of the folder to restore
+     * @param {Object} [options] - Optional parameters, can be left null
+     * @param {?string} [options.name] - The new name for this item
+     * @param {string} [options.parent_id] - The new parent folder for this item
+     * @param {Function} [callback] - Called with folder information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the restored folder object
+     */
+    Folders.prototype.restoreFromTrash = function (folderID, options, callback) {
+        // Set up the parent_id parameter
+        if (options && options.parent_id) {
+            options.parent = {
+                id: options.parent_id,
+            };
+            delete options.parent_id;
+        }
+        var apiPath = url_path_1.default(BASE_PATH, folderID), params = {
+            body: options || {},
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Permanently deletes an folder that is in the trash. The item will no longer exist in Box. This action cannot be undone
+     *
+     * API Endpoint: '/folders/:folderID/trash'
+     * Method: DELETE
+     *
+     * @param  {string} folderID Box ID of the folder being requested
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.etag] Only delete the folder if the ETag matches
+     * @param  {Function} [callback] Called with nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    Folders.prototype.deletePermanently = function (folderID, options, callback) {
+        // Switch around arguments if necessary for backwards compatibility
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        var params = {};
+        if (options && options.etag) {
+            params.headers = {
+                'If-Match': options.etag,
+            };
+        }
+        var apiPath = url_path_1.default(BASE_PATH, folderID, '/trash');
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    };
+    /**
+     * Used to retrieve the watermark for a corresponding Box folder.
+     *
+     * API Endpoint: '/folders/:folderID/watermark'
+     * Method: GET
+     *
+     * @param {string} folderID - The Box ID of the folder to get watermark for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the watermark information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the watermark info
+     */
+    Folders.prototype.getWatermark = function (folderID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, WATERMARK_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client
+            .get(apiPath, params)
+            .then(function (response /* FIXME */) {
+            if (response.statusCode !== 200) {
+                throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+            return response.body.watermark;
+        })
+            .asCallback(callback);
+    };
+    /**
+     * Used to apply or update the watermark for a corresponding Box folder.
+     *
+     * API Endpoint: '/folders/:folderID/watermark'
+     * Method: PUT
+     *
+     * @param {string} folderID - The Box ID of the folder to update watermark for
+     * @param {Object} [options] - Optional parameters, can be left null
+     * @param {Function} [callback] - Passed the watermark information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the watermark info
+     */
+    Folders.prototype.applyWatermark = function (folderID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, WATERMARK_SUBRESOURCE), params = {
+            body: {
+                watermark: {
+                    imprint: 'default', // Currently the API only supports default imprint
+                },
+            },
+        };
+        Object.assign(params.body.watermark, options);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * Used to remove the watermark for a corresponding Box folder.
+     *
+     * API Endpoint: '/folders/:folderID/watermark'
+     * Method: DELETE
+     *
+     * @param {string} folderID - The Box ID of the folder to remove watermark from
+     * @param {Function} [callback] - Empty response body passed if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    Folders.prototype.removeWatermark = function (folderID, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, folderID, WATERMARK_SUBRESOURCE);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    /**
+     * Used to lock a Box folder.
+     *
+     * API Endpoint: '/folder_locks'
+     * Method: POST
+     *
+     * @param {string} folderID - The Box ID of the folder to lock
+     * @param {Function} [callback] - Passed the folder lock object if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to a folder lock object
+     */
+    Folders.prototype.lock = function (folderID, callback) {
+        var params = {
+            body: {
+                folder: {
+                    type: 'folder',
+                    id: folderID,
+                },
+                locked_operations: {
+                    move: true,
+                    delete: true,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(FOLDER_LOCK, params, callback);
+    };
+    /**
+     * Used to get all locks on a folder.
+     *
+     * API Endpoint: '/folder_locks'
+     * Method: GET
+     *
+     * @param {string} folderID - The Box ID of the folder to lock
+     * @param {Function} [callback] - Passed a collection of folder lock objects if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to a collection of folder lock objects
+     */
+    Folders.prototype.getLocks = function (folderID, callback) {
+        var params = {
+            qs: {
+                folder_id: folderID,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(FOLDER_LOCK, params, callback);
+    };
+    /**
+     * Used to delete a lock on a folder.
+     *
+     * API Endpoint: '/folder_locks/:folderLockID'
+     * Method: DELETE
+     *
+     * @param {string} folderLockID - The Box ID of the folder lock
+     * @param {Function} [callback] - Empty response body passed if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    Folders.prototype.deleteLock = function (folderLockID, callback) {
+        var apiPath = url_path_1.default(FOLDER_LOCK, folderLockID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    return Folders;
+}());
 module.exports = Folders;
+//# sourceMappingURL=folders.js.map