box-node-sdk 3.8.0 → 3.8.2

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

@@ -0,0 +1,374 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Retention Policies Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * 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 = {}));
+/**
+ * Enum of valid retention types.
+ * @readonly
+ * @enum {RetentionType}
+ */
+var RetentionType;
+(function (RetentionType) {
+    /**
+     * You can modify the retention policy. For example, you can add or remove folders,
+     * shorten or lengthen the policy duration, or delete the assignment.
+     * Use this type if your retention policy is not related to any regulatory purposes.
+     */
+    RetentionType["MODIFIABLE"] = "modifiable";
+    /**
+     * You can modify the retention policy only in a limited way: add a folder, lengthen the duration,
+     * retire the policy, change the disposition action or notification settings.
+     * You cannot perform other actions, such as deleting the assignment or shortening the policy duration.
+     * Use this type to ensure compliance with regulatory retention policies.
+     */
+    RetentionType["NON_MODIFIABLE"] = "non_modifiable";
+})(RetentionType || (RetentionType = {}));
+/**
+ * Enum of valid retention policy disposition actions, which specify what should
+ * be done when the retention period is over
+ * @readonly
+ * @enum {RetentionPolicyDispositionAction}
+ */
+var RetentionPolicyDispositionAction;
+(function (RetentionPolicyDispositionAction) {
+    RetentionPolicyDispositionAction["PERMANENTLY_DELETE"] = "permanently_delete";
+    RetentionPolicyDispositionAction["REMOVE_RETENTION"] = "remove_retention";
+})(RetentionPolicyDispositionAction || (RetentionPolicyDispositionAction = {}));
+/**
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {RetentionPolicyAssignmentType}
+ */
+var RetentionPolicyAssignmentType;
+(function (RetentionPolicyAssignmentType) {
+    RetentionPolicyAssignmentType["FOLDER"] = "folder";
+    RetentionPolicyAssignmentType["ENTERPRISE"] = "enterprise";
+    RetentionPolicyAssignmentType["METADATA"] = "metadata_template";
+})(RetentionPolicyAssignmentType || (RetentionPolicyAssignmentType = {}));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const BASE_PATH = '/retention_policies', ASSIGNMENTS_PATH = '/retention_policy_assignments', FILE_VERSION_RETENTIONS_PATH = '/file_version_retentions', ASSIGNMENTS_SUBRESOURCE = 'assignments', FILES_UNDER_RETENTION_SUBRESOURCE = 'files_under_retention', FILES_VERSIONS_UNDER_RETENTION_SUBRESOURCE = 'file_versions_under_retention';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * 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}
+ */
+class RetentionPolicies {
+    constructor(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 {boolean} [options.are_owners_notified] - Whether or not owner and co-owners of a file are notified when the policy nears expiration
+     * @param {boolean} [options.can_owner_extend_retention] - Whether or not the owner of a file will be allowed to extend the retention
+     * @param {UserMini[]} [options.custom_notification_recipients] - A list of users notified when the retention policy duration is about to end
+     * @param {string} [options.description] - The additional text description of the retention policy
+     * @param {int} [options.retention_length] - For finite policies, the number of days to retain the content
+     * @param {RetentionType} [options.retention_type] - The type of retention for the new policy
+     * @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
+     */
+    create(name, type, action, options, callback) {
+        var apiPath = (0, 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
+     */
+    get(policyID, options, callback) {
+        var apiPath = (0, 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 {boolean} [updates.are_owners_notified] - Whether or not owner and co-owners of a file are notified when the policy nears expiration
+     * @param {boolean} [updates.can_owner_extend_retention] - Whether or not the owner of a file will be allowed to extend the retention
+     * @param {UserMini[]} [updates.custom_notification_recipients] - A list of users notified when the retention policy duration is about to end
+     * @param {string} [updates.description] - The additional text description of the retention policy
+     * @param {int} [updates.retention_length] - For finite policies, the number of days to retain the content
+     * @param {RetentionType} [updates.retention_type] - The type of retention. The only possible value here is non_modifiable. You can convert a modifiable policy to non_modifiable, but not the other way around.
+     * @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
+     */
+    update(policyID, updates, callback) {
+        var apiPath = (0, 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
+     */
+    getAll(options, callback) {
+        var apiPath = (0, 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
+     */
+    getAssignments(policyID, options, callback) {
+        var apiPath = (0, 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 {string} [options.start_date_field] - Id of Metadata field which will be used to specify the start date for the retention policy, or set this to "upload_date" as value to use the date when the file was uploaded to Box
+     * @param {Function} [callback] - Passed the new assignment object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created assignment object
+     */
+    assign(policyID, assignType, assignID, options, callback) {
+        // Shuffle optional arguments
+        if (typeof options === 'function') {
+            callback = options;
+            options = null;
+        }
+        var apiPath = (0, 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
+     */
+    getAssignment(assignmentID, options, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Delete a specific policy assignment.
+     *
+     * API Endpoint: '/retention_policy_assignments/:assignmentID'
+     * Method: DELETE
+     *
+     * @param {string} assignmentID - The Box ID of the policy assignment object to delete
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    deleteAssignment(assignmentID, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, 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
+     */
+    getFileVersionRetention(retentionID, options, callback) {
+        var apiPath = (0, 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
+     */
+    getAllFileVersionRetentions(options, callback) {
+        var apiPath = (0, url_path_1.default)(FILE_VERSION_RETENTIONS_PATH), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get files under retention by each assignment
+     * To use this feature, you must have the manage retention policies scope enabled
+     * for your API key via your application management console.
+     *
+     * API Endpoint: '/retention_policy_assignments/:assignmentID/files_under_retention'
+     * 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 {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
+     */
+    getFilesUnderRetentionForAssignment(assignmentID, options, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID, FILES_UNDER_RETENTION_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get file versions under retention by each assignment
+     * To use this feature, you must have the manage retention policies scope enabled
+     * for your API key via your application management console.
+     *
+     * API Endpoint: '/retention_policy_assignments/:assignmentID/file_versions_under_retention'
+     * 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 {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
+     */
+    getFileVersionsUnderRetentionForAssignment(assignmentID, options, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID, FILES_VERSIONS_UNDER_RETENTION_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+/**
+ * Enum of valid retention policy types, which specify how long the policy should
+ * remain in effect.
+ * @readonly
+ * @enum {RetentionPolicyType}
+ */
+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 =
+    RetentionPolicyDispositionAction;
+/**
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {RetentionPolicyAssignmentType}
+ */
+RetentionPolicies.prototype.assignmentTypes = RetentionPolicyAssignmentType;
+/**
+ * Enum of valid retention types. Could be either modifiable or non-modifiable.
+ * @readonly
+ * @enum {RetentionType}
+ */
+RetentionPolicies.prototype.retentionTypes = RetentionType;
+module.exports = RetentionPolicies;
+//# sourceMappingURL=retention-policies.js.map

package/lib-esm/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,gEAAuC;AAGvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;;GAKG;AACH,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACtB,wCAAiB,CAAA;IACjB,gDAAyB,CAAA;AAC3B,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AAED;;;;GAIG;AACH,IAAK,aAcJ;AAdD,WAAK,aAAa;IAChB;;;;OAIG;IACH,0CAAyB,CAAA;IACzB;;;;;OAKG;IACH,kDAAiC,CAAA;AACnC,CAAC,EAdI,aAAa,KAAb,aAAa,QAcjB;AAED;;;;;GAKG;AACH,IAAK,gCAGJ;AAHD,WAAK,gCAAgC;IACnC,6EAAyC,CAAA;IACzC,yEAAqC,CAAA;AACvC,CAAC,EAHI,gCAAgC,KAAhC,gCAAgC,QAGpC;AAED;;;;GAIG;AACH,IAAK,6BAIJ;AAJD,WAAK,6BAA6B;IAChC,kDAAiB,CAAA;IACjB,0DAAyB,CAAA;IACzB,+DAA8B,CAAA;AAChC,CAAC,EAJI,6BAA6B,KAA7B,6BAA6B,QAIjC;AAaD,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,qBAAqB,EACrC,gBAAgB,GAAG,+BAA+B,EAClD,4BAA4B,GAAG,0BAA0B,EACzD,uBAAuB,GAAG,aAAa,EACvC,iCAAiC,GAAG,uBAAuB,EAC3D,0CAA0C,GAAG,+BAA+B,CAAC;AAE/E,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,iBAAiB;IAQrB,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CACJ,IAAY,EACZ,IAAyB,EACzB,MAAwC,EACxC,OAOC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,WAAW,EAAE,IAAI;gBACjB,WAAW,EAAE,IAAI;gBACjB,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC;QAEJ,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,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,QAAgB,EAAE,OAA6B,EAAE,QAAmB;QACtE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,CAAC,EACxC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,QAAgB,EAChB,OAUC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,CAAC,EACxC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAIC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,EAAE,uBAAuB,CAAC,EACjE,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,QAAgB,EAChB,UAAyC,EACzC,QAAgB,EAChB,OAMQ,EACR,QAAmB;QAEnB,6BAA6B;QAC7B,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,SAAS,EAAE,QAAQ;gBACnB,SAAS,EAAE;oBACT,IAAI,EAAE,UAAU;oBAChB,EAAE,EAAE,QAAQ;iBACb;aACF;SACF,CAAC;QAEJ,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,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CAAC,YAAoB,EAAE,QAAmB;QACxD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,uBAAuB,CACrB,WAAmB,EACnB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,4BAA4B,EAAE,WAAW,CAAC,EAC9D,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,2BAA2B,CACzB,OASC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,4BAA4B,CAAC,EACjD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,mCAAmC,CACjC,YAAoB,EACpB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EACjB,gBAAgB,EAChB,YAAY,EACZ,iCAAiC,CAClC,EACD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,0CAA0C,CACxC,YAAoB,EACpB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EACjB,gBAAgB,EAChB,YAAY,EACZ,0CAA0C,CAC3C,EACD,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,iBAAiB,CAAC,SAAS,CAAC,WAAW,GAAG,mBAAmB,CAAC;AAE9D;;;;;GAKG;AACH,iBAAiB,CAAC,SAAS,CAAC,kBAAkB;IAC5C,gCAAgC,CAAC;AAEnC;;;;GAIG;AACH,iBAAiB,CAAC,SAAS,CAAC,eAAe,GAAG,6BAA6B,CAAC;AAE5E;;;;GAIG;AACH,iBAAiB,CAAC,SAAS,CAAC,cAAc,GAAG,aAAa,CAAC;AAE3D,iBAAS,iBAAiB,CAAC"}

package/lib-esm/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
+ */
+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 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[] | string;
+        include_recent_shared_links?: boolean;
+        fields?: string;
+        limit?: number;
+        offset?: number;
+        sort?: string;
+        direction?: string;
+    }, callback?: Function): any;
+}
+export = Search;

package/lib-esm/managers/search.js

@@ -0,0 +1,90 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Search Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// -----------------------------------------------------------------------------
+// Requirements
+// -----------------------------------------------------------------------------
+const bluebird_1 = require("bluebird");
+const url_path_1 = __importDefault(require("../util/url-path"));
+/**
+ * Valid search scopes
+ * @readonly
+ * @enum {SearchScope}
+ */
+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.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Search {
+    constructor(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 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 = (0, 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,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+/**
+ * Valid search scopes
+ * @readonly
+ * @enum {SearchScope}
+ */
+Search.prototype.scopes = SearchScope;
+module.exports = Search;
+//# sourceMappingURL=search.js.map

package/lib-esm/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,uCAAmC;AAEnC,gEAAuC;AAmBvC;;;;GAIG;AACH,IAAK,WAGJ;AAHD,WAAK,WAAW;IACd,oCAAqB,CAAA;IACrB,gDAAiC,CAAA;AACnC,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,MAAM,MAAM;IAIV,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CACH,YAAoB,EACpB,OAkBC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,EAAE,GAEE,OAAO,IAAK,EAA0B,CAAC;QAE7C,EAAE,CAAC,KAAK,GAAG,YAAY,CAAC;QAExB,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;YACjB,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChC,EAAE,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;YAC9C,CAAC;iBAAM,CAAC;gBACN,OAAO,kBAAO,CAAC,MAAM,CACnB,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAChE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACzB,CAAC;QACH,CAAC;QAED,IAAI,MAAM,GAAG;YACX,EAAE;SACH,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,WAAW,CAAC;AAEtC,iBAAS,MAAM,CAAC"}

package/lib-esm/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;