box-node-sdk 1.35.0 → 1.37.2

package/lib/managers/retention-policies.js

@@ -1,54 +1,54 @@
+"use strict";
 /**
  * @fileoverview Manager for the Retention Policies Resource
  */
-
-'use strict';
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
 // -----------------------------------------------------------------------------
 // Typedefs
 // -----------------------------------------------------------------------------
-
 /**
- * Retention policy type, which specifies how long the policy should
- * remain in effect
- * @typedef {string} RetentionPolicyType
+ * Enum of valid retention policy types, which specify how long the policy should
+ * remain in effect.
+ * @readonly
+ * @enum {RetentionPolicyType}
  */
-
+var RetentionPolicyType;
+(function (RetentionPolicyType) {
+    RetentionPolicyType["FINITE"] = "finite";
+    RetentionPolicyType["INDEFINITE"] = "indefinite";
+})(RetentionPolicyType || (RetentionPolicyType = {}));
 /**
- * Retention policy disposition action, which specifies what should
+ * Enum of valid retention policy disposition actions, which specify what should
  * be done when the retention period is over
- * @typedef {string} RetentionPolicyDispositionAction
- */
-
-/**
- * Policy assignment types, which specify what type of object the policy applies to
- * @typedef {string} RetentionPolicyAssignmentType
+ * @readonly
+ * @enum {RetentionPolicyDispositionAction}
  */
-
+var RetentionPolicyDispositionAction;
+(function (RetentionPolicyDispositionAction) {
+    RetentionPolicyDispositionAction["PERMANENTLY_DELETE"] = "permanently_delete";
+    RetentionPolicyDispositionAction["REMOVE_RETENTION"] = "remove_retention";
+})(RetentionPolicyDispositionAction || (RetentionPolicyDispositionAction = {}));
 /**
- * Metadata template fields to filter on for assigning a retention policy
- * @typedef {Object} MetadataFilterField
- * @property {string} field The field to filter on
- * @property {string|int} value The value to filter against
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {RetentionPolicyAssignmentType}
  */
-
-// -----------------------------------------------------------------------------
-// Requirements
-// -----------------------------------------------------------------------------
-var urlPath = require('../util/url-path');
-
+var RetentionPolicyAssignmentType;
+(function (RetentionPolicyAssignmentType) {
+    RetentionPolicyAssignmentType["FOLDER"] = "folder";
+    RetentionPolicyAssignmentType["ENTERPRISE"] = "enterprise";
+    RetentionPolicyAssignmentType["METADATA"] = "metadata_template";
+})(RetentionPolicyAssignmentType || (RetentionPolicyAssignmentType = {}));
 // -----------------------------------------------------------------------------
 // Private
 // -----------------------------------------------------------------------------
-var BASE_PATH = '/retention_policies',
-	ASSIGNMENTS_PATH = '/retention_policy_assignments',
-	FILE_VERSION_RETENTIONS_PATH = '/file_version_retentions',
-	ASSIGNMENTS_SUBRESOURCE = 'assignments';
-
+var BASE_PATH = '/retention_policies', ASSIGNMENTS_PATH = '/retention_policy_assignments', FILE_VERSION_RETENTIONS_PATH = '/file_version_retentions', ASSIGNMENTS_SUBRESOURCE = 'assignments';
 // -----------------------------------------------------------------------------
 // Public
 // -----------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all Retention Policies endpoints and actions.
  *
@@ -56,270 +56,224 @@ var BASE_PATH = '/retention_policies',
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function RetentionPolicies(client) {
-	this.client = client;
-}
-
+var RetentionPolicies = /** @class */ (function () {
+    function RetentionPolicies(client) {
+        this.client = client;
+    }
+    /**
+     * Used to create a single retention policy for an enterprise
+     *
+     * API Endpoint: '/retention_policies'
+     * Method: POST
+     *
+     * @param {string} name - The name of the retention policy to be created
+     * @param {RetentionPolicyType} type - The type of policy to create
+     * @param {RetentionPolicyDispositionAction} action - The disposition action for the new policy
+     * @param {Object} [options] - Additional parameters
+     * @param {int} [options.retention_length] - For finite policies, the number of days to retain the content
+     * @param {Function} [callback] - Passed the new policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new policy object
+     */
+    RetentionPolicies.prototype.create = function (name, type, action, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH), params = {
+            body: {
+                policy_name: name,
+                policy_type: type,
+                disposition_action: action,
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Fetches details about a specific retention policy
+     *
+     * API Endpoint: '/retention_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the retention policy being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the policy object
+     */
+    RetentionPolicies.prototype.get = function (policyID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, policyID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Update or modify a retention policy.
+     *
+     * API Endpoint: '/retention_policies/:policyID'
+     * Method: PUT
+     *
+     * @param {string} policyID - The Box ID of the retention policy to update
+     * @param {Object} updates - The information to be updated
+     * @param {string} [updates.policy_name] - The name of the retention policy
+     * @param {RetentionPolicyDispositionAction} [updates.disposition_action] - The disposition action for the updated policy
+     * @param {string} [updates.status] - Used to retire a retention policy if status is set to retired
+     * @param {Function} [callback] - Passed the updated policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated policy object
+     */
+    RetentionPolicies.prototype.update = function (policyID, updates, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, policyID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * Fetches a list of retention policies for the enterprise
+     *
+     * API Endpoint: '/retention_policies
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.policy_name] - A full or partial name to filter the retention policies by
+     * @param {RetentionPolicyType} [options.policy_type] - A policy type to filter the retention policies by
+     * @param {string} [options.created_by_user_id] - A user id to filter the retention policies by
+     * @param {Function} [callback] - Passed the policy objects if they were acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of policies
+     */
+    RetentionPolicies.prototype.getAll = function (options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Fetch a list of assignments for a given retention policy
+     *
+     * API Endpoint: '/retention_policies/:policyID/assignments'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the retention policy to get assignments for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {RetentionPolicyAssignmentType} [options.type] - The type of the retention policy assignment to retrieve
+     * @param {Function} [callback] - Passed the assignment objects if they were acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of policy assignments
+     */
+    RetentionPolicies.prototype.getAssignments = function (policyID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, policyID, ASSIGNMENTS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Assign a retention policy to a folder or the entire enterprise.
+     *
+     * API Endpoint: '/retention_policy_assignments
+     * Method: POST
+     *
+     * @param {string} policyID - The ID of the policy to assign
+     * @param {RetentionPolicyAssignmentType} assignType - The type of object the policy will be assigned to
+     * @param {string} assignID - The Box ID of the object to assign the retention policy to
+     * @param {Object} [options] - Optional parameters for the request
+     * @param {MetadataFilterField[]} [options.filter_fields] - Metadata fields to filter against, if assigning to a metadata template
+     * @param {Function} [callback] - Passed the new assignment object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created assignment object
+     */
+    RetentionPolicies.prototype.assign = function (policyID, assignType, assignID, options, callback) {
+        // Shuffle optional arguments
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH), params = {
+            body: {
+                policy_id: policyID,
+                assign_to: {
+                    type: assignType,
+                    id: assignID,
+                },
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Fetch a specific policy assignment
+     *
+     * API Endpoint: '/retention_policy_assignments/:assignmentID'
+     * Method: GET
+     *
+     * @param {string} assignmentID - The Box ID of the policy assignment object to fetch
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the assignment object if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the assignment object
+     */
+    RetentionPolicies.prototype.getAssignment = function (assignmentID, options, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH, assignmentID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Get the specific retention record for a retained file version. To use this feature,
+     * you must have the manage retention policies scope enabled for your API key
+     * via your application management console.
+     *
+     * API Endpoint: '/file_version_retentions/:retentionID'
+     * Method: GET
+     *
+     * @param {string} retentionID - The ID for the file retention record to retrieve
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the retention record
+     */
+    RetentionPolicies.prototype.getFileVersionRetention = function (retentionID, options, callback) {
+        var apiPath = url_path_1.default(FILE_VERSION_RETENTIONS_PATH, retentionID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Get a list of retention records for a retained file versions in an enterprise.
+     * To use this feature, you must have the manage retention policies scope enabled
+     * for your API key via your application management console.
+     *
+     * API Endpoint: '/file_version_retentions'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.file_id] - A file id to filter the file version retentions by
+     * @param {string} [options.file_version_id] - A file version id to filter the file version retentions by
+     * @param {string} [options.policy_id] - A policy id to filter the file version retentions by
+     * @param {RetentionPolicyDispositionAction} [options.disposition_action] - The disposition action of the retention policy to filter by
+     * @param {string} [options.disposition_before] - Filter by retention policies which will complete before a certain time
+     * @param {string} [options.disposition_after] - Filter by retention policies which will complete after a certain time
+     * @param {int} [options.limit] - The maximum number of items to return in a page
+     * @param {string} [options.marker] - Paging marker, left blank to begin paging from the beginning
+     * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of retention records
+     */
+    RetentionPolicies.prototype.getAllFileVersionRetentions = function (options, callback) {
+        var apiPath = url_path_1.default(FILE_VERSION_RETENTIONS_PATH), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    return RetentionPolicies;
+}());
 /**
  * Enum of valid retention policy types, which specify how long the policy should
  * remain in effect.
  * @readonly
  * @enum {RetentionPolicyType}
  */
-RetentionPolicies.prototype.policyTypes = Object.freeze({
-	FINITE: 'finite',
-	INDEFINITE: 'indefinite'
-});
-
+RetentionPolicies.prototype.policyTypes = RetentionPolicyType;
 /**
  * Enum of valid retention policy disposition actions, which specify what should
  * be done when the retention period is over
  * @readonly
  * @enum {RetentionPolicyDispositionAction}
  */
-RetentionPolicies.prototype.dispositionActions = Object.freeze({
-	PERMANENTLY_DELETE: 'permanently_delete',
-	REMOVE_RETENTION: 'remove_retention'
-});
-
+RetentionPolicies.prototype.dispositionActions = RetentionPolicyDispositionAction;
 /**
  * Enum of valid policy assignment types, which specify what object the policy applies to
  * @readonly
  * @enum {RetentionPolicyAssignmentType}
  */
-RetentionPolicies.prototype.assignmentTypes = Object.freeze({
-	FOLDER: 'folder',
-	ENTERPRISE: 'enterprise',
-	METADATA: 'metadata_template'
-});
-
-/**
- * Used to create a single retention policy for an enterprise
- *
- * API Endpoint: '/retention_policies'
- * Method: POST
- *
- * @param {string} name - The name of the retention policy to be created
- * @param {RetentionPolicyType} type - The type of policy to create
- * @param {RetentionPolicyDispositionAction} action - The disposition action for the new policy
- * @param {Object} [options] - Additional parameters
- * @param {int} [options.retention_length] - For finite policies, the number of days to retain the content
- * @param {Function} [callback] - Passed the new policy information if it was acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the new policy object
- */
-RetentionPolicies.prototype.create = function(name, type, action, options, callback) {
-	var apiPath = urlPath(BASE_PATH),
-		params = {
-			body: {
-				policy_name: name,
-				policy_type: type,
-				disposition_action: action
-			}
-		};
-
-	Object.assign(params.body, options);
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Fetches details about a specific retention policy
- *
- * API Endpoint: '/retention_policies/:policyID'
- * Method: GET
- *
- * @param {string} policyID - The Box ID of the retention policy being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the policy information if it was acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the policy object
- */
-RetentionPolicies.prototype.get = function(policyID, options, callback) {
-	var apiPath = urlPath(BASE_PATH, policyID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Update or modify a retention policy.
- *
- * API Endpoint: '/retention_policies/:policyID'
- * Method: PUT
- *
- * @param {string} policyID - The Box ID of the retention policy to update
- * @param {Object} updates - The information to be updated
- * @param {string} [updates.policy_name] - The name of the retention policy
- * @param {RetentionPolicyDispositionAction} [updates.disposition_action] - The disposition action for the updated policy
- * @param {string} [updates.status] - Used to retire a retention policy if status is set to retired
- * @param {Function} [callback] - Passed the updated policy information if it was acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the updated policy object
- */
-RetentionPolicies.prototype.update = function(policyID, updates, callback) {
-
-	var apiPath = urlPath(BASE_PATH, policyID),
-		params = {
-			body: updates
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * Fetches a list of retention policies for the enterprise
- *
- * API Endpoint: '/retention_policies
- * Method: GET
- *
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {string} [options.policy_name] - A full or partial name to filter the retention policies by
- * @param {RetentionPolicyType} [options.policy_type] - A policy type to filter the retention policies by
- * @param {string} [options.created_by_user_id] - A user id to filter the retention policies by
- * @param {Function} [callback] - Passed the policy objects if they were acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of policies
- */
-RetentionPolicies.prototype.getAll = function(options, callback) {
-	var apiPath = urlPath(BASE_PATH),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Fetch a list of assignments for a given retention policy
- *
- * API Endpoint: '/retention_policies/:policyID/assignments'
- * Method: GET
- *
- * @param {string} policyID - The Box ID of the retention policy to get assignments for
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {RetentionPolicyAssignmentType} [options.type] - The type of the retention policy assignment to retrieve
- * @param {Function} [callback] - Passed the assignment objects if they were acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of policy assignments
- */
-RetentionPolicies.prototype.getAssignments = function(policyID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, policyID, ASSIGNMENTS_SUBRESOURCE),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Assign a retention policy to a folder or the entire enterprise.
- *
- * API Endpoint: '/retention_policy_assignments
- * Method: POST
- *
- * @param {string} policyID - The ID of the policy to assign
- * @param {RetentionPolicyAssignmentType} assignType - The type of object the policy will be assigned to
- * @param {string} assignID - The Box ID of the object to assign the retention policy to
- * @param {Object} [options] - Optional parameters for the request
- * @param {MetadataFilterField[]} [options.filter_fields] - Metadata fields to filter against, if assigning to a metadata template
- * @param {Function} [callback] - Passed the new assignment object if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the created assignment object
- */
-RetentionPolicies.prototype.assign = function(policyID, assignType, assignID, options, callback) {
-
-	// Shuffle optional arguments
-	if (typeof options === 'function') {
-		callback = options;
-		options = null;
-	}
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH),
-		params = {
-			body: {
-				policy_id: policyID,
-				assign_to: {
-					type: assignType,
-					id: assignID
-				}
-			}
-		};
-
-	Object.assign(params.body, options);
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Fetch a specific policy assignment
- *
- * API Endpoint: '/retention_policy_assignments/:assignmentID'
- * Method: GET
- *
- * @param {string} assignmentID - The Box ID of the policy assignment object to fetch
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the assignment object if it was acquired successfully, error otherwise
- * @returns {Promise<Object>} A promise resolving to the assignment object
- */
-RetentionPolicies.prototype.getAssignment = function(assignmentID, options, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH, assignmentID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Get the specific retention record for a retained file version. To use this feature,
- * you must have the manage retention policies scope enabled for your API key
- * via your application management console.
- *
- * API Endpoint: '/file_version_retentions/:retentionID'
- * Method: GET
- *
- * @param {string} retentionID - The ID for the file retention record to retrieve
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the retention record
- */
-RetentionPolicies.prototype.getFileVersionRetention = function(retentionID, options, callback) {
-
-	var apiPath = urlPath(FILE_VERSION_RETENTIONS_PATH, retentionID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Get a list of retention records for a retained file versions in an enterprise.
- * To use this feature, you must have the manage retention policies scope enabled
- * for your API key via your application management console.
- *
- * API Endpoint: '/file_version_retentions'
- * Method: GET
- *
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {string} [options.file_id] - A file id to filter the file version retentions by
- * @param {string} [options.file_version_id] - A file version id to filter the file version retentions by
- * @param {string} [options.policy_id] - A policy id to filter the file version retentions by
- * @param {RetentionPolicyDispositionAction} [options.disposition_action] - The disposition action of the retention policy to filter by
- * @param {string} [options.disposition_before] - Filter by retention policies which will complete before a certain time
- * @param {string} [options.disposition_after] - Filter by retention policies which will complete after a certain time
- * @param {int} [options.limit] - The maximum number of items to return in a page
- * @param {string} [options.marker] - Paging marker, left blank to begin paging from the beginning
- * @param {Function} [callback] - Pass the file version retention record if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of retention records
- */
-RetentionPolicies.prototype.getAllFileVersionRetentions = function(options, callback) {
-
-	var apiPath = urlPath(FILE_VERSION_RETENTIONS_PATH),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
+RetentionPolicies.prototype.assignmentTypes = RetentionPolicyAssignmentType;
 module.exports = RetentionPolicies;
+//# sourceMappingURL=retention-policies.js.map

package/lib/managers/retention-policies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retention-policies.js","sourceRoot":"","sources":["../../src/managers/retention-policies.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAMH,8DAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;;GAKG;AACH,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACvB,wCAAiB,CAAA;IACjB,gDAAyB,CAAA;AAC1B,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AAED;;;;;GAKG;AACH,IAAK,gCAGJ;AAHD,WAAK,gCAAgC;IACpC,6EAAyC,CAAA;IACzC,yEAAqC,CAAA;AACtC,CAAC,EAHI,gCAAgC,KAAhC,gCAAgC,QAGpC;AAED;;;;GAIG;AACH,IAAK,6BAIJ;AAJD,WAAK,6BAA6B;IACjC,kDAAiB,CAAA;IACjB,0DAAyB,CAAA;IACzB,+DAA8B,CAAA;AAC/B,CAAC,EAJI,6BAA6B,KAA7B,6BAA6B,QAIjC;AAaD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,IAAM,SAAS,GAAG,qBAAqB,EACtC,gBAAgB,GAAG,+BAA+B,EAClD,4BAA4B,GAAG,0BAA0B,EACzD,uBAAuB,GAAG,aAAa,CAAC;AAEzC,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH;IAOC,2BAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kCAAM,GAAN,UACC,IAAY,EACZ,IAAyB,EACzB,MAAwC,EACxC,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,EAC/B,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,WAAW,EAAE,IAAI;gBACjB,WAAW,EAAE,IAAI;gBACjB,kBAAkB,EAAE,MAAM;aAC1B;SACD,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,+BAAG,GAAH,UAAI,QAAgB,EAAE,OAA6B,EAAE,QAAmB;QACvE,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,EACzC,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kCAAM,GAAN,UACC,QAAgB,EAChB,OAIC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,EACzC,MAAM,GAAG;YACR,IAAI,EAAE,OAAO;SACb,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,kCAAM,GAAN,UACC,OAIC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,EAC/B,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,0CAAc,GAAd,UACC,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,uBAAuB,CAAC,EAClE,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kCAAM,GAAN,UACC,QAAgB,EAChB,UAAyC,EACzC,QAAgB,EAChB,OAKO,EACP,QAAmB;QAEnB,6BAA6B;QAC7B,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;SACf;QAED,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,CAAC,EACtC,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,SAAS,EAAE,QAAQ;gBACnB,SAAS,EAAE;oBACV,IAAI,EAAE,UAAU;oBAChB,EAAE,EAAE,QAAQ;iBACZ;aACD;SACD,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,yCAAa,GAAb,UACC,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,EACpD,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,mDAAuB,GAAvB,UACC,WAAmB,EACnB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,4BAA4B,EAAE,WAAW,CAAC,EAC/D,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uDAA2B,GAA3B,UACC,OASC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,4BAA4B,CAAC,EAClD,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IACF,wBAAC;AAAD,CAAC,AAzUD,IAyUC;AAED;;;;;GAKG;AACH,iBAAiB,CAAC,SAAS,CAAC,WAAW,GAAG,mBAAmB,CAAC;AAE9D;;;;;GAKG;AACH,iBAAiB,CAAC,SAAS,CAAC,kBAAkB,GAAG,gCAAgC,CAAC;AAElF;;;;GAIG;AACH,iBAAiB,CAAC,SAAS,CAAC,eAAe,GAAG,6BAA6B,CAAC;AAE5E,iBAAS,iBAAiB,CAAC"}

package/lib/managers/search.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @fileoverview Manager for the Box Search Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * 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
+ */
+declare type SearchMetadataFilter = {
+    templateKey: string;
+    scope: string;
+    filters: Record<string, any>;
+};
+/**
+ * Valid search scopes
+ * @readonly
+ * @enum {SearchScope}
+ */
+declare enum SearchScope {
+    USER = "user_content",
+    ENTERPRISE = "enterprise_content"
+}
+/**
+ * Simple manager for interacting with the search endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Search {
+    client: BoxClient;
+    scopes: typeof SearchScope;
+    constructor(client: BoxClient);
+    /**
+     * 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: string, options?: {
+        scope?: SearchScope;
+        file_extensions?: string;
+        created_at_range?: string;
+        updated_at_range?: string;
+        size_range?: string;
+        owner_user_ids?: string;
+        ancestor_folder_ids?: string;
+        content_types?: string;
+        type?: string;
+        trash_content?: string;
+        mdfilters?: SearchMetadataFilter[];
+        include_recent_shared_links?: boolean;
+        fields?: string;
+        limit?: number;
+        offset?: number;
+        sort?: string;
+        direction?: string;
+    }, callback?: Function): any;
+}
+export = Search;