box-node-sdk 1.35.0 → 1.37.2

package/lib/managers/tasks.js

@@ -1,32 +1,33 @@
+"use strict";
 /**
  * @fileoverview Manager for the Tasks Resource
  */
-
-'use strict';
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var url_path_1 = __importDefault(require("../util/url-path"));
 // -----------------------------------------------------------------------------
 // Typedefs
 // -----------------------------------------------------------------------------
-
-/** @typedef {string} TaskResolutionState */
-
-// -----------------------------------------------------------------------------
-// Requirements
-// -----------------------------------------------------------------------------
-var urlPath = require('../util/url-path');
-
+/**
+ * Enum of valid task resolution states
+ * @readonly
+ * @enum {TaskResolutionState}
+ */
+var TaskResolutionState;
+(function (TaskResolutionState) {
+    TaskResolutionState["COMPLETE"] = "completed";
+    TaskResolutionState["INCOMPLETE"] = "incomplete";
+    TaskResolutionState["APPROVED"] = "approved";
+    TaskResolutionState["REJECTED"] = "rejected";
+})(TaskResolutionState || (TaskResolutionState = {}));
 // -----------------------------------------------------------------------------
 // Private
 // -----------------------------------------------------------------------------
-var BASE_PATH = '/tasks',
-	ASSIGNMENTS_SUBRESOURCE = 'assignments',
-	ASSIGNMENTS_PATH = '/task_assignments',
-	REVIEW_ACTION = 'review';
-
+var BASE_PATH = '/tasks', ASSIGNMENTS_SUBRESOURCE = 'assignments', ASSIGNMENTS_PATH = '/task_assignments', REVIEW_ACTION = 'review';
 // -----------------------------------------------------------------------------
 // Public
 // -----------------------------------------------------------------------------
-
 /**
  * Simple manager for interacting with all 'Tasks' endpoints and actions.
  *
@@ -34,252 +35,210 @@ var BASE_PATH = '/tasks',
  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  * @returns {void}
  */
-function Tasks(client) {
-	this.client = client;
-}
-
+var Tasks = /** @class */ (function () {
+    function Tasks(client) {
+        this.client = client;
+    }
+    /**
+     * 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
+     */
+    Tasks.prototype.create = function (fileID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH), params = {
+            body: {
+                item: {
+                    type: 'file',
+                    id: fileID,
+                },
+                action: REVIEW_ACTION,
+            },
+        };
+        Object.assign(params.body, options);
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.get = function (taskID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, taskID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.update = function (taskID, updates, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, taskID), params = {
+            body: updates,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.delete = function (taskID, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, taskID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.getAssignments = function (taskID, options, callback) {
+        var apiPath = url_path_1.default(BASE_PATH, taskID, ASSIGNMENTS_SUBRESOURCE), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.getAssignment = function (assignmentID, options, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH, assignmentID), params = {
+            qs: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.assignByUserID = function (taskID, userID, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH), params = {
+            body: {
+                task: {
+                    type: 'task',
+                    id: taskID,
+                },
+                assign_to: {
+                    id: userID,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.assignByEmail = function (taskID, email, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH), params = {
+            body: {
+                task: {
+                    type: 'task',
+                    id: taskID,
+                },
+                assign_to: {
+                    login: email,
+                },
+            },
+        };
+        return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.updateAssignment = function (assignmentID, options, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH, assignmentID), params = {
+            body: options,
+        };
+        return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
+    };
+    /**
+     * 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
+     */
+    Tasks.prototype.deleteAssignment = function (assignmentID, callback) {
+        var apiPath = url_path_1.default(ASSIGNMENTS_PATH, assignmentID);
+        return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
+    };
+    return Tasks;
+}());
 /**
  * Enum of valid task resolution states
  * @readonly
  * @enum {TaskResolutionState}
  */
-Tasks.prototype.resolutionStates = Object.freeze({
-	COMPLETE: 'completed',
-	INCOMPLETE: 'incomplete',
-	APPROVED: 'approved',
-	REJECTED: 'rejected'
-});
-
-/**
- * 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
- */
-Tasks.prototype.create = function(fileID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH),
-		params = {
-			body: {
-				item: {
-					type: 'file',
-					id: fileID
-				},
-				action: REVIEW_ACTION
-			}
-		};
-
-	Object.assign(params.body, options);
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.get = function(taskID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, taskID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.update = function(taskID, updates, callback) {
-
-	var apiPath = urlPath(BASE_PATH, taskID),
-		params = {
-			body: updates
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.delete = function(taskID, callback) {
-
-	var apiPath = urlPath(BASE_PATH, taskID);
-
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.getAssignments = function(taskID, options, callback) {
-
-	var apiPath = urlPath(BASE_PATH, taskID, ASSIGNMENTS_SUBRESOURCE),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.getAssignment = function(assignmentID, options, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH, assignmentID),
-		params = {
-			qs: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.get)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.assignByUserID = function(taskID, userID, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH),
-		params = {
-			body: {
-				task: {
-					type: 'task',
-					id: taskID
-				},
-				assign_to: {
-					id: userID
-				}
-			}
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.assignByEmail = function(taskID, email, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH),
-		params = {
-			body: {
-				task: {
-					type: 'task',
-					id: taskID
-				},
-				assign_to: {
-					login: email
-				}
-			}
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.post)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.updateAssignment = function(assignmentID, options, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH, assignmentID),
-		params = {
-			body: options
-		};
-
-	return this.client.wrapWithDefaultHandler(this.client.put)(apiPath, params, callback);
-};
-
-/**
- * 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
- */
-Tasks.prototype.deleteAssignment = function(assignmentID, callback) {
-
-	var apiPath = urlPath(ASSIGNMENTS_PATH, assignmentID);
-
-	return this.client.wrapWithDefaultHandler(this.client.del)(apiPath, null, callback);
-};
-
+Tasks.prototype.resolutionStates = TaskResolutionState;
 module.exports = Tasks;
+//# sourceMappingURL=tasks.js.map

package/lib/managers/tasks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../src/managers/tasks.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;AAOH,8DAAuC;AAEvC,gFAAgF;AAChF,WAAW;AACX,gFAAgF;AAEhF;;;;GAIG;AACH,IAAK,mBAKJ;AALD,WAAK,mBAAmB;IACvB,6CAAsB,CAAA;IACtB,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;AACtB,CAAC,EALI,mBAAmB,KAAnB,mBAAmB,QAKvB;AAED,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,IAAM,SAAS,GAAG,QAAQ,EACzB,uBAAuB,GAAG,aAAa,EACvC,gBAAgB,GAAG,mBAAmB,EACtC,aAAa,GAAG,QAAQ,CAAC;AAE1B,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF;;;;;;GAMG;AACH;IAKC,eAAY,MAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,sBAAM,GAAN,UACC,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,CAAC,EAC/B,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,IAAI,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACV;gBACD,MAAM,EAAE,aAAa;aACrB;SACD,CAAC;QAEH,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEpC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAG,GAAH,UAAI,MAAc,EAAE,OAA6B,EAAE,QAAmB;QACrE,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EACvC,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;;;;;;;;;;;;OAYG;IACH,sBAAM,GAAN,UACC,MAAc,EACd,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,MAAM,CAAC,EACvC,MAAM,GAAG;YACR,IAAI,EAAE,OAAO;SACb,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,sBAAM,GAAN,UAAO,MAAc,EAAE,QAAmB;QACzC,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,8BAAc,GAAd,UACC,MAAc,EACd,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,SAAS,EAAE,MAAM,EAAE,uBAAuB,CAAC,EAChE,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,6BAAa,GAAb,UACC,YAAoB,EACpB,OAA6B,EAC7B,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,EACpD,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,8BAAc,GAAd,UAAe,MAAc,EAAE,MAAc,EAAE,QAAmB;QACjE,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,CAAC,EACtC,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,IAAI,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACV;gBACD,SAAS,EAAE;oBACV,EAAE,EAAE,MAAM;iBACV;aACD;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,6BAAa,GAAb,UAAc,MAAc,EAAE,KAAa,EAAE,QAAmB;QAC/D,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,CAAC,EACtC,MAAM,GAAG;YACR,IAAI,EAAE;gBACL,IAAI,EAAE;oBACL,IAAI,EAAE,MAAM;oBACZ,EAAE,EAAE,MAAM;iBACV;gBACD,SAAS,EAAE;oBACV,KAAK,EAAE,KAAK;iBACZ;aACD;SACD,CAAC;QAEH,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAC1D,OAAO,EACP,MAAM,EACN,QAAQ,CACR,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,gCAAgB,GAAhB,UACC,YAAoB,EACpB,OAGC,EACD,QAAmB;QAEnB,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,EACpD,MAAM,GAAG;YACR,IAAI,EAAE,OAAO;SACb,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,gCAAgB,GAAhB,UAAiB,YAAoB,EAAE,QAAmB;QACzD,IAAI,OAAO,GAAG,kBAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CACzD,OAAO,EACP,IAAI,EACJ,QAAQ,CACR,CAAC;IACH,CAAC;IACF,YAAC;AAAD,CAAC,AA3SD,IA2SC;AAED;;;;GAIG;AACH,KAAK,CAAC,SAAS,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEvD,iBAAS,KAAK,CAAC"}

package/lib/managers/terms-of-service.d.ts

@@ -0,0 +1,161 @@
+/**
+ * @fileoverview Manager for the  Box Terms of Service Resource
+ */
+import BoxClient from '../box-client';
+/**
+ * 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}
+ */
+declare enum TermsOfServicesType {
+    MANAGED = "managed",
+    EXTERNAL = "external"
+}
+/**
+ * Enum value of status of the custom terms of services, either currently enabled or currently disabled
+ *
+ * @readonly
+ * @enum {TermsOfServicesStatus}
+ */
+declare enum TermsOfServicesStatus {
+    ENABLED = "enabled",
+    DISABLED = "disabled"
+}
+/**
+ * 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
+ */
+declare class TermsOfService {
+    client: BoxClient;
+    type: typeof TermsOfServicesType;
+    status: typeof TermsOfServicesStatus;
+    constructor(client: BoxClient);
+    /**
+     * 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: TermsOfServicesType, termsOfServicesStatus: TermsOfServicesStatus, termsOfServicesText: string, callback?: Function): any;
+    /**
+     * 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: string, updates: {
+        status?: TermsOfServicesStatus;
+        text?: string;
+    }, callback?: Function): any;
+    /**
+     * 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: string, options?: {
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * 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?: {
+        tos_type?: TermsOfServicesType;
+        fields?: string;
+    }, callback?: Function): any;
+    /**
+     * 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: string, isAccepted: boolean, options?: {
+        user_id?: string;
+    }, callback?: Function): any;
+    /**
+     * 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: string, options?: {
+        user_id?: string;
+    }, callback?: Function): any;
+    /**
+     * 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: string, isAccepted: boolean, callback?: Function): any;
+    /**
+     * 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: string, isAccepted: boolean, options?: {
+        user_id?: string;
+    }, callback?: Function): any;
+}
+/**
+ * @module box-node-sdk/lib/managers/terms-of-service
+ * @see {@Link TermsOfService}
+ */
+export = TermsOfService;