box-node-sdk 1.35.0 → 1.37.2

package/lib/managers/device-pins.js

@@ -1,26 +1,22 @@
+"use strict";
 /**
  * @fileoverview Manager for the Device Pins resource
  * @author mwiller
  */
-
-'use strict';
-
-// ------------------------------------------------------------------------------
-// Requirements
-// ------------------------------------------------------------------------------
-var urlPath = require('../util/url-path');
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
 // ------------------------------------------------------------------------------
 // Private
 // ------------------------------------------------------------------------------
-var BASE_PATH = '/device_pinners',
-	ENTERPRISES_PATH = '/enterprises',
-	DEVICE_PINNERS_SUBRESOURCE = 'device_pinners';
-
+var BASE_PATH = '/device_pinners', ENTERPRISES_PATH = '/enterprises', DEVICE_PINNERS_SUBRESOURCE = 'device_pinners';
 // ------------------------------------------------------------------------------
 // Public
 // ------------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all Device Pin endpoints and actions.
  *
@@ -28,79 +24,70 @@ var BASE_PATH = '/device_pinners',
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function DevicePins(client) {
-	this.client = client;
-}
-
-/**
- * Get a specific device pinning record
- *
- * API Endpoint: '/device_pinners/:pinID'
- * Method: GET
- *
- * @param {string} pinID - The ID of the pin to retrieve
- * @param {Object} [options] - Optional paramters, can be left null in many cases
- * @param {Function} [callback] - Passed the device pin if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the device pin object
- */
-DevicePins.prototype.get = function(pinID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, pinID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * Delete a specific device pinning record
- *
- * API Endpoint: '/device_pinners/:pinID'
- * Method: DELETE
- *
- * @param {string} pinID - The ID of the pin to delete
- * @param {Object} [options] - Optional paramters, can be left null in many cases
- * @param {Function} [callback] - Passed nothing if successful, error otherwise
- * @returns {Promise<void>} A promise resolving to nothing
- */
-DevicePins.prototype.delete = function(pinID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, pinID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
-};
-
-/**
- * Get all device pin records for the current enterprise
- *
- * API Endpoint: '/enterprises/:enterpriseID/device_pinners'
- * Method: GET
- *
- * @param {Object} [options] - Optional paramters, can be left null in many cases
- * @param {Function} [callback] - Passed a list of device pins if successful, error otherwise
- * @returns {Promise<Object>} A promise resolving to the collection of device pins
- */
-DevicePins.prototype.getAll = function(options, callback) {
-
-	return this.client.users.get(this.client.CURRENT_USER_ID, {fields: 'enterprise'})
-		.then(data => {
-
-			if (!data.enterprise || !data.enterprise.id) {
-				throw new Error('User must be in an enterprise to view device pins');
-			}
-
-			var apiPath = urlPath(ENTERPRISES_PATH, data.enterprise.id, DEVICE_PINNERS_SUBRESOURCE),
-				params = {
-					qs: options
-				};
-
-			return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params);
-		})
-		.asCallback(callback);
-};
-
+var DevicePins = /** @class */ (function () {
+    function DevicePins(client) {
+        this.client = client;
+    }
+    /**
+     * Get a specific device pinning record
+     *
+     * API Endpoint: '/device_pinners/:pinID'
+     * Method: GET
+     *
+     * @param {string} pinID - The ID of the pin to retrieve
+     * @param {Object} [options] - Optional paramters, can be left null in many cases
+     * @param {Function} [callback] - Passed the device pin if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the device pin object
+     */
+    DevicePins.prototype.get = function (pinID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, pinID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * Delete a specific device pinning record
+     *
+     * API Endpoint: '/device_pinners/:pinID'
+     * Method: DELETE
+     *
+     * @param {string} pinID - The ID of the pin to delete
+     * @param {Object} [options] - Optional paramters, can be left null in many cases
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    DevicePins.prototype.delete = function (pinID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, pinID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, params, callback);
+    };
+    /**
+     * Get all device pin records for the current enterprise
+     *
+     * API Endpoint: '/enterprises/:enterpriseID/device_pinners'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional paramters, can be left null in many cases
+     * @param {Function} [callback] - Passed a list of device pins if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of device pins
+     */
+    DevicePins.prototype.getAll = function (options, callback) {
+        var _this = this;
+        return this.client.users
+            .get(this.client.CURRENT_USER_ID, { fields: 'enterprise' })
+            .then(function (data /* FIXME */) {
+            if (!data.enterprise || !data.enterprise.id) {
+                throw new Error('User must be in an enterprise to view device pins');
+            }
+            var apiPath = url_path_1.default(ENTERPRISES_PATH, data.enterprise.id, DEVICE_PINNERS_SUBRESOURCE), params = {
+                qs: options,
+            };
+            return _this.client.wrapWithDefaultHandler(_this.client.get)(apiPath, params);
+        })
+            .asCallback(callback);
+    };
+    return DevicePins;
+}());
 module.exports = DevicePins;
+//# sourceMappingURL=device-pins.js.map

package/lib/managers/device-pins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-pins.js","sourceRoot":"","sources":["../../src/managers/device-pins.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;AAOH,8DAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,IAAM,SAAS,GAAG,iBAAiB,EAClC,gBAAgB,GAAG,cAAc,EACjC,0BAA0B,GAAG,gBAAgB,CAAC;AAE/C,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;;GAMG;AACH;IAGC,oBAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACH,wBAAG,GAAH,UAAI,KAAa,EAAE,OAA6B,EAAE,QAAmB;QACpE,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,KAAK,CAAC,EACtC,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,2BAAM,GAAN,UAAO,KAAa,EAAE,OAA6B,EAAE,QAAmB;QACvE,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,KAAK,CAAC,EACtC,MAAM,GAAG;YACR,EAAE,EAAE,OAAO;SACX,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,2BAAM,GAAN,UAAO,OAA6B,EAAE,QAAmB;QAAzD,iBAuBC;QAtBA,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK;aACtB,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;aAC1D,IAAI,CAAC,UAAC,IAAS,CAAC,WAAW;YAC3B,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE;gBAC5C,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACrE;YAED,IAAI,OAAO,GAAG,kBAAO,CACnB,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAAC,EAAE,EAClB,0BAA0B,CAC1B,EACD,MAAM,GAAG;gBACR,EAAE,EAAE,OAAO;aACX,CAAC;YAEH,OAAO,KAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,KAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,MAAM,CACN,CAAC;QACH,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IACF,iBAAC;AAAD,CAAC,AAzFD,IAyFC;AAED,iBAAS,UAAU,CAAC"}

package/lib/managers/enterprise.d.ts

@@ -0,0 +1,162 @@
+/**
+ * @fileoverview Manager for Enterprise resources
+ */
+import BoxClient from '../box-client';
+/**
+ * List of valid user types
+ * @readonly
+ * @enum {EnterpriseUserType}
+ */
+declare enum EnterpriseUserType {
+    ALL = "all",
+    MANAGED = "managed",
+    EXTERNAL = "external"
+}
+/**
+ * List of valid user statuses
+ * @readonly
+ * @enum {EnterpriseUserStatus}
+ */
+declare enum EnterpriseUserStatus {
+    ACTIVE = "active",
+    INACTIVE = "inactive",
+    CANNOT_DELETE_OR_EDIT = "cannot_delete_edit",
+    CANNOT_DELETE_EDIT_OR_UPLOAD = "cannot_delete_edit_upload"
+}
+/**
+ * List of valid roles
+ * @readonly
+ * @enum {EnterpriseRole}
+ */
+declare enum EnterpriseRole {
+    USER = "user",
+    COADMIN = "coadmin"
+}
+/**
+ * Simple manager for interacting with all Enterprise endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Enterprise {
+    client: BoxClient;
+    userTypes: typeof EnterpriseUserType;
+    userStatuses: typeof EnterpriseUserStatus;
+    userRoles: typeof EnterpriseRole;
+    constructor(client: BoxClient);
+    /**
+     * Get a list of users in the current enterprise
+     *
+     * API Endpoint: '/users'
+     * Method: GET
+     *
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.filter_term] - Filter the results to only users starting with the filter_term in either the name or the login
+     * @param {int} [options.limit=100] - The number of records to return
+     * @param {boolean} [options.usemarker=false] - Whether or not to use marker-based pagination
+     * @param {string} [options.marker=''] - The marker for the page at which to start. Default is the first page
+     * @param {int} [options.offset=0] - The record at which to start
+     * @param {EnterpriseUserType} [options.user_type=managed] - The type of user to search for
+     * @param {Function} [callback] - Passed the list of users if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of users
+     */
+    getUsers(options?: {
+        filter_term?: string;
+        limit?: number;
+        usemarker?: boolean;
+        marker?: string;
+        offset?: number;
+        user_type?: EnterpriseUserType;
+    }, callback?: Function): any;
+    /**
+     * Invites a user to join the enterprise
+     *
+     * API Endpoint: '/invites'
+     * Method: POST
+     *
+     * @param {string} enterpriseID - The ID of the enterprise to invite the user to
+     * @param {string} email - The email address of the user to invite
+     * @param {Function} [callback] - Passed the invite object if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the invite object
+     */
+    inviteUser(enterpriseID: string, email: string, callback?: Function): any;
+    /**
+     * Create a new user in the current enterprise
+     *
+     * API Endpoint: '/users'
+     * Method: POST
+     *
+     * @param {string} login - The email address this user uses to login
+     * @param {string} name - The name of this user
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {EnterpriseRole} [options.role] - This user’s enterprise role
+     * @param {string} [options.language] - The user's language
+     * @param {boolean} [options.is_sync_enabled] - Whether or not this user can use Box Sync
+     * @param {string} [options.job_title] - The user’s job title
+     * @param {string} [options.phone] - The user’s phone number
+     * @param {string} [options.address] - The user’s address
+     * @param {int} [options.space_amount] - The user’s total available storage space in bytes
+     * @param {Array} [options.tracking_codes] - An array of key/value pairs set by the user’s admin
+     * @param {EnterpriseUserStatus} [options.status] - The user's status
+     * @param {boolean} [options.can_see_managed_users] - Whether the user should be able to see other managed users
+     * @param {string} [options.timezone] - The user's timezone
+     * @param {boolean} [options.is_exempt_from_device_limits] - Whether to exempt this user from Enterprise device limits
+     * @param {boolean} [options.is_exempt_from_login_verification] - Whether or not this user must use two-factor authentication
+     * @param {Function} [callback] - Passed the created user if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created user
+     */
+    addUser(login: string, name: string, options?: {
+        role?: EnterpriseRole;
+        language?: string;
+        is_sync_enabled?: boolean;
+        job_title?: string;
+        phone?: string;
+        address?: string;
+        space_amount?: number;
+        tracking_codes?: [string, any][];
+        status?: EnterpriseUserStatus;
+        can_see_managed_users?: boolean;
+        timezone?: string;
+        is_exempt_from_device_limits?: boolean;
+        is_exempt_from_login_verification?: boolean;
+    }, callback?: Function): any;
+    /**
+     * Create a new app user in the current enterprise
+     *
+     * API Endpoint: '/users'
+     * Method: POST
+     *
+     * @param {string} name - The name of this user
+     * @param {Object} [options] - Optional parameters, can be left null in most cases
+     * @param {string} [options.language] - The user's language
+     * @param {string} [options.job_title] - The user’s job title
+     * @param {string} [options.phone] - The user’s phone number
+     * @param {string} [options.address] - The user’s address
+     * @param {int} [options.space_amount] - The user’s total available storage space in bytes
+     * @param {string} [options.timezone] - The user's timezone
+     * @param {Function} [callback] - Passed the created user if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created user
+     */
+    addAppUser(name: string, options?: {
+        language?: string;
+        job_title?: string;
+        phone?: string;
+        address?: string;
+        space_amount?: number;
+        timezone?: string;
+    }, callback?: Function): any;
+    /**
+     * Transfers all of a user's files into another user's account.
+     *
+     * API Endpoint: '/users/:sourceUserID/folders/0'
+     * Method: PUT
+     *
+     * @param {string} sourceUserID - The ID of the user whose files will be transferred
+     * @param {string} destUserID - The ID of the user to transfer the files to
+     * @param {Function} [callback] - Passed the new folder which contains all the files if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the folder containing the transferred content
+     */
+    transferUserContent(sourceUserID: string, destUserID: string, callback?: Function): any;
+}
+export = Enterprise;