box-node-sdk 3.8.1 → 4.0.0

package/lib-esm/managers/ai.generated.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const url_path_1 = __importDefault(require("../util/url-path"));
+/**
+ */
+class AIManager {
+    client;
+    /**
+     * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Send AI question request
+     *
+     * Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
+     * @param {schemas.AiAsk} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiResponseFull>} A promise resolving to the result or rejecting with an error
+     */
+    ask(body, options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('ai', 'ask'), params = {
+            qs: queryParams,
+            body: body,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Send AI request to generate text
+     *
+     * Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.
+     * @param {schemas.AiTextGen} body
+     * @param {object} [options] Options for the request
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiResponse>} A promise resolving to the result or rejecting with an error
+     */
+    textGen(body, options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('ai', 'text_gen'), params = {
+            qs: queryParams,
+            body: body,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Get AI agent default configuration
+     *
+     * Get the AI agent default config
+     * @param {object} options Options for the request
+     * @param {"ask" | "text_gen"} options.mode The mode to filter the agent config to return.
+     * @param {string} [options.language] The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.
+     * @param {string} [options.model] The model to return the default agent config for.
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.AiAgentAsk | schemas.AiAgentTextGen>} A promise resolving to the result or rejecting with an error
+     */
+    getAiAgentDefaultConfig(options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('ai_agent_default'), params = {
+            qs: queryParams,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+exports.default = AIManager;
+//# sourceMappingURL=ai.generated.js.map

package/lib-esm/managers/ai.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.generated.js","sourceRoot":"","sources":["../../src/managers/ai.generated.ts"],"names":[],"mappings":";;;;;AACA,gEAAuC;AAEvC;GACG;AACH,MAAM,SAAS;IACb,MAAM,CAAY;IAClB;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;OAQG;IACH,GAAG,CACD,IAAmB,EACnB,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,KAAK,CAAC,EAC9B,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;;;;;;;;OAQG;IACH,OAAO,CACL,IAAuB,EACvB,OAAY,EACZ,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,IAAI,EAAE,UAAU,CAAC,EACnC,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;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,OAcC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,CAAC,EACrC,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,kBAAe,SAAS,CAAC"}

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

@@ -0,0 +1,133 @@
+/**
+ * @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>;
+    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 default CollaborationAllowlist;

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

@@ -0,0 +1,201 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Collaboration Allowlist Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const 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
+// ------------------------------------------------------------------------------
+const 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}
+ */
+class CollaborationAllowlist {
+    client;
+    directions;
+    constructor(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
+     */
+    addDomain(domain, direction, callback) {
+        var params = {
+            body: {
+                domain,
+                direction,
+            },
+        };
+        var apiPath = (0, 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
+     */
+    getAllowlistedDomain(domainID, options, callback) {
+        var params = { qs: options };
+        var apiPath = (0, 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
+     */
+    getAllAllowlistedDomains(options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, 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
+     */
+    removeDomain(domainID, callback) {
+        var apiPath = (0, 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
+     */
+    addExemption(userID, callback) {
+        var params = {
+            body: {
+                user: {
+                    id: userID,
+                    type: 'user',
+                },
+            },
+        };
+        var apiPath = (0, 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
+     */
+    getExemption(exemptionID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, 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
+     */
+    getAllExemptions(options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, 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
+     */
+    removeExemption(exemptionID, callback) {
+        var apiPath = (0, url_path_1.default)(TARGET_ENTRY_PATH, exemptionID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+}
+/**
+ * Enum of valid collaboration allowlist directions
+ *
+ * @readonly
+ * @enum {CollaborationAllowlistDirection}
+ */
+CollaborationAllowlist.prototype.directions = CollaborationAllowlistDirection;
+/**
+ * @module box-node-sdk/lib/managers/collaboration-allowlists
+ * @see {@Link CollaborationAllowlist}
+ */
+exports.default = CollaborationAllowlist;
+//# sourceMappingURL=collaboration-allowlist.js.map

package/lib-esm/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,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;GAGG;AACH,IAAK,+BAIJ;AAJD,WAAK,+BAA+B;IAClC,sDAAmB,CAAA;IACnB,wDAAqB,CAAA;IACrB,gDAAa,CAAA;AACf,CAAC,EAJI,+BAA+B,KAA/B,+BAA+B,QAInC;AAED,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,kCAAkC,EAClD,iBAAiB,GAAG,yCAAyC,CAAC;AAEhE,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,sBAAsB;IAC1B,MAAM,CAAY;IAClB,UAAU,CAA0B;IAEpC,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,SAAS,CACP,MAAc,EACd,SAA0C,EAC1C,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,MAAM;gBACN,SAAS;aACV;SACF,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACjC,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,oBAAoB,CAClB,QAAgB,EAChB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC;QAE7B,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,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,wBAAwB,CACtB,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACjC,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,YAAY,CAAC,QAAgB,EAAE,QAAmB;QAChD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAc,EAAE,QAAmB;QAC9C,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,EAAE,EAAE,MAAM;oBACV,IAAI,EAAE,MAAM;iBACb;aACF;SACF,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,iBAAiB,CAAC,CAAC;QACzC,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,YAAY,CACV,WAAmB,EACnB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QACtD,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,CACd,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,iBAAiB,CAAC,CAAC;QACzC,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,eAAe,CAAC,WAAmB,EAAE,QAAmB;QACtD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED;;;;;GAKG;AACH,sBAAsB,CAAC,SAAS,CAAC,UAAU,GAAG,+BAA+B,CAAC;AAE9E;;;GAGG;AACH,kBAAe,sBAAsB,CAAC"}

package/lib-esm/managers/collaborations.d.ts

@@ -0,0 +1,173 @@
+/**
+ * @fileoverview Manager for the Box Collaboration Resource
+ */
+import BoxClient from '../box-client';
+import { Collaboration, CollaborationAccesibleBy, CollaborationRole, CollaborationStatus, CollaborationUpdate } from '../schemas';
+type ItemType = 'file' | 'folder';
+/**
+ * Simple manager for interacting with all 'Collaboration' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Collaborations {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Requests a collaboration object with a given ID.
+     *
+     * API Endpoint: '/collaborations/:collaborationID'
+     * Method: GET
+     *
+     * @param {string} collaborationID - Box ID of the collaboration being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the collaboration information if it was acquired successfully
+     * @returns {Promise<Collaboration>} A promise resolving to the collaboration object
+     */
+    get(collaborationID: string, options?: Record<string, any>, callback?: Function): Promise<Collaboration>;
+    /**
+     * Gets a user's pending collaborations
+     *
+     * API Endpoint: '/collaborations'
+     * Method: GET
+     *
+     * @param {Function} [callback] - Called with a collection of pending collaborations if successful
+     * @returns {Promise<Collaborations>} A promise resolving to the collection of pending collaborations
+     */
+    getPending(callback?: Function): Promise<Collaborations>;
+    private updateInternal;
+    /**
+     * Update some information about a given collaboration.
+     *
+     * API Endpoint: '/collaborations/:collaborationID'
+     * Method: PUT
+     *
+     * @param {string} collaborationID - Box ID of the collaboration being requested
+     * @param {CollaborationUpdate} updates - Fields of the collaboration to be updated
+     * @param {Function} [callback] - Passed the updated collaboration information if it was acquired successfully
+     * @returns {Promise<Collaboration>} A promise resolving to the updated collaboration object
+     */
+    update(collaborationID: string, updates: CollaborationUpdate, callback?: Function): Promise<Collaboration>;
+    /**
+     * Update the status of a pending collaboration.
+     *
+     * API Endpoint: '/collaborations/:collaborationID'
+     * Method: PUT
+     *
+     * @param {string} collaborationID - Box ID of the collaboration being requested
+     * @param {CollaborationStatus} newStatus - The new collaboration status ('accepted'/'rejected')
+     * @param {Function} [callback] - Passed the updated collaboration information if it was acquired successfully
+     * @returns {Promise<Collaboration>} A promise resolving to the accepted collaboration object
+     */
+    respondToPending(collaborationID: string, newStatus: CollaborationStatus, callback?: Function): Promise<Collaboration>;
+    /**
+     * Invite a collaborator to a folder. You'll have to create the 'accessible_by' input object
+     * yourself, but the method allows for multiple types of collaborator invites. See
+     * {@link http://developers.box.com/docs/#collaborations-add-a-collaboration} for formatting
+     * help.
+     *
+     * API Endpoint: '/collaborations
+     * Method: POST
+     *
+     * @param {CollaborationAccesibleBy} accessibleBy - The accessible_by object expected by the API
+     * @param {string} itemID - Box ID of the item to which the user should be invited
+     * @param {CollaborationRole} role - The role which the invited collaborator should have
+     * @param {Object} [options] - Optional parameters for the collaboration
+     * @param {ItemType} [options.type=folder] - Type of object to be collaborated
+     * @param {boolean} [options.notify] - Determines if the user or group will receive email notifications
+     * @param {boolean} [options.can_view_path] - Whether view path collaboration feature is enabled or not
+     * @param {boolean} [options.is_access_only] - WARN: Feature not yet available.
+     *   Do not display collaborated items on collaborator's All Files Pages
+     *   and suppress notifications sent to collaborators regarding access-only content.
+     *   This feature is going to be released in Q4. Watch our
+     * 	 [announcements](https://developer.box.com/changelog/) to learn about its availability.
+     * @param {Function} [callback] - Called with the new collaboration if successful
+     * @returns {Promise<Collaboration>} A promise resolving to the created collaboration object
+     */
+    create(accessibleBy: CollaborationAccesibleBy, itemID: string, role: CollaborationRole, options?: {
+        type?: ItemType;
+        notify?: boolean;
+        can_view_path?: boolean;
+        is_access_only?: boolean;
+    } | Function, callback?: Function): Promise<Collaboration>;
+    /**
+     * Invite a user to collaborate on an item via their user ID.
+     *
+     * API Endpoint: '/collaborations
+     * Method: POST
+     *
+     * @param {int | string} userID - The ID of the user you'll invite as a collaborator
+     * @param {string} itemID - Box ID of the item to which the user should be invited
+     * @param {CollaborationRole} role - The role which the invited collaborator should have
+     * @param {Object} [options] - Optional parameters for the collaboration
+     * @param {ItemType} [options.type=folder] - Type of object to be collaborated
+     * @param {boolean} [options.notify] - Determines if the user will receive email notifications
+     * @param {boolean} [options.can_view_path] - Whether view path collaboration feature is enabled or not
+     * @param {Function} [callback] - Called with the new collaboration if successful
+     * @returns {Promise<Collaboration>} A promise resolving to the created collaboration object
+     */
+    createWithUserID(userID: number | string, itemID: string, role: CollaborationRole, options?: {
+        type?: ItemType;
+        notify?: boolean;
+        can_view_path?: boolean;
+    } | Function, callback?: Function): Promise<Collaboration>;
+    /**
+     * Invite a user to collaborate on an item via their user login email address.
+     *
+     * API Endpoint: '/collaborations
+     * Method: POST
+     *
+     * @param {string} email - The collaborator's email address
+     * @param {string} itemID - Box ID of the item to which the user should be invited
+     * @param {CollaborationRole} role - The role which the invited collaborator should have
+     * @param {Object} [options] - Optional parameters for the collaboration
+     * @param {ItemType} [options.type=folder] - Type of object to be collaborated
+     * @param {boolean} [options.notify] - Determines if the user will receive email notifications
+     * @param {boolean} [options.can_view_path] - Whether view path collaboration feature is enabled or not
+     * @param {Function} [callback] - Called with the new collaboration if successful
+     * @returns {Promise<Collaboration>} A promise resolving to the created collaboration object
+     */
+    createWithUserEmail(email: string, itemID: string, role: CollaborationRole, options?: {
+        type?: ItemType;
+        notify?: boolean;
+        can_view_path?: boolean;
+    } | Function, callback?: Function): Promise<Collaboration>;
+    /**
+     * Invite a group to collaborate on an item via their group ID.
+     *
+     * API Endpoint: '/collaborations
+     * Method: POST
+     *
+     * @param {int | string} groupID - The ID of the group you'll invite as a collaborator
+     * @param {string} itemID - Box ID of the item to which the group should be invited
+     * @param {CollaborationRole} role - The role which the invited collaborator should have
+     * @param {Object} [options] - Optional parameters for the collaboration
+     * @param {ItemType} [options.type=folder] - Type of object to be collaborated
+     * @param {boolean} [options.notify] - Determines if the group will receive email notifications
+     * @param {boolean} [options.can_view_path] - Whether view path collaboration feature is enabled or not
+     * @param {Function} [callback] - Called with the new collaboration if successful
+     * @returns {Promise<Collaboration>} A promise resolving to the created collaboration object
+     */
+    createWithGroupID(groupID: number | string, itemID: string, role: CollaborationRole, options?: {
+        type?: ItemType;
+        notify?: boolean;
+        can_view_path?: boolean;
+    } | Function, callback?: Function): Promise<Collaboration>;
+    /**
+     * Delete a given collaboration.
+     *
+     * API Endpoint: '/collaborations/:collaborationID'
+     * Method: DELETE
+     *
+     * @param {string} collaborationID - Box ID of the collaboration being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(collaborationID: string, callback?: Function): Promise<void>;
+}
+/**
+ * @module box-node-sdk/lib/managers/collaborations
+ * @see {@Link Collaborations}
+ */
+export default Collaborations;