box-node-sdk 1.35.0 → 1.37.2

package/lib/managers/search.js

@@ -1,42 +1,32 @@
+"use strict";
 /**
  * @fileoverview Manager for the Box Search Resource
  */
-
-'use strict';
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 // -----------------------------------------------------------------------------
 // Requirements
 // -----------------------------------------------------------------------------
-
-var urlPath = require('../util/url-path'),
-	Promise = require('bluebird');
-
-// -----------------------------------------------------------------------------
-// Typedefs
-// -----------------------------------------------------------------------------
-
+var bluebird_1 = require("bluebird");
+var url_path_1 = __importDefault(require("../util/url-path"));
 /**
- * Search metadata filter
- * @typedef {Object} SearchMetadataFilter
- * @property {string} templateKey The template to filter against
- * @property {string} scope The scope of the template, e.g. 'global' or 'enterprise'
- * @property {Object} filters Key/value filters against individual metadata template properties
+ * Valid search scopes
+ * @readonly
+ * @enum {SearchScope}
  */
-
-/** @typedef {string} SearchScope */
-
-/** @typedef {string} SearchTrashContent */
-
+var SearchScope;
+(function (SearchScope) {
+    SearchScope["USER"] = "user_content";
+    SearchScope["ENTERPRISE"] = "enterprise_content";
+})(SearchScope || (SearchScope = {}));
 // -----------------------------------------------------------------------------
 // Private
 // -----------------------------------------------------------------------------
-
 var API_PATHS_SEARCH = '/search';
-
 // -----------------------------------------------------------------------------
 // Public
 // -----------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with the search endpoints and actions.
  *
@@ -44,68 +34,58 @@ var API_PATHS_SEARCH = '/search';
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function Search(client) {
-	this.client = client;
-}
-
-Search.prototype = {
-
-	/**
-	 * Valid search scopes
-	 * @readonly
-	 * @enum {SearchScope}
-	 */
-	scopes: Object.freeze({
-		USER: 'user_content',
-		ENTERPRISE: 'enterprise_content'
-	}),
-
-	/**
-	 * Searches Box for the given query.
-	 *
-	 * @param {string} searchString - The query string to use for search
-	 * @param {Object} [options] - Additional search filters. Can be left null in most cases.
-	 * @param {SearchScope} [options.scope] - The scope on which you want search. Can be user_content for a search limited to the current user or enterprise_content to search an entire enterprise
-	 * @param {string} [options.file_extensions] - Single or comma-delimited list of file extensions to filter against
-	 * @param {string} [options.created_at_range] - Date range for filtering on item creation time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
-	 * @param {string} [options.updated_at_range] - Date range for filtering on item update time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
-	 * @param {string} [options.size_range] - Range of item sizes (in bytes) to filter on, as lower_bound,upper_bound.  Either bound can be ommitted, e.g. ',100000' for <= 100KB
-	 * @param {string} [options.owner_user_ids] - Comma-delimited list of user IDs to filter item owner against
-	 * @param {string} [options.ancestor_folder_ids] - Comma-delimited list of folder IDs, search results will contain only items in these folders (and folders within them)
-	 * @param {string} [options.content_types] - Query within specified comma-delimited fields. The types can be name, description, file_content, comments, or tags
-	 * @param {string} [options.type] - The type of objects you want to include in the search results. The type can be file, folder, or web_link
-	 * @param {string} [options.trash_content=non_trashed_only] - Controls whether to search in the trash. The value can be trashed_only or non_trashed_only
-	 * @param {SearchMetadataFilter[]} [options.mdfilters] - Searches for objects with a specific metadata object association.  Searches with the this parameter do not require a query string
-	 * @param {boolean} [options.include_recent_shared_links] - Determines whether to include items accessible only via shared link in the response.
-	 * @param {string} [options.fields] - Comma-delimited list of fields to be included in the response
-	 * @param {int} [options.limit=30] - The number of search results to return, max 200
-	 * @param {int} [options.offset=0] - The search result at which to start the response, must be a multiple of limit
-	 * @param {string} [options.sort] - The field on which the results should be sorted, e.g. "modified_at"
-	 * @param {string} [options.direction] - The sort direction: "ASC" for ascending and "DESC" for descending
-	 * @param {APIRequest~Callback} [callback] - passed the new comment data if it was posted successfully
-	 * @returns {Promise<Object>} A promise resolving to the collection of search results
-	 */
-	query(searchString, options, callback) {
-
-		var apiPath = urlPath(API_PATHS_SEARCH),
-			qs = options || {};
-
-		qs.query = searchString;
-
-		if (qs.mdfilters) {
-			if (Array.isArray(qs.mdfilters)) {
-				qs.mdfilters = JSON.stringify(qs.mdfilters);
-			} else {
-				return Promise.reject(new Error('Invalid mdfilters parameter: must be a valid array')).asCallback(callback);
-			}
-		}
-
-		var params = {
-			qs
-		};
-		return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-	}
-
-};
-
+var Search = /** @class */ (function () {
+    function Search(client) {
+        this.client = client;
+    }
+    /**
+     * Searches Box for the given query.
+     *
+     * @param {string} searchString - The query string to use for search
+     * @param {Object} [options] - Additional search filters. Can be left null in most cases.
+     * @param {SearchScope} [options.scope] - The scope on which you want search. Can be user_content for a search limited to the current user or enterprise_content to search an entire enterprise
+     * @param {string} [options.file_extensions] - Single or comma-delimited list of file extensions to filter against
+     * @param {string} [options.created_at_range] - Date range for filtering on item creation time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
+     * @param {string} [options.updated_at_range] - Date range for filtering on item update time, e.g. '2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00'
+     * @param {string} [options.size_range] - Range of item sizes (in bytes) to filter on, as lower_bound,upper_bound.  Either bound can be ommitted, e.g. ',100000' for <= 100KB
+     * @param {string} [options.owner_user_ids] - Comma-delimited list of user IDs to filter item owner against
+     * @param {string} [options.ancestor_folder_ids] - Comma-delimited list of folder IDs, search results will contain only items in these folders (and folders within them)
+     * @param {string} [options.content_types] - Query within specified comma-delimited fields. The types can be name, description, file_content, comments, or tags
+     * @param {string} [options.type] - The type of objects you want to include in the search results. The type can be file, folder, or web_link
+     * @param {string} [options.trash_content=non_trashed_only] - Controls whether to search in the trash. The value can be trashed_only or non_trashed_only
+     * @param {SearchMetadataFilter[]} [options.mdfilters] - Searches for objects with a specific metadata object association.  Searches with the this parameter do not require a query string
+     * @param {boolean} [options.include_recent_shared_links] - Determines whether to include items accessible only via shared link in the response.
+     * @param {string} [options.fields] - Comma-delimited list of fields to be included in the response
+     * @param {int} [options.limit=30] - The number of search results to return, max 200
+     * @param {int} [options.offset=0] - The search result at which to start the response, must be a multiple of limit
+     * @param {string} [options.sort] - The field on which the results should be sorted, e.g. "modified_at"
+     * @param {string} [options.direction] - The sort direction: "ASC" for ascending and "DESC" for descending
+     * @param {APIRequest~Callback} [callback] - passed the new comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of search results
+     */
+    Search.prototype.query = function (searchString, options, callback) {
+        var apiPath = url_path_1.default(API_PATHS_SEARCH), qs = options || {};
+        qs.query = searchString;
+        if (qs.mdfilters) {
+            if (Array.isArray(qs.mdfilters)) {
+                qs.mdfilters = JSON.stringify(qs.mdfilters);
+            }
+            else {
+                return bluebird_1.Promise.reject(new Error('Invalid mdfilters parameter: must be a valid array')).asCallback(callback);
+            }
+        }
+        var params = {
+            qs: qs,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    return Search;
+}());
+/**
+ * Valid search scopes
+ * @readonly
+ * @enum {SearchScope}
+ */
+Search.prototype.scopes = SearchScope;
 module.exports = Search;
+//# sourceMappingURL=search.js.map

package/lib/managers/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/managers/search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,qCAAmC;AAEnC,8DAAuC;AAmBvC;;;;GAIG;AACH,IAAK,WAGJ;AAHD,WAAK,WAAW;IACf,oCAAqB,CAAA;IACrB,gDAAiC,CAAA;AAClC,CAAC,EAHI,WAAW,KAAX,WAAW,QAGf;AAKD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,IAAI,gBAAgB,GAAG,SAAS,CAAC;AAEjC,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH;IAIC,gBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,sBAAK,GAAL,UACC,YAAoB,EACpB,OAkBC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,CAAC,EACtC,EAAE,GAAG,OAAO,IAAK,EAA0B,CAAC;QAE7C,EAAE,CAAC,KAAK,GAAG,YAAY,CAAC;QAExB,IAAI,EAAE,CAAC,SAAS,EAAE;YACjB,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE;gBAChC,EAAE,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;aAC5C;iBAAM;gBACN,OAAO,kBAAO,CAAC,MAAM,CACpB,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAC/D,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;aACvB;SACD;QAED,IAAI,MAAM,GAAG;YACZ,EAAE,IAAA;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,aAAC;AAAD,CAAC,AAhFD,IAgFC;AAED;;;;GAIG;AACH,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,WAAW,CAAC;AAEtC,iBAAS,MAAM,CAAC"}

package/lib/managers/shared-items.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @fileoverview Manager for the Shared Items
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all 'Shared Item' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class SharedItems {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Requests a Box item associated with a shared link.
+     *
+     * API Endpoint: '/shared_items'
+     * Method: GET
+     *
+     * @param {string} url - Shared Link URL
+     * @param {string} [password] - Shared Link Password (null if no password)
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - passed the shared item if it was successfully acquired
+     * @returns {Promise<Object>} A promise resolving to the shared item object
+     */
+    get(url: string, password: string, options?: Record<string, any>, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/shared-items
+ * @see {@Link SharedItems}
+ */
+export = SharedItems;

package/lib/managers/shared-items.js

@@ -1,26 +1,22 @@
+"use strict";
 /**
  * @fileoverview Manager for the Shared Items
  */
-
-'use strict';
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-var errors = require('../util/errors'),
-	httpStatusCodes = require('http-status');
-
-
+var http_status_1 = __importDefault(require("http-status"));
+var errors_1 = __importDefault(require("../util/errors"));
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
 var BASE_PATH = '/shared_items';
-
-
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all 'Shared Item' endpoints and actions.
  *
@@ -28,56 +24,52 @@ var BASE_PATH = '/shared_items';
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function SharedItems(client) {
-	this.client = client;
-}
-
-/**
- * Requests a Box item associated with a shared link.
- *
- * API Endpoint: '/shared_items'
- * Method: GET
- *
- * @param {string} url - Shared Link URL
- * @param {string} [password] - Shared Link Password (null if no password)
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - passed the shared item if it was successfully acquired
- * @returns {Promise<Object>} A promise resolving to the shared item object
- */
-SharedItems.prototype.get = function(url, password, options, callback) {
-	var params = {
-		qs: options,
-		headers: {
-			BoxApi: this.client.buildSharedItemAuthHeader(url, password)
-		}
-	};
-
-	// Handle the Special API Response
-	return this.client.get(BASE_PATH, params)
-		.then(response => {
-
-			switch (response.statusCode) {
-
-			// 200 - Shared Item Recieved
-			case httpStatusCodes.OK:
-				return response.body;
-
-			// 403 - Incorrect or missing password
-			// Propagate an error explaining that the password is either missing or incorrect
-			case httpStatusCodes.FORBIDDEN:
-				var errMessage = (password) ? 'Incorrect shared link password' : 'Shared link password missing';
-				throw errors.buildResponseError(response, errMessage);
-
-				// Unexpected Response
-			default:
-				throw errors.buildUnexpectedResponseError(response);
-			}
-		})
-		.asCallback(callback);
-};
-
-/**
- * @module box-node-sdk/lib/managers/shared-items
- * @see {@Link SharedItems}
- */
+var SharedItems = /** @class */ (function () {
+    function SharedItems(client) {
+        this.client = client;
+    }
+    /**
+     * Requests a Box item associated with a shared link.
+     *
+     * API Endpoint: '/shared_items'
+     * Method: GET
+     *
+     * @param {string} url - Shared Link URL
+     * @param {string} [password] - Shared Link Password (null if no password)
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - passed the shared item if it was successfully acquired
+     * @returns {Promise<Object>} A promise resolving to the shared item object
+     */
+    SharedItems.prototype.get = function (url, password, options, callback) {
+        var params = {
+            qs: options,
+            headers: {
+                BoxApi: this.client.buildSharedItemAuthHeader(url, password),
+            },
+        };
+        // Handle the Special API Response
+        return this.client
+            .get(BASE_PATH, params)
+            .then(function (response /* FIXME */) {
+            switch (response.statusCode) {
+                // 200 - Shared Item Recieved
+                case http_status_1.default.OK:
+                    return response.body;
+                // 403 - Incorrect or missing password
+                // Propagate an error explaining that the password is either missing or incorrect
+                case http_status_1.default.FORBIDDEN:
+                    var errMessage = password
+                        ? 'Incorrect shared link password'
+                        : 'Shared link password missing';
+                    throw errors_1.default.buildResponseError(response, errMessage);
+                // Unexpected Response
+                default:
+                    throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+        })
+            .asCallback(callback);
+    };
+    return SharedItems;
+}());
 module.exports = SharedItems;
+//# sourceMappingURL=shared-items.js.map

package/lib/managers/shared-items.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-items.js","sourceRoot":"","sources":["../../src/managers/shared-items.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,4DAA0C;AAE1C,0DAAoC;AAEpC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,SAAS,GAAG,eAAe,CAAC;AAElC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IAGC,qBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,yBAAG,GAAH,UACC,GAAW,EACX,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;YACX,OAAO,EAAE;gBACR,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,yBAAyB,CAAC,GAAG,EAAE,QAAQ,CAAC;aAC5D;SACD,CAAC;QAEF,kCAAkC;QAClC,OAAO,IAAI,CAAC,MAAM;aAChB,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC;aACtB,IAAI,CAAC,UAAC,QAAa,CAAC,WAAW;YAC/B,QAAQ,QAAQ,CAAC,UAAU,EAAE;gBAC5B,6BAA6B;gBAC7B,KAAK,qBAAe,CAAC,EAAE;oBACtB,OAAO,QAAQ,CAAC,IAAI,CAAC;gBAEtB,sCAAsC;gBACtC,iFAAiF;gBACjF,KAAK,qBAAe,CAAC,SAAS;oBAC7B,IAAI,UAAU,GAAG,QAAQ;wBACxB,CAAC,CAAC,gCAAgC;wBAClC,CAAC,CAAC,8BAA8B,CAAC;oBAClC,MAAM,gBAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;gBAEvD,sBAAsB;gBACtB;oBACC,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;aACrD;QACF,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IACF,kBAAC;AAAD,CAAC,AAxDD,IAwDC;AAMD,iBAAS,WAAW,CAAC"}

package/lib/managers/storage-policies.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @fileoverview Manager for the Storage Policies resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all Retention Policies endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class StoragePolicies {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Get information about a specific storage policy
+     * @param {string} storagePolicyID The ID of the storage policy
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed the storage policy object if successful
+     * @returns {Promise<Object>} Promise resolving to the storage policy object
+     */
+    get(storagePolicyID: string, options?: {
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * Get all available storage policies for the enterprise
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed a collection of storage policies if successful
+     * @returns {Promise<Object>} Promise resolving to the collection of storage policies
+     */
+    getAll(options?: {
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * Assign a storage policy to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    assign(storagePolicyID: string, userID: string, callback?: Function): any;
+    /**
+     * Get information about a specific storage policy asisgnment by ID
+     * @param {string} assignmentID The ID of the assignment
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignment(assignmentID: string, callback?: Function): any;
+    /**
+     * Gets the storage policy assignment for a specific user
+     * @param {string} targetID The ID of the target
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.targetType=user] The type of the assignment target to resolve for
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignmentForTarget(targetID: string, options?: {
+        targetType?: string;
+    }, callback?: Function): any;
+    /**
+     * Create a new storage policy assignment to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    createAssignment(storagePolicyID: string, userID: string, callback?: Function): any;
+    /**
+     * Update a storage policy assignment
+     * @param {string} assignmentID The ID of the storage policy assignment to update
+     * @param {Object} updates The updates fields to apply
+     * @param {Function} [callback] Passed the updated assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the updated assignment object
+     */
+    updateAssignment(assignmentID: string, updates: Record<string, any>, callback?: Function): any;
+    /**
+     * Remove a storage policy assignment, returning the user to the default policy
+     * @param {string} assignmentID The ID of the assignment to remove
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving if the removal succeeds
+     */
+    removeAssignment(assignmentID: string, callback?: Function): any;
+}
+export = StoragePolicies;