box-node-sdk 3.8.1 → 3.8.2

package/lib-esm/managers/integration-mappings.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+/**
+ */
+class IntegrationMappingsManager {
+    /**
+     * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List Slack integration mappings
+     *
+     * Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} [options] Options for the request
+     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
+     * @param {number} [options.limit] The maximum number of items to return per page.
+     * @param {"channel"} [options.partner_item_type] Mapped item type, for which the mapping should be returned
+     * @param {string} [options.partner_item_id] ID of the mapped item, for which the mapping should be returned
+     * @param {string} [options.box_item_id] Box item ID, for which the mappings should be returned
+     * @param {"folder"} [options.box_item_type] Box item type, for which the mappings should be returned
+     * @param {boolean} [options.is_manually_created] Whether the mapping has been manually created
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMappings>} A promise resolving to the result or rejecting with an error
+     */
+    getSlackIntegrationMappings(options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('integration_mappings', 'slack'), params = {
+            qs: queryParams,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Create Slack integration mapping
+     *
+     * Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)
+     * by mapping a Slack channel to a Box item.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {schemas.IntegrationMappingSlackCreateRequest} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMapping>} A promise resolving to the result or rejecting with an error
+     */
+    createSlackIntegrationMapping(body, options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('integration_mappings', 'slack'), params = {
+            qs: queryParams,
+            body: body,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Update Slack integration mapping
+     *
+     * Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).
+     * Supports updating the Box folder ID and options.
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} body
+     * @param {object} options Options for the request
+     * @param {string} options.integration_mapping_id An ID of an integration mapping
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.IntegrationMapping>} A promise resolving to the result or rejecting with an error
+     */
+    updateSlackIntegrationMapping(body, options, callback) {
+        const { integration_mapping_id: integrationMappingId, ...queryParams } = options, apiPath = (0, url_path_1.default)('integration_mappings', 'slack', integrationMappingId), params = {
+            qs: queryParams,
+            body: body,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Delete Slack integration mapping
+     *
+     * Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).
+     *
+     *
+     * You need Admin or Co-Admin role to
+     * use this endpoint.
+     * @param {object} options Options for the request
+     * @param {string} options.integration_mapping_id An ID of an integration mapping
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to the result or rejecting with an error
+     */
+    deleteSlackIntegrationMappingById(options, callback) {
+        const { integration_mapping_id: integrationMappingId, ...queryParams } = options, apiPath = (0, url_path_1.default)('integration_mappings', 'slack', integrationMappingId), params = {
+            qs: queryParams,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    }
+}
+module.exports = IntegrationMappingsManager;
+//# sourceMappingURL=integration-mappings.js.map

package/lib-esm/managers/integration-mappings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"integration-mappings.js","sourceRoot":"","sources":["../../src/managers/integration-mappings.ts"],"names":[],"mappings":";;;;AACA,gEAAuC;AAEvC;GACG;AACH,MAAM,0BAA0B;IAE9B;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACH,2BAA2B,CACzB,OAgCC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,sBAAsB,EAAE,OAAO,CAAC,EAClD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAC3B,IAAkD,EAClD,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,sBAAsB,EAAE,OAAO,CAAC,EAClD,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;;OAaG;IACH,6BAA6B,CAC3B,IAAY,EACZ,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,GAAG,WAAW,EAAE,GAClE,OAAO,EACT,OAAO,GAAG,IAAA,kBAAO,EAAC,sBAAsB,EAAE,OAAO,EAAE,oBAAoB,CAAC,EACxE,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,iCAAiC,CAC/B,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,GAAG,WAAW,EAAE,GAClE,OAAO,EACT,OAAO,GAAG,IAAA,kBAAO,EAAC,sBAAsB,EAAE,OAAO,EAAE,oBAAoB,CAAC,EACxE,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AACD,iBAAS,0BAA0B,CAAC"}

package/lib-esm/managers/legal-hold-policies.d.ts

@@ -0,0 +1,190 @@
+/**
+ * @fileoverview Manager for the Legal Hold Policies Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {LegalHoldPolicyAssignmentType}
+ */
+declare enum LegalHoldPolicyAssignmentType {
+    FOLDER = "folder",
+    USER = "user",
+    FILE = "file",
+    FILE_VERSION = "file_version"
+}
+/**
+ * Simple manager for interacting with all Legal Holds endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class LegalHoldPolicies {
+    client: BoxClient;
+    assignmentTypes: typeof LegalHoldPolicyAssignmentType;
+    constructor(client: BoxClient);
+    /**
+     * Used to create a single legal hold policy for an enterprise
+     *
+     * API Endpoint: '/legal_hold_policies'
+     * Method: POST
+     *
+     * @param {string} name - The name of the legal hold policy to be created
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.description] - Description of the legal hold policy
+     * @param {string} [options.filter_started_at] - Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
+     * @param {string} [options.filter_ended_at] - Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
+     * @param {boolean} [options.is_ongoing] - After initialization, Assignments under this Policy will continue applying to files based on events, indefinitely
+     * @param {Function} [callback] - Passed the new policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created policy
+     */
+    create(name: string, options?: {
+        description?: string;
+        filter_started_at?: string;
+        filter_ended_at?: string;
+        is_ongoing?: boolean;
+    }, callback?: Function): any;
+    /**
+     * Fetches details about a specific legal hold policy
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the legal hold 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: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Update or modify a legal hold policy.
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: PUT
+     *
+     * @param {string} policyID - The Box ID of the legal hold policy to update
+     * @param {Object} updates - The information to be updated
+     * @param {string} [updates.policy_name] - Name of Legal Hold Policy
+     * @param {string} [updates.description] - Description of Legal Hold Policy
+     * @param {string} [updates.release_notes] - Notes around why the policy was released
+     * @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
+     */
+    update(policyID: string, updates: {
+        policy_name?: string;
+        description?: string;
+        release_notes?: string;
+    }, callback?: Function): any;
+    /**
+     * Fetches a list of legal hold policies for the enterprise
+     *
+     * API Endpoint: '/legal_hold_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 legal hold policies by
+     * @param {int} [options.limit] - Limit result size to this number
+     * @param {string} [options.marker] - Paging marker, leave blank to start at the first page
+     * @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?: {
+        policy_name?: string;
+        limit?: number;
+        marker?: string;
+    }, callback?: Function): any;
+    /**
+     * Sends request to delete an existing legal hold policy. Note that this is an
+     * asynchronous process - the policy will not be fully deleted yet when the
+     * response comes back.
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: DELETE
+     *
+     * @param {string} policyID - The legal hold policy to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(policyID: string, callback?: Function): any;
+    /**
+     * Fetch a list of assignments for a given legal hold policy
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID/assignments'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the legal hold policy to get assignments for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {LegalHoldPolicyAssignmentType} [options.assign_to_type] - Filter assignments of this type only
+     * @param {string} [options.assign_to_id] - Filter assignments to this ID only. Note that this will only show assignments applied directly to this entity.
+     * @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: string, options?: {
+        assign_to_type?: LegalHoldPolicyAssignmentType;
+        assign_to_id?: string;
+    }, callback?: Function): any;
+    /**
+     * Assign a lehal hold policy to an object
+     *
+     * API Endpoint: '/legal_hold_policy_assignments
+     * Method: POST
+     *
+     * @param {string} policyID - The ID of the policy to assign
+     * @param {LegalHoldPolicyAssignmentType} assignType - The type of object the policy will be assigned to
+     * @param {string} assignID - The Box ID of the object to assign the legal hold policy to
+     * @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: string, assignType: LegalHoldPolicyAssignmentType, assignID: string, callback?: Function): any;
+    /**
+     * Fetch a specific policy assignment
+     *
+     * API Endpoint: '/legal_hold_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: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Sends request to delete an existing legal hold policy. Note that this is an
+     * asynchronous process - the policy will not be fully deleted yet when the
+     * response comes back.
+     *
+     * API Endpoint: '/legal_hold_policy_assignments/:assignmentID'
+     * Method: DELETE
+     *
+     * @param {string} assignmentID - The legal hold policy assignment to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    deleteAssignment(assignmentID: string, callback?: Function): any;
+    /**
+     * Get the specific legal hold record for a held file version.
+     *
+     * API Endpoint: '/file_version_legal_holds/:legalHoldID'
+     * Method: GET
+     *
+     * @param {string} legalHoldID - The ID for the file legal hold 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 legal hold record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the legal hold record
+     */
+    getFileVersionLegalHold(legalHoldID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Get a list of legal hold records for held file versions in an enterprise.
+     *
+     * API Endpoint: '/file_version_legal_holds'
+     * Method: GET
+     *
+     * @param {string} policyID - ID of Legal Hold Policy to get File Version Legal Holds for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Pass the file version legal holds records if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of all file version legal holds
+     */
+    getAllFileVersionLegalHolds(policyID: string, options?: Record<string, any>, callback?: Function): any;
+}
+export = LegalHoldPolicies;

package/lib-esm/managers/legal-hold-policies.js

@@ -0,0 +1,254 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Legal Hold 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 policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {LegalHoldPolicyAssignmentType}
+ */
+var LegalHoldPolicyAssignmentType;
+(function (LegalHoldPolicyAssignmentType) {
+    LegalHoldPolicyAssignmentType["FOLDER"] = "folder";
+    LegalHoldPolicyAssignmentType["USER"] = "user";
+    LegalHoldPolicyAssignmentType["FILE"] = "file";
+    LegalHoldPolicyAssignmentType["FILE_VERSION"] = "file_version";
+})(LegalHoldPolicyAssignmentType || (LegalHoldPolicyAssignmentType = {}));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const BASE_PATH = '/legal_hold_policies', ASSIGNMENTS_PATH = '/legal_hold_policy_assignments', FILE_VERSION_LEGAL_HOLDS_PATH = '/file_version_legal_holds';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all Legal Holds endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class LegalHoldPolicies {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Used to create a single legal hold policy for an enterprise
+     *
+     * API Endpoint: '/legal_hold_policies'
+     * Method: POST
+     *
+     * @param {string} name - The name of the legal hold policy to be created
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.description] - Description of the legal hold policy
+     * @param {string} [options.filter_started_at] - Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
+     * @param {string} [options.filter_ended_at] - Date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range
+     * @param {boolean} [options.is_ongoing] - After initialization, Assignments under this Policy will continue applying to files based on events, indefinitely
+     * @param {Function} [callback] - Passed the new policy information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created policy
+     */
+    create(name, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
+            body: options || {},
+        };
+        params.body.policy_name = name;
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Fetches details about a specific legal hold policy
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the legal hold 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 legal hold policy.
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: PUT
+     *
+     * @param {string} policyID - The Box ID of the legal hold policy to update
+     * @param {Object} updates - The information to be updated
+     * @param {string} [updates.policy_name] - Name of Legal Hold Policy
+     * @param {string} [updates.description] - Description of Legal Hold Policy
+     * @param {string} [updates.release_notes] - Notes around why the policy was released
+     * @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
+     */
+    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 legal hold policies for the enterprise
+     *
+     * API Endpoint: '/legal_hold_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 legal hold policies by
+     * @param {int} [options.limit] - Limit result size to this number
+     * @param {string} [options.marker] - Paging marker, leave blank to start at the first page
+     * @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);
+    }
+    /**
+     * Sends request to delete an existing legal hold policy. Note that this is an
+     * asynchronous process - the policy will not be fully deleted yet when the
+     * response comes back.
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID'
+     * Method: DELETE
+     *
+     * @param {string} policyID - The legal hold policy to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(policyID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, policyID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Fetch a list of assignments for a given legal hold policy
+     *
+     * API Endpoint: '/legal_hold_policies/:policyID/assignments'
+     * Method: GET
+     *
+     * @param {string} policyID - The Box ID of the legal hold policy to get assignments for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {LegalHoldPolicyAssignmentType} [options.assign_to_type] - Filter assignments of this type only
+     * @param {string} [options.assign_to_id] - Filter assignments to this ID only. Note that this will only show assignments applied directly to this entity.
+     * @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)(ASSIGNMENTS_PATH), params = {
+            qs: Object.assign({ policy_id: policyID }, options),
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Assign a lehal hold policy to an object
+     *
+     * API Endpoint: '/legal_hold_policy_assignments
+     * Method: POST
+     *
+     * @param {string} policyID - The ID of the policy to assign
+     * @param {LegalHoldPolicyAssignmentType} assignType - The type of object the policy will be assigned to
+     * @param {string} assignID - The Box ID of the object to assign the legal hold policy to
+     * @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, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
+            body: {
+                policy_id: policyID,
+                assign_to: {
+                    type: assignType,
+                    id: assignID,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Fetch a specific policy assignment
+     *
+     * API Endpoint: '/legal_hold_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);
+    }
+    /**
+     * Sends request to delete an existing legal hold policy. Note that this is an
+     * asynchronous process - the policy will not be fully deleted yet when the
+     * response comes back.
+     *
+     * API Endpoint: '/legal_hold_policy_assignments/:assignmentID'
+     * Method: DELETE
+     *
+     * @param {string} assignmentID - The legal hold policy assignment to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @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 legal hold record for a held file version.
+     *
+     * API Endpoint: '/file_version_legal_holds/:legalHoldID'
+     * Method: GET
+     *
+     * @param {string} legalHoldID - The ID for the file legal hold 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 legal hold record if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the legal hold record
+     */
+    getFileVersionLegalHold(legalHoldID, options, callback) {
+        var apiPath = (0, url_path_1.default)(FILE_VERSION_LEGAL_HOLDS_PATH, legalHoldID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get a list of legal hold records for held file versions in an enterprise.
+     *
+     * API Endpoint: '/file_version_legal_holds'
+     * Method: GET
+     *
+     * @param {string} policyID - ID of Legal Hold Policy to get File Version Legal Holds for
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Pass the file version legal holds records if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of all file version legal holds
+     */
+    getAllFileVersionLegalHolds(policyID, options, callback) {
+        var apiPath = (0, url_path_1.default)(FILE_VERSION_LEGAL_HOLDS_PATH), params = {
+            qs: Object.assign({ policy_id: policyID }, options),
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+/**
+ * Enum of valid policy assignment types, which specify what object the policy applies to
+ * @readonly
+ * @enum {LegalHoldPolicyAssignmentType}
+ */
+LegalHoldPolicies.prototype.assignmentTypes = LegalHoldPolicyAssignmentType;
+module.exports = LegalHoldPolicies;
+//# sourceMappingURL=legal-hold-policies.js.map

package/lib-esm/managers/legal-hold-policies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"legal-hold-policies.js","sourceRoot":"","sources":["../../src/managers/legal-hold-policies.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,6BAKJ;AALD,WAAK,6BAA6B;IAChC,kDAAiB,CAAA;IACjB,8CAAa,CAAA;IACb,8CAAa,CAAA;IACb,8DAA6B,CAAA;AAC/B,CAAC,EALI,6BAA6B,KAA7B,6BAA6B,QAKjC;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,sBAAsB,EACtC,gBAAgB,GAAG,gCAAgC,EACnD,6BAA6B,GAAG,2BAA2B,CAAC;AAE9D,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,iBAAiB;IAIrB,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,IAAY,EACZ,OAKC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAwB;YAC5B,IAAI,EAAE,OAAO,IAAI,EAAE;SACpB,CAAC;QAEJ,MAAM,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAE/B,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;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,QAAgB,EAChB,OAIC,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,MAAM,CAAC,QAAgB,EAAE,QAAmB;QAC1C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE3C,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,cAAc,CACZ,QAAgB,EAChB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC;SACpD,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,MAAM,CACJ,QAAgB,EAChB,UAAyC,EACzC,QAAgB,EAChB,QAAmB;QAEnB,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,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;;;;;;;;;;;OAWG;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;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,WAAmB,EACnB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,EAAE,WAAW,CAAC,EAC/D,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;;;;;;;;;;OAUG;IACH,2BAA2B,CACzB,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,6BAA6B,CAAC,EAClD,MAAM,GAAG;YACP,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,OAAO,CAAC;SACpD,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;;;;GAIG;AACH,iBAAiB,CAAC,SAAS,CAAC,eAAe,GAAG,6BAA6B,CAAC;AAE5E,iBAAS,iBAAiB,CAAC"}