box-node-sdk 1.35.0 → 1.37.2

package/lib/managers/collaboration-allowlist.d.ts

@@ -0,0 +1,137 @@
+/**
+ * @fileoverview Manager for the Box Collaboration Allowlist Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Collaboration Allowlist parameter constant
+ * @typedef {string} CollaborationAllowlistDirection Determines the type of restriction for allowlisting for a domain
+ */
+declare enum CollaborationAllowlistDirection {
+    INBOUND = "inbound",
+    OUTBOUND = "outbound",
+    BOTH = "both"
+}
+/**
+ * Simple manager for interacting with all 'Collaboration Allowlist' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class CollaborationAllowlist {
+    client: BoxClient;
+    directions: Record<string, string>;
+    /** @deprecated */
+    getWhitelistedDomain: any;
+    /** @deprecated */
+    getAllWhitelistedDomains: any;
+    constructor(client: BoxClient);
+    /**
+     * Add a domain to the enterprise's allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries'
+     * Method: POST
+     *
+     * @param {string} domain - The domain to be added to the allowlist
+     * @param {CollaborationAllowlistDirection} direction - Inbound refers to collaboration actions within an enterprise. Outbound
+     *                                                      refers to collaboration actions external to an enterprise. Both refers to
+     *                                                      collaboration actions taken within and external to an enterprise
+     * @param {Function} [callback] - Passed the collaboration allowlist information if it was created successfully
+     * @returns {Promise<Object>} A promise resolve to the collaboration allowlist object
+     */
+    addDomain(domain: string, direction: CollaborationAllowlistDirection, callback?: Function): any;
+    /**
+     * Requests a collaboration allowlist entry with a given ID.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries/:domainID'
+     * Method: GET
+     *
+     * @param {string} domainID - Box ID of the collaboration allowlist being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the collaboration allowlist information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collaboration allowlist object
+     */
+    getAllowlistedDomain(domainID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Requests all collaboration allowlist entries within an enterprise.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {int} [options.limit] - The number of collaboration allowlists to retrieve
+     * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
+     * @param {Function} [callback] - Passed a list of collaboration allowlists if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of collaboration allowlists
+     */
+    getAllAllowlistedDomains(options?: {
+        limit?: number;
+        marker?: string;
+    }, callback?: Function): any;
+    /**
+     * Delete a given collaboration allowlist entry.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries/:domainID'
+     * Method: DELETE
+     *
+     * @param {string} domainID - Box ID of the collaboration allowlist being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    removeDomain(domainID: string, callback?: Function): any;
+    /**
+     * Adds a Box User to the exempt target list.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets'
+     * Method: GET
+     *
+     * @param {string} userID - The ID of the Box User to be added to the allowlist
+     * @param {Function} [callback] - Passed a collaboration allowlist for user if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to a user collaboration allowlist
+     */
+    addExemption(userID: string, callback?: Function): any;
+    /**
+     * Retrieves information about a collaboration allowlist for user by allowlist ID.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
+     * Method: GET
+     *
+     * @param {string} exemptionID - The ID of the collaboration allowlist
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the collaboration allowlist information for a user if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collaboration allowlist object
+     */
+    getExemption(exemptionID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Retrieve a list of all exemptions to an enterprise's collaboration allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {int} [options.limit] - The number of user collaboration allowlists to retrieve
+     * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
+     * @param {Function} [callback] - Passed a list of user collaboration allowlists if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of user collaboration allowlists
+     */
+    getAllExemptions(options?: {
+        limit?: number;
+        marker?: string;
+    }, callback?: Function): any;
+    /**
+     * Delete a given user collaboration allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
+     * Method: DELETE
+     *
+     * @param {string} exemptionID - Box ID of the user collaboration allowlist being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    removeExemption(exemptionID: string, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/collaboration-allowlists
+ * @see {@Link CollaborationAllowlist}
+ */
+export = CollaborationAllowlist;

package/lib/managers/collaboration-allowlist.js

@@ -0,0 +1,200 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Collaboration Allowlist Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * Collaboration Allowlist parameter constant
+ * @typedef {string} CollaborationAllowlistDirection Determines the type of restriction for allowlisting for a domain
+ */
+var CollaborationAllowlistDirection;
+(function (CollaborationAllowlistDirection) {
+    CollaborationAllowlistDirection["INBOUND"] = "inbound";
+    CollaborationAllowlistDirection["OUTBOUND"] = "outbound";
+    CollaborationAllowlistDirection["BOTH"] = "both";
+})(CollaborationAllowlistDirection || (CollaborationAllowlistDirection = {}));
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+var BASE_PATH = '/collaboration_whitelist_entries', TARGET_ENTRY_PATH = '/collaboration_whitelist_exempt_targets';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Collaboration Allowlist' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+var CollaborationAllowlist = /** @class */ (function () {
+    function CollaborationAllowlist(client) {
+        this.client = client;
+    }
+    /**
+     * Add a domain to the enterprise's allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries'
+     * Method: POST
+     *
+     * @param {string} domain - The domain to be added to the allowlist
+     * @param {CollaborationAllowlistDirection} direction - Inbound refers to collaboration actions within an enterprise. Outbound
+     *                                                      refers to collaboration actions external to an enterprise. Both refers to
+     *                                                      collaboration actions taken within and external to an enterprise
+     * @param {Function} [callback] - Passed the collaboration allowlist information if it was created successfully
+     * @returns {Promise<Object>} A promise resolve to the collaboration allowlist object
+     */
+    CollaborationAllowlist.prototype.addDomain = function (domain, direction, callback) {
+        var params = {
+            body: {
+                domain: domain,
+                direction: direction,
+            },
+        };
+        var apiPath = url_path_1.default(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Requests a collaboration allowlist entry with a given ID.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries/:domainID'
+     * Method: GET
+     *
+     * @param {string} domainID - Box ID of the collaboration allowlist being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the collaboration allowlist information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collaboration allowlist object
+     */
+    CollaborationAllowlist.prototype.getAllowlistedDomain = function (domainID, options, callback) {
+        var params = { qs: options };
+        var apiPath = url_path_1.default(BASE_PATH, domainID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Requests all collaboration allowlist entries within an enterprise.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {int} [options.limit] - The number of collaboration allowlists to retrieve
+     * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
+     * @param {Function} [callback] - Passed a list of collaboration allowlists if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of collaboration allowlists
+     */
+    CollaborationAllowlist.prototype.getAllAllowlistedDomains = function (options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Delete a given collaboration allowlist entry.
+     *
+     * API Endpoint: '/collaboration_whitelist_entries/:domainID'
+     * Method: DELETE
+     *
+     * @param {string} domainID - Box ID of the collaboration allowlist being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    CollaborationAllowlist.prototype.removeDomain = function (domainID, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, domainID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    /**
+     * Adds a Box User to the exempt target list.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets'
+     * Method: GET
+     *
+     * @param {string} userID - The ID of the Box User to be added to the allowlist
+     * @param {Function} [callback] - Passed a collaboration allowlist for user if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to a user collaboration allowlist
+     */
+    CollaborationAllowlist.prototype.addExemption = function (userID, callback) {
+        var params = {
+            body: {
+                user: {
+                    id: userID,
+                    type: 'user',
+                },
+            },
+        };
+        var apiPath = url_path_1.default(TARGET_ENTRY_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * Retrieves information about a collaboration allowlist for user by allowlist ID.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
+     * Method: GET
+     *
+     * @param {string} exemptionID - The ID of the collaboration allowlist
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the collaboration allowlist information for a user if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collaboration allowlist object
+     */
+    CollaborationAllowlist.prototype.getExemption = function (exemptionID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(TARGET_ENTRY_PATH, exemptionID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Retrieve a list of all exemptions to an enterprise's collaboration allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {int} [options.limit] - The number of user collaboration allowlists to retrieve
+     * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
+     * @param {Function} [callback] - Passed a list of user collaboration allowlists if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of user collaboration allowlists
+     */
+    CollaborationAllowlist.prototype.getAllExemptions = function (options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = url_path_1.default(TARGET_ENTRY_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Delete a given user collaboration allowlist.
+     *
+     * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
+     * Method: DELETE
+     *
+     * @param {string} exemptionID - Box ID of the user collaboration allowlist being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    CollaborationAllowlist.prototype.removeExemption = function (exemptionID, callback) {
+        var apiPath = url_path_1.default(TARGET_ENTRY_PATH, exemptionID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    return CollaborationAllowlist;
+}());
+// Legacy insensitive language
+CollaborationAllowlist.prototype.getWhitelistedDomain =
+    CollaborationAllowlist.prototype.getAllowlistedDomain;
+CollaborationAllowlist.prototype.getAllWhitelistedDomains =
+    CollaborationAllowlist.prototype.getAllAllowlistedDomains;
+/**
+ * Enum of valid collaboration allowlist directions
+ *
+ * @readonly
+ * @enum {CollaborationAllowlistDirection}
+ */
+CollaborationAllowlist.prototype.directions = CollaborationAllowlistDirection;
+module.exports = CollaborationAllowlist;
+//# sourceMappingURL=collaboration-allowlist.js.map

package/lib/managers/collaboration-allowlist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collaboration-allowlist.js","sourceRoot":"","sources":["../../src/managers/collaboration-allowlist.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,8DAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;GAGG;AACH,IAAK,+BAIJ;AAJD,WAAK,+BAA+B;IACnC,sDAAmB,CAAA;IACnB,wDAAqB,CAAA;IACrB,gDAAa,CAAA;AACd,CAAC,EAJI,+BAA+B,KAA/B,+BAA+B,QAInC;AAED,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,SAAS,GAAG,kCAAkC,EACnD,iBAAiB,GAAG,yCAAyC,CAAC;AAE/D,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IASC,gCAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0CAAS,GAAT,UACC,MAAc,EACd,SAA0C,EAC1C,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE;gBACL,MAAM,QAAA;gBACN,SAAS,WAAA;aACT;SACD,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,CAAC;QACjC,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,qDAAoB,GAApB,UACC,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;QAE7B,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,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,yDAAwB,GAAxB,UACC,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,6CAAY,GAAZ,UAAa,QAAgB,EAAE,QAAmB;QACjD,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,6CAAY,GAAZ,UAAa,MAAc,EAAE,QAAmB;QAC/C,IAAI,MAAM,GAAG;YACZ,IAAI,EAAE;gBACL,IAAI,EAAE;oBACL,EAAE,EAAE,MAAM;oBACV,IAAI,EAAE,MAAM;iBACZ;aACD;SACD,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,iBAAiB,CAAC,CAAC;QACzC,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,6CAAY,GAAZ,UACC,WAAmB,EACnB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QACtD,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,iDAAgB,GAAhB,UACC,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACZ,EAAE,EAAE,OAAO;SACX,CAAC;QAEF,IAAI,OAAO,GAAG,kBAAO,CAAC,iBAAiB,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,gDAAe,GAAf,UAAgB,WAAmB,EAAE,QAAmB;QACvD,IAAI,OAAO,GAAG,kBAAO,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IACF,6BAAC;AAAD,CAAC,AAnOD,IAmOC;AAED,8BAA8B;AAC9B,sBAAsB,CAAC,SAAS,CAAC,oBAAoB;IACpD,sBAAsB,CAAC,SAAS,CAAC,oBAAoB,CAAC;AACvD,sBAAsB,CAAC,SAAS,CAAC,wBAAwB;IACxD,sBAAsB,CAAC,SAAS,CAAC,wBAAwB,CAAC;AAE3D;;;;;GAKG;AACH,sBAAsB,CAAC,SAAS,CAAC,UAAU,GAAG,+BAA+B,CAAC;AAM9E,iBAAS,sBAAsB,CAAC"}

package/lib/managers/collaboration-whitelist.d.ts

@@ -0,0 +1,3 @@
+/** @deprecated */
+import CollaborationAllowlist from './collaboration-allowlist';
+export = CollaborationAllowlist;

package/lib/managers/collaboration-whitelist.js

@@ -1,225 +1,11 @@
-/**
- * @fileoverview Manager for the Box Collaboration Whitelist Resource
- */
-
-'use strict';
-// -----------------------------------------------------------------------------
-// Typedefs
-// -----------------------------------------------------------------------------
-
-/**
- * Collaboration Whitelist parameter constant
- * @typedef {string} CollaborationWhitelistDirection Determines the type of restriction for whitelisting for a domain
- */
-
+"use strict";
+/** @deprecated */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
-var urlPath = require('../util/url-path');
-
-
-// ------------------------------------------------------------------------------
-// Private
-// ------------------------------------------------------------------------------
-var BASE_PATH = '/collaboration_whitelist_entries',
-	TARGET_ENTRY_PATH = '/collaboration_whitelist_exempt_targets';
-
-// ------------------------------------------------------------------------------
-// Public
-// ------------------------------------------------------------------------------
-
-/**
- * Simple manager for interacting with all 'Collaboration Whitelist' endpoints and actions.
- *
- * @constructor
- * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
- * @returns {void}
- */
-function CollaborationWhitelist(client) {
-	this.client = client;
-}
-
-/**
- * Enum of valid collaboration whitelist directions
- *
- * @readonly
- * @enum {CollaborationWhitelistDirection}
- */
-CollaborationWhitelist.prototype.directions = Object.freeze({
-	INBOUND: 'inbound',
-	OUTBOUND: 'outbound',
-	BOTH: 'both'
-});
-
-/**
- * Add a domain to the enterprise's whitelist.
- *
- * API Endpoint: '/collaboration_whitelist_entries'
- * Method: POST
- *
- * @param {string} domain - The domain to be added to the whitelist
- * @param {CollaborationWhitelistDirection} direction - Inbound refers to collaboration actions within an enterprise. Outbound
- *                                                      refers to collaboration actions external to an enterprise. Both refers to
- *                                                      collaboration actions taken within and external to an enterprise
- * @param {Function} [callback] - Passed the collaboration whitelist information if it was created successfully
- * @returns {Promise<Object>} A promise resolve to the collaboration whitelist object
- */
-CollaborationWhitelist.prototype.addDomain = function(domain, direction, callback) {
-
-	var params = {
-		body: {
-			domain,
-			direction
-		}
-	};
-
-	var apiPath = urlPath(BASE_PATH);
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Requests a collaboration whitelist entry with a given ID.
- *
- * API Endpoint: '/collaboration_whitelist_entries/:domainID'
- * Method: GET
- *
- * @param {string} domainID - Box ID of the collaboration whitelist being requested
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the collaboration whitelist information if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the collaboration whitelist object
- */
-CollaborationWhitelist.prototype.getWhitelistedDomain = function(domainID, options, callback) {
-
-	var params = { qs: options };
-
-	var apiPath = urlPath(BASE_PATH, domainID);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Requests all collaboration whitelist entries within an enterprise.
- *
- * API Endpoint: '/collaboration_whitelist_entries'
- * Method: GET
- *
- * @param {Object} [options] - Additional options. Can be left null in most cases.
- * @param {int} [options.limit] - The number of collaboration whitelists to retrieve
- * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
- * @param {Function} [callback] - Passed a list of collaboration whitelists if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of collaboration whitelists
- */
-CollaborationWhitelist.prototype.getAllWhitelistedDomains = function(options, callback) {
-
-	var params = {
-		qs: options
-	};
-
-	var apiPath = urlPath(BASE_PATH);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Delete a given collaboration whitelist entry.
- *
- * API Endpoint: '/collaboration_whitelist_entries/:domainID'
- * Method: DELETE
- *
- * @param {string} domainID - Box ID of the collaboration whitelist being requested
- * @param {Function} [callback] - Empty response body passed if successful.
- * @returns {Promise<void>} A promise resolving to nothing
- */
-CollaborationWhitelist.prototype.removeDomain = function(domainID, callback) {
-
-	var apiPath = urlPath(BASE_PATH, domainID);
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
-/**
- * Adds a Box User to the exempt target list.
- *
- * API Endpoint: '/collaboration_whitelist_exempt_targets'
- * Method: GET
- *
- * @param {string} userID - The ID of the Box User to be added to the whitelist
- * @param {Function} [callback] - Passed a collaboration whitelist for user if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to a user collaboration whitelist
- */
-CollaborationWhitelist.prototype.addExemption = function(userID, callback) {
-
-	var params = {
-		body: {
-			user: {
-				id: userID,
-				type: 'user'
-			}
-		}
-	};
-
-	var apiPath = urlPath(TARGET_ENTRY_PATH);
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * Retrieves information about a collaboration whitelist for user by whitelist ID.
- *
- * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
- * Method: GET
- *
- * @param {string} exemptionID - The ID of the collaboration whitelist
- * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
- * @param {Function} [callback] - Passed the collaboration whitelist information for a user if it was acquired successfully
- * @returns {Promise<Object>} A promise resolving to the collaboration whitelist object
- */
-CollaborationWhitelist.prototype.getExemption = function(exemptionID, options, callback) {
-
-	var params = {
-		qs: options
-	};
-
-	var apiPath = urlPath(TARGET_ENTRY_PATH, exemptionID);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Retrieve a list of all exemptions to an enterprise's collaboration whitelist.
- *
- * API Endpoint: '/collaboration_whitelist_exempt_targets'
- * Method: GET
- *
- * @param {Object} [options] - Additional options. Can be left null in most cases.
- * @param {string} [options.limit] - The number of user collaboration whitelists to retrieve
- * @param {string} [options.marker] - Paging marker, retrieve records starting at this position in the list. Left blank to start at the beginning.
- * @param {Function} [callback] - Passed a list of user collaboration whitelists if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of user collaboration whitelists
- */
-CollaborationWhitelist.prototype.getAllExemptions = function(options, callback) {
-
-	var params = {
-		qs: options
-	};
-
-	var apiPath = urlPath(TARGET_ENTRY_PATH);
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Delete a given user collaboration whitelist.
- *
- * API Endpoint: '/collaboration_whitelist_exempt_targets/:exemptionID'
- * Method: DELETE
- *
- * @param {string} exemptionID - Box ID of the user collaboration whitelist being requested
- * @param {Function} [callback] - Empty response body passed if successful.
- * @returns {Promise<void>} A promise resolving to nothing
- */
-CollaborationWhitelist.prototype.removeExemption = function(exemptionID, callback) {
-
-	var apiPath = urlPath(TARGET_ENTRY_PATH, exemptionID);
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
-/**
- * @module box-node-sdk/lib/managers/collaboration-whitelists
- * @see {@Link CollaborationWhitelist}
- */
-module.exports = CollaborationWhitelist;
+var collaboration_allowlist_1 = __importDefault(require("./collaboration-allowlist"));
+module.exports = collaboration_allowlist_1.default;
+//# sourceMappingURL=collaboration-whitelist.js.map

package/lib/managers/collaboration-whitelist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collaboration-whitelist.js","sourceRoot":"","sources":["../../src/managers/collaboration-whitelist.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;AAElB,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,sFAA+D;AAG/D,iBAAS,iCAAsB,CAAC"}