box-node-sdk 3.8.0 → 3.8.2

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

@@ -0,0 +1,222 @@
+/**
+ * @fileoverview Manager for the Box Events Resource
+ */
+import BoxClient from '../box-client';
+import EnterpriseEventStream from '../enterprise-event-stream';
+/**
+ * Enum of enterprise event types
+ *
+ * @readonly
+ * @enum {EventType}
+ */
+declare enum EventType {
+    ADD_DEVICE_ASSOCIATION = "ADD_DEVICE_ASSOCIATION",
+    ADD_LOGIN_ACTIVITY_DEVICE = "ADD_LOGIN_ACTIVITY_DEVICE",
+    ADMIN_INVITE_ACCEPT = "MASTER_INVITE_ACCEPT",
+    ADMIN_INVITE_REJECT = "MASTER_INVITE_REJECT",
+    ADMIN_LOGIN = "ADMIN_LOGIN",
+    APPLICATION_PUBLIC_KEY_ADDED = "APPLICATION_PUBLIC_KEY_ADDED",
+    APPLICATION_PUBLIC_KEY_DELETED = "APPLICATION_PUBLIC_KEY_DELETED",
+    CHANGE_ADMIN_ROLE = "CHANGE_ADMIN_ROLE",
+    COLLABORATION_ACCEPT = "COLLABORATION_ACCEPT",
+    COLLABORATION_EXPIRATION = "COLLABORATION_EXPIRATION",
+    COLLABORATION_INVITE = "COLLABORATION_INVITE",
+    COLLABORATION_REMOVE = "COLLABORATION_REMOVE",
+    COLLABORATION_ROLE_CHANGE = "COLLABORATION_ROLE_CHANGE",
+    COMMENT_CREATE = "COMMENT_CREATE",
+    COMMENT_DELETE = "COMMENT_DELETE",
+    COMMENT_EDIT = "COMMENT_EDIT",
+    CONTENT_ACCESS = "CONTENT_ACCESS",
+    CONTENT_WORKFLOW_AUTOMATION_ADD = "CONTENT_WORKFLOW_AUTOMATION_ADD",
+    CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION = "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION",
+    COPY = "COPY",
+    DELETE = "DELETE",
+    DELETE_USER = "DELETE_USER",
+    DOWNLOAD = "DOWNLOAD",
+    EDIT = "EDIT",
+    EDIT_USER = "EDIT_USER",
+    EMAIL_ALIAS_CONFIRM = "EMAIL_ALIAS_CONFIRM",
+    ENABLE_TWO_FACTOR_AUTH = "ENABLE_TWO_FACTOR_AUTH",
+    ENTERPRISE_APP_AUTHORIZATION_DELETE = "ENTERPRISE_APP_AUTHORIZATION_DELETE",
+    FAILED_LOGIN = "FAILED_LOGIN",
+    FILE_MARKED_MALICIOUS = "FILE_MARKED_MALICIOUS",
+    FILE_WATERMARKED_DOWNLOAD = "FILE_WATERMARKED_DOWNLOAD",
+    GROUP_ADD_FILE = "GROUP_ADD_FILE",
+    GROUP_ADD_FOLDER = "GROUP_ADD_FOLDER",
+    GROUP_ADD_ITEM = "GROUP_ADD_ITEM",
+    GROUP_ADD_USER = "GROUP_ADD_USER",
+    GROUP_CREATION = "GROUP_CREATION",
+    GROUP_DELETION = "GROUP_DELETION",
+    GROUP_EDITED = "GROUP_EDITED",
+    GROUP_REMOVE_FILE = "GROUP_REMOVE_FILE",
+    GROUP_REMOVE_FOLDER = "GROUP_REMOVE_FOLDER",
+    GROUP_REMOVE_USER = "GROUP_REMOVE_USER",
+    ITEM_MODIFY = "ITEM_MODIFY",
+    ITEM_OPEN = "ITEM_OPEN",
+    ITEM_SHARED_UPDATE = "ITEM_SHARED_UPDATE",
+    ITEM_SYNC = "ITEM_SYNC",
+    ITEM_UNSYNC = "ITEM_UNSYNC",
+    LOCK = "LOCK",
+    LOGIN = "LOGIN",
+    METADATA_INSTANCE_CREATE = "METADATA_INSTANCE_CREATE",
+    METADATA_INSTANCE_DELETE = "METADATA_INSTANCE_DELETE",
+    METADATA_INSTANCE_UPDATE = "METADATA_INSTANCE_UPDATE",
+    METADATA_TEMPLATE_CREATE = "METADATA_TEMPLATE_CREATE",
+    METADATA_TEMPLATE_UPDATE = "METADATA_TEMPLATE_UPDATE",
+    MOVE = "MOVE",
+    NEW_USER = "NEW_USER",
+    PREVIEW = "PREVIEW",
+    REMOVE_DEVICE_ASSOCIATION = "REMOVE_DEVICE_ASSOCIATION",
+    REMOVE_LOGIN_ACTIVITY_DEVICE = "REMOVE_LOGIN_ACTIVITY_DEVICE",
+    RENAME = "RENAME",
+    SHARE = "SHARE",
+    SHARE_EXPIRATION = "SHARE_EXPIRATION",
+    STORAGE_EXPIRATION = "STORAGE_EXPIRATION",
+    TASK_ASSIGNMENT_CREATE = "TASK_ASSIGNMENT_CREATE",
+    TASK_ASSIGNMENT_UPDATE = "TASK_ASSIGNMENT_UPDATE",
+    TASK_CREATE = "TASK_CREATE",
+    TERMS_OF_SERVICE_AGREE = "TERMS_OF_SERVICE_AGREE",
+    TERMS_OF_SERVICE_REJECT = "TERMS_OF_SERVICE_REJECT",
+    UNDELETE = "UNDELETE",
+    UNLOCK = "UNLOCK",
+    UNSHARE = "UNSHARE",
+    UPDATE_COLLABORATION_EXPIRATION = "UPDATE_COLLABORATION_EXPIRATION",
+    UPDATE_SHARE_EXPIRATION = "UPDATE_SHARE_EXPIRATION",
+    UPLOAD = "UPLOAD",
+    WATERMARK_LABEL_CREATE = "WATERMARK_LABEL_CREATE",
+    WATERMARK_LABEL_DELETE = "WATERMARK_LABEL_DELETE"
+}
+/**
+ * Simple manager for interacting with all 'Events' endpoints and actions.
+ *
+ * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+ * @constructor
+ */
+declare class Events {
+    client: BoxClient;
+    CURRENT_STREAM_POSITION: string;
+    enterpriseEventTypes: typeof EventType;
+    constructor(client: BoxClient);
+    /**
+     * Get the current stream position.
+     *
+     * API Endpoint: '/events'
+     * Method: GET
+     *
+     * @param {Function} [callback] Passed the current stream position if successful
+     * @returns {Promise<string>} A promise resolving to the stream position
+     */
+    getCurrentStreamPosition(callback?: Function): any;
+    /**
+     * Get a chunk of events
+     *
+     * API Endpoint: '/events'
+     * Method: GET
+     *
+     * To get events from admin events stream you have to pick stream_type from `admin_logs` or `admin_logs_streaming`.
+     * The `admin_logs` stream emphasis is on completeness over latency,
+     * which means that Box will deliver admin events in chronological order and without duplicates,
+     * but with higher latency. You can specify start and end time/dates.
+     *
+     * To monitor recent events that have been generated within Box across the enterprise use
+     * `admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological
+     * accuracy, which means that Box may return events more than once and out of chronological order.
+     * Events are returned via the API around 12 seconds after they are processed by Box
+     * (the 12 seconds buffer ensures that new events are not written after your cursor position).
+     * Only two weeks of events are available via this feed, and you cannot set start and end time/dates.
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.stream_type] - From which stream events should be selected.
+     * 	Possible values are `admin_logs` and `admin_logs_streaming`
+     * @param {string} [options.created_after] - The date to start from in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
+     * @param {string} [options.created_before] - The date to end at in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
+     * @param {string} [options.event_type] - String of event types to return coma separated: for example 'DOWNLOAD,UPLOAD'
+     * @param {number} [options.limit] - Number of events to fetch per call
+     * @param {string} [options.stream_position] - The stream position to start from (pass '0' for all past events)
+     * @param {Function} [callback] Passed the current stream position if successful
+     * @returns {Promise<Object>} A promise resolving to the collection of events
+     */
+    get(options?: {
+        [key: string]: any;
+        stream_type?: string;
+        created_after?: string;
+        created_before?: string;
+        event_type?: string;
+        limit?: number;
+        stream_position?: string;
+    }, callback?: Function): any;
+    /**
+     * Get information for long-polling until new events are available
+     *
+     * API Endpoint: '/events'
+     * Method: OPTIONS
+     *
+     * @param {Function} [callback] Passed the long poll info if successful
+     * @returns {Promise<Object>} A promise resolving to the long poll info
+     */
+    getLongPollInfo(callback?: Function): any;
+    /**
+     * Create a stream of events, using the long-poll API to wait for new events.
+     *
+     * API Endpoint: '/events'
+     * Method: OPTIONS
+     *
+     * @param {string} [streamPosition] Starting stream position
+     * @param {Object} [options] Optional parameters for the event stream
+     * @param {int} [options.retryDelay=1000] Number of ms to wait before retrying after an error
+     * @param {int} [options.deduplicationFilterSize=5000] Number of IDs to track for deduplication
+     * @param {int} [options.fetchInterval=1000] Minimunm number of ms between calls for more events
+     * @param {Function} [callback] Passed the events stream if successful
+     * @returns {Promise<EventStream>} A promise resolving to the event stream
+     */
+    getEventStream(streamPosition: string, options?: {
+        retryDelay?: number;
+        deduplicationFilterSize?: number;
+        fetchInterval?: number;
+    } | Function, callback?: Function): any;
+    /**
+     * Create a stream of enterprise events.
+     *
+     * By default, the stream starts from the current time.
+     * Pass 'startDate' to start from a specific time.
+     * Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year).
+     * Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds.
+     * If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling).
+     *
+     * By default, stream pools `admin_logs` for events. The emphasis for this stream is on completeness over latency,
+     * which means that Box will deliver admin events in chronological order and without duplicates,
+     * but with higher latency. You can specify start and end time/dates.
+     *
+     * To monitor recent events that have been generated within Box across the enterprise use
+     * `admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological
+     * accuracy, which means that Box may return events more than once and out of chronological order.
+     * Events are returned via the API around 12 seconds after they are processed by Box
+     * (the 12 seconds buffer ensures that new events are not written after your cursor position).
+     * Only two weeks of events are available via this feed, and you cannot set start and end time/dates.
+     *
+     * This method will only work with an API connection for an enterprise admin account
+     * or service account with a manage enterprise properties.
+     *
+     * @param {Object} [options] - Options
+     * @param {string} [options.streamPosition] - The stream position to start from (pass '0' for all past events)
+     * @param {string} [options.startDate] - The date to start from
+     * @param {string} [options.endDate] - The date to end at
+     * @param {EventType[]} [options.eventTypeFilter] - Array of event types to return
+     * @param {int} [options.pollingInterval=60] - Polling interval (in seconds).  Pass 0 for no polling.
+     * @param {int} [options.chunkSize=500] - Number of events to fetch per call (max = 500)
+     * @param {string} [options.streamType] - From which stream events should be selected.
+     * 	Possible values are `admin_logs` and `admin_logs_streaming`
+     * @param {Function} [callback] Passed the events stream if successful
+     * @returns {Promise<EnterpriseEventStream>} A promise resolving to the enterprise event stream
+     */
+    getEnterpriseEventStream(options?: {
+        streamPosition?: string;
+        startDate?: string;
+        endDate?: string;
+        eventTypeFilter?: EventType[];
+        pollingInterval?: number;
+        chunkSize?: number;
+        streamType?: 'admin_logs' | 'admin_logs_streaming';
+    }, callback?: Function): import("bluebird")<EnterpriseEventStream>;
+}
+export = Events;

package/lib-esm/managers/events.js

@@ -0,0 +1,295 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Box Events Resource
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+const bluebird_1 = require("bluebird");
+const http_status_1 = __importDefault(require("http-status"));
+const enterprise_event_stream_1 = __importDefault(require("../enterprise-event-stream"));
+const event_stream_1 = __importDefault(require("../event-stream"));
+const errors_1 = __importDefault(require("../util/errors"));
+const url_path_1 = __importDefault(require("../util/url-path"));
+// -----------------------------------------------------------------------------
+// Typedefs
+// -----------------------------------------------------------------------------
+/**
+ * Enum of enterprise event types
+ *
+ * @readonly
+ * @enum {EventType}
+ */
+var EventType;
+(function (EventType) {
+    EventType["ADD_DEVICE_ASSOCIATION"] = "ADD_DEVICE_ASSOCIATION";
+    EventType["ADD_LOGIN_ACTIVITY_DEVICE"] = "ADD_LOGIN_ACTIVITY_DEVICE";
+    EventType["ADMIN_INVITE_ACCEPT"] = "MASTER_INVITE_ACCEPT";
+    EventType["ADMIN_INVITE_REJECT"] = "MASTER_INVITE_REJECT";
+    EventType["ADMIN_LOGIN"] = "ADMIN_LOGIN";
+    EventType["APPLICATION_PUBLIC_KEY_ADDED"] = "APPLICATION_PUBLIC_KEY_ADDED";
+    EventType["APPLICATION_PUBLIC_KEY_DELETED"] = "APPLICATION_PUBLIC_KEY_DELETED";
+    EventType["CHANGE_ADMIN_ROLE"] = "CHANGE_ADMIN_ROLE";
+    EventType["COLLABORATION_ACCEPT"] = "COLLABORATION_ACCEPT";
+    EventType["COLLABORATION_EXPIRATION"] = "COLLABORATION_EXPIRATION";
+    EventType["COLLABORATION_INVITE"] = "COLLABORATION_INVITE";
+    EventType["COLLABORATION_REMOVE"] = "COLLABORATION_REMOVE";
+    EventType["COLLABORATION_ROLE_CHANGE"] = "COLLABORATION_ROLE_CHANGE";
+    EventType["COMMENT_CREATE"] = "COMMENT_CREATE";
+    EventType["COMMENT_DELETE"] = "COMMENT_DELETE";
+    EventType["COMMENT_EDIT"] = "COMMENT_EDIT";
+    EventType["CONTENT_ACCESS"] = "CONTENT_ACCESS";
+    EventType["CONTENT_WORKFLOW_AUTOMATION_ADD"] = "CONTENT_WORKFLOW_AUTOMATION_ADD";
+    EventType["CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION"] = "CONTENT_WORKFLOW_UPLOAD_POLICY_VIOLATION";
+    EventType["COPY"] = "COPY";
+    EventType["DELETE"] = "DELETE";
+    EventType["DELETE_USER"] = "DELETE_USER";
+    EventType["DOWNLOAD"] = "DOWNLOAD";
+    EventType["EDIT"] = "EDIT";
+    EventType["EDIT_USER"] = "EDIT_USER";
+    EventType["EMAIL_ALIAS_CONFIRM"] = "EMAIL_ALIAS_CONFIRM";
+    EventType["ENABLE_TWO_FACTOR_AUTH"] = "ENABLE_TWO_FACTOR_AUTH";
+    EventType["ENTERPRISE_APP_AUTHORIZATION_DELETE"] = "ENTERPRISE_APP_AUTHORIZATION_DELETE";
+    EventType["FAILED_LOGIN"] = "FAILED_LOGIN";
+    EventType["FILE_MARKED_MALICIOUS"] = "FILE_MARKED_MALICIOUS";
+    EventType["FILE_WATERMARKED_DOWNLOAD"] = "FILE_WATERMARKED_DOWNLOAD";
+    EventType["GROUP_ADD_FILE"] = "GROUP_ADD_FILE";
+    EventType["GROUP_ADD_FOLDER"] = "GROUP_ADD_FOLDER";
+    EventType["GROUP_ADD_ITEM"] = "GROUP_ADD_ITEM";
+    EventType["GROUP_ADD_USER"] = "GROUP_ADD_USER";
+    EventType["GROUP_CREATION"] = "GROUP_CREATION";
+    EventType["GROUP_DELETION"] = "GROUP_DELETION";
+    EventType["GROUP_EDITED"] = "GROUP_EDITED";
+    EventType["GROUP_REMOVE_FILE"] = "GROUP_REMOVE_FILE";
+    EventType["GROUP_REMOVE_FOLDER"] = "GROUP_REMOVE_FOLDER";
+    EventType["GROUP_REMOVE_USER"] = "GROUP_REMOVE_USER";
+    EventType["ITEM_MODIFY"] = "ITEM_MODIFY";
+    EventType["ITEM_OPEN"] = "ITEM_OPEN";
+    EventType["ITEM_SHARED_UPDATE"] = "ITEM_SHARED_UPDATE";
+    EventType["ITEM_SYNC"] = "ITEM_SYNC";
+    EventType["ITEM_UNSYNC"] = "ITEM_UNSYNC";
+    EventType["LOCK"] = "LOCK";
+    EventType["LOGIN"] = "LOGIN";
+    EventType["METADATA_INSTANCE_CREATE"] = "METADATA_INSTANCE_CREATE";
+    EventType["METADATA_INSTANCE_DELETE"] = "METADATA_INSTANCE_DELETE";
+    EventType["METADATA_INSTANCE_UPDATE"] = "METADATA_INSTANCE_UPDATE";
+    EventType["METADATA_TEMPLATE_CREATE"] = "METADATA_TEMPLATE_CREATE";
+    EventType["METADATA_TEMPLATE_UPDATE"] = "METADATA_TEMPLATE_UPDATE";
+    EventType["MOVE"] = "MOVE";
+    EventType["NEW_USER"] = "NEW_USER";
+    EventType["PREVIEW"] = "PREVIEW";
+    EventType["REMOVE_DEVICE_ASSOCIATION"] = "REMOVE_DEVICE_ASSOCIATION";
+    EventType["REMOVE_LOGIN_ACTIVITY_DEVICE"] = "REMOVE_LOGIN_ACTIVITY_DEVICE";
+    EventType["RENAME"] = "RENAME";
+    EventType["SHARE"] = "SHARE";
+    EventType["SHARE_EXPIRATION"] = "SHARE_EXPIRATION";
+    EventType["STORAGE_EXPIRATION"] = "STORAGE_EXPIRATION";
+    EventType["TASK_ASSIGNMENT_CREATE"] = "TASK_ASSIGNMENT_CREATE";
+    EventType["TASK_ASSIGNMENT_UPDATE"] = "TASK_ASSIGNMENT_UPDATE";
+    EventType["TASK_CREATE"] = "TASK_CREATE";
+    EventType["TERMS_OF_SERVICE_AGREE"] = "TERMS_OF_SERVICE_AGREE";
+    EventType["TERMS_OF_SERVICE_REJECT"] = "TERMS_OF_SERVICE_REJECT";
+    EventType["UNDELETE"] = "UNDELETE";
+    EventType["UNLOCK"] = "UNLOCK";
+    EventType["UNSHARE"] = "UNSHARE";
+    EventType["UPDATE_COLLABORATION_EXPIRATION"] = "UPDATE_COLLABORATION_EXPIRATION";
+    EventType["UPDATE_SHARE_EXPIRATION"] = "UPDATE_SHARE_EXPIRATION";
+    EventType["UPLOAD"] = "UPLOAD";
+    EventType["WATERMARK_LABEL_CREATE"] = "WATERMARK_LABEL_CREATE";
+    EventType["WATERMARK_LABEL_DELETE"] = "WATERMARK_LABEL_DELETE";
+})(EventType || (EventType = {}));
+// ------------------------------------------------------------------------------
+// Private
+// ------------------------------------------------------------------------------
+// Base path for all files endpoints
+const BASE_PATH = '/events';
+/** @const {string} */
+const CURRENT_STREAM_POSITION = 'now';
+// ------------------------------------------------------------------------------
+// Public
+// ------------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all 'Events' endpoints and actions.
+ *
+ * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+ * @constructor
+ */
+class Events {
+    constructor(client) {
+        // Attach the client, for making API calls
+        this.client = client;
+    }
+    /**
+     * Get the current stream position.
+     *
+     * API Endpoint: '/events'
+     * Method: GET
+     *
+     * @param {Function} [callback] Passed the current stream position if successful
+     * @returns {Promise<string>} A promise resolving to the stream position
+     */
+    getCurrentStreamPosition(callback) {
+        var params = {
+            qs: {
+                stream_position: CURRENT_STREAM_POSITION,
+            },
+        };
+        var apiPath = (0, url_path_1.default)(BASE_PATH);
+        return this.client
+            .get(apiPath, params)
+            .then((response /* FIXME */) => {
+            if (response.statusCode !== http_status_1.default.OK) {
+                throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+            return response.body.next_stream_position;
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Get a chunk of events
+     *
+     * API Endpoint: '/events'
+     * Method: GET
+     *
+     * To get events from admin events stream you have to pick stream_type from `admin_logs` or `admin_logs_streaming`.
+     * The `admin_logs` stream emphasis is on completeness over latency,
+     * which means that Box will deliver admin events in chronological order and without duplicates,
+     * but with higher latency. You can specify start and end time/dates.
+     *
+     * To monitor recent events that have been generated within Box across the enterprise use
+     * `admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological
+     * accuracy, which means that Box may return events more than once and out of chronological order.
+     * Events are returned via the API around 12 seconds after they are processed by Box
+     * (the 12 seconds buffer ensures that new events are not written after your cursor position).
+     * Only two weeks of events are available via this feed, and you cannot set start and end time/dates.
+     *
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {string} [options.stream_type] - From which stream events should be selected.
+     * 	Possible values are `admin_logs` and `admin_logs_streaming`
+     * @param {string} [options.created_after] - The date to start from in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
+     * @param {string} [options.created_before] - The date to end at in ISO-8601 timestamp format: '2001-01-01T00:00:00-08:00'
+     * @param {string} [options.event_type] - String of event types to return coma separated: for example 'DOWNLOAD,UPLOAD'
+     * @param {number} [options.limit] - Number of events to fetch per call
+     * @param {string} [options.stream_position] - The stream position to start from (pass '0' for all past events)
+     * @param {Function} [callback] Passed the current stream position if successful
+     * @returns {Promise<Object>} A promise resolving to the collection of events
+     */
+    get(options, callback) {
+        const params = {
+            qs: options,
+        };
+        if (options &&
+            options.stream_type &&
+            options.stream_type === 'admin_logs_streaming') {
+            const { created_after, created_before, ...filteredOptions } = options;
+            params.qs = filteredOptions;
+        }
+        const apiPath = (0, url_path_1.default)(BASE_PATH);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get information for long-polling until new events are available
+     *
+     * API Endpoint: '/events'
+     * Method: OPTIONS
+     *
+     * @param {Function} [callback] Passed the long poll info if successful
+     * @returns {Promise<Object>} A promise resolving to the long poll info
+     */
+    getLongPollInfo(callback) {
+        const apiPath = (0, url_path_1.default)(BASE_PATH);
+        return this.client
+            .options(apiPath, {})
+            .then((response /* FIXME */) => {
+            if (response.statusCode !== http_status_1.default.OK) {
+                throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+            let longpollInfo = response.body.entries.find((entry /* FIXME */) => entry.type === 'realtime_server');
+            if (!longpollInfo) {
+                throw errors_1.default.buildResponseError('No valid long poll server specified', response);
+            }
+            return longpollInfo;
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Create a stream of events, using the long-poll API to wait for new events.
+     *
+     * API Endpoint: '/events'
+     * Method: OPTIONS
+     *
+     * @param {string} [streamPosition] Starting stream position
+     * @param {Object} [options] Optional parameters for the event stream
+     * @param {int} [options.retryDelay=1000] Number of ms to wait before retrying after an error
+     * @param {int} [options.deduplicationFilterSize=5000] Number of IDs to track for deduplication
+     * @param {int} [options.fetchInterval=1000] Minimunm number of ms between calls for more events
+     * @param {Function} [callback] Passed the events stream if successful
+     * @returns {Promise<EventStream>} A promise resolving to the event stream
+     */
+    getEventStream(streamPosition, options, callback) {
+        const self = this;
+        if (typeof streamPosition === 'string') {
+            if (typeof options === 'function') {
+                callback = options;
+                options = {};
+            }
+            return bluebird_1.Promise.resolve(new event_stream_1.default(self.client, streamPosition, options)).asCallback(callback);
+        }
+        // Fix up optional arguments
+        callback = options /* FIXME */;
+        options = streamPosition;
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        return this.getCurrentStreamPosition()
+            .then((currentStreamPosition /* FIXME */) => new event_stream_1.default(self.client, currentStreamPosition, options))
+            .asCallback(callback);
+    }
+    /**
+     * Create a stream of enterprise events.
+     *
+     * By default, the stream starts from the current time.
+     * Pass 'startDate' to start from a specific time.
+     * Pass 'streamPosition' to start from a previous stream position, or '0' for all available past events (~1 year).
+     * Once the stream catches up to the current time, it will begin polling every 'pollingInterval' seconds.
+     * If 'pollingInterval' = 0, then the stream will end when it catches up to the current time (no polling).
+     *
+     * By default, stream pools `admin_logs` for events. The emphasis for this stream is on completeness over latency,
+     * which means that Box will deliver admin events in chronological order and without duplicates,
+     * but with higher latency. You can specify start and end time/dates.
+     *
+     * To monitor recent events that have been generated within Box across the enterprise use
+     * `admin_logs_streaming` as stream type. The emphasis for this feed is on low latency rather than chronological
+     * accuracy, which means that Box may return events more than once and out of chronological order.
+     * Events are returned via the API around 12 seconds after they are processed by Box
+     * (the 12 seconds buffer ensures that new events are not written after your cursor position).
+     * Only two weeks of events are available via this feed, and you cannot set start and end time/dates.
+     *
+     * This method will only work with an API connection for an enterprise admin account
+     * or service account with a manage enterprise properties.
+     *
+     * @param {Object} [options] - Options
+     * @param {string} [options.streamPosition] - The stream position to start from (pass '0' for all past events)
+     * @param {string} [options.startDate] - The date to start from
+     * @param {string} [options.endDate] - The date to end at
+     * @param {EventType[]} [options.eventTypeFilter] - Array of event types to return
+     * @param {int} [options.pollingInterval=60] - Polling interval (in seconds).  Pass 0 for no polling.
+     * @param {int} [options.chunkSize=500] - Number of events to fetch per call (max = 500)
+     * @param {string} [options.streamType] - From which stream events should be selected.
+     * 	Possible values are `admin_logs` and `admin_logs_streaming`
+     * @param {Function} [callback] Passed the events stream if successful
+     * @returns {Promise<EnterpriseEventStream>} A promise resolving to the enterprise event stream
+     */
+    getEnterpriseEventStream(options, callback) {
+        const self = this;
+        return bluebird_1.Promise.resolve(new enterprise_event_stream_1.default(self.client, options)).asCallback(callback);
+    }
+}
+Events.prototype.CURRENT_STREAM_POSITION = CURRENT_STREAM_POSITION;
+Events.prototype.enterpriseEventTypes = EventType;
+module.exports = Events;
+//# sourceMappingURL=events.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/managers/events.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,iFAAiF;AACjF,eAAe;AACf,iFAAiF;AAEjF,uCAAmC;AACnC,8DAA0C;AAE1C,yFAA+D;AAC/D,mEAA0C;AAC1C,4DAAoC;AACpC,gEAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;;GAKG;AACH,IAAK,SA4EJ;AA5ED,WAAK,SAAS;IACZ,8DAAiD,CAAA;IACjD,oEAAuD,CAAA;IACvD,yDAA4C,CAAA;IAC5C,yDAA4C,CAAA;IAC5C,wCAA2B,CAAA;IAC3B,0EAA6D,CAAA;IAC7D,8EAAiE,CAAA;IACjE,oDAAuC,CAAA;IACvC,0DAA6C,CAAA;IAC7C,kEAAqD,CAAA;IACrD,0DAA6C,CAAA;IAC7C,0DAA6C,CAAA;IAC7C,oEAAuD,CAAA;IACvD,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IACjC,0CAA6B,CAAA;IAC7B,8CAAiC,CAAA;IACjC,gFAAmE,CAAA;IACnE,kGAAqF,CAAA;IACrF,0BAAa,CAAA;IACb,8BAAiB,CAAA;IACjB,wCAA2B,CAAA;IAC3B,kCAAqB,CAAA;IACrB,0BAAa,CAAA;IACb,oCAAuB,CAAA;IACvB,wDAA2C,CAAA;IAC3C,8DAAiD,CAAA;IACjD,wFAA2E,CAAA;IAC3E,0CAA6B,CAAA;IAC7B,4DAA+C,CAAA;IAC/C,oEAAuD,CAAA;IACvD,8CAAiC,CAAA;IACjC,kDAAqC,CAAA;IACrC,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IACjC,8CAAiC,CAAA;IACjC,0CAA6B,CAAA;IAC7B,oDAAuC,CAAA;IACvC,wDAA2C,CAAA;IAC3C,oDAAuC,CAAA;IACvC,wCAA2B,CAAA;IAC3B,oCAAuB,CAAA;IACvB,sDAAyC,CAAA;IACzC,oCAAuB,CAAA;IACvB,wCAA2B,CAAA;IAC3B,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,kEAAqD,CAAA;IACrD,kEAAqD,CAAA;IACrD,kEAAqD,CAAA;IACrD,kEAAqD,CAAA;IACrD,kEAAqD,CAAA;IACrD,0BAAa,CAAA;IACb,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,oEAAuD,CAAA;IACvD,0EAA6D,CAAA;IAC7D,8BAAiB,CAAA;IACjB,4BAAe,CAAA;IACf,kDAAqC,CAAA;IACrC,sDAAyC,CAAA;IACzC,8DAAiD,CAAA;IACjD,8DAAiD,CAAA;IACjD,wCAA2B,CAAA;IAC3B,8DAAiD,CAAA;IACjD,gEAAmD,CAAA;IACnD,kCAAqB,CAAA;IACrB,8BAAiB,CAAA;IACjB,gCAAmB,CAAA;IACnB,gFAAmE,CAAA;IACnE,gEAAmD,CAAA;IACnD,8BAAiB,CAAA;IACjB,8DAAiD,CAAA;IACjD,8DAAiD,CAAA;AACnD,CAAC,EA5EI,SAAS,KAAT,SAAS,QA4Eb;AAED,iFAAiF;AACjF,UAAU;AACV,iFAAiF;AAEjF,oCAAoC;AACpC,MAAM,SAAS,GAAG,SAAS,CAAC;AAE5B,sBAAsB;AACtB,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,iFAAiF;AACjF,SAAS;AACT,iFAAiF;AAEjF;;;;;GAKG;AACH,MAAM,MAAM;IAMV,YAAY,MAAiB;QAC3B,0CAA0C;QAC1C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CAAC,QAAmB;QAC1C,IAAI,MAAM,GAAG;YACX,EAAE,EAAE;gBACF,eAAe,EAAE,uBAAuB;aACzC;SACF,CAAC;QACF,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACjC,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,qBAAe,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YAED,OAAO,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC;QAC5C,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,GAAG,CACD,OAQC,EACD,QAAmB;QAEnB,MAAM,MAAM,GAAG;YACb,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,IACE,OAAO;YACP,OAAO,CAAC,WAAW;YACnB,OAAO,CAAC,WAAW,KAAK,sBAAsB,EAC9C,CAAC;YACD,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;YACtE,MAAM,CAAC,EAAE,GAAG,eAAe,CAAC;QAC9B,CAAC;QACD,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACnC,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,eAAe,CAAC,QAAmB;QACjC,MAAM,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC,MAAM;aACf,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;aACpB,IAAI,CAAC,CAAC,QAAa,CAAC,WAAW,EAAE,EAAE;YAClC,IAAI,QAAQ,CAAC,UAAU,KAAK,qBAAe,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YAED,IAAI,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAC3C,CAAC,KAAU,CAAC,WAAW,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,iBAAiB,CAC7D,CAAC;YAEF,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,MAAM,gBAAM,CAAC,kBAAkB,CAC7B,qCAAqC,EACrC,QAAQ,CACT,CAAC;YACJ,CAAC;YAED,OAAO,YAAY,CAAC;QACtB,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,cAAsB,EACtB,OAMY,EACZ,QAAmB;QAEnB,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;gBAClC,QAAQ,GAAG,OAAO,CAAC;gBACnB,OAAO,GAAG,EAAE,CAAC;YACf,CAAC;YAED,OAAO,kBAAO,CAAC,OAAO,CACpB,IAAI,sBAAW,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,CACtD,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;QAED,4BAA4B;QAC5B,QAAQ,GAAG,OAAc,CAAC,WAAW,CAAC;QACtC,OAAO,GAAG,cAAc,CAAC;QACzB,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;YAClC,QAAQ,GAAG,OAAO,CAAC;YACnB,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,wBAAwB,EAAE;aACnC,IAAI,CACH,CAAC,qBAA0B,CAAC,WAAW,EAAE,EAAE,CACzC,IAAI,sBAAW,CACb,IAAI,CAAC,MAAM,EACX,qBAAqB,EACrB,OAA8B,CAC/B,CACJ;aACA,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,wBAAwB,CACtB,OAQC,EACD,QAAmB;QAEnB,MAAM,IAAI,GAAG,IAAI,CAAC;QAClB,OAAO,kBAAO,CAAC,OAAO,CACpB,IAAI,iCAAqB,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAChD,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;CACF;AAED,MAAM,CAAC,SAAS,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;AAEnE,MAAM,CAAC,SAAS,CAAC,oBAAoB,GAAG,SAAS,CAAC;AAElD,iBAAS,MAAM,CAAC"}

package/lib-esm/managers/file-requests-manager.d.ts

@@ -0,0 +1,56 @@
+import BoxClient from '../box-client';
+import { FileRequest, FileRequestCopyBody, FileRequestUpdateBody } from '../schemas';
+declare class FileRequestsManager {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Gets File Request by ID.
+     * @param {string} fileRequestId File Request ID
+     * @param {Function} [callback] passed the user info if it was acquired successfully
+     * @returns {Promise<FileRequest>} a promise with FileRequest details
+     */
+    getById(fileRequestId: string, callback?: Function): Promise<FileRequest>;
+    /**
+     * Delete File Request.
+     * @param {string} fileRequestId File Request ID
+     * @param {Function} [callback] passed the user info if it was acquired successfully
+     * @returns {Promise<void>} Returns a promise resolving to nothing
+     */
+    delete(fileRequestId: string, callback?: Function): Promise<FileRequest>;
+    /**
+     * Copies existing FileRequest to new folder
+     * @param {string} fileRequestIdToCopy ID of file request to copy
+     * @param copyRequest copy request details
+     * @param {string} copyRequest.folder.id ID of folder to which file request will be copied
+     * @param {string} copyRequest.folder.type type of folder. Value is always 'folder'
+     * @param {string} [copyRequest.title] new title of file request
+     * @param {string} [copyRequest.description] new description of file request
+     * @param {string} [copyRequest.expires_at] new date when file request expires
+     * @param {boolean} [copyRequest.is_description_required] is file request submitter required to provide a description
+     *   of the files they are submitting
+     * @param {boolean} [copyRequest.is_email_required] is file request submitter required to provide their email address
+     * @param {string} [copyRequest.status] new status of file request
+     * @param {Function} [callback] passed the user info if it was acquired successfully
+     * @returns {Promise<FileRequest>} Returns a promise with FileRequest details
+     */
+    copy(fileRequestIdToCopy: string, copyRequest: FileRequestCopyBody, callback?: Function): Promise<FileRequest>;
+    /**
+     * Update existing file request
+     * @param {string} fileRequestId ID of file request
+     * @param {string} fileRequestChange change of file request
+     * @param {string} [fileRequestChange.description] new description of file request
+     * @param {string} [fileRequestChange.expires_at] new date when file request expires
+     * @param {boolean} [fileRequestChange.is_description_required] is file request submitter required to provide a
+     *   description of the files they are submitting
+     * @param {boolean} [fileRequestChange.is_email_required] is file request submitter required to provide their
+     *   email address
+     * @param {string} [fileRequestChange.status] new status of file request
+     * @param {string} [fileRequestChange.title] new title of file request
+     * @param {string} [originalRequestEtag] pass in the item's last observed etag value into this header and
+     *   the endpoint will fail with a 412 Precondition Failed if it has changed since.
+     * @param {Function} callback passed the user info if it was acquired successfully
+     * @returns {Promise<FileRequest>} Returns a promise with FileRequest details
+     */
+    update(fileRequestId: string, fileRequestChange: FileRequestUpdateBody, originalRequestEtag?: string, callback?: Function): Promise<FileRequest>;
+}
+export = FileRequestsManager;