box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/managers/users.js

@@ -0,0 +1,230 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box User 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 = '/users', EMAIL_ALIASES_SUBRESOURCE = 'email_aliases', GROUP_MEMBERSHIPS_SUBRESOURCE = 'memberships', CURRENT_USER_ID = 'me';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'User' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Users {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Requests information for the Box user info associated with a given ID
+     *
+     * API Endpoint: '/users/:id'
+     * Method: GET
+     *
+     * @param {string} userID - The ID of the user to retrieve
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - passed the user info if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the user object
+     */
+    get(userID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Update some information about a user.
+     *
+     * API Endpoint: '/users/:id'
+     * Method: PUT
+     *
+     * @param {string} userID - The ID of the user to update
+     * @param {Object} updates - User fields to update
+     * @param {Function} [callback] - Passed the updated user information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated user object
+     */
+    update(userID, updates, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Deletes a user in an enterprise account.
+     *
+     * API Endpoint: '/users/:userID'
+     * Method: DELETE
+     *
+     * @param {string} userID - The ID of the user to delete
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {boolean} [options.notify] - Determines if the destination user should receive email notification of the transfer.
+     * @param {boolean} [options.force] - Whether or not the user should be deleted even if this user still own files.
+     * @param {Function} [callback] - Empty response body passed if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(userID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    }
+    // @NOTE(mwiller) 2014-06-10: This does not include their primary email address!
+    /**
+     * Get all linked email addresses for a user.
+     *
+     * API Endpoint: '/users/:id/email_aliases'
+     * Method: GET
+     *
+     * @param {string} userID - The ID of the user to retrieve email alises for
+     * @param {Function} [callback] - Passed the email aliases if successful
+     * @returns {Promise<Object>} A promise resolving to the collection of email aliases
+     */
+    getEmailAliases(userID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, EMAIL_ALIASES_SUBRESOURCE);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Add a linked email address to a user's account.
+     *
+     * API Endpoint: '/users/:id/email_aliases'
+     * Method: POST
+     *
+     * @param {string} userID - The ID of the user to add an email alias to
+     * @param {string} email - The email address to add
+     * @param {Object} [options] - Optional parameters
+     * @param {boolean} [options.is_confirmed=false] Whether or not to attempt to auto-confirm the alias (for admins)
+     * @param {Function} [callback] - Passed the new alias if successful
+     * @returns {Promise<Object>} A promise resolving to the new email alias
+     */
+    addEmailAlias(userID, email, options, callback) {
+        options = options || {};
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, EMAIL_ALIASES_SUBRESOURCE), params = {
+            body: {
+                email,
+                is_confirmed: false, // don't attempt to autoconfirm aliases for admins by default
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Remove a linked email address from the current user by alias ID.
+     *
+     * API Endpoint: '/users/:id/email_aliases/:aliasID'
+     * Method: DELETE
+     *
+     * @param {string} userID - The ID of the user to remove the email alias from
+     * @param {string} aliasID - The ID of the linked email alias to remove
+     * @param {Function} [callback] - Passed nothing on success
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    removeEmailAlias(userID, aliasID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, EMAIL_ALIASES_SUBRESOURCE, aliasID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Retrieve a list of group memberships for the user, which show which groups
+     * the user belongs to.  This ability is restricted to group admins.
+     *
+     * API Endpoint: '/users/:userID/memberships'
+     * Method: GET
+     *
+     * @param {string} userID - The ID of the user to get group memberships for
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {int} [options.limit] - The number of memberships to retrieve
+     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
+     * @param {Function} [callback] - Passed a list of memberships if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of group memberships
+     */
+    getGroupMemberships(userID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, GROUP_MEMBERSHIPS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Retrieve the user's avatar image.
+     *
+     * API Endpoint: '/users/:userID/avatar'
+     * Method: GET
+     *
+     * @param {string} userID The ID of the user whose avatar should be retrieved
+     * @param {Function} [callback] Passed a stream over the bytes of the avatar image if successful
+     * @returns {Promise<Readable>} A promise resolving to the image stream
+     */
+    getAvatar(userID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, 'avatar'), params = {
+            streaming: true,
+        };
+        return this.client.get(apiPath, params).asCallback(callback);
+    }
+    /**
+     * Set the user's avatar image.
+     *
+     * API Endpoint: '/users/:userID/avatar'
+     * Method: POST
+     *
+     * @param {string} userID The ID of the user whose avatar should be set
+     * @param {string|Buffer|ReadStream} avatar - the content of the file. It can be a string, a Buffer, or a read stream
+     * (like that returned by fs.createReadStream()).
+     * @param {Function} [callback] Passed dictionary of picture urls if successful
+     * @returns {Promise<Object>} A promise resolving to the picture urls
+     */
+    setAvatar(userID, avatar, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, 'avatar'), params = {
+            formData: {
+                pic: avatar,
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Delete the user's avatar image.
+     *
+     * API Endpoint: '/users/:userID/avatar'
+     * Method: DELETE
+     *
+     * @param {string} userID The ID of the user whose avatar should be deleted
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    deleteAvatar(userID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, userID, 'avatar'), params = {};
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    }
+    /**
+     * Validates the roles and permissions of the user,
+     * and creates asynchronous jobs to terminate the user's sessions.
+     *
+     * API Endpoint: '/users/terminate_sessions'
+     * Method: POST
+     *
+     * @param {Object} options - The user IDs or logins to terminate sessions
+     * @param {string[]} [options.userIDs] - The user IDs to terminate sessions
+     * @param {string[]} [options.userLogins] - The user logins to terminate sessions
+     * @returns {Promise<Object>} A promise resolving a message about the request status.
+     */
+    terminateSession(options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, 'terminate_sessions'), params = {
+            body: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+}
+/** @const {string} */
+Users.prototype.CURRENT_USER_ID = CURRENT_USER_ID;
+module.exports = Users;
+//# sourceMappingURL=users.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/managers/users.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAGvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,QAAQ,EACxB,yBAAyB,GAAG,eAAe,EAC3C,6BAA6B,GAAG,aAAa,EAC7C,eAAe,GAAG,IAAI,CAAC;AAEzB,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,KAAK;IAKT,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAc,EAAE,OAA6B,EAAE,QAAmB;QACpE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAc,EAAE,OAA4B,EAAE,QAAmB;QACtE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,CAAC,EACtC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED,gFAAgF;IAChF;;;;;;;;;OASG;IACH,eAAe,CAAC,MAAc,EAAE,QAAmB;QACjD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,yBAAyB,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,MAAc,EACd,KAAa,EACb,OAIY,EACZ,QAAmB;QAEnB,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QACxB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,yBAAyB,CAAC,EACjE,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,KAAK;gBACL,YAAY,EAAE,KAAK,EAAE,6DAA6D;aACnF;SACF,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CAAC,MAAc,EAAE,OAAe,EAAE,QAAmB;QACnE,IAAI,OAAO,GAAG,IAAA,kBAAO,EACnB,SAAS,EACT,MAAM,EACN,yBAAyB,EACzB,OAAO,CACR,CAAC;QACF,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,6BAA6B,CAAC,EACrE,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,MAAc,EAAE,QAAmB;QAC3C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAChD,MAAM,GAAG;YACP,SAAS,EAAE,IAAI;SAChB,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CACP,MAAc,EACd,MAAkC,EAClC,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAChD,MAAM,GAAG;YACP,QAAQ,EAAE;gBACR,GAAG,EAAE,MAAM;aACZ;SACF,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAc,EAAE,QAAmB;QAC9C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAChD,MAAM,GAAG,EAAE,CAAC;QAEd,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,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,oBAAoB,CAAC,EACpD,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,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;CACF;AAED,sBAAsB;AACtB,KAAK,CAAC,SAAS,CAAC,eAAe,GAAG,eAAe,CAAC;AAMlD,iBAAS,KAAK,CAAC"}

package/lib-esm/managers/web-links.d.ts

@@ -0,0 +1,127 @@
+/**
+ * @fileoverview Manager for the Web Links Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all 'Weblinks' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class WebLinks {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Creates a web link object within a given folder.
+     *
+     * API Endpoint: '/web_links'
+     * Method: POST
+     *
+     * @param {string} url - URL you want the web link to point to. Must include http:// or https://
+     * @param {string} parentID - The ID of the parent folder where you're creating the web link
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.name] - Name for the web link. Will default to the URL if empty.
+     * @param {string} [options.description] - Description of the web link. Will provide more context to users about the web link.
+     * @param {Function} [callback] - Passed the new web link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created weblink object
+     */
+    create(url: string, parentID: string, options?: {
+        name?: string;
+        description?: string;
+    }, callback?: Function): any;
+    /**
+     * Use to get information about the web link.
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: GET
+     *
+     * @param {string} weblinkID - The Box ID of web link being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the web-link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the weblink object
+     */
+    get(weblinkID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Updates information for a web link.
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: PUT
+     *
+     * @param {string} weblinkID - The Box ID of the web link being updated
+     * @param {Object} updates - Fields of the weblink to update
+     * @param {string} [updates.name] - Name for the web link. Will default to the URL if empty.
+     * @param {string} [updates.description] - Description of the web link. Will provide more context to users about the web link.
+     * @param {Function} [callback] - Passed the updated web link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    update(weblinkID: string, updates?: {
+        name?: string;
+        description?: string;
+        collections?: string[];
+    }, callback?: Function): any;
+    /**
+     * Deletes a web link and moves it to the trash
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: DELETE
+     *
+     * @param {string} weblinkID - The Box ID of the web link being moved to the trash
+     * @param {Function} [callback] - Empty body passed if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to nothing
+     */
+    delete(weblinkID: string, callback?: Function): any;
+    /**
+     * Move a web link into a new parent folder.
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The Box ID of the web link being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to move to All Files.
+     * @param {Function} [callback] - Passed the updated web link information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    move(webLinkID: string, newParentID: string, callback?: Function): any;
+    /**
+     * Copy a web link into a new, different folder
+     *
+     * API Endpoint: '/web_links/:webLinkID/copy
+     * Method: POST
+     *
+     * @param {string} webLinkID - The Box ID of the web link being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to copy to All Files.
+     * @param {Object} [options] - Optional parameters for the copy operation, can be left null in most cases
+     * @param {string} [options.name] - A new name to use if there is an identically-named item in the new parent folder
+     * @param {Function} [callback] - passed the new web link info if call was successful
+     * @returns {Promise<Object>} A promise resolving to the new web link object
+     */
+    copy(webLinkID: string, newParentID: string, options?: {
+        name?: string;
+    }, callback?: Function): any;
+    /**
+     * Add a web link to a given collection
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The web link to add to the collection
+     * @param {string} collectionID - The collection to add the web link to
+     * @param {Function} [callback] - Passed the updated web link if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    addToCollection(webLinkID: string, collectionID: string, callback?: Function): any;
+    /**
+     * Remove a web link from a given collection
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The web link to remove from the collection
+     * @param {string} collectionID - The collection to remove the web link from
+     * @param {Function} [callback] - Passed the updated web link if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    removeFromCollection(webLinkID: string, collectionID: string, callback?: Function): any;
+}
+export = WebLinks;

package/lib-esm/managers/web-links.js

@@ -0,0 +1,200 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Web Links 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 = '/web_links';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Weblinks' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class WebLinks {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Creates a web link object within a given folder.
+     *
+     * API Endpoint: '/web_links'
+     * Method: POST
+     *
+     * @param {string} url - URL you want the web link to point to. Must include http:// or https://
+     * @param {string} parentID - The ID of the parent folder where you're creating the web link
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.name] - Name for the web link. Will default to the URL if empty.
+     * @param {string} [options.description] - Description of the web link. Will provide more context to users about the web link.
+     * @param {Function} [callback] - Passed the new web link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created weblink object
+     */
+    create(url, parentID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
+            body: {
+                url,
+                parent: {
+                    id: parentID,
+                },
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Use to get information about the web link.
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: GET
+     *
+     * @param {string} weblinkID - The Box ID of web link being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the web-link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the weblink object
+     */
+    get(weblinkID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, weblinkID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Updates information for a web link.
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: PUT
+     *
+     * @param {string} weblinkID - The Box ID of the web link being updated
+     * @param {Object} updates - Fields of the weblink to update
+     * @param {string} [updates.name] - Name for the web link. Will default to the URL if empty.
+     * @param {string} [updates.description] - Description of the web link. Will provide more context to users about the web link.
+     * @param {Function} [callback] - Passed the updated web link information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    update(weblinkID, updates, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, weblinkID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Deletes a web link and moves it to the trash
+     *
+     * API Endpoint: '/web_links/:weblinkID'
+     * Method: DELETE
+     *
+     * @param {string} weblinkID - The Box ID of the web link being moved to the trash
+     * @param {Function} [callback] - Empty body passed if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to nothing
+     */
+    delete(weblinkID, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, weblinkID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+    /**
+     * Move a web link into a new parent folder.
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The Box ID of the web link being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to move to All Files.
+     * @param {Function} [callback] - Passed the updated web link information if it was acquired successfully
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    move(webLinkID, newParentID, callback) {
+        var params = {
+            body: {
+                parent: {
+                    id: newParentID,
+                },
+            },
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, webLinkID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Copy a web link into a new, different folder
+     *
+     * API Endpoint: '/web_links/:webLinkID/copy
+     * Method: POST
+     *
+     * @param {string} webLinkID - The Box ID of the web link being requested
+     * @param {string} newParentID - The Box ID for the new parent folder. '0' to copy to All Files.
+     * @param {Object} [options] - Optional parameters for the copy operation, can be left null in most cases
+     * @param {string} [options.name] - A new name to use if there is an identically-named item in the new parent folder
+     * @param {Function} [callback] - passed the new web link info if call was successful
+     * @returns {Promise<Object>} A promise resolving to the new web link object
+     */
+    copy(webLinkID, newParentID, options, callback) {
+        options = options || {};
+        options.parent = {
+            id: newParentID,
+        };
+        var params = {
+            body: options,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, webLinkID, '/copy');
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Add a web link to a given collection
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The web link to add to the collection
+     * @param {string} collectionID - The collection to add the web link to
+     * @param {Function} [callback] - Passed the updated web link if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    addToCollection(webLinkID, collectionID, callback) {
+        return this.get(webLinkID, { fields: 'collections' })
+            .then((data /* FIXME */) => {
+            var collections = data.collections || [];
+            // Convert to correct format
+            collections = collections.map((c /* FIXME */) => ({
+                id: c.id,
+            }));
+            if (!collections.find((c /* FIXME */) => c.id === collectionID)) {
+                collections.push({ id: collectionID });
+            }
+            return this.update(webLinkID, { collections });
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Remove a web link from a given collection
+     *
+     * API Endpoint: '/web_links/:webLinkID'
+     * Method: PUT
+     *
+     * @param {string} webLinkID - The web link to remove from the collection
+     * @param {string} collectionID - The collection to remove the web link from
+     * @param {Function} [callback] - Passed the updated web link if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated web link object
+     */
+    removeFromCollection(webLinkID, collectionID, callback) {
+        return this.get(webLinkID, { fields: 'collections' })
+            .then((data /* FIXME */) => {
+            var collections = data.collections || [];
+            // Convert to correct object format and remove the specified collection
+            collections = collections
+                .map((c /* FIXME */) => ({ id: c.id }))
+                .filter((c /* FIXME */) => c.id !== collectionID);
+            return this.update(webLinkID, { collections });
+        })
+            .asCallback(callback);
+    }
+}
+module.exports = WebLinks;
+//# sourceMappingURL=web-links.js.map

package/lib-esm/managers/web-links.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-links.js","sourceRoot":"","sources":["../../src/managers/web-links.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,MAAM,SAAS,GAAG,YAAY,CAAC;AAE/B,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH,MAAM,QAAQ;IAGZ,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,GAAW,EACX,QAAgB,EAChB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,GAAG;gBACH,MAAM,EAAE;oBACN,EAAE,EAAE,QAAQ;iBACb;aACF;SACF,CAAC;QAEJ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CAAC,SAAiB,EAAE,OAA6B,EAAE,QAAmB;QACvE,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,EACzC,MAAM,GAAG;YACP,EAAE,EAAE,OAAO;SACZ,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,SAAiB,EACjB,OAIC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,EACzC,MAAM,GAAG;YACP,IAAI,EAAE,OAAO;SACd,CAAC;QAEJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,QAAmB;QAC3C,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CAAC,SAAiB,EAAE,WAAmB,EAAE,QAAmB;QAC9D,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,MAAM,EAAE;oBACN,EAAE,EAAE,WAAW;iBAChB;aACF;SACF,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;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,SAAiB,EACjB,WAAmB,EACnB,OAEC,EACD,QAAmB;QAEnB,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAEvB,OAA+B,CAAC,MAAM,GAAG;YACxC,EAAE,EAAE,WAAW;SAChB,CAAC;QAEF,IAAI,MAAM,GAAG;YACX,IAAI,EAAE,OAAO;SACd,CAAC;QACF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACrD,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,eAAe,CACb,SAAiB,EACjB,YAAoB,EACpB,QAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;aAClD,IAAI,CAAC,CAAC,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YAEzC,4BAA4B;YAC5B,WAAW,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrD,EAAE,EAAE,CAAC,CAAC,EAAE;aACT,CAAC,CAAC,CAAC;YAEJ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;gBACrE,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;YACzC,CAAC;YAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,SAAiB,EACjB,YAAoB,EACpB,QAAmB;QAEnB,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;aAClD,IAAI,CAAC,CAAC,IAAS,CAAC,WAAW,EAAE,EAAE;YAC9B,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;YACzC,uEAAuE;YACvE,WAAW,GAAG,WAAW;iBACtB,GAAG,CAAC,CAAC,CAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;iBAC3C,MAAM,CAAC,CAAC,CAAM,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,YAAY,CAAC,CAAC;YAEzD,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;CACF;AAED,iBAAS,QAAQ,CAAC"}