box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/managers/collaborations.js

@@ -0,0 +1,252 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Collaboration Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const BASE_PATH = '/collaborations';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * 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}
+ */
+class Collaborations {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * 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, options, callback) {
+        const params = {
+            qs: options,
+        };
+        const apiPath = (0, url_path_1.default)(BASE_PATH, collaborationID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * 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) {
+        const params = {
+            qs: {
+                status: 'pending',
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(BASE_PATH, params, callback);
+    }
+    updateInternal(collaborationID, updates, callback) {
+        const params = {
+            body: updates,
+        };
+        const apiPath = (0, url_path_1.default)(BASE_PATH, collaborationID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * 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, updates, callback) {
+        return this.updateInternal(collaborationID, updates, callback);
+    }
+    /**
+     * 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, newStatus, callback) {
+        return this.updateInternal(collaborationID, {
+            status: newStatus,
+        }, callback);
+    }
+    /**
+     * 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, itemID, role, options, callback) {
+        const defaultOptions = {
+            type: 'folder',
+        };
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        options = Object.assign({}, defaultOptions, options);
+        const params = {
+            body: {
+                item: {
+                    type: options.type,
+                    id: itemID,
+                },
+                accessible_by: accessibleBy,
+                role,
+            },
+        };
+        if (typeof options.can_view_path === 'boolean') {
+            params.body.can_view_path = options.can_view_path;
+        }
+        if (typeof options.notify === 'boolean') {
+            params.qs = {
+                notify: options.notify,
+            };
+        }
+        if (typeof options.is_access_only === 'boolean') {
+            params.body.is_access_only = options.is_access_only;
+        }
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    }
+    /**
+     * 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, itemID, role, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        const accessibleBy = {
+            type: 'user',
+            id: `${userID}`,
+        };
+        return this.create(accessibleBy, itemID, role, options, callback);
+    }
+    /**
+     * 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, itemID, role, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        const accessibleBy = {
+            type: 'user',
+            login: email,
+        };
+        return this.create(accessibleBy, itemID, role, options, callback);
+    }
+    /**
+     * 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, itemID, role, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        const accessibleBy = {
+            type: 'group',
+            id: `${groupID}`,
+        };
+        return this.create(accessibleBy, itemID, role, options, callback);
+    }
+    /**
+     * 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, callback) {
+        const apiPath = (0, url_path_1.default)(BASE_PATH, collaborationID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+}
+module.exports = Collaborations;
+//# sourceMappingURL=collaborations.js.map

package/lib-esm/managers/collaborations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collaborations.js","sourceRoot":"","sources":["../../src/managers/collaborations.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAevC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AACjF,MAAM,SAAS,GAAG,iBAAiB,CAAC;AAEpC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,cAAc;IAGlB,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,eAAuB,EACvB,OAA6B,EAC7B,QAAmB;QAEnB,MAAM,MAAM,GAAG;YACb,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,UAAU,CAAC,QAAmB;QAC5B,MAAM,MAAM,GAAG;YACb,EAAE,EAAE;gBACF,MAAM,EAAE,SAAS;aAClB;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAEO,cAAc,CACpB,eAAuB,EACvB,OAA8D,EAC9D,QAAmB;QAEnB,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACpD,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,MAAM,CACJ,eAAuB,EACvB,OAA4B,EAC5B,QAAmB;QAEnB,OAAO,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,eAAuB,EACvB,SAA8B,EAC9B,QAAmB;QAEnB,OAAO,IAAI,CAAC,cAAc,CACxB,eAAe,EACf;YACE,MAAM,EAAE,SAAS;SAClB,EACD,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACJ,YAAsC,EACtC,MAAc,EACd,IAAuB,EACvB,OAOY,EACZ,QAAmB;QAEnB,MAAM,cAAc,GAAG;YACrB,IAAI,EAAE,QAAQ;SACf,CAAC;QAEF,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;QAErD,MAAM,MAAM,GAGR;YACF,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,EAAE,EAAE,MAAM;iBACX;gBACD,aAAa,EAAE,YAAY;gBAC3B,IAAI;aACL;SACF,CAAC;QAEF,IAAI,OAAO,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QACpD,CAAC;QAED,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,CAAC,EAAE,GAAG;gBACV,MAAM,EAAE,OAAO,CAAC,MAAM;aACvB,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,OAAO,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QACtD,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CACd,MAAuB,EACvB,MAAc,EACd,IAAuB,EACvB,OAMY,EACZ,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAA6B;YAC7C,IAAI,EAAE,MAAM;YACZ,EAAE,EAAE,GAAG,MAAM,EAAE;SAChB,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CACjB,KAAa,EACb,MAAc,EACd,IAAuB,EACvB,OAMY,EACZ,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAA6B;YAC7C,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,KAAK;SACb,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CACf,OAAwB,EACxB,MAAc,EACd,IAAuB,EACvB,OAMY,EACZ,QAAmB;QAEnB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,MAAM,YAAY,GAA6B;YAC7C,IAAI,EAAE,OAAO;YACb,EAAE,EAAE,GAAG,OAAO,EAAE;SACjB,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,eAAuB,EAAE,QAAmB;QACjD,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,eAAe,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAMD,iBAAS,cAAc,CAAC"}

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

@@ -0,0 +1,42 @@
+/**
+ * @fileoverview Manager for the Box Collection Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all 'Collection' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Collections {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Requests all of a user's collection objects.
+     *
+     * API Endpoint: '/collections'
+     * Method: GET
+     *
+     * @param {Function} [callback] - Called with a collection of collections if successful
+     * @returns {Promise<Object>} A promise resolving to the collection of collections
+     */
+    getAll(callback?: Function): any;
+    /**
+     * Requests the items in the collection object with a given ID.
+     *
+     * API Endpoint: '/collections/:collectionID/items'
+     * Method: GET
+     *
+     * @param {string} collectionID - Box ID of the collection with items being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the items information if they were acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of items in the collection
+     */
+    getItems(collectionID: string, options?: Record<string, any>, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/collections
+ * @see {@Link Collections}
+ */
+export = Collections;

package/lib-esm/managers/collections.js

@@ -0,0 +1,62 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Collection 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
+// -----------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const BASE_PATH = '/collections';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Collection' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Collections {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Requests all of a user's collection objects.
+     *
+     * API Endpoint: '/collections'
+     * Method: GET
+     *
+     * @param {Function} [callback] - Called with a collection of collections if successful
+     * @returns {Promise<Object>} A promise resolving to the collection of collections
+     */
+    getAll(callback) {
+        return this.client.wrapWithDefaultHandler(this.client.get)(BASE_PATH, {}, callback);
+    }
+    /**
+     * Requests the items in the collection object with a given ID.
+     *
+     * API Endpoint: '/collections/:collectionID/items'
+     * Method: GET
+     *
+     * @param {string} collectionID - Box ID of the collection with items being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the items information if they were acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the collection of items in the collection
+     */
+    getItems(collectionID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, collectionID, 'items');
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+module.exports = Collections;
+//# sourceMappingURL=collections.js.map

package/lib-esm/managers/collections.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.js","sourceRoot":"","sources":["../../src/managers/collections.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,cAAc,CAAC;AAEjC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,WAAW;IAGf,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAmB;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,SAAS,EACT,EAAE,EACF,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAMD,iBAAS,WAAW,CAAC"}

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

@@ -0,0 +1,103 @@
+/**
+ * @fileoverview Manager for the Box Comments Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all 'Comment' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Comments {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Requests a comment object with the given ID.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: GET
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the comment information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the comment object
+     */
+    get(commentID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Posts a new comment on a file.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} fileID - Box file id of the file to comment on
+     * @param {string} commentBody - text of the comment
+     * @param {Function} [callback] - passed the new comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    create(fileID: string, commentBody: string, callback?: Function): any;
+    /**
+     * Posts a new tagged comment on a file.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} fileID - Box file id of the file to comment on
+     * @param {string} commentBody - text of the tagged comment
+     * @param {Function} [callback] - passed the new tagged comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    createTaggedComment(fileID: string, commentBody: string, callback?: Function): any;
+    /**
+     * Posts a new comment as a reply to another comment.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} commentID - Comment ID of the comment to reply to
+     * @param {string} commentBody - text of the comment
+     * @param {Function} [callback] - passed the new comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    reply(commentID: string, commentBody: string, callback?: Function): any;
+    /**
+     * Posts a new tagged comment as a reply to another comment.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} commentID - Comment ID of the comment to reply to
+     * @param {string} commentBody - text of the tagged comment
+     * @param {Function} [callback] - passed the new tagged comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    createTaggedReply(commentID: string, commentBody: string, callback?: Function): any;
+    /**
+     * Update some information about a given comment.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: PUT
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Object} updates - Fields to update on the comment
+     * @param {Function} [callback] - Passed the updated comment information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated comment object
+     */
+    update(commentID: string, updates: Record<string, any>, callback?: Function): any;
+    /**
+     * Delete a given comment.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: DELETE
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(commentID: string, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/comments
+ * @see {@Link Comments}
+ */
+export = Comments;

package/lib-esm/managers/comments.js

@@ -0,0 +1,175 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Comments 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
+// -----------------------------------------------------------------------------
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+const BASE_PATH = '/comments';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Comment' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Comments {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Requests a comment object with the given ID.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: GET
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the comment information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the comment object
+     */
+    get(commentID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, commentID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Posts a new comment on a file.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} fileID - Box file id of the file to comment on
+     * @param {string} commentBody - text of the comment
+     * @param {Function} [callback] - passed the new comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    create(fileID, commentBody, callback) {
+        // @TODO(bemerick) 2013-10-29: Don't hardcode this 'item'. Abstract to all commentable types...
+        var params = {
+            body: {
+                item: {
+                    type: 'file',
+                    id: fileID,
+                },
+                message: commentBody,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    }
+    /**
+     * Posts a new tagged comment on a file.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} fileID - Box file id of the file to comment on
+     * @param {string} commentBody - text of the tagged comment
+     * @param {Function} [callback] - passed the new tagged comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    createTaggedComment(fileID, commentBody, callback) {
+        var params = {
+            body: {
+                item: {
+                    type: 'file',
+                    id: fileID,
+                },
+                tagged_message: commentBody,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    }
+    /**
+     * Posts a new comment as a reply to another comment.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} commentID - Comment ID of the comment to reply to
+     * @param {string} commentBody - text of the comment
+     * @param {Function} [callback] - passed the new comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    reply(commentID, commentBody, callback) {
+        var params = {
+            body: {
+                item: {
+                    type: 'comment',
+                    id: commentID,
+                },
+                message: commentBody,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    }
+    /**
+     * Posts a new tagged comment as a reply to another comment.
+     *
+     * API Endpoint: '/comments
+     * Method: POST
+     *
+     * @param {string} commentID - Comment ID of the comment to reply to
+     * @param {string} commentBody - text of the tagged comment
+     * @param {Function} [callback] - passed the new tagged comment data if it was posted successfully
+     * @returns {Promise<Object>} A promise resolving to the new comment object
+     */
+    createTaggedReply(commentID, commentBody, callback) {
+        var params = {
+            body: {
+                item: {
+                    type: 'comment',
+                    id: commentID,
+                },
+                tagged_message: commentBody,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(BASE_PATH, params, callback);
+    }
+    /**
+     * Update some information about a given comment.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: PUT
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Object} updates - Fields to update on the comment
+     * @param {Function} [callback] - Passed the updated comment information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated comment object
+     */
+    update(commentID, updates, callback) {
+        var params = {
+            body: updates,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, commentID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Delete a given comment.
+     *
+     * API Endpoint: '/comments/:commentID'
+     * Method: DELETE
+     *
+     * @param {string} commentID - Box ID of the comment being requested
+     * @param {Function} [callback] - Empty response body passed if successful.
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(commentID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, commentID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+}
+module.exports = Comments;
+//# sourceMappingURL=comments.js.map

package/lib-esm/managers/comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.js","sourceRoot":"","sources":["../../src/managers/comments.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,WAAW,CAAC;AAE9B,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,QAAQ;IAGZ,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,SAAiB,EAAE,OAA6B,EAAE,QAAmB;QACvE,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5C,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,MAAM,CAAC,MAAc,EAAE,WAAmB,EAAE,QAAmB;QAC7D,+FAA+F;QAC/F,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,OAAO,EAAE,WAAW;aACrB;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CACjB,MAAc,EACd,WAAmB,EACnB,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;gBACD,cAAc,EAAE,WAAW;aAC5B;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,SAAiB,EAAE,WAAmB,EAAE,QAAmB;QAC/D,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,SAAS;iBACd;gBACD,OAAO,EAAE,WAAW;aACrB;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,SAAiB,EACjB,WAAmB,EACnB,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,SAAS;iBACd;gBACD,cAAc,EAAE,WAAW;aAC5B;SACF,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,SAAS,EACT,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,OAA4B,EAAE,QAAmB;QACzE,IAAI,MAAM,GAAG;YACX,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5C,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,MAAM,CAAC,SAAiB,EAAE,QAAmB;QAC3C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAMD,iBAAS,QAAQ,CAAC"}