box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/managers/terms-of-service.js

@@ -0,0 +1,283 @@
+"use strict";
+/**
+ * @fileoverview Manager for the  Box Terms of Service Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// -----------------------------------------------------------------------------
+// Requirements
+// -----------------------------------------------------------------------------
+const http_status_1 = __importDefault(require("http-status"));
+const errors_1 = __importDefault(require("../util/errors"));
+const url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * Enum value of scope of the custom terms of services set to either managed by an enterprise or enternal to an enterprise
+ *
+ * @readonly
+ * @enum {TermsOfServicesType}
+ */
+var TermsOfServicesType;
+(function (TermsOfServicesType) {
+    TermsOfServicesType["MANAGED"] = "managed";
+    TermsOfServicesType["EXTERNAL"] = "external";
+})(TermsOfServicesType || (TermsOfServicesType = {}));
+/**
+ * Enum value of status of the custom terms of services, either currently enabled or currently disabled
+ *
+ * @readonly
+ * @enum {TermsOfServicesStatus}
+ */
+var TermsOfServicesStatus;
+(function (TermsOfServicesStatus) {
+    TermsOfServicesStatus["ENABLED"] = "enabled";
+    TermsOfServicesStatus["DISABLED"] = "disabled";
+})(TermsOfServicesStatus || (TermsOfServicesStatus = {}));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+// Base path for all terms of service endpoints
+const BASE_PATH = '/terms_of_services', USER_STATUSES_PATH = '/terms_of_service_user_statuses';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Terms of Services' and 'Terms of Service User Statuses' endpoints and actions.
+ *
+ * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+ * @constructor
+ */
+class TermsOfService {
+    constructor(client) {
+        // Attach the client, for making API calls
+        this.client = client;
+    }
+    /**
+     * Creates a custom terms of services with user specified values
+     *
+     * API Endpoint: '/terms_of_services'
+     * Method: POST
+     *
+     * @param {TermsOfServicesType} termsOfServicesType - Determine if the custom terms of service is scoped internall or externally to an enterprise
+     * @param {TermsOfServicesStatus} termsOfServicesStatus - Determine if the custom terms of service is enabled or disabled
+     * @param {string} termsOfServicesText - Text field for message associated with custom terms of services
+     * @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of services object
+     */
+    create(termsOfServicesType, termsOfServicesStatus, termsOfServicesText, callback) {
+        var params = {
+            body: {
+                status: termsOfServicesStatus,
+                tos_type: termsOfServicesType,
+                text: termsOfServicesText,
+            },
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Updates a custom terms of services with new specified values
+     *
+     * API Endpoint: '/terms_of_services/:termsOfServicesID'
+     * Method: PUT
+     *
+     * @param {string} termsOfServicesID - The id of the custom terms of services to update
+     * @param {Object} updates - Fields ot the Terms of Service to update
+     * @param {TermsOfServicesStatus} [updates.status] - Determine if the custom terms of service is scoped internall or externally to an enterprise
+     * @param {string} [updates.text] - Text field for message associated with custom terms of services
+     * @param {Function} [callback] - Passed the terms of services updated information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of services object
+     */
+    update(termsOfServicesID, updates, callback) {
+        var params = {
+            body: updates,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, termsOfServicesID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Gets a specific custom terms of services with specified ID
+     *
+     * API Endpoint: '/terms_of_services/:termsOfServicesID'
+     * Method: GET
+     *
+     * @param {string} termsOfServicesID - The id of the custom terms of services to retrieve
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
+     * @param {Function} [callback] - Passed the terms of services information with specified ID if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of services object
+     */
+    get(termsOfServicesID, options, callback) {
+        var params = {
+            qs: options,
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH, termsOfServicesID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Gets custom terms of services for the user's enterprise
+     *
+     * API Endpoint: '/terms_of_services'
+     * Method: GET
+     *
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {TermsOfServiceType} [options.tos_type] - Optional, indicates whether the terms of service is set for external or managed under enterprise
+     * @param {string} [options.fields] - Comma-separated list of fields to return on the collaboration objects
+     * @param {Function} [callback] - Passed the terms of services information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of services object
+     */
+    getAll(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);
+    }
+    /**
+     * Accepts/rejects custom terms of services for the user
+     *
+     * API Endpoint: '/terms_of_service_user_statuses'
+     * Method: POST
+     *
+     * @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
+     * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
+     * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of service user status
+     */
+    createUserStatus(termsOfServicesID, isAccepted, options, callback) {
+        var params = {
+            body: {
+                tos: {
+                    id: termsOfServicesID,
+                    type: 'terms_of_service',
+                },
+                is_accepted: isAccepted,
+            },
+        };
+        if (options && options.user_id) {
+            params.body.user = { id: options.user_id, type: 'user' };
+        }
+        var apiPath = (0, url_path_1.default)(USER_STATUSES_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Gets a terms os service status given the terms of services id
+     *
+     * API Endpoint: '/terms_of_service_user_statuses'
+     * Method: GET
+     *
+     * @param {string} termsOfServicesID - The ID of the terms of services to retrieve status on
+     * @param {Object} [options] - Additional options. Can be left null in most cases
+     * @param {string} [options.user_id] - Optional, the id of the user to retrieve status of custom terms and service on
+     * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of service user status
+     */
+    getUserStatus(termsOfServicesID, options, callback) {
+        var params = {
+            qs: {
+                tos_id: termsOfServicesID,
+            },
+        };
+        if (options) {
+            Object.assign(params.qs, options);
+        }
+        var apiPath = (0, url_path_1.default)(USER_STATUSES_PATH);
+        return this.client
+            .get(apiPath, params)
+            .then((response /* FIXME */) => {
+            if (response.statusCode !== 200) {
+                throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+            return response.body.entries[0] ?? {};
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Accepts/rejects custom terms of services for the user
+     *
+     * API Endpoint: '/terms_of_service_user_statuses'
+     * Method: PUT
+     *
+     * @param {string} termsOfServiceUserStatusID - Terms of service user status object ID
+     * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
+     * @param {Function} [callback] - Passed the terms of service user status updated information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated terms of service user status
+     */
+    updateUserStatus(termsOfServiceUserStatusID, isAccepted, callback) {
+        var params = {
+            body: {
+                is_accepted: isAccepted,
+            },
+        };
+        var apiPath = (0, url_path_1.default)(USER_STATUSES_PATH, termsOfServiceUserStatusID);
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Creates a user status for terms of service, if already exists then update existing user status for terms of service
+     *
+     * API Endpoint: '/terms_of_service_user_statuses'
+     * Method: POST/PUT
+     *
+     * @param {string} termsOfServicesID - Terms of services ID to retrieve user statuses on
+     * @param {boolean} isAccepted - Determines wehether the terms of services has been accepted or rejected
+     * @param {Object} [options] - Additional options. Can be left null in most cases.
+     * @param {string} [options.user_id] - Optional, user id to retrieve terms of service status on, default is current user
+     * @param {Function} [callback] - Passed the terms of service user status information if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the terms of service user status
+     */
+    setUserStatus(termsOfServicesID, isAccepted, options, callback) {
+        var params = {
+            body: {
+                tos: {
+                    id: termsOfServicesID,
+                    type: 'terms_of_service',
+                },
+                is_accepted: isAccepted,
+            },
+        };
+        if (options && options.user_id) {
+            params.body.user = { id: options.user_id, type: 'user' };
+        }
+        var apiPath = (0, url_path_1.default)(USER_STATUSES_PATH);
+        return this.client
+            .post(apiPath, params)
+            .then((response /* FIXME */) => {
+            switch (response.statusCode) {
+                // 200/201 - A user status has been successfully updated/created on terms of service
+                // return the terms of service user status object
+                case http_status_1.default.OK:
+                case http_status_1.default.CREATED:
+                    return response.body;
+                // 409 - Conflict
+                // Terms of Service already exists. Update the existing terms of service object
+                case http_status_1.default.CONFLICT:
+                    var getOptions = Object.assign({ fields: 'id' }, options);
+                    return this.getUserStatus(termsOfServicesID, getOptions).then((userStatus /* FIXME */) => this.updateUserStatus(userStatus.id, isAccepted));
+                default:
+                    throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+        })
+            .asCallback(callback);
+    }
+}
+/**
+ * Enum value of scope of the custom terms of services set to either managed by an enterprise or enternal to an enterprise
+ *
+ * @readonly
+ * @enum {TermsOfServicesType}
+ */
+TermsOfService.prototype.type = TermsOfServicesType;
+/**
+ * Enum value of status of the custom terms of services, either currently enabled or currently disabled
+ *
+ * @readonly
+ * @enum {TermsOfServicesStatus}
+ */
+TermsOfService.prototype.status = TermsOfServicesStatus;
+module.exports = TermsOfService;
+//# sourceMappingURL=terms-of-service.js.map

package/lib-esm/managers/terms-of-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terms-of-service.js","sourceRoot":"","sources":["../../src/managers/terms-of-service.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,8DAA0C;AAE1C,4DAAoC;AACpC,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;;GAKG;AACH,IAAK,mBAGJ;AAHD,WAAK,mBAAmB;IACtB,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;AAED;;;;;GAKG;AACH,IAAK,qBAGJ;AAHD,WAAK,qBAAqB;IACxB,4CAAmB,CAAA;IACnB,8CAAqB,CAAA;AACvB,CAAC,EAHI,qBAAqB,KAArB,qBAAqB,QAGzB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,+CAA+C;AAC/C,MAAM,SAAS,GAAG,oBAAoB,EACpC,kBAAkB,GAAG,iCAAiC,CAAC;AAEzD,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;GAKG;AACH,MAAM,cAAc;IAMlB,YAAY,MAAiB;QAC3B,0CAA0C;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,mBAAwC,EACxC,qBAA4C,EAC5C,mBAA2B,EAC3B,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,MAAM,EAAE,qBAAqB;gBAC7B,QAAQ,EAAE,mBAAmB;gBAC7B,IAAI,EAAE,mBAAmB;aAC1B;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;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,iBAAyB,EACzB,OAGC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE,OAAO;SACd,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,iBAAiB,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;;;;;;;;;;;OAWG;IACH,GAAG,CACD,iBAAyB,EACzB,OAEC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE,OAAO;SACZ,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,iBAAiB,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;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,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;;;;;;;;;;;;OAYG;IACH,gBAAgB,CACd,iBAAyB,EACzB,UAAmB,EACnB,OAEC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,GAAG,EAAE;oBACH,EAAE,EAAE,iBAAiB;oBACrB,IAAI,EAAE,kBAAkB;iBACzB;gBACD,WAAW,EAAE,UAAU;aACD;SACzB,CAAC;QAEF,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3D,CAAC;QAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CACX,iBAAyB,EACzB,OAEC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,EAAE,EAAE;gBACF,MAAM,EAAE,iBAAiB;aAC1B;SACF,CAAC;QAEF,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,MAAM;aACf,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;aACpB,IAAI,CAAC,CAAC,QAAa,CAAC,WAAW,EAAE,EAAE;YAClC,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;gBAChC,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,0BAAkC,EAClC,UAAmB,EACnB,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,WAAW,EAAE,UAAU;aACxB;SACF,CAAC;QAEF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,EAAE,0BAA0B,CAAC,CAAC;QACtE,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,aAAa,CACX,iBAAyB,EACzB,UAAmB,EACnB,OAEC,EACD,QAAmB;QAEnB,IAAI,MAAM,GAAG;YACX,IAAI,EAAE;gBACJ,GAAG,EAAE;oBACH,EAAE,EAAE,iBAAiB;oBACrB,IAAI,EAAE,kBAAkB;iBACzB;gBACD,WAAW,EAAE,UAAU;aACD;SACzB,CAAC;QAEF,IAAI,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,EAAE,EAAE,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3D,CAAC;QAED,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,kBAAkB,CAAC,CAAC;QAE1C,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;aACrB,IAAI,CAAC,CAAC,QAAa,CAAC,WAAW,EAAE,EAAE;YAClC,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAC5B,oFAAoF;gBACpF,iDAAiD;gBACjD,KAAK,qBAAe,CAAC,EAAE,CAAC;gBACxB,KAAK,qBAAe,CAAC,OAAO;oBAC1B,OAAO,QAAQ,CAAC,IAAI,CAAC;gBAEvB,iBAAiB;gBACjB,+EAA+E;gBAC/E,KAAK,qBAAe,CAAC,QAAQ;oBAC3B,IAAI,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;oBAC1D,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC,IAAI,CAC3D,CAAC,UAAe,CAAC,WAAW,EAAE,EAAE,CAC9B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,CACnD,CAAC;gBAEJ;oBACE,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACxD,CAAC;QACH,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;CACF;AAED;;;;;GAKG;AACH,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG,mBAAmB,CAAC;AAEpD;;;;;GAKG;AACH,cAAc,CAAC,SAAS,CAAC,MAAM,GAAG,qBAAqB,CAAC;AAMxD,iBAAS,cAAc,CAAC"}

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

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview Manager for the Trash Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all Trash endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Trash {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Get items in the user's trash
+     *
+     * API Endpoint: '/folders/trash/items'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.fields] - Comma-delimited list of item fields to return
+     * @param {Function} [callback] - Passed the list of trashed items if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of trashed items
+     */
+    get(options?: {
+        fields?: string;
+    }, callback?: Function): any;
+}
+export = Trash;

package/lib-esm/managers/trash.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Trash 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
+// -----------------------------------------------------------------------------
+// Trash is technically a folder, so it uses the folders endpoint
+const BASE_PATH = '/folders', TRASH_ID = 'trash', ITEMS_SUBRESOURCE = 'items';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all Trash endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class Trash {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get items in the user's trash
+     *
+     * API Endpoint: '/folders/trash/items'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.fields] - Comma-delimited list of item fields to return
+     * @param {Function} [callback] - Passed the list of trashed items if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of trashed items
+     */
+    get(options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, TRASH_ID, ITEMS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+module.exports = Trash;
+//# sourceMappingURL=trash.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trash.js","sourceRoot":"","sources":["../../src/managers/trash.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,gEAAuC;AAEvC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,iEAAiE;AACjE,MAAM,SAAS,GAAG,UAAU,EAC1B,QAAQ,GAAG,OAAO,EAClB,iBAAiB,GAAG,OAAO,CAAC;AAE9B,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,KAAK;IAGT,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;;;OAUG;IACH,GAAG,CACD,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,EAC3D,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;CACF;AAED,iBAAS,KAAK,CAAC"}

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

@@ -0,0 +1,171 @@
+/**
+ * @fileoverview Manager for the Box User Resource
+ */
+import BoxClient from '../box-client';
+import { Readable } from 'stream';
+/**
+ * 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}
+ */
+declare class Users {
+    client: BoxClient;
+    CURRENT_USER_ID: string;
+    constructor(client: BoxClient);
+    /**
+     * 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: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * 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: string, updates: Record<string, any>, callback?: Function): any;
+    /**
+     * 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: string, options?: {
+        notify?: boolean;
+        force?: boolean;
+    }, callback?: Function): any;
+    /**
+     * 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: string, callback?: Function): any;
+    /**
+     * 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: string, email: string, options?: {
+        is_confirmed?: boolean;
+    } | Function, callback?: Function): any;
+    /**
+     * 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: string, aliasID: string, callback?: Function): any;
+    /**
+     * 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: string, options?: {
+        limit?: number;
+        offset?: number;
+    }, callback?: Function): any;
+    /**
+     * 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: string, callback?: Function): any;
+    /**
+     * 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: string, avatar: string | Buffer | Readable, callback?: Function): any;
+    /**
+     * 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: string, callback?: Function): any;
+    /**
+     * 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: {
+        userIDs?: string[];
+        userLogins?: string[];
+    }, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/users
+ * @see {@Link Users}
+ */
+export = Users;