box-node-sdk 3.8.0 → 3.8.2

package/lib-esm/managers/sign-templates.generated.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const url_path_1 = __importDefault(require("../util/url-path"));
+/**
+ * Simple manager for interacting with all Sign Templates endpoints and actions.
+ */
+class SignTemplatesManager {
+    /**
+     * @param {BoxClient} client The Box API Client that is responsible for making calls to the API
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get Box Sign template by ID
+     *
+     * Fetches details of a specific Box Sign template.
+     * @param {object} options Options for the request
+     * @param {string} options.template_id The ID of a Box Sign template.
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.SignTemplate>} A promise resolving to the result or rejecting with an error
+     */
+    getById(options, callback) {
+        const { template_id: templateId, ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_templates', templateId), params = {
+            qs: queryParams,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * List Box Sign templates
+     *
+     * Gets Box Sign templates created by a user.
+     * @param {object} [options] Options for the request
+     * @param {string} [options.marker] Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires `usemarker` to be set to `true`.
+     * @param {number} [options.limit] The maximum number of items to return per page.
+     * @param {Function} [callback] Passed the result if successful, error otherwise
+     * @returns {Promise<schemas.SignTemplates>} A promise resolving to the result or rejecting with an error
+     */
+    getAll(options, callback) {
+        const { ...queryParams } = options, apiPath = (0, url_path_1.default)('sign_templates'), params = {
+            qs: queryParams,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+}
+module.exports = SignTemplatesManager;
+//# sourceMappingURL=sign-templates.generated.js.map

package/lib-esm/managers/sign-templates.generated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-templates.generated.js","sourceRoot":"","sources":["../../src/managers/sign-templates.generated.ts"],"names":[],"mappings":";;;;AACA,gEAAuC;AAEvC;;GAEG;AACH,MAAM,oBAAoB;IAExB;;OAEG;IACH,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,OAKC,EACD,QAAmB;QAEnB,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EACzD,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,UAAU,CAAC,EAC/C,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;IACD;;;;;;;;;OASG;IACH,MAAM,CACJ,OAYC,EACD,QAAmB;QAEnB,MAAM,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,EAChC,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACnC,MAAM,GAAG;YACP,EAAE,EAAE,WAAW;SAChB,CAAC;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,MAAM,EACN,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AACD,iBAAS,oBAAoB,CAAC"}

package/lib-esm/managers/storage-policies.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @fileoverview Manager for the Storage Policies resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Simple manager for interacting with all Retention Policies endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class StoragePolicies {
+    client: BoxClient;
+    constructor(client: BoxClient);
+    /**
+     * Get information about a specific storage policy
+     * @param {string} storagePolicyID The ID of the storage policy
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed the storage policy object if successful
+     * @returns {Promise<Object>} Promise resolving to the storage policy object
+     */
+    get(storagePolicyID: string, options?: {
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * Get all available storage policies for the enterprise
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed a collection of storage policies if successful
+     * @returns {Promise<Object>} Promise resolving to the collection of storage policies
+     */
+    getAll(options?: {
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * Assign a storage policy to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    assign(storagePolicyID: string, userID: string, callback?: Function): any;
+    /**
+     * Get information about a specific storage policy asisgnment by ID
+     * @param {string} assignmentID The ID of the assignment
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignment(assignmentID: string, callback?: Function): any;
+    /**
+     * Gets the storage policy assignment for a specific user
+     * @param {string} targetID The ID of the target
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.targetType=user] The type of the assignment target to resolve for
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignmentForTarget(targetID: string, options?: {
+        targetType?: string;
+    }, callback?: Function): any;
+    /**
+     * Create a new storage policy assignment to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    createAssignment(storagePolicyID: string, userID: string, callback?: Function): any;
+    /**
+     * Update a storage policy assignment
+     * @param {string} assignmentID The ID of the storage policy assignment to update
+     * @param {Object} updates The updates fields to apply
+     * @param {Function} [callback] Passed the updated assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the updated assignment object
+     */
+    updateAssignment(assignmentID: string, updates: Record<string, any>, callback?: Function): any;
+    /**
+     * Remove a storage policy assignment, returning the user to the default policy
+     * @param {string} assignmentID The ID of the assignment to remove
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving if the removal succeeds
+     */
+    removeAssignment(assignmentID: string, callback?: Function): any;
+}
+export = StoragePolicies;

package/lib-esm/managers/storage-policies.js

@@ -0,0 +1,174 @@
+"use strict";
+/**
+ * @fileoverview Manager for the Storage Policies 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"));
+// -----------------------------------------------------------------------------
+// Private
+// -----------------------------------------------------------------------------
+const BASE_PATH = '/storage_policies', ASSIGNMENTS_PATH = '/storage_policy_assignments';
+// -----------------------------------------------------------------------------
+// Public
+// -----------------------------------------------------------------------------
+/**
+ * Simple manager for interacting with all Retention Policies endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+class StoragePolicies {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Get information about a specific storage policy
+     * @param {string} storagePolicyID The ID of the storage policy
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed the storage policy object if successful
+     * @returns {Promise<Object>} Promise resolving to the storage policy object
+     */
+    get(storagePolicyID, options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH, storagePolicyID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Get all available storage policies for the enterprise
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.fields] Comma-separated list of fields of the storage policy to retrieve
+     * @param {Function} [callback] Passed a collection of storage policies if successful
+     * @returns {Promise<Object>} Promise resolving to the collection of storage policies
+     */
+    getAll(options, callback) {
+        var apiPath = (0, url_path_1.default)(BASE_PATH), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    }
+    /**
+     * Assign a storage policy to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    assign(storagePolicyID, userID, callback) {
+        return this.getAssignmentForTarget(userID)
+            .then((assignment /* FIXME */) => {
+            // Check if the assignment is already correct
+            if (assignment.storage_policy.id === storagePolicyID) {
+                return assignment;
+            }
+            // If the assignment is to an enterprise, we need to create a new
+            // assignment for the user
+            if (assignment.assigned_to.type === 'enterprise') {
+                return this.createAssignment(storagePolicyID, userID);
+            }
+            // Update the user's existing assignment
+            var update = {
+                storage_policy: {
+                    type: 'storage_policy',
+                    id: storagePolicyID,
+                },
+            };
+            return this.updateAssignment(assignment.id, update);
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Get information about a specific storage policy asisgnment by ID
+     * @param {string} assignmentID The ID of the assignment
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignment(assignmentID, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID);
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, null, callback);
+    }
+    /**
+     * Gets the storage policy assignment for a specific user
+     * @param {string} targetID The ID of the target
+     * @param {Object} [options] Optional parameters
+     * @param {string} [options.targetType=user] The type of the assignment target to resolve for
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    getAssignmentForTarget(targetID, options, callback) {
+        options = Object.assign({ targetType: 'user' }, options);
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
+            qs: {
+                resolved_for_type: options.targetType,
+                resolved_for_id: targetID,
+            },
+        };
+        return this.client
+            .get(apiPath, params)
+            .then((response /* FIXME */) => {
+            if (response.statusCode !== http_status_1.default.OK) {
+                // Unexpected status code, throw an error
+                throw errors_1.default.buildUnexpectedResponseError(response);
+            }
+            // Unwrap the collection and give back just the assignment object
+            return response.body.entries[0];
+        })
+            .asCallback(callback);
+    }
+    /**
+     * Create a new storage policy assignment to a user
+     * @param {string} storagePolicyID The ID of the storage policy to assign
+     * @param {string} userID The ID of the user to assign the storage policy to
+     * @param {Function} [callback] Passed the assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the assignment object
+     */
+    createAssignment(storagePolicyID, userID, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH), params = {
+            body: {
+                storage_policy: {
+                    type: 'storage_policy',
+                    id: storagePolicyID,
+                },
+                assigned_to: {
+                    type: 'user',
+                    id: userID,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    }
+    /**
+     * Update a storage policy assignment
+     * @param {string} assignmentID The ID of the storage policy assignment to update
+     * @param {Object} updates The updates fields to apply
+     * @param {Function} [callback] Passed the updated assignment object if successful
+     * @returns {Promise<Object>} Promise resolving to the updated assignment object
+     */
+    updateAssignment(assignmentID, updates, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    }
+    /**
+     * Remove a storage policy assignment, returning the user to the default policy
+     * @param {string} assignmentID The ID of the assignment to remove
+     * @param {Function} [callback] Passed nothing if successful
+     * @returns {Promise<void>} Promise resolving if the removal succeeds
+     */
+    removeAssignment(assignmentID, callback) {
+        var apiPath = (0, url_path_1.default)(ASSIGNMENTS_PATH, assignmentID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    }
+}
+module.exports = StoragePolicies;
+//# sourceMappingURL=storage-policies.js.map

package/lib-esm/managers/storage-policies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage-policies.js","sourceRoot":"","sources":["../../src/managers/storage-policies.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAEH,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,8DAAqC;AAErC,4DAAoC;AACpC,gEAAuC;AAEvC,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,MAAM,SAAS,GAAG,mBAAmB,EACnC,gBAAgB,GAAG,6BAA6B,CAAC;AAEnD,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH,MAAM,eAAe;IAGnB,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,eAAuB,EACvB,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,EAAE,eAAe,CAAC,EAC/C,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;;;;;;OAMG;IACH,MAAM,CACJ,OAEC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,SAAS,CAAC,EAC9B,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;;;;;;OAMG;IACH,MAAM,CAAC,eAAuB,EAAE,MAAc,EAAE,QAAmB;QACjE,OAAO,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC;aACvC,IAAI,CAAC,CAAC,UAAe,CAAC,WAAW,EAAE,EAAE;YACpC,6CAA6C;YAC7C,IAAI,UAAU,CAAC,cAAc,CAAC,EAAE,KAAK,eAAe,EAAE,CAAC;gBACrD,OAAO,UAAU,CAAC;YACpB,CAAC;YAED,iEAAiE;YACjE,0BAA0B;YAC1B,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACjD,OAAO,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;YACxD,CAAC;YAED,wCAAwC;YACxC,IAAI,MAAM,GAAG;gBACX,cAAc,EAAE;oBACd,IAAI,EAAE,gBAAgB;oBACtB,EAAE,EAAE,eAAe;iBACpB;aACF,CAAC;YACF,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,YAAoB,EAAE,QAAmB;QACrD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,QAAgB,EAChB,OAEC,EACD,QAAmB;QAEnB,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAEzD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,EAAE,EAAE;gBACF,iBAAiB,EAAE,OAAO,CAAC,UAAU;gBACrC,eAAe,EAAE,QAAQ;aAC1B;SACF,CAAC;QAEJ,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,qBAAU,CAAC,EAAE,EAAE,CAAC;gBAC1C,yCAAyC;gBACzC,MAAM,gBAAM,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;YAED,iEAAiE;YACjE,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC,CAAC;aACD,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,gBAAgB,CACd,eAAuB,EACvB,MAAc,EACd,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,CAAC,EACrC,MAAM,GAAG;YACP,IAAI,EAAE;gBACJ,cAAc,EAAE;oBACd,IAAI,EAAE,gBAAgB;oBACtB,EAAE,EAAE,eAAe;iBACpB;gBACD,WAAW,EAAE;oBACX,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACX;aACF;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;;;;;;OAMG;IACH,gBAAgB,CACd,YAAoB,EACpB,OAA4B,EAC5B,QAAmB;QAEnB,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,EACnD,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;;;;;OAKG;IACH,gBAAgB,CAAC,YAAoB,EAAE,QAAmB;QACxD,IAAI,OAAO,GAAG,IAAA,kBAAO,EAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACxD,OAAO,EACP,IAAI,EACJ,QAAQ,CACT,CAAC;IACJ,CAAC;CACF;AAED,iBAAS,eAAe,CAAC"}

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

@@ -0,0 +1,161 @@
+/**
+ * @fileoverview Manager for the Tasks Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * Enum of valid task resolution states
+ * @readonly
+ * @enum {TaskResolutionState}
+ */
+declare enum TaskResolutionState {
+    COMPLETE = "completed",
+    INCOMPLETE = "incomplete",
+    APPROVED = "approved",
+    REJECTED = "rejected"
+}
+/**
+ * Simple manager for interacting with all 'Tasks' endpoints and actions.
+ *
+ * @constructor
+ * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
+ * @returns {void}
+ */
+declare class Tasks {
+    client: BoxClient;
+    resolutionStates: typeof TaskResolutionState;
+    constructor(client: BoxClient);
+    /**
+     * Used to create a single task for single user on a single file.
+     *
+     * API Endpoint: '/tasks'
+     * Method: POST
+     *
+     * @param {string} fileID - The ID of the item this task is for
+     * @param {Object} [options] - Additional parameters
+     * @param {string} [options.message] - An optional message to include with the task
+     * @param {string} [options.due_at] - The day at which this task is due
+     * @param {Function} [callback] - Passed the new task information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the created task object
+     */
+    create(fileID: string, options?: {
+        message?: string;
+        due_at?: string;
+    }, callback?: Function): any;
+    /**
+     * Fetches a specific task.
+     *
+     * API Endpoint: '/tasks/:taskID'
+     * Method: GET
+     *
+     * @param {string} taskID - The Box ID of the task being requested
+     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
+     * @param {Function} [callback] - Passed the task information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the task object
+     */
+    get(taskID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Updates a specific task.
+     *
+     * API Endpoint: '/tasks/:taskID'
+     * Method: PUT
+     *
+     * @param {string} taskID - The Box ID of the task being updated
+     * @param {Object} updates - Fields of the task object to update
+     * @param {string} [updates.message] - An optional message to include with the task
+     * @param {string} [updates.due_at] - The day at which this task is due
+     * @param {Function} [callback] - Passed the updated task information if it was acquired successfully, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated task object
+     */
+    update(taskID: string, updates?: {
+        message?: string;
+        due_at?: string;
+    }, callback?: Function): any;
+    /**
+     * Permanently deletes a specific task.
+     *
+     * API Endpoint: '/tasks/:taskID'
+     * Method: DELETE
+     *
+     * @param {string} taskID - The Box ID of the task being deleted
+     * @param {Function} [callback] - Empty body passed if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    delete(taskID: string, callback?: Function): any;
+    /**
+     * Get a list of assignments for a given task
+     *
+     * API Endpoint: '/tasks/:taskID/assignments'
+     * Method: GET
+     *
+     * @param {string} taskID - The Box ID of the task to get assignments for
+     * @param {Object} [options] - Additional parameters, can be left null in most cases
+     * @param {Function} [callback] - Passed the list of assignments if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the collection of assignment objects
+     */
+    getAssignments(taskID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Get a specific task assignment
+     *
+     * API Endpoint: '/task_assignments/:assignmentID'
+     * Method: GET
+     *
+     * @param {string} assignmentID - The Box ID of the task assignment to retrieve
+     * @param {Object} [options] - Additional parameters, can be left null in most cases
+     * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the assignment object
+     */
+    getAssignment(assignmentID: string, options?: Record<string, any>, callback?: Function): any;
+    /**
+     * Assign a task to a specific user by ID
+     *
+     * API Endpoint: '/task_assignments'
+     * Method: POST
+     *
+     * @param {string} taskID - The Box ID of the task to assign
+     * @param {string} userID - The ID of the user to assign the task to
+     * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new assignment object
+     */
+    assignByUserID(taskID: string, userID: string, callback?: Function): any;
+    /**
+     * Assign a task to a specific user by email address
+     *
+     * API Endpoint: '/task_assignments'
+     * Method: POST
+     *
+     * @param {string} taskID - The Box ID of the task to assign
+     * @param {string} email - The email address of the user to assign the task to
+     * @param {Function} [callback] - Passed the task assignment if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the new assignment object
+     */
+    assignByEmail(taskID: string, email: string, callback?: Function): any;
+    /**
+     * Update a task assignment.  This is used to resolve or complete a task.
+     *
+     * API Endpoint: '/task_assignments/:assignmentID'
+     * Method: PUT
+     *
+     * @param {string} assignmentID - The Box ID of the task assignment to update
+     * @param {Object} options - The fields of the assignment to update
+     * @param {string} [options.message] - A message from the assignee about this task
+     * @param {TaskResolutionState} [options.resolution_state] - Resolution of the task
+     * @param {Function} [callback] - Passed the updated task assignment if successful, error otherwise
+     * @returns {Promise<Object>} A promise resolving to the updated assignment object
+     */
+    updateAssignment(assignmentID: string, options?: {
+        message?: string;
+        resolution_state?: TaskResolutionState;
+    }, callback?: Function): any;
+    /**
+     * Delete a task assignment.  This unassigns a user from the related task.
+     *
+     * API Endpoint: '/task_assignments/:assignmentID'
+     * Method: DELETE
+     *
+     * @param {string} assignmentID - The Box ID of the task assignment to delete
+     * @param {Function} [callback] - Passed nothing if successful, error otherwise
+     * @returns {Promise<void>} A promise resolving to nothing
+     */
+    deleteAssignment(assignmentID: string, callback?: Function): any;
+}
+export = Tasks;